CoIPx REST API Gateway
Integrate your business applications with the CoIPx Telephony Engine using our unified API Gateway endpoints (/api/v1/*).
1. Authentication
Authenticate using JWT credentials or Bearer tokens. All requests map transparently through the Yii2 API Gateway.
curl -X POST https://your-domain/coipx/web/api/v1/logins/do-login \
-H "Content-Type: application/json" \
-d '{"username": "admin", "password": "your_password"}'2. Making API Calls
Pass your session token in the Authorization: Bearer header on every API request.
curl -X GET https://your-domain/coipx/web/api/v1/subscribers \
-H "Authorization: Bearer <your_jwt_token>"Available API Gateway Modules
Subscribers/api/v1/subscribersSIP Extensions & User Accounts
Call Queues/api/v1/queuesACD Queues & Members
ACD Agents/api/v1/agentsHuman & AI Agent Profiles
CDR Records/api/v1/cdrsCall Detail History & Logs
Phone Addressbook/api/v1/phone-abContacts & Speed Dials
Domains/api/v1/domainsMulti-Tenant Domain Management
Ready to test endpoints interactively?
Launch our interactive Swagger UI to inspect schemas, test live requests, and download the full OpenAPI 3.0 specification.