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.
All URLs in the reference documentation use the following base URL:
_10 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:
_10 GET /v1/Services/ISxx/Conversations/CHxx/Messages
Resource properties chat_service_sid
type: SID<IS> Not PIImessaging_service_sid
type: SID<MG> Not PIIA 34 character string that uniquely identifies this resource.
The human-readable name of this conversation, limited to 256 characters. Optional.
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.
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.
Current state of this conversation. Can be either active
, inactive
or closed
and defaults to active
Possible values:
inactive
active
closed
date_created
type: string<DATE TIME> Not PIIThe date that this resource was created.
date_updated
type: string<DATE TIME> Not PIIThe date that this resource was last updated.
Timer date values representing state update for this conversation.
An absolute API resource URL for this conversation.
POST https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations
Request headers X-Twilio-Webhook-Enabled
type: enum<STRING> Not PII
The X-Twilio-Webhook-Enabled HTTP request header
Possible values:
true
false
URI parameters Request body parameters The human-readable name of this conversation, limited to 256 characters. Optional.
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.
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.
MessagingServiceSid
type: SID<MG> Not PIIDateCreated
type: string<DATE TIME> Not PIIThe date that this resource was created.
DateUpdated
type: string<DATE TIME> Not PIIThe date that this resource was last updated.
Current state of this conversation. Can be either active
, inactive
or closed
and defaults to active
Possible values:
inactive
active
closed
ISO8601 duration when conversation will be switched to inactive
state. Minimum value for this timer is 1 minute.
ISO8601 duration when conversation will be switched to closed
state. Minimum value for this timer is 10 minutes.
Bindings.Email.Address
type: string Not PIIThe default email address that will be used when sending outbound emails in this conversation.
Bindings.Email.Name
type: string Not PIIThe default name that will be used when sending outbound emails in this conversation.
_11 // Download the helper library from https://www.twilio.com/docs/node/install
_11 // Find your Account SID and Auth Token at twilio.com/console
_11 // and set the environment variables. See http://twil.io/secure
_11 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11 const authToken = process.env.TWILIO_AUTH_TOKEN;
_11 const client = require('twilio')(accountSid, authToken);
_11 client.conversations.v1.services('ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .then(conversation => console.log(conversation.sid));
_25 "sid": "CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "chat_service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "messaging_service_sid": "MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "friendly_name": "friendly_name",
_25 "unique_name": "unique_name",
_25 "date_created": "2015-12-16T22:18:37Z",
_25 "date_updated": "2015-12-16T22:18:38Z",
_25 "date_inactive": "2015-12-16T22:19:38Z",
_25 "date_closed": "2015-12-16T22:28:38Z"
_25 "url": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "participants": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants",
_25 "messages": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Messages",
_25 "webhooks": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Webhooks"
GET https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{Sid}
URI parameters Path Parameter
A 34 character string that uniquely identifies this resource. Can also be the unique_name
of the Conversation.
_11 // Download the helper library from https://www.twilio.com/docs/node/install
_11 // Find your Account SID and Auth Token at twilio.com/console
_11 // and set the environment variables. See http://twil.io/secure
_11 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11 const authToken = process.env.TWILIO_AUTH_TOKEN;
_11 const client = require('twilio')(accountSid, authToken);
_11 client.conversations.v1.services('ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .conversations('CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .then(conversation => console.log(conversation.friendlyName));
_25 "sid": "CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "chat_service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "messaging_service_sid": "MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "friendly_name": "My First Conversation",
_25 "unique_name": "first_conversation",
_25 "date_created": "2015-12-16T22:18:37Z",
_25 "date_updated": "2015-12-16T22:18:38Z",
_25 "date_inactive": "2015-12-16T22:19:38Z",
_25 "date_closed": "2015-12-16T22:28:38Z"
_25 "url": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "participants": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants",
_25 "messages": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Messages",
_25 "webhooks": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Webhooks"
GET https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations
URI parameters Query Parameter
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.
Query Parameter
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.
Query Parameter
State for sorting and filtering list of Conversations. Can be active
, inactive
or closed
Possible values:
inactive
active
closed
Query Parameter
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Query Parameter
The page index. This value is simply for client state.
Query Parameter
The page token. This is provided by the API.
_11 // Download the helper library from https://www.twilio.com/docs/node/install
_11 // Find your Account SID and Auth Token at twilio.com/console
_11 // and set the environment variables. See http://twil.io/secure
_11 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11 const authToken = process.env.TWILIO_AUTH_TOKEN;
_11 const client = require('twilio')(accountSid, authToken);
_11 client.conversations.v1.services('ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .then(conversations => conversations.forEach(c => console.log(c.sid)));
_38 "sid": "CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_38 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_38 "chat_service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_38 "messaging_service_sid": "MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_38 "friendly_name": "Home Repair Visit",
_38 "date_created": "2015-12-16T22:18:37Z",
_38 "date_updated": "2015-12-16T22:18:38Z",
_38 "date_inactive": "2015-12-16T22:19:38Z",
_38 "date_closed": "2015-12-16T22:28:38Z"
_38 "url": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_38 "participants": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants",
_38 "messages": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Messages",
_38 "webhooks": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Webhooks"
_38 "first_page_url": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations?PageSize=50&Page=0",
_38 "previous_page_url": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations?PageSize=50&Page=0",
_38 "url": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations?PageSize=50&Page=0",
_38 "next_page_url": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations?PageSize=50&Page=1",
_38 "key": "conversations"
POST https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{Sid}
Request headers X-Twilio-Webhook-Enabled
type: enum<STRING> Not PII
The X-Twilio-Webhook-Enabled HTTP request header
Possible values:
true
false
URI parameters Path Parameter
A 34 character string that uniquely identifies this resource. Can also be the unique_name
of the Conversation.
Request body parameters The human-readable name of this conversation, limited to 256 characters. Optional.
DateCreated
type: string<DATE TIME> Not PIIThe date that this resource was created.
DateUpdated
type: string<DATE TIME> Not PIIThe date that this resource was last updated.
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.
MessagingServiceSid
type: SID<MG> Not PIICurrent state of this conversation. Can be either active
, inactive
or closed
and defaults to active
Possible values:
inactive
active
closed
ISO8601 duration when conversation will be switched to inactive
state. Minimum value for this timer is 1 minute.
ISO8601 duration when conversation will be switched to closed
state. Minimum value for this timer is 10 minutes.
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.
Bindings.Email.Address
type: string Not PIIThe default email address that will be used when sending outbound emails in this conversation.
Bindings.Email.Name
type: string Not PIIThe default name that will be used when sending outbound emails in this conversation.
_11 // Download the helper library from https://www.twilio.com/docs/node/install
_11 // Find your Account SID and Auth Token at twilio.com/console
_11 // and set the environment variables. See http://twil.io/secure
_11 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11 const authToken = process.env.TWILIO_AUTH_TOKEN;
_11 const client = require('twilio')(accountSid, authToken);
_11 client.conversations.v1.services('ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .conversations('CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .update({friendlyName: 'friendly_name'})
_11 .then(conversation => console.log(conversation.friendlyName));
_25 "sid": "CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "chat_service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "messaging_service_sid": "MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "friendly_name": "friendly_name",
_25 "unique_name": "unique_name",
_25 "date_created": "2015-12-16T22:18:37Z",
_25 "date_updated": "2015-12-16T22:18:38Z",
_25 "date_inactive": "2015-12-16T22:19:38Z",
_25 "date_closed": "2015-12-16T22:28:38Z"
_25 "url": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "participants": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants",
_25 "messages": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Messages",
_25 "webhooks": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Webhooks"
DELETE https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{Sid}
Request headers X-Twilio-Webhook-Enabled
type: enum<STRING> Not PII
The X-Twilio-Webhook-Enabled HTTP request header
Possible values:
true
false
URI parameters Path Parameter
A 34 character string that uniquely identifies this resource. Can also be the unique_name
of the Conversation.
_10 // Download the helper library from https://www.twilio.com/docs/node/install
_10 // Find your Account SID and Auth Token at twilio.com/console
_10 // and set the environment variables. See http://twil.io/secure
_10 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10 const authToken = process.env.TWILIO_AUTH_TOKEN;
_10 const client = require('twilio')(accountSid, authToken);
_10 client.conversations.v1.services('ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10 .conversations('CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')