Fetch a conversation from your service

GET /v1/Services/{ChatServiceSid}/Conversations/{Sid}
Account sid auth token

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

Fetch a conversation from your service

Path parameters

  • ChatServiceSid string Required

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

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

  • Sid string Required

    A 34 character string that uniquely identifies this resource. Can also be the unique_name of the Conversation.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • 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}$.

    • 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}$.

    • 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}$.

    • friendly_name string | null

      The human-readable name of this conversation, limited to 256 characters. Optional.

    • unique_name string | null

      An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's sid in the URL.

    • attributes string | null

      An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set "{}" will be returned.

    • state string

      Current state of this conversation. Can be either initializing, active, inactive or closed and defaults to active

      Values are inactive, active, or closed.

    • 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.

    • timers

      Timer date values representing state update for this conversation.

    • url string(uri) | null

      An absolute API resource URL for this conversation.

    • links object(uri-map) | null

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

    • bindings
GET /v1/Services/{ChatServiceSid}/Conversations/{Sid} 
curl \
 --request GET 'https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{Sid}' \
 --user "username:password"
Response examples (200) 
{
  "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "export": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Export",
    "messages": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages",
    "webhooks": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks",
    "participants": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants"
  },
  "state": "active",
  "timers": {
    "date_closed": "2015-12-16T22:28:38Z",
    "date_inactive": "2015-12-16T22:19:38Z"
  },
  "bindings": {},
  "attributes": "{ \"topic\": \"feedback\" }",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "unique_name": "first_conversation",
  "date_created": "2015-12-16T22:18:37Z",
  "date_updated": "2015-12-16T22:18:38Z",
  "friendly_name": "My First Conversation",
  "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}