BroadNet
Spec download·/openapi

OpenAPI specification.

The public BroadNet API spec as OpenAPI 3.1 at /developers/openapi.yaml (JSON at /developers/openapi.json): 329 paths and 376 operations across 8 channels, with internal examples removed. Import it into Postman, Insomnia or Swagger UI, or generate a client for any language with openapi-generator. The official TypeScript SDK (@broadnet/cpaas-sdk) is generated from the BroadNet OpenAPI specification.

Download·OpenAPI 3.1·Section 4 of 15Developer Hub

Overview

The BroadNet API as one OpenAPI 3.1 file: 329 paths and 376 operations across eight channels. It is a public copy with internal examples removed. Import it into Postman, Insomnia or Swagger UI, or generate a client in any language. The official TypeScript SDK (@broadnet/cpaas-sdk) is generated from the BroadNet OpenAPI specification.

Example

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

fetch the spec and generate a clientbash
curl -O https://www.broadnet.me/developers/openapi.yaml

# Generate a Python client
npx @openapitools/openapi-generator-cli generate \
  -i openapi.yaml -g python -o broadnet-python

# Or a Go client
npx @openapitools/openapi-generator-cli generate \
  -i openapi.yaml -g go -o broadnet-go
↳ OpenAPI 3.1 · 329 paths / 376 operations across 8 channels · public copy with internal examples removed
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.

Request test accessBrowse all docs
$npm install @broadnet/cpaas-sdk axiosready