All URLs in the reference documentation use the following base URL:
_10https://conversations.twilio.com/v1
Using the REST API, you can interact with Conversation Message resources in the default Conversation Service instance via a "shortened" URL that does not include the Conversation Service instance SID ("ISXXX..."). If you are only using one Conversation Service (the default), you do not need to include the Conversation Service SID in your URL, e.g.
_10GET /v1/Conversations/CHxx/Messages
For Conversations applications that build on more than one Conversation Service instance, you will need to specify the Conversation Service SID in the REST API call:
_10GET /v1/Services/ISxx/Conversations/CHxx/Messages
The index of the message within the Conversation. Indices may skip numbers, but will always be in order of when the message was received.
The channel specific identifier of the message's author. Defaults to system
.
An array of objects that describe the Message's media, if the message contains media. Each object contains these fields: content_type
with the MIME type of the media, filename
with the name of the media, sid
with the SID of the Media resource, and size
with the media object's file size in bytes. If the Message has no media, this value is null
.
A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set "{}" will be returned.
The unique ID of messages's author participant. Null in case of system
sent message.
The date that this resource was last updated. null
if the message has not been edited.
An object that contains the summary of delivery statuses for the message to non-chat participants.
Contains an absolute API resource URL to access the delivery & read receipts of this message.
The unique ID of the multi-channel Rich Content template.
POST https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages
The X-Twilio-Webhook-Enabled HTTP request header
true
false
The channel specific identifier of the message's author. Defaults to system
.
The date that this resource was last updated. null
if the message has not been edited.
A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set "{}" will be returned.
The unique ID of the multi-channel Rich Content template, required for template-generated messages. Note that if this field is set, Body
and MediaSid
parameters are ignored.
A structurally valid JSON string that contains values to resolve Rich Content template variables.
The subject of the message, can be up to 256 characters long.
GET https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages/{Sid}
Fetch a Conversation Message by SID
GET https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages
The sort order of the returned messages. Can be: asc
(ascending) or desc
(descending), with asc
as the default.
asc
desc
How many resources to return in each list page. The default is 50, and the maximum is 1000.
List all messages in a Conversation
POST https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages/{Sid}
The X-Twilio-Webhook-Enabled HTTP request header
true
false
The channel specific identifier of the message's author. Defaults to system
.
The date that this resource was last updated. null
if the message has not been edited.
A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set "{}" will be returned.
The subject of the message, can be up to 256 characters long.
DELETE https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages/{Sid}
The X-Twilio-Webhook-Enabled HTTP request header
true
false