BroadNet
Reference·/api-reference

Full API reference.

Every endpoint, every field, every error code, generated from our OpenAPI 3.1 spec: 329 paths and 376 operations across 8 channels. Examples use curl and plain HTTP; the official TypeScript SDK (@broadnet/cpaas-sdk) is generated from the BroadNet OpenAPI specification.

Browsable reference·OpenAPI 3.1·Section 3 of 15Developer Hub

Overview

The BroadNet API is described in an OpenAPI 3.1 spec: 329 paths and 376 operations across eight channels (WhatsApp, SMS, RCS, Telegram, push, email, Messenger and Instagram). The official TypeScript SDK is generated from the BroadNet OpenAPI specification. The full reference, with every field of the most-used calls, is at /developers/api.

Example

Copy, paste, replace the placeholders — these examples call the production API as written.

Top-level resourceshttp
POST   /sms/sendSms                  Send one SMS (JSON)
POST   /sms/identify                 Encoding, characters and segments for a message
POST   /sms/sendbulk                 Bulk SMS from an uploaded file (multipart)
GET    /sms/list                     Bulk jobs; pause, resume, abort by batch_Id
POST   /sms/lookup                   Number status (HLR / MNP) before sending
POST   /whatsapp/message/sendbulk    WhatsApp text, media, templates, interactive
GET    /whatsapp/message/bulk-insights  Per-recipient WhatsApp status
POST   /rcs/message/sendbulk         RCS messages
POST   /telegram-sms/send            Telegram messages
POST   /email/email-service/send     Email
POST   /messenger/message/sendbulk   Facebook Messenger
POST   /instagram/message/sendbulk   Instagram
POST   /push/message/send            Push notifications
↳ Base URL https://api.broadnet.me · full reference at /developers/api
Test access · reply within one business day

Request test access and build with confidence.

We reply within one business day with test credentials. Then install the TypeScript SDK or call the REST API from any language, and send your first test message to your own number.

$npm install @broadnet/cpaas-sdk axiosready