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.
An Invite resource for Programmable Chat represents an invitation for a User (within the Service instance) to join a Channel and become a Member.
Each Invite resource contains these properties.
sid
type: SID<IN>The unique string that we created to identify the Invite resource.
^IN[0-9a-fA-F]{32}$
34
34
account_sid
type: SID<AC>The SID of the Account that created the Invite resource.
^AC[0-9a-fA-F]{32}$
34
34
channel_sid
type: SID<CH>The SID of the Channel the Invite resource belongs to.
^CH[0-9a-fA-F]{32}$
34
34
service_sid
type: SID<IS>The SID of the Service the Invite resource is associated with.
^IS[0-9a-fA-F]{32}$
34
34
identity
type: stringThe application-defined string that uniquely identifies the resource's User within the Service. See access tokens for more info.
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.
role_sid
type: SID<RL>The SID of the Role assigned to the resource.
^RL[0-9a-fA-F]{32}$
34
34
POST https://chat.twilio.com/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites
The {ChannelSid}
value can be the Channel's sid
or its unique_name
.
ServiceSid
type: SID<IS>The SID of the Service to create the Invite resource under.
^IS[0-9a-fA-F]{32}$
34
34
ChannelSid
type: stringThe SID of the Channel the new Invite resource belongs to. This value can be the Channel resource's sid
or unique_name
.
Identity
type: stringRequiredThe identity
value that uniquely identifies the new resource's User within the Service. See access tokens for more info.
GET https://chat.twilio.com/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}
The {ChannelSid}
value can be the Channel's sid
or its unique_name
.
ServiceSid
type: SID<IS>The SID of the Service to fetch the Invite resource from.
^IS[0-9a-fA-F]{32}$
34
34
ChannelSid
type: stringThe SID of the Channel the Invite resource to fetch belongs to. This value can be the Channel resource's sid
or unique_name
.
Sid
type: SID<IN>The SID of the Invite resource to fetch.
^IN[0-9a-fA-F]{32}$
34
34
GET https://chat.twilio.com/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites
The {ChannelSid}
value can be the Channel's sid
or its unique_name
.
ServiceSid
type: SID<IS>The SID of the Service to read the Invite resources from.
^IS[0-9a-fA-F]{32}$
34
34
ChannelSid
type: stringThe SID of the Channel the Invite resources to read belong to. This value can be the Channel resource's sid
or unique_name
.
Identity
type: array[string]The User's identity
value of the resources to read. See access tokens for more details.
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
DELETE https://chat.twilio.com/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}
The {ChannelSid}
value can be the Channel's sid
or its unique_name
.
ServiceSid
type: SID<IS>The SID of the Service to delete the Invite resource from.
^IS[0-9a-fA-F]{32}$
34
34
ChannelSid
type: stringThe SID of the Channel the Invite resource to delete belongs to. This value can be the Channel resource's sid
or unique_name
.
Sid
type: SID<IN>The SID of the Invite resource to delete.
^IN[0-9a-fA-F]{32}$
34
34