Overview

Sample Code

• Call Detail Report
• Web Hook Listener
• Click-To-IVR Broadcast
• Download Recording

Web Hooks

IVR Web Hook

• Introduction
• Setting up the IVR Web Hook
• IVR Web Hook Action
• Method
• Target URL
• Call Generated Parameters
• SourceTrak Data
• Responses to Web hook
• User Parameters
• Passthrough Data
• Transcription Post Back

SurVo NetGet

• Introduction
• Setting up the NetGet
• NetGet Action
• Submit Type
• Domain
• Page
• Static Parameters
• Dynamic Parameters
• SourceTrak Data
• Responses to NetGet
• User Parameters
• Passthrough Data
• Transcription Post Back

Custom Audio Prompts

• IVR
• Survo Classic

Post Call Action

• Introduction
• Setting up a PCA
• Dynamic Parameters
• SourceTrak Data
• Include LeadFlow Information
• Configuring Phone Number Post Call Action Settings

Agent Panel Lookup

• Introduction
• Setting up Agent Panel Web Hook
• Dynamic Parameters
• SourceTrak Data
• Agent Experience

Distributor Form

• Introduction
• Setting up Distributor Forms Web Hook
• Question Parameter Names
• Agent Experience

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

• Client Side Requests
• Client Side Response
• Server Side Requests
• Server Side Response

Click-to-IVR

• Client Side Requests
• Client Side Response
• Server Side Requests
• Server Side Response

Click-to-Agent

Administration API

addons

• list
• purchase

broadcast

• create
• get_optout
• history
• optout
• schedule
• status
• stop

clickto

• agent

conference

• attendee.add
• attendee.call
• attendee.details
• attendee.kick
• attendee.list
• attendee.mute
• attendee.remove
• attendee.unmute
• details
• list
• remove
• schedule

cost

• get_surcharge

findme

• add_number
• create
• delete
• delete_number
• delete_recorded_call
• empty
• get_findme_list
• get_phone_list
• get_recorded_calls_list
• update_list_settings

general

• buildingblockids

group

• create
• details
• empty
• list
• memberadd
• memberremove
• remove
• rename

locator

• location.add
• location.details
• location.list
• location.remove
• location.update

numbers

• order
• remove
• search

recording

• download
• list
• remove
• upload

registerednumbers

• add
• list
• remove

report

• broadcast
• call_detail
• call_detail_csv
• clickto
• survo

routing

• advanced
• configure
• numbers
• update_label

sms

• delete_message
• get_message
• get_messages
• get_numbers
• register_number
• send_message
• unregister_number

survo

• delete_survey_results
• get_recording

verifymenow

• get_recording
• verify

vmail

• createbox
• deletebox
• deletemessage
• getmessagebyid
• getmessagebysid
• getmessages
• recordgreeting

Click-to-Agent

The Click-To-Agent API lets you connect a specific Call Distributor Agent to a recipient. This API call is useful for outbound dialing with or without recording.

Arguments

queue_id (required)

The specific call distributor to dial the agent in. You can find this in your browser URL while on the configuration screen of a specific call distributor. Look for the value after “?usr_queue_id=”.

agent_id (required)

The agent schedule ID to be invoked into controlled recipient calling. Agent Ids are available within the Call Distributor agent configuration of your account.

access_key (required)

Access key

secret_access_key (required)

The Secret Access key is used to validate the Access Key.

phone_to_call (required)

The recipient the requested agent should be connected to.

first_callerid (optional)

Caller ID agent sees.

second_callerid (optional)

Caller ID the recipient sees.

record (optional)

0 for off, 1 for on to dictate call recording, defaults to value configured for agent_id

warning (optional)

Set recorded call warning type. 0 -- don't play warning to either party. 1 -- play warning to both parties (default). 2 -- play warning to just agent. 3 -- play warning to just call recipient

Server Side Example Request URL

Here's a sample click-to-call between a registered number and another number:

https://secure.ifbyphone.com/ibp_api.php
?action=clickto.agent
&queue_id=12345
&agent_id=67890
&access_key=ACCESS_KEY
&secret_access_key=SECRET_ACCESS_KEY
&phone_to_call=8475551212
&first_callerid=8475551212
&second_callerid=8475550000
&record=1
&warning=0

The server will call agent 67890 using Call Distributor 12345, and then call the recipient number 847.555.1212.

Agent Mode and requirements for use:

The "OUTBOUND" mode within Call Distributor is available to handle these calls, set automatically for the agent upon full validation of the combination of URL parameters.

An API request for this will only succeed if the agent is in one of the following modes: OPEN, OUTBOUND, BUSY (WORK)

A test panel is available here for this method Click-to-Agent Test Panel

Server Side Response (XML)