Developer guide introduction
Exchange information about messages, contacts, and owners using the platform's HTTP-based REST APIs with JSON requests and responses. For developers integrating messaging capabilities after obtaining an API key.
Use the Communications Platform REST APIs to exchange information about messages, contacts, and owners programmatically. Every capability documented in the Communications Platform user guide has a corresponding API endpoint here. Request and response bodies use JSON.
Who this is for
This section is for developers integrating messaging capabilities into their own applications via API.
Before you begin
- Review web programming concepts, including HTTP requests and responses.
- Prepare to send and process JSON data.
- Ask a platform administrator to retrieve an API key for your integration (see Preferences).
Two webhook mechanisms
This platform has two separate webhook-like mechanisms -- use the one that matches your use case:
- Custom Webhook: configured under Communications Platform → Integrations. Routes Live Chat and Chatbot automation events (inbound/outbound messages, session start/end) to an endpoint you control.
- Callback URL WhatsApp Business: configured for your WhatsApp Business Account. Receives Meta's native WhatsApp Business notifications (message delivery status, account status changes) directly from Meta.
Find your task
| I want to... | Go to |
|---|---|
| Learn the API fundamentals | (this page) |
| ↳ Authentication | Authentication |
| ↳ Base Response | Base Response |
| ↳ Communications Platform API | Communications Platform API |
| ↳ Document conventions | Document conventions |
| ↳ Making Requests | Making Requests |
| ↳ Message throughput and rate limits | Message throughput and rate limits |
| ↳ Notes | Notes |
| ↳ SMS encoding and character limits | SMS encoding and character limits |
| ↳ Status Codes | Status Codes |
| Send SMS | SMS overview |
| ↳ Callback URL (MO) | Callback URL (MO) |
| ↳ Callback URL (MT) | Callback URL (MT) |
| ↳ Inbound SMS | Inbound SMS |
| ↳ Outbound SMS | Outbound SMS |
| ↳ Sending Outbound SMS | Sending Outbound SMS |
| Send WhatsApp messages | |
| ↳ Sending WhatsApp Message Template | Sending WhatsApp Message Template |
| ↳ Media Message Template | Media Message Template |
| ↳ Text Message Template | Text Message Template |
| ↳ Sending WhatsApp Session Message | Sending WhatsApp Session Message |
| ↳ WhatsApp Carousel | WhatsApp Carousel |
| ↳ WhatsApp Flows | WhatsApp Flows |
| ↳ Flows with Message Templates | Flows with Message Templates |
| ↳ Static Flows | Static Flows |
| ↳ Webhook - WhatsApp Flow Responses | Webhook - WhatsApp Flow Responses |
| ↳ WhatsApp Message Templates | WhatsApp Message Templates |
| ↳ Callback URL WhatsApp Business | Callback URL WhatsApp Business |
| ↳ Creating & Sending WhatsApp Authentication Message Template | Creating & Sending WhatsApp Authentication Message Template |
| ↳ Creating & Sending WhatsApp Media Message Template | Creating & Sending WhatsApp Media Message Template |
| ↳ Creating & Sending WhatsApp Session Messages | Creating & Sending WhatsApp Session Messages |
| ↳ Creating & Sending WhatsApp Text Message Template | Creating & Sending WhatsApp Text Message Template |
| ↳ Simulating Inbound WhatsApp Message | Simulating Inbound WhatsApp Message |
| ↳ Webhook Notification Payload Examples | Webhook Notification Payload Examples |
| ↳ WhatsApp Business Step by Step Onboarding | WhatsApp Business Step by Step Onboarding |
| Send RCS | Sending RCS |
| Send Email | |
| ↳ Sending Email | Sending Email |
| Send a message via the unified Messaging API | Messaging |
| ↳ Contacts Message | Contacts Message |
| ↳ Interactive Message | Interactive Message |
| ↳ Location Message | Location Message |
| ↳ Media Message | Media Message |
| ↳ Text Message | Text Message |
| Send broadcasts via API | Broadcast |
| ↳ Creating and Sending Email Broadcast | Creating and Sending Email Broadcast |
| ↳ Creating and Sending SMS Broadcast | Creating and Sending SMS Broadcast |
| ↳ Creating and Sending WhatsApp Broadcast | Creating and Sending WhatsApp Broadcast |
| Manage contact lists via API | List Management |
| Use two-factor authentication | Two Factor Authentication |
| ↳ Two Factor Authentication (WhatsApp) | Two Factor Authentication (WhatsApp) |
| Shorten URLs | URL Shortener |
| Manage blocklisted contacts via API | Blocklisted Contact |
| Pull reporting data via API | Reporting |
| Integrate via SFTP, SMPP, or webhooks | Developer Messaging Integrations |
| ↳ SFTP Messaging Integration | SFTP Messaging Integration |
| ↳ Sending SMS via SFTP | Sending SMS via SFTP |
| ↳ Sending WhatsApp via SFTP | Sending WhatsApp via SFTP |
| ↳ Sending WhatsApp media templates via SFTP | Sending WhatsApp media templates via SFTP |
| ↳ Sending WhatsApp session messages via SFTP | Sending WhatsApp session messages via SFTP |
| ↳ Sending WhatsApp text templates via SFTP | Sending WhatsApp text templates via SFTP |
| ↳ SMPP Messaging Integration | SMPP Messaging Integration |
| ↳ SMPP Traffic (Analytics & Reporting) | SMPP Traffic (Analytics & Reporting) |
Looking for the web interface instead?
See the Communications Platform introduction for the same capabilities via the Workspace UI, no code required.
Chatbot, Live Chat, and Administration Console are configured through their own sections in the platform UI, not through this API — see Chatbot introduction, Live Chat introduction, and Administration Console introduction.
Updated 13 days ago
