Connect your phone system

Choose the option that matches your backend. Add your API key on your own server after downloading.

Setting up FreePBX? Start with the simple config generator. The downloads below are for custom PHP/Python integrations.FreePBX setup →

1. Choose your integration

Existing PHP backendA small PHP client and example. Add API lookups to your current router. PHP 8.1+ and cURL. FreePBX / Asterisk — PHPPHP AGI script, peer mapping and dialplan. Best if your PBX already has PHP CLI. FreePBX / Asterisk — PythonThe same integration using Python 3, with no third-party Python packages.

2. Your FreePBX settings

Use a peer you have already configured and tested with the remote operator.

Local access prefix1–8 digits, default 88. Stripped before lookup; not part of the Global CEN Number.

Local IAX peer name

Remote PBX hostname

Remote IAX port

All downloads include a README. API keys and IAX passwords are separate. The directory takes exactly 10 digits: CEN Area Code + Local Number. FreePBX claims only your prefix plus 10 digits. Configure trusted member APIs locally.

Protected by Cloudflare Turnstile. Privacy information

Using something else?

Any backend that can make an HTTPS request can use the API. See request examples and response formats in the API Explorer or the integration guide.