API

Для автоматизации взаимодействия с сервисом мы разработали API, документация по которому размещена на этой странице.

Корневой путь к API https://sms-online.pro/api/. Во всех ответах от сервера используется Content-Type: application/json.

Каждый запрос к API должен быть типа GET и включать параметр api_token (ваш API-ключ).

Обработка ошибок

При возникновении ошибки в ходе выполнения запроса вместо ожидаемого ответа вы получите объект с полем message, содержащим описание ошибки. Возможные ошибки:

  • Общие ошибки
    • PERMISSION_DENIED - был передан некорректный api_token
    • INVALID_IDENTIFIER - был передан некорректный идентификатор (номер сервиса, заказа и т.д.)
    • COMMON_ERROR - неспецифическая ошибка при выполнении запроса
  • Заказы
    • NEW_ORDERS_TEMPORARILY_UNAVAILABLE - прием новых заказов для всех сервисов временно недоступен
    • NO_NUMBERS - ошибка при получении номера (нет доступных номеров)
    • SMS_TIMEOUT - истекло время ожидания смс
    • CANNOT_RECEIVE_SMS - ошибка при получении смс
    • ORDER_QUEUE_ERROR - ошибка при обработке очереди заказов
    • SERVICE_UNAVAILABLE - сервис временно недоступен (нет свободных номеров)
    • LOW_BALANCE - недостаточный баланс для выполнения операции
    • ORDER_LIMIT_ERROR - превышен лимит потоков для аккаунта
    • UNCANCELLABLE_ORDER - невозможно отменить заказ (текущий статус заказа не позволяет этого сделать)
    • ORDER_ERROR - неспецифическая ошибка при обработке заказа

Пример ответа:

Баланс

GET https://sms-online.pro/api/balance/get?api_token=YOUR_API_TOKEN


При успешном выполнении запроса в ответ вернется текущее состояние счета.

  • balance - баланс
  • frozen - замороженные средства (больше 0, если имеются незавершенные заказы)

Пример ответа:

Новый заказ

GET https://sms-online.pro/api/orders/create/{service_id}?api_token=YOUR_API_TOKEN

service_id - номер сервиса для заказа


GET https://sms-online.pro/api/orders/create/random?api_token=YOUR_API_TOKEN - для заказа случайного сервиса из выбранных на странице Настройки в личном кабинете.


Сервисы

ВКонтакте

SERVICE_ID Страна
1 Китай
2 Египет
3 Гонконг
4 Индонезия
7 Лаос
8 Мьянма
9 Макао
10 Малайзия
11 Филиппины
12 Таиланд
14 Южная Африка
15 Казахстан
34 Россия
99 Бразилия
114 Польша
140 Кыргызстан
237 Конго
283 Украина

Telegram

SERVICE_ID Страна
18 Китай
32 Казахстан
59 Россия
119 Польша
144 Кыргызстан
231 Малайзия
232 Камбоджа
233 Филиппины
234 Таиланд
235 Гонконг
236 Макао
241 Конго
286 Украина
338 Вьетнам
339 Марокко
340 США
341 Канада
342 Лаос

Viber

SERVICE_ID Страна
20 Китай
31 Казахстан
58 Россия
118 Польша
143 Кыргызстан
240 Конго
285 Украина

Одноклассники

SERVICE_ID Страна
21 Китай
29 Казахстан
56 Россия
116 Польша
141 Кыргызстан
190 Украина
238 Конго

WhatsApp

SERVICE_ID Страна
22 Китай
30 Казахстан
57 Россия
117 Польша
142 Кыргызстан
239 Конго
284 Украина

Сервисы Google

SERVICE_ID Страна
23 Китай
35 Казахстан
61 Россия
121 Польша
146 Кыргызстан
242 Конго
288 Украина

Instagram

SERVICE_ID Страна
24 Китай
42 Казахстан
68 Россия
127 Польша
152 Кыргызстан
246 Конго
294 Украина

Yahoo

SERVICE_ID Страна
25 Китай
47 Казахстан
73 Россия
132 Польша
156 Кыргызстан
250 Конго
298 Украина

Яндекс

SERVICE_ID Страна
26 Китай
51 Казахстан
77 Россия
134 Польша
158 Кыргызстан
252 Конго
302 Украина

Microsoft

SERVICE_ID Страна
27 Китай
46 Казахстан
72 Россия
131 Польша
155 Кыргызстан
249 Конго
297 Украина

Facebook

SERVICE_ID Страна
28 Китай
37 Казахстан
63 Россия
122 Польша
147 Кыргызстан
243 Конго
289 Украина

Twitter

SERVICE_ID Страна
38 Казахстан
64 Россия
123 Польша
148 Кыргызстан
244 Конго
290 Украина

Uber

SERVICE_ID Страна
39 Казахстан
65 Россия
124 Польша
149 Кыргызстан
245 Конго
291 Украина

Gett

SERVICE_ID Страна
40 Казахстан
66 Россия
125 Польша
150 Кыргызстан
292 Украина

OLX

SERVICE_ID Страна
41 Казахстан
67 Россия
126 Польша
151 Кыргызстан
293 Украина

SeoSprint

SERVICE_ID Страна
43 Казахстан
69 Россия
128 Польша
153 Кыргызстан
247 Конго
295 Украина

Mail.ru

SERVICE_ID Страна
45 Казахстан
71 Россия
130 Польша
154 Кыргызстан
248 Конго
296 Украина

ДругВокруг

SERVICE_ID Страна
48 Казахстан
74 Россия
133 Польша
157 Кыргызстан
251 Конго
299 Украина

Rambler.ru

SERVICE_ID Страна
49 Казахстан
75 Россия

Такси Максим

SERVICE_ID Страна
50 Казахстан
76 Россия

Drom.ru

SERVICE_ID Страна
52 Казахстан
78 Россия
303 Украина

KakaoTalk

SERVICE_ID Страна
53 Казахстан
79 Россия
194 Польша
253 Конго
304 Украина

AOL

SERVICE_ID Страна
54 Казахстан
80 Россия
305 Украина

Mamba

SERVICE_ID Страна
55 Казахстан
81 Россия
255 Конго
306 Украина

Avito

SERVICE_ID Страна
62 Россия

Юла

SERVICE_ID Страна
70 Россия

Spaces.ru

SERVICE_ID Страна
82 Россия
83 Казахстан

Tinder

SERVICE_ID Страна
84 Россия
85 Казахстан
137 Польша
163 Кыргызстан
254 Конго
308 Украина

uCoz

SERVICE_ID Страна
87 Россия
88 Казахстан
161 Кыргызстан

Beget

SERVICE_ID Страна
89 Россия
90 Казахстан
162 Кыргызстан

Steam

SERVICE_ID Страна
91 Россия
92 Казахстан
135 Польша
138 Китай
159 Кыргызстан
256 Конго
311 Украина

Taobao

SERVICE_ID Страна
93 Россия
94 Казахстан
136 Польша
160 Кыргызстан
257 Конго
312 Украина

QIP

SERVICE_ID Страна
95 Россия
96 Казахстан
313 Украина

Blizzard

SERVICE_ID Страна
97 Россия
98 Казахстан

Viberate

SERVICE_ID Страна
100 Россия

HQ Trivia

SERVICE_ID Страна
102 Россия
103 Казахстан
104 Китай
268 Польша
269 Конго
270 Кыргызстан
316 Украина

Nike

SERVICE_ID Страна
105 Китай
139 Польша
164 Кыргызстан

Adidas

SERVICE_ID Страна
106 Россия
107 Казахстан
108 Китай

Nimses

SERVICE_ID Страна
109 Россия
110 Казахстан

ICQ

SERVICE_ID Страна
111 Казахстан
228 Россия
229 Кыргызстан
230 Польша
263 Конго

Joyride

SERVICE_ID Страна
112 Казахстан

Chauffeur Privé

SERVICE_ID Страна
165 Кыргызстан

Airbnb

SERVICE_ID Страна
177 Польша
178 Кыргызстан
179 Казахстан

Cdkeys.com

SERVICE_ID Страна
181 Польша
182 Казахстан
183 Кыргызстан

ViaBTC

SERVICE_ID Страна
184 Польша

g2g.com

SERVICE_ID Страна
186 Казахстан
187 Кыргызстан
188 Польша

Ситимобил

SERVICE_ID Страна
192 Казахстан
199 Россия

Авито + Переадресация

SERVICE_ID Страна
196 Россия

Юла + Переадресация

SERVICE_ID Страна
197 Россия

Яндекс + Переадресация

SERVICE_ID Страна
198 Россия

DeliveryClub

SERVICE_ID Страна
200 Россия

Discord

SERVICE_ID Страна
201 Казахстан
202 Россия
203 Польша
204 Кыргызстан
258 Конго

Burger_king

SERVICE_ID Страна
205 Россия

cjs-cdkeys

SERVICE_ID Страна
210 Польша
211 Кыргызстан

5ka.ru

SERVICE_ID Страна
212 Россия
213 Казахстан

Cian.ru + Переадресация

SERVICE_ID Страна
214 Россия

Line messenger

SERVICE_ID Страна
215 Россия
216 Казахстан
217 Кыргызстан
218 Польша
259 Конго
327 Украина

Indodax

SERVICE_ID Страна
219 Казахстан
220 Россия
221 Кыргызстан
222 Польша
260 Конго

ingos

SERVICE_ID Страна
223 Россия
261 Конго

GetContact

SERVICE_ID Страна
224 Россия
225 Казахстан
226 Кыргызстан
227 Польша
262 Конго

Skout

SERVICE_ID Страна
264 Польша
265 Конго

Skout 1

SERVICE_ID Страна
266 Китай

Skout 2

SERVICE_ID Страна
267 Китай

Dodopizza

SERVICE_ID Страна
271 Россия

tantan

SERVICE_ID Страна
272 Россия
273 Казахстан
274 Польша
275 Кыргызстан
276 Конго
330 Украина

Messenger

SERVICE_ID Страна
280 Россия
281 Казахстан
282 Польша

WeChat

SERVICE_ID Страна
287 Украина

Topface

SERVICE_ID Страна
333 Казахстан
334 Россия
335 Польша
336 Кыргызстан

Получение списка сервисов по API

GET https://sms-online.pro/api/services?api_token=YOUR_API_TOKEN


При успешном выполнении запроса в ответ вернется список актуальных на данный момент сервисов.

  • id - номер сервиса
  • country - страна
  • country_code - код страны
  • name - название сервиса
  • price - цена
  • quantity - кол-во доступных номеров (может принимать занчение true, если точное кол-во неизвестно)

Пример ответа:

Workflow обработки заказов

После получения ID заказа ваше приложение должно периодически отслеживать состояние заказа (см. раздел Статус заказа).

Внимание! Номер телефона в описании заказа появляется не сразу. После создания заказа необходимо опрашивать его состояние раз в 5-10 секунд. После того, как номер будет получен, на него можно отправлять СМС. Далее следует продолжать опрос состояния заказа до получения кода из СМС или ошибки в поле description.

Типичный порядок возможного взаимодействия с сервисом (пользовательские действия и статусы заказов):

workflow

Если вы принимаете участие в реферальной программе, то вы можете указать дополнительный GET-параметр ref=REF_ID при запросе от другого аккаунта. REF_ID доступен в личном кабинете на странице История баланса.

При успешном выполнении запроса в ответ вернется актуальное описание нового заказа.

  • id - номер заказа
  • sms_service_name - название сервиса
  • country - страна
  • country_code - код страны
  • phone - номер телефона
  • state - статус заказа (одно из значений):
    • awaiting_phone - ожидается выдача телефонного номера
    • awaiting_sms - номер выдан, ожидается СМС на него
    • success - СМС принято
    • error - произошла ошибка
    • cancelled - заказ отменен
    • sms_timeout - не дождались СМС
  • cancelling_required - true, если была запрошена отмена, иначе false
  • description - описание статуса (код из смс или описание ошибки)
  • reorder - возможность повторного заказа смс на номер в данный момент (false - нельзя, иначе содержит численное значение стоимости повтора)
  • created_at - дата и время создания заказа (ГГГГ-ММ-ДД чч:мм:сс)

Пример ответа:

Статус заказа

GET https://sms-online.pro/api/orders/status/{order_id}?api_token=YOUR_API_TOKEN

order_id - номер заказа


При успешном выполнении запроса в ответ вернется актуальное описание заказа.

  • id - номер заказа
  • sms_service_name - название сервиса
  • country - страна
  • country_code - код страны
  • phone - номер телефона
  • state - статус заказа (одно из значений):
    • awaiting_phone - ожидается выдача телефонного номера
    • awaiting_sms - номер выдан, ожидается СМС на него
    • success - СМС принято
    • error - произошла ошибка
    • cancelled - заказ отменен
    • sms_timeout - не дождались СМС
  • cancelling_required - true, если была запрошена отмена, иначе false
  • description - описание статуса (код из смс или описание ошибки)
  • reorder - возможность повторного заказа смс на номер в данный момент (false - нельзя, иначе содержит численное значение стоимости повтора)
  • created_at - дата и время создания заказа (ГГГГ-ММ-ДД чч:мм:сс)

Пример ответа:

Отмена заказа

GET https://sms-online.pro/api/orders/cancel/{order_id}?api_token=YOUR_API_TOKEN

order_id - номер заказа


При успешном выполнении запроса в ответ вернется актуальное описание заказа. Параметр cancelling_required будет установлен в значение true

Внимание! Заказ можно отменить, только если он имеет один из следующих статусов: awaiting_phone, awaiting_sms, и cancelling_required == false (заказ не находится в состоянии отмены).

  • id - номер заказа
  • sms_service_name - название сервиса
  • country - страна
  • country_code - код страны
  • phone - номер телефона
  • state - статус заказа (одно из значений):
    • awaiting_phone - ожидается выдача телефонного номера
    • awaiting_sms - номер выдан, ожидается СМС на него
    • success - СМС принято
    • error - произошла ошибка
    • cancelled - заказ отменен
    • sms_timeout - не дождались СМС
  • cancelling_required - true, если была запрошена отмена, иначе false
  • description - описание статуса (код из смс или описание ошибки)
  • reorder - возможность повторного заказа смс на номер в данный момент (false - нельзя, иначе содержит численное значение стоимости повтора)
  • created_at - дата и время создания заказа (ГГГГ-ММ-ДД чч:мм:сс)

Пример ответа:

Повтор заказа

GET https://sms-online.pro/api/orders/repeat/{order_id}?api_token=YOUR_API_TOKEN

order_id - номер успешно завершенного заказа, который нужно повторить


При успешном выполнении запроса в ответ вернется актуальное описание заказа.

Внимание! Заказ можно повторить, только если он имеет статус success. Параметр reorder при этом должен быть численным (равен или больше нуля) - это стоимость повтора заказа. Если он имеет значение false, то повтор невозможен.

  • id - номер заказа
  • sms_service_name - название сервиса
  • country - страна
  • country_code - код страны
  • phone - номер телефона
  • state - статус заказа (одно из значений):
    • awaiting_phone - ожидается выдача телефонного номера
    • awaiting_sms - номер выдан, ожидается СМС на него
    • success - СМС принято
    • error - произошла ошибка
    • cancelled - заказ отменен
    • sms_timeout - не дождались СМС
  • cancelling_required - true, если была запрошена отмена, иначе false
  • description - описание статуса (код из смс или описание ошибки)
  • reorder - возможность повторного заказа смс на номер в данный момент (false - нельзя, иначе содержит численное значение стоимости повтора)
  • created_at - дата и время создания заказа (ГГГГ-ММ-ДД чч:мм:сс)

Пример ответа: