> For the complete documentation index, see [llms.txt](https://docs.fortics.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fortics.com.br/chat-center-api-reference/reference/agents.md).

# Agents

## Atualizar dados do agente

> Atualiza dados do agente conforme os dados enviados.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"schemas":{"UpdateAgentRequest":{"type":"object","properties":{"name":{"type":"string"},"ramal":{"type":"integer"},"password":{"type":"string"},"new_password":{"type":"string"},"default_language":{"type":"string"}}},"GenericSuccessResponse":{"type":"object","additionalProperties":true},"ValidationErrorResponse":{"type":"object","properties":{"status":{"type":"boolean"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}},"ValidationError":{"description":"Erro de validação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}}}},"paths":{"/v4/user/agents/update":{"put":{"tags":["Agents"],"summary":"Atualizar dados do agente","description":"Atualiza dados do agente conforme os dados enviados.","operationId":"putV4UserAgentsUpdate","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAgentRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"},"422":{"$ref":"#/components/responses/ValidationError"}}}}}}
```

## Listar agentes online

> Retorna agentes online conforme filtros enviados.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agents/online":{"get":{"tags":["Agents"],"summary":"Listar agentes online","description":"Retorna agentes online conforme filtros enviados.","operationId":"getV4UserAgentsOnline","parameters":[{"in":"query","name":"paginate","schema":{"type":"boolean"},"description":"Paginar resultados."},{"in":"query","name":"allUsers","schema":{"type":"boolean"},"description":"Listar todos os usuários."}],"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Login do agente

> Processa a solicitação de login do agente e retorna o resultado.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agents/login":{"post":{"tags":["Agents"],"summary":"Login do agente","description":"Processa a solicitação de login do agente e retorna o resultado.","operationId":"postV4UserAgentsLogin","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Logout do agente

> Processa a solicitação de logout do agente e retorna o resultado.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agents/logout":{"post":{"tags":["Agents"],"summary":"Logout do agente","description":"Processa a solicitação de logout do agente e retorna o resultado.","operationId":"postV4UserAgentsLogout","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Campanhas disponíveis para o agente

> Processa a solicitação de campanhas disponíveis para o agente e retorna o resultado.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agents/campaigns":{"get":{"tags":["Agents"],"summary":"Campanhas disponíveis para o agente","description":"Processa a solicitação de campanhas disponíveis para o agente e retorna o resultado.","operationId":"getV4UserAgentsCampaigns","responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Média de notas do agente

> Processa a solicitação de média de notas do agente e retorna o resultado.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agents/grades":{"get":{"tags":["Agents"],"summary":"Média de notas do agente","description":"Processa a solicitação de média de notas do agente e retorna o resultado.","operationId":"getV4UserAgentsGrades","responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Ativar ou desativar campanha do agente

> Alterna campanha do agente conforme o estado informado.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agents/toggle/campaign":{"post":{"tags":["Agents"],"summary":"Ativar ou desativar campanha do agente","description":"Alterna campanha do agente conforme o estado informado.","operationId":"postV4UserAgentsToggleCampaign","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"campaign_id":{"type":"string"}},"required":["campaign_id"]}}}},"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Listar atendimentos do agente

> Retorna atendimentos do agente conforme filtros enviados.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agents/attendances":{"get":{"tags":["Agents"],"summary":"Listar atendimentos do agente","description":"Retorna atendimentos do agente conforme filtros enviados.","operationId":"getV4UserAgentsAttendances","responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Listar atendimentos do agente (com paginação)

> Retorna atendimentos do agente conforme filtros enviados.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agents/attendances_plus":{"get":{"tags":["Agents"],"summary":"Listar atendimentos do agente (com paginação)","description":"Retorna atendimentos do agente conforme filtros enviados.","operationId":"getV4UserAgentsAttendancesPlus","parameters":[{"in":"query","name":"name","schema":{"type":"string"},"description":"Filtro por nome."},{"in":"query","name":"paginateAttendance","schema":{"type":"boolean"}},{"in":"query","name":"pageAttendance","schema":{"type":"integer","minimum":1}},{"in":"query","name":"paginateWait","schema":{"type":"boolean"}},{"in":"query","name":"pageWait","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Listar sessões em atendimento

> Retorna sessões em atendimento conforme filtros enviados.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agents/sessions/attendances":{"get":{"tags":["Agents"],"summary":"Listar sessões em atendimento","description":"Retorna sessões em atendimento conforme filtros enviados.","operationId":"getV4UserAgentsSessionsAttendances","parameters":[{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"paginate","schema":{"type":"boolean"}},{"in":"query","name":"page","schema":{"type":"integer","minimum":1}},{"in":"query","name":"contact_plus","schema":{"type":"boolean"}}],"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Listar sessões em espera

> Retorna sessões em espera conforme filtros enviados.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agents/sessions/waits":{"get":{"tags":["Agents"],"summary":"Listar sessões em espera","description":"Retorna sessões em espera conforme filtros enviados.","operationId":"getV4UserAgentsSessionsWaits","parameters":[{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"paginate","schema":{"type":"boolean"}},{"in":"query","name":"page","schema":{"type":"integer","minimum":1}},{"in":"query","name":"contact_plus","schema":{"type":"boolean"}}],"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Listar pausas ativas

> Retorna pausas ativas conforme filtros enviados.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agents/pauses":{"get":{"tags":["Agents"],"summary":"Listar pausas ativas","description":"Retorna pausas ativas conforme filtros enviados.","operationId":"getV4UserAgentsPauses","responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Iniciar pausa

> Inicia pausa com os dados informados.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"schemas":{"PauseStartRequest":{"type":"object","required":["pause_id"],"properties":{"pause_id":{"type":"string"},"isPausePersonalized":{"type":"boolean"}}},"GenericSuccessResponse":{"type":"object","additionalProperties":true},"ValidationErrorResponse":{"type":"object","properties":{"status":{"type":"boolean"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}},"ValidationError":{"description":"Erro de validação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}}}},"paths":{"/v4/user/agents/pauses/start":{"post":{"tags":["Agents"],"summary":"Iniciar pausa","description":"Inicia pausa com os dados informados.","operationId":"postV4UserAgentsPausesStart","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PauseStartRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"},"422":{"$ref":"#/components/responses/ValidationError"}}}}}}
```

## Encerrar pausa

> Encerra pausa conforme a sessão informada.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agents/pauses/stop":{"post":{"tags":["Agents"],"summary":"Encerrar pausa","description":"Encerra pausa conforme a sessão informada.","operationId":"postV4UserAgentsPausesStop","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Evento de timeout de pausa

> Processa a solicitação de evento de timeout de pausa e retorna o resultado.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agents/pauses/timeout/event/admin":{"post":{"tags":["Agents"],"summary":"Evento de timeout de pausa","description":"Processa a solicitação de evento de timeout de pausa e retorna o resultado.","operationId":"postV4UserAgentsPausesTimeoutEventAdmin","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Buscar pausa em progresso

> Pesquisa pausa em progresso conforme critérios enviados.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agents/pauses/progress":{"get":{"tags":["Agents"],"summary":"Buscar pausa em progresso","description":"Pesquisa pausa em progresso conforme critérios enviados.","operationId":"getV4UserAgentsPausesProgress","responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Listar mensagens do chat do agente

> Retorna mensagens do chat do agente conforme filtros enviados.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agents/messages":{"get":{"tags":["Agents"],"summary":"Listar mensagens do chat do agente","description":"Retorna mensagens do chat do agente conforme filtros enviados.","operationId":"getV4UserAgentsMessages","responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Enviar mensagem do chat do agente

> Envia mensagem do chat do agente com os dados informados.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agents/messages/send":{"post":{"tags":["Agents"],"summary":"Enviar mensagem do chat do agente","description":"Envia mensagem do chat do agente com os dados informados.","operationId":"postV4UserAgentsMessagesSend","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Marcar mensagens como lidas (chat)

> Marca mensagens como lidas conforme os parâmetros informados.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agents/messages/read/{agent_id}":{"get":{"tags":["Agents"],"summary":"Marcar mensagens como lidas (chat)","description":"Marca mensagens como lidas conforme os parâmetros informados.","operationId":"getV4UserAgentsMessagesRead","parameters":[{"in":"path","name":"agent_id","required":true,"schema":{"type":"string"},"description":"ID do agente."}],"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Mensagens pendentes (chat)

> Processa a solicitação de mensagens pendentes e retorna o resultado.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agents/messages/pending":{"post":{"tags":["Agents"],"summary":"Mensagens pendentes (chat)","description":"Processa a solicitação de mensagens pendentes e retorna o resultado.","operationId":"postV4UserAgentsMessagesPending","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Limite de upload do agente

> Processa a solicitação de limite de upload do agente e retorna o resultado.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agents/uploadLimit":{"get":{"tags":["Agents"],"summary":"Limite de upload do agente","description":"Processa a solicitação de limite de upload do agente e retorna o resultado.","operationId":"getV4UserAgentsUploadLimit","responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Listar copilot

> Retorna copilot conforme filtros enviados.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agent/copilot/list":{"get":{"tags":["Agents"],"summary":"Listar copilot","description":"Retorna copilot conforme filtros enviados.","operationId":"getV4UserAgentCopilotList","responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Executar copilot

> Processa a solicitação de executar copilot e retorna o resultado.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agent/copilot/execute":{"post":{"tags":["Agents"],"summary":"Executar copilot","description":"Processa a solicitação de executar copilot e retorna o resultado.","operationId":"postV4UserAgentCopilotExecute","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Obter dados WebRTC

> Recupera dados WebRTC.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agent/webrtc/{id}":{"get":{"tags":["Agents"],"summary":"Obter dados WebRTC","description":"Recupera dados WebRTC.","operationId":"getV4UserAgentWebrtc","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"ID do agente ou sessão."}],"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Listar placeholders

> Retorna placeholders conforme filtros enviados.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/user/agent/placeholders":{"post":{"tags":["Agents"],"summary":"Listar placeholders","description":"Retorna placeholders conforme filtros enviados.","operationId":"postV4UserAgentPlaceholders","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Traduzir mensagem

> Processa a solicitação de traduzir mensagem e retorna o resultado.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"schemas":{"TranslateMessageRequest":{"type":"object","required":["language","message"],"properties":{"language":{"type":"string"},"message":{"type":"string"},"session_id":{"type":"string"},"message_id":{"type":"string"}}},"GenericSuccessResponse":{"type":"object","additionalProperties":true},"ValidationErrorResponse":{"type":"object","properties":{"status":{"type":"boolean"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}},"ValidationError":{"description":"Erro de validação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}}}},"paths":{"/v4/user/agent/stt/translate":{"post":{"tags":["Agents"],"summary":"Traduzir mensagem","description":"Processa a solicitação de traduzir mensagem e retorna o resultado.","operationId":"postV4UserAgentSttTranslate","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"},"422":{"$ref":"#/components/responses/ValidationError"}}}}}}
```

## Detectar idioma

> Processa a solicitação de detectar idioma e retorna o resultado.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"schemas":{"DetectLanguageRequest":{"type":"object","required":["message","contact_id"],"properties":{"message":{"type":"string"},"contact_id":{"type":"string"}}},"GenericSuccessResponse":{"type":"object","additionalProperties":true},"ValidationErrorResponse":{"type":"object","properties":{"status":{"type":"boolean"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}},"ValidationError":{"description":"Erro de validação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}}}},"paths":{"/v4/user/agent/stt/translate/detect":{"post":{"tags":["Agents"],"summary":"Detectar idioma","description":"Processa a solicitação de detectar idioma e retorna o resultado.","operationId":"postV4UserAgentSttDetect","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetectLanguageRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"},"422":{"$ref":"#/components/responses/ValidationError"}}}}}}
```

## Ativar/desativar auto tradução

> Alterna auto tradução conforme o estado informado.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"schemas":{"ToggleAutoTranslateRequest":{"type":"object","required":["session_id"],"properties":{"session_id":{"type":"string"}}},"GenericSuccessResponse":{"type":"object","additionalProperties":true},"ValidationErrorResponse":{"type":"object","properties":{"status":{"type":"boolean"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}},"ValidationError":{"description":"Erro de validação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}}}},"paths":{"/v4/user/agent/stt/translate/activeAutoTranslate":{"post":{"tags":["Agents"],"summary":"Ativar/desativar auto tradução","description":"Alterna auto tradução conforme o estado informado.","operationId":"postV4UserAgentSttActiveAutoTranslate","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToggleAutoTranslateRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"},"422":{"$ref":"#/components/responses/ValidationError"}}}}}}
```

## Realizar chamada para contato

> Processa a solicitação de realizar chamada para contato e retorna o resultado.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"schemas":{"ClickToCallRequest":{"type":"object","required":["contact_id"],"properties":{"contact_id":{"type":"string"},"whatsapp":{"type":"boolean"}}},"GenericSuccessResponse":{"type":"object","additionalProperties":true},"ValidationErrorResponse":{"type":"object","properties":{"status":{"type":"boolean"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}},"ValidationError":{"description":"Erro de validação.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}}}},"paths":{"/v4/user/agent/call":{"post":{"tags":["Agents"],"summary":"Realizar chamada para contato","description":"Processa a solicitação de realizar chamada para contato e retorna o resultado.","operationId":"postV4UserAgentCall","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClickToCallRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"},"422":{"$ref":"#/components/responses/ValidationError"}}}}}}
```

## Listar agentes

> Retorna agentes conforme filtros enviados.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/agents":{"get":{"tags":["Agents"],"summary":"Listar agentes","description":"Retorna agentes conforme filtros enviados.","operationId":"getV4Agents","responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Criar agente

> Cria agente com os dados enviados.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/agents":{"post":{"tags":["Agents"],"summary":"Criar agente","description":"Cria agente com os dados enviados.","operationId":"postV4Agents","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Buscar agente por e-mail

> Pesquisa agente por e-mail conforme critérios enviados.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}},"NotFound":{"description":"Não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"},"status":{"type":"boolean"},"code":{"type":"string"}}}}},"paths":{"/v4/agents/email/{email}":{"get":{"tags":["Agents"],"summary":"Buscar agente por e-mail","description":"Pesquisa agente por e-mail conforme critérios enviados.","operationId":"getV4AgentsByEmail","parameters":[{"in":"path","name":"email","required":true,"schema":{"type":"string","format":"email"}}],"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
```

## Resumo de agentes

> Processa a solicitação de resumo de agentes e retorna o resultado.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/agents/summary":{"get":{"tags":["Agents"],"summary":"Resumo de agentes","description":"Processa a solicitação de resumo de agentes e retorna o resultado.","operationId":"getV4AgentsSummary","responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Detalhar agente

> Recupera os dados de agente identificado no caminho.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/agents/{id}":{"get":{"tags":["Agents"],"summary":"Detalhar agente","description":"Recupera os dados de agente identificado no caminho.","operationId":"getV4AgentsById","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Atualizar agente

> Atualiza agente conforme os dados enviados.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/agents/{id}":{"put":{"tags":["Agents"],"summary":"Atualizar agente","description":"Atualiza agente conforme os dados enviados.","operationId":"putV4AgentsById","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Remover agente

> Remove agente identificado no caminho.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/agents/{id}":{"delete":{"tags":["Agents"],"summary":"Remover agente","description":"Remove agente identificado no caminho.","operationId":"deleteV4AgentsById","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```

## Atualizar foto do agente

> Atualiza foto do agente conforme os dados enviados.

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"servers":[{"url":"/api","description":"Base da API"}],"security":[{"JwtAuth":[]}],"components":{"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token JWT no header Authorization."}},"responses":{"GenericSuccess":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericSuccessResponse"}}}}},"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}},"paths":{"/v4/agents/photo":{"post":{"tags":["Agents"],"summary":"Atualizar foto do agente","description":"Atualiza foto do agente conforme os dados enviados.","operationId":"postV4AgentsPhoto","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"photo":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"$ref":"#/components/responses/GenericSuccess"}}}}}}
```


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.fortics.com.br/chat-center-api-reference/reference/agents.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.