SMS API

API change history

SMS API contains methods used to send notifications via Short Message Service, directly to your client's phone

Sends new SMS messages

This method sends new SMS messages to the numbers listed in the requests. The request is sent in JSON, with the numbers sent as an array of strings.

Try it

Request

Request URL

Request headers

  • string

    The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

Request body

This method sends new SMS messages to the numbers listed in the requests. Requests are sent in JSON with the following fields:

  • text (string) - Content of the message
  • to (array([string]) - Array of numbers to deliver the message to. Each number is in a string, and must must start with '+'.

{
  "text": "Hello everyone!",
  "to": [
    2783123456,
    2783234567
  ]
}

Responses

202 Accepted

Returns a confirmation that the SMS requests have been recieved with the following fields returned:

  • messages (array) - Each SMS number submitted and it's status.
  • messages.apiMessageId (string) - The ID of the message.
  • messages.accepted (bool) - Whether the submission was accepted or rejected (for example, a misformed SMS number).
  • messages.to (string) - The SMS number the message was send to.
  • messages.errorCode (null | string) - The code if an error was detected.
  • messages.error (null | string) - The name of the error.
  • messages.errorDescription (null | string) - The description of what the error means.
  • errorCode (null | string) - The code if an error was detected for the entire request.
  • error (null | string) - The name of the error for the entire request.
  • errorDescription (null | string) - The description of what the error for the entire request means.

Representations

{
  "messages": [
    {
      "apiMessageId": "af750c2dc53e4e4c88c39b3b48756d3a",
      "accepted": true,
      "to": 1234567980,
      "errorCode": null,
      "error": null,
      "errorDescription": null
    },
    {
      "apiMessageId": "abcdec2dc53e4e4c88c39b3b48756d3a",
      "accepted": true,
      "to": 9876543210,
      "errorCode": null,
      "error": null,
      "errorDescription": null
    }
  ],
  "errorCode": null,
  "error": null,
  "errorDescription": null
}

400 Bad Request

The request was not properly formatted.

Representations

{
  "status": 400,
  "message": "The request was not properly formatted."
}

401 Unauthorized

Provided API key is not valid. Please check the key and try again.

Representations

{
  "status": 401,
  "message": "API key is invalid."
}

403 Forbidden

Your account has been suspended. Please check with your account representative for more information.

Representations

{
  "status": 403,
  "message": "Your account has been suspended! Please check with your account representative for more information."
}

429 Too many requests

The number of API calls has been exceeded. The return will include the number of seconds (represented by (number of seconds) in the example) until the API call can be tried again.

Representations

{
  "status": 429,
  "message": "Rate limit is exceeded.  Try again in {number of seconds} seconds."
}

500 Internal Server Error

There has been an error on our internal processes. Please try again later.

Representations

{
  "status": 500,
  "message": "An internal error has occurred. We have been notified about it and will restore service functionality as soon as possible."
}
{
  "status": 500,
  "message": "Updating your credit balance has failed. Please contact us."
}

405 Method Not Allowed

You don't have enough credits on your account, or your credit balance update has failed

Representations

{
  "status": 405,
  "message": "You don't have enough credits on your account!"
}
{
  "status": 405,
  "message": "Message sending failed for your credit balance couldn't be updated!"
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.touchbasepro.com/sms/messages"
-H "Authorization: "Bearer API_KEY""
-H "Content-Type: application/json"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Authorization", ""Bearer API_KEY"");

            var uri = "https://api.touchbasepro.com/sms/messages?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.touchbasepro.com/sms/messages");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Authorization", ""Bearer API_KEY"");
            request.setHeader("Content-Type", "application/json");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.touchbasepro.com/sms/messages?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization",""Bearer API_KEY"");
                xhrObj.setRequestHeader("Content-Type","application/json");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.touchbasepro.com/sms/messages";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@""Bearer API_KEY"" forHTTPHeaderField:@"Authorization"];
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.touchbasepro.com/sms/messages');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Authorization' => '"Bearer API_KEY"',
    'Content-Type' => 'application/json',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Authorization': '"Bearer API_KEY"',
    'Content-Type': 'application/json',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.touchbasepro.com')
    conn.request("POST", "/sms/messages?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Authorization': '"Bearer API_KEY"',
    'Content-Type': 'application/json',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.touchbasepro.com')
    conn.request("POST", "/sms/messages?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.touchbasepro.com/sms/messages')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Authorization'] = '"Bearer API_KEY"'
# Request headers
request['Content-Type'] = 'application/json'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body