BroadNet
Documentos

Construa sobre o fio.

Uma API REST e SMPP 3.4, um SDK oficial TypeScript e uma especificação OpenAPI 3.1 a partir da qual você pode gerar clientes em qualquer linguagem. Cada endpoint possui um exemplo de requisição, um exemplo de resposta e os erros que você pode encontrar.

Solicitar acesso de testeInicie o guia de início rápido.
5 minutos

Início rápido

Instale o TypeScript SDK ou use curl, envie o seu primeiro SMS e, em seguida, vá para produção.

Abrir
Referência

Referência API

Autenticação Bearer, envio, envio em massa, pesquisa de número, formato de erro e ponto de extremidade de envio de cada canal.

Abrir
Download

Especificação OpenAPI

OpenAPI 3.1: 329 caminhos e 376 operações em 8 canais. Importe ou gere um cliente.

Abrir
Agentes de IA

Servidor MCP

Conecte agentes de IA ao BroadNet por meio do Protocolo de Contexto de Modelo, utilizando o seu token BroadNet.

Abrir
Referência

SMPP 3.4

Vinculação direta para remetentes de alto volume. Catálogo PDU + configuração.

Abrir
Guia

Webhooks

O status da entrega é enviado para o URL do webhook configurado na sua conta.

Abrir
Guia

Autenticação

Tokens Bearer, uma única URL base para teste e produção e armazenamento de tokens no lado do servidor.

Abrir
Referência

Códigos de erro

O formato de erro ExceptionResponse e o significado de cada status HTTP.

Abrir
Downloads

SDK e ferramentas

O SDK oficial em TypeScript (@broadnet/cpaas-sdk), além do plugin do Excel, dos webhooks e do servidor MCP.

Abrir
Registo datado

Registo de alterações

Alterações API, desatualizadas.

Abrir
Guia

Idempotência

Evite envios duplicados: guarde o ID de cada envio recebido e verifique o status antes de reenviar.

Abrir
Guia

Tentativas repetidas e recuo

O que tentar novamente, o recuo exponencial com jitter e o que fazer após um tempo limite excedido.

Abrir
Referência

Paginação

Navegue pelas páginas da lista de endpoints usando os parâmetros de consulta `page` e `size`.

Abrir
Política

Versões API

Caminhos sem versão, versões de especificações e SDK e como rastrear alterações API.

Abrir

Solução de problemas

Falhas específicas e as suas causas reais em rotas operadas diretamente pela operadora.

Falha no envio de SMS no EgitoFalha no envio de SMS na Arábia SauditaID do remetente dos Emirados Árabes Unidos rejeitadoMensagens presas na filaWebhooks de entrega não estão a ser acionadosModelo WhatsApp rejeitado
Pré-visualização API

POST /sms/sendSms

Um único endpoint, uma única requisição HTTPS com um token Bearer. Envie mensagens em inglês, Unicode ou árabe na mesma chamada: defina o tipo de mensagem como TEXT ou UNICODE, e a API devolverá o ID da mensagem aceita.

Leia a referência completa.
Exemplo
curl -X POST https://api.broadnet.me/sms/sendSms \
  -H "Authorization: Bearer $BROADNET_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "senderId": "BroadNet",
    "destinationNumber": "447700900123",
    "message": "Your verification code is 482913",
    "messageType": "TEXT"
  }'
 
# 200 OK → response body is the message ID, e.g. 2603121407537573731