# BroadNet messaging API: REST, SMPP and a TypeScript SDK

- Canonical URL: https://www.broadnet.me/developers
- Language: en
- Last updated: 2026-10-20
- Publisher: BroadNet (https://www.broadnet.me)
- Markdown version of the page above, generated from the rendered page.

Developer Hub · v2026.05

Built for engineers. Test first, then ship.

BroadNet's messaging API is a Bearer-token REST API plus SMPP 3.4, with an official TypeScript SDK, an OpenAPI 3.1 spec and an MCP server for AI agents. The same platform that moves 300M+ messages a day is the one your `npm install` talks to.

[Request test access](https://www.broadnet.me/signup) [Read the quickstart](https://www.broadnet.me/developers/quickstart) [API reference](https://www.broadnet.me/developers/api)

Test access on request Reply within one business day SOC 2, ISO 27001

![Cinematic visualization of the BroadNet developer messaging API](https://www.broadnet.me/marketing/generated/viz-sms-api.png)

BroadNet · developer API

api.broadnet.me

REST + SMPP

protocols

8

channels

300M+/day

messages

Interactive

## Try the API

Fill in a request, hit send, and watch a simulated response and delivery flow — right here, no signup.

POST api.broadnet.me/sms/sendSms

Request

`Authorization: Bearer $BROADNET_TOKEN`

request.sh

```
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"
    }'
```

Response

Example response — no message is sent

Fill in the request and hit Send test request to see an example response.

Runs entirely in your browser. No request leaves this page and no SMS is sent.

[Request test access](https://www.broadnet.me/signup) [Full API reference](https://www.broadnet.me/developers/api)

Channels, one API

8

SMS · WhatsApp · RCS · Telegram · Email · Push · Messenger · Instagram

API uptime SLA

99.99%

Contractual, on production API endpoints

p99 API latency

<350ms

From your region to /sms/sendSms

OpenAPI spec

3.1

329 paths · 376 operations · downloadable

Official SDK

## TypeScript SDK, or any language.

One official SDK, for TypeScript and Node.js. Everything else speaks plain HTTPS: call the REST API directly, or generate a client from the spec.

[TypeScript / Node.js The official SDK, @broadnet/cpaas-sdk: generated from the BroadNet OpenAPI specification, with full type definitions. `npm install @broadnet/cpaas-sdk axios` View on npm](https://www.npmjs.com/package/@broadnet/cpaas-sdk)

[Any language via OpenAPI Call the REST API from any language, or generate a typed client from the OpenAPI 3.1 spec with openapi-generator. Download openapi.yaml](https://www.broadnet.me/developers/openapi.yaml)

[MCP server Connect AI agents to BroadNet over the Model Context Protocol, with your BroadNet token. Set up MCP](https://www.broadnet.me/developers/mcp)

Documentation

## Everything you need, none of the fluff.

Six entry points, opinionated by use case. Each links to a focused page — not a 200-tab sprawl.

[Quickstart Get a token, install the TypeScript SDK or use curl, and send your first SMS. Open](https://www.broadnet.me/developers/quickstart)

[API Reference Bearer auth, send, bulk, number lookup, errors and every channel's send endpoint. Open](https://www.broadnet.me/developers/api)

[OpenAPI spec OpenAPI 3.1: 329 paths and 376 operations across 8 channels. Download it or generate a client. Open](https://www.broadnet.me/developers/openapi)

[MCP server Connect AI agents to BroadNet over the Model Context Protocol. Open](https://www.broadnet.me/developers/mcp)

[SMPP 3.4 Direct SMPP binding for sustained high-volume workloads. Host and ports are provided with your test access. Open](https://www.broadnet.me/developers/smpp)

[Webhooks Delivery status pushed to the webhook URL on your account, plus endpoints to poll it. Open](https://www.broadnet.me/developers/webhooks)

[Moving from another SMS provider? The migration guide maps your current send, delivery-receipt and webhook calls to the BroadNet API, and covers sender IDs, a parallel run, the traffic ramp and rollback. Read the migration guide](https://www.broadnet.me/developers/migrate)

What changed, and when

Dated changes to the OpenAPI spec, the SDK, the MCP servers, the docs and the developer tools.

[Read the changelog](https://www.broadnet.me/developers/changelog) [Atom feed](https://www.broadnet.me/changelog.xml)

Common recipes

## Five things you'll do on day one.

Real code, not pseudo-code. Copy, paste, change the recipient, ship.

### Send an SMS

One HTTPS call to POST /sms/sendSms returns the message ID. Set messageType to TEXT or UNICODE, and delivery status is pushed to your webhook.

[SMS API](https://www.broadnet.me/products/sms-api)

sms.ts

```
// npm install @broadnet/cpaas-sdk axios
import { Configuration, SMSSMSApi } from "@broadnet/cpaas-sdk";

const sms = new SMSSMSApi(
  new Configuration({
    basePath: "https://api.broadnet.me",
    accessToken: process.env.BROADNET_TOKEN!,
  }),
);

const res = await sms.smsSendsmsPost({
  sMSSmsRequest: {
    senderId: "BroadNet",
    destinationNumber: "447700900123",
    message: "Your verification code is 482913",
    messageType: "TEXT",
  },
});

console.log(res.data); // message ID
```

See it in action

## The platform, on screen.

Short walkthroughs of the BroadNet messaging console — sign in, send, and measure. The same platform the API drives.

[Signing in & resetting your password](https://www.youtube.com/watch?v=i851uzE5gMI)

[Sending a single message](https://www.youtube.com/watch?v=TIG0n1C9ecE)

[Checking delivery reports](https://www.youtube.com/watch?v=op5OjCrAlIQ)

Community & support

## Real engineers, one short reply away.

An official TypeScript SDK on npm. A public OpenAPI spec and a Postman collection. A support team that owns its routes — not a queue of tier-1 scripts.

[npm The official TypeScript/Node.js SDK, with full type definitions. Install it with npm and axios. npmjs.com/package/@broadnet/cpaas-sdk](https://www.npmjs.com/package/@broadnet/cpaas-sdk)

[Postman A collection of the essential calls, or import the OpenAPI spec for every operation. Import collection](https://www.broadnet.me/developers/postman)

[Support Engineering support 24/7 for production accounts. 15-minute P1 response. developers@broadnet.me](mailto:developers@broadnet.me)

From request to production

## One path to your first message, with the clock on every step.

1. 01 Request test access Reply within 1 business day A messaging engineer replies with your test credentials and books a 30-minute call on your countries, volumes and use case.
2. 02 First test message About 5 minutes after credentials Send a test message to your own verified number with the quickstart code. The delivery receipt comes back to your webhook.
3. 03 Integration 2–5 business days Build and test with your test credentials against the same endpoint as the code samples. A BroadNet engineer pairs with you on REST or SMPP.
4. 04 Approval 3–10 business days Sender identity, traffic purpose and destination rules are reviewed, and sender IDs are registered with each regulator, in parallel with your integration.
5. 05 Production Cutover day Production access and routes are switched on for your account. Your integration already calls https://api.broadnet.me.

Overall: 5–15 business days from request to production for most markets; longer where a regulator's sender-ID lead time is longer.

Questions buyers ask

## Developer questions

Request test access at /signup, and a BroadNet engineer replies within one business day with your test credentials: the access token you send in an Authorization: Bearer header, and where to send test traffic. Your first test message can go out about five minutes after you receive them.

One official SDK: @broadnet/cpaas-sdk for TypeScript and Node.js, on npm. In any other language, call the REST API directly over HTTPS, or generate a client from the OpenAPI spec (/developers/openapi.yaml).

Postman builds one from the OpenAPI spec: import /developers/openapi.yaml (OpenAPI 3.1) to get a collection of every BroadNet endpoint, then add your access token as a Bearer collection variable.

The status page at /status shows website and public API reachability, measured by synthetic checks every 5 minutes, and the incident log, with an RSS feed at /status/rss.xml for updates. Production API endpoints carry a 99.99% uptime SLA.

Question not here? [Ask our engineering team](https://www.broadnet.me/contact)

Test access · reply within one business day

## Request test access.

Send your test messages to your own verified number. Before production, we review sender identity, traffic purpose and destination requirements — most teams are live in 5-15 business days.

[Request test access](https://www.broadnet.me/signup) [Talk to engineering](https://www.broadnet.me/contact)

$ npm install @broadnet/cpaas-sdk axios · first SMS in minutes