Class: AggregatedDeliveryReceipt

AggregatedDeliveryReceipt

Contains aggregated information about a Message's delivery statuses across all Participants of a Conversation. At any moment during delivering message to a Participant the message can have zero or more of following delivery statuses:
  • Message considered as sent to a participant, if the nearest upstream carrier accepted the message.
  • Message considered as delivered to a participant, if Twilio has received confirmation of message delivery from the upstream carrier, and, where available, the destination handset.
  • Message considered as undelivered to a participant, if Twilio has received a delivery receipt indicating that the message was not delivered. This can happen for many reasons including carrier content filtering and the availability of the destination handset.
  • Message considered as read by a participant, if the message has been delivered and opened by the recipient in the conversation. The recipient must have enabled read receipts.
  • Message considered as failed to be delivered to a participant if the message could not be sent. This can happen for various reasons including queue overflows, account suspensions and media errors (in the case of MMS for instance).
AggregatedDeliveryReceipt class contains aggregated value AggregatedDeliveryReceipt#DeliveryAmount for each delivery status.

Properties:
Name Type Description
total number Maximum number of delivery events expected for the message
sent AggregatedDeliveryReceipt#DeliveryAmount Amount of participants that have sent delivery status for the message.
delivered AggregatedDeliveryReceipt#DeliveryAmount Amount of participants that have delivered delivery status for the message.
read AggregatedDeliveryReceipt#DeliveryAmount Amount of participants that have read delivery status for the message.
undelivered AggregatedDeliveryReceipt#DeliveryAmount Amount of participants that have undelivered delivery status for the message.
failed AggregatedDeliveryReceipt#DeliveryAmount Amount of participants that have failed delivery status for the message.

Members


delivered

Message considered as delivered to a participant, if Twilio has received confirmation of message delivery from the upstream carrier, and, where available, the destination handset.

failed

Message considered as failed to be delivered to a participant if the message could not be sent. This can happen for various reasons including queue overflows, account suspensions and media errors (in the case of MMS for instance). Twilio does not charge you for failed messages.

read

Message considered as read by a participant, if the message has been delivered and opened by the recipient in the conversation. The recipient must have enabled read receipts.

sent

Message considered as sent to a participant, if the nearest upstream carrier accepted the message.

total


undelivered

Message considered as undelivered to a participant, if Twilio has received a delivery receipt indicating that the message was not delivered. This can happen for many reasons including carrier content filtering and the availability of the destination handset.

Type Definitions


DeliveryAmount

Signifies amount of participants which have the status for the message.
Type:
  • 'none' | 'some' | 'all'