Voice API

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

A API do Voice é 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, BSP e IA, a API do Voice 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, BSP 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

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.