Sms | Api reference MessageFlow

Get single SMS campaign

get

Use this method to get all details of certain SMS campaign such as campaignId, senderId, message, scheduleTime and more.

Authorizations

Path parameters

campaignIdstringrequired

Id of existing campaign

Responses

application/json

objectoptional

application/json

get

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}");

            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": [
    {
      "campaignId": "text",
      "name": "text",
      "description": "text",
      "message": "text",
      "senderId": "text",
      "priority": true,
      "recipientsCount": 1,
      "unicode": true,
      "validity": 1,
      "flash": true,
      "trackLinks": true,
      "scheduleTime": "text"
    }
  ]
}

List sms campaigns

get

Use this method to list all campaigns and its details from a certain time range.

Authorizations

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

dateFromstringrequired

Start of the time range.

Example: YYYY-MM-DD hh:mm:ii

dateTostringrequired

End of the time range.

Example: YYYY-MM-DD hh:mm:ii

Responses

application/json

objectoptional

application/json

get

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?limit=100&offset=0&dateFrom=YYYY-MM-DD hh:mm:ii&dateTo=YYYY-MM-DD hh:mm:ii");

            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": [
    {
      "externalId": "example-id",
      "name": "test",
      "description": "test descr",
      "message": "Hello world",
      "senderId": "TEST",
      "groupId": "test-group-id",
      "scheduleTime": "2020-09-10 10:15:00",
      "api": "1"
    }
  ]
}