API Endpoints

Requesting access-token

POST: https://api.sms.to/v1/oauth/token

Once you have created an API client, you may request an access token by issuing a POST request to this route with the user's email address, password, client_id and client_secret.

Headers

Header	Value
Accept	application/json

Body

Parameter	Value	Required
grant_type	password	Yes
client_id	xyz	Yes
client_secret	xxyyzzxxyyzzxxyyzzxxyyzz	Yes
username	your@email.com	Yes
password	your-password	Yes
scope	*	Yes

curl --location --request POST "https://api.sms.to/v1/oauth/token" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --data "{
    \"grant_type\": \"password\",
    \"client_id\": xyz,
    \"client_secret\": \"xxyyzzxxyyzzxxyyzzxxyyzzxxyyzzxxyyzz\",
    \"username\": \"your@email.com\",
    \"password\": \"your-password\",
    \"scope\": \"*\"
}"

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.sms.to/v1/oauth/token",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => false,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>'{"grant_type": "password","client_id": xyz,"client_secret": "xxyyzzxxyyzzxxyyzzxxyyzzxxyyzzxxyyzz","username": "your@email.com","password": "your@email.com","scope": "*"}',
  CURLOPT_HTTPHEADER => array(
    "Content-Type: application/json",
    "Accept: application/json"
  ),
));

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

curl_close($curl);
?>

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"grant_type\": \"password\",\"client_id\": xyz,\"client_secret\": \"xxyyzzxxyyzzxxyyzzxxyyzzxxyyzzxxyyzz\",\"username\": \"your@email.com\",\"password\": \"your@email.com\",\"scope\": \"*\"}");
Request request = new Request.Builder()
  .url("https://api.sms.to/v1/oauth/token")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Accept", "application/json")
  .build();

Response response = client.newCall(request).execute();

var client = new RestClient("https://api.sms.to/v1/oauth/token");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddParameter("application/json", "{\"grant_type\": \"password\",\"client_id\": xyz,\"client_secret\": \"xxyyzzxxyyzzxxyyzzxxyyzzxxyyzzxxyyzz\",\"username\": \"your@email.com\",\"password\": \"your@email.com\",\"scope\": \"*\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

import http.client

conn = http.client.HTTPSConnection("api.sms.to")

payload = "{\"grant_type\": \"password\",\"client_id\": xyz,\"client_secret\": \"xxyyzzxxyyzzxxyyzzxxyyzzxxyyzzxxyyzz\",\"username\": \"your@email.com\",\"password\": \"your@email.com\",\"scope\": \"*\"}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json"
    }

conn.request("POST", "/v1/oauth/token", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'

url = URI("https://api.sms.to/v1/oauth/token")

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["Accept"] = 'application/json'
request.body = "{\"grant_type\": \"password\",\"client_id\": xyz,\"client_secret\": \"xxyyzzxxyyzzxxyyzzxxyyzzxxyyzzxxyyzz\",\"username\": \"your@email.com\",\"password\": \"your@email.com\",\"scope\": \"*\"}"

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

Response

{
    "token_type": "Bearer",
    "expires_in": "xyzxyz",
    "access_token": "xyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyz",
    "refresh_token": "xyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyz"
}

Get Balance

POST: https://api.sms.to/v1/balance

Get Current Balance

Headers

Header	Value
Accept	application/json

curl --location --request POST "https://api.sms.to/v1/balance --header "Accept: application/json"

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.sms.to/v1/balance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => false,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => array(
    "Content-Type: application/json",
    "Accept: application/json"
  ),
));

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

curl_close($curl);
?>

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
  .url("https://api.sms.to/v1/balance")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Accept", "application/json")
  .build();

Response response = client.newCall(request).execute();

var client = new RestClient("https://api.sms.to/v1/balance");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

import http.client

conn = http.client.HTTPSConnection("api.sms.to")

payload = "{}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json"
    }

conn.request("POST", "/v1/balance", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'

url = URI("https://api.sms.to/v1/balance")

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["Accept"] = 'application/json'
request.body = "{}"

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

Response

{
    "balance": 123,
    "currency": "EUR"
}

Sending single SMS to one number

POST: https://api.sms.to/v1/sms/single/send

Sends personalized SMS to a single number or array of numbers with personalized SMS.

Headers

Header	Value
Accept	application/json
Authorization	Bearer xyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyz

Body

Parameter	Value	Required
messages	[{"to": "+355692179931", "message": "This is test SMS for +355692179931"}]	Yes
sender_id	SMS.to	No
callback_url	https://your-website.com/handle-notification	No

messages - Array of destination numbers with their respective personalized messages to be sent

sender_id - the sender ID which is optional

callback_url - this will be an optional URL where we will POST some information about the status of SMS as soon as we have an update

To send SMS to a single number

curl --location --request POST "https://api.sms.to/v1/sms/single/send" \
  --header "Authorization: Bearer xyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyzxyz" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data "{
    \"messages\": [{\"to\":\"+355692179931\", \"message\": \"This is a message to +355692179931\"}],
    \"sender_id\": \"SMS.to\",
    \"callback_url\": \"https://your-website.com/handle-notification\"
}"