/v1/Account/{auth_id}. Operations marked in Asks first wait for your yes. See Approvals.
Voice calls
Calls, live and queued calls, conferences, multiparty calls, endpoints and recordings. 45 operations, 25 ask first.| Operation | Call | What it does | Asks first |
|---|---|---|---|
| List All Calls | GET /Call/ | Retrieve details of all completed calls. | — |
| List All Live Calls | GET /Call/?status=live | Retrieve IDs of all ongoing calls. | — |
| List All Queued Calls | GET /Call/?status=queued | Retrieve IDs of all queued calls. | — |
| Create a Call | POST /Call/ | Initiate an outbound call to a PSTN number or SIP endpoint. | costs money |
| Retrieve a Call | GET /Call/{call_uuid}/ | Get the call detail record (CDR) of a specific call. | — |
| Retrieve a Live Call | GET /Call/{call_uuid}/?status=live | Get details of a specific ongoing call. | — |
| Transfer a Call | POST /Call/{call_uuid}/ | Transfer an in-progress call to fetch and execute XML from a different URL. | moves a call |
| Hang Up a Call | DELETE /Call/{call_uuid}/ | Hang up an ongoing call or cancel a queued outbound call. | permanent |
| Send DTMF | POST /Call/{call_uuid}/DTMF/ | Send DTMF digits on an active call. | — |
| Start Playing | POST /Call/{call_uuid}/Play/ | Play an audio file during an active call. | costs money |
| Stop Playing | DELETE /Call/{call_uuid}/Play/ | Stop playing audio during an active call. | permanent |
| Start Recording | POST /Call/{call_uuid}/Record/ | Start recording an active call. | costs money |
| Stop Recording | DELETE /Call/{call_uuid}/Record/ | Stop active recordings on a call. | permanent |
| Start Speaking | POST /Call/{call_uuid}/Speak/ | Speak text during an active call using text-to-speech. | costs money |
| Stop Speaking | DELETE /Call/{call_uuid}/Speak/ | Stop active text-to-speech during a call. | permanent |
| List All Conferences | GET /Conference/ | Retrieve names of all ongoing conferences in your account. | — |
| Retrieve a Conference | GET /Conference/{conference_name}/ | Get details of a specific conference by name. | — |
| Hang Up a Conference | DELETE /Conference/{conference_name}/ | Terminate a conference and disconnect all members. | permanent |
| Deaf | POST /Conference/{conference_name}/Member/{member_id}/Deaf/ | Make a member deaf so they cannot hear conference audio. | — |
| Undeaf | DELETE /Conference/{conference_name}/Member/{member_id}/Deaf/ | Restore hearing to a deaf member. | permanent |
| Kick a Member | POST /Conference/{conference_name}/Member/{member_id}/Kick/ | Disconnect a member from the conference. | — |
| Mute | POST /Conference/{conference_name}/Member/{member_id}/Mute/ | Mute a member so other participants cannot hear them. | — |
| Unmute | DELETE /Conference/{conference_name}/Member/{member_id}/Mute/ | Unmute a previously muted member. | permanent |
| Start Playing | POST /Conference/{conference_name}/Member/{member_id}/Play/ | Play an audio file to specific members. | costs money |
| Stop Playing | DELETE /Conference/{conference_name}/Member/{member_id}/Play/ | Stop playing audio to members. | permanent |
| Start Speaking | POST /Conference/{conference_name}/Member/{member_id}/Speak/ | Speak text to specific members using text-to-speech. | costs money |
| Stop Speaking | DELETE /Conference/{conference_name}/Member/{member_id}/Speak/ | Stop speaking text to members. | permanent |
| Start Recording | POST /Conference/{conference_name}/Record/ | Start recording an ongoing conference. | costs money |
| Stop Recording | DELETE /Conference/{conference_name}/Record/ | Stop recording a conference. | permanent |
| List All Endpoints | GET /Endpoint/ | Retrieve all endpoints in your account. | — |
| Create an Endpoint | POST /Endpoint/ | Create a new SIP endpoint. | keeps access |
| Retrieve an Endpoint | GET /Endpoint/{endpoint_id}/ | Get details of a specific endpoint. | — |
| Update an Endpoint | POST /Endpoint/{endpoint_id}/ | Update an endpoint’s password, alias, or attached application. | keeps access |
| Delete an Endpoint | DELETE /Endpoint/{endpoint_id}/ | Permanently delete an endpoint. | permanent |
| List All Multiparty Calls | GET /MultiPartyCall/ | Retrieve all multiparty calls with optional filters. | — |
| Retrieve a Multiparty Call | GET /MultiPartyCall/name_{mpc_name}/ | Get details of a specific multiparty call. | — |
| End a Multiparty Call | DELETE /MultiPartyCall/name_{mpc_name}/ | Terminate an ongoing MPC. | permanent |
| List All Participants | GET /MultiPartyCall/name_{mpc_name}/Participant/ | Retrieve all participants in a multiparty call. | — |
| Add a Participant | POST /MultiPartyCall/name_{mpc_name}/Participant/ | Add a participant to an existing MPC or start a new MPC. | costs money |
| Update a Participant | POST /MultiPartyCall/name_{mpc_name}/Participant/{member_id}/ | Mute, unmute, hold, or unhold a participant. | — |
| Kick a Participant | DELETE /MultiPartyCall/name_{mpc_name}/Participant/{member_id}/ | Remove a participant from the MPC. | permanent |
| Retrieve a Multiparty Call | GET /MultiPartyCall/uuid_{mpc_uuid}/ | Get details of a specific multiparty call. | — |
| List All Recordings | GET /Recording/ | Retrieve all recordings in your account with optional filters. | — |
| Retrieve a Recording | GET /Recording/{recording_id}/ | Get details of a specific recording by its ID. | — |
| Delete a Recording | DELETE /Recording/{recording_id}/ | Permanently delete a recording from your account. | permanent |
SIP trunking
Trunks, credentials, IP access lists, origination URIs and trunk calls. 23 operations, 12 ask first.| Operation | Call | What it does | Asks first |
|---|---|---|---|
| List All Calls | GET /Zentrunk/Call/ | Retrieve CDRs for all calls with optional filtering. | — |
| Retrieve a Call | GET /Zentrunk/Call/{call_uuid}/ | Get the call detail record (CDR) for a specific call. | — |
| Retrieve Call Insights | GET /Zentrunk/Call/{call_uuid}/Insights/ | Get quality metrics for a specific call. | — |
| List All Credentials | GET /Zentrunk/Credential/ | Get all credentials for your account. | — |
| Create Credentials | POST /Zentrunk/Credential/ | Create a new credential set for SIP digest authentication. | keeps access |
| Retrieve Credentials | GET /Zentrunk/Credential/{credential_uuid}/ | Get details of specific credentials. | — |
| Update Credentials | POST /Zentrunk/Credential/{credential_uuid}/ | Modify an existing credential’s name, username, or password. | keeps access |
| Delete Credentials | DELETE /Zentrunk/Credential/{credential_uuid}/ | Permanently delete credentials. | permanent |
| List All IP Access Control Lists | GET /Zentrunk/IPAccessControlList/ | Get all IP ACLs for your account. | — |
| Create an IP Access Control List | POST /Zentrunk/IPAccessControlList/ | Create a new IP whitelist for SIP trunk authentication. | keeps access |
| Retrieve an IP Access Control List | GET /Zentrunk/IPAccessControlList/{ipacl_uuid}/ | Get details of a specific IP ACL. | — |
| Update an IP Access Control List | POST /Zentrunk/IPAccessControlList/{ipacl_uuid}/ | Modify an existing IP ACL’s name or IP addresses. | keeps access |
| Delete an IP Access Control List | DELETE /Zentrunk/IPAccessControlList/{ipacl_uuid}/ | Permanently delete an IP ACL. | permanent |
| List All Trunks | GET /Zentrunk/Trunk/ | Get all trunks with optional filtering. | — |
| Create a Trunk | POST /Zentrunk/Trunk/ | Create a new SIP trunk for inbound or outbound traffic. | keeps access |
| Retrieve a Trunk | GET /Zentrunk/Trunk/{trunk_id}/ | Get details of a specific trunk. | — |
| Update a Trunk | POST /Zentrunk/Trunk/{trunk_id}/ | Modify an existing trunk’s properties. | keeps access |
| Delete a Trunk | DELETE /Zentrunk/Trunk/{trunk_id}/ | Permanently delete a trunk. | permanent |
| List All Origination URIs | GET /Zentrunk/URI/ | Get all origination URIs for your account. | — |
| Create an Origination URI | POST /Zentrunk/URI/ | Create a new destination endpoint for inbound calls. | reroutes |
| Retrieve an Origination URI | GET /Zentrunk/URI/{uri_uuid}/ | Get details of a specific origination URI. | — |
| Update an Origination URI | POST /Zentrunk/URI/{uri_uuid}/ | Modify an existing origination URI’s properties. | reroutes |
| Delete an Origination URI | DELETE /Zentrunk/URI/{uri_uuid}/ | Permanently delete an origination URI. | permanent |
Messaging
Messages, Powerpacks, 10DLC brands and campaigns, and toll-free verification. 22 operations, 8 ask first.| Operation | Call | What it does | Asks first |
|---|---|---|---|
| List All Brands | GET /10dlc/Brand/ | This API lets you fetch all the brands associated with an account. | — |
| Register a Standard Brand | POST /10dlc/Brand/ | This API lets you register a standard brand using a preexisting profile. | costs money |
| Retrieve a Brand | GET /10dlc/Brand/{brand_id}/ | This API lets you fetch details about a specific brand associated with your account. | — |
| List All Campaigns | GET /10dlc/Campaign/ | This API lets you fetch all the campaigns associated with an account. | — |
| Register a Campaign | POST /10dlc/Campaign/ | This API lets you register a campaign using a preexisting brand. | costs money |
| Retrieve a Campaign | GET /10dlc/Campaign/{campaign_id}/ | This API lets you fetch details about a specific campaign associated with your account. | — |
| Update a Campaign | POST /10dlc/Campaign/{campaign_id}/ | Update a 10DLC campaign from your account. | costs money |
| Retrieve All Numbers Linked to a Campaign | GET /10dlc/Campaign/{campaign_id}/Number/ | Fetch all numbers linked to a particular campaign. | — |
| Link Number to Campaign | POST /10dlc/Campaign/{campaign_id}/Number/ | Link one or more phone numbers to an existing campaign. | — |
| Retrieve Number Status | GET /10dlc/Campaign/{campaign_id}/Number/{number}/ | Fetch the status of a specific number linked to a campaign. | — |
| Unlink Number from Campaign | DELETE /10dlc/Campaign/{campaign_id}/Number/{number}/ | Unlink a phone number from a campaign. | permanent |
| List All Messages | GET /Message/ | Retrieve a list of message records with optional filters. | — |
| Send a Message | POST /Message/ | Send an SMS, MMS, or WhatsApp message to one or more recipients. | costs money |
| Retrieve a Message | GET /Message/{message_uuid}/ | Get details of a specific message by its UUID. | — |
| List All Powerpacks | GET /Powerpack/ | Fetches a list of all Powerpacks in your account. | — |
| Create a Powerpack | POST /Powerpack/ | Create a new Powerpack for intelligent number pooling and traffic distribution. | reroutes |
| Retrieve a Powerpack | GET /Powerpack/{powerpack_uuid}/ | Retrieves the details of a specific Powerpack. | — |
| Update a Powerpack | POST /Powerpack/{powerpack_uuid}/ | Update a Powerpack’s name, sticky_sender, local_connect, or the application connected to it. | reroutes |
| Delete a Powerpack | DELETE /Powerpack/{powerpack_uuid}/ | Deletes a single Powerpack. | permanent |
| List All Verification Requests | GET /TollfreeVerification/ | Get the status of all toll-free verification requests for your account. | — |
| Create a Verification Request | POST /TollfreeVerification/ | Create a new toll-free verification request. | — |
| Retrieve a Verification Request | GET /TollfreeVerification/{uuid}/ | Get details of a specific toll-free verification request. | — |
Phone numbers and compliance
Search, buy, update and release numbers, and compliance applications. 12 operations, 4 ask first.| Operation | Call | What it does | Asks first |
|---|---|---|---|
| List Account Phone Numbers | GET /Number/ | Returns all phone numbers in your account. | — |
| Get an Account Phone Number | GET /Number/{number}/ | Retrieve details of a specific phone number. | — |
| Update an Account Phone Number | POST /Number/{number}/ | Change the application, subaccount, or alias for a phone number. | reroutes |
| Unrent a Number | DELETE /Number/{number}/ | Remove a phone number from your account. | permanent |
| Search Phone Numbers | GET /PhoneNumber/ | Returns available phone numbers matching your criteria. | — |
| List Compliance Applications | GET /PhoneNumber/Compliance/ | Returns a paginated list of compliance applications for the account. | — |
| Bulk Link Numbers to Compliance | POST /PhoneNumber/Compliance/Link/ | Link multiple phone numbers to their respective compliance applications in a single request. | — |
| Get Requirements | GET /PhoneNumber/Compliance/Requirements/ | Query compliance requirements before creating a compliance record. | — |
| Get a Compliance Application | GET /PhoneNumber/Compliance/{compliance_id}/ | Retrieve details of a specific compliance application. | — |
| Update a Compliance Application | PATCH /PhoneNumber/Compliance/{compliance_id}/ | Update a rejected compliance application and automatically resubmit it for review. | — |
| Delete a Compliance Application | DELETE /PhoneNumber/Compliance/{compliance_id}/ | Soft-delete a compliance application. | permanent |
| Buy a Phone Number | POST /PhoneNumber/{number}/ | Purchase a phone number and add it to your account. | costs money |
AI agents
Voice, chat and message agents, their runs, and the node types they are built from. 12 operations, 6 ask first.| Operation | Call | What it does | Asks first |
|---|---|---|---|
| List Agents | GET /AgentFlow/ | List the AI agents (voice, chat and message agent flows) on this account. | — |
| Create an Agent | POST /AgentFlow/ | Create an AI agent flow: a graph of typed nodes wired together with connections. It starts as a DRAFT and handles no traffic until published. If the name is taken, the server appends ” 1”, ” 2” and so on, and returns the stored name. | creates an agent |
| Retrieve an Agent | GET /AgentFlow/{agent_id}/ | Get an agent flow’s full definition: fields, state, nodes and connections. Secret values in node configs come back as ***REDACTED***. | — |
| Update an Agent | POST /AgentFlow/{agent_id}/ | Rename an agent flow (name alone), or replace its whole graph (nodes and connections together). description with name but no graph is rejected (400). nodes is a full replacement: to remove nodes, leave them out and set allow_node_deletion; no connection may still point at a removed node. ***REDACTED*** sent back from Retrieve an Agent keeps the stored secret. | changes an agent |
| Delete an Agent | DELETE /AgentFlow/{agent_id}/ | Permanently delete an agent flow. | permanent |
| Pause an Agent | POST /AgentFlow/{agent_id}/Pause/ | Pause an ACTIVE agent flow so it stops handling traffic. | stops an agent |
| Publish an Agent | POST /AgentFlow/{agent_id}/Publish/ | Publish an agent flow, moving it from DRAFT to ACTIVE so it starts handling traffic. | puts an agent live |
| Resume an Agent | POST /AgentFlow/{agent_id}/Resume/ | Resume a PAUSED agent flow, returning it to ACTIVE. | puts an agent live |
| List Agent Runs | GET /AgentFlow/{agent_id}/Run/ | List the runs (executions) of an agent flow. | — |
| Retrieve an Agent Run | GET /AgentFlow/{agent_id}/Run/{run_id}/ | Get one run of an agent flow: status, logs and goal metrics. | — |
| List Agent Node Types | GET /AgentFlowNode/ | List the node types available for building an agent flow’s graph. | — |
| Retrieve an Agent Node Type | GET /AgentFlowNode/{node_type}/ | Get the JSON Schema a node type’s config must match, before wiring it into a flow with Create an Agent or Update an Agent. x-plivo-coverage lists server-side rules (conditional requirements, secret references) the schema cannot express. | — |
Account and applications
Account details and usage, and the applications that handle calls and messages. 8 operations, 3 ask first.| Operation | Call | What it does | Asks first |
|---|---|---|---|
| Retrieve Account Details | GET / | Retrieves the details of your account. | — |
| Update Account Details | POST / | Updates the Account object. | — |
| List All Applications | GET /Application/ | Returns all applications sorted by creation date. | — |
| Create an Application | POST /Application/ | Creates a new application. | reroutes |
| Retrieve an Application | GET /Application/{app_id}/ | Get details of a specific application. | — |
| Update an Application | POST /Application/{app_id}/ | Modify an existing application. | reroutes |
| Delete an Application | DELETE /Application/{app_id}/ | Permanently deletes an application. | permanent |
| Retrieve Usage Summary | GET /UsageSummary/ | Retrieves a paginated usage summary for the requested window. | — |
Audio Streaming
Stream a live call’s audio to a voice agent over WebSocket. 5 operations, 3 ask first.| Operation | Call | What it does | Asks first |
|---|---|---|---|
| List All Audio Streams | GET /Call/{call_uuid}/Stream/ | Get all audio streams for a call. | — |
| Start an Audio Stream | POST /Call/{call_uuid}/Stream/ | Initiate streaming for an active call. | costs money |
| Stop All Audio Streams | DELETE /Call/{call_uuid}/Stream/ | Stop all active streams on a call. | permanent |
| Retrieve an Audio Stream | GET /Call/{call_uuid}/Stream/{stream_id}/ | Get details of a specific audio stream. | — |
| Stop a Specific Audio Stream | DELETE /Call/{call_uuid}/Stream/{stream_id}/ | Stop streaming for a specific stream. | permanent |
Number masking
Masking sessions that hide both parties’ real numbers. 4 operations, 2 ask first.| Operation | Call | What it does | Asks first |
|---|---|---|---|
| List All Sessions | GET /Masking/Session/ | Fetch details of all existing masking sessions. | — |
| Create a Session | POST /Masking/Session/ | Create a number masking session using the real phone numbers of two parties. | costs money |
| Retrieve a Session | GET /Masking/Session/{session_uuid}/ | Fetch details of an existing masking session. | — |
| Expire a Session | DELETE /Masking/Session/{session_uuid}/ | Terminate an ongoing session and mark it as expired. | permanent |
Verify
One-time-code verification sessions. 4 operations, 1 ask first.| Operation | Call | What it does | Asks first |
|---|---|---|---|
| List All Sessions | GET /Verify/Session/ | Retrieve a list of sessions based on filter criteria over the last 90 days. | — |
| Create a Session | POST /Verify/Session/ | Send an OTP via SMS or voice. | costs money |
| Retrieve a Session | GET /Verify/Session/{session_uuid}/ | Get details of a specific session. | — |
| Validate a Session | POST /Verify/Session/{session_uuid}/ | Validate the OTP entered by the user. | — |