ConversationsConversation

List Service Conversation

GET
/v1/Services/{ChatServiceSid}/Conversations

Retrieve a list of conversations in your service

Authorization

accountSid_authToken
AuthorizationBasic <token>

In: header

Path Parameters

ChatServiceSid*string

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

Match^IS[0-9a-fA-F]{32}$
Length34 <= length <= 34

Query Parameters

StartDate?string

Specifies the beginning of the date range for filtering Conversations based on their creation date. Conversations that were created on or after this date will be included in the results. The date must be in ISO8601 format, specifically starting at the beginning of the specified date (YYYY-MM-DDT00:00:00Z), for precise filtering. This parameter can be combined with other filters. If this filter is used, the returned list is sorted by latest conversation creation date in descending order.

EndDate?string

Defines the end of the date range for filtering conversations by their creation date. Only conversations that were created on or before this date will appear in the results. The date must be in ISO8601 format, specifically capturing up to the end of the specified date (YYYY-MM-DDT23:59:59Z), to ensure that conversations from the entire end day are included. This parameter can be combined with other filters. If this filter is used, the returned list is sorted by latest conversation creation date in descending order.

State?ServiceConversationState

State for sorting and filtering list of Conversations. Can be active, inactive or closed

Value in

  • "inactive"
  • "active"
  • "closed"
  • "initializing"
PageSize?integer

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

Formatint64
Range1 <= value <= 100
Page?integer

The page index. This value is simply for client state.

Range0 <= value
PageToken?string

The page token. This is provided by the API.

Response Body

application/json

curl -X GET "https://example.com/v1/Services/stringstringstringstringstringstri/Conversations"
{  "conversations": [    {      "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",      "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",      "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",      "friendly_name": "Home Repair Visit",      "unique_name": null,      "attributes": "{ \"topic\": \"feedback\" }",      "date_created": "2015-12-16T22:18:37Z",      "date_updated": "2015-12-16T22:18:38Z",      "state": "active",      "timers": {        "date_inactive": "2015-12-16T22:19:38Z",        "date_closed": "2015-12-16T22:28:38Z"      },      "bindings": {},      "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",      "links": {        "participants": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants",        "messages": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages",        "webhooks": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks",        "export": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Export"      }    }  ],  "meta": {    "page": 0,    "page_size": 50,    "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0",    "previous_page_url": null,    "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0",    "next_page_url": null,    "key": "conversations"  }}