API
Reference guide for the legacy ProxyAPI and the newer OpenAPI JSON endpoint, including authentication, object scope, request patterns, examples, and error handling.
OpenAPI
OpenAPI JSON endpoint reference and examples.
Overview and Examples
The MiRTA PBX OpenAPI endpoint exposes configuration and reporting APIs as an OpenAPI 3.0.3 JSON ...
Extension State
The Extension State endpoint returns live call-state information for one extension. It is a read-...
Auth Token
The Auth Token endpoint generates or resets temporary login tokens for web users and extension we...
Dial
The Dial endpoint originates a call between a source extension and a destination number. It is th...
CDR
The CDR endpoint is a read-only reporting endpoint. It supports GET only; create, update, and de...
Simple CDR
The Simple CDR endpoint is a read-only reporting endpoint. It supports GET only; create, update,...
Extension
The Extension object is supported by the MiRTA PBX OpenAPI endpoint. This object is tenant-scoped...
Tenant
The Tenant object is supported by the MiRTA PBX OpenAPI endpoint. This object is managed at syste...
User
The User object is supported by the MiRTA PBX OpenAPI endpoint. This object is managed at system ...
User Profile
The User Profile object is supported by the MiRTA PBX OpenAPI endpoint. This object is managed at...
Routing Profile
The Routing Profile object is supported by the MiRTA PBX OpenAPI endpoint. This object is managed...
Provider
The Provider object is supported by the MiRTA PBX OpenAPI endpoint. This object is managed at sys...
Voicemail
The Voicemail object is supported by the MiRTA PBX OpenAPI endpoint. This object is tenant-scoped...
IVR
The IVR object is supported by the MiRTA PBX OpenAPI endpoint. This object is tenant-scoped. Tena...
Custom Destination
The Custom Destination object is supported by the MiRTA PBX OpenAPI endpoint. This object is norm...
Condition
The Condition object is supported by the MiRTA PBX OpenAPI endpoint. This object is tenant-scoped...
Hunt List
The Hunt List object is supported by the MiRTA PBX OpenAPI endpoint. This object is tenant-scoped...
DID
The DID object is supported by the MiRTA PBX OpenAPI endpoint. This object is tenant-scoped. Tena...
Queue
The Queue object is supported by the MiRTA PBX OpenAPI endpoint. This object is tenant-scoped. Te...
Setting
The Setting object is supported by the MiRTA PBX OpenAPI endpoint. This object is normally tenant...
Media File
The Media File object is supported by the MiRTA PBX OpenAPI endpoint. This object is normally ten...
Music On Hold
The Music On Hold object is supported by the MiRTA PBX OpenAPI endpoint. This object is normally ...
Paging Group
The Paging Group object is supported by the MiRTA PBX OpenAPI endpoint. This object is tenant-sco...
Conference Room
The Conference Room object is supported by the MiRTA PBX OpenAPI endpoint. This object is tenant-...
Flow
The Flow object is supported by the MiRTA PBX OpenAPI endpoint. This object is tenant-scoped. Ten...
Tenant Variable
The Tenant Variable object is supported by the MiRTA PBX OpenAPI endpoint. This object is tenant-...
DISA
The DISA object is supported by the MiRTA PBX OpenAPI endpoint. This object is tenant-scoped. Ten...
Caller ID Blacklist
The Caller ID Blacklist object is supported by the MiRTA PBX OpenAPI endpoint. This object is nor...
Campaign
The Campaign object is supported by the MiRTA PBX OpenAPI endpoint. This object is tenant-scoped....
Campaign Number
The Campaign Number object is supported by the MiRTA PBX OpenAPI endpoint. This object is tenant-...
Cron Job
The Cron Job object is supported by the MiRTA PBX OpenAPI endpoint. This object is normally tenan...
Feature Code
The Feature Code object is supported by the MiRTA PBX OpenAPI endpoint. This object is normally t...
Short Number
The Short Number object is supported by the MiRTA PBX OpenAPI endpoint. This object is normally t...
Phone Book
The Phone Book object is supported by the MiRTA PBX OpenAPI endpoint. This object is tenant-scope...
Phone Book Entry
The Phone Book Entry object is supported by the MiRTA PBX OpenAPI endpoint. This object is tenant...
Provisioning Phone
The Provisioning Phone object is supported by the MiRTA PBX OpenAPI endpoint. This object is tena...
AI Analysis
The AI Analysis endpoint returns transcript, AI summary, and sentimental analysis data for record...