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

conference.attendee.add

Add one or more attendees to an existing Smart Conference Form. If the conference call is already in progress, the Conference Smart Form can make outbound calls to the new attendees to add them to the conference call.

Arguments

access_key (required)
Your Access Key.
secret_access_key (required)
Your Secret Access Key.
usr_conference_id (required)
Conference ID to add attendee(s) to.
attendee_list (required)
A double bar-delimited list of bar-delimited attendees in these formats: 1112223333|Attendee Name|x@x.com OR 2223334444|Attendee Name, or a CSV file that is no more than 512KB with required "attendee_name" and "phone_number" columns plus optional "email_address" column. Possibilities for CSV can come from either an HTTP POST upload, or a fully-qualified HTTP(S)/FTP(S) URL.
invitations (optional)
If specified (value is irrelevant), all conference attendees with valid e-mail addresses will receive an e-mail invitation containing information about their participation.
immediate (optional)
If specified (value is irrelevant), the newly added conference attendees will be called immediately.

Example URL

https://secure.ifbyphone.com/ibp_api.php
?access_key=ACCESS_KEY
&secret_access_key=SECRET_ACCESS_KEY
&action=conference.attendee.add
&usr_conference_id=3731
&attendee_list=7737648727%7CRose%20Tyler%7Crtyler%40example.com
&immediate=1
&invitations=1

Example Response

<response>

<result/>

<result_description>Successfully added 1 out of 1 valid attendee(s) to the Smart Conference</result_description>

<usr_conference_id>3731</usr_conference_id>

<attendees_added>1</attendees_added>

<attendee>

<usr_conference_attendee_id>12181</usr_conference_attendee_id>

<attendee_name>Rose Tyler</attendee_name>

<phone_number>7735552222</phone_number>

<email_address>rtyler@example.com</email_address>

</attendee>

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