Sign in
ConversationsV2Communication

List Communications

Retrieve a list of Communications in a Conversation.

get/v2/Conversations/{ConversationId}/Communications

Query parameters

channelIdstring

Resource identifier to filter communications

pageSizeinteger
Example:50

Maximum number of items to return

pageTokenstring

Page token for pagination

Response

OK

Example response

{
  "communications": [
    {
      "id": "conv_communication_00000000000000000000000001",
      "conversationId": "conv_conversation_00000000000000000000000001",
      "accountId": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "author": {
        "address": "+18005550100",
        "channel": "SMS",
        "participantId": "conv_participant_00000000000000000000000001"
      },
      "content": {
        "type": "TEXT",
        "text": "Hello, I need help with my order"
      },
      "resourceId": "SM12345678901234567890123456789012",
      "recipients": [
        {
          "address": "+18005550102",
          "channel": "SMS",
          "participantId": "conv_participant_00000000000000000000000002",
          "deliveryStatus": "DELIVERED"
        }
      ],
      "createdAt": "2023-07-01T12:15:00Z",
      "updatedAt": "2023-07-01T12:15:05Z"
    }
  ],
  "meta": {
    "key": "communications"
  }
}

Changes

Changed in 1 of the 4 revisions of this API.1

  • v2f039dce079161See the full diff
    • ●

      added the new READ enum value to the communications/items/recipients/items/allOf[subschema #2]/deliveryStatus response property for the response status 200

      response-property-enum-value-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog