Documentation Overview
Welcome to the API documentation for our services. This documentation is divided into two main sections to help you easily find the information you need:
User API
The User API section contains endpoints and examples that are primarily for end-users who are interacting with our service to perform various tasks such as requesting phone numbers, checking balances, and retrieving lists of countries and services.
- Request a Phone Number
- Learn how to request a phone number using our API.
- Receive SMS
- Start using our webhook to get notified of new sms.
- Get List of All Countries
- Retrieve a list of all available countries.
- Get List of All Services
- Retrieve a list of all available services.
- Check Balance
- Find out how to check your account balance.
Partner API
The Partner API section contains endpoints and examples that are intended for partners who need to integrate more deeply with our systems. This includes webhooks and advanced configurations for automated interactions.
- Push SMS Webhook
- Set up a webhook to forward received messages to your server.
Getting Started
To get started with the APIs, you will need your API key, which can be found in your profile settings. Each API call requires this key to authenticate your requests.
Security
Ensure that your API key is kept secure and not shared publicly. Use HTTPS for all API requests to protect your data in transit.
Common Error Codes
Here are some common error codes you might encounter:
- wrong_token: The API key provided is incorrect.
- NO_OPERATION: The number has no active operation.
- BAD_SERVICE: The service is banned by our server.
- IGNORED: The service differs from the one ordered by the client.
- SERVICE_BAN: The service is blacklisted.
For more detailed error handling, refer to the individual endpoint documentation.
Support
If you need further assistance, please contact our support team. We're here to help you with any questions or issues you might encounter.
Happy integrating!