OpenAPI

Overview

openapi.php is the JSON API endpoint based on the OpenAPI specification.

The API uses the existing API keys:

Full API key: APIKEY
Read-only API key: READONLYAPIKEY

Both global and tenant-level keys are supported.

The implemented API objects are extension, tenant, routingprofile, voicemail, condition, huntlist, did, queue, ivr, customdestination, setting, mediafile, conferenceroom, featurecode, shortnumber, and provisioningphone. They provide endpoints for listing, retrieving, creating, modifying, and deleting configuration records.

OpenAPI Specification

The OpenAPI specification is available from:

openapi.php
openapi.php?spec=1
openapi.php/openapi.json
openapi.php/swagger.json

The response is an OpenAPI 3.0.3 JSON document.

Authentication

The API key can be provided in any of these ways.

Query Parameter

openapi.php/extensions?tenant=TENANTCODE&key=APIKEY

X-API-Key: APIKEY

Bearer Token

Authorization: Bearer APIKEY

API Key Scope

Tenant API Key

When using a tenant-level API key, the tenant parameter is required.

openapi.php/extensions?tenant=TENANTCODE&key=TENANT_API_KEY

Global API Key

When using a global API key, tenant is optional.

If tenant is provided, only that tenant's records are returned.

If tenant is omitted, records from all tenants are returned for list and get requests.

openapi.php/extensions?key=GLOBAL_API_KEY

Some objects can be edited at global level by adding global=yes. This is supported for global settings, global custom destinations, global media files, global feature codes, and global short numbers.

openapi.php/featurecodes?global=yes&key=GLOBAL_API_KEY

List Extensions

Endpoint

GET openapi.php/extensions

Alternative compatibility format:

openapi.php?object=extension&action=list

Parameters

Name	Required	Description
`key`	Yes, unless using header authentication	Full or read-only API key
`tenant`	Required for tenant keys	Tenant code or tenant name

Example Request

curl "https://pbx.example.com/openapi.php/extensions?tenant=TENANTCODE&key=APIKEY"

Using header authentication:

curl \
  -H "X-API-Key: APIKEY" \
  "https://pbx.example.com/openapi.php/extensions?tenant=TENANTCODE"

Using bearer authentication:

curl \
  -H "Authorization: Bearer APIKEY" \
  "https://pbx.example.com/openapi.php/extensions?tenant=TENANTCODE"

Example Response

[
  {
    "id": 101,
    "number": "100",
    "name": "Reception",
    "tech": "PJSIP"
  },
  {
    "id": 102,
    "number": "101",
    "name": "Office",
    "tech": "SIP"
  }
]

Response Fields

Field	Type	Description
`id`	integer	Extension internal ID
`number`	string	Extension number
`name`	string	Extension display name
`tech`	string	Extension technology, for example `SIP`, `PJSIP`, `VIRTUAL`, or `CUSTOM`

Get Extension Information

This endpoint returns detailed information for one extension.

The extension can be selected by internal extension ID or by extension number.

When using the global full API key, the response also includes the extension password when a password exists for the extension technology.

Tenant API keys and read-only API keys do not return the extension password.

Endpoints

Get an extension by ID:

GET openapi.php/extension?id=EXTENSION_ID

Alternative path format:

GET openapi.php/extensions/EXTENSION_ID

Get an extension by number:

GET openapi.php/extension?number=EXTENSION_NUMBER

Alternative path format:

GET openapi.php/extensions/number/EXTENSION_NUMBER

Alternative compatibility format:

openapi.php?object=extension&action=info&id=EXTENSION_ID
openapi.php?object=extension&action=info&number=EXTENSION_NUMBER

Parameters

Name	Required	Description
`key`	Yes, unless using header authentication	Full or read-only API key
`tenant`	Required for tenant keys	Tenant code or tenant name
`id`	Required if `number` is not provided	Extension internal ID
`number`	Required if `id` is not provided	Extension number

Use either id or number, not both.

When using a global API key without the tenant parameter, selecting by extension number can match more than one tenant. In that case the request returns an error and the request should be repeated using the tenant parameter or the extension ID.

Example Requests

Get by ID:

curl "https://pbx.example.com/openapi.php/extension?id=101&tenant=TENANTCODE&key=APIKEY"

Get by number:

curl "https://pbx.example.com/openapi.php/extension?number=100&tenant=TENANTCODE&key=APIKEY"

Using header authentication:

curl \
  -H "X-API-Key: APIKEY" \
  "https://pbx.example.com/openapi.php/extension?number=100&tenant=TENANTCODE"

Example Response

The response includes all fields from the extension table, the normalized fields id, number, name, and tech, the current state when available, the technology username, technology-specific details, and related records.

Related records are returned in the related object. Depending on the extension configuration, this can include state information, registrations, PJSIP contacts, call groups, pickup groups, destinations, queue membership, allowed queue membership, user profile, routing profiles, client rate, caller ID regex, music on hold, parking lot, conditions, media files, and associated phones.

The me_data binary field from media files is not returned in this response.

{
  "ex_id": "101",
  "ex_te_id": "1",
  "ex_name": "Reception",
  "ex_number": "100",
  "ex_tech": "PJSIP",
  "ex_tech_id": "55",
  "tenant_code": "TENANTCODE",
  "tenant_name": "Tenant Name",
  "id": 101,
  "number": "100",
  "name": "Reception",
  "tech": "PJSIP",
  "username": "100",
  "state": "NOT_INUSE",
  "st_state": "NOT_INUSE",
  "tech_details": {
    "endpoint": {
      "id": "100",
      "tech_id": "55",
      "te_id": "1"
    },
    "aor": {
      "id": "100",
      "max_contacts": "99"
    },
    "auth": {
      "id": "100",
      "username": "100"
    }
  },
  "related": {
    "state": {
      "st_extension": "100",
      "st_state": "NOT_INUSE"
    },
    "callgroups": [],
    "pickupgroups": [],
    "destinations": [],
    "referenced_by_destinations": [],
    "queue_members": [],
    "allowed_queue_members": [],
    "userprofile": {
      "up_id": "3",
      "up_name": "Basic user panel"
    },
    "routing_profile": {
      "rp_id": "1",
      "rp_name": "Default"
    },
    "sms_routing_profile": false,
    "client_rate": false,
    "callerid_regex": false,
    "callerid_regex_rules": [],
    "music_on_hold": false,
    "parkinglot": false,
    "conditions": [],
    "mediafiles": [],
    "phones": []
  }
}

When the global full API key is used, the response can also include:

{
  "password": "extension_password"
}

Create Extension

This endpoint creates one extension. A full API key is required. Read-only API keys are rejected.

The request is checked against the installed license before the extension is created.

Endpoint

POST openapi.php/extensions

Alternative compatibility format:

POST openapi.php?object=extension&action=add
POST openapi.php?object=extension&action=create

Parameters

Name	Required	Description
`key`	Yes, unless using header authentication	Full API key
`tenant`	Yes	Tenant code or tenant name

Request Body

The body is JSON. The API accepts the extension table fields used by the web page, such as ex_number, ex_name, ex_tech, and the technology table fields for sipfriends, ps_endpoints, ps_aors, ps_auths, ce_customextensions, and ve_virtualextensions.

Short aliases are also accepted:

Alias	Field
`number`	`ex_number`
`name`	`ex_name`
`tech`	`ex_tech`
`password`	SIP `secret` or PJSIP auth `password`
`username`	Technology username
`sipusername`	Technology username, matching the web page field
`mailbox`	`ex_mailbox` and PJSIP `mailboxes`

Supported technologies are SIP, PJSIP, CUSTOM, and VIRTUAL. If tech is omitted, PJSIP is used.

Example Request

curl \
  -X POST \
  -H "Content-Type: application/json" \
  -H "X-API-Key: APIKEY" \
  -d '{"number":"100","name":"Reception","tech":"PJSIP","password":"secret-password"}' \
  "https://pbx.example.com/openapi.php/extensions?tenant=TENANTCODE"

Nested technology fields can also be supplied:

{
  "ex_number": "100",
  "ex_name": "Reception",
  "ex_tech": "PJSIP",
  "ps_aors": {
    "max_contacts": 99
  },
  "ps_endpoints": {
    "allow": "alaw:20;ulaw:20"
  },
  "ps_auths": {
    "password": "secret-password"
  }
}

Example Response

The response is the same detailed extension object returned by the get endpoint, with HTTP status 201.

Modify Extension

This endpoint modifies an existing extension. A full API key is required. Read-only API keys are rejected.

The extension can be selected by internal ID or extension number. Use either id or number, not both.

Endpoints

PUT openapi.php/extension?id=EXTENSION_ID
PATCH openapi.php/extension?id=EXTENSION_ID
PATCH openapi.php/extensions/EXTENSION_ID

Alternative compatibility format:

PUT openapi.php?object=extension&action=update&objectid=EXTENSION_ID
PATCH openapi.php?object=extension&action=modify&objectid=EXTENSION_ID

Request Body

The body is JSON and can contain the same table fields accepted by the create endpoint. Only fields included in the body are updated.

Changing the extension technology is not supported. To change technology, delete and recreate the extension.

Example Request

curl \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "X-API-Key: APIKEY" \
  -d '{"ex_name":"Reception Desk","ex_callgroup":"1,2","ex_pickupgroup":"1,2"}' \
  "https://pbx.example.com/openapi.php/extension?id=101&tenant=TENANTCODE"

Delete Extension

This endpoint deletes an extension and its related technology rows. A full API key is required. Read-only API keys are rejected.

Endpoints

DELETE openapi.php/extension?id=EXTENSION_ID
DELETE openapi.php/extensions/EXTENSION_ID

Alternative compatibility format:

DELETE openapi.php?object=extension&action=delete&objectid=EXTENSION_ID

Example Request

curl \
  -X DELETE \
  -H "X-API-Key: APIKEY" \
  "https://pbx.example.com/openapi.php/extension?id=101&tenant=TENANTCODE"

Example Response

{
  "deleted": true,
  "id": 101,
  "number": "100"
}

Additional Configuration Objects

The following objects use the same authentication and HTTP behavior as extensions.

Object	List Endpoint	Single Endpoint	ID Field	Main Table
`voicemail`	`GET openapi.php/voicemails`	`openapi.php/voicemail?id=ID`	`uniqueid`	`voicemail`
`tenant`	`GET openapi.php/tenants`	`openapi.php/tenant?id=ID`	`te_id`	`te_tenants`
`routingprofile`	`GET openapi.php/routingprofiles`	`openapi.php/routingprofile?id=ID`	`rp_id`	`rp_routingprofiles`
`condition`	`GET openapi.php/conditions`	`openapi.php/condition?id=ID`	`co_id`	`co_conditions`
`ivr`	`GET openapi.php/ivrs`	`openapi.php/ivr?id=ID`	`iv_id`	`iv_ivrs`
`customdestination`	`GET openapi.php/customdestinations`	`openapi.php/customdestination?id=ID`	`cu_id`	`cu_customs`
`huntlist`	`GET openapi.php/huntlists`	`openapi.php/huntlist?id=ID`	`hu_id`	`hu_huntlists`
`did`	`GET openapi.php/dids`	`openapi.php/did?id=ID`	`di_id`	`di_dids`
`queue`	`GET openapi.php/queues`	`openapi.php/queue?id=ID`	`qu_id`	`qu_queues`
`setting`	`GET openapi.php/settings`	`openapi.php/setting?id=ID`	`se_id`	`se_settings`
`mediafile`	`GET openapi.php/mediafiles`	`openapi.php/mediafile?id=ID`	`me_id`	`me_mediafiles`
`conferenceroom`	`GET openapi.php/conferencerooms`	`openapi.php/conferenceroom?id=ID`	`cr_id`	`cr_conferencerooms`
`featurecode`	`GET openapi.php/featurecodes`	`openapi.php/featurecode?id=ID`	`fe_id`	`fe_features`
`shortnumber`	`GET openapi.php/shortnumbers`	`openapi.php/shortnumber?id=ID`	`sn_id`	`sn_shortnumbers`
`provisioningphone`	`GET openapi.php/provisioningphones`	`openapi.php/provisioningphone?id=ID`	`ph_id`	`ph_phones`

Generic Endpoints

Use the plural path for list and create operations:

GET openapi.php/voicemails
POST openapi.php/voicemails
GET openapi.php/tenants
POST openapi.php/tenants
GET openapi.php/routingprofiles
POST openapi.php/routingprofiles
GET openapi.php/conditions
POST openapi.php/conditions
GET openapi.php/ivrs
POST openapi.php/ivrs
GET openapi.php/customdestinations
POST openapi.php/customdestinations
GET openapi.php/huntlists
POST openapi.php/huntlists
GET openapi.php/dids
POST openapi.php/dids
GET openapi.php/queues
POST openapi.php/queues
GET openapi.php/settings
POST openapi.php/settings
GET openapi.php/mediafiles
POST openapi.php/mediafiles
GET openapi.php/conferencerooms
POST openapi.php/conferencerooms
GET openapi.php/featurecodes
POST openapi.php/featurecodes
GET openapi.php/shortnumbers
POST openapi.php/shortnumbers
GET openapi.php/provisioningphones
POST openapi.php/provisioningphones

Use either the singular endpoint with an id parameter or the plural path with the ID:

GET openapi.php/voicemail?id=ID
PATCH openapi.php/voicemail?id=ID
DELETE openapi.php/voicemail?id=ID

GET openapi.php/voicemails/ID
PATCH openapi.php/voicemails/ID
DELETE openapi.php/voicemails/ID

The same pattern applies to all generic objects listed in the table above.

Alternative compatibility format:

openapi.php?object=voicemail&action=list
openapi.php?object=voicemail&action=info&id=ID
openapi.php?object=voicemail&action=create
openapi.php?object=voicemail&action=modify&id=ID
openapi.php?object=voicemail&action=delete&id=ID

Generic Request Body

The body is JSON. Fields can be supplied using the database column names used by the web pages.

Short aliases are supported where they are unambiguous:

Object	Alias	Field
`voicemail`	`number`	`mailbox`
`voicemail`	`name`	`fullname`
`tenant`	`name`	`te_name`
`tenant`	`code`	`te_code`
`routingprofile`	`name`	`rp_name`
`routingprofile`	`type`	`rp_type`
`condition`	`name`	`co_name`
`condition`	`type`	`co_type`
`ivr`	`name`	`iv_name`
`customdestination`	`name`	`cu_name`
`huntlist`	`name`	`hu_name`
`huntlist`	`number`	`hu_number`
`did`	`number`	`di_number`
`queue`	`name`	`qu_name`
`setting`	`code`	`se_code`
`setting`	`value`	`se_value`
`mediafile`	`name`	`me_name`
`mediafile`	`data_base64`	`me_data`
`conferenceroom`	`name`	`cr_name`
`conferenceroom`	`number`	`cr_number`
`featurecode`	`code`	`fe_code`
`shortnumber`	`number`	`sn_number`
`provisioningphone`	`name`	`ph_name`
`provisioningphone`	`mac`	`ph_mac`

Destinations

Objects that use destinations accept a destinations object. Each destination item can be either a string in TYPE-ID format or an object with type and id.

{
  "di_number": "390212345678",
  "di_comment": "Main number",
  "destinations": {
    "DID": ["EXT-101"],
    "DID-UNCONDITIONAL": [
      { "type": "VOICEMAIL", "id": 10 }
    ]
  }
}

Supported destination keys:

Object	Destination Keys
`voicemail`	`VOICEMAIL-OPERATOR`, `VOICEMAIL-FOLLOW`, `VOICEMAIL-BROADCAST`
`condition`	`CONDITION`, `NOTCONDITION`, and `CONDITION1` through `CONDITION20`
`ivr`	`IVR_1` through `IVR_9`, `IVR_0`, `IVR_STAR`, `IVR_SHARP`, `IVR_WRONG`, `IVR_TIMEOUT`, `IVR_HANGUP`, `IVR_FEATURE`, `IVR_EXTENSION`, `IVR_MEDIAFILE`, `IVR_OPTIONSMEDIAFILE`, and custom keys beginning with `CUSTOMIVR_`
`customdestination`	`PRIVACY-DONTCALL`, `PRIVACY-TORTURE`, `CTONANSWER`, `CALLBACK-CONNECTED`, `CTONCALLERHANGUP`, `SPLITCHANNELACTION-CALLER`, `SPLITCHANNELACTION-CALLED`, and `RANDOMDESTINATION` keys
`huntlist`	`HUNTLIST`, `HUNTLIST-TIMEOUT`
`did`	`DID`, `DID-UNCONDITIONAL`, `DID-SMS`, `DID-FAXSUCCESS`
`queue`	`QUEUE-FULL`, `QUEUE-TIMEOUT`, `QUEUE-EXITKEY`, `QUEUE-ONCALLBACK`, `QUEUE-NOBODYHOME`, `QUEUE-NOFREEMEMBER`, `QUEUE-PERIODICANNOUNCE`, `QUEUE-BEFORERINGING`, `QUEUE-ONAUTOPAUSE`, `QUEUE-ONABANDONEDCALL`
`featurecode`	`FEATURE`

Related Records

Get responses include a related object when the object has related configuration.

For conditions, related.extended_infos contains rows from ce_conditions_extended. Create and modify requests can replace these rows by sending extended_infos.

For queues, related.realtime contains the realtime queue row. Create and modify requests can send realtime queue fields either at the top level or nested under queue or realtime. Queue members can be replaced by sending members, queue_member, or queue_members. Allowed queue members can be replaced by sending allowed_members, aq_allowed_queue_member, or allowed_queue_members.

For hunt lists, create and modify requests update the matching follow-me records used by the dialplan.

For custom destinations, related.extended_infos contains rows from ce_customs_extended and related.binary_files lists stored binary records without returning the binary payload.

For conference rooms, related.meetme contains the linked realtime conference row. Creating a conference room also creates the linked meetme row, and deleting it removes that row.

For provisioning phones, related.button_layouts and related.phonebooks contain the linked phone layout and phonebook rows.

Examples

Create a voicemail:

curl \
  -X POST \
  -H "Content-Type: application/json" \
  -H "X-API-Key: APIKEY" \
  -d '{"mailbox":"200","fullname":"Sales","password":"1234","email":"sales@example.com"}' \
  "https://pbx.example.com/openapi.php/voicemails?tenant=TENANTCODE"

Modify a DID destination:

curl \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "X-API-Key: APIKEY" \
  -d '{"destinations":{"DID":["EXT-101"]}}' \
  "https://pbx.example.com/openapi.php/did?id=25&tenant=TENANTCODE"

Create a queue with realtime fields:

curl \
  -X POST \
  -H "Content-Type: application/json" \
  -H "X-API-Key: APIKEY" \
  -d '{"qu_name":"Support","qu_number":"700","queue":{"strategy":"ringall","timeout":20},"members":[{"membername":"100","interface":"Local/AG-000-NF-101@fromotherpbx/n","state_interface":"Custom:100","member_device":"100","penalty":0,"paused":0}]}' \
  "https://pbx.example.com/openapi.php/queues?tenant=TENANTCODE"

Create a global feature code:

curl \
  -X POST \
  -H "Content-Type: application/json" \
  -H "X-API-Key: GLOBAL_APIKEY" \
  -d '{"code":"*56","comment":"Pickup"}' \
  "https://pbx.example.com/openapi.php/featurecodes?global=yes"

Create a conference room:

curl \
  -X POST \
  -H "Content-Type: application/json" \
  -H "X-API-Key: APIKEY" \
  -d '{"name":"Weekly Meeting","number":"900","pin":"1234","adminpin":"4321","maxusers":10}' \
  "https://pbx.example.com/openapi.php/conferencerooms?tenant=TENANTCODE"

Change Logging

Create, modify, and delete operations write a process log entry and a user activity log entry using the OpenAPI user label. Related destination, condition, queue member, and queue realtime changes are also logged where applicable.

Additional Error Responses

Missing Identifier

{
  "error": {
    "code": "missing_identifier",
    "message": "Provide an extension id or number."
  }
}

Invalid Identifier

{
  "error": {
    "code": "invalid_identifier",
    "message": "Use either id or number, not both."
  }
}

Extension Not Found

{
  "error": {
    "code": "extension_not_found",
    "message": "Extension not found."
  }
}

Multiple Extensions Found

{
  "error": {
    "code": "multiple_extensions_found",
    "message": "Multiple extensions match the requested number. Use the tenant parameter or the extension id."
  }
}

Error Responses

Errors are returned as JSON.

Missing API Key

{
  "error": {
    "code": "missing_api_key",
    "message": "Missing API key."
  }
}

Invalid API Key

{
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid API key."
  }
}

Tenant Not Found

{
  "error": {
    "code": "tenant_not_found",
    "message": "Tenant not found."
  }
}

Endpoint Not Found

{
  "error": {
    "code": "not_found",
    "message": "Endpoint not found."
  }
}

Method Not Allowed

Supported methods are GET, POST, PUT, PATCH, and DELETE.

{
  "error": {
    "code": "method_not_allowed",
    "message": "Supported methods are GET, POST, PUT, PATCH and DELETE."
  }
}

Notes

Read-only API keys are allowed for list and get endpoints.
A full API key is required for create, modify, and delete endpoints.
Sensitive fields such as passwords, API keys, tokens, and media binary data are hidden unless the global full API key is used.
The endpoint does not create a web session.
Responses are always JSON.
CORS is enabled with Access-Control-Allow-Origin: *.
OPTIONS requests return HTTP 204 for browser preflight support.

OpenAPI

Overview

OpenAPI Specification

Authentication

Query Parameter

Header

Bearer Token

API Key Scope

Tenant API Key

Global API Key

List Extensions

Endpoint

Parameters

Example Request

Example Response

Response Fields

Get Extension Information

Endpoints

Parameters

Example Requests

Example Response

Create Extension

Endpoint

Parameters

Request Body

Example Request

Example Response

Modify Extension

Endpoints

Request Body

Example Request

Delete Extension

Endpoints

Example Request

Example Response

Additional Configuration Objects

Generic Endpoints

Generic Request Body

Destinations

Related Records

Examples

Change Logging

Additional Error Responses

Missing Identifier

Invalid Identifier

Extension Not Found

Multiple Extensions Found

Error Responses

Missing API Key

Invalid API Key

Tenant Not Found

Endpoint Not Found

Method Not Allowed

Notes

Navigation menu

Search