API documentation

API is a Protocol of interaction between your SOFTWARE and our activation server.

The API is needed in order to automate the process of receiving SMS messages on your side All requests (supported by POST and GET) should go to

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

Attention

All requests must have API key-parameter "api_key", localization for interaction with ruble / dollar (ru/en) balance-parameter "lang", method name-parameter "action".

API key You can get in the section:Profile.

getBalance

To check the balance

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

Field

Type

Description

api_key

string

Your API key provides access to paid services. The API key should be kept secret

action

string

Method name

lang

string

Localization ru or en

Server response:

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

463.02

getCountryAndOperators

Get all countries and operators available to them

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

Field

Type

Description

api_key

string

Your API key provides access to paid services. The API key should be kept secret

lang

string

Localization ru or en

Server response:

Пример ответа в 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"}}]

Field

Example

Description

id

0

ID страны

name

Россия

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

operators

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

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

getServicesAndCost

Get current prices and number of rooms

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

Field

Type

Description

api_key

string

Your API key provides access to paid services. The API key should be kept secret

operator

string

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

country

integer

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

lang

string

Localization ru or en

Server response:

Пример ответа в 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"}]

Field

Example

Description

id

vk

ID сервиса

name

Вконтакте

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

price

29.88

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

quantity

19

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

getNumber

Room booking

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

Field

Type

Description

api_key

string

Your API key provides access to paid services. The API key should be kept secret

action

string

Method name

service

string

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

operator

string

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

country

integer

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

lang

string

Localization ru or en

Server response:

Server response

Example

Description

NO_BALANCE

NO_BALANCE

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

NO_NUMBERS

NO_NUMBERS

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

ACCESS_NUMBER:ID:NUMBER

ACCESS_NUMBER:234242:79991728822

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

setStatus

To change the status

https://sms-service-online.com/stubs/handler_api?api_key=APIKEY&action=setStatus&id=ID&status=STATUS&lang=LANG

Field

Type

Description

api_key

string

Your API key provides access to paid services. The API key should be kept secret

action

string

Method name

id

integer

Activation ID received when requesting a number

status

integer

Status to be transferred to activation

lang

string

Localization ru or en

Available statuses:

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

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

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

Server response:

Server response

Description

NO_BALANCE

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

ACCESS_CANCEL

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

ACCESS_RETRY_GET

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

ACCESS_ACTIVATION

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

getStatus

To obtain the current status

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

Field

Type

Description

api_key

string

Your API key provides access to paid services. The API key should be kept secret

action

string

Method name

id

integer

Activation ID received when requesting a number

lang

string

Localization ru or en

Server response:

Server response

Description

STATUS_WAIT_CODE

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

STATUS_CANCEL

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

STATUS_OK:CODE

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

Annex 1. List of countries

ID

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

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

0

Russia

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

1

Ukraine

3mob, any, intertelecom, kyivstar, life, lycamobile, mts, utel, vodafone,

2

Kazakhstan

activ, altel, any, beeline, tele2,

3

China

any, chinamobile, unicom,

4

Philippines

any, globe_telecom, tm,

5

Myanmar

any, telenor,

6

Indonesia

any, axis, indosat, telkomsel, threeuk,

7

Malaysia

any, digi, hotlink, u_mobile,

8

Kenya

airtel, any, econet, orange, safaricom, telkom,

10

Vietnam

any, itelecom, mobifone, vietnamobile, viettel, vinaphone,

11

Kyrgyzstan

any, beeline, megacom, o!,

12

USA (virtual)

any, cellular, tmobile,

13

Israel

any, orange, pelephone,

14

Hong Kong

any, chinamobile, csl_mobile, imc, threeuk, unicom,

15

Poland

any, klucz, orange, play,

16

England

any, cmlink, ee, ezmobile, lebara, lycamobile, o2, talk_telecom, threeuk, tmobile, vodafone,

17

Madagascar

any,

18

Dem. Congo

africel, airtel, any, orange, vodacom,

19

Nigeria

airtel, any, etisalat, glomobile, mtn,

20

Macau

any,

21

Egypt

any, etisalat, orange, vodafone,

22

India

any,

23

Ireland

any, lycamobile,

24

Cambodia

any,

25

Laos

any, etl, telekom, tplus, unitel,

26

Haiti

any, natcom,

27

Ivory coast

any, moov, mtn, orange,

28

Gambia

africel, any, comium, gamcel, qcell,

29

Serbia

any, mobtel, mts, vip,

30

Yemen

any, mtn, sabafon,

31

South Africa

any, vodacom,

32

Romania

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

33

Colombia

any,

34

Estonia

any, elisa, goodline, super, tele2, topconnect,

35

Azerbaijan

any, azerfon,

36

Canada (virtual)

any, cellular, lucky,

37

Morocco

any, inwi, itissalat, orange,

38

Ghana

airtel, any, glomobile, millicom, mtn, vodafone,

39

Argentina

any,

40

Uzbekistan

any, beeline, mts, ucell, uzmobile,

41

Cameroon

any, mtn, nexttel, orange,

42

Chad

airtel, any, salam, tigo,

43

Germany

any, fonic, lebara, lycamobile, o2, ortel_mobile, vodafone,

44

Lithuania

any, tele2, telia,

45

Croatia

any,

46

Sweden

any, comviq, lycamobile, tele2,

47

Iraq

any, asiacell, korek,

48

Netherlands

any, lebara, lycamobile,

49

Latvia

any, tele2,

50

Austria

any,

51

Belarus

any, life, mdc, mts,

52

Thailand

any, truemove,

53

Saud. Arabia

any,

54

Mexico

any,

55

Taiwan

any, chunghwa, fareast,

56

Spain

any, lebara, lycamobile,

57

Iran

any, aptel, azartel, hamrah_e_aval, irancell, rightel, samantel, shatel,

58

Algeria

any,

59

Slovenia

any,

60

Bangladesh

any,

61

Senegal

any,

62

Turkey

any,

63

Czech Republic

any, tmobile,

64

Sri Lanka

any,

65

Peru

any,

66

Pakistan

any,

67

New Zealand

2degree, any, vodafone,

68

Guinea

any, cellcom, mtn, orange,

69

Mali

any, malitel, telecel,

70

Venezuela

any,

71

Ethiopia

any,

72

Mongolia

any, beeline,

73

Brazil

algartelecom, any, claro, oi, tim, vivo,

74

Afghanistan

any,

75

Uganda

airtel, any,

76

Angola

any,

77

Cyprus

any,

78

France

any, lebara, lycamobile, sfr, syma_mobile, vectone,

79

Papua New Guinea

any,

80

Mozambique

any,

81

Nepal

any,

82

Belgium

any,

83

Bulgaria

any,

84

Hungary

any,

85

Moldova

any, moldcell, orange, unite,

86

Italy

any,

87

Paraguay

any,

88

Honduras

any,

89

Tunisia

any,

90

Nicaragua

any,

91

Timor-Leste

any,

92

Bolivia

any,

93

Costa Rica

any,

94

Guatemala

any,

95

UAE

any,

96

Zimbabwe

any,

97

Puerto Rico

any,

98

Sudan

any,

99

That

any,

100

Kuwait

any,

101

Salvador

any,

103

Jamaica

any,

104

Trinidad and Tobago

any,

105

Ecuador

any,

108

Bosnia and Herzegovina

any,

111

Qatar

any,

113

Cuba

any,

116

Jordan

any,

117

Portugal

any,

122

Bahamas

any,

Annex 2. Service list

ID

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

vk

VK.com

ok

OK.ru

wa

Whatsapp

vi

Viber

tg

Telegram

wb

WeChat

go

Google,youtube,Gmail

av

avito

fb

facebook

tw

Twitter

ub

Uber

qw

Qiwi

gt

Gett

sn

OLX

ig

Instagram

ss

Hezzl

ym

Юла

ma

Mail.ru

mm

Microsoft

uk

Airbnb

me

Line messenger

mb

Yahoo

we

Drugvokrug.ru

bd

5ka.ru

kp

HQ Trivia

dt

Delivery Club

ya

Yandex

mt

Steam

oi

Tinder

fd

Mamba, MeetMe

zz

Dent

kt

KakaoTalk

pm

AOL

tn

LinkedIN

qq

Tencent QQ

mg

Magnit

pf

pof.com

yl

Yalla

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

TikTok/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

tc

Rambler

dp

ProtonMail

pg

NRJ Music Awards

yf

Citymobil

op

MIRATORG

fx

PGbonus

qr

MEGA

yk

SportMaster

ls

Careem

bl

BIGO LIVE

mu

MyMusicTaste

fu

Snapchat

bf

Keybase

sg

OZON

uu

Wildberries

ua

BlaBlaCar

ab

Alibaba

iv

Inboxlv

zy

Nttgame

gd

Surveytime

fy

Mylove

ce

mosru

tl

Truecaller

hm

Globus

tx

Bolt

ka

Shopee

pl

Perekrestok.ru

ip

Burger King

cm

Prom

hw

AliPay

de

Karusel

jc

IVI

rl

inDriver

df

Happn

ui

RuTube

up

Magnolia

nz

Foodpanda

kf

Weibo

ri

BillMill

cc

Quipp

lr

Okta

za

JDcom

da

MTS CashBack

ug

Fiqsy

sq

KuCoinPlay

zr

Papara

xv

Wish

cx

Icrypex

cw

PaddyPower

li

Baidu

dz

Dominos Pizza

xz

paycell

rd

Lenta

qb

Payberry

hz

Drom

gl

GlobalTel

zk

Deliveroo

ia

Socios

xl

Wmaraci

yi

Yemeksepeti

ew

Nike

ae

myGLO

gb

YouStar

cy

РСА

qm

RosaKhutor

dh

eBay

yb

Pay.kvartplata.ru+

qe

GG

yw

Grindr

uz

OffGamers

gx

Hepsiburadacom

re

Coinbase

tj

RADA NABU

ts

PayPal

rt

hily

sf

SneakersnStuff

sv

Dostavista

qi

32red

bz

Blizzard

db

ezbuy

vw

CoinField

zl

Airtel

wf

Airtel

lw

MrGreen

co

Rediffmail

ey

miloan

ge

Paytm

os

Dhani

ql

CMTcuzdan

cq

Mercado

xk

DiDi

py

Monese

rv

Kotak811

jl

Hopi

pr

Trendyol

pu

Justdating

dk

Pairs

fm

Touchance

ph

SnappFood

sw

NCsoft

nr

Tosla

hy

Ininal

tr

Paysend

pq

CDkeys

ff

AVON

sd

dodopizza

ry

McDonalds

le

E bike Gewinnspiel

hr

JKF

qa

MyFishka

wc

Craigslist

kw

Foody

jg

Grab

mj

Zalo

eu

LiveScore

ll

888casino

ed

Gamer

pp

Huya

th

WestStein

xr

Tango

iz

Global24

tk

МВидео

rx

Sheerid

ki

99app

my

CAIXA

zm

OfferUp

tq

Swvl

au

Haraj

ei

Taksheel

rp

hamrahaval

pa

Gamekit

fs

Şikayet var

ul

Getir

cf

irancell

bt

Alfa

ud

Disney Hotstar

qu

Agroinform

un

humblebundle

rm

Faberlic

uo

CafeBazaar

ti

cryptocom

nk

Gittigidiyor

jm

mzadqatar

lp

Algida

si

Cita Previa

fj

Potato Chat

pt

Bitaqaty

qc

Primaries 2020

yo

Amasia

ve

Dream11

qh

Oriflame

iu

Bykea

ib

Immowelt

zv

Digikala

jb

Wing Money

vn

Yaay

wn

GameArena

bj

Vita express

st

Auchan

ev

Picpay

qn

Blued

ot

Not on the list

Possible error

Server response

Description

BAD_ACTION

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

BAD_KEY

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

BAD_LANG

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

NO_ACTIVATION

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

ERROR_SQL

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