A Channel is a Programmable Chat object that is equivalent to a Conversation in the Conversations API.
Please see the Conversation Resource for Conversations that are already available to your Conversations application.
Only 'private' type Channels are automatically migrated to Conversations. For 'public' type Channels, please use this API to migrate them to 'private' type.
_10https://chat.twilio.com/v3
There is only one API endpoint on the v3 Chat API:
_10POST /Services/ISxx/Channels/CHxx
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/v3/Services/{ServiceSid}/Channels/{Sid}
Use this API to change a Channel's type from public
to private
. This makes it available in Conversations.
Read here to determine if you need to include a Messaging Service SID in your request.
X-Twilio-Webhook-Enabled
type: enum<string>The X-Twilio-Webhook-Enabled HTTP request header
true
false
Type
type: enum<string>TThe Type for this Channel to migrate to. Can only be private
. Migration to 'public' is not allowed.
public
private
MessagingServiceSid
type: SID<MG>The unique ID of the Messaging Service this channel belongs to.