BroadNet messaging API: REST, SMPP and a TypeScript SDK
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.
Try the API
Fill in a request, hit send, and watch a simulated response and delivery flow — right here, no signup.
Authorization: Bearer $BROADNET_TOKENcurl -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"
}'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.
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.
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.
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.
Dated changes to the OpenAPI spec, the SDK, the MCP servers, the docs and the developer tools.
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.
// 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 IDThe platform, on screen.
Short walkthroughs of the BroadNet messaging console — sign in, send, and measure. The same platform the API drives.
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.
One path to your first message, with the clock on every step.
- 01
Request test access
Reply within 1 business dayA messaging engineer replies with your test credentials and books a 30-minute call on your countries, volumes and use case.
- 02
First test message
About 5 minutes after credentialsSend a test message to your own verified number with the quickstart code. The delivery receipt comes back to your webhook.
- 03
Integration
2–5 business daysBuild and test with your test credentials against the same endpoint as the code samples. A BroadNet engineer pairs with you on REST or SMPP.
- 04
Approval
3–10 business daysSender identity, traffic purpose and destination rules are reviewed, and sender IDs are registered with each regulator, in parallel with your integration.
- 05
Production
Cutover dayProduction 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.
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
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.