# Referência completa da API

> Cada endpoint, cada campo, cada código de erro, gerados a partir da nossa especificação OpenAPI 3.1: 329 caminhos e 376 operações em 8 canais. Os exemplos usam curl e HTTP simples; o SDK oficial de TypeScript (@broadnet/cpaas-sdk) é gerado a partir da especificação OpenAPI da BroadNet.

- URL canônico: https://www.broadnet.me/pt/developers/api-reference
- Idioma: pt
- Última atualização: 2026-10-21
- Editor: BroadNet (https://www.broadnet.me)

A API BroadNet é descrita numa especificação OpenAPI 3.1: 329 caminhos e 376 operações em oito canais (WhatsApp, SMS, RCS, Telegram, push, e-mail, Messenger e Instagram). O SDK oficial TypeScript é gerado a partir da especificação OpenAPI BroadNet. A referência completa, com todos os campos das chamadas mais usadas, está em /developers/api.

> **Um token, uma URL base, todos os canais.** Todos os endpoints se autenticam com o mesmo token Bearer e residem na mesma URL base, portanto, adicionar um canal significa chamar um novo caminho, não integrar uma nova API.

## Exemplos

### Top-level resources

```http
POST   /sms/sendSms                  Enviar um SMS (JSON)
POST   /sms/identify                 Codificação, caracteres e segmentos de uma mensagem
POST   /sms/sendbulk                 SMS em massa a partir de um ficheiro enviado (multipart)
GET    /sms/list                     Envios em massa; pausar, retomar, cancelar por batch_Id
POST   /sms/lookup                   Status do número (HLR / MNP) antes do envio
POST   /whatsapp/message/sendbulk    WhatsApp: texto, conteúdo multimédia, modelos, interativos
GET    /whatsapp/message/bulk-insights  Status do WhatsApp por destinatário
POST   /rcs/message/sendbulk         Mensagens RCS
POST   /telegram-sms/send            Mensagens do Telegram
POST   /email/email-service/send     E-mail
POST   /messenger/message/sendbulk   Facebook Messenger
POST   /instagram/message/sendbulk   Instagram
POST   /push/message/send            Notificações push
```

URL base: https://api.broadnet.me · referência completa em /developers/api

## Relacionados

- [Padrão de design de API de mensagens REST](https://www.broadnet.me/pt/reference/rest-messaging-api-design)
- [Especificação OpenAPI](https://www.broadnet.me/pt/developers/openapi)