Sms

Get single SMS campaign

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

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

Authorization

APIKeyHeader

Path parameters

campaignId*string

Id of existing campaign

Response

200401404500

Request was successfully processed

Body

application/json

metaobject

Additional data

dataarray of object

Request

CsharpGoJavaNodePhpPythonRubyShell

var client = new RestClient("https://api.redlink.pl/v2.1/campaign/sms/%7BcampaignId%7D");
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": [
    {
      "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

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

GEThttps://api.messageflow.com/v2.1/campaign/sms

Authorization

APIKeyHeader

Query parameters

Response

200401404500

Request was successfully processed

Body

application/json

metaobject

Additional data

dataarray of object

Request

CsharpGoJavaNodePhpPythonRubyShell

var client = new RestClient("https://api.redlink.pl/v2.1/campaign/sms?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&dateFrom=SOME_STRING_VALUE&dateTo=SOME_STRING_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": [
    {
      "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"
    }
  ]
}