Overview

Sample Code

Web Hooks

IVR Web Hook SurVo NetGet Custom Audio Prompts Post Call Action Agent Panel Lookup Distributor Form

Call Initiation API

Click-to-Call Click-to-Find Me Click-to-Find Me List Click-to-Virtual Receptionist Click-to-Voice Mail Click-to-SurVo Click-to-IVR Click-to-Agent

Administration API

addonsbroadcastclicktoconferencecostfindmegeneralgrouplocatornumbersrecordingregisterednumbersreportroutingsmssurvoverifymenowvmail

routing.configure

Set up routing for a phone number

Arguments

access_key (required)
Your Access Key.
secret_access_key (required)
Your Secret Access Key.
phone_number (required)
The phone number we're configuring
routing_type (required)
Type of routing to route the number to. Valid types: findme, transfer, transfer_w_whisper, survo, locator, broadcast_from_phone, call_distributor, phone_directory, vmail
parameter1 (required)
Parameter for the selected routing type (see notes below)
description (optional)
Set the phone label description for this number.
record_call (optional)
Turn call recording on or off. Values are 0 for off and 1 for on, default is 0 (off).
recording_warning (optional)
This determines whether to play the "This call may be recorded for quality purposes" message to the caller, recipent, both or neither. Valid values are:
  • 0 - Both caller and recipient (default)
  • 1 - Caller only
  • 2 - Recipient only
  • 3 - None
When using the call recording features users must understand and comply with all applicable laws which govern recording or surveillance of electronic communications, eavesdropping, and the like. Failure to follow these laws may lead to civil or even criminal liability.
reverse_lookup (optional)
Perform a reverse lookup on incoming calls to attempt to find the inbound caller?s name, street address, city, state, and zip code. Additional charges may apply.
play_ring (optional)
Recommended for whole-call recording. Values are 0 for off, 1 for on, default is 0 (off).
parameter2 (optional)
Parameter 2 for the selected routing type (see notes below)
parameter3 (optional)
Parameter 3 for the selected routing type (see notes below)
parameter4 (optional)
Parameter 4 for the selected routing type (see notes below)

Notes

Routing TypeParameters
findme

1 - Building Block ID of Find Me (required)

2 - Prompt to read to caller using TTS (optional)

3 - Whisper phrase (optional)

transfer_w_whisper

1 - Transfer To Number (required)

2 - Prompt to read to caller using TTS (optional)

3 - Whisper Phrase spoken using TTS (optional)

4 - Record Call (optional). Values: 0=recording off, 1=recording on. Default is 0, recording off.

survo

1 - Building Block ID of SurVo (required)

2 - Prompt to read to caller using TTS (optional)

transfer

1 - Phone number to transfer to (required)

2 - Prompt to read to caller using TTS (optional)

locator

1 - Building Block ID of Store Locator (required)
voting

1 - Building Block ID of Polling Event (required)
vmail

1 - Building Block ID of Voice Mail Box (required)

2 - Prompt to read to caller using TTS (optional)
broadcast_from_phone

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

phone_directory

1 - Building Block ID of the Phone Directory (required)

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

Example URL

https://secure.ifbyphone.com/ibp_api.php
?access_key=ACCESS_KEY
&secret_access_key=SECRET_ACCESS_KEY
&action=routing.configure
&phone_number=8772955100
&routing_type=survo
¶meter1=1234
¶meter2=Please%20hold

Example Response

<response>

<result>success</result>

<result_description>phone number routed successfully</result_description>

</response>

API Test Panel

NOTE: The API Test Panel can be used to try out the various API methods
using the actual data from your account. You must be logged
into your account to make any API calls using the test panel.

 

URL:

XML Result: