Docs

Build on the wire.

A REST API and SMPP 3.4, an official TypeScript SDK, and an OpenAPI 3.1 spec you can generate clients from in any language. Every endpoint has a request example, a response example, and the errors you can actually hit.

Request test access Start the quickstart

5 min

Quickstart

Install the TypeScript SDK or use curl, send your first SMS, then go to production.

Open

Reference

API Reference

Bearer auth, send, bulk, number lookup, the error format and every channel's send endpoint.

Open

Download

OpenAPI spec

OpenAPI 3.1: 329 paths and 376 operations across 8 channels. Import it or generate a client.

Open

AI agents

MCP server

Connect AI agents to BroadNet over the Model Context Protocol, with your BroadNet token.

Open

Reference

SMPP 3.4

Direct binding for high-volume senders. PDU catalogue + tuning.

Open

Guide

Webhooks

Delivery status is pushed to the webhook URL configured on your account.

Open

Guide

Authentication

Bearer tokens, the one base URL for test and production, and keeping tokens server-side.

Open

Reference

Error Codes

The ExceptionResponse error format and what each HTTP status means.

Open

Downloads

SDK and tools

The official TypeScript SDK (@broadnet/cpaas-sdk), plus the Excel plugin, webhooks and the MCP server.

Open

Dated log

Changelog

API changes, dated.

Open

Guide

Idempotency

Avoid duplicate sends: keep the ID every send returns and check status before you resend.

Open

Guide

Retries & backoff

What to retry, exponential backoff with jitter, and what to do after a timeout.

Open

Reference

Pagination

Page through list endpoints with the page and size query parameters.

Open

Policy

API versions

Unversioned paths, spec and SDK versions, and how to track API changes.

Open

Troubleshooting

Specific failures, and what actually causes them on operator-direct routes.

SMS failing in Egypt SMS failing in Saudi Arabia UAE sender ID rejected Messages stuck in queued Delivery webhooks not firing WhatsApp template rejected

API preview

POST /sms/sendSms

One endpoint, one HTTPS request with a Bearer token. Send English, Unicode or Arabic through the same call: set the message type to TEXT or UNICODE, and the API returns the accepted message ID.

Read the full reference

POST · api.broadnet.me/sms/sendSms

Example

1curl -X POST https://api.broadnet.me/sms/sendSms \
2  -H "Authorization: Bearer $BROADNET_TOKEN" \
3  -H "Content-Type: application/json" \
4  -d '{
5    "senderId": "BroadNet",
6    "destinationNumber": "447700900123",
7    "message": "Your verification code is 482913",
8    "messageType": "TEXT"
9  }'
10 
11# 200 OK → response body is the message ID, e.g. 2603121407537573731