Sms | Api reference MessageFlow

Api reference MessageFlow

Get list of SMS

Use this method to get all sent sms

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

Authorization

Path parameters

externalIdstring

externalId of SMS preceded by a sign 'C-' f.e. C-extid_3-0001

Query parameters

Response

Request was successfully processed

Body

metaobject

Additional data

dataarray of object

Request

var client = new RestClient("https://api.redlink.pl/v2.1/sms/%7BexternalId%7D?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&sender=SOME_STRING_VALUE&phoneNumber=SOME_STRING_VALUE&status=SOME_INTEGER_VALUE&orderBy=SOME_STRING_VALUE&orderDirection=SOME_STRING_VALUE&dateTo=SOME_STRING_VALUE&dateFrom=SOME_STRING_VALUE");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Response

{
  "meta": {
    "numberOfErrors": 0,
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    {
      "id": 1,
      "sender": "text",
      "message": "text",
      "phoneNumber": "text",
      "scheduleTime": 1,
      "type": 1,
      "shortLink": true,
      "externalId": "text",
      "status": 1,
      "statusTime": 1,
      "subscribeUrl": "text",
      "createTime": 1,
      "smsPrice": 1,
      "currency": 1,
      "numberOfParts": 1,
      "encoding": 1
    }
  ]
}

Send SMS

Use this method to send SMS to any phone numbers you provide. If you want to send SMS to the group created through POST /v2/group use the send sms campaign method. Remember that the use of characters other than the GSM-7 standard will shorten individual text messages, which may increase the cost of sending messages. If You want more information, check SMS Billing section in this documentation.

POSThttps://api.messageflow.com/v2.1/sms

Authorization

Body

sender*string

The sender ID that was previously added through the user panel and then accepted by our support team.

message*string

The content of the SMS

Example: "Hello world!"

phoneNumbers*any

The phone numbers of receivers.

Example: ["+48111222333","+48111222444"]

validitynumber

The number of minutes the SMS will be valid (Max value = 4320) / 3 days

scheduleTimenumber

SMS dispatch date set in the future, up to a maximum of 14 days.

typenumber

Type of SMS ( 0 - regular SMS, 1 - Flash SMS )

shortLinkboolean

The URL shortener and tracker. Setting this property to ‘true’ will make the urls shorter and also urls will be tracked.

Example: true

webhookUrlstring

The URL for DLR (Delivery Report). DLR is a feature that reports if the message has been delivered. If you want more information check section DLR in this documentation.

externalIdstring

The unique identifier of the message. After sending a text message with external ID, it cannot be resent for next 24 hours.

Example: "xxxx-xxxx-xxxx"

Response

Request was successfully processed

Body

metaobject

Additional data

dataarray of object

Request

var client = new RestClient("https://api.redlink.pl/v2.1/sms");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"sender\":\"string\",\"message\":\"Hello world!\",\"phoneNumbers\":[\"+48111222333\",\"+48111222444\"],\"validity\":0,\"scheduleTime\":0,\"type\":1,\"shortLink\":true,\"webhookUrl\":\"string\",\"externalId\":\"xxxx-xxxx-xxxx\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Response

{
  "meta": {
    "numberOfErrors": 0,
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    {
      "sender": "text",
      "message": "text",
      "phoneNumber": "text",
      "scheduleTime": 1,
      "type": 1,
      "shortLink": true,
      "externalId": "text",
      "status": 1,
      "statusTime": 1,
      "createTime": 1,
      "smsPrice": 1,
      "currency": 1,
      "numberOfParts": 1,
      "encoding": 1
    }
  ]
}