> 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/voice-api-reference/readme.md).

# Voz API

API para gerenciamento de chamadas e recursos de voz integrada ao ecossistema omnichannel Fortics.

A API do **Voz** é o módulo de voz do ecossistema Fortics, desenvolvido para potencializar a comunicação da sua empresa com recursos avançados de telefonia VoIP.

Com ela, você cadastra recursos de voz, cria fluxos inteligentes de atendimento, realiza click-to-call e muito mais — tudo de forma simples, escalável e segura.

Totalmente integrada aos módulos de Chat Center, Channel Conect e IA, a API do Voz permite desenvolver experiências omnichannel completas, unificando comunicação e inteligência em uma única plataforma.

### Visão geral

* Padrão OpenAPI 3.0.0.
* Foco em chamadas e recursos de voz (telefonia VoIP) no ecossistema Fortics.
* A API integra os módulos de Chat Center, Channel Conect e IA para cenários omnichannel.
* Formatos aceitos: `application/json` e `multipart/form-data` (quando aplicável).

### Base URL

* Base path: `https://{host}/v1/pbx/`.
* O host varia por ambiente.

### Autenticação

* Esquema: HTTP Basic Authentication.
* O header `Authorization` usa o esquema `Basic`.

### Como obter a API Key

Esta API utiliza autenticação HTTP Basic, baseado nas credenciais de um agente da plataforma.

### Principais recursos

* Cadastro e gerenciamento de recursos de voz (cadastro de agentes/equipes, desvio de chamadas, cadastro de operadoras/rotas).
* Criação e gerenciamento de URAs/fluxos.
* Execução de chamadas via click-to-call.
* Aplicação de pausas/tabulações.

### Exemplos rápidos

#### Click-to-call

```bash
curl -X POST "https://{host}/v1/pbx/click2call" \
  -u "{username}:{password}" \
  -H "Content-Type: application/json" \
  -d '{
    "src": "1000",
    "dst": "5511999999999",
    "ringTime": 30,
    "whatsapp": false
  }'
```

### Códigos de resposta comuns

Os endpoints retornam códigos HTTP padrão. A spec OpenAPI define os códigos e schemas por operação.

### Boas práticas

* Definir `Content-Type: application/json` em requisições com corpo JSON.
* Para uploads, usar `multipart/form-data` quando o endpoint exigir arquivo.


---

# 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/voice-api-reference/readme.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.