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

Configure advanced options such as reverse look up and call recording

Arguments

access_key (required)
Your Access Key.
secret_access_key (required)
Your Secret Access Key.
phone_number (required)
The phone number to update advanced options for
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.
record_call (optional)
Enable advanced call record feautures such as 'Record up to transfer', 'Record after transfer', and 'Record whole call'. Values are 0 for no recording, 1 for 'Record after transfer', 2 for 'Record whole call', 3 for 'Record up to transfer'.
play_warning (optional)
Enable call record warning notifications for the recipient, the caller, both parties, or none. Values are 0 for both caller and recipient, 1 for the caller, 2 for the recipient, and 3 for none.
caller_audio (optional)
Provide a filename saved in your Call Recording Warning Audio directory to play for the caller.
recipient_audio (optional)
Provide a filename saved in your Call Recording Warning Audio directory to play for the recipient.
always_ring (optional)
Enable this feature to play a ring tone to the caller before they connect to an application. Values are 0 for off and 1 for on. The default is 0.
ga_referrer (optional)
Provide a value for Google Analytics referrer. Example: Google, Bing, Yahoo, etc.
ga_content (optional)
Provide a value for Content for Google Analytics
ga_campaign (optional)
Provide a value for a Campaing name for Google Analytics
ga_term (optional)
Provide a value for a keyword associated with your number for Google Analytics
ga_medium (optional)
Provide a value for a medium associated with your number. Example: banner add, newspaper, PPC link. etc.

Example URL

https://secure.ifbyphone.com/ibp_api.php
?access_key=ACCESS_KEY
&secret_access_key=SECRET_ACCESS_KEY
&action=routing.advanced
&phone_number=2249355999
&reverse_lookup=1
&record_call=1
&play_warning=1
&caller_audio=callerwarning.wav
&recipient_audio=recipientwarning.wav
&always_ring=1
&ga_referrer=google
&ga_content=marketing_apps
&ga_campaign=IVR
&ga_term=virtual office
&ga_medium=PPC

Example Response

<response>

<result>success</result>

<result_description>phone number updated 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: