> 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/video-porteiro.md).

# Vídeo Porteiro

Guia de integração com o Vídeo Porteiro (VTalk) para consultar histórico de chamadas (call logs) por dispositivo e intervalo de tempo, com autenticação, paginação, erros comuns e exemplo curl.

### Como usar:

* Substitua as variáveis `{{host}}`, `{{loginToken}}` e demais identificadores pelos valores reais do ambiente.
* Utilize variáveis globais do seu projeto quando disponíveis para evitar hardcode.
* Ajuste parâmetros de query conforme o cenário (paginação, filtros, IDs).
* Campos JSON opcionais podem ser removidos ou adicionados sem alterar a estrutura base.
* Sempre valide os tipos esperados pelo backend antes de enviar requisições em lote.

***

### 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}}/iams/api/v1.1`

***

### Erros comuns (modelo):

| Situação                   |                       Sintoma | Como resolver                             |
| -------------------------- | ----------------------------: | ----------------------------------------- |
| Token ausente/expirado     |                         `401` | Refaça login e atualize `X-Subject-Token` |
| Content-Type incorreto     |  `415 Unsupported Media Type` | Use `application/json;charset=UTF-8`      |
| Campos obrigatórios vazios | `400` / mensagem de validação | Revise a seção **Parâmetros** do endpoint |

***

### Obter Histórico de Chamadas Por Dispositivo

**Tópico**: Realiza a consulta de registros de chamadas (call logs) de um ou mais dispositivos dentro de um intervalo de tempo especificado.

* Método: `POST /obms/api/v1.0/vtalk/callLogList`
* Headers: `X-Subject-Token`, `Content-Type`

Exemplo (curl):

```bash
curl --location 'https://{{Host}}/obms/api/v1.0/vtalk/callLogList' 
--header 'X-Subject-Token: 2C226604724B4874b47f17f492cbc098' 
--header 'Content-Type: application/json' 
--header 'Cookie: Path=/' 
--data '{
    "callEndTime": "1558627199",
    "callStartTime": "1556640000",
    "deviceCodes": [
        "1000001"
    ],
    "page": 1,
    "pagesize": 20,
    "currentPage": 0,
    "splitId": 0,
    "splitTime": ""
}
```

Resposta (modelo – sucesso):

```json
{
    "code": 2134,
    "desc": "The user does not have permissions of the device.",
    "data": null
}
```

***

Notas Finais:

* Sempre confirme que o **X-Subject-Token** está válido e não expirado antes de realizar a requisição.
* Verifique se o usuário autenticado possui permissão de acesso aos dispositivos informados em `deviceCodes`.
* Certifique-se de que os timestamps (`callStartTime` e `callEndTime`) estejam no formato **Unix (segundos)** e que o intervalo seja válido.
* Ajuste corretamente os parâmetros de paginação (`page`, `pagesize`) para evitar retorno vazio ou sobrecarga desnecessária.
* Campos como `currentPage`, `splitId` e `splitTime` devem ser utilizados apenas quando exigidos pelo cenário; caso contrário, podem ser omitidos.
* Em caso de retorno diferente de `code: 1000`, implemente tratamento de erro com log detalhado para facilitar a análise.
* Evite hardcode de tokens, host ou identificadores sensíveis; utilize variáveis de ambiente.
* Sempre valide a estrutura do JSON antes do envio para prevenir erros de formatação.
* Em ambientes produtivos, priorize comunicação segura (HTTPS) e controle adequado de permissões por perfil de usuário.

***


---

# 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/video-porteiro.md?ask=<question>&goal=<user_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.