DID

The DID 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
did
Primary path
/dids
ID field
di_id
Label field
di_number
Primary source table
di_dids
Required on create
di_number
Path aliases
/dids
Endpoint Patterns
Action
Example pattern
List
GET https://pbx.example.com/pbx/openapi.php/dids?tenant=CANISTRACCI
Get by ID
GET https://pbx.example.com/pbx/openapi.php/dids/OBJECT_ID?tenant=CANISTRACCI
Create
POST https://pbx.example.com/pbx/openapi.php/dids?tenant=CANISTRACCI
Update
PATCH https://pbx.example.com/pbx/openapi.php/dids/OBJECT_ID?tenant=CANISTRACCI
Delete
DELETE https://pbx.example.com/pbx/openapi.php/dids/OBJECT_ID?tenant=CANISTRACCI
Accepted Field Aliases
Request field
Source field
number
di_number
country
di_country
area
di_area
comment
di_comment
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
DID
destination, 
did
DID-UNCONDITIONAL
unconditional
DID-SMS
sms
DID-FAXSUCCESS
faxsuccess, 
fax_success
Examples
List DIDs
Returns the dids visible to the key and scope.
curl -H "X-API-Key: TENANT_API_KEY" \
  "https://pbx.example.com/pbx/openapi.php/dids?tenant=CANISTRACCI"
Get DID
Reads one object by its internal ID.
curl -H "X-API-Key: TENANT_API_KEY" \
  "https://pbx.example.com/pbx/openapi.php/dids/OBJECT_ID?tenant=CANISTRACCI"
Create DID
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 '{
  "number": "+15551234567",
  "country": "US",
  "area": "212",
  "comment": "Docs API inbound DID"
}' \
  "https://pbx.example.com/pbx/openapi.php/dids?tenant=CANISTRACCI"
Edit DID
Updates only the supplied fields.
curl -X PATCH \
  -H "X-API-Key: TENANT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "comment": "Docs API DID updated"
}' \
  "https://pbx.example.com/pbx/openapi.php/dids/OBJECT_ID?tenant=CANISTRACCI"
Delete DID
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/dids/OBJECT_ID?tenant=CANISTRACCI"
DID Destination
Updates the 
DID 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 '{
  "destination": [
    "EXT-100"
  ]
}' \
  "https://pbx.example.com/pbx/openapi.php/dids/OBJECT_ID?tenant=CANISTRACCI"
DID UNCONDITIONAL Destination
Updates the 
DID-UNCONDITIONAL 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 '{
  "unconditional": [
    "EXT-100"
  ]
}' \
  "https://pbx.example.com/pbx/openapi.php/dids/OBJECT_ID?tenant=CANISTRACCI"
DID SMS Destination
Updates the 
DID-SMS 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 '{
  "sms": [
    "EXT-100"
  ]
}' \
  "https://pbx.example.com/pbx/openapi.php/dids/OBJECT_ID?tenant=CANISTRACCI"
DID FAXSUCCESS Destination
Updates the 
DID-FAXSUCCESS 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 '{
  "faxsuccess": [
    "EXT-100"
  ]
}' \
  "https://pbx.example.com/pbx/openapi.php/dids/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.