Skip to main content
Skip table of contents

Список событий. VMS Client API

Список системных событий, которые может просматривать пользователь

GET/api/v1/events

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

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

pagerequired

int

Номер страницы пагинации

daterequired

string

Шаблон для фильтрации по определенной метке даты. Это поле обязательно, когда есть поле timezone

timezonerequired

string

Часовой пояс для шаблон фильтрации по дате. Пример - Europe/Paris. Это поле обязательно, когда есть поле date

fromrequired

date

Дата, с которой будут отображаться события

torequired

date

Дата, до которой будут отображаться события

typerequired

array

Массив типов, список доступных можно найти в Основные конфигурации

camerasrequired

array

Массив идентификаторов камер, по которым нужны события

sortrequired

string

Поле, по которому нужно отсортировать метки

dirrequired

string

В каком направлении нужно отсортировать.

Response

200

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

JSON
{
            "data": [
                {
                    "id": null,
                    "type": "stream_high_active",
                    "type_pretty": "Стрим высокого качества активен",
                    "data": [],
                    "camera": {
                        "id": 756,
                        "group_id": 101,
                        "status": "active",
                        "type": "media_server_v2",
                        "start_at": "2022-05-23 17:09:57",
                        "created_at": "2022-01-27 19:52:55",
                        "billing_id": null,
                        "pretty_name": "Камера 1",
                        "pretty_text": "Камеры",
                        "short_address": "Камеры",
                        "full_address": "Камеры",
                        "lat": null,
                        "lng": null,
                        "azimuth": null,
                        "streams": [
                            {
                                "id": 754,
                                "type": "high",
                                "camera_id": 756,
                                "is_preview_from_server": true,
                                "is_archive_from_server": null,
                                "status": "active",
                                "has_sound": false,
                                "width": 1920,
                                "height": 1080
                            },
                            {
                                "id": 755,
                                "type": "low",
                                "camera_id": 756,
                                "is_preview_from_server": true,
                                "is_archive_from_server": null,
                                "status": "active",
                                "has_sound": false,
                                "width": 640,
                                "height": 480
                            }
                        ],
                        "has_sound": false,
                        "is_archive_recording": true,
                        "is_bridge": false,
                        "is_favorite": false,
                        "user_status": "active",
                        "name": "Камера 1"
                    },
                    "camera_id": 756,
                    "user": null,
                    "user_id": null,
                    "created_at": "2022-06-07 05:20:05",
                    "analytic_case": null
                },
                {
                    "id": null,
                    "type": "stream_high_inactive",
                    "type_pretty": "Стрим высокого качества неактивен",
                    "data": [],
                    "camera": {
                        "id": 756,
                        "group_id": 101,
                        "status": "active",
                        "type": "media_server_v2",
                        "start_at": "2022-05-23 17:09:57",
                        "created_at": "2022-01-27 19:52:55",
                        "billing_id": null,
                        "pretty_name": "Камера 1",
                        "pretty_text": "Камеры",
                        "short_address": "Камеры",
                        "full_address": "Камеры",
                        "lat": null,
                        "lng": null,
                        "azimuth": null,
                        "streams": [
                            {
                                "id": 754,
                                "type": "high",
                                "camera_id": 756,
                                "is_preview_from_server": true,
                                "is_archive_from_server": null,
                                "status": "active",
                                "has_sound": false,
                                "width": 1920,
                                "height": 1080
                            },
                            {
                                "id": 755,
                                "type": "low",
                                "camera_id": 756,
                                "is_preview_from_server": true,
                                "is_archive_from_server": null,
                                "status": "active",
                                "has_sound": false,
                                "width": 640,
                                "height": 480
                            }
                        ],
                        "services": {
                            "ptz": false,
                            "motion_detect": false
                        },
                        "has_sound": false,
                        "is_archive_recording": true,
                        "is_bridge": false,
                        "is_favorite": false,
                        "user_status": "active",
                        "name": "Камера 1"
                    },
                    "camera_id": 756,
                    "user": null,
                    "user_id": null,
                    "created_at": "2022-06-07 05:19:05",
                    "analytic_case": null
                }
            ],
            "links": {
                "first": "https://vms.local/api/v3/events?per_page=25&page=1",
                "last": "https://vms.local/api/v3/events?per_page=25&page=111",
                "prev": null,
                "next": "https://vms.local/api/v3/events?per_page=25&page=2"
            },
            "meta": {
                "current_page": 1,
                "from": 1,
                "last_page": 111,
                "links": [
                    {
                        "url": null,
                        "label": "pagination.previous",
                        "active": false
                    },
                    {
                        "url": "https://vms.local/api/v3/events?per_page=25&page=1",
                        "label": "1",
                        "active": true
                    },
                    {
                        "url": "https://vms.local/api/v3/events?per_page=25&page=2",
                        "label": "2",
                        "active": false
                    },
                    {
                        "url": "https://vms.local/api/v3/events?per_page=25&page=3",
                        "label": "3",
                        "active": false
                    },
                    {
                        "url": "https://vms.local/api/v3/events?per_page=25&page=4",
                        "label": "4",
                        "active": false
                    },
                    {
                        "url": "https://vms.local/api/v3/events?per_page=25&page=5",
                        "label": "5",
                        "active": false
                    },
                    {
                        "url": "https://vms.local/api/v3/events?per_page=25&page=6",
                        "label": "6",
                        "active": false
                    },
                    {
                        "url": "https://vms.local/api/v3/events?per_page=25&page=7",
                        "label": "7",
                        "active": false
                    },
                    {
                        "url": "https://vms.local/api/v3/events?per_page=25&page=8",
                        "label": "8",
                        "active": false
                    },
                    {
                        "url": "https://vms.local/api/v3/events?per_page=25&page=9",
                        "label": "9",
                        "active": false
                    },
                    {
                        "url": "https://vms.local/api/v3/events?per_page=25&page=10",
                        "label": "10",
                        "active": false
                    },
                    {
                        "url": null,
                        "label": "...",
                        "active": false
                    },
                    {
                        "url": "https://vms.local/api/v3/events?per_page=25&page=110",
                        "label": "110",
                        "active": false
                    },
                    {
                        "url": "https://vms.local/api/v3/events?per_page=25&page=111",
                        "label": "111",
                        "active": false
                    },
                    {
                        "url": "https://vms.local/api/v3/events?per_page=25&page=2",
                        "label": "pagination.next",
                        "active": false
                    }
                ],
                "path": "https://vms.local/api/v3/events",
                "per_page": 25,
                "to": 25,
                "total": 2762
            }
        }
401

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

422

Возвращает JSON объект с ошибкой, см. Валидация

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

Пример

JSON
curl -k --location --request GET 'https://vms.local/api/v1/events?per_page=int&page=int&date=string&timezone=string&from=date&to=date&type=array&cameras=array&sort=string&dir=string' \
--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.