Messages API

The Messages API enables you to send messages to your contacts through multiple channels including SMS and WhatsApp.

Available Endpoints

Send Message to Contact

View endpoint

Send a message to an existing contact using their contact ID.

Send Message to Phone

View endpoint

Send a message directly to a phone number without requiring a pre-existing contact.

Key Features

• Multi-channel Delivery: Automatically route messages via SMS or WhatsApp based on contact preferences
• Template Support: Use pre-approved message templates for consistent messaging
• Webhook Notifications: Receive real-time delivery status updates
• Bulk Messaging: Send messages to multiple recipients efficiently

Authentication

All Messages API endpoints require the standard authentication headers:

x-sender-id: YOUR_SENDER_ID
x-api-key: YOUR_API_KEY

Message Flow

1. Choose Endpoint: Select based on whether you have a contact ID or just a phone number
2. Prepare Message: Use a template or custom message body
3. Send Request: Submit the message via API
4. Track Delivery: Monitor status via webhooks or polling