VoIP Integration

VoIP events

Request

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.

Security

BearerPartner

Acceptstringrequired

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

Example:application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token

Bodyapplication/jsonrequired

Request bodies

Any of:

Connect integration

commandstringrequired

Operation type: 'setup'

Example:"setup"

crm_tokenstringrequired

CRM-token from the VoIP Integration in the client's chain section

Example:"7cf262d6-1656-43f9-86ac-2826bdc125d2"

typestringrequired

Operation type, in this case 'enable'

Example:"enable"

curl -i -X POST \
  https://developer.alteg.io/_mock/en/developers/openapi/voip/integration \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "command": "setup",
    "type": "enable",
    "crm_token": "7cf262d6-1656-43f9-86ac-2826bdc125d2"
  }'

Responses

Accepted

Bodyapplication/json

successboolean

Success status (true)

Example:true

datastring

Contains null

metaobject

Metadata (contain an "Accepted" message)

Example:

{
  "message": "Accepted"
}

Response

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