Получение списка устройств камер с Agent

Метод и параметры

Запрос позволяет получить пагинированный список всех камер с установленным Agent, доступных в системе.

Agent для камеры – программное обеспечение, которое производители камер могут интегрировать непосредственно в прошивку устройства. Интегрированный в камеру Agent обеспечивает передачу видео и аудио потоков напрямую из локальных сетей пользователей по зашифрованному каналу связи. Данное ПО используется для предоставления доступа к камере, к которой нет доступа для медиа сервера напрямую (находятся во внутренней сети).

Необходимый уровень разрешения (Permission) camera-agents.

GET api/admin/v1/camera-agents

Параметры

string search – поиск осуществляется по серийному номеру или MAC-адресу устройства.

bool is_online – фильтрация устройств по статусу в сети, 1 – онлайн, 0 – оффлайн.

string status – фильтрация устройств по статусу камеры, active – активна, inactive – неактивна, partial – частично активна.

int per_page – количество элементов на одной странице пагинации. По умолчанию 25 элементов.

string sort – поле, по которому осуществляется сортировка устройств.

string dir – поле, в котором указывается направлении сортировки: desc – от большего к меньшему, asc – от меньшего к большему.

array users – массив из id пользователей. Данное поле служит для фильтрации камер по принадлежности к пользователям.

int page – номер страницы пагинации.

cURL

BASH

curl -k --request POST \
	--url 'https://your-domainapi/admin/v1/camera-agents' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "search": "string",
    "is_online": true,
    "status": "string",
    "per_page": 0,
    "sort": "string",
    "dir": "string",
    "users": [],
    "page": 0
}'

PHP

$data = array (
  'search' => 'string',
  'is_online' => true,
  'status' => 'string',
  'per_page' => 0,
  'sort' => 'string',
  'dir' => 'string',
  'users' => 
  array (
  ),
  'page' => 0,
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domainapi/admin/v1/camera-agents', false, $context);

Ответы

Детальный перечень кодов возможных ответов смотрите в разделе «Общее описание API».

Успешный ответ:

200 – OK

200 OK

Возвращает список камер на i странице пагинации.

JSON

{
    "data": [
        {
            "id": 1,
            "name": "camera-1",
            "uuid": "a21907cf-391b-4350-affe-3a6bdfdbd5e5",
            "mac": "mac1",
            "serial_number": "serial1",
            "status": "activated",
            "is_online": true,
            "version": "3.4",
            "created_at": "2024-05-31T13:17:08.000000Z",
            "updated_at": "2024-05-31T13:17:08.000000Z",
            "last_updated_at": null,
            "camera": {
                "id": 1,
                "group_id": 1,
                "status": "active",
                "type": "mediaagent",
                "start_at": null,
                "created_at": "2024-06-04T12:36:42.000000Z",
                "name": "name",
                "can_edit": true,
                "origin": null,
                "group_type": "public",
                "ip": "127.0.0.1",
                "lat": null,
                "lng": null,
                "azimuth": null,
                "is_sensitive": false,
                "is_buffer_enabled": false,
                "is_public": 0,
                "is_ip_reserved": false,
                "count_issues": 0,
                "source": "manual",
                "archive_storage_days": 80,
                "is_archive_recording": false,
                "archive_recording_type": "fulltime",
                "is_local_archive_enabled": false,
                "local_archive_storage_days": 30,
                "is_increased_reconnect": 0,
                "is_sound_enabled": true,
                "is_bridge": false,
                "is_agent": true,
                "is_auto_create_streams": false,
                "is_provisioning_enable": false,
                "is_editable": true,
                "status_changed_at": null,
                "is_intercom": false,
                "deleted_at": null,
                "is_need_replace": false
            }
        }
    ],
    "links": {
        "first": "https://vms.local:8080/api/admin/v1/camera-agents?page=1",
        "last": "https://vms.local:8080/api/admin/v1/camera-agents?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:8080/api/admin/v1/camera-agents?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local:8080/api/admin/v1/camera-agents",
        "per_page": 25,
        "to": 1,
        "total": 1
    }
}

Ответы с ошибкой:

401 Unauthorized

Токен авторизации не передан или недействительный.

422 Unprocessable Entity

Возвращает JSON объект с ошибкой.

JSON

{
    "message": "Тут не будет информативного сообщения",
    "errors": {
        "any_key": [
            "Тут будет описана причина ошибки"
        ]
    }
}