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?api_token=YOUR_API_TOKEN


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

Внимание! Не используйте данный метод API для мониторинга свежих заказов. Вместо этого используйте метод для получения статуса конкретного заказа по его id (см. раздел Статус заказа).

  • id - номер заказа
  • sms_service_name - название сервиса
  • country - страна
  • 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/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 Индонезия
8 Мьянма
9 Макао
10 Малайзия
11 Филиппины
12 Таиланд
13 Вьетнам
14 Южная Африка
15 Казахстан
99 Бразилия
114 Польша
140 Кыргызстан

Telegram

SERVICE_ID Страна
18 Китай
32 Казахстан
119 Польша
144 Кыргызстан

Viber

SERVICE_ID Страна
20 Китай
31 Казахстан
118 Польша
143 Кыргызстан

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

SERVICE_ID Страна
21 Китай
29 Казахстан
116 Польша
141 Кыргызстан

WhatsApp

SERVICE_ID Страна
22 Китай
30 Казахстан
117 Польша
142 Кыргызстан

Сервисы Google

SERVICE_ID Страна
23 Китай
35 Казахстан
121 Польша
146 Кыргызстан

Instagram

SERVICE_ID Страна
24 Китай
42 Казахстан
127 Польша
152 Кыргызстан

Yahoo

SERVICE_ID Страна
25 Китай
47 Казахстан
132 Польша
156 Кыргызстан

Яндекс

SERVICE_ID Страна
26 Китай
51 Казахстан
134 Польша
158 Кыргызстан

Microsoft

SERVICE_ID Страна
27 Китай
46 Казахстан
131 Польша
155 Кыргызстан

Facebook

SERVICE_ID Страна
28 Китай
37 Казахстан
122 Польша
147 Кыргызстан

WeChat

SERVICE_ID Страна
33 Казахстан
120 Польша
145 Кыргызстан

Twitter

SERVICE_ID Страна
38 Казахстан
123 Польша
148 Кыргызстан

Uber

SERVICE_ID Страна
39 Казахстан
124 Польша
149 Кыргызстан

Gett

SERVICE_ID Страна
40 Казахстан
125 Польша
150 Кыргызстан

OLX

SERVICE_ID Страна
41 Казахстан
126 Польша
151 Кыргызстан

SeoSprint

SERVICE_ID Страна
43 Казахстан
128 Польша
153 Кыргызстан

Mail.ru

SERVICE_ID Страна
45 Казахстан
130 Польша
154 Кыргызстан

ДругВокруг

SERVICE_ID Страна
48 Казахстан
133 Польша
157 Кыргызстан

Rambler.ru

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

Такси Максим

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

Drom.ru

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

KakaoTalk

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

AOL

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

Mamba

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

Spaces.ru

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

Tinder

SERVICE_ID Страна
85 Казахстан
137 Польша
163 Кыргызстан

uCoz

SERVICE_ID Страна
88 Казахстан
161 Кыргызстан

Beget

SERVICE_ID Страна
90 Казахстан
162 Кыргызстан

Steam

SERVICE_ID Страна
92 Казахстан
135 Польша
138 Китай
159 Кыргызстан

Taobao

SERVICE_ID Страна
94 Казахстан
136 Польша
160 Кыргызстан

QIP

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

Blizzard

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

HQ Trivia

SERVICE_ID Страна
103 Казахстан
104 Китай

Nike

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

Adidas

SERVICE_ID Страна
107 Казахстан
108 Китай

Nimses

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

ICQ

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

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 Польша

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

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

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

workflow

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

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

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

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