Conversation Service Resource
A Conversation Service is the top-level container for other resources in the Twilio Conversations REST API. All other Twilio Conversations resources, such as Conversations , Users , Messages , Bindings , and Credentials belong to a specific Service.
Services allow you to:
Create multiple, distinct environments (such as
dev, stage,
and
prod
) under a single Twilio account
Scope access to resources through both the REST and client APIs
Configure different Service instances with specific behaviors
A Service can also send HTTPS requests (webhooks) to URLs that you define to let you know of specific events. See what events you can subscribe to in our webhook reference(link takes you to an external page) .
Danger Do not use Personally Identifiable Information (PII) for the friendlyName field.
Avoid using a person's name, home address, email, phone number, or other PII in the friendlyName
field. Use some form of pseudonymized identifier, instead.
You can learn more about how we process your data in our privacy policy.(link takes you to an external page)
You can use the REST API to configure your Conversation Service instances. (See the following examples.)
You can also find the default Conversation Service instance under Defaults in the Conversations Section(link takes you to an external page) of the Twilio Console.
You may have created non-default Conversation Service resources to separate messaging traffic, create development environments, etc. To access any non-default Conversation Service resources, the Service Sid (ISXXX
) has to be a part of the url, as shown below:
_10 https://conversations.twilio.com/v1/Services/ISXXX
_10 https://conversations.twilio.com/v1/Services/ISXXX/Conversations
_10 https://conversations.twilio.com/v1/Services/ISXXX/Conversations/CHXXX/Participants
_10 https://conversations.twilio.com/v1/Services/ISXXX/Conversations/CHXXX/Messages
The Service resource contains these properties:
Resource properties A 34 character string that uniquely identifies this resource.
The human-readable name of this service, limited to 256 characters. Optional.
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.
An absolute API resource URL for this service.
Contains absolute API resource URLs to access conversations, users, roles, bindings and configuration of this service.
POST https://conversations.twilio.com/v1/Services
Request body parameters Required
The human-readable name of this service, limited to 256 characters. Optional.
_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
_10 .create({friendlyName: 'friendly_name'})
_10 .then(service => console.log(service.sid));
_16 "sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_16 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_16 "friendly_name": "friendly_name",
_16 "date_created": "2015-12-16T22:18:37Z",
_16 "date_updated": "2015-12-16T22:18:38Z",
_16 "url": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_16 "conversations": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations",
_16 "users": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users",
_16 "roles": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Roles",
_16 "bindings": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Bindings",
_16 "configuration": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Configuration",
_16 "participant_conversations": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ParticipantConversations"
GET https://conversations.twilio.com/v1/Services/{Sid}
URI parameters Path Parameter
A 34 character string that uniquely identifies this resource.
_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 .then(service => console.log(service.friendlyName));
_16 "sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_16 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_16 "friendly_name": "My First Service",
_16 "date_created": "2015-12-16T22:18:37Z",
_16 "date_updated": "2015-12-16T22:18:38Z",
_16 "url": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_16 "conversations": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations",
_16 "users": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users",
_16 "roles": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Roles",
_16 "bindings": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Bindings",
_16 "configuration": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Configuration",
_16 "participant_conversations": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ParticipantConversations"
GET https://conversations.twilio.com/v1/Services
URI parameters 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.
_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
_10 .then(services => services.forEach(s => console.log(s.sid)));
_29 "sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_29 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_29 "friendly_name": "Home Service",
_29 "date_created": "2015-12-16T22:18:37Z",
_29 "date_updated": "2015-12-16T22:18:38Z",
_29 "url": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_29 "conversations": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conversations",
_29 "users": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users",
_29 "roles": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Roles",
_29 "bindings": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Bindings",
_29 "configuration": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Configuration",
_29 "participant_conversations": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ParticipantConversations"
_29 "first_page_url": "https://conversations.twilio.com/v1/Services?PageSize=50&Page=0",
_29 "previous_page_url": "https://conversations.twilio.com/v1/Services?PageSize=50&Page=0",
_29 "url": "https://conversations.twilio.com/v1/Services?PageSize=50&Page=0",
_29 "next_page_url": "https://conversations.twilio.com/v1/Services?PageSize=50&Page=1",
DELETE https://conversations.twilio.com/v1/Services/{Sid}
URI parameters Path Parameter
A 34 character string that uniquely identifies this resource.
_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')