Receiving sms - API Documentation

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 страны

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 сервиса

name

Вконтакте

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

price

29.88

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

quantity

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

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

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

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

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

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

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

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

Russia

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

Ukraine

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

Kazakhstan

activ, altel, any, beeline, kcell, tele2,

China

any, chinamobile, china_unicom, unicom,

England (UK)

any, cmlink, ee, ezmobile, lebara, lycamobile, o2, talk_telecom, three, tmobile, vectone, vodafone,

Myanmar

any, telenor,

Indonesia

any, axis, indosat, telkomsel, three,

Malaysia

any, celcom, digi, hotlink, u_mobile, xox,

Kenya

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

Tanzania

any,

Viet Nam

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

Kyrgyzstan

any, beeline, megacom, o!,

USA

any, cellular, tmobile,

Israel

019mobile, any, golan_telecom, home_cellular, hot_mobile, jawwal, ooredoo, orange, pelephone, rami_levy,

Hong Kong

any, chinamobile, csl_mobile, imc, smartone, three, unicom,

Poland

aero2, any, e_telko, klucz, lycamobile, netia, orange, play, plus, tmobile,

Philippines

any, globe_telecom, smart, tm,

Madagascar

any,

Dem. Congo

africel, airtel, any, orange, vodacom,

Nigeria

airtel, any, etisalat, glomobile, mtn,

Macau

any,

Egypt

any, etisalat, orange, vodafone,

India

any,

Ireland

any, lycamobile,

Cambodia

any,

Laos

any, etl, telekom, tplus, unitel,

Haiti

any, natcom,

Côte d'Ivoire

any, moov, mtn, orange,

Gambia

africel, any, comium, gamcel, qcell,

Serbia

any, mobtel, mts, vip,

Yemen

any, mtn, sabafon, yemen_mobile,

SOUTH AFRICA

any, cell_c, lycamobile, mtn, telkom, vodacom,

Romania

any, digi, lycamobile, my_avon, orange, runex_telecom, telekom, vodafone,

Colombia

any, claro,

Estonia

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

Azerbaijan

any,

Canada (virtual)

any, cellular, lucky, rogers,

Morocco

any, iam, inwi, itissalat, orange,

Ghana

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

Argentina

any,

Uzbekistan

any, beeline, mts, ucell, uzmobile,

Cameroon

any, mtn, nexttel, orange,

Chad

airtel, any, salam, tigo,

Germany

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

Lithuania

any, tele2, telia,

Croatia

a1, any, tele2, tmobile,

Sweden

any, comviq, lycamobile, tele2, telenor, telia, three, vectone, vodafone,

Iraq

any, asiacell, korek, zain,

Netherlands

any, kpn, lebara, lycamobile, l_mobi, tmobile, vodafone,

Latvia

any, tele2,

Austria

a1, any, orange, telering, three, tmobile,

Belarus

any, life, mdc, mts,

Thailand

ais, any, dtac, truemove,

Saudi Arabia Saudi Arabia

any,

Mexico

any, telcel,

Taiwan

any, chunghwa, fareast,

Spain

any, lebara, lycamobile, orange, you_mobile,

Iran

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

Algeria

any, djezzy, mobilis, ooredoo,

Slovenia

any,

Bangladesh

any,

Senegal

any, expresso, free, orange,

Turkey

any, turkcell,

Czech Republic

any, o2, tmobile, vodafone,

Sri Lanka

any,

Peru

any,

Pakistan

any,

New Zealand

2degree, any, vodafone,

Guinea

any, cellcom, mtn, orange,

Mali

any, malitel, orange, telecel,

Venezuela

any,

Ethiopia

any,

Mongolia

any, beeline,

Brazil

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

Afghanistan

any, salaam,

Uganda

airtel, any, k2_telecom, lycamobile, mtn, orange, smart, smile, uganda_telecom,

Angola

any,

Cyprus

any, cyta, epic, lemontel, primetel, vectone,

France

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

New Guinea

any,

Mozambique

any,

Nepal

any,

Belgium

any,

Bulgaria

any,

Hungary

any,

Moldova

any, moldcell, orange, unite,

Italy

any,

Paraguay

any,

Honduras

any,

Tunisia

any,

Nicaragua

any,

Timor-Leste

any,

Bolivia

any,

Costa Rica

any,

Guatemala

any, claro, movistar, tigo,

UNITED ARAB EMIRATES

any,

Zimbabwe

any,

Puerto Rico

any,

Sudan

any, mtn, sudani_one, zain,

Togo

any,

100

Kuwait

any,

101

El Salvador

any,

102

Libya

any,

103

Jamaica

any, digi,

104

Trinidad and Tobago

any,

105

Ecuador

any,

106

Swaziland

any,

107

Oman

any,

108

Bosnia and Herzegovina

any,

109

Dominican Republic

altice, any, claro, viva,

111

Qatar

any,

113

Cuba

any,

112

Panama

any,

114

Mauritania

any, chinguitel, mattel, mauritel,

115

Sierra Leone

africel, airtel, any, qcell,

116

Jordan

any, orange, umniah, xpress, zain,

117

Portugal

any, lycamobile, vodafone,

118

Barbados

any,

119

Burundi

any,

120

Benin

any,

121

Brunei

any,

122

Bahamas

any,

123

Botswana

any, be_mobile, mascom, orange,

124

Belize

any,

125

CAR

any,

126

Dominica

any,

127

Grenada

any,

128

Georgia

any, beeline, geocell, hamrah_e_aval, magticom,

129

Greece

any, cosmote, q_telecom, vodafone,

130

Guinea-Bissau

any,

131

Guyana

any,

132

Iceland

any,

133

Comoros

any,

134

Saint Kitts and Nevis

any,

135

Liberia

any, cellcom, comium, libercell, libtelco, lonestar,

136

Lesotho

any,

137

Malawi

any,

138

Namibia

any,

139

Niger

any,

140

Rwanda

any,

141

Slovakia

any,

142

Suriname

any,

143

Tajikistan

any,

144

Monaco

any,

145

Bahrain

any,

146

Reunion

any,

147

Zambia

any,

148

Armenia

any, viva, vivo,

149

Somalia

any,

150

Congo

any,

151

Chile

any,

152

Burkina Faso

airtel, any, onatel, telecel,

153

Lebanon

alfa, any, ogero, touch,

154

Gabon

any,

155

Albania

any,

156

Uruguay

any,

157

Mauritius

any,

158

Bhutan

any,

159

Maldives

any,

160

Guadeloupe

any,

161

Turkmenistan

any,

162

French Guiana

any,

163

Finland

any,

164

Saint Lucia

any,

165

Luxembourg

any,

166

Saint Pierre and Miquelon

any,

167

Equatorial Guinea

any,

168

Djibouti

any,

169

Saint Kitts and Nevis

any,

170

Cayman Islands

any,

171

Montenegro

any,

172

Denmark

any, lycamobile,

173

Switzerland

any,

174

Norway

any,

175

Australia

any,

176

Eritrea

any,

177

South Sudan

any,

178

Sao Tome and Principe

any,

179

Aruba

any,

180

Montserrat

any,

181

Anguilla

any,

182

Japan

any,

183

Northern Macedonia

any,

184

Republic of Seychelles

any,

185

New Caledonia

any,

186

Cape Verde

any,

187

USA

any, lycamobile, tmobile,

190

South Korea

any,

189

Fiji

any,

195

Bermuda

any,

Annex 2. Service list

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

PGbonus

Airtel

Mylove

Lamoda

Квартплата+

Moneylion

Naver

JamesDelivery

CliQQ

MyMusicTaste

Alfa

inDriver

PingPong

Apple

Nttgame

Mamba

LightChat

Monobank

Justdating

Digikala

Twilio

Siply

Вконтакте

Icrypex

Fastmail

MTS CashBack

Hermes

Yaay

888casino

Potato

GlobalTel

Potato Chat

humblebundle

Bilibili

Douyu

hamrahaval

Эльдорадо

Gabi

Magnolia

Магнит

paycell

Вита экспресс

BIGO LIVE

Weibo

Citymobil/Urent

Kaggle

MapleSEA

HeyBox

Revolut

Poshmark

Rediffmail

Sizeer

SnappFood

Touchance

Keybase

Paysafecard

Zilch

CallApp

facebook

Blizzard

HQ Trivia

Wing Money

WeChat

Nike

RRSA

MPL

СhampionСasino

RoyalWin

Shopee

Bolt

Nanovest

CAIXA

Paxful

Skroutz

RuTube

BitClout

eBay

1хbet

iQIYI

Aitu

Zoho

SpotHit

Ticketmaster

GameArena

Банки

Uber

ssoidnet

Ziglu

1688

GalaxyWin

Netflix

Tencent QQ

Papara

ChaingeFinance

Payzapp

IndiaGold

Paytm

IFood

premium.one

Bitaqaty

Google,youtube,Gmail

AOL

Amasia

Tosla

Eneba

Kwai

Yubo

Pairs

Q12 Trivia

Киви

Haraj

Pyro Music

OfferUp

McDonalds

Delivery Club

OffGamers

MyFishka

Olacabs

Xiaomi

Dent

Whoosh

Agroinform

Meliuz

Детский мир

kolesa.kz

Snapchat

Disney Hotstar

Onlinerby

Setel

Airbnb

Hezzl

Roposo

CourseHero

Possible error

Server response

Description

BAD_ACTION

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

BAD_KEY

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

BAD_LANG

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

NO_ACTIVATION

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

ERROR_SQL

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

ERROR_API

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