API overview

The Drömlik API is a REST API for querying and configuring a tenant, plus an event channel (WebSocket or webhook) for real-time updates. Everything you can do in the admin console you can also do over the API.

Two communication modes

• Request / response. Your application sends an HTTPS request and receives JSON. Use this for queries ("list extensions"), changes ("create an extension"), and call control ("originate a call").
• Event subscription. Subscribe to events (call state, extension presence, voicemail received) and Drömlik pushes them to you over a persistent WebSocket or to a webhook URL. Use this instead of polling.

What you can do

• Query parameters and status (extensions, trunks, queues, presence).
• Configure features (create/edit/delete extensions, routes, IVRs).
• Control calls (originate, transfer, hang up, hold).
• Monitor events (call state changed, voicemail received, presence changed, inbound SMS).

Base URL

https://<tenant>.dromlik.com/openapi/v1.0/

Replace <tenant> with your Drömlik subdomain. All requests must use HTTPS.

Request flow

1. Exchange your API key + secret for an access token (valid 30 minutes). See Authentication.
2. Send subsequent requests with Authorization: Bearer <token>.
3. Refresh the token before it expires using the refresh token returned with it.

Response format

All responses are JSON with a top-level errcode, errmsg, and feature-specific payload. errcode: 0 means success.

{
  "errcode": 0,
  "errmsg": "SUCCESS",
  "total_number": 12,
  "data": [ ... ]
}