Base URL
All API requests should be made to:Authentication
All endpoints require Bearer token authentication:Request Format
- All request bodies must be JSON
- Include
Content-Type: application/jsonheader - Phone numbers must be in E.164 format (e.g.,
+56912345678)
Response Format
All responses are JSON. Successful responses include the resource:HTTP Status Codes
| Code | Description |
|---|---|
200 | Success |
201 | Resource created |
202 | Accepted (async processing) |
204 | No content (successful deletion) |
400 | Bad request - invalid parameters |
401 | Unauthorized - invalid API key |
403 | Forbidden - insufficient permissions |
404 | Not found |
409 | Conflict - duplicate idempotency key |
429 | Rate limit exceeded |
500 | Internal server error |
Rate Limits
| Endpoint | Limit |
|---|---|
POST /v1/messages | 100 requests/second |
GET /v1/messages | 1000 requests/minute |
| All other endpoints | 1000 requests/minute |
Pagination
List endpoints support cursor-based pagination:| Parameter | Type | Description |
|---|---|---|
limit | integer | Items per page (default: 50, max: 100) |
cursor | string | Cursor from previous response |
Idempotency
ForPOST requests, include an idempotencyKey to prevent duplicates:
409 Conflict with the original resource.