SMS API

API change history

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

Get SMS Campaign Webhook Details

This method returns detailed information for specific campaign webhook (identified by its ID value).

Try it

Request

Request URL

Request parameters

  • int

    ID value of SMS campaign webhook record is associated with

  • int

    ID value of SMS webhook details are to be fetched for

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

Method was successfully invoked and response body contains detailed information about requested webhook

Representations

{
  "Note": null,
  "Id": 26,
  "IsActive": true,
  "Url": "https://mywebhook.com/ldxckfmlckfglidkrjog",
  "WebhookType": "CampaignReply",
  "DateCreated": "2021-10-24T05:34:10Z"
}
{
  "type": "object",
  "properties": {
    "Note": {
      "type": "string",
      "description": "If webhook gets deactivated, this field will contain the reason why it happened"
    },
    "Id": {
      "type": "integer",
      "description": "Webhook ID value"
    },
    "IsActive": {
      "type": "boolean",
      "description": "Webhook active status indicator. Event notifications are only sent to active webhooks"
    },
    "Url": {
      "type": "string",
      "description": "Webhook Url"
    },
    "WebhookType": {
      "type": "string",
      "description": "Webhook type"
    },
    "DateCreated": {
      "type": "string",
      "description": "Webhook creation date"
    }
  }
}

401 Unauthorized

Provided API credentials is not valid. Please check out response body for more 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

Campaign webhook list with specified ID value does not exist.

Representations

{
  "Code": 142,
  "Message": "Webhook record 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/campaigns/{campaignId}/webhooks/{webhookId}"
-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/campaigns/{campaignId}/webhooks/{webhookId}?" + 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/campaigns/{campaignId}/webhooks/{webhookId}");


            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/campaigns/{campaignId}/webhooks/{webhookId}?" + $.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/campaigns/{campaignId}/webhooks/{webhookId}";
    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/campaigns/{campaignId}/webhooks/{webhookId}');
$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/campaigns/{campaignId}/webhooks/{webhookId}?%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/campaigns/{campaignId}/webhooks/{webhookId}?%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/campaigns/{campaignId}/webhooks/{webhookId}')


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