API Reference
Complete API documentation with endpoints and examples
Authentication
All API requests require authentication using an API key. Include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEYBase URL
https://api.yourplatform.com/v1Send Message
POST /messages
Send a message using an approved template.
Request Body
{
"to": "+1234567890",
"template": "welcome_message",
"language": "en",
"parameters": {
"name": "John Doe"
}
}Response
{
"id": "msg_123456",
"status": "sent",
"timestamp": "2024-01-01T12:00:00Z"
}Get Message Status
GET /messages/:id
Retrieve the status of a sent message.
Create Template
POST /templates
Create a new message template for approval.
Webhooks
Configure webhooks to receive real-time notifications for message events:
- message.sent
- message.delivered
- message.read
- message.failed
Rate Limits
API requests are rate limited to 100 requests per minute per API key.
Error Codes
- 400 - Bad Request
- 401 - Unauthorized
- 429 - Too Many Requests
- 500 - Internal Server Error