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

Service-Scoped Delivery Receipt Resource


Service-Scoped Delivery Receipts in Conversations provide visibility into the status of Service-Scoped Conversation Messages sent across different Conversations within a non-default Conversation Service.

Using Service-Scoped Delivery Receipts, you can verify that Messages have been sent, delivered, or even read (for OTT) by Conversations Participants within a non-default, service-scoped Conversation Service.


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

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


ServiceConversationMessageReceipt Properties

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

The unique ID of the Account(link takes you to an external page) responsible for this participant.

Pattern:
^AC[0-9a-fA-F]{32}$
Min length:
34
Max length:
34

chat_service_sidtype: SID<IS>

The SID of the Conversation Service(link takes you to an external page) the Message resource is associated with.

Pattern:
^IS[0-9a-fA-F]{32}$
Min length:
34
Max length:
34

conversation_sidtype: SID<CH>

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

Pattern:
^CH[0-9a-fA-F]{32}$
Min length:
34
Max length:
34

message_sidtype: SID<IM>

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

Pattern:
^IM[0-9a-fA-F]{32}$
Min length:
34
Max length:
34

sidtype: SID<DY>

A 34 character string that uniquely identifies this resource.

Pattern:
^DY[0-9a-fA-F]{32}$
Min length:
34
Max length:
34

channel_message_sidtype: SID

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

Pattern:
^[a-zA-Z]{2}[0-9a-fA-F]{32}$
Min length:
34
Max length:
34

participant_sidtype: SID<MB>

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

Pattern:
^MB[0-9a-fA-F]{32}$
Min length:
34
Max length:
34

statustype: enum<string>

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

Possible values:
readfaileddeliveredundeliveredsent

error_codetype: integer

date_createdtype: string<date-time>

The date that this resource was created.


date_updatedtype: string<date-time>

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


urltype: string<uri>

An absolute API resource URL for this delivery receipt.


Rate this page: