Conversation Message Resource
API Base URL
All URLs in the reference documentation use the following base URL:
https://conversations.twilio.com/v1Using the shortened base URL
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.
GET /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:
GET /v1/Services/ISxx/Conversations/CHxx/MessagesConversationMessage properties
| Resource Properties in REST API format | |
|---|---|
account_sid
|
The unique ID of the Account responsible for this message. |
conversation_sid
|
The unique ID of the Conversation for this message. |
sid
|
A 34 character string that uniquely identifies this resource. |
index
|
The index of the message within the Conversation. Indices may skip numbers, but will always be in order of when the message was received. |
author
|
The channel specific identifier of the message's author. Defaults to |
body
|
The content of the message, can be up to 1,600 characters long. |
media
|
An array of objects that describe the Message's media, if the message contains media. Each object contains these fields: |
attributes
|
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. |
participant_sid
|
The unique ID of messages's author participant. Null in case of |
date_created
|
The date that this resource was created. |
date_updated
|
The date that this resource was last updated. |
url
|
An absolute API resource API URL for this message. |
delivery
|
An object that contains the summary of delivery statuses for the message to non-chat participants. |
links
|
Contains an absolute API resource URL to access the delivery & read receipts of this message. |
Create a ConversationMessage resource
https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages
Parameters
| Parameters in REST API format | |
|---|---|
conversation_sid
Path
|
The unique ID of the Conversation for this message. |
author
Optional
|
The channel specific identifier of the message's author. Defaults to |
body
Optional
|
The content of the message, can be up to 1,600 characters long. |
date_created
Optional
|
The date that this resource was created. |
date_updated
Optional
|
The date that this resource was last updated. |
attributes
Optional
|
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. |
media_sid
Optional
|
The Media SID to be attached to the new Message. |
x_twilio_webhook_enabled
Header
|
The X-Twilio-Webhook-Enabled HTTP request header |
Example 1
Fetch a ConversationMessage resource
https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
conversation_sid
Path
|
The unique ID of the Conversation for this message. |
sid
Path
|
A 34 character string that uniquely identifies this resource. |
Example 1
List all Conversation Message(s)
https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages
Parameters
| Parameters in REST API format | |
|---|---|
conversation_sid
Path
|
The unique ID of the Conversation for messages. |
order
Optional
|
The sort order of the returned messages. Can be: |
Example 1
Example 2
Update a ConversationMessage resource
https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
conversation_sid
Path
|
The unique ID of the Conversation for this message. |
sid
Path
|
A 34 character string that uniquely identifies this resource. |
author
Optional
|
The channel specific identifier of the message's author. Defaults to |
body
Optional
|
The content of the message, can be up to 1,600 characters long. |
date_created
Optional
|
The date that this resource was created. |
date_updated
Optional
|
The date that this resource was last updated. |
attributes
Optional
|
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. |
x_twilio_webhook_enabled
Header
|
The X-Twilio-Webhook-Enabled HTTP request header |
Example 1
Delete a ConversationMessage resource
https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
conversation_sid
Path
|
The unique ID of the Conversation for this message. |
sid
Path
|
A 34 character string that uniquely identifies this resource. |
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.
