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

findme.create

Create a Find Me Smart Form.

Arguments

access_key (required)
Your Access Key.
secret_access_key (required)
Your Secret Access Key.
name (required)
Name description for the findme
list_type (optional)
Specific type of findme. 1 for Individual Find Me (Default) 2 for Customer Service Hunt Group
loop_count (optional)
Number of times to loop the findme list. Default is 1
distribution_type (optional)
How calls reach list. Values: 1, randomize; 2, round robin. Default: traverse list sequentially.
record (optional)
Record the conversation after caller connects to one of the Find Me destinations. Values: 1, record; 0, do not record (default)
screen_method (optional)
Screen caller for information before attempting to connect caller. Values: 0=Record callers name (default), 1=Use value in whisper_phrase as TTS, 2=Use value in whisper_audio. The whisper_audio value must be a file name for an existing whisper message in your account.
screen_prompt (optional)
TTS Screening message. Default is our standard message.
dtmf_only (optional)
Requires person answering to use keypad to accept call. Values: 1, DTMF Only; 0, speech and DTMF (default)
holdmusic (optional)
Audio file to play to caller as caller waits for destination to answer. Audio file must be in the account "holdme" directory. Default: Our standard audio file.
holdrepeat (optional)
How often the hold message is played to the caller. Values: 0, only once per Find Me session; 1, only once between each attempt to connect to a destination; 2, repeat continuosly between each connection attempt (default)
timeout (optional)
Number of seconds to ring each destination before attempting next destination (or end action). Values: 10-60. Default is 30
whisper_phrase (optional)
Phrase spoken to person who answers phone, used when call screening is not enabled. Default: no phrase.
findme_action (optional)
Action to take if Find Me reaches end of list
findme_action_parameter (optional)
Building Block ID if required by End of List Action
advanced_audio_id (optional)
If you have already configured an Advanced Audio Prompt Set in another Find Me you can use that set ID here. Advanced Prompt sets are specific to the Find Me Type (Customer Service Hunt Group or Individual Find Me).
numbers (optional)
Phone numbers to add to the Find Me. Can either be a single number or a comma-separated list of numbers. Must be a numeric string without any punctuation. Examples: 8475551234 or 8475551234,3124328281
auto_accept (optional)
How and when to auto-accept the call. Valid values are 0-4:
0 - Disabled (default)
1 - Auto-accept on first answered call
2 - Auto-accept on the last number tried with screening
3 - Auto-accept on the last number tried without screening
simul (optional)
Number of calls to make simultaneously. Maximum is defined by your account type.
whisper_audio (optional)
The name of an audio file in your Whisper Phrase Audio files folder (See Utilities -> Audio File Maintenance).

Example URL

https://secure.ifbyphone.com/ibp_api.php
?access_key=ACCESS_KEY
&secret_access_key=SECRET_ACCESS_KEY
&action=findme.create
&name=api-created+find+me+%2312
&list_type=1
&loop_count=1
&record=27
&use_screen=0
&whisper_phrase=Who+knows+what+lives+in+the+hearts+of+men%3F

Example Response

<response>

<result>success</result>

<result_description></result_description>

<findme_id>3831</findme_id>

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