1.9 KiB
1.9 KiB
RingLogix CPaaS API — Quick Reference
Base URL: https://api.ringlogix.com/pbx/v1/
Auth: OAuth2 password grant → Bearer token
Pattern: POST ?object=X&action=Y
Auth
POST /pbx/v1/oauth2/token/
Body: grant_type=password, client_id, client_secret, username, password
Returns: access_token, refresh_token, expires_in, domain, scope
Key Objects (50+ total)
| Object | Key Actions | Use |
|---|---|---|
| subscriber | create, read, update, count | Customer accounts |
| device | create, read, update, delete | Phone provisioning (MAC + model) |
| devicemodel | read | List supported phones for auto-provisioning |
| phonenumber | read, update | DID management |
| CDR2 | read, count, report | Call records for billing |
| cdrexport | create, read, download | Export CDRs |
| call | make, answer, transfer, hold, disconnect | Live call control |
| callqueue | create, read, update, delete | Call center queues |
| agent | create, read, update, delete | Queue agents |
| message | create, read, delete | SMS/MMS |
| recording | create, read, update, delete | Call recordings |
| vmailnag | read, update | Voicemail reminders (SMS/email/phone) |
| contact | CRUD | Personal directories |
| meeting | CRUD | Video conferencing |
| answerrule | CRUD | Call routing/forwarding |
| audio | CRUD | IVR prompts, hold music |
| dashboard, chart | CRUD | Analytics widgets |
| subscription | create, read, delete | Webhook event subscriptions |
| presence | list | User status (online/offline) |
Access Scopes
- Basic User: own data only
- Office Manager: whole domain
- Reseller: all domains (must be requested via Success Manager)
RingOS API
Billing data + commissions. Currently unavailable — under development.
Getting Credentials
Contact RingLogix Success Manager → opens ticket → keys delivered via one-time secure link. Need: client_id, client_secret, PBX user with Reseller scope.