Centro de Programadores

Faça da sua central parte do seu software.

Uma única chave de API, HTTP simples, respostas JSON. Do click-to-call e controlo de chamadas às campanhas de chamadas automáticas, das tarefas do assistente de voz ao código de verificação por voz, tudo é REST; os resultados voltam por webhooks assinados com HMAC.

Início rápido

O seu primeiro pedido em 2 minutos

Obtenha a sua chave no separador Painel > Chamadas Automáticas > API (ou em Definições da Central); envie-a com o cabeçalho Bearer, X-Api-Key ou ?key=.

A chave está associada à sua conta de cliente; não acede aos dados de outros clientes.
As operações de leitura são GET, as que alteram são POST; corpo JSON ou formulário.
A resposta de erro é sempre {"ok":false,"error":"…","code":"…"} é do formato.
Limite de pedidos: 120 por minuto, por chave; em caso de excesso, 429.

Ler a visão geral Fazer o pedido

# click-to-call: a extensão 1001 toca primeiro e, ao atender, o destino é chamado curl "https://api.buluthat.com/api/begin_call.php?key=K1234-…&extension=1001&destination=905321234567" # criar campanha curl -X POST "https://api.buluthat.com/api/autocall.php?action=create_campaign" \ -H "Authorization: Bearer bt_xxxxxxxx" \ -H "Content-Type: application/json" \ -d '{"name":"Ödeme hatırlatma","campaign_type":"ivr", "tts_template":"Merhaba {sayin}, {tutar} tutarındaki ödemeniz…", "digit_labels":{"1":"Ödedim","2":"Yetkili"}}' # enviar código de verificação por voz curl -X POST "https://api.buluthat.com/api/voice_otp.php?action=send" \ -H "X-Api-Key: bt_xxxxxxxx" -d "phone=905321234567" → {"ok":true,"id":8812,"code":"472915","expires_in":300}

Documentação

Cabeçalhos da API

Em cada título: o endereço do endpoint, parâmetros, exemplo de pedido e resposta.

Visão Geral

Autenticação, formato dos pedidos, códigos de erro, limites de pedidos

Ler

Segurança da API

Chave e âmbitos, IP autorizado, assinatura HMAC dos pedidos, renovação de chaves, registo de pedidos

Ler

Gestão de Chamadas

Click-to-call, terminar, transferir, silenciar

Ler

Filas

Lista de filas, em espera, adicionar/remover membros

Ler

Estados dos Agentes

Estados das extensões e membros das filas

Ler

Lista negra

Listar, adicionar e eliminar números bloqueados

Ler

Ficheiros de Áudio

Lista de anúncios, carregamento, atualização, eliminação

Ler

Chamadas Automáticas

Criar campanha, adicionar números, obter resultados, webhook

Ler

Assistente de Voz

Conversas, notas, marcações, chamada de tarefa, incorporação

Ler

Verificação por Voz (OTP)

Enviar código, validar, estado, webhook

Ler

API de SMS

SMS em massa / personalizado, SMS OTP, relatório de entrega, SMS recebidos, lista negra

Ler

Webhooks

Validação da assinatura, política de repetição, esquemas de eventos

Ler

Incorporar (iframe CRM)

Nos painéis da central e no seu software de telefone web: código, link assinado, eventos JavaScript

Ler

Webhooks

Que os resultados cheguem até si, sem ter de perguntar.

O resultado da chamada automática, o resumo da conversa do assistente de voz, o estado do código de verificação — cada evento é enviado por POST para o seu endereço em JSON; o cabeçalho X-Buluthat-Signature é a assinatura HMAC-SHA256. Uma entrega falhada é repetida em intervalos de 1 min → 6 h.

Documentação de webhooks

// PHP: validação da assinatura $raw = file_get_contents('php://input'); $sig = $_SERVER['HTTP_X_BULUTHAT_SIGNATURE'] ?? ''; $calc = hash_hmac('sha256', $raw, $secret); if (!hash_equals($calc, $sig)) { http_response_code(401); exit; } $event = json_decode($raw, true); // $event['event'] = 'call_finished' | 'session_ended' | 'otp_result' …

Ponte do Byfix CRM

O assistente de voz encontra o cliente no CRM, abre registos de assistência, deixa notas; a chamada "ligar com o assistente" inicia-se a partir do CRM. Pronto, com uma única chave.

Detalhe

Cliente PHP

Classe PHP pronta para o código de verificação por voz; enviar/validar em duas linhas. Os restantes endpoints são HTTP simples, pelo que se chamam a partir de qualquer linguagem.

Exemplo

Ecrã em direto incorporável

Transcrição em direto da conversa do assistente, em iframe dentro do CRM; com token assinado e com prazo, sem necessidade de sessão no painel.

embed_url