API & DOCS

My Account            

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

ParameterRequiredAcceptsMax LengthNotesUsage
actionYesString: routing.configuren/aOnly accepts routing.configure to set up routing for a phone numberDefines the API Call as "Number Configuration - Basic" type
access_keyYesStringn/aAccess Key from the Key Manager within a DialogTech accountCredentials used for access to the API for a particular DialogTech account
secret_access_keyYesStringn/aSecret Access Key from the Key Manager within a DialogTech accountCredentials used for access to the API for a particular DialogTech account
phone_numberYesUnformatted Phone Numbern/a
routing_typeYesfindme or transfer or transfer_w_whisper or survo or locator or broadcast_from_phone or call_distributor or vmailn/afindme - 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.
parameter1YesSee Routing Parameter Listn/aSee Routing Parameter ListSee aSee Routing Parameter ListParameter List
parameter2NoSee Routing Parameter Listn/aSee Routing Parameter ListSee Routing Parameter List
parameter3NoSee Routing Parameter Listn/aSee Routing Parameter ListSee Routing Parameter List
parameter4NoSee Routing Parameter Listn/aSee Routing Parameter ListSee Routing Parameter List
descriptionNoStringn/aPhone Label assigned to a phone numberDefines the label assigned to the phone_number provided
record_callNo0 or 110 - Do not record the call (default)
1 - Record the call
Determines if the call will be recorded or not.
recording_warningNo0 or 1 or 2 or 310 - 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_lookupNo0 or 110 - 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_ringNo0 or 110 - 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 TypeParameter Usage
findmeparameter1 - 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_whisperparameter1 - 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
survoparameter1 - Building Block ID of the SurVo/IVR (required)
parameter2 - Prompt to read to the caller using TTS (optional)
transferparameter1 - Transfer To Number (required)
parameter2 - Prompt to read to the caller using TTS (optional)
locatorparameter1 - Building Block ID of the Store Locator (required)
virtual_receptionistparameter1 - Building Block ID of the Virtual Receptionist (required)
vmailparameter1 - Building Block ID of Voicemail Box (required)
parameter2 - Prompt to read to the caller using TTS (optional)
broadcast_from_phoneparameter1 - 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>