Conversation Message Receipt Resource
Delivery Receipts in Conversations provide visibility into the status of Conversation Messages sent across different channels.
Using Delivery Receipts, you can verify that Messages have been sent, delivered, or even read (for OTT) by Conversations Participants.
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 Receipt 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/IMXXX/Receipts
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/Messages/IMXXX/ReceiptsConversationMessageReceipt properties
| Resource Properties in REST API format | |
|---|---|
account_sid
|
The unique ID of the Account responsible for this participant. |
conversation_sid
|
The unique ID of the Conversation for this message. |
sid
|
A 34 character string that uniquely identifies this resource. |
message_sid
|
The SID of the message within a Conversation the delivery receipt belongs to |
channel_message_sid
|
A messaging channel-specific identifier for the message delivered to participant e.g. |
participant_sid
|
The unique ID of the participant the delivery receipt belongs to. |
status
|
The message delivery status, can be |
error_code
|
The message delivery error code for a |
date_created
|
The date that this resource was created. |
date_updated
|
The date that this resource was last updated. |
url
|
An absolute API resource URL for this delivery receipt. |
Fetch a ConversationMessageReceipt resource
https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
conversation_sid
Path
|
The unique ID of the Conversation for this message. |
message_sid
Path
|
The SID of the message within a Conversation the delivery receipt belongs to. |
sid
Path
|
A 34 character string that uniquely identifies this resource. |
Example 1
Read multiple ConversationMessageReceipt resources
https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts
Parameters
| Parameters in REST API format | |
|---|---|
conversation_sid
Path
|
The unique ID of the Conversation for this message. |
message_sid
Path
|
The SID of the message within a Conversation the delivery receipt belongs to. |
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.
