Service-Scoped Conversation Resource
A Service-scoped Conversation is a unique thread of a conversation that is scoped or limited to a specific, non-default Conversation Service.
Please see the Conversation Resource for Conversations within the default Conversation Service instance.
API Base URL
All URLs in the reference documentation use the following base URL:
https://conversations.twilio.com/v1
For Conversations applications that build on more than one Conversation Service instance, you will need to specify the Conversation Service SID in the REST API call:
GET /v1/Services/ISxx/Conversations/CHxx/Messages
Service-Scoped Conversation Properties
| Resource Properties in REST API format | |
|---|---|
account_sid
|
The unique ID of the Account responsible for this conversation. |
chat_service_sid
|
The unique ID of the Conversation Service this conversation belongs to. |
messaging_service_sid
|
The unique ID of the Messaging Service this conversation belongs to. |
sid
|
A 34 character string that uniquely identifies this resource. |
friendly_name
|
The human-readable name of this conversation, limited to 256 characters. Optional. |
unique_name
|
An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's |
attributes
|
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
|
Current state of this conversation. Can be either |
date_created
|
The date that this resource was created. |
date_updated
|
The date that this resource was last updated. |
timers
|
Timer date values representing state update for this conversation. |
url
|
An absolute API resource URL for this conversation. |
links
|
Contains absolute URLs to access the participants, messages and webhooks of this conversation. |
bindings
|
|
Create a Service-Scoped Conversation
https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations
Parameters
| Parameters in REST API format | |
|---|---|
chat_service_sid
Path
|
The SID of the Conversation Service the Conversation resource is associated with. |
friendly_name
Optional
|
The human-readable name of this conversation, limited to 256 characters. Optional. |
unique_name
Optional
|
An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's |
attributes
Optional
|
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. |
messaging_service_sid
Optional
|
The unique ID of the Messaging Service this conversation belongs to. |
date_created
Optional
|
The date that this resource was created. |
date_updated
Optional
|
The date that this resource was last updated. |
state
Optional
|
Current state of this conversation. Can be either |
timers.inactive
Optional
|
ISO8601 duration when conversation will be switched to |
timers.closed
Optional
|
ISO8601 duration when conversation will be switched to |
x_twilio_webhook_enabled
Header
|
The X-Twilio-Webhook-Enabled HTTP request header |
Example 1
Fetch a Service-Scoped Conversation
https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
chat_service_sid
Path
|
The SID of the Conversation Service the Conversation resource is associated with. |
sid
Path
|
A 34 character string that uniquely identifies this resource. Can also be the |
Example 1
Read multiple Service-Scoped Conversation resources
https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations
Parameters
| Parameters in REST API format | |
|---|---|
chat_service_sid
Path
|
The SID of the Conversation Service the Conversation resource is associated with. |
start_date
Optional
|
Start date or time in ISO8601 format for filtering list of Conversations. If a date is provided, the start time of the date is used (YYYY-MM-DDT00:00:00Z). Can be combined with other filters. |
end_date
Optional
|
End date or time in ISO8601 format for filtering list of Conversations. If a date is provided, the end time of the date is used (YYYY-MM-DDT23:59:59Z). Can be combined with other filters. |
state
Optional
|
State for sorting and filtering list of Conversations. Can be |
Example 1
Update a Service-Scoped Conversation resource
https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
chat_service_sid
Path
|
The SID of the Conversation Service the Conversation resource is associated with. |
sid
Path
|
A 34 character string that uniquely identifies this resource. Can also be the |
friendly_name
Optional
|
The human-readable name of this conversation, limited to 256 characters. Optional. |
date_created
Optional
|
The date that this resource was created. |
date_updated
Optional
|
The date that this resource was last updated. |
attributes
Optional
|
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. |
messaging_service_sid
Optional
|
The unique ID of the Messaging Service this conversation belongs to. |
state
Optional
|
Current state of this conversation. Can be either |
timers.inactive
Optional
|
ISO8601 duration when conversation will be switched to |
timers.closed
Optional
|
ISO8601 duration when conversation will be switched to |
unique_name
Optional
|
An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's |
x_twilio_webhook_enabled
Header
|
The X-Twilio-Webhook-Enabled HTTP request header |
Example 1
Delete a Service-Scoped Conversation
https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
chat_service_sid
Path
|
The SID of the Conversation Service the Conversation resource is associated with. |
sid
Path
|
A 34 character string that uniquely identifies this resource. Can also be the |
x_twilio_webhook_enabled
Header
|
The X-Twilio-Webhook-Enabled HTTP request header |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
