smsDeliveryObject

The smsDeliveryObject contains data for an SMS delivery. smsDeliveryObjects contain details on SMS deliveries you have sent or have scheduled to send.

Name Type Description
id string The unique id assigned to the SMS delivery.
start dateTime The date the delivery was/is scheduled to be sent.
messageId string The id associated with the SMS message used in the SMS delivery.
deliveryType string

The deliveryType indicates the how the SMS delivery was made. Valid values are:

  • triggered

    Includes transactional deliveries. To filter, use:

    smsDeliveryFilter::deliveryType transaction
  • automated

    Includes workflow deliveries. To filter, use:

    smsDeliveryFilter::deliveryType workflow
  • normal

    Includes bulk and test deliveries. To filter, use:

    smsDeliveryFilter::deliveryType bulk|test
status string

The status of the SMS delivery. Valid values are:

  • unsent
  • sending
  • sent
  • skipped
  • archived
content string

The content used in the SMS delivery.

Note: SMS messages are limited to 160 characters. The following text must be included somewhere in the body of the SMS message: Text STOP to end
recipients deliveryRecipientObject[] An array of the recipients who were, or are scheduled to receive the SMS delivery.
fields smsMessageFieldObject[] An array of the API fields and data to substitute into the SMS message being sent by this SMS delivery.
numSends long The total number of text messages sent in the SMS delivery.
numDeliveries long The total number of successful text messages sent in the SMS delivery.
numIncoming long The total number of replies to the SMS delivery.
numBounces long The total number of bounces recorded for the SMS delivery.
deliveryRate double The percentage of text messages that were successfully delivered in the SMS delivery.