Skip to main content
Skip table of contents

List of intercoms. VMS Client API

List of all intercoms added by the user with statuses «key_confirmed» (added by key, but apartment not selected) and «confirmed» (fully added and configured)

GET/api/v1/intercom

Headers

Authorization

Bearer token

Accept

application/json

X-Client

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

X-UUID

unique device id

Body

per_pagerequired

int

Number of elements per pagination page. Default is 25

pagerequired

int

Pagination page number

Response

200

Successful response

JSON
{
    "data": [
        {
            "id": 180,
            "title": "House",
            "is_online": true,
            "is_enabled": true,
            "timetable": {
                "days": [
                    {
                        "to": "23:59:59+05:00",
                        "from": "00:00:00+05:00",
                        "type": "tuesday"
                    },
                    {
                        "to": "23:59:59+05:00",
                        "from": "00:00:00+05:00",
                        "type": "wednesday"
                    },
                    {
                        "to": "23:59:59+05:00",
                        "from": "00:00:00+05:00",
                        "type": "saturday"
                    }
                ],
                "intervals": []
            },
            "department": 100,
            "address": "Cameras",
            "camera": {
                "id": 833,
                "group_id": 124,
                "status": "active",
                "type": "media_server_v2",
                "start_at": "2022-04-19 16:43:15",
                "created_at": "2022-02-18 15:05:53",
                "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"
            },
            "status": "confirmed",
            "created_at": null,
            "updated_at": "2022-04-20T12:34:32.000000Z"
        }
    ],
    "links": {
        "first": "https://vms.local/api/v1/intercom?page=1",
        "last": "https://vms.local/api/v1/intercom?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "https://vms.local/api/v1/intercom?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local/api/v1/intercom",
        "per_page": 25,
        "to": 1,
        "total": 1
    }
}
401

Authorization token not provided or invalid, see Obtaining a token

422

Returns a JSON object with an error, see Validation

JSON
{
    "message": "There won't be any informative message here",
    "errors": {
        "any_key": [
            "Here the error cause will be described"
        ]
    }
}

Example

JSON
curl -k --location --request GET 'https://vms.local/api/v1/intercom?per_page=int&page=int' \
--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.