Use the SMS delivery filter to retrieve SMS delivery data based on send date, delivery id, message id, status, or delivery type.

Name Type Required Description
type filterType Yes You must specify the conjunction to use for values under the start parameter as OR or AND.
start dateValue[] No Allows you to read data for SMS deliveries based on their send date. In the smsDeliveryFilter, the value you set for the start li represents the send date of the SMS delivery.
id string[] No The unique ids assigned to SMS deliveries you want to read.
messageId string[] No The unique id of SMS message you want to read SMS deliveries for.
status string[] No The status of the SMS delivery:
  • sent
  • sending
  • unsent
  • archived
  • skipped
  • tmp
deliveryType string[] No

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

  • bulk
  • test
  • workflow
  • transaction