KUkudosity
Reporting

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.

post/get-sms-sent.json

Request

  • Base URL
    https://api.transmitsms.com
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

message_idinteger required

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

list_idinteger

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.

pageinteger

Page number, for pagination.

maxinteger

Maximum results returned per page.

deliveryboolean

Only show messages with specific delivery status.

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

Whether to include opt outs.

VALUEDESCRIPTION
trueOnly return opt outs
falseDo not include opt outs

Example request

{
  "message_id": 123456,
  "list_id": 789,
  "page": 1,
  "max": 10,
  "delivery": true
}

Response

Successful response containing information about the sent message or campaign.

Changes

No recorded changes to this operation across all 2 revisions of this API.