Menu

Expand
Rate 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

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

https://conversations.twilio.com/v1

Using 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/Receipts

ConversationMessageReceipt properties

Resource Properties in REST API format
account_sid
sid<AC> Not PII

The unique ID of the Account responsible for this participant.

conversation_sid
sid<CH> Not PII

The unique ID of the Conversation for this message.

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

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 API resource 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_like<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
Loading Code Sample...
        
        

        Fetch Delivery Receipt

        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_like<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
        Loading Code Sample...
              
              

              Read Delivery Receipt

              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 by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.

              Loading Code Sample...
                    
                    
                    

                    Thank you for your feedback!

                    Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

                    Sending your feedback...
                    🎉 Thank you for your feedback!
                    Something went wrong. Please try again.

                    Thanks for your feedback!

                    thanks-feedback-gif