Routing Profile

The Routing Profile object is supported by the MiRTA PBX OpenAPI endpoint. This object is managed at system scope and requires a global API key.

Object Summary

Property	Value
Object	routingprofile
Primary path	/routingprofiles
ID field	rp_id
Label field	rp_name
Primary source table	rp_routingprofiles
Required on create	rp_name
Path aliases	/routingprofiles, /routing_profiles, /routing_profile

Endpoint Patterns

Action	Example pattern
List	GET https://pbx.example.com/pbx/openapi.php/routingprofiles
Get by ID	GET https://pbx.example.com/pbx/openapi.php/routingprofiles/OBJECT_ID
Create	POST https://pbx.example.com/pbx/openapi.php/routingprofiles
Update	PATCH https://pbx.example.com/pbx/openapi.php/routingprofiles/OBJECT_ID
Delete	DELETE https://pbx.example.com/pbx/openapi.php/routingprofiles/OBJECT_ID

Accepted Field Aliases

Request field	Source field
name	rp_name
description	rp_description
type	rp_type

Examples

List Routing Profiles

Returns the routing profiles visible to the key and scope.

curl -H "X-API-Key: GLOBAL_API_KEY" \
  "https://pbx.example.com/pbx/openapi.php/routingprofiles"

Get Routing Profile

Reads one object by its internal ID.

curl -H "X-API-Key: GLOBAL_API_KEY" \
  "https://pbx.example.com/pbx/openapi.php/routingprofiles/OBJECT_ID"

Create Routing Profile

Creates a new object. Use the short aliases shown above or the source field names.

curl -X POST \
  -H "X-API-Key: GLOBAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Docs API Voice Routing",
  "description": "Documentation outbound routing",
  "type": "VOICE"
}' \
  "https://pbx.example.com/pbx/openapi.php/routingprofiles"

Edit Routing Profile

Updates only the supplied fields.

curl -X PATCH \
  -H "X-API-Key: GLOBAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Updated documentation routing profile"
}' \
  "https://pbx.example.com/pbx/openapi.php/routingprofiles/OBJECT_ID"

Delete Routing Profile

Deletes the object. Check references before deleting configuration used by routing or reporting.

curl -X DELETE \
  -H "X-API-Key: GLOBAL_API_KEY" \
  "https://pbx.example.com/pbx/openapi.php/routingprofiles/OBJECT_ID"

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.