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

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

1https://conversations.twilio.com/v1
2

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:

1GET /v1/Services/ISxx/Conversations/CHxx/Messages
2

Receipt Properties

Property nameTypeRequiredPIIDescriptionChild properties

accountSidSID<AC>

Optional

Not PII

The unique ID of the Account responsible for this participant.

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

chatServiceSidSID<IS>

Optional

Not PII

The SID of the Conversation Service the Message resource is associated with.

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

conversationSidSID<CH>

Optional

Not PII

The unique ID of the Conversation for this message.

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

messageSidSID<IM>

Optional

Not PII

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

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

sidSID<DY>

Optional

Not PII

A 34 character string that uniquely identifies this resource.

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

channelMessageSidSID

Optional

Not PII

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: 34Max length: 34

participantSidSID<MB>

Optional

Not PII

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

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

statusenum<string>

Optional

Not PII

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

Possible values:

readfaileddeliveredundeliveredsent

errorCodeinteger

Optional

Not PII

The message delivery error code for a failed status,

Default: 0

dateCreatedstring<date-time>

Optional

Not PII

The date that this resource was created.

dateUpdatedstring<date-time>

Optional

Not PII

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

urlstring<uri>

Optional

Not PII

An absolute API resource URL for this delivery receipt.