com.twilio.conversations.AggregatedDeliveryReceipt Class Reference

Contains aggregated information about a Message's delivery statuses across all participants of a Conversation. More...

Classes
enum	DeliveryAmount
	Amount of participants which have the status for the message. More...

Public Member Functions
int	getTotal ()
DeliveryAmount	getSent ()
	Message considered as sent to a participant, if the nearest upstream carrier accepted the message. More...
DeliveryAmount	getDelivered ()
	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. More...
DeliveryAmount	getUndelivered ()
	Message considered as undelivered to a participant, if Twilio has received a delivery receipt indicating that the message was not delivered. More...
DeliveryAmount	getRead ()
	Message considered as read by a participant, if the message has been delivered and opened by the recipient in the conversation. More...
DeliveryAmount	getFailed ()
	Message considered as failed to be delivered to a participant if the message could not be sent. More...

Detailed Description

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 DeliveryAmount for each delivery status. The DeliveryAmount displays amount of participants which have the status for the message.

Member Function Documentation

DeliveryAmount com.twilio.conversations.AggregatedDeliveryReceipt.getDelivered

(

)

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.

Returns

DeliveryAmount of participants that have delivered delivery status for the message.

DeliveryAmount com.twilio.conversations.AggregatedDeliveryReceipt.getFailed

(

)

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.

Returns

DeliveryAmount of participants that have failed delivery status for the message.

DeliveryAmount com.twilio.conversations.AggregatedDeliveryReceipt.getRead

(

)

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.

Returns

DeliveryAmount of participants that have read delivery status for the message.

DeliveryAmount com.twilio.conversations.AggregatedDeliveryReceipt.getSent

(

)

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

Returns

DeliveryAmount of participants that have sent delivery status for the message.

int com.twilio.conversations.AggregatedDeliveryReceipt.getTotal

(

)

Returns

Maximum number of delivery events expected for the message.

DeliveryAmount com.twilio.conversations.AggregatedDeliveryReceipt.getUndelivered

(

)

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.

Returns

DeliveryAmount of participants that have undelivered delivery status for the message.