Introduction
Details on authentication, rate limits, and error handling.
Base URL
All API requests should be made to the following base URL:
https://api.postack.dev/v1
Authentication
To authenticate with our API, use a Bearer token in the format Bearer {{API_KEY}}. You can obtain your API key from the Postack console. This method ensures secure access to our API endpoints.
Rate Limits
Each client is limited to 10 requests per second (RPS). This rate limit helps to ensure fair usage and maintain the quality of service for all users.
Error Codes
Understanding error codes is crucial for effective error handling in your application. Below, we’ve outlined common error codes for two main operations: sending SMS and verifications.
| Code | Description |
|---|---|
invalid_sender | Sender is either not associated with your account or does not exist. |
invalid_recipient | Recipient should be in E.164 format. |
invalid_short_code_recipient | Short code can send messages only to recipients in the same country. |
messaging_disabled | Sender does not have messaging capabilities. |
tollfree_verification_required | Tollfree number requires verification. |
missing_campaign | Sending messages to US from a 10DLC number requires an approved campaign. |
unsupported_destination | Sending messages to the destination is not supported. |
destination_disabled | This destination is disabled for messaging. Please contact support to enable it. |
invalid_text | Message text is either missing or too long. |
invalid_message | No message found for the given id. |
This guide aims to provide you with a clear understanding of how to authenticate, handle rate limits, and interpret error codes for a smoother development experience with our API.