Retrieve a list of all messages in the conversation

GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages

A Service Message resource represents a message in a conversation within a specific service.

Retrieve a list of all messages in the conversation

Path parameters

Query parameters

  • Order string

    The sort order of the returned messages. Can be: asc (ascending) or desc (descending), with asc as the default.

    Values are asc or desc.

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • messages array[object]
      Hide messages attributes Show messages attributes
      • account_sid string | null

        The unique ID of the Account responsible for this message.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • attributes string | null

        A string metadata field you can use to store any data you wish.

      • author string | null

        The channel specific identifier of the message's author.

      • body string | null

        The content of the message.

      • chat_service_sid string | null

        The SID of the Conversation Service that the resource is associated with.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.

      • conversation_sid string | null

        The unique ID of the Conversation for this message.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CH[0-9a-fA-F]{32}$.

      • date_created string(date-time) | null

        The date that this resource was created.

      • date_updated string(date-time) | null

        The date that this resource was last updated.

      • delivery

        An object that contains the summary of delivery statuses for the message to non-chat participants.

      • index integer | null

        The index of the message within the Conversation.

      • links object(uri-map) | null

        Absolute URL to access the receipts of this message.

      • media array | null

        An array of objects that describe the Message's media if attached, otherwise, null.

      • participant_sid string | null

        The unique ID of messages's author participant.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MB[0-9a-fA-F]{32}$.

      • sid string | null

        A 34 character string that uniquely identifies this resource.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IM[0-9a-fA-F]{32}$.

      • url string(uri) | null

        An absolute URL for this message.

    • meta object
      Hide meta attributes Show meta attributes
GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages 
curl \
 -X GET https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages \
 --user "username:password"
Response examples (200) 
{
  "messages": [
    {
      "account_sid": "string",
      "attributes": "string",
      "author": "string",
      "body": "string",
      "chat_service_sid": "string",
      "conversation_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "index": 42,
      "links": {},
      "media": [],
      "participant_sid": "string",
      "sid": "string",
      "url": "https://example.com"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}