Programmable Chat Message Resource
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.
Message properties
Each Message resource contains these properties.
Resource Properties in REST API format | |
---|---|
sid
|
The unique string that we created to identify the Message resource. |
account_sid
|
The SID of the Account that created the Message resource. |
attributes
|
The JSON string that stores application-specific data. If attributes have not been set, |
service_sid
|
The SID of the Service the Message resource is associated with. |
to
|
The SID of the Channel that the message was sent to. |
channel_sid
|
The SID of the Channel the Message resource belongs to. |
date_created
|
The date and time in GMT when the resource was created specified in ISO 8601 format. |
date_updated
|
The date and time in GMT when the resource was last updated specified in ISO 8601 format. |
last_updated_by
|
The Identity of the User who last updated the Message, if applicable. |
was_edited
|
Whether the message has been edited since it was created. |
from
|
The Identity of the message's author. The default value is |
body
|
The content of the message. |
index
|
The index of the message within the Channel. Indices may skip numbers, but will always be in order of when the message was received. |
type
|
The Message type. Can be: |
media
|
An object that describes the Message's media, if the message contains media. The object contains these fields: |
url
|
The absolute URL of the Message resource. |
Create a Message resource
https://chat.twilio.com/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages
The {ChannelSid}
value can be the Channel resource's sid
or unique_name
.
Creating a new Message resource in a Channel sends a message to the Channel.
Parameters
Parameters in REST API format | |
---|---|
service_sid
Path
|
The SID of the Service to create the Message resource under. |
channel_sid
Path
|
The SID of the Channel the new Message resource belongs to. This value can be the Channel resource's |
from
Optional
|
The Identity of the new message's author. The default value is |
attributes
Optional
|
A valid JSON string that contains application-specific data. |
date_created
Optional
|
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. This parameter should only be used when a Chat's history is being recreated from a backup/separate source. |
date_updated
Optional
|
The date, specified in ISO 8601 format, to assign to the resource as the date it was last updated. |
last_updated_by
Optional
|
The Identity of the User who last updated the Message, if applicable. |
body
Optional
|
The message to send to the channel. Can be an empty string or |
media_sid
Optional
|
The SID of the Media to attach to the new Message. |
x_twilio_webhook_enabled
Header
|
The X-Twilio-Webhook-Enabled HTTP request header |
Example 1
Fetch a Message resource
https://chat.twilio.com/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}
The {ChannelSid}
value can be the Channel resource's sid
or unique_name
.
Parameters
Parameters in REST API format | |
---|---|
service_sid
Path
|
The SID of the Service to fetch the Message resource from. |
channel_sid
Path
|
The SID of the Channel the Message resource to fetch belongs to. This value can be the Channel resource's |
sid
Path
|
The SID of the Message resource to fetch. |
Example 1
Read multiple Message resources
https://chat.twilio.com/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages
The {ChannelSid}
value can be the Channel resource's sid
or unique_name
.
Parameters
Parameters in REST API format | |
---|---|
service_sid
Path
|
The SID of the Service to read the Message resources from. |
channel_sid
Path
|
The SID of the Channel the Message resource to read belongs to. This value can be the Channel resource's |
order
Optional
|
The sort order of the returned messages. Can be: |
Example 1
Update a Message resource
https://chat.twilio.com/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}
The {ChannelSid}
value can be the Channel resource's sid
or unique_name
.
Parameters
Parameters in REST API format | |
---|---|
service_sid
Path
|
The SID of the Service to update the Message resource in. |
channel_sid
Path
|
The SID of the Channel the Message resource to update belongs to. This value can be the Channel resource's |
sid
Path
|
The SID of the Message resource to update. |
body
Optional
|
The message to send to the channel. Can be an empty string or |
attributes
Optional
|
A valid JSON string that contains application-specific data. |
date_created
Optional
|
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. This parameter should only be used when a Chat's history is being recreated from a backup/separate source. |
date_updated
Optional
|
The date, specified in ISO 8601 format, to assign to the resource as the date it was last updated. |
last_updated_by
Optional
|
The Identity of the User who last updated the Message, if applicable. |
from
Optional
|
The Identity of the message's author. |
x_twilio_webhook_enabled
Header
|
The X-Twilio-Webhook-Enabled HTTP request header |
Example 1
Delete a Message resource
https://chat.twilio.com/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}
The {ChannelSid}
value can be the Channel resource's sid
or unique_name
.
Parameters
Parameters in REST API format | |
---|---|
service_sid
Path
|
The SID of the Service to delete the Message resource from. |
channel_sid
Path
|
The SID of the Channel the Message resource to delete belongs to. This value can be the Channel resource's |
sid
Path
|
The SID of the Message resource to delete. |
x_twilio_webhook_enabled
Header
|
The X-Twilio-Webhook-Enabled HTTP request header |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.