{"_id":"591334d1c188f10f00503423","user":"58cadf93d223510f005d27db","__v":0,"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"},"parentDoc":null,"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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-10T15:42:09.331Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":true,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"[block:api-header]\n{\n  \"title\": \"Use the Number Configuration - Basic API to set up routing for a phone number\"\n}\n[/block]\nUse the Number Configuration - Basic API to set up routing for a phone number within a DialogTech's account.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Base URL for Number Configuration - Basic\",\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: **routing.configure**\",\n    \"0-3\": \"n/a\",\n    \"0-4\": \"Only accepts **routing.configure** to set up routing for a phone number\",\n    \"0-5\": \"Defines the API Call as \\\"Number Configuration - Basic\\\" 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_number\",\n    \"4-0\": \"routing_type\",\n    \"3-1\": \"Yes\",\n    \"3-2\": \"Unformatted Phone Number\",\n    \"4-2\": \"**findme** or **transfer** or **transfer_w_whisper** or **survo** or **locator** or **broadcast_from_phone** or **call_distributor** or **vmail**\",\n    \"4-1\": \"Yes\",\n    \"3-3\": \"n/a\",\n    \"4-3\": \"n/a\",\n    \"3-4\": \"\",\n    \"4-4\": \"**findme** - Configure routing to a FindMe\\n**transfer** - Configure routing to a Transfer\\n**transfer_w_whisper** - Configure routing to a Transfer using a Whisper\\n**survo** - Configure routing to a SurVo\\n**locator** - Configure routing to a Store Locator\\n**broadcast_from_phone** - Configure routing to a Broadcast From Phone\\n**call_distributor** - Configure routing to a Call Distributor\\n**vmail** - Configure routing to a Voicemail\",\n    \"3-5\": \"\",\n    \"4-5\": \"Determines which application a number is configured to route to.\",\n    \"5-0\": \"parameter1\",\n    \"5-1\": \"Yes\",\n    \"5-2\": \"*See Routing Parameter List*\",\n    \"5-3\": \"n/a\",\n    \"5-4\": \"*See Routing Parameter List*\",\n    \"5-5\": \"*See a*See Routing Parameter List*Parameter List*\",\n    \"9-0\": \"description\",\n    \"9-1\": \"No\",\n    \"9-2\": \"String\",\n    \"9-3\": \"n/a\",\n    \"9-4\": \"Phone Label assigned to a phone number\",\n    \"9-5\": \"Defines the label assigned to the `phone_number` provided\",\n    \"10-0\": \"record_call\",\n    \"10-1\": \"No\",\n    \"10-2\": \"**0** or **1**\",\n    \"10-3\": \"1\",\n    \"10-4\": \"**0** - Do not record the call (default)\\n**1** - Record the call\",\n    \"10-5\": \"Determines if the call will be recorded or not.\",\n    \"11-0\": \"recording_warning\",\n    \"11-1\": \"No\",\n    \"11-2\": \"**0** or **1** or **2** or **3**\",\n    \"11-3\": \"1\",\n    \"11-4\": \"**0** - Play warning to caller and recipient (default)\\n**1** - Play warning to caller only\\n**2** - Play warning to Recipient only\\n**3** - Do not play warning\",\n    \"11-5\": \"Determines if and to whom the \\\"This call may be recorded for quality purposes\\\" message is played\",\n    \"12-0\": \"reverse_lookup\",\n    \"12-1\": \"No\",\n    \"12-2\": \"**0** or **1**\",\n    \"12-3\": \"1\",\n    \"12-4\": \"**0** - Do not perform a reverse lookup (default)\\n**1** - Perform a reverse lookup *(additional charges may apply)*\",\n    \"12-5\": \"Determines if there should be a reverse lookup performed against the caller\",\n    \"13-0\": \"play_ring\",\n    \"13-1\": \"No\",\n    \"13-2\": \"**0** or **1**\",\n    \"13-3\": \"1\",\n    \"13-4\": \"**0** - Do not play any artificial ring-sounds to the caller (default)\\n**1** - Play artificial ring-sounds to the caller to help mitigate silence during transfers\",\n    \"13-5\": \"Determines if an artificial ring sound should be utilized to impact the calling experience. This setting could help if calls are experiencing silence during the transfers.\",\n    \"6-0\": \"parameter2\",\n    \"6-1\": \"No\",\n    \"7-0\": \"parameter3\",\n    \"8-0\": \"parameter4\",\n    \"7-1\": \"No\",\n    \"8-1\": \"No\",\n    \"6-2\": \"*See Routing Parameter List*\",\n    \"7-2\": \"*See Routing Parameter List*\",\n    \"8-2\": \"*See Routing Parameter List*\",\n    \"6-3\": \"n/a\",\n    \"7-3\": \"n/a\",\n    \"8-3\": \"n/a\",\n    \"6-4\": \"*See Routing Parameter List*\",\n    \"6-5\": \"*See Routing Parameter List*\",\n    \"7-5\": \"*See Routing Parameter List*\",\n    \"8-5\": \"*See Routing Parameter List*\",\n    \"8-4\": \"*See Routing Parameter List*\",\n    \"7-4\": \"*See Routing Parameter List*\"\n  },\n  \"cols\": 6,\n  \"rows\": 14\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Routing Parameter List\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Routing Type\",\n    \"0-0\": \"**findme**\",\n    \"h-1\": \"Parameter Usage\",\n    \"0-1\": \"`parameter1` - Building Block ID of the FindMe (required)\\n`parameter2` - Prompt to read to the caller using TTS (optional)\\n`parameter3` - Whisper Phrase spoken using TTS (optional)\",\n    \"1-0\": \"**transfer_w_whisper**\",\n    \"2-0\": \"**survo**\",\n    \"3-0\": \"**transfer**\",\n    \"4-0\": \"**locator**\",\n    \"6-0\": \"**vmail**\",\n    \"5-0\": \"**virtual_receptionist**\",\n    \"7-0\": \"**broadcast_from_phone**\",\n    \"1-1\": \"`parameter1` - Transfer To Number (required)\\n`parameter2` - Prompt to read to the caller using TTS (optional)\\n`parameter3` - Whisper Phrase spoken using TTS (optional)\\n`parameter4` - Record Call (optional) **0**=recording off (default) **1**=recording on\",\n    \"2-1\": \"`parameter1` - Building Block ID of the SurVo/IVR (required)\\n`parameter2` - Prompt to read to the caller using TTS (optional)\",\n    \"3-1\": \"`parameter1` - Transfer To Number (required)\\n`parameter2` - Prompt to read to the caller using TTS (optional)\",\n    \"5-1\": \"`parameter1` - Building Block ID of the Virtual Receptionist (required)\",\n    \"6-1\": \"`parameter1` - Building Block ID of Voicemail Box (required)\\n`parameter2` - Prompt to read to the caller using TTS (optional)\",\n    \"7-1\": \"`parameter1` - Group ID (required). Use 0 to select group from phone.\",\n    \"4-1\": \"`parameter1` - Building Block ID of the Store Locator (required)\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Using this API\"\n}\n[/block]\n**Example Response**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n\\t<result>success</result>\\n\\t<result_description>success</result_description>\\n</response>\",\n      \"language\": \"xml\",\n      \"name\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"API used to set up routing for a phone number","slug":"number-configuration-basic","type":"basic","title":"Number Configuration - Basic"}

Number Configuration - Basic

API used to set up routing for a phone number

Use the Number Configuration - Basic API to set up routing for a phone number

Use the Number Configuration - Basic API to set up routing for a phone number within a DialogTech's account.

Base URL for Number Configuration - Basic

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

Parameter List

Parameter
Required
Accepts
Max Length
Notes
Usage

action

Yes

String: routing.configure

n/a

Only accepts routing.configure to set up routing for a phone number

Defines the API Call as "Number Configuration - Basic" 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_number

Yes

Unformatted Phone Number

n/a

routing_type

Yes

findme or transfer or transfer_w_whisper or survo or locator or broadcast_from_phone or call_distributor or vmail

n/a

findme - Configure routing to a FindMe
transfer - Configure routing to a Transfer
transfer_w_whisper - Configure routing to a Transfer using a Whisper
survo - Configure routing to a SurVo
locator - Configure routing to a Store Locator
broadcast_from_phone - Configure routing to a Broadcast From Phone
call_distributor - Configure routing to a Call Distributor
vmail - Configure routing to a Voicemail

Determines which application a number is configured to route to.

parameter1

Yes

See Routing Parameter List

n/a

See Routing Parameter List

See aSee Routing Parameter ListParameter List

parameter2

No

See Routing Parameter List

n/a

See Routing Parameter List

See Routing Parameter List

parameter3

No

See Routing Parameter List

n/a

See Routing Parameter List

See Routing Parameter List

parameter4

No

See Routing Parameter List

n/a

See Routing Parameter List

See Routing Parameter List

description

No

String

n/a

Phone Label assigned to a phone number

Defines the label assigned to the phone_number provided

record_call

No

0 or 1

1

0 - Do not record the call (default)
1 - Record the call

Determines if the call will be recorded or not.

recording_warning

No

0 or 1 or 2 or 3

1

0 - Play warning to caller and recipient (default)
1 - Play warning to caller only
2 - Play warning to Recipient only
3 - Do not play warning

Determines if and to whom the "This call may be recorded for quality purposes" message is played

reverse_lookup

No

0 or 1

1

0 - Do not perform a reverse lookup (default)
1 - Perform a reverse lookup (additional charges may apply)

Determines if there should be a reverse lookup performed against the caller

play_ring

No

0 or 1

1

0 - Do not play any artificial ring-sounds to the caller (default)
1 - Play artificial ring-sounds to the caller to help mitigate silence during transfers

Determines if an artificial ring sound should be utilized to impact the calling experience. This setting could help if calls are experiencing silence during the transfers.

Routing Parameter List

Routing Type
Parameter Usage

findme

parameter1 - Building Block ID of the FindMe (required)
parameter2 - Prompt to read to the caller using TTS (optional)
parameter3 - Whisper Phrase spoken using TTS (optional)

transfer_w_whisper

parameter1 - Transfer To Number (required)
parameter2 - Prompt to read to the caller using TTS (optional)
parameter3 - Whisper Phrase spoken using TTS (optional)
parameter4 - Record Call (optional) 0=recording off (default) 1=recording on

survo

parameter1 - Building Block ID of the SurVo/IVR (required)
parameter2 - Prompt to read to the caller using TTS (optional)

transfer

parameter1 - Transfer To Number (required)
parameter2 - Prompt to read to the caller using TTS (optional)

locator

parameter1 - Building Block ID of the Store Locator (required)

virtual_receptionist

parameter1 - Building Block ID of the Virtual Receptionist (required)

vmail

parameter1 - Building Block ID of Voicemail Box (required)
parameter2 - Prompt to read to the caller using TTS (optional)

broadcast_from_phone

parameter1 - Group ID (required). Use 0 to select group from phone.

Using this API

Example Response

<response>
	<result>success</result>
	<result_description>success</result_description>
</response>