Conversation

Gets a list of conversation messages

Gets a paginated list of messages for a specific conversation.

get/conversations/{id}/messages

Path parameters

idstring required

The ID of the conversation.

Query parameters

page_sizeinteger
Example:25

Number of results to return per page.

page_tokenstring

Cursor token for pagination. Use the next_page_token value from the previous response.

Response

next_page_tokenstring

Cursor token for the next page of results. Pass this value as the page_token parameter in the next request.

Example response

{
  "result": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "conversation_id": "550e8400-e29b-41d4-a716-446655440000",
      "direction": "incoming",
      "status": "done",
      "reference_type": "message",
      "reference_id": "f6a7b8c9-d0e1-2345-6789-0abcdef01234",
      "source": {
        "type": "tel",
        "target": "+14155551234",
        "target_name": "John Smith",
        "name": "Main Office",
        "detail": "Primary contact number"
      },
      "destination": {
        "type": "tel",
        "target": "+14155551234",
        "target_name": "John Smith",
        "name": "Main Office",
        "detail": "Primary contact number"
      },
      "text": "Hello, how can I help you today?",
      "medias": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
          "type": "image",
          "filename": "photo_2026-01-15.jpg",
          "tm_create": "2026-01-15T09:30:00.000000Z",
          "tm_update": "2026-01-15T09:30:00.000000Z",
          "tm_delete": "2026-01-15T09:30:00.000000Z"
        }
      ],
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-15T09:30:00.000000Z",
      "tm_delete": "2026-01-15T09:30:00.000000Z"
    }
  ]
}

Changes

Changed in 4 of the 54 revisions of this API.1715

    • added the new web_session enum value to the allOf[subschema #2]/result/items/destination/type response property for the response status 200

      response-property-enum-value-added

    • added the new web_session enum value to the allOf[subschema #2]/result/items/source/type response property for the response status 200

      response-property-enum-value-added

    • added the optional property allOf[subschema #2]/result/items/destination to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[subschema #2]/result/items/source to the response with the 200 status

      response-optional-property-added

  • c7eb634e776f76See the full diff
    • added the new enum value to the allOf[subschema #2]/result/items/reference_type response property for the response status 200

      response-property-enum-value-added

    • added the new done enum value to the allOf[subschema #2]/result/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new email enum value to the allOf[subschema #2]/result/items/reference_type response property for the response status 200

      response-property-enum-value-added

    • added the new line enum value to the allOf[subschema #2]/result/items/reference_type response property for the response status 200

      response-property-enum-value-added

    • added the new message enum value to the allOf[subschema #2]/result/items/reference_type response property for the response status 200

      response-property-enum-value-added

    • added the new progressing enum value to the allOf[subschema #2]/result/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new whatsapp enum value to the allOf[subschema #2]/result/items/reference_type response property for the response status 200

      response-property-enum-value-added

    • removed the call enum value from the allOf[subschema #2]/result/items/reference_type response property for the response status 200

      response-property-enum-value-removed

    • removed the campaign enum value from the allOf[subschema #2]/result/items/reference_type response property for the response status 200

      response-property-enum-value-removed

    • removed the none enum value from the allOf[subschema #2]/result/items/reference_type response property for the response status 200

      response-property-enum-value-removed

    • removed the received enum value from the allOf[subschema #2]/result/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the sending enum value from the allOf[subschema #2]/result/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the sent enum value from the allOf[subschema #2]/result/items/status response property for the response status 200

      response-property-enum-value-removed

  • 995c56ba921987See the full diff
    • removed the optional property allOf[subschema #2]/result/items/destination from the response with the 200 status

      response-optional-property-removed

    • removed the optional property allOf[subschema #2]/result/items/source from the response with the 200 status

      response-optional-property-removed

    • added the new call enum value to the allOf[subschema #2]/result/items/reference_type response property for the response status 200

      response-property-enum-value-added

    • added the new campaign enum value to the allOf[subschema #2]/result/items/reference_type response property for the response status 200

      response-property-enum-value-added

    • added the new none enum value to the allOf[subschema #2]/result/items/reference_type response property for the response status 200

      response-property-enum-value-added

    • added the new received enum value to the allOf[subschema #2]/result/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new sending enum value to the allOf[subschema #2]/result/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new sent enum value to the allOf[subschema #2]/result/items/status response property for the response status 200

      response-property-enum-value-added

    • removed the enum value from the allOf[subschema #2]/result/items/reference_type response property for the response status 200

      response-property-enum-value-removed

    • removed the done enum value from the allOf[subschema #2]/result/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the email enum value from the allOf[subschema #2]/result/items/reference_type response property for the response status 200

      response-property-enum-value-removed

    • removed the line enum value from the allOf[subschema #2]/result/items/reference_type response property for the response status 200

      response-property-enum-value-removed

    • removed the message enum value from the allOf[subschema #2]/result/items/reference_type response property for the response status 200

      response-property-enum-value-removed

    • removed the progressing enum value from the allOf[subschema #2]/result/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the whatsapp enum value from the allOf[subschema #2]/result/items/reference_type response property for the response status 200

      response-property-enum-value-removed

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