Sms

List contacts

Use this method to get a list of all existing contacts.

GEThttps://api.messageflow.com/v2.1/contact

Query parameters

Response

200401404500

Request was successfully processed

Body

application/json

metaMetaObject (object)

Additional data

dataarray of ContactObjectV2 (object)

Response

200401404500

{
  "meta": {
    "numberOfErrors": 0,
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    {
      "companyName": "Example company",
      "createdAt": "2019-02-01 20:12:12",
      "email": "[e-mail]",
      "externalId": "XXX-XXX-XXX",
      "firstName": "First name",
      "id": "1",
      "lastName": "Last name",
      "phoneNumber": "123123123",
      "externalData": {
        "test": "test",
        "createdAt": "1989-09-28",
        "isClient": false
      },
      "inArchive": "false",
      "unsubscribeAllReason": "Last name",
      "unsubscribeAllTime": "2019-02-01 20:12:12",
      "unsubscribePushTime": "2019-02-01 20:12:12",
      "unsubscribeEmailTime": "2019-02-01 20:12:12",
      "unsubscribeSmsTime": "2019-02-01 20:12:12",
      "isUnsubscribeSms": "false",
      "isUnsubscribeEmail": "false",
      "isUnsubscribePush": "false"
    }
  ]
}

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'

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"}'