SMS API
API change historySMS API contains methods used to send notifications via Short Message Service, directly to your client's phone
Get SMS subscribers
This method returns SMS subscriber records, that belong to list with specified ID value
Try itRequest
Request URL
Request parameters
-
int
ID value of SMS list subscribers are to be fetched for
-
int
The results page to retrieve. It has to be a positive integer.
-
int
The number of records to retrieve per results page. Should be an integer value between 10 and 1000.
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
Responses
200 OK
SMS subscriber records that belong to specified list
Representations
{
"Data": [
{
"MobileNumber": "27831112255",
"DateCreated": "2021-10-11T11:14:01Z"
},
{
"MobileNumber": "27831112256",
"DateCreated": "2021-10-11T11:14:01Z"
}
],
"Page": 2,
"PageSize": 10,
"TotalPages": 2,
"TotalRecordCount": 12
}
{
"type": "object",
"properties": {
"Data": {
"type": "array",
"items": {
"required": [
"MobileNumber",
"DateCreated"
],
"type": "object",
"properties": {
"MobileNumber": {
"type": "string",
"description": "Subscriber mobile number"
},
"DateCreated": {
"type": "string",
"description": "Subscriber creation date"
}
}
},
"description": "An array of SMS subscriber records retrieved"
},
"Page": {
"type": "integer",
"description": "Requested subscriber page to get"
},
"PageSize": {
"type": "integer",
"description": "Subscriber page size (max. number of records returned)"
},
"TotalPages": {
"type": "integer",
"description": "Total number of subscriber pages available to fetch"
},
"TotalRecordCount": {
"type": "integer",
"description": "Total number of SMS subscribers in the list"
}
}
}
400 Bad Request
An error occurred while making get subscribers request. Please check response body to find additional details about error.
Representations
{
"Code": 201,
"Message": "Records page number must be a positive integer value"
}
{
"type": "object",
"properties": {
"Code": {
"type": "integer",
"description": "Error code"
},
"Message": {
"type": "string",
"description": "Error details in user-friendly form"
}
}
}
401 Unauthorized
Provided API key is not valid. Please check out response body for additional details.
Representations
{
"Code": 100,
"Message": "Provided API key is invalid"
}
{
"type": "object",
"properties": {
"Code": {
"type": "integer",
"description": "Error code"
},
"Message": {
"type": "string",
"description": "Error details in user-friendly form"
}
}
}
404 Not Found
SMS subscriber list with specified ID value does not exist. Please check out response body for additional details.
Representations
{
"Code": 104,
"Message": "SMS list with provided ID value does not exist"
}
{
"type": "object",
"properties": {
"Code": {
"type": "integer",
"description": "Error code"
},
"Message": {
"type": "string",
"description": "Error details in user-friendly form"
}
}
}
Code samples
@ECHO OFF
curl -v -X GET "https://api.touchbasepro.com/sms/lists/{listId}/subscribers?page={page}&pageSize={pageSize}"
-H "Authorization: Bearer "
--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 ");
var uri = "https://api.touchbasepro.com/sms/lists/{listId}/subscribers?page={page}&pageSize={pageSize}&" + queryString;
var response = await client.GetAsync(uri);
}
}
}
// // 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/lists/{listId}/subscribers?page={page}&pageSize={pageSize}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Authorization", "Bearer ");
// 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/lists/{listId}/subscribers?page={page}&pageSize={pageSize}&" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Authorization","Bearer ");
},
type: "GET",
// 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/lists/{listId}/subscribers?page={page}&pageSize={pageSize}";
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:@"GET"];
// Request headers
[_request setValue:@"Bearer " forHTTPHeaderField:@"Authorization"];
// 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/lists/{listId}/subscribers?page={page}&pageSize={pageSize}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Authorization' => 'Bearer ',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// 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 ',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.touchbasepro.com')
conn.request("GET", "/sms/lists/{listId}/subscribers?page={page}&pageSize={pageSize}&%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 ',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api.touchbasepro.com')
conn.request("GET", "/sms/lists/{listId}/subscribers?page={page}&pageSize={pageSize}&%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/lists/{listId}/subscribers?page={page}&pageSize={pageSize}')
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Authorization'] = 'Bearer '
# 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