Skip to main content
Skip table of contents

Intercom view

GET/api/admin/v1/intercoms/{intercom}

Headers

Authorization

Bearer token

Accept

application/json

X-Client

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

X-UUID

unique device id

Body

intercomoptional

int

Unique identifier of the intercom

Response

200

Successful response

JSON
{
    "id": 11,
    "title": "sputnik",
    "is_online": true,
    "group_id": 4,
    "camera_id": 1,
    "flat_from": 1,
    "flat_to": 50,
    "flat_offset": null,
    "department": 1,
    "department_name": "main enter",
    "department_type": "main",
    "department_type_pretty": "Entrance",
    "uuid": "e7a06b0d-512b-4d10-8866-11d277fa7f0a",
    "address": null,
    "group": {
        "id": 4,
        "name": "Intercoms",
        "full_pretty": "Intercoms",
        "is_house": 1,
        "cameras_count": 0,
        "parent_id": 3,
        "csa_id": null,
        "intercoms_count": 1
    },
    "camera": {
        "id": 1,
        "group_id": 2,
        "status": "inactive",
        "type": "media_server_v2",
        "start_at": "",
        "created_at": "2022-12-06 20:20:50",
        "name": "Camera",
        "streams": [
            {
                "id": 2,
                "type": "low",
                "camera_id": 1,
                "status": "active",
                "url": "rtsp://admin:456redko@192.168.204.21:554/Streaming/Channels/102",
                "bitrate": 0,
                "resolution": "0x0",
                "output_rate": 0,
                "ip": "192.168.204.13",
                "uuid": "a4967207-eb49-4275-b73e-91e771675ac0",
                "sound": "tracks-v1",
                "streams_count": 0,
                "server": {
                    "id": 1,
                    "type": "media_server_v2",
                    "schema": "https",
                    "internal_domain": "host-name-1.vms.local",
                    "external_domain": "host-name-1.vms.local",
                    "domain": "host-name-1.vms.local",
                    "internal": "8080",
                    "external": "8443",
                    "rtsp": "5554",
                    "traffic_in": 74045,
                    "traffic_out": 0,
                    "status": true,
                    "is_enabled": true,
                    "has_cache": false,
                    "proxy": "host-name-1.vms.local",
                    "created_at": "2022-12-06 20:20:50",
                    "updated_at": "2022-12-16 10:25:53",
                    "group_type":"all",
                    "can_delete": false,
                    "streams_limit": 100,
                    "bitrate_limit": 1000000,
                    "extra": {
                        "io": {
                            "read_rate": 0,
                            "read_bytes": 0,
                            "write_rate": 0,
                            "write_bytes": 0
                        },
                        "cpu": {
                            "total": 10,
                            "usage": 13,
                            "stime_sec": 15212,
                            "utime_sec": 15212
                        },
                        "mem": {
                            "rss": 3244748800,
                            "share": 9314304,
                            "usage": 5843918848
                        },
                        "net": {
                            "in_bitrate": 75822232,
                            "out_bitrate": 0
                        },
                        "drives": {
                            "/": {
                                "fs": "ext4",
                                "mount": "/",
                                "inode_free": 1463157,
                                "inode_total": 1589248,
                                "capacity_free": 11702407168,
                                "capacity_total": 25445027840
                            },
                            "none": {
                                "fs": "swap",
                                "mount": "none",
                                "inode_free": 0,
                                "inode_total": 0,
                                "capacity_free": 0,
                                "capacity_total": 0
                            },
                            "/boot": {
                                "fs": "ext4",
                                "mount": "/boot",
                                "inode_free": 97988,
                                "inode_total": 98304,
                                "capacity_free": 1332723712,
                                "capacity_total": 1547051008
                            },
                            "/storage": {
                                "fs": "ext4",
                                "mount": "/storage",
                                "inode_free": 32765326,
                                "inode_total": 32768000,
                                "capacity_free": 448026333184,
                                "capacity_total": 527295578112
                            }
                        },
                        "server": {
                            "ip4": "192.168.200.15",
                            "name": "MS-21.03.3-lts-rc-3",
                            "build": "caeb03b",
                            "uptime": 247945,
                            "startat": 1670595943,
                            "version": "21.03.3",
                            "hostname": "host-name-1.vms.local",
                            "revision": "lts-rc-3",
                            "timestamp": "20221129093237"
                        },
                        "cluster": {
                            "id": "100",
                            "node": "3",
                            "enable": "true",
                            "hostname": "host-name-1.vms.local"
                        },
                        "license": {
                            "type": "enterprise",
                            "issued": 4102444799
                        },
                        "streams": {
                            "total": 371,
                            "active": 105,
                            "clients": 0
                        },
                        "storages": {
                            "/storage": {
                                "fs": "",
                                "err": 0,
                                "name": "default",
                                "mount": "/storage",
                                "inode_free": 32765326,
                                "inode_total": 32768000,
                                "capacity_free": 448026333184,
                                "capacity_total": 527295578112
                            },
                            "/storage2": {
                                "fs": "",
                                "err": -2,
                                "name": "secondary",
                                "mount": "/storage2",
                                "inode_free": 0,
                                "inode_total": 0,
                                "capacity_free": 0,
                                "capacity_total": 0
                            }
                        }
                    },
                    "is_editable": true
                },
                "sub_servers": [
                    {
                        "id": 2,
                        "type": "media_server_v2",
                        "schema": "https",
                        "internal_domain": "host-name-2.vms.local",
                        "external_domain": "host-name-2.vms.local",
                        "domain": "host-name-4.vms.local",
                        "internal": "8080",
                        "external": "8443",
                        "rtsp": "5554",
                        "traffic_in": 11568,
                        "traffic_out": 22496,
                        "status": true,
                        "is_enabled": true,
                        "has_cache": false,
                        "proxy": "host-name-2.vms.local",
                        "created_at": "2022-12-06 20:20:50",
                        "updated_at": "2022-12-16 10:25:53",
                        "group_type":"all",
                        "can_delete": false,
                        "streams_limit": 100,
                        "bitrate_limit": 1000000,
                        "extra": {
                            "io": {
                                "read_rate": 0,
                                "read_bytes": 0,
                                "write_rate": 0,
                                "write_bytes": 0
                            },
                            "cpu": {
                                "total": 5,
                                "usage": 4,
                                "stime_sec": 5985,
                                "utime_sec": 5985
                            },
                            "mem": {
                                "rss": 7734063104,
                                "share": 5169152,
                                "usage": 11912642560
                            },
                            "net": {
                                "in_bitrate": 11845448,
                                "out_bitrate": 23035504
                            },
                            "drives": {
                                "/": {
                                    "fs": "ext4",
                                    "mount": "/",
                                    "inode_free": 1462977,
                                    "inode_total": 1589248,
                                    "capacity_free": 10998165504,
                                    "capacity_total": 25445027840
                                },
                                "none": {
                                    "fs": "swap",
                                    "mount": "none",
                                    "inode_free": 0,
                                    "inode_total": 0,
                                    "capacity_free": 0,
                                    "capacity_total": 0
                                },
                                "/boot": {
                                    "fs": "ext4",
                                    "mount": "/boot",
                                    "inode_free": 97988,
                                    "inode_total": 98304,
                                    "capacity_free": 1332719616,
                                    "capacity_total": 1547051008
                                },
                                "/storage": {
                                    "fs": "ext4",
                                    "mount": "/storage",
                                    "inode_free": 32735783,
                                    "inode_total": 32768000,
                                    "capacity_free": 16777216,
                                    "capacity_total": 527295578112
                                }
                            },
                            "server": {
                                "ip4": "192.168.200.16",
                                "name": "MS-21.03.3-lts-rc-3",
                                "build": "caeb03b",
                                "uptime": 247945,
                                "startat": 1670595943,
                                "version": "21.03.3",
                                "hostname": "host-name-2.vms.local",
                                "revision": "lts-rc-3",
                                "timestamp": "20221129093237"
                            },
                            "cluster": {
                                "id": "100",
                                "node": "4",
                                "enable": "true",
                                "hostname": "host-name-2.vms.local"
                            },
                            "license": {
                                "type": "enterprise",
                                "issued": 4102444799
                            },
                            "streams": {
                                "total": 374,
                                "active": 5,
                                "clients": 75
                            },
                            "storages": {
                                "/storage": {
                                    "fs": "",
                                    "err": 0,
                                    "name": "default",
                                    "mount": "/storage",
                                    "inode_free": 32735783,
                                    "inode_total": 32768000,
                                    "capacity_free": 16777216,
                                    "capacity_total": 527295578112
                                },
                                "/storage2": {
                                    "fs": "",
                                    "err": -2,
                                    "name": "secondary",
                                    "mount": "/storage2",
                                    "inode_free": 0,
                                    "inode_total": 0,
                                    "capacity_free": 0,
                                    "capacity_total": 0
                                }
                            }
                        },
                        "is_editable": true
                    }
                ],
                "transfer_servers": [],
                "transfer_sub_servers": [],
                "created_at": "2022-12-06 20:20:50",
                "updated_at": "2022-12-12 15:42:13",
                "is_preview_from_server": true,
                "is_archive_from_server": null,
                "is_enabled": true,
                "is_can_transfer": true,
                "source": "manual",
                "is_sound_enabled": false,
                "reconnect_attempt": 234,
                "reconnect_total": 234,
                "reconnect_time": "2022-12-12 14:53:55",
                "disconnections_count": 0,
                "is_actual": true,
                "condition": "incorrect",
                "stopped_at": "2022-12-06 20:20:51"
            }
        ],
        "can_edit": true,
        "origin": null,
        "group_type": "public",
        "shared_from": null,
        "ip": "192.168.204.13",
        "lat": null,
        "lng": null,
        "azimuth": null,
        "is_sensitive": 0,
        "is_public": 0,
        "archive_ranges": [],
        "archive_recording_timetable": null,
        "motion_detaction_timetable": [],
        "onvif_configuration": null,
        "streams_rtsp": null,
        "is_ip_reserved": false,
        "count_issues": 0,
        "source": "manual",
        "archive_storage_days": null,
        "is_archive_recording": false,
        "archive_recording_type": "fulltime",
        "is_increased_reconnect": 0,
        "is_sound_enabled": true,
        "is_bridge": false,
        "can_change_archive_timetable": true,
        "is_auto_create_streams": false,
        "is_provisioning_enable": false,
        "is_can_manage_streams": true,
        "streams_source": "manual",
        "is_can_manage_archive_storage_days": true,
        "is_editable": true,
        "status_changed_at": "",
        "is_intercom": true,
        "deleted_at": ""
    },
    "collecting_keys": true,
    "door_open_time_general": 7,
    "sip_credentials": {
        "server": "vgw1.vms.local",
        "port": "5090",
        "login": "Panel_2566",
        "password": "************"
    },
    "sip_options": {
        "dtmf": [
            {
                "id": 1,
                "value": "*"
            }
        ]
    },
    "is_crossbar_switchers_enabled": true,
    "is_can_manage_matrix": false,
    "matrix": [
        {
            "id": 1,
            "capacity": 49,
            "items": [
                [
                    1,
                    2,
                    3,
                    4,
                    5,
                    6,
                    7,
                    8,
                    9,
                    10
                ],
                [
                    11,
                    12,
                    13,
                    14,
                    15,
                    16,
                    17,
                    18,
                    19,
                    20
                ],
                [
                    21,
                    22,
                    23,
                    24,
                    25,
                    26,
                    27,
                    28,
                    29,
                    30
                ],
                [
                    31,
                    32,
                    33,
                    34,
                    35,
                    36,
                    37,
                    38,
                    39,
                    40
                ],
                [
                    41,
                    42,
                    43,
                    44,
                    45,
                    46,
                    47,
                    48,
                    49
                ]
            ],
            "auto": true,
            "is_last_item_first": null,
            "flat_from": 1
        }
    ],
    "created_at": "",
    "updated_at": "2023-01-05 12:52:12",
    "mac": null,
    "vendor": "sputnik",
    "vendor_pretty": "Sputnik",
    "status": "installed",
    "status_pretty": "Installed",
    "switch": "metakom",
    "switch_pretty": "Metakom",
    "schema": null,
    "ip": null,
    "port": null,
    "login": null,
    "password": null,
    "commutators_count": null,
    "connection_type": "matrix_switching",
    "connection_type_pretty": "Matrix-switching",
    "key_count": null
}
401

Authorization token is not provided or is invalid. Obtaining a token

Example

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