Sign in

v1

latestOpenAPI 3.1.1Altegio API Agreement2026-08-062032133.5 KB
VoIP Integration

VoIP events

Enable integration

To use the api and activate access to the settings in the user interface, you need to activate the integration by sending the "Enable integration" request. After a successful connection, access to the section with routing settings will be opened in the chain user interface.

Disable integration

To disable the integration, you can use the "Disable integration" method. After the integration is disabled, access to the user interface settings section is closed, the requests "Call notification" and "Call information saving" are not processed.

Call notification

To display notifications about an incoming call, the "Call notification" method is used, the call type ("incoming", "outgoing", "internal") is specified in the parameters, but currently notifications are displayed only for the "incoming" value. Notifications are displayed for users defined based on routing settings. When specifying the "user" and "diversion" parameters at the same time, "user" is the priority when searching for routes.

Saving call information

The information about the call is automatically saved to the chain history and to the history of chain locations in accordance with the call routing settings.

post/voip/integration

Headers

Acceptstring required

e.g. application/vnd.api.v2+json

Content-Typestring required

application/json

Authorizationstring required

Bearer partner_token

Request body

OR
OR
OR

Example request

{
  "command": "setup",
  "type": "enable",
  "crm_token": "7cf262d6-1656-43f9-86ac-2826bdc125d2"
}

Response

Accepted

successboolean

Success status (true)

datastring

Contains null

Example response

{
  "success": true,
  "meta": {
    "message": "Accepted"
  }
}