API Documentation — Pixabits REST API Reference

Getting Started

The Pixabits REST API lets you integrate SMS, WhatsApp, Voice, Email, RCS, VAS, Network, and Billing capabilities into your application. All requests use JSON and require an API key.

BASE URL

https://api.pixabits.ai

Content-Type

application/json

API Versioning

v2 (SMS/Voice/Email) · v1 (WA/RCS/VAS/Net/Billing)

Quick Example

curl -X POST https://api.pixabits.ai/v2/sms/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"+919876543210","body":"Hello from Pixabits!","sender":"PIXABT"}'

Authentication

All API requests require a Bearer token in the Authorization header. Tokens are scoped to your organization and can be rotated at any time.

Header Format

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Get your API key from Dashboard → Developer → API Keys. Keep it secret. Rotate immediately if compromised.

SMS API

GET/api/v1/sms/reportsv1

Summary + daily delivery breakdown for all SMS sent via this API key.

cURL Example

curl -X GET https://api.pixabits.ai/api/v1/sms/reports

POST/api/v1/sms/sendv1

POST /api/v1/sms/send

cURL Example

curl -X POST https://api.pixabits.ai/api/v1/sms/send

GET/api/v1/sms/shortenv1

GET /api/v1/sms/shorten

cURL Example

curl -X GET https://api.pixabits.ai/api/v1/sms/shorten

POST/api/v1/sms/shortenv1

POST /api/v1/sms/shorten

cURL Example

curl -X POST https://api.pixabits.ai/api/v1/sms/shorten

GET/api/v1/sms/status/{jobId}v1

Returns delivery status for a customer API SMS job.

cURL Example

curl -X GET https://api.pixabits.ai/api/v1/sms/status/{jobId}

GET/api/v1/sms/templatesv1

List DLT-approved SMS templates for the authenticated org.

cURL Example

curl -X GET https://api.pixabits.ai/api/v1/sms/templates

GET/api/v1/sms/templates/{id}v1

Fetch a single SMS template by its UUID.

cURL Example

curl -X GET https://api.pixabits.ai/api/v1/sms/templates/{id}

GET/api/v1/sms/webhooksv1

SMS delivery webhook registration (customer-facing).

cURL Example

curl -X GET https://api.pixabits.ai/api/v1/sms/webhooks

POST/api/v1/sms/webhooksv1

SMS delivery webhook registration (customer-facing).

cURL Example

curl -X POST https://api.pixabits.ai/api/v1/sms/webhooks

WhatsApp API

GET/api/wa/ext/media-libraryext

Library

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/wa/ext/media-library \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/wa/ext/media-libraryext

Library

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/wa/ext/media-library \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/wa/ext/templatesext

GET /api/wa/ext/templates

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/wa/ext/templates \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/wa/ext/templatesext

Return a useful error instead of Next.js default HTML for wrong methods

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/wa/ext/templates \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/wa/v1/ai-agent-handoffv1

Handoff

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/wa/v1/ai-agent-handoff \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/wa/v1/ai-agent-handoffv1

Handoff

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/wa/v1/ai-agent-handoff \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/wa/v1/bulk/{jobId}v1

Returns status and progress for a bulk WhatsApp send job.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/wa/v1/bulk/{jobId} \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/wa/v1/bulk/{jobId}/recipientsv1

Returns per-recipient delivery data for a bulk WhatsApp job.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/wa/v1/bulk/{jobId}/recipients \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/wa/v1/bulk/{jobId}/recipientsv1

Returns per-recipient delivery data for a bulk WhatsApp job.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/wa/v1/bulk/{jobId}/recipients \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/wa/v1/inbox/conversationsv1

Lists conversations for the authenticated WABA with pagination and optional polling support via the `since` query parameter.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/wa/v1/inbox/conversations \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/wa/v1/inbox/conversations/{id}/messagesv1

Returns paginated message history for a single conversation.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/wa/v1/inbox/conversations/{id}/messages \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/wa/v1/inbox/conversations/{id}/replyv1

Sends a free-form (session) text reply within an open 24-hour WhatsApp conversation window.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/wa/v1/inbox/conversations/{id}/reply \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/wa/v1/inbox/conversations/{id}/send-mediav1

Media

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/wa/v1/inbox/conversations/{id}/send-media \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/wa/v1/ivr/eventsv1

Public IVR event ingestion for third-party providers.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/wa/v1/ivr/events \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/wa/v1/sendv1

GET /api/wa/v1/send

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/wa/v1/send \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/wa/v1/sendv1

Public API for sending WhatsApp messages via API token.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/wa/v1/send \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/wa/v1/send/bulkv1

Bulk WhatsApp send via API token.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/wa/v1/send/bulk \
  -H "Authorization: Bearer YOUR_API_KEY"

Voice API

GET/api/voice/ext/audioext

List the org's audio library clips

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/voice/ext/audio \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/voice/ext/audioext

List the org's audio library clips

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/voice/ext/audio \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/voice/ext/audio/{id}/downloadext

Fetch a clip for playback/preview

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/voice/ext/audio/{id}/download \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/voice/ext/audio/ttsext

Synthesize a TTS clip (for a preview sample or to pre-generate a camp_type 2 message). Saves to the audio library and reuses on repeat, same as the dashboard route.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/voice/ext/audio/tts \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/voice/ext/callsext

Trigger a single outbound call via the external API

AuthAuthorization: Bearer <api_token>

Request Body

{
  "to_number": "string",
  "from_number": "string",
  "camp_type": 0,
  "tts_text": "string",
  "audio_id": "string",
  "audio_url": "string",
  "flow_id": "string",
  "campaign_id": "string"
}

cURL Example

curl -X POST https://api.pixabits.ai/api/voice/ext/calls \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to_number":"string","from_number":"string","camp_type":0,"tts_text":"string","audio_id":"string","audio_url":"string","flow_id":"string","campaign_id":"string"}'

GET/api/voice/ext/campaignsext

List campaigns for the org

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/voice/ext/campaigns \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/voice/ext/campaignsext

List campaigns for the org

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/voice/ext/campaigns \
  -H "Authorization: Bearer YOUR_API_KEY"

DELETE/api/voice/ext/campaigns/{id}ext

Get campaign details

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X DELETE https://api.pixabits.ai/api/voice/ext/campaigns/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/voice/ext/campaigns/{id}ext

Get campaign details

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/voice/ext/campaigns/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"

PATCH/api/voice/ext/campaigns/{id}ext

Get campaign details

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X PATCH https://api.pixabits.ai/api/voice/ext/campaigns/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"

PUT/api/voice/ext/campaigns/{id}ext

Get campaign details

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X PUT https://api.pixabits.ai/api/voice/ext/campaigns/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/voice/ext/campaigns/{id}/contactsext

Upload audience contacts to a voice campaign. Supports four content modes:

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/voice/ext/campaigns/{id}/contacts \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/voice/ext/campaigns/{id}/launchext

POST /api/voice/ext/campaigns/{id}/launch

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/voice/ext/campaigns/{id}/launch \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/voice/ext/campaigns/{id}/pauseext

Pause a running campaign

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/voice/ext/campaigns/{id}/pause \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/voice/ext/campaigns/{id}/resumeext

Resume a paused campaign

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/voice/ext/campaigns/{id}/resume \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/voice/ext/campaigns/{id}/statusext

Campaign status + KPIs

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/voice/ext/campaigns/{id}/status \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/voice/ext/campaigns/{id}/stopext

Stop a running/paused campaign

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/voice/ext/campaigns/{id}/stop \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/voice/ext/campaigns/runext

Run a voice campaign in ONE call.

AuthAuthorization: Bearer <api_token>

Request Body

{
  "name": "string",
  "recipients": [
    "..."
  ],
  "camp_type": 0,
  "caller_id": "string",
  "tts_text": "string",
  "audio_id": "string",
  "audio_url": "string",
  "flow_id": "string",
  "max_retries": 0,
  "scheduled_at": "string"
}

cURL Example

curl -X POST https://api.pixabits.ai/api/voice/ext/campaigns/run \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","recipients":["..."],"camp_type":0,"caller_id":"string","tts_text":"string","audio_id":"string","audio_url":"string","flow_id":"string","max_retries":0,"scheduled_at":"string"}'

POST/api/voice/ext/contactsext

Upload a named contact dataset — not tied to any specific campaign.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/voice/ext/contacts \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/voice/ext/ivrext

List the org's IVR / call flows

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/voice/ext/ivr \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/voice/ext/ivr/{id}ext

Get one IVR / call flow (summary/detail for preview)

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/voice/ext/ivr/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/voice/ext/recordings/{callId}ext

Download a call's recording

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/voice/ext/recordings/{callId} \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/voice/ext/reportsext

CDR / delivery reports for the org

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/voice/ext/reports \
  -H "Authorization: Bearer YOUR_API_KEY"

Email API

GET/api/email/ext/campaigns/{jobId}/statsext

Returns aggregate delivery stats for a send job (campaign).

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/email/ext/campaigns/{jobId}/stats \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/email/ext/domainsext

Returns verified sending domains for the authenticated organisation.

cURL Example

curl -X GET https://api.pixabits.ai/api/email/ext/domains

GET/api/email/ext/reportsext

Paginated delivery report — one row per recipient per job.

cURL Example

curl -X GET https://api.pixabits.ai/api/email/ext/reports

GET/api/email/ext/sendext

External API — send a single or bulk email using a Pixabits email API key.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/email/ext/send \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/email/ext/sendext

POST /api/email/ext/send

AuthAuthorization: Bearer <api_token>

Request Body

{
 "to": "recipient@example.com",
 "subject": "Hello",
 "htmlContent": "<html>...</html>",
 "fromEmail": "sender@brand.com",
 "fromName": "Brand",
 "replyTo": "reply@brand.com",
 "domain": "brand.com"
}

cURL Example

curl -X POST https://api.pixabits.ai/api/email/ext/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"recipient@example.com","subject":"Hello","htmlContent":"<html>...</html>","fromEmail":"sender@brand.com","fromName":"Brand","replyTo":"reply@brand.com","domain":"brand.com"}'

GET/api/email/ext/status/{jobId}ext

Returns delivery status and per-recipient breakdown for a send job.

cURL Example

curl -X GET https://api.pixabits.ai/api/email/ext/status/{jobId}

GET/api/email/ext/templatesext

External API — list email templates using a Pixabits email API key.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/email/ext/templates \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/email/ext/templatesext

External API — list email templates using a Pixabits email API key.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/email/ext/templates \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/email/ext/templates/{id}ext

External API — fetch a single email template by UUID.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/email/ext/templates/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/email/ext/templates/{id}ext

External API — fetch a single email template by UUID.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/email/ext/templates/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/email/ext/webhooksext

List registered webhooks

cURL Example

curl -X GET https://api.pixabits.ai/api/email/ext/webhooks

POST/api/email/ext/webhooksext

List registered webhooks

cURL Example

curl -X POST https://api.pixabits.ai/api/email/ext/webhooks

DELETE/api/email/ext/webhooks/{id}ext

Update (enable/disable/change url)

cURL Example

curl -X DELETE https://api.pixabits.ai/api/email/ext/webhooks/{id}

PATCH/api/email/ext/webhooks/{id}ext

Update (enable/disable/change url)

cURL Example

curl -X PATCH https://api.pixabits.ai/api/email/ext/webhooks/{id}

POST/api/v1/email/otp/sendv1

Customer-facing Email OTP — generate + send a one-time code.

cURL Example

curl -X POST https://api.pixabits.ai/api/v1/email/otp/send

GET/api/v1/email/otp/statsv1

Live OTP metrics for the customer-facing API:

cURL Example

curl -X GET https://api.pixabits.ai/api/v1/email/otp/stats

POST/api/v1/email/otp/verifyv1

Customer-facing Email OTP — verify a code against a prior /send requestId.

cURL Example

curl -X POST https://api.pixabits.ai/api/v1/email/otp/verify

RCS API

GET/api/rcs/ext/accountext

Use this as a "ping" to verify your integration is configured correctly.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/rcs/ext/account \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/rcs/ext/bulkext

External bulk RCS send — sends the same approved template to a list of mobile numbers. Callable from any system using a Bearer API token.

AuthAuthorization: Bearer <api_token>

Request Body

{
 "templateId": "template-uuid-or-id",
 "mobiles":    ["9876543210", "9123456789"]
}

cURL Example

curl -X POST https://api.pixabits.ai/api/rcs/ext/bulk \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"templateId":"template-uuid-or-id","mobiles":["9876543210","9123456789"]}'

GET/api/rcs/ext/bulk/{jobId}ext

Returns status and progress for a bulk send job.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/rcs/ext/bulk/{jobId} \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/rcs/ext/bulk/{jobId}/statsext

Returns delivery stats for a bulk send job.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/rcs/ext/bulk/{jobId}/stats \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/rcs/ext/messagesext

Paginated + filterable list of messages sent via this API key, plus aggregate stats for the requested date range.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/rcs/ext/messages \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/rcs/ext/reportsext

Summary and daily breakdown for all messages sent via this API key.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/rcs/ext/reports \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/rcs/ext/statusext

Look up delivery status for a specific message.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/rcs/ext/status \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/rcs/ext/templatesext

GET /api/rcs/ext/templates

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/rcs/ext/templates \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/rcs/ext/templatesext

Creates a template in 'draft' status.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X POST https://api.pixabits.ai/api/rcs/ext/templates \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/rcs/ext/templates/{id}ext

Returns a single template by ID (must belong to the org).

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/rcs/ext/templates/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"

PATCH/api/rcs/ext/templates/{id}ext

Allows updating name, title, body, suggestions, media, cards of a draft template.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X PATCH https://api.pixabits.ai/api/rcs/ext/templates/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/rcs/ext/walletext

Returns current wallet balance, and usage/transaction history scoped to RCS and this API key.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/rcs/ext/wallet \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/api/rcs/ext/webhooksext

Lists all registered webhook endpoints for this API key's organisation.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X GET https://api.pixabits.ai/api/rcs/ext/webhooks \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/api/rcs/ext/webhooksext

AuthAuthorization: Bearer <api_token>

Request Body

{
  "url": "string",
  "events": "string",
  "secret": "string"
}

cURL Example

curl -X POST https://api.pixabits.ai/api/rcs/ext/webhooks \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"string","events":"string","secret":"string"}'

DELETE/api/rcs/ext/webhooks/{id}ext

Permanently removes a registered webhook endpoint.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X DELETE https://api.pixabits.ai/api/rcs/ext/webhooks/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"

PATCH/api/rcs/ext/webhooks/{id}ext

Update events list, isActive flag, or secret.

AuthAuthorization: Bearer <api_token>

cURL Example

curl -X PATCH https://api.pixabits.ai/api/rcs/ext/webhooks/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"

Webhooks

Webhooks deliver real-time event notifications to your server via HTTP POST. Configure your webhook URL in the Dashboard. Each event includes a JSON payload with event type, timestamp, and relevant data.

Event	Channel	Description
sms.message.delivered	SMS	SMS delivered to handset
sms.message.failed	SMS	SMS delivery failed
sms.otp.verified	SMS	OTP code verified successfully
wa.message.delivered	WhatsApp	WhatsApp message delivered
wa.message.read	WhatsApp	WhatsApp message read by recipient
wa.message.received	WhatsApp	Incoming WhatsApp message from user
voice.call.answered	Voice	Outbound call answered
voice.call.completed	Voice	Call ended — duration and recording available
email.delivered	Email	Email delivered to inbox
email.opened	Email	Email opened by recipient
email.clicked	Email	Link clicked in email body
email.bounced	Email	Email bounced (hard or soft)
rcs.message.delivered	RCS	RCS message delivered to handset
rcs.message.read	RCS	RCS message read by recipient
rcs.fallback.triggered	RCS	Fallback to SMS triggered for RCS
push.delivered	Push	Push notification delivered to device
push.clicked	Push	User tapped on push notification
vas.verification.success	VAS	KYC/verification completed successfully
vas.verification.failed	VAS	Verification failed or rejected
net.sim-swap.detected	Network API	SIM swap event detected on number
net.number.verified	Network API	Silent number verification completed
aicam.campaign.completed	AiCAM	Campaign run completed with results
aicam.ab-test.winner	AiCAM	A/B test winner variant selected by AI
wallet.recharged	Billing	Wallet recharge payment confirmed
wallet.balance.low	Billing	Wallet balance below threshold

Example Webhook Payload

{
  "event": "sms.message.delivered",
  "timestamp": "2026-03-21T10:05:00Z",
  "data": {
    "message_id": "msg_abc123",
    "to": "+919876543210",
    "status": "delivered",
    "delivered_at": "2026-03-21T10:04:58Z"
  }
}

Error Codes

All API responses include a standard HTTP status code. Below are the codes you may encounter.

Status	Code	Description
200	OK	Request succeeded
201	CREATED	Resource created successfully
400	BAD_REQUEST	Invalid request body or parameters
401	UNAUTHORIZED	Missing or invalid API key
403	FORBIDDEN	Insufficient permissions or plan restriction
404	NOT_FOUND	Resource not found
409	CONFLICT	Duplicate resource or conflicting state
422	VALIDATION_ERROR	Request body failed validation
429	RATE_LIMITED	Too many requests — retry after cooldown
500	INTERNAL_ERROR	Server error — contact support if persistent
503	SERVICE_UNAVAILABLE	Temporary outage — retry with backoff

Rate Limits

Rate limits are enforced per API key. When you exceed the limit, the API returns a 429 status with a Retry-After header indicating when to retry.

Plan	Requests/sec	Burst	Daily Limit
Starter	10 req/sec	50	1,000 messages
Growth	200 req/sec	1,000	Unlimited
Enterprise	1,000 req/sec	5,000	Unlimited
Premium	5,000+ req/sec	10,000	Unlimited

SDKs

Official SDKs for popular languages. Install via your package manager and start building in minutes.

🐍Python

pip install pixabits

View on GitHub

⬢Node.js

npm install pixabits

View on GitHub

🐘PHP

composer require pixabits/pixabits

View on GitHub

🔵Go

go get github.com/pixabits/pixabits-go

View on GitHub

☕Java

<dependency>
  <groupId>ai.pixabits</groupId>
  <artifactId>pixabits-java</artifactId>
  <version>1.0.0</version>
</dependency>

View on GitHub

💎Ruby

gem install pixabits

View on GitHub