Developer Documentation

Build with the Channlr API

Integrate WhatsApp, SMS, Voice, and Chatbot messaging into your application with our RESTful API. SDKs available in Node.js, Python, PHP, and Go.

Quickstart Guide API Reference

Base URL

https://api.channlr.io

Authentication

Authorization: Bearer YOUR_API_KEY

Response Format

JSON with standard error codes and pagination

Get started

Quickstart

Send your first message in under 2 minutes.

01

Get your API key

Sign up and generate an API key from your dashboard.

02

Install an SDK

Choose your language and install the Channlr SDK.

03

Send a message

Use the messaging API to reach your first customer.

Send your first message

curl -X POST https://api.channlr.io/v1/messages/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+254712345678",
    "channel": "whatsapp",
    "template": "order_update",
    "parameters": {
      "1": "John",
      "2": "#ORD-4821",
      "3": "Delivered"
    }
  }'

Libraries

Official SDKs

Native libraries for your favourite language.

JS

Node.js / TypeScript

npm install @channlr/sdk
PY

Python

pip install channlr
PHP

PHP

composer require channlr/sdk
GO

Go

go get github.com/channlr/go-sdk

Endpoints

API Reference

All available endpoints organised by resource.

POST/v1/messages/send
POST/v1/messages/send-bulk
GET/v1/messages/{id}
GET/v1/messages
POST/v1/messages/schedule
DELETE/v1/messages/schedule/{id}

Real-time

Webhook Events

Subscribe and get notified instantly.

message.sent

Message successfully sent to carrier

message.delivered

Message delivered to recipient device

message.read

Recipient opened or read the message

message.failed

Message delivery failed

message.received

Incoming message from a customer

template.approved

Template approved by Meta

template.rejected

Template rejected by Meta

account.quality_change

WhatsApp quality rating changed

Limits

Rate Limits

Fair usage limits based on your plan.

Starter

100 req/min

Burst: 20 req/sec

Pro

1,000 req/min

Burst: 100 req/sec

Enterprise

10,000 req/min

Burst: 500 req/sec

Ready to build?

Get your API key and start integrating Channlr in minutes. No credit card required.

Back to homeGet Free API Key