{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Get Numbers","type":"basic","slug":"sms-get-numbers","excerpt":"API used to get a list of SMS enabled numbers","body":"[block:api-header]\n{\n \"title\": \"Use the SMS Get Numbers API to retrieve a list of SMS enabled numbers\"\n}\n[/block]\nThe SMS Get Numbers API is used to retrieve a list of SMS enabled numbers from within a DialogTech account\n[block:callout]\n{\n \"type\": \"info\",\n \"title\": \"Base URL for SMS Get Numbers\",\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.get_numbers**\",\n \"0-3\": \"n/a\",\n \"0-4\": \"Only accepts **sms.get_numbers** to retrieve SMS enabled numbers\",\n \"0-5\": \"Defines the API Call as \\\"SMS Get Numbers\\\" 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 },\n \"cols\": 6,\n \"rows\": 3\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\\nhttps://secure.dialogtech.com/ibp_api.php?access_key=ACCESS_KEY&secret_access_key=SECRET_ACCESS_KEY&action=sms.get_numbers\\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, data)>\\n<!ELEMENT result (#PCDATA)>\\n<!ELEMENT result_description (#PCDATA)>\\n<!ELEMENT data (number+)>\\n<!ELEMENT number (#PCDATA)>\\n<!ELEMENT url (#PCDATA)>\\n]>\\n<response>\\n\\t<result></result>\\n\\t<result_description>[1] Number(s) Returned</result_description>\\n\\t<data>\\n\\t\\t<number sms_enabled=\\\"1\\\" url=\\\"http://example.net/sms_listener.php\\\">5559990000</number>\\n\\t</data>\\n</response>\\n\",\n \"language\": \"xml\",\n \"name\": \"xml\"\n }\n ]\n}\n[/block]","updates":[],"order":5,"isReference":false,"hidden":true,"sync_unique":"","link_url":"","link_external":false,"_id":"58fdfbbbeed0651b00f82e49","__v":0,"user":"58cadf93d223510f005d27db","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["558d9c33beb7c719007f631d","558db0bc7afc102f008ed863","558db0d07afc102f008ed864","558db3c84cd25f0d00b7ecb2","558dbace7afc102f008ed894","558dbd104cd25f0d00b7ecca","558dbd4c4cd25f0d00b7eccb","559d3e858639bd21008e90a6","55bb8ca5a8400c2d00873e70","58fdfb438fbd2819000db9eb","590829c7ade4172d006a87b8","59082a11beedcf0f00235d87","5908bd2cba2afd23007d6d12","5908d1f64f544425002b6aae","591e5e9e2c1b1f0f000fa4e5","5a283434aba91f002834ea86","5a69fe5cde745d002c936c66","5a81e6ef761cf300127317f8","5a81e7d63b1e120012bed5a1","5f6cf225ba56a40011bff62d","5f970e8b7617eb041ae758bb","602adb88243fbc0056918566","602adbb91828a600535980c4"],"_id":"558d9c33beb7c719007f631c","createdAt":"2015-06-26T18:38:43.154Z","project":"558d9c32beb7c719007f6319","releaseDate":"2015-06-26T18:38:43.153Z","__v":23},"parentDoc":null,"project":"558d9c32beb7c719007f6319","githubsync":"","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"SMS APIs","slug":"sms-apis","order":3,"from_sync":false,"reference":false,"_id":"58fdfb438fbd2819000db9eb","createdAt":"2017-04-24T13:18:59.649Z","__v":0,"version":"558d9c33beb7c719007f631c","project":"558d9c32beb7c719007f6319"},"createdAt":"2017-04-24T13:20:59.349Z"}
Get Numbers
API used to get a list of SMS enabled numbers
The SMS Get Numbers API is used to retrieve a list of SMS enabled numbers from within a DialogTech account
Base URL for SMS Get Numbers
Parameter
Required
Accepts
Max Length
Notes
Usage
action
Yes
String: sms.get_numbers
n/a
Only accepts sms.get_numbers to retrieve SMS enabled numbers
Defines the API Call as "SMS Get Numbers" 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
These code examples are meant to show a basic method of accessing DialogTech's IVR Report API.
<?php
https://secure.dialogtech.com/ibp_api.php?access_key=ACCESS_KEY&secret_access_key=SECRET_ACCESS_KEY&action=sms.get_numbers
?>
curl -X ""
Example Response
<response>
<result></result>
<result_description>[1] Number(s) Returned</result_description>
<data>
<number sms_enabled="1" url="http://example.net/sms_listener.php">5559990000</number>
</data>
</response>