Syscall Proxy API - Documentação

API intermediária para comunicação com o Syscall CRM Revo

Configuração de Teste

PROXY_SECRET

Este valor é necessário para autenticar suas requisições ao proxy

Configuração

Base URL: https://syscall.ybrasil.com.br

Variáveis de Ambiente:

SYSCALL_BASE_URL: https://maxfama.syscall.com.br
PROXY_SECRET: Chave secreta para autenticar o middleware

Autenticação:

Header: x-proxy-secret (obrigatório em todas as requisições)
Header: Authorization Bearer token (necessário em campanhas e operações autenticadas)

Autenticação

GET /api/auth/login

Realiza login do agente no sistema

Agente

Ramal

Token

Query Parameters:

agente (string, obrigatório): ID do agente
ramal (string, obrigatório): Número do ramal
token (string, obrigatório): Token de autenticação

Exemplo de requisição:

curl -X GET "https://syscall.ybrasil.com.br/api/auth/login?agente=00003&ramal=9102&token=seu_token" \
  -H "x-proxy-secret: SEU_PROXY_SECRET"

Campanhas

POST /api/campaign/new

Cria uma nova campanha

Nome

Operadores[] (separados por vírgula)

Rotas Selecionadas[] (separadas por vírgula)

Agressividade

CX Postal

Token (Authorization)

Headers:

Authorization: Bearer {token}
Content-Type: multipart/form-data
x-proxy-secret: SEU_PROXY_SECRET

Body (FormData):

nome: string
operadores[]: array de IDs
rotas_selecionadas[]: array de IDs de rotas
agressividade: number (1-10)
cxpostal: boolean (true/false)

Exemplo cURL:

curl -X POST "https://syscall.ybrasil.com.br/api/campaign/new" \
  -H "x-proxy-secret: SEU_PROXY_SECRET" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -F "nome=Campanha Teste" \
  -F "operadores[]=00003" \
  -F "rotas_selecionadas[]=9" \
  -F "agressividade=2" \
  -F "cxpostal=false"

POST /api/campaign/edit

Edita uma campanha existente

ID Campanha

Nome

Operadores[]

Rotas Selecionadas[]

Agressividade

CX Postal

Token

POST /api/campaign/status

Controla o status de uma campanha (play/pause/stop)

ID Campanha

Status (play/pause/stop)

Body (FormData):

id_campanha: string
status: string (play | pause | stop)

POST /api/campaign/upload

Faz upload de arquivo CSV com contatos para campanha

Headers:

Authorization: Bearer {token}
Content-Type: multipart/form-data
x-proxy-secret: SEU_PROXY_SECRET

Body (FormData):

id_campanha: string
planilha: arquivo CSV

Exemplo cURL:

curl -X POST "https://syscall.ybrasil.com.br/api/campaign/upload" \
  -H "x-proxy-secret: SEU_PROXY_SECRET" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -F "id_campanha=1528" \
  -F "planilha=@/caminho/arquivo.csv"

Chamadas

POST /api/call/start

Inicia uma ligação

Agente

Telefone

Token

Body (URLEncoded):

agente: string
telefone: string

POST /api/call/hangup

Encerra uma ligação

Agente

Token

Body (URLEncoded):

agente: string

POST /api/call/acionamento

Registra o resultado de uma ligação

Agente

Contrato

Telefone

Data

ID Resultado

Observação

Token

Body (URLEncoded):

agente: string
contrato: string
telefone: string
data: string (formato: YYYY-MM-DD HH:MM:SS)
id_resultado: string
observacao: string

Agentes

POST /api/agent/pause

Pausa um agente

Agente

ID Pausa

Token

Body (URLEncoded):

agente: string
id_pausa: string

POST /api/agent/unpause

Remove a pausa de um agente

Agente

Token

Body (URLEncoded):

agente: string

Áudio

GET /api/audio

Download de gravação de áudio

ID Ligação

Token

Query Parameters:

idligacao (string, obrigatório): ID da ligação
token (string, obrigatório): Token de autenticação

Exemplo cURL:

curl -X GET "https://syscall.ybrasil.com.br/api/audio?idligacao=19628852&token=seu_token" \
  -H "x-proxy-secret: SEU_PROXY_SECRET"

Resposta:

Arquivo de áudio binário (MP3) com headers Content-Type: audio/mpeg