> 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/api-inc-cloud/alarmes.md). # Alarmes Tipos de alarme configuráveis e histórico de alarmes disparados ## Obter tipos de alarme configuráveis > Retorna o catálogo de tipos de alarme suportados pela plataforma (ex.: uso de CPU, dispositivo\ > offline, canal de rádio congestionado), com seus parâmetros de configuração padrão e nível de\ > severidade.
```json {"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Alarmes","description":"Tipos de alarme configuráveis e histórico de alarmes disparados"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/alarm/list":{"get":{"tags":["Alarmes"],"summary":"Obter tipos de alarme configuráveis","description":"Retorna o catálogo de tipos de alarme suportados pela plataforma (ex.: uso de CPU, dispositivo\noffline, canal de rádio congestionado), com seus parâmetros de configuração padrão e nível de\nseveridade.\n","parameters":[{"name":"user_name","in":"query","required":true,"schema":{"type":"string"}},{"name":"locale","in":"query","required":true,"description":"Idioma da resposta. Envie `en` para receber textos em inglês.","schema":{"type":"string","enum":["en"]}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","description":"Identificador interno do tipo de alarme."},"typeNumber":{"type":"integer"},"processMark":{"type":"integer"},"name":{"type":"string"},"name_en":{"type":"string"},"level":{"type":"integer","description":"Nível de severidade do alarme."},"detail":{"type":"string"},"detail_en":{"type":"string"},"confData":{"type":"object","nullable":true,"description":"Parâmetros configuráveis desse tipo de alarme (varia conforme o tipo)."},"groupId":{"type":"integer"},"groupName":{"type":"string"},"groupName_en":{"type":"string"},"sms":{"type":"integer","nullable":true},"defaultValue":{"type":"object","nullable":true,"description":"Valor padrão dos parâmetros configuráveis."},"regionSupport":{"type":"integer","nullable":true}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"listAlarmTypes"}}}} ``` ## Obter histórico de alarmes disparados > Retorna o histórico de alarmes disparados na conta, com suporte a filtros (site, dispositivo,\ > tipo, nível, status, período) e paginação. Envie \`{}\` no corpo para listar sem filtro adicional.
```json {"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Alarmes","description":"Tipos de alarme configuráveis e histórico de alarmes disparados"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/alarm/history/list":{"post":{"tags":["Alarmes"],"summary":"Obter histórico de alarmes disparados","description":"Retorna o histórico de alarmes disparados na conta, com suporte a filtros (site, dispositivo,\ntipo, nível, status, período) e paginação. Envie `{}` no corpo para listar sem filtro adicional.\n","parameters":[{"name":"user_name","in":"query","required":true,"schema":{"type":"string"}},{"name":"locale","in":"query","required":true,"description":"Idioma da resposta. Envie `en` para receber textos em inglês.","schema":{"type":"string","enum":["en"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Todos os campos são filtros opcionais; envie `{}` para não filtrar.","properties":{"start":{"type":"integer","description":"Página inicial (1-based)."},"size":{"type":"integer","description":"Quantidade de itens por página."},"level":{"type":"integer","description":"Filtro por nível de severidade."},"levels":{"type":"array","items":{"type":"integer"}},"status":{"type":"integer","description":"Filtro por status do alarme (ex.: ativo/limpo)."},"alarmTypeName":{"type":"string"},"alarmTypeName_en":{"type":"string"},"alarmTypeList":{"type":"array","items":{"type":"string"}},"shopName":{"type":"string"},"shopIds":{"type":"array","items":{"type":"integer"}},"devSn":{"type":"string"},"devName":{"type":"string"},"devType":{"type":"string"},"detail":{"type":"string"},"detail_en":{"type":"string"},"regionName":{"type":"string"},"alarmTime":{"type":"integer","format":"int64"},"clearTime":{"type":"integer","format":"int64"},"startTime":{"type":"integer","format":"int64","description":"Início do período de busca (timestamp em ms)."},"endTime":{"type":"integer","format":"int64","description":"Fim do período de busca (timestamp em ms)."},"timeType":{"type":"string"},"order":{"type":"string"},"sort":{"type":"string","description":"Direção da ordenação (ex.: `asc`/`desc`)."}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"object","properties":{"count":{"type":"integer","description":"Total de alarmes encontrados."},"todayNotClearedCount":{"type":"integer","description":"Alarmes não resolvidos disparados hoje."},"historyList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"integer"},"userName":{"type":"string"},"shopId":{"type":"integer"},"shopName":{"type":"string"},"level":{"type":"integer"},"alarmTime":{"type":"integer","format":"int64","description":"Timestamp (ms) em que o alarme foi disparado."},"alarmValue":{"type":"number","nullable":true},"status":{"type":"integer","description":"1 = ativo, 0 = limpo."},"clearTime":{"type":"integer","format":"int64","nullable":true},"alarmTypeName":{"type":"string"},"alarmTypeName_en":{"type":"string"},"alarmType":{"type":"string"},"alarmTypeNumber":{"type":"integer"},"message":{"type":"string"},"message_en":{"type":"string"},"devType":{"type":"string"},"devSn":{"type":"string"},"devName":{"type":"string"},"readStatus":{"type":"integer","description":"1 = lido, 0 = não lido."},"remark":{"type":"string"},"regionId":{"type":"integer","nullable":true},"regionName":{"type":"string","nullable":true},"expireTime":{"type":"integer","format":"int64","description":"Timestamp (ms) em que o registro expira/é removido do histórico."}}}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"listAlarmHistory"}}}} ``` --- # 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/api-inc-cloud/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.