Skip to main content
Conferences let you connect multiple participants in a single call. Using the Conference API, you can manage ongoing conferences, control individual members, and record conversations. Conferences are suited for traditional “meeting” use cases. For advanced contact center or sales dialer scenarios requiring more control, consider Multiparty Calls.

The Conference Object

conference_name
string
Name used to identify the conference.
conference_run_time
string
Time in seconds since the conference was initiated.
conference_member_count
string
Number of members currently active in the conference.
members
array
Array of member objects in the conference.

Member Attributes

Each member in the members array has the following attributes:
member_id
string
Unique ID of the member within the conference.
muted
boolean
true if the member is currently muted.
deaf
boolean
true if the member cannot hear conference audio.
from
string
Source of the call — PSTN number or SIP endpoint.
to
string
Conference bridge number — Plivo number or application URL.
caller_name
string
Name of the caller (SIP calls only).
direction
string
Direction of the call — inbound or outbound.
call_uuid
string
Unique identifier of the call.
join_time
string
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

conference_name
string
Name used to identify the conference.
conference_run_time
string
Time in seconds since the conference was initiated.
conference_member_count
string
Number of members currently active in the conference.
members
array
Array of member objects in the conference — see Member Attributes.
api_id
string
Unique identifier for the API request.

List All Conferences

Retrieve names of all ongoing conferences in your account.

Arguments

No arguments required.

Response

api_id
string
Unique identifier for the API request.
conferences
array
Array of names of all ongoing conferences in your account.

Hang Up a Conference

Terminate a conference and disconnect all members.

Response

message
string
Status of the request. Returns conference hung up on a successful request.
api_id
string
Unique identifier for the API request.

Hang Up All Conferences

Terminate all ongoing conferences in your account.

Response

message
string
Status of the request. Returns all conferences hung up on a successful request.
api_id
string
Unique identifier for the API request.

Member Operations

Control individual members within a conference. The member_id parameter can be:
  • A specific member ID (e.g., 10)
  • A comma-separated list (e.g., 10,11,12)
  • The string all to affect all members

Kick a Member

Disconnect a member from the conference.

Response

message
string
Status of the request. Returns kicked on a successful request.
member_id
string
Unique ID of the member within the conference.
api_id
string
Unique identifier for the API request.

Mute / Unmute a Member

Mute a member so other participants cannot hear them.

Response

message
string
Status of the request. Returns muted on a successful request.
member_id
string
Unique ID of the member within the conference.
api_id
string
Unique identifier for the API request.

Deaf / Undeaf a Member

Make a member deaf so they cannot hear conference audio.

Response

message
string
Status of the request. Returns deaf on a successful request.
member_id
string
Unique ID of the member within the conference.
api_id
string
Unique identifier for the API request.

Play Audio to a Member

Play an audio file to specific members.

Response

message
string
Status of the request. Returns play queued into conference on a successful request.
api_id
string
Unique identifier for the API request.
member_id
string
Unique ID of the member within the conference.

Speak Text to a Member

Speak text to specific members using text-to-speech.

Response

message
string
Status of the request. Returns speak queued into conference on a successful request.
api_id
string
Unique identifier for the API request.
member_id
string
Unique ID of the member within the conference.

Record a Conference

Start recording an ongoing conference.

Arguments

Response

api_id
string
Unique identifier for the API request.
message
string
Status of the request. Returns conference recording started on a successful request.
recording_id
string
Recording ID associated with the file.
url
string
URL where the recorded file can be accessed.