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.
A Channel resource of Programmable Chat represents a chat room, which is a familiar concept for what is, programmatically, a scope in which Messages can be sent and received by its members. Members can be added or invited to join channels and Channels exist within a Chat Service scope.
Channels can have an optional unique_name
that can replace the Channel's {ChannelSid}
in the URL. This allows a channel to be named something specific and be addressed by that name. A Channel's unique_name
must be unique within its Service instance.
The User Channels resource lists all the Channels to which a specific User is a Member.
Chat Channels are organized by their Chat service. You can view that Channels in a Chat service by using your Twilio console when logged in to the console and selecting the Chat Service from the list. Within a Chat Service, you can browse its Channels.
Each Channel resource contains these properties.
sid
type: SID<CH>The unique string that we created to identify the Channel resource.
^CH[0-9a-fA-F]{32}$
34
34
account_sid
type: SID<AC>The SID of the Account that created the Channel resource.
^AC[0-9a-fA-F]{32}$
34
34
service_sid
type: SID<IS>The SID of the Service the Channel resource is associated with.
^IS[0-9a-fA-F]{32}$
34
34
unique_name
type: stringAn application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's sid
in the URL.
attributes
type: stringThe JSON string that stores application-specific data. If attributes have not been set, {}
is returned.
type
type: enum<string>The visibility of the channel. Can be: public
or private
.
public
private
date_created
type: string<date-time>The date and time in GMT when the resource was created specified in ISO 8601 format.
date_updated
type: string<date-time>The date and time in GMT when the resource was last updated specified in ISO 8601 format.
created_by
type: stringThe identity
of the User that created the channel. If the Channel was created by using the API, the value is system
.
POST https://chat.twilio.com/v2/Services/{ServiceSid}/Channels
X-Twilio-Webhook-Enabled
type: enum<string>The X-Twilio-Webhook-Enabled HTTP request header
true
false
ServiceSid
type: SID<IS>The SID of the Service to create the Channel resource under.
^IS[0-9a-fA-F]{32}$
34
34
FriendlyName
type: stringA descriptive string that you create to describe the new resource. It can be up to 64 characters long.
UniqueName
type: stringAn application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the Channel resource's sid
in the URL. This value must be 64 characters or less in length and be unique within the Service.
Type
type: enum<string>The visibility of the channel. Can be: public
or private
and defaults to public
.
public
private
DateCreated
type: string<date-time>The date, specified in ISO 8601 format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this should only be used in cases where a Channel is being recreated from a backup/separate source.
DateUpdated
type: string<date-time>The date, specified in ISO 8601 format, to assign to the resource as the date it was last updated. The default value is null
. Note that this parameter should only be used in cases where a Channel is being recreated from a backup/separate source and where a Message was previously updated.
CreatedBy
type: stringThe identity
of the User that created the channel. Default is: system
.
GET https://chat.twilio.com/v2/Services/{ServiceSid}/Channels/{Sid}
When fetching a Channel resource, the {Sid}
value can be either the sid
or the unique_name
of the Channel resource to fetch.
ServiceSid
type: SID<IS>The SID of the Service to fetch the Channel resource from.
^IS[0-9a-fA-F]{32}$
34
34
Sid
type: stringThe SID of the Channel resource to fetch. This value can be either the sid
or the unique_name
of the Channel resource to fetch.
GET https://chat.twilio.com/v2/Services/{ServiceSid}/Channels
ServiceSid
type: SID<IS>The SID of the Service to read the Channel resources from.
^IS[0-9a-fA-F]{32}$
34
34
Type
type: array[enum<string>]The visibility of the Channels to read. Can be: public
or private
and defaults to public
.
public
private
PageSize
type: integerHow many resources to return in each list page. The default is 50, and the maximum is 1000.
1
Page
type: integerThe page index. This value is simply for client state.
0
POST https://chat.twilio.com/v2/Services/{ServiceSid}/Channels/{Sid}
When updating a Channel resource, the {Sid}
value can be either the sid
or the unique_name
of the Channel resource to update.
X-Twilio-Webhook-Enabled
type: enum<string>The X-Twilio-Webhook-Enabled HTTP request header
true
false
ServiceSid
type: SID<IS>The SID of the Service to update the Channel resource in.
^IS[0-9a-fA-F]{32}$
34
34
Sid
type: stringThe SID of the Channel resource to update. This value can be either the sid
or the unique_name
of the Channel resource to update.
FriendlyName
type: stringA descriptive string that you create to describe the resource. It can be up to 256 characters long.
UniqueName
type: stringAn application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's sid
in the URL. This value must be 256 characters or less in length and unique within the Service.
DateCreated
type: string<date-time>The date, specified in ISO 8601 format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this should only be used in cases where a Channel is being recreated from a backup/separate source.
DateUpdated
type: string<date-time>The date, specified in ISO 8601 format, to assign to the resource as the date it was last updated.
CreatedBy
type: stringThe identity
of the User that created the channel. Default is: system
.
DELETE https://chat.twilio.com/v2/Services/{ServiceSid}/Channels/{Sid}
When deleting a Channel resource, the {Sid}
value can be either the sid
or the unique_name
of the Channel resource to delete.
X-Twilio-Webhook-Enabled
type: enum<string>The X-Twilio-Webhook-Enabled HTTP request header
true
false
ServiceSid
type: SID<IS>The SID of the Service to delete the resource from.
^IS[0-9a-fA-F]{32}$
34
34
Sid
type: stringThe SID of the Channel resource to delete. This value can be either the sid
or the unique_name
of the Channel resource to delete.