API & DOCS

My Account            

Use the Conference Calls API to launch conference calls.

128

The Conference Calls API allows the user to launch conference calls. This API allows the user to schedule outbound calls to conference call attendees, if the user would rather not wait for all attendees to dial in. In addition to scheduling conference calls, the Conference Call API allows the user to add, remove, and mute attendees. The user also has the option of viewing the list of all scheduled conference calls, within a desired period of time.

The user may utilize the Find Me Call Forwarding API with the Add Attendee, Call Attendee, Attendee Details, Kick Attendee, Attendee List, Mute Attendee, Remove Attendee, Un-Mute Attendee, Details, List, Remove, and Schedule methods.

Add Attendee

conference.attendee.add

Use the Add Attendee method to add one or more attendees to an existing Smart Conference Form.

📘

Please Note

If the conference call is already in progress, the Conference Smart Form will make outbound calls to new attendees and add them to the conference call.

The parameters listed in the following table may be needed to complete this action:

PARAMETERREQUIREDOPTIONAL
API KeyX
Attendee ListX
ImmediateX
InvitationsX
User Conference Attendee IDX

Call Attendee

conference.attendee.call

Use the Call Attendee method to add one or more call participants to a conference call.

📘

Please Note

The scheduled conference is programmed to call the phone number the attendee used to reach the call (in the past?).

The parameters listed in the following table may be needed to complete this action:

PARAMETERREQUIREDOPTIONAL
API KeyX
User Conference IDX
User Conference Attendee IDX
User Conference Participation IDX

Attendee Details

conference.attendee.details

Use the Attendee Details to obtain conference call, participation details for a specific attendee.

The parameters listed in the following table may be needed to complete this action:

PARAMETERREQUIREDOPTIONAL
API KeyX
User Conference IDX
User Conference Attendee IDX

Kick Attendee

conference.attendee.kick

Use the Kick Attendee method to kick a user (?) off of a conference call.

The parameters listed in the following table may be needed to complete this action:

PARAMETERREQUIREDOPTIONAL
API KeyX
User Conference IDX
User NumberX

Attendee List

conference.attendee.list

Use the Attendee List method to obtain a list of attendees scheduled for a conference call.

The parameters listed in the following table may be needed to complete this action:

PARAMETERREQUIREDOPTIONAL
API KeyX
User Conference IDX

Mute Attendee

conference.attendee.mute

Use the Mute Attendees method to mute a conference call participant.

The parameters listed in the following table may be needed to complete this action:

PARAMETERREQUIREDOPTIONA
API KeyX
User Conference IDX
User NumberX

Remove Attendee

conference.attendee.remove

Use the Remove Attendees method to delete one or more attendees from a scheduled conference call.

The parameters listed in the following table may be needed to complete this action:

PARAMETERREQUIREDOPTIONAL
API KeyX
User Conference IDX
User Conference Attendee IDX

Un-mute Attendee

conference.attendee.unmute

Use the Un-Mute Attendee to un-mute a muted conference participant.

The parameters listed in the following table may be needed to complete this action:

PARAMETERREQUIREDOPTIONAL
API KeyX
User Conference IDX
User NumberX

Details

conference.details

Use the Details method to obtain the details for a specific conference call.

The parameters listed in the following table may be needed to complete this action:

PARAMETERREQUIREDOPTIONAL
API KeyX
User Conference IDX

List

conference.list

Use the List method to list all scheduled and completed conference calls.

The parameters listed in the following table may be needed to complete this action:

PARAMETERREQUIREDOPTIONAL
API KeyX

Remove

conference.remove

Use the Remove method to delete an inactive conference call.

The parameters listed in the following table may be needed to complete this action:

PARAMETERREQUIREDOPTIONAL
API KeyX
User Conference IDX

Schedule

conference.schedule

Use the Schedule method to schedule a conference call.

The parameters listed in the following table may be needed to complete this action:

PARAMETERREQUIREDOPTIONAL
API KeyX
Attendee ListX
Conference LengthX
Conference NameX
DescX
Inbound OnlyX
InvitationsX
PinX
Scheduled TimeX

API Test Panel

48

Use the DialogTech API Wizard and Test Panel to make changes to a customer account.

Please note that this tool works with the live data in a customer account. The user must be careful when adding, editing, or deleting data.

Example URLs

32
Add Attendee Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.attendee.add&usr_conference_id=3731&attendee_list=7737648727%7CRose%20Tyler%7Crtyler%40example.com&immediate=1&invitations=1
Call Attendee Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.attendee.call&usr_conference_id=3731&usr_conference_attendee_id=12181&usr_conference_participation_id=8921
Attendee Details Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.attendee.list&usr_conference_id=3731&usr_conference_attendee_id=12181
Kick Attendee Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.attendee.unmute&usr_conference_id=3731&user_number=28971
Attendee List Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.attendee.list&usr_conference_id=3731
Mute Attendee Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.attendee.mute&usr_conference_id=3731&user_number=28971
Remove Attendee Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.attendee.remove&usr_conference_id=3731&usr_conference_attendee_id=12181
Un-Mute Attendee Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.attendee.unmute&usr_conference_id=3731&user_number=28971
Details Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.schedule&usr_conference_id=3731
List Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.list
Remove Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.remove&usr_conference_id=3691
Schedule Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.schedule&conference_name=Conference%20%2317&scheduled_time=2008-11-18%2014%3A18%3A00%20-0600&conference_length=10&inboundonly=1&invitations=1&attendee_list=7735551212%7CJohn%20Smith%7Cjsmith%40example.com%7C%7C7735552222%7CMary%20Cellphone

Example Responses

32
Add Attendee 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>[email protected]</email_address>
</attendee>
</response>
Call Attendee Example Response:

<response>
<result>success</result>
<result_description>Smart Conference participant call successfully performed</result_description>
<result_action>call</result_action>
<usr_conference_id>3731</usr_conference_id>
<usr_conference_attendee_id>12181</usr_conference_attendee_id>
<usr_conference_participation_id>8921</usr_conference_participation_id>
</response>
Attendee Details Example Response:

<response>
<result>success</result>
<result_description>Smart Conference attendee details successfully generated</result_description>
<usr_conference_attendee_id>12181</usr_conference_attendee_id>
<attendee_name>Harriet Jones</attendee_name>
<phone_number>773551212</phone_number>
<email_address>[email protected]</email_address>
<participation>
<usr_conference_participation_id>8921</usr_conference_participation_id
<sid>0811188727015299</sid>
<caller_id>7735559999</caller_id>
<status>2</status>
<user_number/>
<muted>0</muted>
<active_minutes>10</active_minutes>
<elapsed_minutes>12.2</elapsed_minutes>
</participation>
</response>
Kick Attendee Example Response:

<response>
<result>success</result>
<result_description>Smart Conference participant kick successfully performed</result_description>
<result_action>kick</result_action>
<usr_conference_id>3731</usr_conference_id>
<user_number>999</user_number>
</response>
Attendee List Example Response:

<response>
<result>success</result>
<result_description>Smart Conference attendee list successfully generated
<attendee>
<usr_conference_attendee_id>11911</usr_conference_attendee_id>
<attendee_name>Rose Tyler</attendee_name>
<phone_number>7735552222</phone_number>
<email_address/>
<participation>
<usr_conference_participation_id/>
<sid/>
<caller_id/>
<status>0</status>
<user_number/>
<muted>0</muted>
<active_minutes>0</active_minutes>
<elapsed_minutes/>
</participation>
</attendee>
<attendee>
<usr_conference_attendee_id>12181</usr_conference_attendee_id>
<attendee_name>Harriet Jones</attendee_name>
<phone_number>7735551212</phone_number>
<email_address>[email protected]</email_address>
<participation>
<usr_conference_participation_id>8921</usr_conference_participation_id
<sid>0811188727015299</sid>
<caller_id>7735559999</caller_id>
<status>1</status>
<user_number/>
<muted>0</muted>
<active_minutes>10</active_minutes>
<elapsed_minutes>12.2</elapsed_minutes>
</participation>
</attendee>
</response>
Mute Attendee Example Response:

<response>
<result>success</result>
<result_description>Smart Conference participant mute successfully performed</result_description>
<result_action>mute</result_action>
<usr_conference_id>3731</usr_conference_id>
<user_number>28971</user_number>
</response>
Remove Attendee Example Response:

<response>
<result>success</result>
<result_description>Successfully removed 1 attendee(s) from the Smart Conference</result_description>
<usr_conference_id>3731</usr_conference_id>
<attendees_removed>1</attendees_removed>
</response>
Un-Mute Attendee Example Response:

<response>
<result>success</result>
<result_description>Smart Conference participant unmute successfully performed</result_description>
<result_action>unmute</result_action>
<usr_conference_id>3731</usr_conference_id>
<user_number>28971</user_number>
</response>
Details Example Response:

<response>
<result>success</result>
<result_description/>
<usr_conference_id>3731</usr_conference_id>
<conference_name>Smart Conference 11-17-2008</conference_name>
<scheduled_time>2008-11-18 15:20:00 -0600</scheduled_time>
<conference_length>10</conference_length>
<pin/>
<allow_overrun>1</allow_overrun>
<status>0</status>
<attendees>2</attendees>
<participants>0</participants>
<sys_conference_server_id>2</sys_conference_server_id>
<dnis>8003415801</dnis>
</response>
List Example Response:

<response>
<result>success</result>
<result_description>
</result_description>
<conference>
<usr_conference_id>370</usr_conference_id>
<conference_name>Demo Conference</conference_name>
<scheduled_time>2009-06-13 17:30:00 -0500</scheduled_time>
<conference_length>60</conference_length>
<pin>1234</pin>
<allow_overrun>1</allow_overrun>
<status>0</status>
<attendees>3</attendees>
<participants>0</participants>
<sys_conference_server_id>1</sys_conference_server_id>
<dnis>8475551234</dnis>
</conference>
</response>
Remove Example Response:

<response>
<result>success</result>
<result_description>The conference was successfully removed</result_description>
<usr_conference_id>112</usr_conference_id>
</response>
Schedule Example Response:

<response>
<result>success</result>
<result_description>
Successfully scheduled the Smart Conference with 2 out of 2 valid attendee(s)
</result_description>
<usr_conference_id>3651</usr_conference_id>
<conference_name>
Conference #17
</conference_name>
<scheduled_time>2008-11-18 14:20:00 -0600</scheduled_time>
<conference_length>10</conference_length>
<pin/>
<allow_overrun>1</allow_overrun>
<status>1</status>
<attendees_added>2</attendees_added>
<sys_conference_server_id>2</sys_conference_server_id>
<dnis>8005551212</dnis>
</response>