Uma única API de mensagens para oito canais
Envie SMS, WhatsApp, RCS, Messenger, Instagram, Telegram, e-mail e push a partir do seu próprio código, com uma única URL base e um único token Bearer. Acompanhe cada mensagem por webhooks, escale o SMS via SMPP e deixe que agentes de IA usem a mesma API por meio do MCP.
curl -X POST https://api.broadnet.me/sms/sendSms \
-H "Authorization: Bearer $BROADNET_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"senderId": "OmniDemo",
"destinationNumber": "447700900123",
"message": "Your code is 482913",
"messageType": "TEXT"
}'
# 200 OK
2603121407537573731Uma requisição real: POST /sms/sendSms retorna o ID da mensagem em texto simples. Substitua o token, o ID de remetente (Sender ID) e o número pelos seus.
Resposta curta
Atualizado em
A OmniChannels.ai oferece aos desenvolvedores uma única API REST para SMS, WhatsApp, RCS, Messenger, Instagram, Telegram, e-mail e push. São cerca de 225 endpoints documentados em uma especificação OpenAPI 3.1, um SDK em TypeScript, webhooks de status de entrega, SMPP v3.4 sobre TLS e um servidor MCP para agentes de IA. O acesso de teste envia apenas para seus números verificados, engenheiros apoiam sua integração e revendedores podem usar a mesma API com a própria marca.
O que você ganha como desenvolvedor
Uma única integração cobre todos os canais que seus clientes usam, com as ferramentas que uma equipe de produção espera.
Uma API REST, oito canais
SMS, WhatsApp, RCS, Messenger, Instagram, Telegram, e-mail e push compartilham a mesma URL base, o mesmo token Bearer e o mesmo formato de erro. Adicionar um canal significa usar um novo endpoint, não contratar um novo fornecedor.
OpenAPI 3.1 e SDK em TypeScript
Cerca de 225 endpoints documentados em uma especificação OpenAPI 3.1 que você pode importar no Postman ou usar para gerar clientes, além do pacote oficial @broadnet/cpaas-sdk para TypeScript e Node.js.
Webhooks de status de entrega
Os status são padronizados entre os canais (SUBMITTED, SENT, DELIVERED, READ, FAILED e REJECTED) e enviados ao seu endpoint HTTPS, com endpoints de consulta e de reenvio como rede de segurança.
SMPP v3.4 para SMS em alto volume
Binds transceiver sobre TLS com lista de IPs permitidos, provisionados para a sua conta, nas mesmas rotas diretas com as operadoras usadas pela API REST.
Servidor MCP para agentes de IA
Conecte o Claude, o Cursor ou qualquer cliente MCP à API com o seu token, para que os agentes enviem mensagens e leiam relatórios de entrega dentro das regras que você definir.
Teste antes de entrar em produção
As credenciais de teste enviam para seus próprios números verificados, na mesma URL base da produção, então seu código não muda na virada.
Suporte de engenheiros
Um engenheiro de mensageria avalia seu caso de uso, ajuda no desenho da integração via REST ou SMPP, com IDs de remetente e regras de cada país, e acompanha você até a entrada em produção.
Feito para revendedores
Revendedores usam a mesma API com a própria marca, com subcontas que têm crédito, IDs de remetente, usuários e webhooks próprios, além de uma API de revenda para gestão de contas.
Recursos para desenvolvedores em resumo
O que está disponível hoje e o que é configurado com a nossa equipe.
| Item | Status | Detalhes |
|---|---|---|
| API REST (SMS, WhatsApp, RCS, Messenger, Instagram, Telegram, e-mail, push) | Disponível | URL base https://api.broadnet.me com autenticação por token Bearer. O acesso de teste é liberado após uma breve solicitação. |
| Webhooks de status de entrega | Disponível | Configurados por conta ou subconta. Os status são padronizados entre os canais. |
| SDK em TypeScript | Disponível | npm install @broadnet/cpaas-sdk axios. Outras linguagens chamam a API REST diretamente ou geram um cliente. |
| Especificação OpenAPI 3.1 | Disponível | Pública em https://omnichannels.ai/developers/openapi.json (YAML em /developers/openapi.yaml): todas as operações que um token de cliente pode chamar, para Postman, Insomnia, geração de clientes e ferramentas de programação com IA. |
| Servidor MCP | Disponível | https://mcp.broadnet.me/mcp via Streamable HTTP, autenticado com o seu token. |
| SMPP v3.4 sobre TLS | Sob consulta | Binds, throughput e lista de IPs permitidos são provisionados para a sua conta pela nossa equipe. |
| Voz (OTP, URA, chamadas de saída, agentes de voz com IA) | Sob consulta | Provisionada com a equipe de contas; não há endpoints públicos de voz na API REST. |
Da primeira requisição à produção
Não há cadastro self-service instantâneo. O acesso começa com uma breve solicitação, para que a conta seja configurada para os seus canais e países.
- 1
Solicite acesso de teste
Informe seus canais, países de destino, volumes e caso de uso. Um engenheiro avalia a solicitação e libera as credenciais de teste.
- 2
Envie sua primeira mensagem de teste
Siga o guia de início rápido para enviar um SMS ao seu próprio número verificado e receber o status de entrega no seu webhook.
- 3
Construa a integração
Adicione os canais de que precisa, trate erros e novas tentativas e registre os IDs das mensagens. Nossos engenheiros podem revisar seu desenho para REST ou SMPP.
- 4
Aprove os remetentes
IDs de remetente, contas do WhatsApp Business e agentes RCS são registrados em paralelo ao desenvolvimento, seguindo as regras de cada país e plataforma.
- 5
Entre em produção
As rotas de produção são ativadas na sua conta. Seu código continua chamando a mesma URL base, então nada muda na virada.
Esta API é adequada para a sua equipe?
Indicado quando
- Você quer uma única integração para SMS, WhatsApp, RCS, mensageria social, e-mail e push, em vez de vários fornecedores.
- Você precisa do status de entrega de cada mensagem nos seus próprios sistemas, e não apenas em um painel.
- Você envia grandes volumes de SMS e quer SMPP junto com REST.
- Você revende mensageria e precisa da mesma API com a sua marca, com subcontas.
- Você está construindo agentes de IA que devem enviar e acompanhar mensagens por meio do MCP.
Bom saber antes de começar
- Não há cadastro self-service instantâneo; o acesso de teste é liberado após uma breve solicitação.
- O SDK oficial é apenas em TypeScript; outras linguagens usam HTTP direto ou um cliente gerado a partir da especificação.
- A API não aceita chave de idempotência, então sua integração deve registrar cada envio antes de tentar novamente.
- Voz e SMPP são provisionados com a nossa equipe, e não por endpoints públicos.
- Envios por WhatsApp, Messenger e Instagram seguem as regras da Meta, incluindo modelos aprovados e janelas de mensagens.
Documentação
Tudo o que você precisa para integrar, da primeira chamada à API até binds SMPP e agentes de IA. A documentação técnica está em inglês.
- Primeiros passos· Em inglêsInício rápido: envie sua primeira mensagemObtenha credenciais de teste, envie seu primeiro SMS com cURL, Node.js, Python ou PHP, receba o status de entrega e veja o que fazer antes de entrar em produção.
- Primeiros passos· Em inglêsAutenticaçãoComo autenticar requisições com um token Bearer, guardá-lo e renová-lo com segurança, entender uma resposta 401 e conectar Páginas do Facebook e Instagram via OAuth.
- Canais de mensagens· Em inglêsReferência da API de SMSEnvie SMS individuais e em massa, escolha a codificação TEXT ou UNICODE, conte segmentos, agende, controle envios em massa e valide números antes de enviar.
- Canais de mensagens· Em inglêsReferência da API do WhatsApp BusinessEnvie modelos, texto, mídia e mensagens interativas do WhatsApp por um único endpoint multipart, gerencie modelos e lotes e acompanhe cada destinatário.
- Canais de mensagens· Em inglêsAPI de RCS Business MessagingEnvie texto, mídia, cards ricos, carrosséis e respostas sugeridas por RCS, verifique antes a compatibilidade do aparelho e planeje o fallback para SMS.
- Canais de mensagens· Em inglêsAPI do Facebook MessengerConecte uma Página do Facebook via OAuth e envie texto, mídia, botões, carrosséis e respostas rápidas no Messenger dentro das janelas da Meta.
- Canais de mensagens· Em inglêsAPI de mensagens do InstagramConecte uma conta profissional do Instagram via OAuth e responda às mensagens diretas por API: texto, mídia, respostas rápidas, modelos genéricos e reações.
- Canais de mensagens· Em inglêsAPI do TelegramEnvie texto, fotos, documentos, vídeo, localização e contatos pelo Telegram a partir do remetente conectado, use modelos salvos e teste em sandbox.
- Canais de mensagens· Em inglêsAPI de e-mailEnvie e-mails transacionais e em massa pelo seu remetente SMTP: HTML, modelos, anexos, CC e agendamento, além de verificação de domínio e envio de teste.
- Canais de mensagens· Em inglêsAPI de notificações pushEnvie notificações push aos usuários do seu app por referência, token do aparelho, tópico ou segmento, com imagens, deep links, ações, modelos e simulações.
- Canais de mensagens· Em inglêsVoz: OTP, URA, chamadas e agentes de IAO que a voz faz na OmniChannels.ai, do OTP por voz e da URA aos agentes de voz com IA e ao fallback de SMS para voz, e como nossa equipe ativa na sua conta.
- Eventos e erros· Em inglêsWebhooks e status de entregaReceba status de entrega e mensagens recebidas no seu endpoint HTTPS, responda rápido, elimine eventos duplicados e consulte ou reenvie status quando precisar.
- Eventos e erros· Em inglêsErros, novas tentativas e limitesCódigos HTTP e corpos de erro, quais erros repetir com backoff e jitter, limites padrão de requisições, paginação e como evitar envios duplicados.
- Conectividade· Em inglêsConectividade SMPP v3.4Quando usar SMPP em vez de REST, como os binds são provisionados com TLS, o essencial de submit_sm, codificação, concatenação, relatórios de entrega e códigos de erro.
- Ferramentas· Em inglêsServidor MCP para agentes de IAConecte Claude, Cursor, VS Code e outros clientes MCP à API de mensagens para que agentes de IA enviem e acompanhem mensagens com segurança usando seu token.
- Ferramentas· Em inglêsSDKs, especificação OpenAPI e exemplos de códigoUse o SDK em TypeScript, importe a especificação OpenAPI 3.1 no Postman ou Insomnia, gere clientes e chame a API a partir de Java, .NET, Go e Ruby.
- Ferramentas· Em inglêsEspecificação OpenAPI 3.1Baixe a especificação OpenAPI 3.1 pública, importe no Postman ou Insomnia, gere clientes e tipos e entregue-a às ferramentas de programação com IA.
- Ferramentas· Em inglêsUsar o servidor MCP com o Claude CodeAdicione o servidor MCP da OmniChannels.ai ao Claude Code com claude mcp add, compartilhe no .mcp.json, mantenha o token em variável de ambiente e controle as ferramentas de envio.
- Ferramentas· Em inglêsUsar o servidor MCP com o CursorConecte o Cursor ao servidor MCP da OmniChannels.ai com .cursor/mcp.json, leia o token de uma variável de ambiente, ative ou desative ferramentas e envie a primeira mensagem.
- Ferramentas· Em inglêsUsar o servidor MCP com o n8nDê a um agente de IA do n8n as ferramentas de mensagens com o nó MCP Client Tool, ou chame a API REST e receba status de entrega com nós comuns do n8n.
- Ferramentas· Em inglêsMake e Zapier com webhooksEnvie mensagens de cenários do Make e Zaps com uma requisição HTTP à API REST e receba status de entrega e mensagens recebidas por um webhook do Make ou do Zapier.
Como a API se encaixa no seu stack
Seus sistemas chamam uma única REST API com um único bearer token. A BroadNet roteia cada mensagem pelo canal e pela operadora certos e envia os status de entrega de volta para o seu webhook.
Seu app, CRM ou agente de IA
- Bearer token, uma única URL base
- SMPP 3.4 sobre TLS para alto volume
- Servidor MCP para agentes de IA
API de mensagens da BroadNet
API de mensagens da BroadNethttps://api.broadnet.meO celular do seu cliente
Status de entrega no seu webhook
SENTDELIVEREDREADFAILED
Dúvidas de desenvolvedores
Como faço a autenticação?
Envie o token de acesso da sua conta em um cabeçalho Authorization: Bearer em todas as requisições. Os tokens são emitidos por conta; não existe endpoint que troque usuário e senha por um token. Um token ausente ou inválido retorna 401. Mantenha o token nos seus servidores, nunca em código de navegador ou de aplicativo móvel.
Qual é a URL base e existe um sandbox separado?
Todas as chamadas vão para https://api.broadnet.me, sem prefixo de versão. Teste e produção usam a mesma URL base: as credenciais de teste enviam apenas para seus números verificados, e a produção é ativada na sua conta após a aprovação dos remetentes, então seu código não muda.
Como recebo as confirmações de entrega?
Os status são enviados para a URL de webhook configurada na sua conta: SUBMITTED, SENT, DELIVERED, READ nos canais que informam leitura, FAILED e REJECTED. Você também pode consultar, por exemplo, GET /sms/list para envios de SMS em massa e GET /whatsapp/message/bulk-insights para lotes de WhatsApp.
Como devo tratar novas tentativas e duplicidades?
Tente novamente apenas em erros de rede e respostas 429 e 5xx, com backoff exponencial e jitter, e nunca repita sem alterações uma requisição que retornou 4xx. A API não aceita chave de idempotência, então registre cada envio antes de fazê-lo, armazene o ID de mensagem retornado e verifique o status após um timeout antes de enviar de novo.
Quais são os limites de requisições?
Os padrões documentados são 200 requisições por segundo na API REST, com picos de até 500 por até 60 segundos, 1.000 mensagens por segundo por bind SMPP e 50 requisições por segundo para consultas de números. Os limites da sua conta são confirmados junto com as credenciais. Requisições acima do limite retornam 429 com o cabeçalho Retry-After.
Quais linguagens são suportadas?
Qualquer linguagem capaz de fazer requisições HTTPS. Há um SDK oficial em TypeScript, o @broadnet/cpaas-sdk, e a documentação traz exemplos em HTTP direto para cURL, Node.js, Python, PHP, Java, .NET, Go e Ruby. Você também pode gerar um cliente a partir da especificação OpenAPI 3.1, pública em /developers/openapi.json.
Devo usar REST ou SMPP para SMS?
REST atende à maioria das aplicações e dá acesso a todos os canais por uma única API. SMPP v3.4 sobre TLS é indicado para SMS em alto volume contínuo, principalmente se você já opera um cliente SMPP. Binds, throughput e listas de IPs permitidos são provisionados para a sua conta, e você pode usar os dois na mesma conta.
Posso revender mensageria pela API?
Sim. Revendedores usam a mesma API com a própria marca. Cada subconta tem crédito, IDs de remetente, usuários e webhooks próprios, e uma API de revenda cobre criação de contas, recargas de crédito, tabelas de tarifas e relatórios. Mencione a revenda ao solicitar acesso para estruturarmos tudo com você.
Guias sobre este tema
- IntegraçãoGuia de integração de API de mensagens: REST, SMPP e webhooks9 min de leitura
- MarketingEnviada, entregue, lida e falha: status de mensagem explicados8 min de leitura
- IntegraçãoComo conectar um CRM a uma inbox omnichannel com webhooks8 min de leitura
- SMS e OTPOTP no WhatsApp e SMS: segurança, entrega e fraude9 min de leitura
- WhatsAppCódigos de erro da Cloud API do WhatsApp: significado e solução8 min de leitura
- SMS e OTPO que é SMS A2P? Como mensagens de empresas chegam ao celular8 min de leitura
Conheça mais da plataforma
Solicite acesso de teste
Informe seus canais, países e volumes. Um engenheiro vai configurar credenciais de teste para seus números verificados e ajudar você a planejar a migração para produção.
Conte qual é sua stack e o que você quer conectar. Um engenheiro de soluções entrará em contato.