API 2.0 (Current)
Our API is a protocol for interaction between your software and our activation server. The API automates the process of receiving SMS messages on your side.
Endpoint URL
All API requests should be sent via POST or GET methods to:
https://heyalex.store/stubs/handler_api.php
🔑 Authentication
All requests to the API must include your API key as the api_key parameter.
Your API Key
••••••••••••••••••••••••••••••••
Security Notice: Keep your API key secure. Do not share it in client-side code or public repositories.
GET
Get Balance
❱
Retrieve your current account balance
Endpoint
https://heyalex.store/stubs/handler_api.php?api_key=$api_key&action=getBalance
Parameters
| Field | Type | Req | Description |
|---|---|---|---|
| action | String | Yes | Must be getBalance |
| api_key | String | Yes | Your unique API key |
Success Response
| Code | Value / Description |
|---|---|
ACCESS_BALANCE:100.20 | Current account balance. |
Error Responses
| Code | Description |
|---|---|
BAD_KEY | Invalid API key. |
ERROR | General server error. |
Node.js example
const axios = require('axios');
async function getBalance() {
try {
const response = await axios.get('https://heyalex.store/stubs/handler_api.php', {
params: {
api_key: 'YOUR_API_KEY',
action: 'getBalance'
}
});
console.log(response.data);
} catch (error) {
console.error(error);
}
}
getBalance();
GET
Get Operators
❱
Retrieve all available network operators
Endpoint
https://heyalex.store/stubs/handler_api.php?api_key=$api_key&action=getOperators
Success Response
{
"Operator 1": "1",
"Operator 2": "2",
"Any": "any"
}
Error Responses
| Code | Description |
|---|---|
BAD_ACTION | Invalid action. |
TOO_MANY_REQUESTS | Rate limit exceeded. |
GET
Request a Number
❱
Get a virtual phone number for SMS verification
Endpoint
https://heyalex.store/stubs/handler_api.php?api_key=$api_key&action=getNumber&service=$service&country=$country&operator=$operator
Parameters
| Field | Required | Description |
|---|---|---|
| service | Yes | Service ID (e.g. wa). |
| country | Yes | Country ID (e.g. 91). |
| operator | No | Network operator ID. |
| maxPrice | No | Mandatory for operator 6 & 9. |
Success Response
ACCESS_NUMBER:3423423432:914738485900
Error Responses
| Code | Description |
|---|---|
NO_NUMBERS | No inventory available. |
NO_BALANCE | Insufficient balance. |
BAD_SERVICE | Invalid service code. |
GET
Get SMS Status
❱
Retrieve SMS code from the virtual number
Endpoint
https://heyalex.store/stubs/handler_api.php?api_key=$api_key&action=getStatus&id=$id
Success Responses
| Code | Description |
|---|---|
STATUS_OK:12343 | SMS received. Code is 12343. |
STATUS_WAIT_CODE | Pending delivery. |
Error Responses
| Code | Description |
|---|---|
NO_ACTIVATION | Invalid Order ID. |
STATUS_CANCEL | Order timed out/cancelled. |
GET
Change Status
❱
Update the status of a phone number request (Cancel or Retry)
Endpoint
https://heyalex.store/stubs/handler_api.php?api_key=$api_key&action=setStatus&status=$status&id=$id
Parameters
| Field | Required | Description |
|---|---|---|
| status | Yes | 3 = Request another SMS, 8 = Cancel |
| id | Yes | Activation Order ID |
Success Responses
| Code | Description |
|---|---|
ACCESS_CANCEL | Cancellation successful. |
ACCESS_RETRY_GET | Waiting for next SMS. |
GET
Get Countries
❱
Retrieve all available countries
Endpoint
https://heyalex.store/stubs/handler_api.php?api_key=$api_key&action=getCountries
Success Response
{
"1": "Ukraine",
"91": "India",
"21": "USA"
}
GET
Get Services
❱
Retrieve all available services
Endpoint
https://heyalex.store/stubs/handler_api.php?api_key=$api_key&action=getServices
Success Response
{
"wa": "WhatsApp",
"tg": "Telegram",
"ig": "Instagram"
}
🔍 API Data Explorer
Instantly lookup live codes, names and prices required for your API requests.