English 中国
Главная
Инструкция
Войти / Регистрация

CheapSMS.xyz - Документация API

Рекомендация: для заказа номеров используйте VPN выбранной страны или любой другой. Это поможет обеспечить стабильную работу сервиса и своевременное получение SMS.

Документация API для автоматизации

API ключ можно найти тут: Личный кабинет

API - это протокол взаимодействия между вашим ПО и нашим сервером активаций.

API нужен для того, чтобы автоматизировать процесс получение смс сообщений на вашей стороне

Обновленное API для автоматизации

Все запросы должны идти на https://cheapsms.xyz/handler/index

POST или GET запросом.

Во всех запросах должен присутствовать API ключ в виде параметра "api_key"

ID Код Название
1 ru Россия
2 ua Украина
3 kz Казахстан
4 us США
5 DE Германия
6 id Индонезия
7 nl Нидерланды
8 ph Филиппины
9 fr Франция
10 es Испания
11 bg Болгария
12 gb Великобритания
13 pl Польша
14 ar Аргентина
15 ge Грузия
16 ee Эстония
17 se Швеция
18 ro Румыния
19 cz Чехия
20 gr Греция
21 za ЮАР
22 it Италия
23 si Словения
24 ch Швейцария
25 hr Хорватия
26 at Австрия
27 cy Кипр
28 UZ Узбекистан
29 CN Канада
30 GR Греция
31 HOK Гон Конд
32 KN Кения
33 SOA Южная Африка
34 SW Швейцария
35 KG Кыргызстан
36 CH0 Китай
37 MO Марокко
38 GH Гана
41 CA Камерун
42 CH Чад
44 LI Литва
47 IR Ирак
49 LA Латвия
51 BE Беларусь
52 TH Таиланд
53 SA Сауд. Аравия
54 ME Мексика
55 TA Тайвань
58 AL Алжир
60 BA Бангладеш
61 SE Сенегал
62 62 Турция
64 64 Шри-Ланка
65 PE Перу
66 PA Пакистан
67 NZ Новая Зеландия
68 GU Гвинея
69 MA Мали
70 VE Венесуэла
71 ET Эфиопия
72 72 Монголия
73 BR Бразилия
74 AF Афганистан
75 UG Уганда
76 AN Ангола
79 PNG Папуа-Новая Гвинея
80 80 Мозамбик
81 NE Непал
82 82 Бельгия
84 HU Венгрия
85 85 Молдова
87 87 Парагвай
88 HO Гондурас
89 TU Тунис
90 NI Никарагуа
91 TI Тимор-Лесте
92 BO Боливия
93 CR Коста Рика
94 94 Гватемала
95 UA ОАЭ
96 ZI Зимбабве
97 PR Пуэрто-Рико
99 TO Того
100 KU Кувейт
101 ES Сальвадор
102 102 Ливия
103 JA Ямайка
104 TAT Тринидад и Тобаго
105 EC Эквадор
106 106 Свазиленд
107 OM Оман
108 BAH Босния и Герцеговина
109 DR Доминиканская Республика
111 QA Катар
112 112 Панама
114 114 Мавритания
115 SL Сьерра-Леоне
116 JO Иордания
117 PO Португалия
118 118 Барбадос
119 BU Бурунди
120 120 Бенин
121 121 Бруней
122 122 Багамы
123 123 Ботсвана
124 124 Белиз
125 CAR ЦАР
126 DO Доминика
127 127 Гренада
130 130 Гвинея-Бисау
131 131 Гайана
132 IC Исландия
133 133 Коморы
134 SKA Сент-Китс и Невис
135 135 Либерия
136 136 Лесото
137 137 Малави
138 NA Намибия
139 139 Нигер
140 RW Руанда
141 141 Словакия
142 SU Суринам
143 143 Таджикистан
144 144 Монако
145 145 Бахрейн
146 RE Реюньон
147 ZA Замбия
148 AR Армения
149 SO Сомали
150 CO Конго
151 151 Чили
152 BF Буркина-Фасо
153 LE Ливан
154 GA Габон
155 155 Албания
156 UR Уругвай
157 157 Маврикий
158 BH Бутан
159 159 Мальдивы
160 160 Гваделупа
161 161 Туркменистан
162 FG Французская Гвиана
163 FI Финляндия
164 164 Сент-Люсия
165 LU Люксембург
166 SVA Сент-Винсент и Гренадин
167 EG Экваториальная Гвинея
168 DJ Джибути
169 AAB Антигуа и Барбуда
170 CI Острова Кайман
171 171 Черногория
172 172 Дания
174 NO Норвегия
175 AU Австралия
176 ER Эритрея
177 SS Южный Судан
178 STA Сан-Томе и Принсипи
179 179 Аруба
180 180 Монтсеррат
181 181 Ангилья
183 NM Северная Македония
184 184 Республика Сейшелы
185 NC Новая Каледония
186 CV Кабо-Верде
189 189 Фиджи
196 SI Сингапур
ID Код Название
1 vk ВКонтакте
2 ok Одноклассники
3 vi Viber
4 tg Telegram
5 wb WeChat
6 go Google, Gmail
8 fb Facebook
9 tw Twitter
10 ub Uber
11 gt Gett
12 sn OLX
13 ig Instagram
14 ss SeoSprint
16 ma Mail.ru
17 mm Microsoft
18 mb Yahoo
19 we ДругВокруг
20 bd Rambler
21 ya Yandex
22 mt Steam
23 oi Tinder
24 fd Mamba
25 pm AOL
26 ot Нет в списке
28 oy Okey
29 sm Steemit
30 wm WebMoney
36 sp Спортмастер
37 wp WhatsApp
39 dd DodoPizza
44 dt Delivery Club
45 rn Роснефть
49 pd Pandao
50 nv NAVER
51 im IMO
53 tt TikTok
55 ta TamTam
57 bb BlaBlaCar
61 tv Tradingview
65 nk Nike
68 bt Beget
75 st T7 TAXI
77 bz Benzuber
79 gr Grindr
83 yg YandexGo
84 pg PGbonus
85 in Linkedin
87 am Amazon
88 yo YooMoney
92 ad Adidas
93 fc FACEIT
94 ko Okko
95 fp FoodPanda
96 ic ICQ
99 al Aliexpess
101 ke KazanExpress
102 ka KakaoTalk_
103 pp PayPal
105 bc Blockchain
106 ar Airbnb
107 tc Twitch
108 kf KFC
109 ur Urent
112 xg X5 Group
113 ai Alibaba
114 lk Likee
115 hr Hohoro
116 vd VIVADENGI
117 px Piastrix
118 si SberID / Купер
121 ml Marlboro
126 cn Centrify
127 ap Apple
128 kp KoronaPay
129 ps Salampay
135 bankiru Banki.ru
140 bz0 blizzard
141 ukl Uklon
142 _leo LEON-TWIN
https://cheapsms.xyz/handler/index?api_key=$api_key&action=getCountries

Параметры:
$api_key = ВАШ_API_KEY

Ответ сервиса в json формате:
[{"id":1,"code":"RU","name":"Россия"},{"id":2,"code":"UA","name":"Украина"}]


Возможные ошибки:
BAD_KEY - Неверный API-ключ
ERROR_SQL - ошибка SQL-сервера

Пример:
https://cheapsms.xyz/handler/index?api_key=f8d597bb7439df66a4eeb5befdee6e44&action=getCountries
https://cheapsms.xyz/handler/index?api_key=$api_key&action=getServices

Параметры:
$api_key = ВАШ_API_KEY

Ответ сервиса в json формате:
[{"id":1,"code":"telegram","name":"Telegram"},{"id":2,"code":"vk","name":"ВКонтакте"}]


Возможные ошибки:
BAD_KEY - Неверный API-ключ
ERROR_SQL - ошибка SQL-сервера

Пример:
https://cheapsms.xyz/handler/index?api_key=f8d597bb7439df66a4eeb5befdee6e44&action=getServices
https://cheapsms.xyz/handler/index?api_key=$api_key&action=getCounts

Параметры:
$api_key = ВАШ_API_KEY

Ответ сервиса в json формате:
{"6":{"vk":"5706","wp":"5615","tg":"5665"},"17":{"vk":"736","wp":"687","tg":"648"}}


Где ключ - ID страны, внутри - код сервиса и количество доступных номеров (объединенные от всех провайдеров)
Возможные ошибки:
BAD_KEY - Неверный API-ключ
ERROR_SQL - ошибка SQL-сервера

Пример:
https://cheapsms.xyz/handler/index?api_key=f8d597bb7439df66a4eeb5befdee6e44&action=getCounts
https://cheapsms.xyz/handler/index?api_key=$api_key&action=getPrices

Параметры:
$api_key = ВАШ_API_KEY

Ответ сервиса в json формате:
{
    "ru": {
        "vk": {
            "price1": "0.00",
            "price2": "0.00",
            "price3": "0.00"
        },
        "ok": {
            "price1": "0.00",
            "price2": "0.00",
            "price3": "0.00"
        }
    },
    "ua": {
        "vk": {
            "price1": "0.11",
            "price2": "20.00",
            "price3": "26.28",
            "price4": "0.10"
        },
        "ok": {
            "price1": "0.03",
            "price2": "0.00",
            "price3": "0.00",
            "price4": "0.03"
        }
    }
}


Возвращает финальные цены сервисов от провайдеров (с комиссией) только для тех стран, где реально есть доступные номера в Redis. Ключи верхнего уровня - коды стран, внутри - сервисы с индексированными ценами.

Структура ответа:
• Первый уровень - коды стран (только те, где есть номера в наличии)
• Второй уровень - коды сервисов (vk, tg, ok и т.д.)
• Третий уровень - индексированные цены от доступных провайдеров (price1, price2, price3 и т.д.)

Важно: API показывает цены только от провайдеров, которые реально имеют номера в наличии (данные из Redis), а не все цены из базы данных.
Возможные ошибки:
BAD_KEY - Неверный API-ключ
ERROR_SQL - ошибка SQL-сервера

Пример:
https://cheapsms.xyz/handler/index?api_key=f8d597bb7439df66a4eeb5befdee6e44&action=getPrices
https://cheapsms.xyz/handler/index?api_key=$api_key&action=getNumbersStatus&country=$country

Параметры:
$api_key = ВАШ_API_KEY
$country = параметр не играет роли

Ответ сервиса в json формате:
{"vk":"0","ig":"3","ok":"1","vi":"3","other":"2"}

Где до черточки - название сервиса, после обозначение нужно ли включать переадресацию. 0 - не включать. 1 - включать. Переадресации пока нет
Возможные ошибки:
BAD_KEY - Неверный API-ключ
ERROR_SQL - ошибка SQL-сервера

Пример:
https://cheapsms.xyz/handler/index?api_key=f8d597bb7439df66a4eeb5befdee6e44&action=getNumbersStatus&country=$country
https://cheapsms.xyz/handler/index?api_key=$api_key&action=getBalance

Параметры:
$api_key = ВАШ_API_KEY

Ответ сервиса:
ACCESS_BALANCE:$balance (где $balance - баланс на счету)
Возможные ошибки:
BAD_KEY - Неверный API-ключ
ERROR_SQL - ошибка SQL-сервера

Пример:
https://cheapsms.xyz/handler/index?api_key=f8d597bb7439df66a4eeb5befdee6e44&action=getBalance
https://cheapsms.xyz/handler/index?api_key=$api_key&action=getNumber&service=$service&country=$country

Параметры:
$api_key = ВАШ_API_KEY
$service - код сервиса (например: telegram, vk, instagram)
$country - ID страны (например: 1 для России, 2 для Украины)

ВАЖНО: Теперь нужно указывать ID страны! Используйте метод getCountries для получения списка стран с их ID.

Ответ сервиса:
NO_NUMBERS - нет номеров
NO_BALANCE - закончился баланс
ACCESS_NUMBER:$id:$number - номер выдан ($id - id операции,$number - номер телефона)

Возможные ошибки:
BAD_KEY - Неверный API-ключ
ERROR_SQL - ошибка SQL-сервера

Пример:
https://cheapsms.xyz/handler/index?api_key=f8d597bb7439df66a4eeb5befdee6e44&action=getNumber&service=vk
https://cheapsms.xyz/handler/index?api_key=$api_key&action=retryNumber&id=$id

Примечание:
Сервис остается тот же
Цена -50% от старого заказа
При отмене деньги не возвращаться


Параметры:
$api_key = ВАШ_API_KEY
$id - номер старой операции который нужно повторить

Ответ сервиса:
NUMBER_OFFLINE - сим-карта не онлайн
NO_BALANCE - закончился баланс
ACCESS_NUMBER:$id:$number - номер выдан ($id - id операции,$number - номер телефона)

Возможные ошибки:
ORDER_NOT_FOUND - номер старой операции не найден
IMPOSSIBLE_AGAIN - невозможно повторить этот заказ
BAD_KEY - Неверный API-ключ
ERROR_SQL - ошибка SQL-сервера

Пример:
https://cheapsms.xyz/handler/index?api_key=f8d597bb7439df66a4eeb5befdee6e44&action=getNumber&service=vk
https://cheapsms.xyz/handler/index?api_key=$api_key&action=setStatus&status=$status&id=$id&forward=$forward

Параметры:
$api_key = ВАШ_API_KEY
$id - id активации
$status - статусы активации:
  • -1 - отменить активацию
  • 1 - сообщить о готовности номера (смс на номер отправлено)
  • 3 - запросить еще один код (бесплатно)
  • 6 - завершить активацию(если был статус "код получен" - помечает успешно и завершает

Ответ сервиса:
ACCESS_READY - готовность номера подтверждена
ACCESS_RETRY_GET - ожидание нового смс
ACCESS_ACTIVATION - сервис успешно активирован
ACCESS_CANCEL - активация отменена
ACCESS_COMPLETED - активация использована

Возможные ошибки:
NO_ACTIVATION - id активации не существует
BAD_SERVICE - некорректное наименование сервиса
BAD_STATUS - некорректный статус
BAD_KEY - Неверный API-ключ
BAD_ACTION - некорректное действие
ERROR_SQL - ошибка SQL-сервера

Пример:
https://cheapsms.xyz/handler/index?api_key=f8d597bb7439df66a4eeb5befdee6e44&action=setStatus&status=1&id=1
https://cheapsms.xyz/handler/index?api_key=$api_key&action=getStatus&id=$id

Параметры:
$api_key = ВАШ_API_KEY
$id - id активации

Ответ сервиса:
STATUS_WAIT_CODE - ожидание смс
STATUS_WAIT_RETRY:$lastcode - ожидание уточнения кода (где $lastcode - прошлый, неподошедший код)
STATUS_WAIT_RESEND - ожидание повторной отправки смс
STATUS_CANCEL - активация отменена
STATUS_OK:$code - код получен (где $code - код активации)

Возможные ошибки:
NO_ACTIVATION - id активации не существует
BAD_KEY - Неверный API-ключ
ERROR_SQL - ошибка SQL-сервера

Пример:
https://cheapsms.xyz/handler/index?api_key=f8d597bb7439df66a4eeb5befdee6e44&action=getStatus&id=1