For AI agents: visit https://pbx.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

Home Guides API Reference

v1.0

Guides API Reference

API Reference

v1.0Home Guides API Reference

Getting Started

Getting an Access Token
Rate Limiting

Subscriber

Subscriber Overview
Read Subscriberpost
Create Subscriberpost
Update Subscriberpost
Delete Subscriberpost
Count Subscribers on a domainpost
List Subscribers on a domainpost

Device

User Device Overview
Read User Devicepost
Create User Devicepost
Update User Devicepost
Delete User Devicepost
Count Devices for a Domain/Userpost
List supported device modelspost

Phone

Create Phonepost
Read Phonepost
Resync Phonepost
Update Phonepost
Count Phonespost
Delete Phonepost

Domains

Create a domainpost
Count Domainspost
Read Domainpost
Update Domainpost
Delete Domainpost
Read billable summary for a Domainpost

Answering Rules

Answering Rule Overview
Read Answering Rulepost
Create Answering Rulepost
Update Answering Rulepost
Delete Answering Rulepost
Reorder Answering Rulespost

Time Frames

Create a Time Framepost
Create a Time Range for a Time Framepost

Conference Bridges

Conference Bridge Overview
Create Conference Bridgepost
Update Conference Bridgepost
Disconnect Participantspost
Read Conference Bridgepost

Call

Create Callpost
Read Active Callspost
Count Callspost
Report Active Callspost
Answer Active Callpost
Disconnect Active Callpost
Place orig/tem end on Holdpost
Unhold a Callpost
Enable Recording of an Active Callpost
Disable Recording of an Active Callpost
Pause Recording of an Active Callpost
Resume Recording of an Active Callpost
Reject Incoming Callpost
Transfer an Active Callpost

Subscriptions

Overview
Read Subscriptionspost
Create Agent Subscriptionpost
Create Audit Log Subscriptionpost
Create Call Subscriptionpost
Create Presence Subscriptionpost
Create Call Recording Subscriptionpost
Create CDR Subscriptionspost
Delete Subscriptionpost

Call ID Emergency

Read Emergency Numbers for a Domainpost

CDR

Read CDRspost

Voicemail

Read Voicemailpost
Delete Voicemailpost
Upload Greetingpost

Phone Number

Read Phone Numberpost
Create Phone Numberpost
Update Phone Numberpost

Recordings

Read Recordingpost
Get Call Recording Settingget
Enable Call Recording Settingpost
Disable Call Recording Settingdel

Agent

Create Agentpost
Read Agents in a Call Queuepost
Count Agents in a Call Queuepost
Make Agent Availablepost
Make Agent Available Single Callpost
Make Agent Unavailablepost
Delete Agent from a Call Queuepost

Sip Trunks

Create a Sip Trunkpost
Count Sip Trunkspost
Read Sip Trunkspost
Update Sip Trunkpost
Delete Sip Trunkpost

Powered by

Subscriptions

Overview

Event Model Overiew

Updated about 1 year ago

Transfer an Active Call

Read Subscriptions

Did this page help you?

Updated about 1 year ago

Transfer an Active Call

Read Subscriptions

Did this page help you?