Skip to main content
Skip table of contents

Initiating a call

After receiving a «ring» push notification (APN/FCM/Huawei) and when the user wants to answer the call, this request should be sent to notify other devices via WebSocket that the call has been answered.

After a successful response, the status of the call is changed to «answered».

GET/api/v1/intercom/calls/{call}/start

Headers

Authorization

Bearer token

Accept

application/json

X-Client

ios-cctv|android-cctv|thick-legal|web

X-UUID

unique device id

Body

calloptional

int

Identifier of the call to initiate (status must be «ring»)

Response

200

Successful response

JSON
{
                "sip": "wss://intercom2.vms.local:443/sip?token=ciOiJIUzUEp6UvshAzZwD1bZJPErvADmA",
                "number": "81786225",
                "host" : "intercom2.vms.local"
            }
401

Authorization token not provided or invalid, see Obtaining a token

404

If the call does not belong to the user, does not exist, or is not in the «ring» status

Example

JSON
curl -k --location --request GET 'https://vms.local/api/v1/intercom/calls/{call}/start' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id'
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.