APIHub
Back to Explore

Twilio - Chat

The Twilio Chat REST API provides programmatic access to create, read, update, and delete chat services, channels, messages, members, users, invites, roles, and credentials for building chat-enabled applications.

Telecom
basic
HTTPS
CORS: Unknown
Description enriched …
Visit official documentation

Latency

1024ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/v1/Credentials

  • 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

/v1/Credentials

DELETE

/v1/Credentials/{Sid}

  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Credential resource to delete.
GET

/v1/Credentials/{Sid}

  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Credential resource to fetch.
POST

/v1/Credentials/{Sid}

  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Credential resource to update.
GET

/v1/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

/v1/Services

GET

/v1/Services/{ServiceSid}/Channels

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the 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

/v1/Services/{ServiceSid}/Channels

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to create the resource under.
POST

/v1/Services/{ServiceSid}/Roles/{Sid}

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to update the resource from.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Role resource to update.
GET

/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.
  • ChannelSid (path, required) — The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resources to read belong to.
  • Identity (query) — The [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/api/chat/guides/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.
POST

/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to create the resource under.
  • ChannelSid (path, required) — The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the new resource belongs to.
DELETE

/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to delete the resource from.
  • ChannelSid (path, required) — The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resource to delete belongs to.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Invite resource to delete.
GET

/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.
  • ChannelSid (path, required) — The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resource to fetch belongs to.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Invite resource to fetch.
GET

/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.
  • ChannelSid (path, required) — The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the members to read belong to. Can be the Channel resource's `sid` or `unique_name` value.
  • Identity (query) — The [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/api/chat/guides/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.
POST

/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to create the resource under.
  • ChannelSid (path, required) — The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the new member belongs to. Can be the Channel resource's `sid` or `unique_name`.
DELETE

/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to delete the resource from.
  • ChannelSid (path, required) — The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message belongs to. Can be the Channel's `sid` or `unique_name`.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Member resource to delete.
GET

/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.
  • ChannelSid (path, required) — The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the member to fetch belongs to. Can be the Channel resource's `sid` or `unique_name` value.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Member resource to fetch.
POST

/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to update the resource from.
  • ChannelSid (path, required) — The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the member to update belongs to. Can be the Channel resource's `sid` or `unique_name`.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Member resource to update.
GET

/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.
  • ChannelSid (path, required) — The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message to read belongs to. Can be the Channel'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.
POST

/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to create the resource under.
  • ChannelSid (path, required) — The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the new resource belongs to. Can be the Channel resource's `sid` or `unique_name`.
DELETE

/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to delete the resource from.
  • ChannelSid (path, required) — The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message to delete belongs to. Can be the Channel resource's `sid` or `unique_name`.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Message resource to delete.
GET

/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.
  • ChannelSid (path, required) — The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message to fetch belongs to. Can be the Channel's `sid` or `unique_name`.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Message resource to fetch.
POST

/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to update the resource from.
  • ChannelSid (path, required) — The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message belongs to. Can be the Channel's `sid` or `unique_name`.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Message resource to update.
DELETE

/v1/Services/{ServiceSid}/Channels/{Sid}

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to delete the resource from.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Channel resource to delete.
GET

/v1/Services/{ServiceSid}/Channels/{Sid}

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Channel resource to fetch.
POST

/v1/Services/{ServiceSid}/Channels/{Sid}

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to update the resource from.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Channel resource to update.
GET

/v1/Services/{ServiceSid}/Roles

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the 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

/v1/Services/{ServiceSid}/Roles

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to create the resource under.
DELETE

/v1/Services/{ServiceSid}/Roles/{Sid}

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to delete the resource from.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Role resource to delete.
GET

/v1/Services/{ServiceSid}/Roles/{Sid}

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Role resource to fetch.
GET

/v1/Services/{ServiceSid}/Users

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the 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

/v1/Services/{ServiceSid}/Users

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to create the resource under.
DELETE

/v1/Services/{ServiceSid}/Users/{Sid}

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to delete the resource from.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the User resource to delete.
GET

/v1/Services/{ServiceSid}/Users/{Sid}

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the resource from.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the User resource to fetch.
POST

/v1/Services/{ServiceSid}/Users/{Sid}

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to update the resource from.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the User resource to update.
GET

/v1/Services/{ServiceSid}/Users/{UserSid}/Channels

List all Channels for a given User.

  • ServiceSid (path, required) — The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.
  • UserSid (path, required) — The SID of the [User](https://www.twilio.com/docs/api/chat/rest/users) to read the User Channel 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.
DELETE

/v1/Services/{Sid}

  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Service resource to delete.
GET

/v1/Services/{Sid}

  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Service resource to fetch.
POST

/v1/Services/{Sid}

  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Service resource to update.

40 endpoints auto-detected

Authentication

This API uses Basic authentication (a username and password).

curl -X GET \
  "https://chat.twilio.com/v1/Credentials"

chat.twilio.com · HTTPS only