{"_id":"5908d10a0e0a521b00164ac6","project":"558d9c32beb7c719007f6319","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"},"githubsync":"","user":"58cadf93d223510f005d27db","parentDoc":null,"category":{"_id":"590829c7ade4172d006a87b8","project":"558d9c32beb7c719007f6319","__v":0,"version":"558d9c33beb7c719007f631c","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-05-02T06:40:07.955Z","from_sync":false,"order":1,"slug":"administration-apis","title":"Administration APIs"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-02T18:33:46.536Z","link_external":false,"link_url":"","sync_unique":"","hidden":true,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":10,"body":"[block:api-header]\n{\n  \"title\": \"Use the Register Number API to register a number as a Caller ID\"\n}\n[/block]\nThe Register Number API is used  to register a number as a Caller ID within a DialogTech account when the number is not provided by DialogTech but is still legally owned by the account holder.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Base URL for Register Number\",\n  \"body\": \"https://secure.dialogtech.com/ibp_api.php\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Any account wanting to register numbers via the API must submit a 1-time form to legally verify that they own any numbers submitted via API. Please visit https://secure.dialogtech.com/registered_numbers_api_verification.php to submit the form.\",\n  \"title\": \"Notice\"\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: **registerednumbers.add**\",\n    \"0-3\": \"n/a\",\n    \"0-4\": \"Only accepts **registerednumbers.add** to add registered numbers\",\n    \"0-5\": \"Defines the API Call as \\\"Add Registered 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\": \"phone\",\n    \"4-0\": \"description\",\n    \"4-1\": \"Yes\",\n    \"3-1\": \"Yes\",\n    \"3-2\": \"String: Unformatted Phone Number\",\n    \"3-3\": \"10\",\n    \"3-4\": \"Phone number not provided through DialogTech but is still legally owned by the customer for use as a Caller ID\",\n    \"3-5\": \"Defines which phone number is being registered as a Caller ID\",\n    \"4-2\": \"String\",\n    \"4-3\": \"n/a\",\n    \"4-4\": \"Description of the Phone Number\",\n    \"4-5\": \"A description of the phone number which is used to help identify the number in the registered numbers user interface\"\n  },\n  \"cols\": 6,\n  \"rows\": 5\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 using DialogTech's Register Number API\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\",\n      \"language\": \"text\",\n      \"name\": \"PHP Example\"\n    }\n  ]\n}\n[/block]\n**Example Response**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\",\n      \"language\": \"xml\",\n      \"name\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"Used to register a number as a Caller ID","slug":"add-registered-number","type":"basic","title":"Add Registered Number"}

Add Registered Number

Used to register a number as a Caller ID

Use the Register Number API to register a number as a Caller ID

The Register Number API is used to register a number as a Caller ID within a DialogTech account when the number is not provided by DialogTech but is still legally owned by the account holder.

Base URL for Register Number

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

Notice

Any account wanting to register numbers via the API must submit a 1-time form to legally verify that they own any numbers submitted via API. Please visit https://secure.dialogtech.com/registered_numbers_api_verification.php to submit the form.

Parameter List

Parameter
Required
Accepts
Max Length
Notes
Usage

action

Yes

String: registerednumbers.add

n/a

Only accepts registerednumbers.add to add registered numbers

Defines the API Call as "Add Registered 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

phone

Yes

String: Unformatted Phone Number

10

Phone number not provided through DialogTech but is still legally owned by the customer for use as a Caller ID

Defines which phone number is being registered as a Caller ID

description

Yes

String

n/a

Description of the Phone Number

A description of the phone number which is used to help identify the number in the registered numbers user interface

Using this API

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

Example Response