VoIP API

API Overview

The API lets you connect any cloud PBX to Planfix.

Integrating Planfix and cloud PBX addresses several business needs:

• retrieving caller names so they can be displayed on phone or SIP client screens;
• automatic routing of incoming calls from a client to a specific employee assigned to this client;
• displaying information about incoming calls directly within Planfix (pop-up windows for calls);
• saving entire call history and recordings of conversations to Planfix;
• making outgoing calls directly from the Planfix interface.

The integration must be two-way. As a result, some requests will be sent by Planfix to the specified cloud PBX entry points, and some requests will be sent from the cloud PBX to Planfix's single entry point.

The exchange happens over HTTPS. Authorization is done using the Planfix or cloud PBX address, respectively, and the authorization key obtained during the integration setup process.

How authorization and communication work

HTTPS

• API calls to Planfix are accepted only over HTTPS. This ensures that the systems can communicate securely over the Internet.
• To keep your data secure, please use HTTPS to receive calls in your PBX as well.

Key (token)

• In addition, a special key (token) is used to authorize each call to Planfix. You can get it in the integration settings.
• Please use a key (token) to accept calls in your PBX as well. Generate a key and enter it in the corresponding field in the integration settings section.
• Keys are created one time, when configuring the integration. You can replace the key on your end as needed and update it in Planfix.

API calls from cloud PBX to Planfix

• Calls must be sent to the address specified in the integration settings to receive notifications.
• The special key must always be passed in the body of the request, in the "token" field.
• Requests are passed in the format application/x-www-form-urlencoded

API calls from Planfix to cloud PBX

• Planfix will send all requests to the address specified in the integration settings.
• Planfix will pass the key (token) that you specify in your settings in the body of the message.
• Requests are passed in the format application/x-www-form-urlencoded

Responses

• Planfix sends all responses to API calls from cloud PBX in JSON in the body of the response.
• The cloud PBX must send all responses to Planfix calls in JSON in the body of the response.