Skip to main content

Documentation Index

Fetch the complete documentation index at: https://orbit-docs.devotel.io/llms.txt

Use this file to discover all available pages before exploring further.

​
SIP Credentials API

Issue SIP credentials so a third-party softphone or hardware desk phone can register with Orbit’s voice plane and receive / place calls on tenant numbers. Credentials authenticate against the Kamailio + Jambonz edge. Base path: /v1/sip-credentials Authentication: API key (X-API-Key) or session JWT.
MethodPathPurpose
GET/v1/sip-credentials/List credentials
POST/v1/sip-credentials/Issue a new credential
GET/v1/sip-credentials/{id}Get a credential
PATCH/v1/sip-credentials/{id}Update label / restrictions
DELETE/v1/sip-credentials/{id}Revoke
POST/v1/sip-credentials/{id}/rotateRotate password
POST/v1/sip-credentials/{id}/unregisterForce-unregister all sessions

​
Example — issue a credential for a desk phone

curl -X POST https://orbit-api.devotel.io/api/v1/sip-credentials/ \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Reception desk - Yealink T46U",
    "extension": "100",
    "allowed_outbound": true
  }'
The response includes sip_username, sip_password, sip_server, and sip_port — configure these on the device. Passwords are returned once, on creation; use rotate if a password is lost.

​
See also