{"_id":"58fdfbc0c1e51e1900412a00","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"},"project":"558d9c32beb7c719007f6319","user":"58cadf93d223510f005d27db","githubsync":"","parentDoc":null,"__v":1,"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"},"updates":["5ac2807272317b00330f50d0"],"next":{"pages":[],"description":""},"createdAt":"2017-04-24T13:21:04.149Z","link_external":false,"link_url":"","sync_unique":"","hidden":true,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"NOTICE\",\n  \"body\": \"**Not all numbers on the DialogTech platform are capable of sending/receiving SMS**\\n\\nDialogTech is partners with many top-tier carriers to handle call and SMS traffic around the world. Unfortunately, not every one of these partners is capable of sending/receiving SMS. This means not every number on the DialogTech platform is capable of sending/receiving SMS. If you need help ensuring the number you're wanting to use, is SMS capable, please reach out to our Customer Support Team at [support:::at:::dialogtech.com](mailto:support@dialogtech.com) or by calling [(877) 295-5100](tel:8772955100).\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Use the SMS Register Number API to enable SMS\"\n}\n[/block]\nThe SMS Register Number API is used to enable SMS functionality for a tracking number within a DialogTech account.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Base URL for SMS Register Number\",\n  \"body\": \"https://secure.dialogtech.com/ibp_api.php\"\n}\n[/block]\n\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.register_number**\",\n    \"0-3\": \"n/a\",\n    \"0-4\": \"Only accepts **sms.register_number** to register a tracking number as SMS capable\",\n    \"0-5\": \"Defines the API Call as \\\"SMS Register Number\\\" 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\": \"number\",\n    \"4-0\": \"url\",\n    \"4-1\": \"No\",\n    \"3-1\": \"Yes\",\n    \"3-2\": \"String: Unformatted Phone Number\",\n    \"3-3\": \"10\",\n    \"3-4\": \"Local phone number* from within a DialogTech account which is hosted with an SMS-capable carrier\",\n    \"3-5\": \"Defines which phone number is being enabled for SMS\",\n    \"4-2\": \"String URL\",\n    \"4-3\": \"1024\",\n    \"4-4\": \"URL which inbound SMS content will be forwarded to\",\n    \"4-5\": \"When receiving an SMS, DialogTech can forward the SMS to a URL\",\n    \"5-0\": \"dlr_url\",\n    \"5-1\": \"No\",\n    \"5-2\": \"String URL\",\n    \"5-3\": \"1024\",\n    \"5-4\": \"URL which DLR conent generated from outbound SMS will be forwarded to\",\n    \"5-5\": \"When receiving DLR for an SMS, DialogTech can forward the DLR to a URL\"\n  },\n  \"cols\": 6,\n  \"rows\": 6\n}\n[/block]\n*Tollfree SMS is available by contacting your account manager or by reaching out to DialogTech's [Customer Support Team](mailto:support@dialogtech.com).\n[block:api-header]\n{\n  \"title\": \"Using this API\"\n}\n[/block]\nThese code examples are meant to show a basic method of using DialogTech's SMS Register Number API\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\n\\nhttps://secure.dialogtech.com/ibp_api.php?access_key=ACCESS_KEY&secret_access_key=SECRET_ACCESS_KEY&action=sms.register_number&number=5556667777&url=http://example.net/sms_listener.php&dlr_url=http://www.example.net/dlr_listener.php\\n\\n?>\",\n      \"language\": \"text\",\n      \"name\": \"PHP Example\"\n    },\n    {\n      \"code\": \"curl -X \\\"\\\"\",\n      \"language\": \"text\",\n      \"name\": \"cURL\"\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>[5556667777] Registered</result_description>\\n</response>\",\n      \"language\": \"xml\",\n      \"name\": \"xml\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Forwarding SMS from DialogTech\"\n}\n[/block]\nDialogTech has the ability to forward the message received via SMS via a DialogTech SMS enabled tracking number, to a web-service by utilizing URL Parameters. The destination DialogTech will forward these messages to should be provided when using the [SMS Register Number](doc:sms-register-number) API and the available `url` parameter.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"URL Parameter Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"from_number\",\n    \"0-1\": \"The Caller ID of the number which sent an SMS to a tracking number\",\n    \"1-0\": \"to_number\",\n    \"1-1\": \"The tracking number which was sent an SMS\",\n    \"2-0\": \"message\",\n    \"2-1\": \"The message sent from the `from_number` to the `to_number`\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Forwarding SMS DLR from DialogTech\"\n}\n[/block]\nDialogTech also has the ability to forward all DLR content received for each outbound SMS sent via a DialogTech SMS enabled tracking number, to a web-service by utilizing URL parameters.  The destination DialogTech will forward these DLR to should be provided when using the [SMS Register Number](doc:sms-register-number) API and the available `dlr_url` parameter.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"URL Parameter Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"uuid\",\n    \"0-1\": \"The unique identifier for the outgoing SMS within DialogTech that has an association with this DLR message.\",\n    \"1-0\": \"from_number\",\n    \"1-1\": \"The original destination (to) of the outgoing SMS sent by the [SMS Send Message](doc:sms-send-message) API which this DLR associates, acts as a surrogate caller ID.\",\n    \"2-1\": \"The original destination (to) of the outgoing SMS sent by the [SMS Send Message](doc:sms-send-message) API which this DLR associates, acts as a surrogate DialogTech tracking number.\",\n    \"2-0\": \"to_number\",\n    \"3-0\": \"dlr_status\",\n    \"3-1\": \"A numerical classification type of each DLR received on behalf of the outgoing SMS sent by the [SMS Send Message](doc:sms-send-message) API.  This will common be one of:\\n\\n2 - Message failed delivery\\n4 - Message queued by carrier for delivery\\n8 - Message sent to carrier for delivery\",\n    \"4-0\": \"dlr_text\",\n    \"4-1\": \"The raw DLR payload as delivered to us by the carrier involved on behalf of the outgoing SMS sent by the [SMS Send Message](doc:sms-send-message) API.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]","excerpt":"API used to enable SMS on a DialogTech tracking number","slug":"sms-register-number","type":"basic","title":"Register Number"}

Register Number

API used to enable SMS on a DialogTech tracking number

NOTICE

Not all numbers on the DialogTech platform are capable of sending/receiving SMS

DialogTech is partners with many top-tier carriers to handle call and SMS traffic around the world. Unfortunately, not every one of these partners is capable of sending/receiving SMS. This means not every number on the DialogTech platform is capable of sending/receiving SMS. If you need help ensuring the number you're wanting to use, is SMS capable, please reach out to our Customer Support Team at support@dialogtech.com or by calling (877) 295-5100.

Use the SMS Register Number API to enable SMS

The SMS Register Number API is used to enable SMS functionality for a tracking number within a DialogTech account.

Base URL for SMS Register Number

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

Parameter List

Parameter
Required
Accepts
Max Length
Notes
Usage

action

Yes

String: sms.register_number

n/a

Only accepts sms.register_number to register a tracking number as SMS capable

Defines the API Call as "SMS Register Number" 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

number

Yes

String: Unformatted Phone Number

10

Local phone number* from within a DialogTech account which is hosted with an SMS-capable carrier

Defines which phone number is being enabled for SMS

url

No

String URL

1024

URL which inbound SMS content will be forwarded to

When receiving an SMS, DialogTech can forward the SMS to a URL

dlr_url

No

String URL

1024

URL which DLR conent generated from outbound SMS will be forwarded to

When receiving DLR for an SMS, DialogTech can forward the DLR to a URL

*Tollfree SMS is available by contacting your account manager or by reaching out to DialogTech's Customer Support Team.

Using this API

These code examples are meant to show a basic method of using DialogTech's SMS Register Number API

<?php

https://secure.dialogtech.com/ibp_api.php?access_key=ACCESS_KEY&secret_access_key=SECRET_ACCESS_KEY&action=sms.register_number&number=5556667777&url=http://example.net/sms_listener.php&dlr_url=http://www.example.net/dlr_listener.php

?>
curl -X ""

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>[5556667777] Registered</result_description>
</response>

Forwarding SMS from DialogTech

DialogTech has the ability to forward the message received via SMS via a DialogTech SMS enabled tracking number, to a web-service by utilizing URL Parameters. The destination DialogTech will forward these messages to should be provided when using the SMS Register Number API and the available url parameter.

URL Parameter Name
Description

from_number

The Caller ID of the number which sent an SMS to a tracking number

to_number

The tracking number which was sent an SMS

message

The message sent from the from_number to the to_number

Forwarding SMS DLR from DialogTech

DialogTech also has the ability to forward all DLR content received for each outbound SMS sent via a DialogTech SMS enabled tracking number, to a web-service by utilizing URL parameters. The destination DialogTech will forward these DLR to should be provided when using the SMS Register Number API and the available dlr_url parameter.

URL Parameter Name
Description

uuid

The unique identifier for the outgoing SMS within DialogTech that has an association with this DLR message.

from_number

The original destination (to) of the outgoing SMS sent by the SMS Send Message API which this DLR associates, acts as a surrogate caller ID.

to_number

The original destination (to) of the outgoing SMS sent by the SMS Send Message API which this DLR associates, acts as a surrogate DialogTech tracking number.

dlr_status

A numerical classification type of each DLR received on behalf of the outgoing SMS sent by the SMS Send Message API. This will common be one of:

2 - Message failed delivery
4 - Message queued by carrier for delivery
8 - Message sent to carrier for delivery

dlr_text

The raw DLR payload as delivered to us by the carrier involved on behalf of the outgoing SMS sent by the SMS Send Message API.