v1 Reference
Danger
Programmable Chat has been deprecated and is no longer supported. Instead, we'll be focusing on the next generation of chat: Twilio Conversations. Find out more about the EOL process here.
If you're starting a new project, please visit the Conversations Docs to begin. If you've already built on Programmable Chat, please visit our Migration Guide to learn about how to switch.
Danger
This is reference documentation for the v1 REST API, which has been deprecated. You should use the current v2 REST API.
The Programmable Chat REST API allows you to control your Chat applications from the server in much the same way you can from the client, except from a service perspective rather than a 1st person one. You can create channels, send messages, and query the state of your messaging applications using the resources in this REST API.
All URLs in the reference documentation use the following base URL:
https://chat.twilio.com/v1
All requests to the Programmable Chat REST API are served over HTTPS. Unencrypted HTTP is not supported.
To authenticate requests to the Twilio APIs, Twilio supports HTTP Basic authentication. Use your API key as the username and your API key secret as the password. You can create an API key either in the Twilio Console or using the API.
Note: Twilio recommends using API keys for authentication in production apps. For local testing, you can use your Account SID as the username and your Auth token as the password. You can find your Account SID and Auth Token in the Twilio Console.
Learn more about Twilio API authentication.
1curl -G https://chat.twilio.com/v1/Services \2-u $TWILIO_API_KEY:$TWILIO_API_KEY_SECRET
You can use the Twilio Helper Libraries to interact with the Programmable Chat REST endpoints.
Programmable Chat is available in the Next Gen Release builds of the Twilio Helper Libraries.
Here are the resources you will be interacting with via the REST API:
| Resource | Description |
|---|---|
| Channels | A "chat room" - a scope in which messages can be sent or received |
| Credentials | Credentials used by Twilio to integrate with Google Cloud Messaging or Apple Push Notifications Service |
| Invites | Represents all pending invitations to Users within the Service instance to become a Member of the Channel. |
| Members | Members of a Channel |
| Messages | Messages sent to a Channel |
| Roles | Define actions users are allowed to take in a Channel or Service scope |
| Services | A service roughly maps to a Chat app. Channels, Users, Credentials, and all the REST (see what I did there?) are scoped to a Service. Can define webhook URLs for events in a service |
| Users | A user with a unique identity within the scope of your Service |