> For the complete documentation index, see [llms.txt](https://portal-integracao.intelbras.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://portal-integracao.intelbras.com.br/defense-ia-and-lite/readme/gestao-de-alarmes.md). # Gestão de alarmes Guia de endpoints de Alarmes: subscribe/callback, consulta paginada de registros, tratamento e detalhes de eventos (veículos, faces e acesso), com exemplos curl. ### Como usar: * Substitua variáveis `{{host}}`, `{{loginToken}}`, pelos valores reais do seu ambiente ou utilize variáveis que tenham esses valores. * Copie e cole os blocos por endpoint e mantenha a estrutura “Tópico / Fonte / Resposta / Exemplo”. * Adicione/oculte campos de corpo (JSON) conforme a necessidade do seu caso, mantendo o padrão do projeto. *** ### Convenções e autenticação * Códigos de resultado (padrão): `code: 1000` indica sucesso * Content-Type: `application/json;charset=UTF-8` * Idioma (opcional): `Accept-Language: en` * Autenticação: header `X-Subject-Token: {{loginToken}}` (obtenha o token no seu fluxo de login do projeto) * Base URL: `http://{{host}}/brms/api/v1.1` *** ### Erros comuns (modelo):
SituaçãoSintomaComo resolver
Token ausente/expirado401Refaça login e atualize X-Subject-Token
Content-Type incorreto415 Unsupported Media TypeUse application/json;charset=UTF-8
Campos obrigatórios vazios400 / mensagem de validaçãoRevise a seção Parâmetros do endpoint
*** ### Assinar alarmes **Tópico**: Permite **assinar (subscribe)** o recebimento de alarmes enviados pelo sistema, configurando uma **URL de callback** para receber notificações em tempo real sempre que um alarme for disparado. * Método: `POST /brms/api/v1.1/push-data/alarm/subscribe` * Headers: `X-Subject-Token`-Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{{Host}}/brms/api/v1.1/push-data/alarm/subscribe' --header 'X-Subject-Token: EC38D1A7709B4BAA995339e6c4e572c4' --header 'Content-Type: application/json' --header 'Cookie: Path=/' --data '{ "callbackUrl": "https://192.168.1.1:443/brms/api/v1.1/push-data/alarm/push", "action": "1", "signature": "c743b433407be68ee62c46ede8fb5a0c" }' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": null } ``` ### Receber mensagens de alarme em páginas **Tópico**: Permite **consultar registros de alarmes de forma paginada**, possibilitando filtrar por código de alarme, dispositivos e canais. Ideal para exibição em páginas, relatórios ou históricos de eventos. * Método: `POST /brms/api/v1.1/alarm/record/fetch/page` * Headers: `X-Subject-Token` - Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{{Host}}/brms/api/v1.1/alarm/record/fetch/page' --header 'X-Subject-Token: EC38D1A7709B4BAA995339e6c4e572c4' --header 'Content-Type: application/json' --header 'Cookie: JSESSIONID=F43073C7368F2438635F52E6D56E94CE' --data '{ "alarmCode": "", "deviceCodes": [], "channelIds": [], "alarmStatus": [], "alarmTypes": [], "startAlarmTime": "1691337600", "endAlarmTime": "1691596799", "alarmGrade": [], "handleUser": "", "handleStatus": [], "splitTime": "", "splitId": "", "currentPage": "1", "pageSize": "20", "page": "1", "orderType": "1", "orderDirection": "1" }' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": { "totalCount": "0", "pageData": [] } } ``` ### Lidar com alarmes **Tópico**: Permite **tratar (lidar com) um alarme específico**, registrando o status do tratamento, o usuário responsável, comentários e mensagens associadas ao processamento do evento. * Método: `POST /brms/api/v1.0/BRM/Alarm/HandleAlarm` * Headers: `X-Subject-Token` - Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{{Host}}/brms/api/v1.0/BRM/Alarm/HandleAlarm' --header 'X-Subject-Token: 5D047F5AA3B64E2Bac648cf7d411bae1' --header 'Content-Type: application/json' --header 'Cookie: Path=/; JSESSIONID=F43073C7368F2438635F52E6D56E94CE' --data '{ "data": { "alarmDate": "1691394961", "comment": "", "deviceCode": "", "handleStatus": "1", "handleMessage": "", "handleUser": "system", "alarmCode": "{F7C46B12-829E-4B28-B2E6-EC14F9CFCCDD}" } }' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": { "alarmCode": "F7C46B12-829E-4B28-B2E6-EC14F9CFCCDD", "handleStatus": "1", "handleUser": "system", "handleTime": "2026-01-21 15:08:42", "comment": "", "message": "Alarm handled successfully" } } ``` ### Obter informações sobre a lista de bloqueio de veículos relacionados a alarmes **Tópico**: Permite **consultar as informações de um alarme de veículo associado a uma lista de bloqueio (blacklist)**, retornando dados do veículo identificado, do evento de alarme e da base de bloqueio relacionada. (ativação do banco de dados de veículos) * Método: `POST /brms/api/v1.0/BRM/Alarm/GetAlarmCarBlacklistInfo` * Headers: `X-Subject-Token` - Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{{Host}}/brms/api/v1.0/BRM/Alarm/GetAlarmCarBlacklistInfo' --header 'X-Subject-Token: EEC0FF7F9761469Ca87f63ee05fc7ede' --header 'Content-Type: application/json' --header 'Cookie: Path=/; JSESSIONID=F43073C7368F2438635F52E6D56E94CE' --data '{ "data": { "alarmCode": "{85b8b20d-dd66-4f75-81bd-3fa2f8611bbd}" } }' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": { "alarmId": "85b8b20d-dd66-4f75-81bd-3fa2f8611bbd", "alarmCode": "CAR_BLACKLIST", "alarmName": "Veículo em Lista Negra", "alarmTime": "2026-01-21 14:32:18", "deviceCode": "CAM_001", "deviceName": "Câmera Portaria Principal", "channelId": "1", "plateNumber": "ABC1D23", "plateColor": "Azul", "vehicleType": "Carro", "vehicleBrand": "Toyota", "vehicleModel": "Corolla", "blacklistName": "Veículos Suspeitos", "blacklistReason": "Veículo com registro de furto", "confidence": 97.5, "captureImageUrl": "https://{{Host}}/images/alarm/plate_abc1d23.jpg", "fullImageUrl": "https://{{Host}}/images/alarm/scene_abc1d23.jpg", "status": "UNPROCESSED" } } ``` ### Obter informações sobre infrações de trânsito relacionadas a alarmes **Tópico**: Permite **consultar informações detalhadas de infrações de trânsito (peccancy)** associadas a um alarme de veículo, retornando dados do evento, do veículo identificado e do tipo de infração registrada. * Método: `POST /brms/api/v1.0/BRM/Alarm/GetAlarmCarPeccancyInfo` * Headers: `X-Subject-Token` - Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{{Host}}/brms/api/v1.0/BRM/Alarm/GetAlarmCarPeccancyInfo' --header 'X-Subject-Token: 0682487EF35B4D96a2364d12b0ed01e1' --header 'Content-Type: application/json' --header 'Cookie: Path=/; JSESSIONID=F43073C7368F2438635F52E6D56E94CE' --data '{ "data": { "alarmCode": "{fa3a211f-3df0-4123-984d-dc26091af709}" } }' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": null } ``` ### Obter detalhes do alarme de estacionamento com tempo limite na entrada e na saída **Tópico**: Permite consultar informações detalhadas de alarmes de veículos gerados em eventos de **entrada ou saída de estacionamento**, quando ocorre o **cruzamento de uma linha configurada**. * Método: `GET /brms/api/v1.1/alarm/record/entrance-parking-overtime/detail?alarmCode` * Headers: `X-Subject-Token` - Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{{Host}}/brms/api/v1.1/alarm/record/entrance-parking-overtime/detail?alarmCode=%7Bb6aeaab004bf48aa9c6aa64d473dd60b%7D' --header 'X-Subject-Token: 0682487EF35B4D96a2364d12b0ed01e1' --header 'Cookie: Path=/; JSESSIONID=F43073C7368F2438635F52E6D56E94CE' --data '' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": null } ``` ### Obter detalhes de alarmes de veículos **que não realizaram registro de entrada ou saída do local** **Tópico**: Permite consultar informações detalhadas de alarmes de veículos que não realizaram registro de entrada ou saída do local, associados a infrações de trânsito. * Método: `GET /brms/api/v1.1/alarm/record/entrance-none-enter-exit-record/detail?alarmCode` * Headers: `X-Subject-Token` - Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{{Host}}/brms/api/v1.1/alarm/record/entrance-parking-overtime/detail?alarmCode=%7Bb6aeaab004bf48aa9c6aa64d473dd60b%7D' --header 'X-Subject-Token: EEC0FF7F9761469Ca87f63ee05fc7ede' --header 'Cookie: Path=/; JSESSIONID=F43073C7368F2438635F52E6D56E94CE' --data '' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": null } ``` ### Obter detalhes do registro facial capturado durante o alarme **Tópico**: Permite **consultar informações detalhadas do registro facial capturado durante um evento de alarme**, retornando dados do evento, do dispositivo de captura e do rosto detectado (instantâneo facial). * Método: `POST /brms/api/v1.0/BRM/Alarm/GetAlarmFaceDetectionInfo` * Headers: `X-Subject-Token` - Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{{Host}}/brms/api/v1.0/BRM/Alarm/GetAlarmFaceDetectionInfo' --header 'X-Subject-Token: EEC0FF7F9761469Ca87f63ee05fc7ede' --header 'Content-Type: application/json' --header 'Cookie: Path=/; JSESSIONID=F43073C7368F2438635F52E6D56E94CE' --data '{ "data": { "alarmCode": "{1f4a86fd-d1c4-4777-ad8f-1659aa3f036b}", "alarmDate": "1691562669", "deviceCode": "1000003$1$0$1" } }' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": null } ``` ### Obter informações sobre reconhecimento facial relacionadas a alarmes **Tópico**: Permite **consultar informações detalhadas de reconhecimento facial associadas a um evento de alarme**, retornando dados do evento, do dispositivo de captura, da pessoa reconhecida (quando houver correspondência) e o nível de similaridade com o repositório facial. * Método: `POST /brms/api/v1.0/BRM/Alarm/GetAlarmFaceRecognitionInfo` * Headers: `X-Subject-Token` - Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{{Host}}/brms/api/v1.0/BRM/Alarm/GetAlarmFaceRecognitionInfo' --header 'X-Subject-Token: EEC0FF7F9761469Ca87f63ee05fc7ede' --header 'Content-Type: application/json' --header 'Cookie: Path=/; JSESSIONID=F43073C7368F2438635F52E6D56E94CE' --data '{ "data": { "alarmCode": "{1f4a86fd-d1c4-4777-ad8f-1659aa3f036b}", "alarmDate": "1691562669", "deviceCode": "1000000$1$0$0" } }' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": { "alarmCode": "{1f4a86fd-d1c4-4777-ad8f-1659aa3f036b}", "alarmTime": null, "name": null, "repositoryName": null, "personId": null, "personTypeName": null, "gender": null, "birthday": null, "nationality": null, "detectionImageUrl": null, "repositoryImageUrl": null, "similarity": null, "tel": null } ``` ### Obter informações sobre controle de acesso relacionadas a alarmes **Tópico**: Permite **consultar informações detalhadas de registros de controle de acesso associados a um evento de alarme**, retornando dados do evento, do dispositivo de captura, da pessoa identificada (quando houver) e o resultado do acesso. * Método: `POST /brms/api/v1.0/BRM/Alarm/GetAlarmAccessRecordInfo` * Headers: `X-Subject-Token` - Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{{Host}}/brms/api/v1.0/BRM/Alarm/GetAlarmAccessRecordInfo' --header 'X-Subject-Token: D67AFE4B2E4D485681fb2d06b20ec74d' --header 'Content-Type: application/json' --header 'Cookie: Path=/; JSESSIONID=F43073C7368F2438635F52E6D56E94CE' --data '{ "data": { "alarmCode": "{231da23_sd321as_23dsd12}", "alarmDate": "1691562669", "deviceCode": "1000000" } }' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": null } ``` ### Obter informações sobre a lista de bloqueio de veículos relacionados a alarmes na entrada e na saída **Tópico**: Permite **consultar informações detalhadas de alarmes de veículos vinculados à lista de bloqueio** em eventos de **entrada ou saída**, retornando dados do evento, do veículo identificado, do ponto de acesso e do motivo do bloqueio. * Método: `GET /brms/api/v1.1/alarm/record/entrance-block-roster/detail?alarmCode` * Headers: `X-Subject-Token` - Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{{Host}}/brms/api/v1.1/alarm/record/entrance-block-roster/detail?alarmCode=%7B85b8b20d-dd66-4f75-81bd-3fa2f8611bbd%7D' --header 'X-Subject-Token: D67AFE4B2E4D485681fb2d06b20ec74d' --header 'Cookie: Path=/; JSESSIONID=F43073C7368F2438635F52E6D56E94CE' --data '' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": null } ``` ### Obter detalhes sobre o alarme de estacionamento na entrada e na saída **Tópico**: Permite consultar informações detalhadas de alarmes de veículos gerados em eventos de **entrada ou saída de estacionamento**, quando ocorre o **cruzamento de uma linha configurada.** * Método: `GET /brms/api/v1.1/alarm/record/entrance-parking-cross-line/detail?alarmCode` * Headers: `X-Subject-Token` - Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{{Host}}/brms/api/v1.1/alarm/record/entrance-parking-cross-line/detail?alarmCode=%7B85b8b20d-dd66-4f75-81bd-3fa2f8611bbd%7D' --header 'X-Subject-Token: D67AFE4B2E4D485681fb2d06b20ec74d' --header 'Cookie: Path=/; JSESSIONID=F43073C7368F2438635F52E6D56E94CE' --data '' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": { "alarmId": "85b8b20d-dd66-4f75-81bd-3fa2f8611bbd", "alarmName": "Veículo Cruzou Linha Proibida", "alarmTime": "2026-01-21 21:03:29", "deviceCode": "CAM_018", "deviceName": "Câmera Estacionamento Subsolo", "channelId": "1", "plateNumber": "ABC1D23", "plateColor": "Branca", "vehicleType": "Carro", "vehicleBrand": "Hyundai", "vehicleModel": "HB20", "crossLineType": "FORBIDDEN_LINE", "direction": "IN", "confidence": 98.4, "captureImageUrl": "https://{{Host}}/images/alarm/crossline_abc1d23.jpg", "status": "UNPROCESSED" } } ``` ### Obtenha detalhes sobre como ativar o alarme do veículo **Tópico**: Permite consultar informações detalhadas de alarmes de veículos gerados durante o monitoramento (*survey vehicle*), normalmente associados a eventos de entrada ou saída de estacionamento ou ao cruzamento de uma linha configurada. * Método: `GET /brms/api/v1.1/alarm/record/survey-vehicle/detail?alarmCode` * Headers: `X-Subject-Token` - Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{{Host}}/brms/api/v1.1/alarm/record/survey-vehicle/detail?alarmCode=%7B85b8b20d-dd66-4f75-81bd-3fa2f8611bbd%7D' --header 'X-Subject-Token: 0682487EF35B4D96a2364d12b0ed01e1' --header 'Cookie: Path=/; JSESSIONID=F43073C7368F2438635F52E6D56E94CE' --data '' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": { "plateNo": "", "vehicleType": null, "vehicleColor": "", "vehicleBrand": "", "vehiclePicture": null, "plateNoPicture": null } } ``` ### Obtenha os detalhes do alarme da entrada e da saída **Tópico**: Permite consultar informações detalhadas de alarmes de veículos gerados em eventos de **entrada ou saída de estacionamento**, quando ocorre o **cruzamento de uma linha configurada**. * Método: `GET /brms/api/v1.1/alarm/record/entrance/detail?alarmCode` * Headers: `X-Subject-Token` - Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{{Host}}/brms/api/v1.1/alarm/record/entrance/detail?alarmCode=%7B85b8b20d-dd66-4f75-81bd-3fa2f8611bbd%7D' --header 'X-Subject-Token: 0682487EF35B4D96a2364d12b0ed01e1' --header 'Cookie: JSESSIONID=F43073C7368F2438635F52E6D56E94CE' --data '' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": { "alarmId": "85b8b20d-dd66-4f75-81bd-3fa2f8611bbd", "alarmName": "Alarme de Entrada/Saída de Veículo", "alarmTime": "2026-01-21 21:03:29", "deviceCode": "CAM_018", "deviceName": "Câmera Entrada Estacionamento", "channelId": "1", "direction": "IN", "plateNumber": "ABC1D23", "plateColor": "Branca", "vehicleType": "Carro", "vehicleBrand": "Hyundai", "vehicleModel": "HB20", "confidence": 98.4, "captureImageUrl": "https://{{Host}}/images/alarm/entrance_abc1d23.jpg", "status": "UNPROCESSED" } } ``` ### Obter lista dos tipos de alarme **Tópico**: Permite consultar informações detalhadas de alarmes de veículos gerados em eventos de **entrada ou saída de estacionamento**, quando ocorre o **cruzamento de uma linha configurada**. * Método: `GET /brms/api/v1.1/alarm/plan/alarm-type/list` * Headers: `X-Subject-Token` - Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{{Host}}/brms/api/v1.1/alarm/plan/alarm-type/list' --header 'X-Subject-Token: D67AFE4B2E4D485681fb2d06b20ec74d' --header 'Cookie: Path=/; JSESSIONID=F43073C7368F2438635F52E6D56E94CE' --data '' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": { "results": [ { "sourceTypeId": "1", "sourceTypeName": "Device", "groups": [ { "groupId": "101", "groupName": "Common Device Alarm", "alarmTypes": [ { "alarmTypeId": "16", "alarmTypeName": "Device Disconnected", "icon": null, "allowDelete": null, "eventSourceType": null, "siaSupportMode": "3" } ] } ``` *** Notas finais: * Todos os endpoints seguem o **padrão de resposta**, onde `code = 1000` indica sucesso. * Utilize sempre o header **`X-Subject-Token`** com um token válido obtido no processo de login. * Substitua corretamente as variáveis **`{{Host}}`**, **`{{loginToken}}`** e demais parâmetros antes da execução. * Respeite o formato **JSON** e o header **`Content-Type: application/json;charset=UTF-8`**. * Verifique **fuso horário** e **paginação** nos endpoints que utilizam `displayServerTimezoneOffset`, `page` e `pageSize`. * Em caso de erro, valide primeiro a **autenticação**, os **parâmetros obrigatórios** e o **formato da requisição**. *** --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://portal-integracao.intelbras.com.br/defense-ia-and-lite/readme/gestao-de-alarmes.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.