Sms

Get list of SMS

Use this method to get all sms sent.

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

Path parameters

externalIdstring

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

Query parameters

Response

200401404500

Request was successfully processed

Body

application/json

metaMetaObject (object)

Additional data

dataarray of SmsObject (object)

Request

var client = new RestClient("https://api.messageflow.com/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");
request.AddHeader("application-key", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Response

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

C#

var client = new RestClient("https://api.messageflow.com/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);

Go

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.messageflow.com/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"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "REPLACE_KEY_VALUE")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Java

HttpResponse<String> response = Unirest.get("https://api.messageflow.com/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")
  .header("authorization", "REPLACE_KEY_VALUE")
  .asString();

Node

var request = require("request");

var options = {
  method: 'GET',
  url: 'https://api.messageflow.com/v2.1/sms/%7BexternalId%7D',
  qs: {
    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'
  },
  headers: {authorization: 'REPLACE_KEY_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.messageflow.com/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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "authorization: REPLACE_KEY_VALUE"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://api.messageflow.com/v2.1/sms/%7BexternalId%7D"

querystring = {"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"}

headers = {'authorization': 'REPLACE_KEY_VALUE'}

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.messageflow.com/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")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["authorization"] = 'REPLACE_KEY_VALUE'

response = http.request(request)
puts response.read_body

Shell

http GET 'https://api.messageflow.com/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' \
  authorization:REPLACE_KEY_VALUEuthorization: REPLACE_KEY_VALUE'

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

Body

application/json

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

phoneNumbers*string/array

The phone numbers of receivers.

validitynumber

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

scheduleTimenumber

Date the message was sent. Maximum in 14 days. UnixTimeStamp in UTC timezone.

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.

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.

Response

200401404500

Request was successfully processed

Body

application/json

metaMetaObject (object)

Additional data

dataarray of SmsObjectV2 (object)

Request

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

Response

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

C#

var client = new RestClient("https://api.messageflow.com/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\":[\"[phone]\",\"[phone]\"],\"validity\":0,\"scheduleTime\":0,\"type\":1,\"shortLink\":true,\"webhookUrl\":\"string\",\"externalId\":\"xxxx-xxxx-xxxx\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Go

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.messageflow.com/v2.1/sms"

	payload := strings.NewReader("{\"sender\":\"string\",\"message\":\"Hello world!\",\"phoneNumbers\":[\"[phone]\",\"[phone]\"],\"validity\":0,\"scheduleTime\":0,\"type\":1,\"shortLink\":true,\"webhookUrl\":\"string\",\"externalId\":\"xxxx-xxxx-xxxx\"}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "REPLACE_KEY_VALUE")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Java

HttpResponse<String> response = Unirest.post("https://api.messageflow.com/v2.1/sms")
  .header("content-type", "application/json")
  .header("authorization", "REPLACE_KEY_VALUE")
  .body("{\"sender\":\"string\",\"message\":\"Hello world!\",\"phoneNumbers\":[\"[phone]\",\"[phone]\"],\"validity\":0,\"scheduleTime\":0,\"type\":1,\"shortLink\":true,\"webhookUrl\":\"string\",\"externalId\":\"xxxx-xxxx-xxxx\"}")
  .asString();

Node

var request = require("request");

var options = {
  method: 'POST',
  url: 'https://api.messageflow.com/v2.1/sms',
  headers: {'content-type': 'application/json', authorization: 'REPLACE_KEY_VALUE'},
  body: {
    sender: 'string',
    message: 'Hello world!',
    phoneNumbers: ['[phone]', '[phone]'],
    validity: 0,
    scheduleTime: 0,
    type: 1,
    shortLink: true,
    webhookUrl: 'string',
    externalId: 'xxxx-xxxx-xxxx'
  },
  json: true
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.messageflow.com/v2.1/sms",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"sender\":\"string\",\"message\":\"Hello world!\",\"phoneNumbers\":[\"[phone]\",\"[phone]\"],\"validity\":0,\"scheduleTime\":0,\"type\":1,\"shortLink\":true,\"webhookUrl\":\"string\",\"externalId\":\"xxxx-xxxx-xxxx\"}",
  CURLOPT_HTTPHEADER => array(
    "authorization: REPLACE_KEY_VALUE",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://api.messageflow.com/v2.1/sms"

payload = "{\"sender\":\"string\",\"message\":\"Hello world!\",\"phoneNumbers\":[\"[phone]\",\"[phone]\"],\"validity\":0,\"scheduleTime\":0,\"type\":1,\"shortLink\":true,\"webhookUrl\":\"string\",\"externalId\":\"xxxx-xxxx-xxxx\"}"
headers = {
    'content-type': "application/json",
    'authorization': "REPLACE_KEY_VALUE"
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.messageflow.com/v2.1/sms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request["authorization"] = 'REPLACE_KEY_VALUE'
request.body = "{\"sender\":\"string\",\"message\":\"Hello world!\",\"phoneNumbers\":[\"[phone]\",\"[phone]\"],\"validity\":0,\"scheduleTime\":0,\"type\":1,\"shortLink\":true,\"webhookUrl\":\"string\",\"externalId\":\"xxxx-xxxx-xxxx\"}"

response = http.request(request)
puts response.read_body

Shell

echo '{"sender":"string","message":"Hello world!","phoneNumbers":["[phone]","[phone]"],"validity":0,"scheduleTime":0,"type":1,"shortLink":true,"webhookUrl":"string","externalId":"xxxx-xxxx-xxxx"}' |  \
  http POST https://api.messageflow.com/v2.1/sms \
  authorization:REPLACE_KEY_VALUE \
  content-type:application/jsonl":"string","externalId":"xxxx-xxxx-xxxx"}'