Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

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

api-base-url page anchor

All URLs in the reference documentation use the following base URL:


_10
https://conversations.twilio.com/v1

Using the shortened base URL

using-the-shortened-base-url page anchor

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.


_10
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:


_10
GET /v1/Services/ISxx/Conversations/CHxx/Messages/IMXXX/Receipts


ConversationMessageReceipt Properties

conversationmessagereceipt-properties page anchor
Resource properties
account_sidtype: SID<AC>Not PII

conversation_sidtype: SID<CH>Not PII

The unique ID of the Conversation(link takes you to an external page) for this message.


sidtype: SID<DY>Not PII

A 34 character string that uniquely identifies this resource.


message_sidtype: SID<IM>Not PII

The SID of the message within a Conversation(link takes you to an external page) the delivery receipt belongs to


channel_message_sidtype: SIDNot PII

A messaging channel-specific identifier for the message delivered to participant e.g. SMxx for SMS, WAxx for Whatsapp etc.


participant_sidtype: SID<MB>Not PII

The unique ID of the participant the delivery receipt belongs to.


statustype: enum<STRING>Not PII

The message delivery status, can be read, failed, delivered, undelivered, sent or null.

Possible values:
readfaileddeliveredundeliveredsent

error_codetype: integerNot PII

date_createdtype: string<DATE TIME>Not PII

The date that this resource was created.


date_updatedtype: string<DATE TIME>Not PII

The date that this resource was last updated. null if the delivery receipt has not been updated.


urltype: string<URI>Not PII

An absolute API resource URL for this delivery receipt.


Fetch a ConversationMessageReceipt resource

fetch-a-conversationmessagereceipt-resource page anchor
GET https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}

Parameters

fetch-parameters page anchor
URI parameters
ConversationSidtype: stringNot PII
Path Parameter

The unique ID of the Conversation(link takes you to an external page) for this message.


MessageSidtype: SID<IM>Not PII
Path Parameter

The SID of the message within a Conversation(link takes you to an external page) the delivery receipt belongs to.


Sidtype: SID<DY>Not PII
Path Parameter

A 34 character string that uniquely identifies this resource.

Fetch a ConversationMessageReceipt

fetch-a-conversationmessagereceipt page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_12
// Download the helper library from https://www.twilio.com/docs/node/install
_12
// Find your Account SID and Auth Token at twilio.com/console
_12
// and set the environment variables. See http://twil.io/secure
_12
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12
const authToken = process.env.TWILIO_AUTH_TOKEN;
_12
const client = require('twilio')(accountSid, authToken);
_12
_12
client.conversations.v1.conversations('CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12
.messages('IMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12
.deliveryReceipts('DYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12
.fetch()
_12
.then(delivery_receipt => console.log(delivery_receipt.conversationSid));

Output

_13
{
_13
"sid": "DYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_13
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_13
"conversation_sid": "CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_13
"message_sid": "IMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_13
"channel_message_sid": "SMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_13
"status": "failed",
_13
"error_code": 3000,
_13
"participant_sid": "MBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_13
"date_created": "2016-03-24T20:37:57Z",
_13
"date_updated": "2016-03-24T20:37:57Z",
_13
"url": "https://conversations.twilio.com/v1/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Messages/IMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Receipts/DYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_13
}


Read multiple ConversationMessageReceipt resources

read-multiple-conversationmessagereceipt-resources page anchor
GET https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts

URI parameters
ConversationSidtype: stringNot PII
Path Parameter

The unique ID of the Conversation(link takes you to an external page) for this message.


MessageSidtype: SID<IM>Not PII
Path Parameter

The SID of the message within a Conversation(link takes you to an external page) the delivery receipt belongs to.


PageSizetype: integerNot PII
Query Parameter

How many resources to return in each list page. The default is 50, and the maximum is 1000.


Pagetype: integerNot PII
Query Parameter

The page index. This value is simply for client state.


PageTokentype: stringNot PII
Query Parameter

The page token. This is provided by the API.

List multiple ConversationMessageReceipts

list-multiple-conversationmessagereceipts page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_12
// Download the helper library from https://www.twilio.com/docs/node/install
_12
// Find your Account SID and Auth Token at twilio.com/console
_12
// and set the environment variables. See http://twil.io/secure
_12
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12
const authToken = process.env.TWILIO_AUTH_TOKEN;
_12
const client = require('twilio')(accountSid, authToken);
_12
_12
client.conversations.v1.conversations('CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12
.messages('IMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12
.deliveryReceipts
_12
.list({limit: 20})
_12
.then(deliveryReceipts => deliveryReceipts.forEach(d => console.log(d.sid)));

Output

_52
{
_52
"meta": {
_52
"page": 0,
_52
"page_size": 50,
_52
"first_page_url": "https://conversations.twilio.com/v1/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Messages/IMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Receipts?PageSize=50&Page=0",
_52
"previous_page_url": "https://conversations.twilio.com/v1/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Messages/IMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Receipts?PageSize=50&Page=0",
_52
"url": "https://conversations.twilio.com/v1/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Messages/IMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Receipts?PageSize=50&Page=0",
_52
"next_page_url": "https://conversations.twilio.com/v1/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Messages/IMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Receipts?PageSize=50&Page=1",
_52
"key": "delivery_receipts"
_52
},
_52
"delivery_receipts": [
_52
{
_52
"sid": "DYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_52
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_52
"conversation_sid": "CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_52
"message_sid": "IMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_52
"channel_message_sid": "SMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_52
"status": "failed",
_52
"error_code": 3000,
_52
"participant_sid": "MBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_52
"date_created": "2016-03-24T20:37:57Z",
_52
"date_updated": "2016-03-24T20:37:57Z",
_52
"url": "https://conversations.twilio.com/v1/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Messages/IMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Receipts/DYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_52
},
_52
{
_52
"sid": "DYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_52
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_52
"conversation_sid": "CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_52
"message_sid": "IMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_52
"channel_message_sid": "SMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_52
"status": "failed",
_52
"error_code": 3000,
_52
"participant_sid": "MBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_52
"date_created": "2016-03-24T20:37:57Z",
_52
"date_updated": "2016-03-24T20:37:57Z",
_52
"url": "https://conversations.twilio.com/v1/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Messages/IMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Receipts/DYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_52
},
_52
{
_52
"sid": "DYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_52
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_52
"conversation_sid": "CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_52
"message_sid": "IMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_52
"channel_message_sid": "SMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_52
"status": "failed",
_52
"error_code": 3000,
_52
"participant_sid": "MBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_52
"date_created": "2016-03-24T20:37:57Z",
_52
"date_updated": "2016-03-24T20:37:57Z",
_52
"url": "https://conversations.twilio.com/v1/Conversations/CHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Messages/IMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Receipts/DYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_52
}
_52
]
_52
}


Rate this page: