{"_id":"591334db65888319004e7222","githubsync":"","parentDoc":null,"project":"558d9c32beb7c719007f6319","__v":0,"user":"58cadf93d223510f005d27db","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"},"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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-10T15:42:19.988Z","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 Number Configuration - Advanced API to set up advanced features for a tracking number\"\n}\n[/block]\nUse the Number Configuration - Advanced API to set up advanced features for a tracking number within a DialogTech's account.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Base URL for Number Configuration - Advanced\",\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.advanced**\",\n    \"0-3\": \"n/a\",\n    \"0-4\": \"Only accepts **routing.advanced** to set up advanced features for a tracking number\",\n    \"0-5\": \"Defines the API Call as \\\"Number Configuration - Advanced\\\" 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    \"3-1\": \"Yes\",\n    \"3-2\": \"Unformatted Phone Number\",\n    \"3-3\": \"n/a\",\n    \"3-4\": \"\",\n    \"3-5\": \"\",\n    \"4-0\": \"record_call\",\n    \"4-1\": \"No\",\n    \"4-2\": \"**0** or **1** or **2** or **3**\",\n    \"4-3\": \"1\",\n    \"4-4\": \"**0** - Do not record the call (default)\\n**1** - Record after transfer\\n**2** - Record whole call\\n**3** - Record up to transfer\",\n    \"4-5\": \"Determines if the call will be recorded or not.\",\n    \"5-0\": \"play_warning\",\n    \"5-1\": \"No\",\n    \"5-2\": \"**0** or **1** or **2** or **3**\",\n    \"5-3\": \"1\",\n    \"5-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    \"5-5\": \"Determines if and to whom the \\\"This call may be recorded for quality purposes\\\" message is played\",\n    \"6-0\": \"reverse_lookup\",\n    \"6-1\": \"No\",\n    \"6-2\": \"**0** or **1**\",\n    \"6-3\": \"1\",\n    \"6-4\": \"**0** - Do not perform a reverse lookup (default)\\n**1** - Perform a reverse lookup *(additional charges may apply)*\",\n    \"6-5\": \"Determines if there should be a reverse lookup performed against the caller\",\n    \"7-0\": \"always_ring\",\n    \"7-1\": \"No\",\n    \"7-2\": \"**0** or **1**\",\n    \"7-3\": \"1\",\n    \"7-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    \"7-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    \"8-0\": \"caller_audio\",\n    \"8-1\": \"No\",\n    \"8-2\": \"String\",\n    \"8-3\": \"n/a\",\n    \"8-4\": \"Link to an audio file in your account to be used as caller whisper audio\",\n    \"8-5\": \"Determines the audio file to be used as caller whisper audio\",\n    \"9-0\": \"recipient_audio\",\n    \"9-1\": \"No\",\n    \"9-2\": \"String\",\n    \"9-3\": \"n/a\",\n    \"9-4\": \"Link to an audio file in your account to be used as recipient whisper audio\",\n    \"9-5\": \"Determines the audio file to be used as recipient whisper audio\",\n    \"10-0\": \"ga_referrer\",\n    \"11-0\": \"ga_content\",\n    \"12-0\": \"ga_campaign\",\n    \"13-0\": \"ga_term\",\n    \"14-0\": \"ga_medium\",\n    \"10-1\": \"No\",\n    \"11-1\": \"No\",\n    \"12-1\": \"No\",\n    \"13-1\": \"No\",\n    \"14-1\": \"No\",\n    \"10-2\": \"String\",\n    \"11-2\": \"String\",\n    \"12-2\": \"String\",\n    \"13-2\": \"String\",\n    \"14-2\": \"String\",\n    \"10-3\": \"100\",\n    \"11-3\": \"100\",\n    \"12-3\": \"100\",\n    \"13-3\": \"100\",\n    \"14-3\": \"100\",\n    \"10-5\": \"Determines the UTM Referrer used with DialogTech's integration into Google Universal Analytics integration\",\n    \"11-5\": \"Determines the UTM Content used with DialogTech's integration into Google Universal Analytics integration\",\n    \"12-5\": \"Determines the UTM Campaign used with DialogTech's integration into Google Universal Analytics integration\",\n    \"13-5\": \"Determines the UTM Term used with DialogTech's integration into Google Universal Analytics integration\",\n    \"14-5\": \"Determines the UTM Medium used with DialogTech's integration into Google Universal Analytics integration\",\n    \"10-4\": \"UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributed\",\n    \"11-4\": \"UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributed\",\n    \"12-4\": \"UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributed\",\n    \"13-4\": \"UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributed\",\n    \"14-4\": \"UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributed\"\n  },\n  \"cols\": 6,\n  \"rows\": 15\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>Phone number updated successfully</result_description>\\n</response>\",\n      \"language\": \"xml\",\n      \"name\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"Used to set up advanced features for a tracking number","slug":"number-configuration-advanced","type":"basic","title":"Number Configuration - Advanced"}

Number Configuration - Advanced

Used to set up advanced features for a tracking number

Use the Number Configuration - Advanced API to set up advanced features for a tracking number

Use the Number Configuration - Advanced API to set up advanced features for a tracking number within a DialogTech's account.

Base URL for Number Configuration - Advanced

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

Parameter List

Parameter
Required
Accepts
Max Length
Notes
Usage

action

Yes

String: routing.advanced

n/a

Only accepts routing.advanced to set up advanced features for a tracking number

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

record_call

No

0 or 1 or 2 or 3

1

0 - Do not record the call (default)
1 - Record after transfer
2 - Record whole call
3 - Record up to transfer

Determines if the call will be recorded or not.

play_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

always_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.

caller_audio

No

String

n/a

Link to an audio file in your account to be used as caller whisper audio

Determines the audio file to be used as caller whisper audio

recipient_audio

No

String

n/a

Link to an audio file in your account to be used as recipient whisper audio

Determines the audio file to be used as recipient whisper audio

ga_referrer

No

String

100

UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributed

Determines the UTM Referrer used with DialogTech's integration into Google Universal Analytics integration

ga_content

No

String

100

UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributed

Determines the UTM Content used with DialogTech's integration into Google Universal Analytics integration

ga_campaign

No

String

100

UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributed

Determines the UTM Campaign used with DialogTech's integration into Google Universal Analytics integration

ga_term

No

String

100

UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributed

Determines the UTM Term used with DialogTech's integration into Google Universal Analytics integration

ga_medium

No

String

100

UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributed

Determines the UTM Medium used with DialogTech's integration into Google Universal Analytics integration

Using this API

Example Response

<response>
	<result>success</result>
	<result_description>Phone number updated successfully</result_description>
</response>