Recipient

List sms campaign recipients

get

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

Authorizations

APIKeyHeaderAPPKeyHeader

Path parameters

campaignIdstringrequired

Id of existing campaign

Query parameters

limitinteger · max: 1000optional

The maximum number of items returned by request. Default ‘100’. Maximum ‘1000’.

Default: 100

offsetintegeroptional

The number of items omitted from the beginning of the list. Default ‘0’.

Default: 0

Responses

application/json

objectoptional

application/json

application/json

application/json

get

CsharpGoJavaNodePhpPythonRubyShell

using System.Threading.Tasks;

internal class Program
{
    private static void Main(string[] args)
    {
        string requestBody = "";

        try {
            using var client = new HttpClient{};
            using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.messageflow.com/v2.1/campaign/sms/{campaignId}/report/recipient?limit=100&offset=0");

            request.Headers.Add("Authorization", "YourAuthorizationKey");
            request.Headers.Add("Application-Key", "YourApplicationKey");
            request.Content = new StringContent(requestBody, null, "application/json");

            var response = await client.SendAsync(request);
            response.EnsureSuccessStatusCode();
            string content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);

        } catch (HttpRequestException e) {
            Console.WriteLine("\n Exception Caught!\n Message :{0} ", e.Message);
        }
    }
}

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