ExoVoIP API

The ExoVoIP REST API lets you manage the phone system from any application: everything you can do in the control panel can also be done through the API, with a dedicated key.

#What you can do

• Configure the phone system: extensions, trunks, numbers, inbound and outbound routes, business hours and closures, IVR menus, ring groups, queues, music on hold and voice prompts.
• Read call data: call log, recordings with transcripts, voicemail messages, company phonebook.
• Monitor the phone system in real time: active calls, extension and phone status, trunks, queues and call parking, via SSE or WebSocket events.
• Receive events in your own systems: signed webhooks to CRMs, business software and automation tools.
• Manage the platform (Exobyte only): tenants, numbers, security and services.

#Addresses

All paths in this guide are relative to the API address: GET /v1/extensions means GET https://centralino.exovoip.it/api/v1/extensions.

#In three steps

1. In the control panel, under Developers, create an API key with the permissions you need.
2. Send the key in the X-API-Key header (or Authorization: Bearer).
3. Use one of the official SDKs or any HTTP client.

curl -s https://centralino.exovoip.it/api/v1/tenants/current \
  -H "X-API-Key: $EXOPBX_API_KEY"

const { tenant } = await pbx.tenants.current();
console.log(tenant.name, tenant.status);

$out = $pbx->tenants->current();
echo $out['tenant']['name'], PHP_EOL;

tenant = pbx.tenants.current()["tenant"]
print(tenant["name"], tenant["status"])

Continue with Getting started or go straight to the guide for the area you need.

#Official SDKs

The SDKs are generated from the OpenAPI document and stay in sync with the API. They handle the key, retries, pagination, idempotency, errors, real-time events and webhook verification for you. Details in SDKs.