The Conference Object
Name used to identify the conference.
Time in seconds since the conference was initiated.
Number of members currently active in the conference.
Array of member objects in the conference.
Member Attributes
Each member in themembers array has the following attributes:
Unique ID of the member within the conference.
true if the member is currently muted.true if the member cannot hear conference audio.Source of the call — PSTN number or SIP endpoint.
Conference bridge number — Plivo number or application URL.
Name of the caller (SIP calls only).
Direction of the call —
inbound or outbound.Unique identifier of the call.
Time in seconds since the member joined.
Example Conference Object
Retrieve a Conference
Get details of a specific conference by name.Arguments
No arguments required.Response
Name used to identify the conference.
Time in seconds since the conference was initiated.
Number of members currently active in the conference.
Array of member objects in the conference — see Member Attributes.
Unique identifier for the API request.
List All Conferences
Retrieve names of all ongoing conferences in your account.Arguments
No arguments required.Response
Unique identifier for the API request.
Array of names of all ongoing conferences in your account.
Hang Up a Conference
Terminate a conference and disconnect all members.Response
Status of the request. Returns
conference hung up on a successful request.Unique identifier for the API request.
Hang Up All Conferences
Terminate all ongoing conferences in your account.Response
Status of the request. Returns
all conferences hung up on a successful request.Unique identifier for the API request.
Member Operations
Control individual members within a conference. Themember_id parameter can be:
- A specific member ID (e.g.,
10) - A comma-separated list (e.g.,
10,11,12) - The string
allto affect all members
Kick a Member
Disconnect a member from the conference.Response
Status of the request. Returns
kicked on a successful request.Unique ID of the member within the conference.
Unique identifier for the API request.
Mute / Unmute a Member
- Mute
- Unmute
Deaf / Undeaf a Member
- Deaf
- Undeaf
Play Audio to a Member
- Start Playing
- Stop Playing
Speak Text to a Member
- Start Speaking
- Stop Speaking
Record a Conference
- Start Recording
- Stop Recording
Start recording an ongoing conference.
Arguments
Callback URL parameters
Callback URL parameters
Response
Unique identifier for the API request.
Status of the request. Returns
conference recording started on a successful request.Recording ID associated with the file.
URL where the recorded file can be accessed.
Related
- Conference XML Element - Create conferences using XML
- Multiparty Calls - Advanced call control for contact centers
- Recordings - Manage conference recordings