Getting Started
Authentication, rate limits, and status codes
Overview
The SMS service API allows you to manage SMS operations and address books. Obtain your Access Token from Service Settings > Generate API Key. Your API URL can be found in Account Settings (accessible via the avatar menu), labeled "API URL". All requests must be made over HTTPS. The API follows REST conventions and uses JSON encoding.
Authorization
Authenticate by including a Bearer token in the Authorization header with every request.
Rate Limiting
The API allows an average of 10 requests per second. Bursts are allowed. When rate limited, the API returns HTTP 429 with a rate_limited error code. The response includes a Retry-After header indicating the number of seconds to wait before retrying. As an alternative, consider queue-based request management.
Status Codes
200 - Success. 403 - Authentication failed. 500 - Server error.