Документація 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 ще раз для нової сесії. У розрахунку тарифу, винагорода користувача USD 0.003 дається USD 0.00015 кожному власнику програмного продукту та пошуковцю. Загальна бонусна винагорода становить USD 0.00030.
Команди 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; неправильний формат країни – 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 повертає статус закритого, порожній телефон та порожню список 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- Повторно спробуйте – чекайте наступний код протягом оригінальних 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, щоб обробляти лише нові повідомлення.
- Числовий статус SMScash: 1 - активний, 6 - виконано, 8 - анульовано або минув. status_name розрізняє очікування, отримано, завершено, скасовано, минув.
- Коди, отримані раніше, залишаються доступними після закінчення сесії. Для великих обсягів використовуйте REST /activations/{id}/sms з after_id.
- Після видалення числа без SMS, getStatus та getSms повертаються до STATUS_CANCEL; getSmsFull повертає статус закритого, порожній телефон та порожню список 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 | Розподіл номерів тимчасово недоступнийОновіть каталоги API. |
BAD_KEY | 400 | Немає api_key або недійсний формат.Перевірте ключ у запиті. |
INVALID_API_KEY | 401 | Ключ невідомий, відкликаний або обліковий запис вимкнено.Створіть дійсний ключ API. |
BAD_COUNTRY | 400 | країна відсутня або не додатне число.Візьміть ID від getCountries. |
BAD_SESSION_DURATION | 400 | Номери телефонів випускаються на точно 20 хвилин.Правильно session_duration. |
BAD_REQUEST | 400 | Недійсний параметр або Idempotency-Key.Виправте запит. |
BAD_SERVICE / BAD_OPERATOR / INVALID_PROVIDER | 200 | Невідомий або вимкнений елемент каталогу.Оновіть каталоги API. |
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 | Служба, країна або постачальник не авторизовані для ключа.Оновіть область дії ключа API. |
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/tariffsSMS ставки винагороди по країнах/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, очікування або всі/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/repeatNumber reissue/api/v1/keysКлючі API/api/v1/keysСтворіть ключ/api/v1/keys/{id}Змініть назву або policy/api/v1/keys/{id}Revoke key/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 доступні лише власнику.