{"_id":"58fdfb73eed0651b00f82e46","user":"58cadf93d223510f005d27db","parentDoc":null,"githubsync":"","project":"558d9c32beb7c719007f6319","category":{"_id":"58fdfb438fbd2819000db9eb","__v":0,"version":"558d9c33beb7c719007f631c","project":"558d9c32beb7c719007f6319","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-04-24T13:18:59.649Z","from_sync":false,"order":3,"slug":"sms-apis","title":"SMS APIs"},"version":{"_id":"558d9c33beb7c719007f631c","project":"558d9c32beb7c719007f6319","__v":19,"createdAt":"2015-06-26T18:38:43.154Z","releaseDate":"2015-06-26T18:38:43.153Z","categories":["558d9c33beb7c719007f631d","558db0bc7afc102f008ed863","558db0d07afc102f008ed864","558db3c84cd25f0d00b7ecb2","558dbace7afc102f008ed894","558dbd104cd25f0d00b7ecca","558dbd4c4cd25f0d00b7eccb","559d3e858639bd21008e90a6","55bb8ca5a8400c2d00873e70","58fdfb438fbd2819000db9eb","590829c7ade4172d006a87b8","59082a11beedcf0f00235d87","5908bd2cba2afd23007d6d12","5908d1f64f544425002b6aae","591e5e9e2c1b1f0f000fa4e5","5a283434aba91f002834ea86","5a69fe5cde745d002c936c66","5a81e6ef761cf300127317f8","5a81e7d63b1e120012bed5a1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-04-24T13:19:47.153Z","link_external":false,"link_url":"","sync_unique":"","hidden":true,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:api-header]\n{\n  \"title\": \"Use the SMS Send Message API to send an SMS message\"\n}\n[/block]\nThe SMS Send Message API is used to send an SMS message from a DialogTech SMS enabled tracking number, to a 3rd party recipient.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Base URL for SMS Send Message\",\n  \"body\": \"https://secure.dialogtech.com/ibp_api.php\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Rate Limits\"\n}\n[/block]\nThe SMS API enforces the following rate-limits\n* 
40 sms per number per 60 seconds \n* 4 sms per DialogTech account per second\n* 1 sms per number per second\n[block:api-header]\n{\n  \"title\": \"Parameter List\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Required\",\n    \"h-2\": \"Accepts\",\n    \"h-3\": \"Max Length\",\n    \"h-4\": \"Notes\",\n    \"h-5\": \"Usage\",\n    \"0-0\": \"action\",\n    \"0-1\": \"Yes\",\n    \"0-2\": \"String: **sms.send_message**\",\n    \"0-3\": \"n/a\",\n    \"0-4\": \"Only accepts **sms.send_message** to send an SMS Message\",\n    \"0-5\": \"Defines the API Call as \\\"SMS Send Message\\\" type\",\n    \"1-0\": \"access_key\",\n    \"1-1\": \"Yes\",\n    \"1-2\": \"String\",\n    \"1-3\": \"n/a\",\n    \"2-0\": \"secret_access_key\",\n    \"2-1\": \"Yes\",\n    \"2-2\": \"String\",\n    \"2-3\": \"n/a\",\n    \"1-4\": \"Access Key from the Key Manager within a DialogTech account\",\n    \"1-5\": \"Credentials used for access to the API for a particular DialogTech account\",\n    \"2-5\": \"Credentials used for access to the API for a particular DialogTech account\",\n    \"2-4\": \"Secret Access Key from the Key Manager within a DialogTech account\",\n    \"3-0\": \"to\",\n    \"4-0\": \"from\",\n    \"3-1\": \"Yes\",\n    \"3-2\": \"String: Unformatted Phone Number\",\n    \"4-2\": \"String: Unformatted Phone Number\",\n    \"4-1\": \"Yes\",\n    \"3-3\": \"n/a\",\n    \"4-3\": \"n/a\",\n    \"3-4\": \"Can be any unformatted phone number\",\n    \"4-4\": \"Must be a DialogTech SMS enabled tracking number\",\n    \"3-5\": \"Defines the start of the date-range for records to be returned from\",\n    \"4-5\": \"Defines the end of the date-range for records to be returned from\",\n    \"5-0\": \"message\",\n    \"5-1\": \"Yes\",\n    \"5-2\": \"String\",\n    \"5-3\": \"256\",\n    \"5-4\": \"DialogTech does not limit / break texts into smaller batches messages. This behavior is dependent on the recipient's carrier\",\n    \"5-5\": \"Defines the message being send to the third party.\"\n  },\n  \"cols\": 6,\n  \"rows\": 6\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Using this API\"\n}\n[/block]\nThese code examples are meant to show a basic method of accessing DialogTech's IVR Report API.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\n  /*\\n    SMS Send Message EX:\\n    This example will send an SMS with\\n    the text 'Thank you for calling.'\\n    to a predefined number and echo the\\n    verbatim XML response.\\n  */\\n\\n  // Create cURL resource\\n  $ch = curl_init(); \\n  $baseuri = \\\"https://secure.dialogtech.com/ibp_api.php?\\\";\\n\\n  // API Specific Static Parameters\\n  $action = \\\"sms.send_message\\\";\\n\\n  // Required User Parameters To Request the API\\n  $access_key = \\\"foo\\\";\\n  $secret_access_key = \\\"bar\\\";\\n  $to = \\\"5556667777\\\";\\n  $from = \\\"5554332111\\\"; // This is a DialogTech SMS-Enabled Tracking Number in the account\\n  $message = \\\"Thank%20you%20for%20calling.\\\";\\n\\n\\n\\n  // Construct the full URL\\n  $full_url = $baseuri . \\\"&action=\\\" . $action .\\n    \\\"&access_key=\\\" . $access_key .\\n    \\\"&secret_access_key=\\\" . $secret_access_key .\\n    \\\"&to=\\\" . $to .\\n    \\\"&from=\\\" . $from .\\n    \\\"&message=\\\" . $message;\\n\\n\\n  // Set the URL\\n  curl_setopt($ch, CURLOPT_URL, $full_url);\\n\\n  // Sets the return options of the cURL to return the actual result from the curl request, and FALSE on failure\\n  curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);\\n\\n  // Sets the $output variable to the result of the curl\\n  $output = curl_exec($ch);\\n\\n  // Close curl resource to free up system resources\\n  curl_close($ch);\\n\\n  // Echo the XML response to the page\\n  echo $output;\\n?>\",\n      \"language\": \"php\",\n      \"name\": \"PHP Example\"\n    }\n  ]\n}\n[/block]\n**Example Response**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<!DOCTYPE response [\\n<!ELEMENT response (result,result_description)>\\n<!ELEMENT result (#PCDATA)>\\n<!ELEMENT result_description (#PCDATA)>\\n]>\\n<response>\\n    <result>success</result>\\n    <result_description>[1] Message Sent</result_description>\\n</response>\",\n      \"language\": \"xml\",\n      \"name\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"API used to send an SMS message","slug":"sms-send-message","type":"basic","title":"Send Message"}

Send Message

API used to send an SMS message

Use the SMS Send Message API to send an SMS message

The SMS Send Message API is used to send an SMS message from a DialogTech SMS enabled tracking number, to a 3rd party recipient.

Base URL for SMS Send Message

https://secure.dialogtech.com/ibp_api.php

Rate Limits

The SMS API enforces the following rate-limits

  • 
40 sms per number per 60 seconds
  • 4 sms per DialogTech account per second
  • 1 sms per number per second

Parameter List

Parameter
Required
Accepts
Max Length
Notes
Usage

action

Yes

String: sms.send_message

n/a

Only accepts sms.send_message to send an SMS Message

Defines the API Call as "SMS Send Message" type

access_key

Yes

String

n/a

Access Key from the Key Manager within a DialogTech account

Credentials used for access to the API for a particular DialogTech account

secret_access_key

Yes

String

n/a

Secret Access Key from the Key Manager within a DialogTech account

Credentials used for access to the API for a particular DialogTech account

to

Yes

String: Unformatted Phone Number

n/a

Can be any unformatted phone number

Defines the start of the date-range for records to be returned from

from

Yes

String: Unformatted Phone Number

n/a

Must be a DialogTech SMS enabled tracking number

Defines the end of the date-range for records to be returned from

message

Yes

String

256

DialogTech does not limit / break texts into smaller batches messages. This behavior is dependent on the recipient's carrier

Defines the message being send to the third party.

Using this API

These code examples are meant to show a basic method of accessing DialogTech's IVR Report API.

<?php
  /*
    SMS Send Message EX:
    This example will send an SMS with
    the text 'Thank you for calling.'
    to a predefined number and echo the
    verbatim XML response.
  */

  // Create cURL resource
  $ch = curl_init(); 
  $baseuri = "https://secure.dialogtech.com/ibp_api.php?";

  // API Specific Static Parameters
  $action = "sms.send_message";

  // Required User Parameters To Request the API
  $access_key = "foo";
  $secret_access_key = "bar";
  $to = "5556667777";
  $from = "5554332111"; // This is a DialogTech SMS-Enabled Tracking Number in the account
  $message = "Thank%20you%20for%20calling.";



  // Construct the full URL
  $full_url = $baseuri . "&action=" . $action .
    "&access_key=" . $access_key .
    "&secret_access_key=" . $secret_access_key .
    "&to=" . $to .
    "&from=" . $from .
    "&message=" . $message;


  // Set the URL
  curl_setopt($ch, CURLOPT_URL, $full_url);

  // Sets the return options of the cURL to return the actual result from the curl request, and FALSE on failure
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

  // Sets the $output variable to the result of the curl
  $output = curl_exec($ch);

  // Close curl resource to free up system resources
  curl_close($ch);

  // Echo the XML response to the page
  echo $output;
?>

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE response [
<!ELEMENT response (result,result_description)>
<!ELEMENT result (#PCDATA)>
<!ELEMENT result_description (#PCDATA)>
]>
<response>
    <result>success</result>
    <result_description>[1] Message Sent</result_description>
</response>