The Twilio Chat API offers REST operations to manage chat services, including credentials, channels, messages, members (users), invites, device bindings, and associated webhooks.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
POST
/v2/Credentials
DELETE
/v2/Credentials/{Sid}
Sid(path, required) — The SID of the Credential resource to delete.
GET
/v2/Credentials/{Sid}
Sid(path, required) — The SID of the Credential resource to fetch.
POST
/v2/Credentials/{Sid}
Sid(path, required) — The SID of the Credential resource to update.
GET
/v2/Services
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
POST
/v2/Services
GET
/v2/Services/{ServiceSid}/Bindings
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the Binding resources from.
BindingType(query) — The push technology used by the Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.
Identity(query) — The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
DELETE
/v2/Services/{ServiceSid}/Bindings/{Sid}
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the Binding resource from.
Sid(path, required) — The SID of the Binding resource to delete.
GET
/v2/Services/{ServiceSid}/Bindings/{Sid}
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the Binding resource from.
Sid(path, required) — The SID of the Binding resource to fetch.
GET
/v2/Services/{ServiceSid}/Channels
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the Channel resources from.
Type(query) — The visibility of the Channels to read. Can be: `public` or `private` and defaults to `public`.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
POST
/v2/Services/{ServiceSid}/Channels
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the Channel resource under.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the Invite resources from.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Invite resources to read belong to. This value can be the Channel resource's `sid` or `unique_name`.
Identity(query) — The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the Invite resource under.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the new Invite resource belongs to. This value can be the Channel resource's `sid` or `unique_name`.
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the Invite resource from.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Invite resource to delete belongs to. This value can be the Channel resource's `sid` or `unique_name`.
Sid(path, required) — The SID of the Invite resource to delete.
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the Invite resource from.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Invite resource to fetch belongs to. This value can be the Channel resource's `sid` or `unique_name`.
Sid(path, required) — The SID of the Invite resource to fetch.
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the Member resources from.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Member resources to read belong to. This value can be the Channel resource's `sid` or `unique_name`.
Identity(query) — The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the Member resources to read. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the Member resource under.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the new Member resource belongs to. This value can be the Channel resource's `sid` or `unique_name`.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the Member resource from.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Member resource to delete belongs to. This value can be the Channel resource's `sid` or `unique_name`.
Sid(path, required) — The SID of the Member resource to delete. This value can be either the Member's `sid` or its `identity` value.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the Member resource from.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Member resource to fetch belongs to. This value can be the Channel resource's `sid` or `unique_name`.
Sid(path, required) — The SID of the Member resource to fetch. This value can be either the Member's `sid` or its `identity` value.
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to update the Member resource in.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Member resource to update belongs to. This value can be the Channel resource's `sid` or `unique_name`.
Sid(path, required) — The SID of the Member resource to update. This value can be either the Member's `sid` or its `identity` value.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the Message resources from.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Message resource to read belongs to. This value can be the Channel resource's `sid` or `unique_name`.
Order(query) — The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending) with `asc` as the default.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the Message resource under.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the new Message resource belongs to. This value can be the Channel resource's `sid` or `unique_name`.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the Message resource from.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Message resource to delete belongs to. This value can be the Channel resource's `sid` or `unique_name`.
Sid(path, required) — The SID of the Message resource to delete.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the Message resource from.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Message resource to fetch belongs to. This value can be the Channel resource's `sid` or `unique_name`.
Sid(path, required) — The SID of the Message resource to fetch.
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to update the Message resource in.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Message resource to update belongs to. This value can be the Channel resource's `sid` or `unique_name`.
Sid(path, required) — The SID of the Message resource to update.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) with the Channel to read the resources from.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook resources to read belong to. This value can be the Channel resource's `sid` or `unique_name`.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) with the Channel to create the Webhook resource under.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the new Channel Webhook resource belongs to. This value can be the Channel resource's `sid` or `unique_name`.
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) with the Channel to delete the Webhook resource from.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook resource to delete belongs to. This value can be the Channel resource's `sid` or `unique_name`.
Sid(path, required) — The SID of the Channel Webhook resource to delete.
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) with the Channel to fetch the Webhook resource from.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook resource to fetch belongs to. This value can be the Channel resource's `sid` or `unique_name`.
Sid(path, required) — The SID of the Channel Webhook resource to fetch.
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) with the Channel that has the Webhook resource to update.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook resource to update belongs to. This value can be the Channel resource's `sid` or `unique_name`.
Sid(path, required) — The SID of the Channel Webhook resource to update.
DELETE
/v2/Services/{ServiceSid}/Channels/{Sid}
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the resource from.
Sid(path, required) — The SID of the Channel resource to delete. This value can be either the `sid` or the `unique_name` of the Channel resource to delete.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
GET
/v2/Services/{ServiceSid}/Channels/{Sid}
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the Channel resource from.
Sid(path, required) — The SID of the Channel resource to fetch. This value can be either the `sid` or the `unique_name` of the Channel resource to fetch.
POST
/v2/Services/{ServiceSid}/Channels/{Sid}
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to update the Channel resource in.
Sid(path, required) — The SID of the Channel resource to update. This value can be either the `sid` or the `unique_name` of the Channel resource to update.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
GET
/v2/Services/{ServiceSid}/Roles
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the Role resources from.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
POST
/v2/Services/{ServiceSid}/Roles
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the Role resource under.
DELETE
/v2/Services/{ServiceSid}/Roles/{Sid}
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the Role resource from.
Sid(path, required) — The SID of the Role resource to delete.
GET
/v2/Services/{ServiceSid}/Roles/{Sid}
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the Role resource from.
Sid(path, required) — The SID of the Role resource to fetch.
POST
/v2/Services/{ServiceSid}/Roles/{Sid}
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to update the Role resource in.
Sid(path, required) — The SID of the Role resource to update.
GET
/v2/Services/{ServiceSid}/Users
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the User resources from.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
POST
/v2/Services/{ServiceSid}/Users
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the User resource under.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
DELETE
/v2/Services/{ServiceSid}/Users/{Sid}
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the User resource from.
Sid(path, required) — The SID of the User resource to delete. This value can be either the `sid` or the `identity` of the User resource to delete.
GET
/v2/Services/{ServiceSid}/Users/{Sid}
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the User resource from.
Sid(path, required) — The SID of the User resource to fetch. This value can be either the `sid` or the `identity` of the User resource to fetch.
POST
/v2/Services/{ServiceSid}/Users/{Sid}
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to update the User resource in.
Sid(path, required) — The SID of the User resource to update. This value can be either the `sid` or the `identity` of the User resource to update.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the User Binding resources from.
UserSid(path, required) — The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User Binding resources to read. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.
BindingType(query) — The push technology used by the User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the User Binding resource from.
UserSid(path, required) — The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User Binding resources to delete. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.
Sid(path, required) — The SID of the User Binding resource to delete.
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the User Binding resource from.
UserSid(path, required) — The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User Binding resource to fetch. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.
Sid(path, required) — The SID of the User Binding resource to fetch.
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the User Channel resources from.
UserSid(path, required) — The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) to read the User Channel resources from. This value can be either the `sid` or the `identity` of the User resource.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the User Channel resource from.
UserSid(path, required) — The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) to fetch the User Channel resource from. This value can be either the `sid` or the `identity` of the User resource.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) that has the User Channel to fetch. This value can be either the `sid` or the `unique_name` of the Channel to fetch.
ServiceSid(path, required) — The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to update the User Channel resource in.
UserSid(path, required) — The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) to update the User Channel resource from. This value can be either the `sid` or the `identity` of the User resource.
ChannelSid(path, required) — The SID of the [Channel](https://www.twilio.com/docs/chat/channels) with the User Channel resource to update. This value can be the Channel resource's `sid` or `unique_name`.
DELETE
/v2/Services/{Sid}
Sid(path, required) — The SID of the Service resource to delete.
GET
/v2/Services/{Sid}
Sid(path, required) — The SID of the Service resource to fetch.
POST
/v2/Services/{Sid}
Sid(path, required) — The SID of the Service resource to update.
54 endpoints auto-detected
Authentication
This API uses Basic authentication (a username and password).
curl -X GET \
"https://chat.twilio.com/v2/Credentials"
