readSMSDeliveries

The readSMSDeliveries function attempts to return SMS deliveries that match all of the given filter. An SMS delivery consists of an SMS message that has been sent to a specific set of recipients. Although an SMS delivery is associated with an SMS message, the SMS message’s content may have changed since the SMS delivery was sent and should not be used for determining the actual content sent. Instead, the content that was delivered may be returned by this function.

Results

The readSMSDeliveries function may return 1 or many smsdeliveryObjects. For more information on result limits and paging, see How To Read Objects.

Note: The data fields returned depend on the type of data you ask for in your request.

Syntax

smsdeliveryObject[] deliveries = bApi.readSMSDeliveries( filter smsDeliveryFilter includeRecipients, includeContent, pageNumber);
	    

Parameters

Name Type Required Description
filter smsDeliveryFilter Yes A filter used for returning specific SMS deliveries.
includeRecipients boolean Yes Include the recipients of returned SMS deliveries. You will get back an array of the recipients who were, or are scheduled to receive the SMS delivery. If the SMS delivery was sent to a keyword, you will get back a keyword id.
includeContent boolean Yes Include the content of returned SMS deliveries.
pageNumber int Yes Retrieves the next “batch” of objects as the value specified increases from 1. In order to obtain an entire set of objects for a given call, you should increase the number value assigned to pageNumber until no more objects are returned.