{"_id":"58fdfbc7c1e51e1900412a01","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,"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"},"githubsync":"","parentDoc":null,"project":"558d9c32beb7c719007f6319","user":"58cadf93d223510f005d27db","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-04-24T13:21:11.431Z","link_external":false,"link_url":"","sync_unique":"","hidden":true,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"[block:api-header]\n{\n  \"title\": \"Use the SMS Unregister Number API to disable SMS\"\n}\n[/block]\nThe SMS Un-Register Number API is used to disable SMS functionality for a tracking number within a DialogTech account.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Base URL for SMS Unregister 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.unregister_number**\",\n    \"0-3\": \"n/a\",\n    \"0-4\": \"Only accepts **sms.unregister_number** to disable SMS\",\n    \"0-5\": \"Defines the API Call as \\\"SMS Unregister 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    \"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 SMS enabled\",\n    \"3-5\": \"Defines which phone number is being disabled for SMS\"\n  },\n  \"cols\": 6,\n  \"rows\": 4\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:::at:::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 Unregister 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.unregister_number&number=5556667777\\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] Unregistered</result_description>\\n</response>\",\n      \"language\": \"xml\",\n      \"name\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"API used to disable SMS on a DialogTech tracking number","slug":"sms-unregister-number","type":"basic","title":"Unregister Number"}

Unregister Number

API used to disable SMS on a DialogTech tracking number

Use the SMS Unregister Number API to disable SMS

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

Base URL for SMS Unregister Number

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

Parameter List

Parameter
Required
Accepts
Max Length
Notes
Usage

action

Yes

String: sms.unregister_number

n/a

Only accepts sms.unregister_number to disable SMS

Defines the API Call as "SMS Unregister 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 SMS enabled

Defines which phone number is being disabled for SMS

*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 Unregister Number API

<?php

https://secure.dialogtech.com/ibp_api.php?access_key=ACCESS_KEY&secret_access_key=SECRET_ACCESS_KEY&action=sms.unregister_number&number=5556667777

?>
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] Unregistered</result_description>
</response>