SIsinch
Conversation

List conversations

This operation lists all conversations that are associated with an app and/or a contact. Note that either app_id or contact_id is required in order for the operation to function correctly.

get/v1/projects/{project_id}/conversations

Request

  • Base URL
    https://us.conversation.api.sinch.com
  • URL
    https://us.conversation.api.sinch.com/v1/projects/{project_id}/conversations
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://auth.sinch.com/oauth2/token

Query parameters

app_idstring

The ID of the app involved in the conversations.

contact_idstring

Resource name (ID) of the contact.

only_activeboolean

Set to true to list only active conversations. Set to false to list only inactive conversations.

page_sizeinteger

The maximum number of conversations to fetch. Defaults to 10 and the maximum is 20.

page_tokenstring

Next page token previously returned if any.

active_channel'SMS' | 'RCS' | 'WHATSAPP' | 'MMS' | 'KAKAOTALK' | 'KAKAOTALKCHAT' | 'VIBERBM' | 'LINE' | 'INSTAGRAM' | 'MESSENGER' | 'WECHAT' | 'TELEGRAM' | 'APPLEBC'

The identifier of the channel you want to include. Must be one of the enum values.

Example:WHATSAPP

Only fetch conversations from the active_channel

Response

A successful response.

next_page_tokenstring

Token that should be included in the next request to fetch the next page.

total_sizeinteger

Example response

{
  "conversations": [
    {
      "active_channel": "WHATSAPP"
    }
  ]
}

Changes

No recorded changes to this operation across all 3 revisions of this API.