Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

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.

ConversationMessageReceipt properties

Resource Properties in REST API format
sid
sid<DY> Not PII

A 34 character string that uniquely identifies this resource.

message_sid
sid<IM> Not PII

The sid of the message within a Conversation the delivery receipt belongs to

conversation_sid
sid<CH> Not PII

channel_message_sid
sid Not PII

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

participant_sid
sid<MB> Not PII

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

status
enum:delivery_status Not PII

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

error_code
integer Not PII

The message delivery error code for a failed status,

date_created
date_time<iso8601> Not PII

The date that this resource was created.

date_updated
date_time<iso8601> Not PII

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

url
url Not PII

An absolute URL for this delivery receipt.

Fetch a ConversationMessageReceipt resource

get
https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}
Parameters
Parameters in REST API format
conversation_sid
Path
get sid<CH> Not PII

The unique id of the Conversation for this message.

message_sid
Path
get sid<IM> Not PII

The sid of the message within a Conversation the delivery receipt belongs to

sid
Path
get sid<DY> Not PII

A 34 character string that uniquely identifies this resource.

Example 1
        
        
        
        

        Read multiple ConversationMessageReceipt resources

        get
        https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts
        Parameters
        Parameters in REST API format
        conversation_sid
        Path
        get sid<CH> Not PII

        The unique id of the Conversation for this message.

        message_sid
        Path
        get sid<IM> Not PII

        The sid of the message within a Conversation the delivery receipt belongs to

        Example 1
              
              
              
              
              Rate this page:

              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 browsing the Twilio tag on Stack Overflow.