Skip to main content
Skip table of contents

Viewing a call

This request is used to check if it is necessary to initiate a call after receiving a «ring» push notification (APN/FCM/Huawei).

It is used to handle scenarios where the user's internet connection is restored after the push notification is sent, and during that time another device may have already answered the call. This is because the "cancel" push notification is delivered via WebSocket, and the device may have missed it due to the lack of internet connection.

If the received status after the request is not «ring», Android devices do not initiate the call. However, iOS devices initiate the call first and then terminate it after the check. This behavior is due to limitations in the operating system.

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

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 retrieve

Response

200

Successful response

JSON
{
    "id": 5546,
    "status": "ring",
    "created_at": "2022-02-04 15:53:04",
    "intercom": {
        "id": 158,
        "title": "test",
        "is_online": false,
        "department": 1,
        "address": "Cameras",
        "camera": {
            "id": 832,
            "group_id": 124,
            "status": "inactive",
            "type": "media_server_v2",
            "start_at": "",
            "created_at": "2022-02-18 15:03:58",
            "billing_id": null,
            "pretty_name": "Intercom",
            "lat": null,
            "lng": null,
            "azimuth": null,
            "is_archive_recording": true,
            "is_bridge": false,
            "is_favorite": false,
            "user_status": "active",
            "name": "Intercom"
        },
        "created_at": "2021-11-18T11:22:30.000000Z",
        "updated_at": "2022-02-21T15:48:56.000000Z"
    },
    "started_at": "2022-02-04 15:53:07",
    "ended_at": "2022-02-04 15:54:02"
}
401

Authorization token not provided or invalid, see Obtaining a token

404

If the call does not belong to the user or does not exist

Example

JSON
curl -k --location --request GET 'https://vms.local/api/v1/intercom/calls/{call}' \
--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.