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)
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)
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:
Property name Type PII Description
The unique ID of the Account responsible for this service.
Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
A 34 character string that uniquely identifies this resource.
Pattern: ^IS[0-9a-fA-F]{32}$Min length: 34Max length: 34
The human-readable name of this service, limited to 256 characters. Optional.
date_created string<date-time> The date that this resource was created.
date_updated string<date-time> The 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/ServicesProperty name Type Required PII Description
FriendlyName string required The human-readable name of this service, limited to 256 characters. Optional.
_18 // Download the helper library from https://www.twilio.com/docs/node/install
_18 const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18 // Find your Account SID and Auth Token at twilio.com/console
_18 // and set the environment variables. See http://twil.io/secure
_18 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18 const authToken = process.env.TWILIO_AUTH_TOKEN;
_18 const client = twilio(accountSid, authToken);
_18 async function createService() {
_18 const service = await client.conversations.v1.services.create({
_18 friendlyName: "FriendlyName",
_18 console.log(service.accountSid);
_16 "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_16 "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_16 "friendly_name": "FriendlyName",
_16 "date_created": "2015-12-16T22:18:37Z",
_16 "date_updated": "2015-12-16T22:18:38Z",
_16 "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_16 "conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations",
_16 "users": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users",
_16 "roles": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles",
_16 "bindings": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings",
_16 "configuration": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration",
_16 "participant_conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations"
GET https://conversations.twilio.com/v1/Services/{Sid}Property name Type Required PII Description
A 34 character string that uniquely identifies this resource.
Pattern: ^IS[0-9a-fA-F]{32}$Min length: 34Max length: 34
_18 // Download the helper library from https://www.twilio.com/docs/node/install
_18 const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18 // Find your Account SID and Auth Token at twilio.com/console
_18 // and set the environment variables. See http://twil.io/secure
_18 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18 const authToken = process.env.TWILIO_AUTH_TOKEN;
_18 const client = twilio(accountSid, authToken);
_18 async function fetchService() {
_18 const service = await client.conversations.v1
_18 .services("ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18 console.log(service.accountSid);
_16 "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_16 "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_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/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_16 "conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations",
_16 "users": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users",
_16 "roles": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles",
_16 "bindings": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings",
_16 "configuration": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration",
_16 "participant_conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations"
GET https://conversations.twilio.com/v1/ServicesProperty name Type Required PII Description
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Minimum: 1Maximum: 1000
The page index. This value is simply for client state.
Minimum: 0
The page token. This is provided by the API.
_16 // Download the helper library from https://www.twilio.com/docs/node/install
_16 const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_16 // Find your Account SID and Auth Token at twilio.com/console
_16 // and set the environment variables. See http://twil.io/secure
_16 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_16 const authToken = process.env.TWILIO_AUTH_TOKEN;
_16 const client = twilio(accountSid, authToken);
_16 async function listService() {
_16 const services = await client.conversations.v1.services.list({ limit: 20 });
_16 services.forEach((s) => console.log(s.accountSid));
_29 "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29 "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_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/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29 "conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations",
_29 "users": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users",
_29 "roles": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles",
_29 "bindings": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings",
_29 "configuration": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration",
_29 "participant_conversations": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations"
_29 "first_page_url": "https://conversations.twilio.com/v1/Services?PageSize=50&Page=0",
_29 "previous_page_url": null,
_29 "url": "https://conversations.twilio.com/v1/Services?PageSize=50&Page=0",
_29 "next_page_url": null,
DELETE https://conversations.twilio.com/v1/Services/{Sid}Property name Type Required PII Description
A 34 character string that uniquely identifies this resource.
Pattern: ^IS[0-9a-fA-F]{32}$Min length: 34Max length: 34
_16 // Download the helper library from https://www.twilio.com/docs/node/install
_16 const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_16 // Find your Account SID and Auth Token at twilio.com/console
_16 // and set the environment variables. See http://twil.io/secure
_16 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_16 const authToken = process.env.TWILIO_AUTH_TOKEN;
_16 const client = twilio(accountSid, authToken);
_16 async function deleteService() {
_16 await client.conversations.v1
_16 .services("ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")