Retrieve a list of conversations in your service

GET /v1/Services/{ChatServiceSid}/Conversations

A Service Conversation resource represents an omnichannel group conversation with an ordered list of messages and a participant roster.

Retrieve a list of conversations in your service

Path parameters

Query parameters

  • 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
    • conversations array[object]
      Hide conversations attributes Show conversations attributes
      • account_sid string | null

        The unique ID of the Account responsible for this conversation.

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

      • attributes string | null

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

      • bindings
      • chat_service_sid string | null

        The unique ID of the Conversation Service this conversation belongs to.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[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.

      • friendly_name string | null

        The human-readable name of this conversation.

      • links object(uri-map) | null

        Absolute URLs to access the participants, messages and webhooks of this conversation.

      • messaging_service_sid string | null

        The unique ID of the Messaging Service this conversation belongs to.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MG[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: ^CH[0-9a-fA-F]{32}$.

      • state string | null

        Current state of this conversation.

        Values are inactive, active, or closed.

      • timers

        Timer date values for this conversation.

      • unique_name string | null

        An application-defined string that uniquely identifies the resource

      • url string(uri) | null

        An absolute URL for this conversation.

    • meta object
      Hide meta attributes Show meta attributes
GET /v1/Services/{ChatServiceSid}/Conversations 
curl \
 -X GET https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations \
 --user "username:password"
Response examples (200) 
{
  "conversations": [
    {
      "account_sid": "string",
      "attributes": "string",
      "chat_service_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "friendly_name": "string",
      "links": {},
      "messaging_service_sid": "string",
      "sid": "string",
      "state": "inactive",
      "unique_name": "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"
  }
}