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)
  ↳ AuthenticationAuthentication
  ↳ Base ResponseBase Response
  ↳ Communications Platform APICommunications Platform API
  ↳ Document conventionsDocument conventions
  ↳ Making RequestsMaking Requests
  ↳ Message throughput and rate limitsMessage throughput and rate limits
  ↳ NotesNotes
  ↳ SMS encoding and character limitsSMS encoding and character limits
  ↳ Status CodesStatus Codes
Send SMSSMS overview
  ↳ Callback URL (MO)Callback URL (MO)
  ↳ Callback URL (MT)Callback URL (MT)
  ↳ Inbound SMSInbound SMS
  ↳ Outbound SMSOutbound SMS
  ↳ Sending Outbound SMSSending Outbound SMS
Send WhatsApp messagesWhatsApp
  ↳ Sending WhatsApp Message TemplateSending WhatsApp Message Template
    ↳ Media Message TemplateMedia Message Template
    ↳ Text Message TemplateText Message Template
  ↳ Sending WhatsApp Session MessageSending WhatsApp Session Message
  ↳ WhatsApp CarouselWhatsApp Carousel
  ↳ WhatsApp FlowsWhatsApp Flows
    ↳ Flows with Message TemplatesFlows with Message Templates
    ↳ Static FlowsStatic Flows
    ↳ Webhook - WhatsApp Flow ResponsesWebhook - WhatsApp Flow Responses
  ↳ WhatsApp Message TemplatesWhatsApp Message Templates
    ↳ Callback URL WhatsApp BusinessCallback URL WhatsApp Business
    ↳ Creating & Sending WhatsApp Authentication Message TemplateCreating & Sending WhatsApp Authentication Message Template
    ↳ Creating & Sending WhatsApp Media Message TemplateCreating & Sending WhatsApp Media Message Template
    ↳ Creating & Sending WhatsApp Session MessagesCreating & Sending WhatsApp Session Messages
    ↳ Creating & Sending WhatsApp Text Message TemplateCreating & Sending WhatsApp Text Message Template
    ↳ Simulating Inbound WhatsApp MessageSimulating Inbound WhatsApp Message
    ↳ Webhook Notification Payload ExamplesWebhook Notification Payload Examples
    ↳ WhatsApp Business Step by Step OnboardingWhatsApp Business Step by Step Onboarding
Send RCSSending RCS
Send EmailEmail
  ↳ Sending EmailSending Email
Send a message via the unified Messaging APIMessaging
  ↳ Contacts MessageContacts Message
  ↳ Interactive MessageInteractive Message
  ↳ Location MessageLocation Message
  ↳ Media MessageMedia Message
  ↳ Text MessageText Message
Send broadcasts via APIBroadcast
  ↳ Creating and Sending Email BroadcastCreating and Sending Email Broadcast
  ↳ Creating and Sending SMS BroadcastCreating and Sending SMS Broadcast
  ↳ Creating and Sending WhatsApp BroadcastCreating and Sending WhatsApp Broadcast
Manage contact lists via APIList Management
Use two-factor authenticationTwo Factor Authentication
  ↳ Two Factor Authentication (WhatsApp)Two Factor Authentication (WhatsApp)
Shorten URLsURL Shortener
Manage blocklisted contacts via APIBlocklisted Contact
Pull reporting data via APIReporting
Integrate via SFTP, SMPP, or webhooksDeveloper Messaging Integrations
  ↳ SFTP Messaging IntegrationSFTP Messaging Integration
    ↳ Sending SMS via SFTPSending SMS via SFTP
    ↳ Sending WhatsApp via SFTPSending WhatsApp via SFTP
      ↳ Sending WhatsApp media templates via SFTPSending WhatsApp media templates via SFTP
      ↳ Sending WhatsApp session messages via SFTPSending WhatsApp session messages via SFTP
      ↳ Sending WhatsApp text templates via SFTPSending WhatsApp text templates via SFTP
  ↳ SMPP Messaging IntegrationSMPP 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.


What’s Next

Related pages