Get Message/Campaign Recipients

Get information about a message send and it's recipients This will return paginated information regarding individual recipients on a campaign or message send.

Form Data
integer
required

Numeric ID assigned to the message sent. This ID was returned in the send-sms response.

integer

Recipient list ID. Provide list_id if contact is not associated with a campaign send. It will look up custom data on this list for the contact and return it in the response.

integer

Page number, for pagination.

integer

Maximum results returned per page.

boolean

Only show messages with specific delivery status.

VALUEDESCRIPTION
deliveredOnly return delivered messages
failedOnly return failed messages
pendingOnly return pending messages
boolean

Whether to include opt outs.

VALUEDESCRIPTION
trueOnly return opt outs
falseDo not include opt outs
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Basic
base64
:
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain