Документация API

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

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

https://sms-service-online.com/stubs/handler_api

Внимание!

Во всех запросах должен присутствовать API ключ - параметр "api_key", локазация для взаимодействия с рублевым/долларовым (ru/en) балансом - параметр "lang", название метода - параметр "action".

API ключ Вы можете получить в разделе:Профиль.

Поле

Тип

Описание

api_key

string

Ваш API-ключ, обеспечивает доступ к оплаченным услугам. API-ключ следует хранить в тайне

action

string

Название метода

lang

string

Локализация ru или en

Ответ сервера:

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

463.02

getCountryAndOperators

Получить все страны и операторов доступных для них

https://sms-service-online.com/stubs/handler_api?api_key=APIKEY&action=getCountryAndOperators&lang=LANG

Поле

Тип

Описание

api_key

string

Ваш API-ключ, обеспечивает доступ к оплаченным услугам. API-ключ следует хранить в тайне

lang

string

Локализация ru или en

Ответ сервера:

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

[{"id":0,"name":"Россия","operators":{"any":"any","tele2":"tele2","tinkoff":"tinkoff","ttk":"ttk","yota":"yota"}},{"id":1,"name":"Украина","operators":{"any":"any","kyivstar":"kyivstar","life":"life","lycamobile":"lycamobile","mts":"mts","utel":"utel","vodafone":"vodafone"}}]

Поле

Пример

Описание

id

0

ID страны

name

Россия

Название страны

operators

["operators":{"aiva":"aiva", "any":"any"}]

Массив с ID операторов

getServicesAndCost

Получить актуальные цены и количество номеров

https://sms-service-online.com/stubs/handler_api?api_key=APIKEY&action=getServicesAndCost&country=COUNTRY&operator=OPERATOR&lang=LANG

Поле

Тип

Описание

api_key

string

Ваш API-ключ, обеспечивает доступ к оплаченным услугам. API-ключ следует хранить в тайне

operator

string

Сотовый оператор номер которого необходимо получить см. "Список стран"

country

integer

ID Страны номер которой необходимо получить см. "Список стран"

lang

string

Локализация ru или en

Ответ сервера:

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

[{"id":"vk","name":"Вконтакте","price":29.88,"quantity":"19"},{"id":"ok","name":"Ok.ru","price":1.34,"quantity":"2776"},{"id":"wa","name":"Whatsapp","price":0,"quantity":"0"}]

Поле

Пример

Описание

id

vk

ID сервиса

name

Вконтакте

Название сервиса

price

29.88

Актуальная цена

quantity

19

Количество номеров

Поле

Тип

Описание

api_key

string

Ваш API-ключ, обеспечивает доступ к оплаченным услугам. API-ключ следует хранить в тайне

action

string

Название метода

service

string

Сервис, номер для которого необходимо получить см. "Список сервисов"

operator

string

Сотовый оператор номер которого необходимо получить см. "Список стран"

country

integer

ID Страны номер которой необходимо получить см. "Список стран"

lang

string

Локализация ru или en

Ответы сервера:

Ответ сервера

Пример

Описание

NO_BALANCE

NO_BALANCE

Недостаточно баланса на аккаунте API

NO_NUMBERS

NO_NUMBERS

Нет номеров с заданными параметрами, попробуйте позже, или поменяйте оператора, страну.

ACCESS_NUMBER:ID:NUMBER

ACCESS_NUMBER:234242:79991728822

Получили номер, ID активации - ID, сам номер с кодом страны - NUMBER

Поле

Тип

Описание

api_key

string

Ваш API-ключ, обеспечивает доступ к оплаченным услугам. API-ключ следует хранить в тайне

action

string

Название метода

id

integer

ID активации, полученное при запросе номера

status

integer

Статус который необходимо передать активации

lang

string

Локализация ru или en

Доступные статусы:

3 - Запросить еще одну смс

6 - Завершить активацию

8 - Отменить заказ

Ответы сервера:

Ответ сервера

Описание

NO_BALANCE

Недостаточно баланса на аккаунте API

ACCESS_CANCEL

Активация отменена

ACCESS_RETRY_GET

Ожидаем новое смс

ACCESS_ACTIVATION

Активация успешно завершена

Поле

Тип

Описание

api_key

string

Ваш API-ключ, обеспечивает доступ к оплаченным услугам. API-ключ следует хранить в тайне

action

string

Название метода

id

integer

ID активации, полученное при запросе номера

lang

string

Локализация ru или en

Ответы сервера:

Ответ сервера

Описание

STATUS_WAIT_CODE

Ожидаем прихода смс

STATUS_CANCEL

активация отменена

STATUS_OK:CODE

Код получен (где CODE - код активации)

Приложение 1. Список стран

ID

Наименование

Доступные операторы

0

Russia

aiva, any, beeline, ezmobile, lycamobile, megafon, motiv, mts, rostelecom, sber, simsim, tele2, tinkoff, ttk, winmobile, yota,

1

Ukraine

any, kyivstar, life, lycamobile, mts, utel, vodafone,

2

Kazakhstan

activ, altel, any, beeline, tele2,

3

China

any, chinamobile, unicom,

5

Myanmar

any, telenor,

6

Indonesia

any, telkomsel,

8

Kenya

airtel, any,

11

Kyrgyzstan

any, beeline, megacom, o!,

15

Poland

any, klucz, orange,

16

England

any, ee, lebara, lycamobile, o2, tmobile,

19

Nigeria

airtel, any, etisalat, glomobile, mtn,

20

Macao

3macao, any,

21

Egypt

any, etisalat, orange, vodafone,

23

Ireland

any, lycamobile,

26

Haiti

any, natcom,

27

Ivory coast

any, mtn, orange,

28

Gambia

africel, any, comium, gamcel, qcell,

29

Serbia

any, mobtel, mts, vip,

30

Yemen

any, mtn, sabafon,

32

Romania

any, digi, lycamobile, orange, telekom, vodafone,

34

Estonia

any, goodline,

35

Azerbaijan

any, azerfon,

38

Ghana

any, glomobile, millicom, mtn, vodafone,

40

Uzbekistan

any, mts, ucell,

42

Chad

airtel, any, tigo,

43

Germany

any, o2,

44

Lithuania

any, telia,

45

Croatia

any,

46

Sweden

any, comviq, tele2,

47

Iraq

any, asiacell, korek,

48

Netherlands

any, lycamobile,

49

Latvia

any, tele2,

50

Austria

any,

51

Belarus

any, life, mdc, mts,

59

Slovenia

any,

63

Czech

any,

67

New Zealand

2degree, any, vodafone,

68

Guinea

any, cellcom, mtn, orange,

69

Mali

any, malitel, telecel,

72

Mongolia

any, beeline,

Приложение 2. Список сервисов

ID

Наименование

vk

VK.com

ok

Ok.ru

wa

Whatsapp

vi

Viber

tg

Telegram

wb

WeChat

go

Google

av

Avito

fb

facebook

tw

Twitter

ub

Uber

qw

Qiwi

gt

Gett

sn

OLX

ig

Instagram

ss

Hezzl

ym

Youla.ru

ma

Mail.ru

mm

Microsoft

uk

Airbnb

me

Line msg

mb

Yahoo

we

DrugVokrug.ru

bd

5ka.ru

kp

HQ Trivia

dt

Delivery Club

ya

Yandex

mt

Steam

oi

Tinder

fd

Mamba

zz

Dent

kt

KakaoTalk

pm

AOL

tn

LinkedIN

qq

Tencent QQ

mg

Magnit

pf

pof.com

kl

kolesa.kz

po

premium.one

nv

Naver

nf

Netflix

iq

icq

ob

Onlinerby

kb

kufarby

im

Imo

mc

Michat

ds

Discord

vv

Seosprint

ji

Monobank

lf

Douyin

hu

Ukrnet

wg

Skout

rz

EasyPay

vf

Q12 Trivia

ny

Pyro Music

rr

Wolt

fe

CliQQ

la

ssoidnet

zh

Zoho

gp

Ticketmaster

am

Amazon

ly

Olacabs

ot

Not on the list

Возможные ошибки

Ответ сервера

Описание

BAD_ACTION

Неправильное формирование запроса

BAD_KEY

Неверный API-ключ

BAD_LANG

Неверная локазация, приниматся ru или en

NO_ACTIVATION

ID активации не существует

ERROR_SQL

Ошибка базы SQL-сервера