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