Документация API
Номера, сообщения и начисления — из вашего приложения.
Начните с одного запроса
Создайте API-ключ в кабинете, получите номер и проверяйте сообщения каждые 20 секунд. Вознаграждение начисляется при получении SMS с кодом; повторное чтение не влияет на баланс.
https://smscash.org/api/v1https://smscash.org/stubs/handler_api.phpcurl -X POST 'https://smscash.org/api/v1/activations' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: request-unique-001' \
-d '{"service":"go","country":86}'Альтернативный адрес совместимого интерфейса: /handler_api.php. Существующие REST-интеграции продолжают работать.
Конструктор запросов
Idempotency-Key: UUID · POST · 8–128
Автовыбор: больше кодов за час, затем за сутки. Нет номеров — следующий оператор.
curl --max-time 15 --fail-with-body -X POST 'https://smscash.org/api/v1/activations' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: request-unique-001' \
--data '{"service":"go","country":86}'package main
import (
"bytes"
"fmt"
"io"
"net/http"
"os"
"time"
)
func main() {
payload := []byte("{\"service\":\"go\",\"country\":86}")
req, err := http.NewRequest("POST", "https://smscash.org/api/v1/activations", bytes.NewReader(payload))
if err != nil { panic(err) }
req.Header.Set("Authorization", "Bearer " + os.Getenv("SMSCASH_API_KEY"))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Idempotency-Key", "request-unique-001")
client := &http.Client{Timeout: 15 * time.Second, CheckRedirect: func(_ *http.Request, _ []*http.Request) error { return http.ErrUseLastResponse }}
res, err := client.Do(req)
if err != nil { panic(err) } // Keep the same operation key after a network error.
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil { panic(err) }
if res.StatusCode >= 300 {
fmt.Fprintf(os.Stderr, "HTTP %d, request_id=%s\n%s\n", res.StatusCode, res.Header.Get("X-Request-ID"), body)
os.Exit(1)
}
fmt.Println(string(body))
}// Node.js 18+: set SMSCASH_API_KEY in your environment.
const response = await fetch("https://smscash.org/api/v1/activations", {
method: "POST",
headers: {
Authorization: 'Bearer ' + process.env.SMSCASH_API_KEY,
'Content-Type': 'application/json',
'Idempotency-Key': "request-unique-001",
},
body: JSON.stringify({
"service": "go",
"country": 86
}),
signal: AbortSignal.timeout(15000),
redirect: 'error',
});
const result = await response.json();
if (!response.ok) {
const error = result.error || {};
console.error(response.status, error.code, error.hint, error.request_id);
throw new Error(error.message || 'API error');
}
console.log(result);
// SMS codes are strings: keep leading zeros. Never retry writes automatically.import json
import os
import urllib.error
import urllib.request
class NoRedirect(urllib.request.HTTPRedirectHandler):
def redirect_request(self, req, fp, code, msg, headers, newurl):
return None
headers = {
'Authorization': 'Bearer ' + os.environ['SMSCASH_API_KEY'],
'Content-Type': 'application/json',
'Idempotency-Key': "request-unique-001",
}
request = urllib.request.Request(
"https://smscash.org/api/v1/activations",
headers=headers,
data="{\"service\":\"go\",\"country\":86}".encode('utf-8'),
method="POST",
)
try:
with urllib.request.build_opener(NoRedirect).open(request, timeout=15) as response:
result = json.load(response)
print(result)
except urllib.error.HTTPError as error:
details = json.load(error).get('error', {})
print(error.code, details.get('code'), details.get('hint'), details.get('request_id'))
raise
# No automatic retries; SMS codes remain strings.Ключ не сохраняется. Проверка не выдаёт номера.
REST для новых интеграций
Сервисы и страны
Выберите сервис и страну. Оплата за SMS зависит от страны.
GET /api/v1/catalog?service=go&country=86&page=1&page_size=100
Authorization: Bearer YOUR_API_KEY{
"rows": [
{
"offer_id": 42,
"service": "go",
"service_name": "Google",
"country_id": 86,
"country_name": "Italy",
"provider_id": 1,
"operator": 1,
"provider_name": "Operator 1",
"reward": "0.00300000",
"currency": "USD",
"accounting_precision": 8,
"earnings_hold_days": 45
}
],
"page": 1,
"page_size": 100,
"total": 1,
"pages": 1,
"has_more": false,
"accounting_precision": 8
}service · country · operator · q · page · page_size (1–100)
Получить номер
POST /api/v1/activations
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Idempotency-Key: request-unique-001
{
"service": "go",
"country": 86
}Автовыбор: больше кодов за час, затем за сутки. Нет номеров — следующий оператор.
201: new session · 200: replay of the same operation
service + country OR offer_id · duration_minutes: 20
ref: software owner code (optional)
operator: public ID (e.g. 1 for Operator 1), optional · any/0: automatic
country: integer · service: string · SMS code: stringНомер действует 20 минут. Проверка SMS — каждые 20 секунд. Отмена доступна сразу.
Проверка нескольких номеров
GET /api/v1/activations/batch?ids=42,43
Authorization: Bearer YOUR_API_KEY{
"rows": [
{
"id": 42,
"found": true,
"phone": "12025550123",
"status": "received",
"service": "go",
"country_id": 86,
"provider_id": 1,
"operator": 1,
"expires_at": "2026-10-10T12:15:00Z",
"sms_count": 1,
"code": "001234",
"last_sms": {
"id": 101,
"code": "001234",
"sender": "Service",
"text": "Code: 001234",
"received_at": "2026-10-10T12:01:00Z"
}
},
{
"id": 43,
"found": false,
"error": {
"code": "NO_ACTIVATION",
"message": "Session not found."
}
}
],
"as_of": "2026-10-10T12:01:00Z",
"poll_interval_seconds": 20
}ids: 1–100 positive session IDs, separated by commas
Input order preserved · duplicates removed
Foreign, unavailable or out-of-scope IDs: found=false
Read only · no supplier requests · last_sms is the latest messageБаланс · В холде
GET /api/v1/balance
Authorization: Bearer YOUR_API_KEY{
"currency": "USD",
"accounting_precision": 8,
"balance": "12.00000000",
"held_balance": "34.50000001",
"balance_minor": "1200000000",
"held_minor": "3450000001",
"as_of": "2026-10-12T20:00:00Z",
"next_release_at": "2026-11-26T20:00:00Z"
}balance — Доступно; held_balance — В холде. USD · 8
Вывести можно только средства, у которых завершён холд.
Готовые клиенты
import {SmScash, SmScashError} from './smscash.mjs';
import {randomUUID} from 'node:crypto';
const api = new SmScash(process.env.SMSCASH_API_KEY);
const catalog = await api.catalog({service: 'go', country: 86});
console.log(catalog.rows);
// Save this key before sending; keep it for retries of this operation.
const requestKey = randomUUID();
const session = await api.createNumber({service: 'go', country: 86}, requestKey);
// After 20 seconds:
const messages = await api.sms(session.id, {afterId: 0});
console.log(messages.sms);
const statuses = await api.batch([session.id]);
const held = await api.holdBalance();
console.log(held); // Exact USD stringimport os
import uuid
from smscash import SmScash, SmScashError
api = SmScash(os.environ['SMSCASH_API_KEY'])
catalog = api.catalog(service='go', country=86)
print(catalog['rows'])
# Save this key before sending; keep it for retries of this operation.
request_key = str(uuid.uuid4())
session = api.create_number({'service': 'go', 'country': 86}, request_key)
# After 20 seconds:
messages = api.sms(session['id'], after_id=0)
print(messages['sms'])
statuses = api.batch([session['id']])
held = api.hold_balance()
print(held) # Exact USD stringme() · balance() · holdBalance()/hold_balance() · catalog() · activation() · sms() · batch()
createNumber(parameters, requestKey) / create_number(parameters, request_key)
setStatus(id, "cancel") / set_status(id, "cancel")
setStatus(id, "retry", requestKey) / set_status(id, "retry", request_key)
Timeout: 15 s · no dependencies · no automatic retries
Error: code · status · hint · requestId/request_id · retryable
ALLOCATION_UNCERTAIN: contact support with request_id; never retry automatically.SMS-Activate / HeroSMS
https://smscash.org/sms-activate/stubs/handler_api.phphttps://smscash.org/hero-sms/stubs/handler_api.phpЛичный API-ключ пользователя.
Выберите сервис и страну. Оплата за SMS зависит от страны.
| Код | Описание |
|---|---|
getNumber / getNumberV2 | Получить номер |
getStatus / getStatusV2 | Получить последний код |
setStatus / finishActivation / cancelActivation | Управлять сессией |
getPrices / getNumbersStatus | Проверить наличие |
getRewards (SMScash) | Вознаграждение за SMS |
getServicesList / getServices | Сервисы |
getCountries / getOperators | Сервисы и страны |
getActiveActivations | Сессии |
getBalance | Баланс пользователя |
getHoldBalance (SMScash) | В холде |
cost = 0 USD · activationCost = 0 USDreward — Вознаграждение за SMS
curl --get 'https://smscash.org/hero-sms/stubs/handler_api.php' \
--data-urlencode 'api_key=YOUR_API_KEY' \
--data-urlencode 'action=getNumberV2' \
--data-urlencode 'service=go' \
--data-urlencode 'country=86' \
-H 'Idempotency-Key: request-unique-001'{
"activationId": "42",
"phoneNumber": "393331234567",
"activationCost": 0,
"currency": 840,
"countryCode": 86,
"canGetAnotherSms": true,
"activationTime": "2026-10-11T12:00:00Z",
"activationEndTime": "2026-10-11T12:15:00Z",
"reward": "0.00300000"
}GET or POST application/x-www-form-urlencoded
api_key · action · service · country · ref (optional)
setStatus: 1 → ACCESS_READY · 3 → ACCESS_RETRY_GET
6 → ACCESS_ACTIVATION · 8 → ACCESS_CANCEL
getStatus: STATUS_WAIT_CODE · STATUS_OK:001234 · STATUS_CANCEL
getStatusV2: {"verificationType":1,"sms":null,"call":null}
getServicesList: {"status":"success","services":[{"code":"go","name":"Google"}]}
getCountries: {"86":{"id":86,"eng":"Italy","visible":1,"retry":1,"rent":0}}
getPrices: {"86":{"go":{"cost":0,"count":12,"reward":"0.00300000","currency":"USD"}}}
getRewards: {"59":{"vi":{"1":"0.01000000"}}}
getRewards filters: country · service · operator (optional); any/0: all permitted providers
getActiveActivations: start=0 · limit=1–100 · activeActivations / data
Business/key errors: HTTP 200 + plain text · server errors: HTTP 500
Availability: actual supplier pool, shared cache up to 20 s; not a reservation
No automatic retries after a transport error or ALLOCATION_UNCERTAIN.
Keep the original Idempotency-Key and parameters.
Unsupported: rent · calls · forwarding · multiple services per number · prolong
Unsupported options return BAD_REQUEST; unsupported actions return BAD_ACTION.
SMScash keys and country/service codes; configure this base URL in your software.Номер действует 20 минут. Проверка SMS — каждые 20 секунд. Отмена доступна сразу.
Авторизация и повторы
REST: заголовок Authorization: Bearer YOUR_API_KEY. Совместимый интерфейс: параметры api_key и action. Используйте HTTPS.
Для управления API-ключами войдите в кабинет.
Частота запросов и количество номеров не ограничены. Суточных и часовых квот нет.
Номер действует 20 минут. Проверка SMS — каждые 20 секунд. Отмена доступна сразу.
В REST уникальный Idempotency-Key обязателен при выдаче, повторной выдаче, retry и заявке на выплату. В handler_api.php он необязателен, но рекомендуется. При сетевом повторе сохраняйте ключ; для новой операции создавайте новый.
Область API-ключа
Ключ можно привязать к сервисам, странам и поставщикам. Пустые списки разрешают все доступные варианты.
{
"label": "Мой софт",
"policy": {
"services": [
"go"
],
"countries": [
86
],
"providers": [
1
]
}
}PATCH /api/v1/keys/{id} меняет имя и policy целиком. Секрет показывается только при создании.
10% суммарно. 5% + 5% с кодом софта.
При выдаче номера передавайте ref владельца софта. Запрос авторизуется ключом пользователя. Код находится в разделе «Рефералы» и в GET /api/v1/referrals → software_ref.
| Запрос | Пригласившему | Софт |
|---|---|---|
| Без ref | 10% | — |
| С ref | 5% | 5% |
| С ref, пригласившего нет | — | 5% |
Бонус платит платформа, доход пользователя не уменьшается. Владелец софта и пригласивший могут совпадать. Собственный код пользователя недопустим.
Условия фиксируются при создании сессии; чтение SMS и retry их не меняют. В новой повторной сессии ref передаётся заново. В расчёте тарифа при 0,003 USD пользователю софт и пригласивший получают по 0,00015 USD. Общий бонус — 0,00030 USD.
Команды API
11 методов по образцу XVBC и баланс SMScash.
GETgetNumberПолучить номер+
Создаёт сессию и закрепляет свободный номер за пользователем. Тариф и получатели реферальных долей фиксируются при выдаче, а вознаграждение начисляется после получения SMS с кодом.
Параметры
| Параметр | Тип | Описание |
|---|---|---|
api_key* | string | Личный API-ключ пользователя. |
service* | string | Доступные коды сервисов. Ответ ограничен областью API-ключа. |
country* | integer | Возьмите ID из getCountries. |
operator | string | Возьмите ID из operators/getOperators (API). operator=1 · any/0 |
session_duration | integer | Срок сессии — 20 минут. Передайте 20 или пропустите параметр. |
with_operator | integer | 1 добавляет ID оператора в ответ; 0 или отсутствие — три сегмента. |
ref | string | Публичный код владельца софта: 5% ему и 5% пригласившему. Без ref — 10% пригласившему. |
* Обязательный параметр. Во всех запросах также передавайте action=getNumber.
Пример запроса
curl 'https://smscash.org/stubs/handler_api.php?action=getNumber&api_key=YOUR_API_KEY&service=go&country=86&with_operator=1' \
-H 'Idempotency-Key: request-unique-001'package main
import (
"fmt"
"io"
"net/http"
"time"
)
func main() {
req, err := http.NewRequest("GET", "https://smscash.org/stubs/handler_api.php?action=getNumber&api_key=YOUR_API_KEY&service=go&country=86&with_operator=1", nil)
if err != nil { panic(err) }
req.Header.Set("Idempotency-Key", "request-unique-001")
client := &http.Client{Timeout: 15 * time.Second}
resp, err := client.Do(req)
if err != nil { panic(err) }
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil { panic(err) }
fmt.Println(resp.StatusCode, string(body))
}const response = await fetch("https://smscash.org/stubs/handler_api.php?action=getNumber&api_key=YOUR_API_KEY&service=go&country=86&with_operator=1", {
headers: {"Idempotency-Key": "request-unique-001"}
});
const result = await response.text();
console.log(response.status, result);import requests
response = requests.get(
"https://smscash.org/stubs/handler_api.php?action=getNumber&api_key=YOUR_API_KEY&service=go&country=86&with_operator=1",
headers={"Idempotency-Key": "request-unique-001"},
timeout=15,
)
print(response.status_code, response.text)Ответы
ACCESS_NUMBER:42:380670000000:1EMPTY_POOL- Автовыбор: больше кодов за час, затем за сутки. Нет номеров — следующий оператор.
- Передавайте Idempotency-Key: одинаковый запрос с тем же ключом возвращает прежнюю сессию. Изменение параметров вызывает IDEMPOTENCY_CONFLICT.
- Числовая страна без пула даёт EMPTY_POOL; ошибочный формат country — BAD_COUNTRY.
- Ключ удалённой сессии остаётся использованным: повтор выдачи с этим ключом возвращает SESSION_CLOSED и не выдаёт новый номер.
- Результат выдачи не подтверждён. Автоматический повтор отключён, чтобы не выдать второй номер.
GETgetNumbersStatusПроверить наличие+
Количество доступных номеров по сервисам и стране.
Параметры
| Параметр | Тип | Описание |
|---|---|---|
api_key* | string | Личный API-ключ пользователя. |
country* | integer | Возьмите ID из getCountries. |
* Обязательный параметр. Во всех запросах также передавайте action=getNumbersStatus.
Пример запроса
curl 'https://smscash.org/stubs/handler_api.php?action=getNumbersStatus&api_key=YOUR_API_KEY&country=86'package main
import (
"fmt"
"io"
"net/http"
"time"
)
func main() {
req, err := http.NewRequest("GET", "https://smscash.org/stubs/handler_api.php?action=getNumbersStatus&api_key=YOUR_API_KEY&country=86", nil)
if err != nil { panic(err) }
client := &http.Client{Timeout: 15 * time.Second}
resp, err := client.Do(req)
if err != nil { panic(err) }
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil { panic(err) }
fmt.Println(resp.StatusCode, string(body))
}const response = await fetch("https://smscash.org/stubs/handler_api.php?action=getNumbersStatus&api_key=YOUR_API_KEY&country=86");
const result = await response.json();
console.log(response.status, result);import requests
response = requests.get(
"https://smscash.org/stubs/handler_api.php?action=getNumbersStatus&api_key=YOUR_API_KEY&country=86",
timeout=15,
)
print(response.status_code, response.json())Ответы
{
"go_0": 0
}- Суффикс _0 означает выбор без конкретного оператора.
- Наличие относится к общему пулу поставщика. Доступность выбранного канала проверяется при выдаче номера.
GETgetStatusПолучить последний код+
Лёгкий запрос состояния сессии и последнего SMS-кода. Начальные нули в коде сохраняются.
Параметры
| Параметр | Тип | Описание |
|---|---|---|
api_key* | string | Личный API-ключ пользователя. |
id* | integer | ID вашей сессии, полученный при выдаче номера. |
* Обязательный параметр. Во всех запросах также передавайте action=getStatus.
Пример запроса
curl 'https://smscash.org/stubs/handler_api.php?action=getStatus&api_key=YOUR_API_KEY&id=42'package main
import (
"fmt"
"io"
"net/http"
"time"
)
func main() {
req, err := http.NewRequest("GET", "https://smscash.org/stubs/handler_api.php?action=getStatus&api_key=YOUR_API_KEY&id=42", nil)
if err != nil { panic(err) }
client := &http.Client{Timeout: 15 * time.Second}
resp, err := client.Do(req)
if err != nil { panic(err) }
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil { panic(err) }
fmt.Println(resp.StatusCode, string(body))
}const response = await fetch("https://smscash.org/stubs/handler_api.php?action=getStatus&api_key=YOUR_API_KEY&id=42");
const result = await response.text();
console.log(response.status, result);import requests
response = requests.get(
"https://smscash.org/stubs/handler_api.php?action=getStatus&api_key=YOUR_API_KEY&id=42",
timeout=15,
)
print(response.status_code, response.text)Ответы
STATUS_WAIT_CODESTATUS_OK:001234STATUS_CANCELNO_ACTIVATION- Опрашивайте раз в 20 секунд. Повторное чтение не начисляет деньги.
- После retry старый код не возвращается: getStatus ждёт следующее SMS.
- После удаления номера без SMS getStatus и getSms возвращают STATUS_CANCEL, getSmsFull — закрытый статус, пустой phone и пустой sms. REST /activations/{id} и /sms возвращают 404 NO_ACTIVATION.
GETsetStatusУправлять сессией+
Завершает, отменяет или возобновляет ожидание SMS. Срок сессии остаётся прежним.
Параметры
| Параметр | Тип | Описание |
|---|---|---|
api_key* | string | Личный API-ключ пользователя. |
id* | integer | ID вашей сессии, полученный при выдаче номера. |
status* | integer | 3 — ждать следующий код без продления; 6 — завершить после SMS; 8 — отменить сразу. |
* Обязательный параметр. Во всех запросах также передавайте action=setStatus.
Пример запроса
curl 'https://smscash.org/stubs/handler_api.php?action=setStatus&api_key=YOUR_API_KEY&id=42&status=3' \
-H 'Idempotency-Key: request-unique-001'package main
import (
"fmt"
"io"
"net/http"
"time"
)
func main() {
req, err := http.NewRequest("GET", "https://smscash.org/stubs/handler_api.php?action=setStatus&api_key=YOUR_API_KEY&id=42&status=3", nil)
if err != nil { panic(err) }
req.Header.Set("Idempotency-Key", "request-unique-001")
client := &http.Client{Timeout: 15 * time.Second}
resp, err := client.Do(req)
if err != nil { panic(err) }
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil { panic(err) }
fmt.Println(resp.StatusCode, string(body))
}const response = await fetch("https://smscash.org/stubs/handler_api.php?action=setStatus&api_key=YOUR_API_KEY&id=42&status=3", {
headers: {"Idempotency-Key": "request-unique-001"}
});
const result = await response.text();
console.log(response.status, result);import requests
response = requests.get(
"https://smscash.org/stubs/handler_api.php?action=setStatus&api_key=YOUR_API_KEY&id=42&status=3",
headers={"Idempotency-Key": "request-unique-001"},
timeout=15,
)
print(response.status_code, response.text)Ответы
ACCESS_RETRY_GETACCESS_ACTIVATIONACCESS_CANCEL- Retry ждёт следующий код в пределах исходных 20 минут. Время выдачи и истечения не меняется.
- Для status=3 используйте Idempotency-Key: повтор запроса не сбросит уже полученный новый код. История SMS остаётся доступна.
- Отмена не списывает уже заработанные средства.
- В истории сохраняются только номера с SMS-кодом. Отменённые и истёкшие номера без кода удаляются.
GETgetRepeatNumberВыдать прежний номер снова+
Открывает новую сессию с конкретным номером из вашей истории. Можно выбрать другой доступный сервис той же страны.
Параметры
| Параметр | Тип | Описание |
|---|---|---|
api_key* | string | Личный API-ключ пользователя. |
number* | string | Ваш прежний номер. Допустимы только цифры и необязательный начальный +. |
service* | string | Доступные коды сервисов. Ответ ограничен областью API-ключа. |
session_duration | integer | Срок сессии — 20 минут. Передайте 20 или пропустите параметр. |
with_operator | integer | 1 добавляет ID оператора в ответ; 0 или отсутствие — три сегмента. |
ref | string | Публичный код владельца софта: 5% ему и 5% пригласившему. Без ref — 10% пригласившему. |
operator | string | Возьмите ID из operators/getOperators (API). operator=1 · any/0 |
* Обязательный параметр. Во всех запросах также передавайте action=getRepeatNumber.
Пример запроса
curl 'https://smscash.org/stubs/handler_api.php?action=getRepeatNumber&api_key=YOUR_API_KEY&number=380670000000&service=go' \
-H 'Idempotency-Key: request-unique-001'package main
import (
"fmt"
"io"
"net/http"
"time"
)
func main() {
req, err := http.NewRequest("GET", "https://smscash.org/stubs/handler_api.php?action=getRepeatNumber&api_key=YOUR_API_KEY&number=380670000000&service=go", nil)
if err != nil { panic(err) }
req.Header.Set("Idempotency-Key", "request-unique-001")
client := &http.Client{Timeout: 15 * time.Second}
resp, err := client.Do(req)
if err != nil { panic(err) }
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil { panic(err) }
fmt.Println(resp.StatusCode, string(body))
}const response = await fetch("https://smscash.org/stubs/handler_api.php?action=getRepeatNumber&api_key=YOUR_API_KEY&number=380670000000&service=go", {
headers: {"Idempotency-Key": "request-unique-001"}
});
const result = await response.text();
console.log(response.status, result);import requests
response = requests.get(
"https://smscash.org/stubs/handler_api.php?action=getRepeatNumber&api_key=YOUR_API_KEY&number=380670000000&service=go",
headers={"Idempotency-Key": "request-unique-001"},
timeout=15,
)
print(response.status_code, response.text)Ответы
ACCESS_NUMBER:43:380670000000NUMBER_IN_USE- Сначала завершите или отмените текущую сессию. При занятом номере повторная выдача не выполняется.
- Новая сессия получает новый ID и текущий тариф. Старые SMS в неё не копируются. ref задаётся заново.
- SMScash разрешает повтор только номеров из истории этого аккаунта. Страна определяется по номеру.
- Ключ удалённой сессии остаётся использованным: повтор выдачи с этим ключом возвращает SESSION_CLOSED и не выдаёт новый номер.
GETgetSmsFullПолучить SMS в JSON+
Структурированная история всех сообщений с ID, отправителем, кодом, текстом и данными страны, сервиса и поставщика.
Параметры
| Параметр | Тип | Описание |
|---|---|---|
api_key* | string | Личный API-ключ пользователя. |
id* | integer | ID вашей сессии, полученный при выдаче номера. |
* Обязательный параметр. Во всех запросах также передавайте action=getSmsFull.
Пример запроса
curl 'https://smscash.org/stubs/handler_api.php?action=getSmsFull&api_key=YOUR_API_KEY&id=42'package main
import (
"fmt"
"io"
"net/http"
"time"
)
func main() {
req, err := http.NewRequest("GET", "https://smscash.org/stubs/handler_api.php?action=getSmsFull&api_key=YOUR_API_KEY&id=42", nil)
if err != nil { panic(err) }
client := &http.Client{Timeout: 15 * time.Second}
resp, err := client.Do(req)
if err != nil { panic(err) }
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil { panic(err) }
fmt.Println(resp.StatusCode, string(body))
}const response = await fetch("https://smscash.org/stubs/handler_api.php?action=getSmsFull&api_key=YOUR_API_KEY&id=42");
const result = await response.json();
console.log(response.status, result);import requests
response = requests.get(
"https://smscash.org/stubs/handler_api.php?action=getSmsFull&api_key=YOUR_API_KEY&id=42",
timeout=15,
)
print(response.status_code, response.json())Ответы
{
"success": true,
"session_id": 42,
"phone": "380670000000",
"status": 1,
"status_name": "received",
"sms_count": 1,
"sms": [
{
"id": 101,
"external_id": "message-101",
"sender": "Service",
"code": "001234",
"text": "Код подтверждения: 001234",
"received_at": "2026-10-09T12:00:00Z",
"country": {
"id": 86,
"name": "Italy"
},
"service": {
"code": "go",
"name": "Google"
},
"provider": {
"id": 1,
"name": "Оператор 1"
}
}
],
"expires_at": "2026-10-09T12:20:00Z"
}- Предпочтительный формат для интеграции. Запоминайте sms[].id, чтобы обрабатывать только новые сообщения.
- Числовой status SMScash: 1 — активна, 6 — завершена, 8 — отменена или истекла. status_name различает waiting, received, finished, canceled, expired.
- История полученных кодов доступна после закрытия сессии. Для большого потока используйте REST /activations/{id}/sms с after_id.
- После удаления номера без SMS getStatus и getSms возвращают STATUS_CANCEL, getSmsFull — закрытый статус, пустой phone и пустой sms. REST /activations/{id} и /sms возвращают 404 NO_ACTIVATION.
GETgetSmsПолучить SMS текстовой строкой+
Возвращает всю историю SMS в строковом формате для существующих клиентов.
Параметры
| Параметр | Тип | Описание |
|---|---|---|
api_key* | string | Личный API-ключ пользователя. |
id* | integer | ID вашей сессии, полученный при выдаче номера. |
* Обязательный параметр. Во всех запросах также передавайте action=getSms.
Пример запроса
curl 'https://smscash.org/stubs/handler_api.php?action=getSms&api_key=YOUR_API_KEY&id=42'package main
import (
"fmt"
"io"
"net/http"
"time"
)
func main() {
req, err := http.NewRequest("GET", "https://smscash.org/stubs/handler_api.php?action=getSms&api_key=YOUR_API_KEY&id=42", nil)
if err != nil { panic(err) }
client := &http.Client{Timeout: 15 * time.Second}
resp, err := client.Do(req)
if err != nil { panic(err) }
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil { panic(err) }
fmt.Println(resp.StatusCode, string(body))
}const response = await fetch("https://smscash.org/stubs/handler_api.php?action=getSms&api_key=YOUR_API_KEY&id=42");
const result = await response.text();
console.log(response.status, result);import requests
response = requests.get(
"https://smscash.org/stubs/handler_api.php?action=getSms&api_key=YOUR_API_KEY&id=42",
timeout=15,
)
print(response.status_code, response.text)Ответы
STATUS_OK:2026-10-09T12:00:00Z|001234|Код подтверждения: 001234STATUS_WAIT_CODESTATUS_CANCEL- Формат сообщения: время|код|текст. Несколько сообщений разделяются двоеточием.
- Текст SMS сам может содержать двоеточия и вертикальные черты. Для надёжного разбора используйте getSmsFull.
GETgetServicesСервисы+
Доступные коды сервисов. Ответ ограничен областью API-ключа.
Параметры
| Параметр | Тип | Описание |
|---|---|---|
api_key* | string | Личный API-ключ пользователя. |
country | integer | Возьмите ID из getCountries. |
* Обязательный параметр. Во всех запросах также передавайте action=getServices.
Пример запроса
curl 'https://smscash.org/stubs/handler_api.php?action=getServices&api_key=YOUR_API_KEY'package main
import (
"fmt"
"io"
"net/http"
"time"
)
func main() {
req, err := http.NewRequest("GET", "https://smscash.org/stubs/handler_api.php?action=getServices&api_key=YOUR_API_KEY", nil)
if err != nil { panic(err) }
client := &http.Client{Timeout: 15 * time.Second}
resp, err := client.Do(req)
if err != nil { panic(err) }
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil { panic(err) }
fmt.Println(resp.StatusCode, string(body))
}const response = await fetch("https://smscash.org/stubs/handler_api.php?action=getServices&api_key=YOUR_API_KEY");
const result = await response.json();
console.log(response.status, result);import requests
response = requests.get(
"https://smscash.org/stubs/handler_api.php?action=getServices&api_key=YOUR_API_KEY",
timeout=15,
)
print(response.status_code, response.json())Ответы
{
"go": {
"name": "Google",
"code": "go"
}
}- Справочник сервисов общий для поставщика. Наличие номеров проверяется отдельно.
GETgetCountriesСтраны+
ID, название и телефонный префикс стран выбранного канала.
Параметры
| Параметр | Тип | Описание |
|---|---|---|
api_key* | string | Личный API-ключ пользователя. |
* Обязательный параметр. Во всех запросах также передавайте action=getCountries.
Пример запроса
curl 'https://smscash.org/stubs/handler_api.php?action=getCountries&api_key=YOUR_API_KEY'package main
import (
"fmt"
"io"
"net/http"
"time"
)
func main() {
req, err := http.NewRequest("GET", "https://smscash.org/stubs/handler_api.php?action=getCountries&api_key=YOUR_API_KEY", nil)
if err != nil { panic(err) }
client := &http.Client{Timeout: 15 * time.Second}
resp, err := client.Do(req)
if err != nil { panic(err) }
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil { panic(err) }
fmt.Println(resp.StatusCode, string(body))
}const response = await fetch("https://smscash.org/stubs/handler_api.php?action=getCountries&api_key=YOUR_API_KEY");
const result = await response.json();
console.log(response.status, result);import requests
response = requests.get(
"https://smscash.org/stubs/handler_api.php?action=getCountries&api_key=YOUR_API_KEY",
timeout=15,
)
print(response.status_code, response.json())Ответы
{
"86": {
"id": 86,
"name": "Italy",
"phone_code": "39"
}
}GETgetOperatorsОператоры+
Доступные операторы: ID для API, название и срок холда.
Параметры
| Параметр | Тип | Описание |
|---|---|---|
api_key* | string | Личный API-ключ пользователя. |
country | integer | Возьмите ID из getCountries. |
operator | string | Возьмите ID из operators/getOperators (API). operator=1 · any/0 |
* Обязательный параметр. Во всех запросах также передавайте action=getOperators.
Пример запроса
curl 'https://smscash.org/stubs/handler_api.php?action=getOperators&api_key=YOUR_API_KEY'package main
import (
"fmt"
"io"
"net/http"
"time"
)
func main() {
req, err := http.NewRequest("GET", "https://smscash.org/stubs/handler_api.php?action=getOperators&api_key=YOUR_API_KEY", nil)
if err != nil { panic(err) }
client := &http.Client{Timeout: 15 * time.Second}
resp, err := client.Do(req)
if err != nil { panic(err) }
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil { panic(err) }
fmt.Println(resp.StatusCode, string(body))
}const response = await fetch("https://smscash.org/stubs/handler_api.php?action=getOperators&api_key=YOUR_API_KEY");
const result = await response.json();
console.log(response.status, result);import requests
response = requests.get(
"https://smscash.org/stubs/handler_api.php?action=getOperators&api_key=YOUR_API_KEY",
timeout=15,
)
print(response.status_code, response.json())Ответы
{
"1": {
"id": 1,
"provider_id": 1,
"operator": 1,
"name": "Оператор 1",
"earnings_hold_days": 45
}
}- Возьмите ID из operators/getOperators (API).
GETgetRewardsВознаграждение за SMS+
Цена зависит от страны. Все суммы в таблице — за одно оплаченное SMS.
Параметры
| Параметр | Тип | Описание |
|---|---|---|
api_key* | string | Личный API-ключ пользователя. |
country | integer | Возьмите ID из getCountries. |
service | string | Доступные коды сервисов. Ответ ограничен областью API-ключа. |
operator | string | Возьмите ID из operators/getOperators (API). operator=1 · any/0 |
* Обязательный параметр. Во всех запросах также передавайте action=getRewards.
Пример запроса
curl 'https://smscash.org/stubs/handler_api.php?action=getRewards&api_key=YOUR_API_KEY&country=59&service=vi'package main
import (
"fmt"
"io"
"net/http"
"time"
)
func main() {
req, err := http.NewRequest("GET", "https://smscash.org/stubs/handler_api.php?action=getRewards&api_key=YOUR_API_KEY&country=59&service=vi", nil)
if err != nil { panic(err) }
client := &http.Client{Timeout: 15 * time.Second}
resp, err := client.Do(req)
if err != nil { panic(err) }
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil { panic(err) }
fmt.Println(resp.StatusCode, string(body))
}const response = await fetch("https://smscash.org/stubs/handler_api.php?action=getRewards&api_key=YOUR_API_KEY&country=59&service=vi");
const result = await response.json();
console.log(response.status, result);import requests
response = requests.get(
"https://smscash.org/stubs/handler_api.php?action=getRewards&api_key=YOUR_API_KEY&country=59&service=vi",
timeout=15,
)
print(response.status_code, response.json())Ответы
{
"59": {
"vi": {
"1": "0.01000000",
"3": "0.00500000"
}
}
}{}- Тарифы в USD передаются точными строками с 8 знаками после точки:
- Включённые поставщики, доступные вашему ключу.
- country ID → service code → operator ID → reward (USD)
GETgetBalanceБаланс пользователя+
Дополнение SMScash: доступный баланс с учётом начислений, реферальных бонусов и заявок на выплату.
Параметры
| Параметр | Тип | Описание |
|---|---|---|
api_key* | string | Личный API-ключ пользователя. |
* Обязательный параметр. Во всех запросах также передавайте action=getBalance.
Пример запроса
curl 'https://smscash.org/stubs/handler_api.php?action=getBalance&api_key=YOUR_API_KEY'package main
import (
"fmt"
"io"
"net/http"
"time"
)
func main() {
req, err := http.NewRequest("GET", "https://smscash.org/stubs/handler_api.php?action=getBalance&api_key=YOUR_API_KEY", nil)
if err != nil { panic(err) }
client := &http.Client{Timeout: 15 * time.Second}
resp, err := client.Do(req)
if err != nil { panic(err) }
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil { panic(err) }
fmt.Println(resp.StatusCode, string(body))
}const response = await fetch("https://smscash.org/stubs/handler_api.php?action=getBalance&api_key=YOUR_API_KEY");
const result = await response.text();
console.log(response.status, result);import requests
response = requests.get(
"https://smscash.org/stubs/handler_api.php?action=getBalance&api_key=YOUR_API_KEY",
timeout=15,
)
print(response.status_code, response.text)Ответы
ACCESS_BALANCE:0.00- getBalance возвращает доступный баланс в USD с точностью до 8 знаков.
- Вывести можно только средства, у которых завершён холд.
GETgetHoldBalanceВ холде+
После получения SMS начисление уходит в холд на срок поставщика. В указанную дату сумма автоматически становится доступной для вывода.
Параметры
| Параметр | Тип | Описание |
|---|---|---|
api_key* | string | Личный API-ключ пользователя. |
* Обязательный параметр. Во всех запросах также передавайте action=getHoldBalance.
Пример запроса
curl 'https://smscash.org/stubs/handler_api.php?action=getHoldBalance&api_key=YOUR_API_KEY'package main
import (
"fmt"
"io"
"net/http"
"time"
)
func main() {
req, err := http.NewRequest("GET", "https://smscash.org/stubs/handler_api.php?action=getHoldBalance&api_key=YOUR_API_KEY", nil)
if err != nil { panic(err) }
client := &http.Client{Timeout: 15 * time.Second}
resp, err := client.Do(req)
if err != nil { panic(err) }
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil { panic(err) }
fmt.Println(resp.StatusCode, string(body))
}const response = await fetch("https://smscash.org/stubs/handler_api.php?action=getHoldBalance&api_key=YOUR_API_KEY");
const result = await response.text();
console.log(response.status, result);import requests
response = requests.get(
"https://smscash.org/stubs/handler_api.php?action=getHoldBalance&api_key=YOUR_API_KEY",
timeout=15,
)
print(response.status_code, response.text)Ответы
ACCESS_HOLD_BALANCE:34.50000001- SMScash · getHoldBalance · USD · 8
- Вывести можно только средства, у которых завершён холд.
Коды ответа и повторные запросы
В handler_api.php бизнес-исходы обычно приходят с HTTP 200. Проверяйте текст тела. Справочники и getSmsFull при успехе возвращают JSON; ошибки всегда текстовые.
| Код | HTTP | Причина и действие |
|---|---|---|
TARIFF_NOT_CONFIGURED | 200 | Тарифы ещё не заданыВыдача номеров начнётся после настройки вознаграждения за SMS. |
COUNTRY_BLOCKED | 200 | Получение номеров этой страны заблокировано.Выберите другую страну. |
BAD_SERVICE | 200 | Этот сервис заблокирован для получения номеров.Выберите другой сервис. |
PROVIDER_NOT_READY | 200 | Выдача номеров временно недоступнаОбновите справочники. |
BAD_KEY | 400 | Нет api_key или неверный формат.Проверьте ключ в запросе. |
INVALID_API_KEY | 401 | Ключ неизвестен, отозван или аккаунт отключён.Выпустите действующий ключ. |
BAD_COUNTRY | 400 | country отсутствует или не является положительным числом.Возьмите ID из getCountries. |
BAD_SESSION_DURATION | 400 | Номер выдаётся ровно на 20 минут.Исправьте session_duration. |
BAD_REQUEST | 400 | Некорректный параметр или Idempotency-Key.Исправьте запрос. |
BAD_SERVICE / BAD_OPERATOR / INVALID_PROVIDER | 200 | Неизвестный или отключённый элемент каталога.Обновите справочники. |
BAD_NUMBER | 200 | Неправильный формат номера.Передайте номер цифрами. |
BAD_ACTION / BAD_STATUS | 200 | Неизвестная команда, ID или операция.Проверьте параметры. |
EMPTY_POOL | 200 | Подходящих свободных номеров сейчас нет.Повторите через 10–30 секунд или смените фильтры. |
NUMBER_IN_USE | 200 | Конкретный номер занят активной сессией.Завершите свою сессию либо выберите другой номер. |
NO_ACTIVATION | 200 | Сессия или прежний номер не принадлежат вашему аккаунту.Проверьте ID и ключ. |
SESSION_CLOSED / SMS_REQUIRED | 200 | Переход состояния сейчас недоступен.Проверьте состояние и наличие SMS. |
SCOPE_BLOCKED | 200 | Сервис, страна или поставщик не разрешены ключу.Исправьте область ключа. |
IDEMPOTENCY_CONFLICT | 200 | Этот ключ запроса уже связан с другими параметрами.Для новой операции создайте другой Idempotency-Key. |
BAD_REF / SELF_REF | 400 | Код софта неизвестен, отключён или принадлежит самому пользователю.Передайте код владельца софта. |
INTERNAL_ERROR | 500 | Временная ошибка сервера или поставщика.Повторите с задержкой и тем же Idempotency-Key. |
ALLOCATION_PENDING | 200 | Запрос выдачи уже выполняется. Повторите с прежним Idempotency-Key.Запрос выдачи уже выполняется. Повторите с прежним Idempotency-Key. |
ALLOCATION_UNCERTAIN | 200 | Результат выдачи не подтверждён. Автоматический повтор отключён, чтобы не выдать второй номер.Результат выдачи не подтверждён. Автоматический повтор отключён, чтобы не выдать второй номер. |
REST возвращает объект {"error":{"code":"…","message":"…"}} и обычные HTTP-статусы 400/401/403/404/409/503.
{
"error": {
"code": "BAD_REQUEST",
"message": "Проверьте поля запроса.",
"request_id": "req_…",
"hint": "Use the documented JSON type; numbers must not be quoted.",
"retryable": false,
"details": {
"field": "country",
"expected": "integer"
}
}
}X-Request-ID: included in every API response
405: Allow lists the supported HTTP methods
ALLOCATION_PENDING: retryable=true · Retry-After=3 · same operation key
ALLOCATION_UNCERTAIN: retryable=false · contact support
Transport errors: check the operation before another write; keep the original key.REST для новых интеграций
Тарифы в USD передаются точными строками с 8 знаками после точки: 0.00300000 USD.
Валюта баланса — USD. Схемы запросов и ответов находятся в OpenAPI.
/api/v1/catalogСервисы и страны/api/v1/tariffsВознаграждение за SMS по странам/api/v1/offersТарифы и вознаграждения/api/v1/servicesСправочник/api/v1/countriesСправочник/api/v1/operatorsСправочник/api/v1/availability?country=1Наличие номеров/api/v1/activationsНовая сессия/api/v1/activations/batch?ids=42,43Проверка нескольких номеров/api/v1/activationsПоследние 200 сессий: scope=history, waiting или all/api/v1/activations/{id}Сессия и сообщения/api/v1/activations/{id}/sms?after_id=0&limit=100Новые SMS с курсором/api/v1/activations/{id}/retryОжидание SMS/api/v1/activations/{id}/finishЗавершение/api/v1/activations/{id}/cancelОтмена/api/v1/activations/repeatПовторная выдача номера/api/v1/keysAPI-ключи/api/v1/keysСоздать ключ/api/v1/keys/{id}Изменить имя или policy/api/v1/keys/{id}Отозвать ключ/api/v1/referralsРеферальный код и доходы/api/v1/summaryБаланс и сводка/api/v1/balanceВ холде/api/v1/ledgerЖурнал начислений/api/v1/withdrawalsЗаявки на выплату/api/v1/withdrawalsСоздать заявку/api/v1/statisticsОбщая статистика/api/v1/earnings/holdsХолд начисленийПолучение только новых SMS
GET /api/v1/activations/42/sms?after_id=0&limit=100
Authorization: Bearer YOUR_API_KEY{
"session_id": 42,
"sms": [
{
"id": 101,
"code": "001234",
"text": "Код: 001234",
"sender": "Service",
"received_at": "2026-10-09T12:00:00Z"
}
],
"next_cursor": 101,
"has_more": false
}Сохраняйте next_cursor и передавайте его как after_id. Если has_more=true, следующую страницу можно читать сразу. limit: 1–200. Сессии и SMS доступны только владельцу.