Integration with External Systems

Connecting the virtual PBX integration to an external system by a user is an automated process that should be understandable to the user without additional help. In the external system, widgets (applications) are generally available that the user can use to connect the system integration with a telephony platform. When the user choosing the desired widget, the external system informs the user what steps must be taken to complete the integration, or an integrator performs the integration process independently without participation of the user, having received authorization data from the user.

To enable the PBX user to connect the integration via the external system widget, you are required to create an application of the public type with the call api access level, specify the Redirect URL, allow the application to access the system, and authorize the application. In order not to re-request access to the user account, you may create a permanent trusted application (of the trusted type, it is also automatically created with the call api access level). See the full description is available using the link: "Application Authorization and Integration Start".

For integration purposes, it is required to define the extension numbers that are ordinary extension numbers and the extension numbers that service ones (voice menu and queue). This data may be retrieved, for example, by requesting it with the resource:
get /client/{client_id}/extension/ (the extension number field type).

The PBX prefix and the extension number length may be found using the resource:
get /client/{client_id}/client/ (the client fields extension_len and prefix).
The user extension number with the PBX prefix has format of a regular expression (regex): [0-9]{3,6}*[0-9]{2,4}

The PBX records data on the calls and generates the call history (it may be available in the client card in the external system).

Events are exchanged between the external system and the PBX. For example, based on the corresponding event, a client card pops up in the external system when an incoming call is received. To configure filtering of the events between the external system and the PBX, you must set the appropriate values.

You can find more detailed documentation on the extension number events in the page "Extension Number Events". Logic of the extension number events is described in the corresponding page. A description of how the integration works is available with the link. It will also be helpful to get more information related to comments on the integration.

← REST API Structure Application Authorization and Integration Start →