Paging Group

The Paging Group object is supported by the MiRTA PBX OpenAPI endpoint. This object is tenant-scoped. Tenant API keys must include 
tenant=CANISTRACCI; writes require a writable API key.
Object Summary
Property
Value
Object
paginggroup
Primary path
/paginggroups
ID field
pa_id
Label field
pa_name
Primary source table
pa_paginggroups
Required on create
pa_name, 
pa_number
Path aliases
/paging, 
/pagings, 
/paginggroup, 
/paginggroups, 
/intercom, 
/intercoms
Endpoint Patterns
Action
Example pattern
List
GET https://pbx.example.com/pbx/openapi.php/paginggroups?tenant=CANISTRACCI
Get by ID
GET https://pbx.example.com/pbx/openapi.php/paginggroups/OBJECT_ID?tenant=CANISTRACCI
Create
POST https://pbx.example.com/pbx/openapi.php/paginggroups?tenant=CANISTRACCI
Update
PATCH https://pbx.example.com/pbx/openapi.php/paginggroups/OBJECT_ID?tenant=CANISTRACCI
Delete
DELETE https://pbx.example.com/pbx/openapi.php/paginggroups/OBJECT_ID?tenant=CANISTRACCI
Accepted Field Aliases
Request field
Source field
name
pa_name
number
pa_number
pin
pa_pin
bidirectional
pa_bidirectional
checkinuse
pa_checkinuse
mediafile_id
pa_me_id
manualheader
pa_manualheader
Destination Fields
Destination fields accept one destination string or an array of destination strings such as 
EXT-100, 
VOICEMAIL-100, or another supported destination type and ID pair.
Destination type
Accepted aliases
PAGING
extensions, 
peers, 
members, 
destination
Examples
List Paging Groups
Returns the paging groups visible to the key and scope.
curl -H "X-API-Key: TENANT_API_KEY" \
  "https://pbx.example.com/pbx/openapi.php/paginggroups?tenant=CANISTRACCI"
Get Paging Group
Reads one object by its internal ID.
curl -H "X-API-Key: TENANT_API_KEY" \
  "https://pbx.example.com/pbx/openapi.php/paginggroups/OBJECT_ID?tenant=CANISTRACCI"
Create Paging Group
Creates a new object. Use the short aliases shown above or the source field names.
curl -X POST \
  -H "X-API-Key: TENANT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Docs API Paging Group",
  "number": "830",
  "pin": "1234",
  "bidirectional": "no"
}' \
  "https://pbx.example.com/pbx/openapi.php/paginggroups?tenant=CANISTRACCI"
Edit Paging Group
Updates only the supplied fields.
curl -X PATCH \
  -H "X-API-Key: TENANT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "bidirectional": "yes"
}' \
  "https://pbx.example.com/pbx/openapi.php/paginggroups/OBJECT_ID?tenant=CANISTRACCI"
Delete Paging Group
Deletes the object. Check references before deleting configuration used by routing or reporting.
curl -X DELETE \
  -H "X-API-Key: TENANT_API_KEY" \
  "https://pbx.example.com/pbx/openapi.php/paginggroups/OBJECT_ID?tenant=CANISTRACCI"
Paging Group Destination
Updates the 
PAGING destination. The same value can also be sent inside a 
destinations object.
curl -X PATCH \
  -H "X-API-Key: TENANT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "extensions": [
    100,
    101
  ]
}' \
  "https://pbx.example.com/pbx/openapi.php/paginggroups/OBJECT_ID?tenant=CANISTRACCI"
Common Errors
Error
Meaning
missing_api_key
No API key was supplied in the query string, 
X-API-Key, or bearer token.
invalid_api_key
The supplied key does not match the tenant or global API key.
tenant_required
A tenant code is required for tenant-scoped writes or tenant-key reads.
read_only_api_key
The key can read data but cannot create, update, or delete objects.
missing_required_field
A required create field is missing.