CALLFLOW.INSTANCE.CONFERENCE.ACTION

CALLFLOW.INSTANCE.CONFERENCE.ACTION - API REQUEST

CALLFLOW.INSTANCE.CONFERENCE.ACTION - real-time control over conference call participants.

Description

CALLFLOW.INSTANCE.CONFERENCE.ACTION API Action is used to MUTE,UNMUTE or KICK conference call participant.

Arguments

CALLFLOW.INSTANCE.KEY
Required. CALLFLOW INSTANCE KEY of a call flow. CALLFLOW.INSTANCE.KEY can be obtained using HTTP Callback when a new Call Flow instance is created. Simply configure START call flow control and enter On Start URL to a script on your server and include $[CALLFLOW.INSTANCE.KEY]$ in the URL Query String.

CONFERENCE.NUMBER
Required. Conference number as it is configured in the Call Flow.

E164
Required. A phone number of the conference call participant. Hint: You can use HTTP Call Control right before 'Join Conf.' control and submit $[E64] and $[CALLFLOW.INSTANCE.KEY]$ call flow variables to your web server.

CONFERENCE.ACTION
Required. Conference call action to be executed for a given participant. It can be MUTE,UNMUTE or KICK.

Example:
<PARAMETER NAME="CALLFLOW.INSTANCE.KEY">12312345</PARAMETER>
<PARAMETER NAME="CONFERENCE.NUMBER">1122</PARAMETER>
<PARAMETER NAME="E164">12157010680</PARAMETER>
<PARAMETER NAME="CONFERENCE.ACTION">mute</PARAMETER>

Response

RESULT will be SUCCESS when API Action is received and processed.

API Request Example

<?xml version="1.0" standalone="no" ?>
<REQUEST>
  <USERTOKEN>
    <USERKEY>df141891e2e883904b0b294dc5bq79c1c1c13f6d</USERKEY>
  </USERTOKEN>
  <ACTION NAME="CALLFOW.INSTANCE.CONFERENCE.ACTION">
  	<PARAMETER NAME="CALLFLOW.INSTANCE.KEY">1231232</PARAMETER>
	<PARAMETER NAME="CONFERENCE.NUMBER">1122</PARAMETER>
	<PARAMETER NAME="E164">12157010680</PARAMETER>
	<PARAMETER NAME="CONFERENCE.ACTION">kick</PARAMETER>
  </ACTION>
</REQUEST>

Response Example

<?xml version="1.0" standalone="no" ?>
<RESPONSE>
  <RESULT>SUCCESS</RESULT>
</RESPONSE>