Voice

Calls and live-call streams are documented under Make and control calls; this page covers the rest of the Voice API.

Conferences

List active conferences, inspect them, hang them up, and manage members. Inspect and control live audio conferences

Command	What it does
`plivo voice conferences get`	Get conference details (members, run time)
`plivo voice conferences hangup`	End the entire conference (requires —yes)
`plivo voice conferences list`	List active conference names
`plivo voice conferences member`	Per-member actions inside a conference
`plivo voice conferences record`	Start recording a conference
`plivo voice conferences stop-record`	Stop the active recording on a conference
`plivo voice conferences member deaf`	Deafen a member (they can’t hear)
`plivo voice conferences member kick`	Kick a member from the conference (requires —yes)
`plivo voice conferences member mute`	Mute a member
`plivo voice conferences member play`	Play audio file(s) into a member’s channel
`plivo voice conferences member speak`	Speak TTS text to a member
`plivo voice conferences member stop-play`	Stop audio playback to a member
`plivo voice conferences member stop-speak`	Stop TTS playback to a member
`plivo voice conferences member undeaf`	Undeafen a member
`plivo voice conferences member unmute`	Unmute a member

plivo voice conferences get

Command:

plivo voice conferences get <conference_name>

plivo voice conferences hangup

Command:

plivo voice conferences hangup <conference_name>

plivo voice conferences list

Command:

plivo voice conferences list

plivo voice conferences member

Command:

plivo voice conferences member

plivo voice conferences record

Command:

plivo voice conferences record <conference_name> [flags]

Flags

--callback-url <string>: URL hit when recording finishes
--file-format <string>: mp3|wav (default “mp3”)
--time-limit <int>: max recording length in seconds (default 60)
--transcribe: request transcription

plivo voice conferences stop-record

Command:

plivo voice conferences stop-record <conference_name>

plivo voice conferences member deaf

Command:

plivo voice conferences member deaf <conference_name> <member_id>

plivo voice conferences member kick

Command:

plivo voice conferences member kick <conference_name> <member_id>

plivo voice conferences member mute

Command:

plivo voice conferences member mute <conference_name> <member_id>

plivo voice conferences member play

Command:

plivo voice conferences member play <conference_name> <member_id> [flags]

Flags

--length <int>: stop after N seconds
--loop: loop playback
--mix: mix with conference audio (default true)
--urls <string>: comma-separated audio file URLs (required)

plivo voice conferences member speak

Command:

plivo voice conferences member speak <conference_name> <member_id> [flags]

Flags

--language <string>: BCP-47 language code (default “en-US”)
--text <string>: TTS text (required)
--voice <string>: MAN|WOMAN (default “WOMAN”)

plivo voice conferences member stop-play

Command:

plivo voice conferences member stop-play <conference_name> <member_id>

plivo voice conferences member stop-speak

Command:

plivo voice conferences member stop-speak <conference_name> <member_id>

plivo voice conferences member undeaf

Command:

plivo voice conferences member undeaf <conference_name> <member_id>

plivo voice conferences member unmute

Command:

plivo voice conferences member unmute <conference_name> <member_id>

Multiparty calls

Create MultiPartyCall rooms, add or remove participants, and end rooms. Creating a room and dialling a participant spend money and require --yes. Multi-Party Calls (MPC): group voice rooms with dynamic participants

Command	What it does
`plivo voice multiparty create`	Create a multi-party call (spends money: requires —yes)
`plivo voice multiparty end`	End the MPC and hang up all participants (requires —yes)
`plivo voice multiparty get`	Get an MPC by uuid or friendly_name
`plivo voice multiparty list`	List multi-party calls
`plivo voice multiparty participant`	Per-participant actions inside an MPC
`plivo voice multiparty participant add`	Add a participant by dialing out (spends money: requires —yes)
`plivo voice multiparty participant hold`	Put a participant on hold
`plivo voice multiparty participant kick`	Remove a participant (requires —yes)
`plivo voice multiparty participant list`	List participants in an MPC
`plivo voice multiparty participant mute`	Mute a participant
`plivo voice multiparty participant unhold`	Take a participant off hold
`plivo voice multiparty participant unmute`	Unmute a participant

plivo voice multiparty create

Command:

plivo voice multiparty create [flags]

Flags

--max-participants <int>: cap on simultaneous participants
--name <string>: friendly_name for the MPC (required)
--record: auto-record the MPC

plivo voice multiparty end

Command:

plivo voice multiparty end <mpc_uuid_or_name>

plivo voice multiparty get

Command:

plivo voice multiparty get <mpc_uuid_or_name>

plivo voice multiparty list

Command:

plivo voice multiparty list [flags]

Flags

--limit <int>: results per page (default 20)
--offset <int>: pagination offset
--status <string>: filter by status: active|initialized|ended

plivo voice multiparty participant

Command:

plivo voice multiparty participant

plivo voice multiparty participant add

Command:

plivo voice multiparty participant add <mpc_uuid_or_name> [flags]

Flags

--from <string>: source number for the dial-out (required)
--role <string>: participant role: agent|supervisor|customer (default “agent”)
--to <string>: destination number to add (required)

plivo voice multiparty participant hold

Command:

plivo voice multiparty participant hold <mpc_uuid_or_name> <participant_id>

plivo voice multiparty participant kick

Command:

plivo voice multiparty participant kick <mpc_uuid_or_name> <participant_id>

plivo voice multiparty participant list

Command:

plivo voice multiparty participant list <mpc_uuid_or_name> [flags]

Flags

--limit <int>: results per page (default 20)
--offset <int>: pagination offset

plivo voice multiparty participant mute

Command:

plivo voice multiparty participant mute <mpc_uuid_or_name> <participant_id>

plivo voice multiparty participant unhold

Command:

plivo voice multiparty participant unhold <mpc_uuid_or_name> <participant_id>

plivo voice multiparty participant unmute

Command:

plivo voice multiparty participant unmute <mpc_uuid_or_name> <participant_id>

Recordings

List recordings (filter by call UUID, conference, or time range), fetch one, or delete one. List, fetch, and delete call/conference recordings

Command	What it does
`plivo voice recordings delete`	Delete a recording (requires —yes)
`plivo voice recordings get`	Get a recording by ID
`plivo voice recordings list`	List recordings

plivo voice recordings delete

Command:

plivo voice recordings delete <recording_id>

plivo voice recordings get

Command:

plivo voice recordings get <recording_id>

plivo voice recordings list

Command:

plivo voice recordings list [flags]

Flags

--call-uuid <string>: filter by call uuid
--conference-name <string>: filter by conference name
--from-time <string>: filter recordings after this ISO time
--limit <int>: results per page (default 20)
--offset <int>: pagination offset
--to-time <string>: filter recordings before this ISO time

SIP endpoints

Create, list, update, and delete SIP endpoints (credentials a softphone or PBX registers with). Manage SIP endpoints (registered SIP devices/usernames)

Command	What it does
`plivo voice endpoints create`	Create a SIP endpoint
`plivo voice endpoints delete`	Delete a SIP endpoint (requires —yes)
`plivo voice endpoints get`	Get an endpoint by ID
`plivo voice endpoints list`	List SIP endpoints
`plivo voice endpoints update`	Update a SIP endpoint

plivo voice endpoints create

Command:

plivo voice endpoints create [flags]

Flags

--alias <string>: human-friendly label
--app-id <string>: application to attach
--password <string>: SIP password (required)
--username <string>: SIP username (required)

plivo voice endpoints delete

Command:

plivo voice endpoints delete <endpoint_id>

plivo voice endpoints get

Command:

plivo voice endpoints get <endpoint_id>

plivo voice endpoints list

Command:

plivo voice endpoints list [flags]

Flags

--limit <int>: results per page (default 20)
--offset <int>: pagination offset

plivo voice endpoints update

Command:

plivo voice endpoints update <endpoint_id> [flags]

Flags

--alias <string>: new alias
--app-id <string>: new application id
--password <string>: new password

Getting started

Voice agents with Audio Streaming

Plivo APIs

Conferences

Multiparty calls

Recordings

SIP endpoints

​Conferences

​Multiparty calls

​Recordings

​SIP endpoints

Conferences

Multiparty calls

Recordings

SIP endpoints