Recipient

List sms campaign recipients

Use this method to get all recipients details from SMS campaign. Possible SMS status values: SMS_SEND, SMS_ERROR, SMS_WAITING, SMS_CANCELED, SMS_BAD_NUMBER, SMS_MESSAGE_TOO_LONG, SMS_MESSAGE_INCORRECT, SMS_MESSAGE_TOO_SHORT, SMS_UNKNOWN_ERROR

GEThttps://api.messageflow.com/v2.1/campaign/sms/{campaignId}/report/recipient

Authorization

APIKeyHeader

Path parameters

campaignId*string

Id of existing campaign

Query parameters

Response

200401404500

Request was successfully processed

Body

application/json

metaobject

Additional data

dataany

Request

CsharpGoJavaNodePhpPythonRubyShell

var client = new RestClient("https://api.redlink.pl/v2.1/campaign/sms/%7BcampaignId%7D/report/recipient?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Response

200401404500

{
  "meta": {
    "numberOfErrors": 0,
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    [
      {
        "Number": "text",
        "ReceivedTime": "text",
        "ResultCode": "text"
      }
    ]
  ]
}