Ontvangen van sms - API Documentatie

Прием смс - Документация API

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

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

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

Внимание

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

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

getBalance

Проверить баланс

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

Поле

Тип

Описание

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

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

name

Вконтакте

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

price

29.88

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

quantity

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

getNumber

Заказ номера

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

Поле

Тип

Описание

api_key

string

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

action

string

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

service

string

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

operator

string

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

country

integer

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

lang

string

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

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

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

Пример

Описание

NO_BALANCE

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

NO_NUMBERS

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

ACCESS_NUMBER:ID:NUMBER

ACCESS_NUMBER:234242:79991728822

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

setStatus

Сменить статус

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

Поле

Тип

Описание

api_key

string

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

action

string

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

integer

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

status

integer

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

lang

string

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

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

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

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

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

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

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

Описание

NO_BALANCE

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

ACCESS_CANCEL

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

ACCESS_RETRY_GET

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

ACCESS_ACTIVATION

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

getStatus

Получить текущий статус

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

Поле

Тип

Описание

api_key

string

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

action

string

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

integer

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

lang

string

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

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

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

Описание

STATUS_WAIT_CODE

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

STATUS_CANCEL

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

STATUS_OK:CODE

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

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

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

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

Россия

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

Украина

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

Казахстан

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

Китай

any, chinamobile, china_unicom, unicom,

Англия (UK)

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

Мьянма

any, telenor,

Индонезия

any, axis, indosat, telkomsel, three,

Малайзия

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

Кения

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

Танзания

any,

Вьетнам

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

Кыргызстан

any, beeline, megacom, o!,

США

any, cellular, tmobile,

Израиль

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

Гонконг

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

Польша

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

Филиппины

any, globe_telecom, smart, tm,

Мадагаскар

any,

Дем. Конго

africel, airtel, any, orange, vodacom,

Нигерия

airtel, any, etisalat, glomobile, mtn,

Макао

any,

Египет

any, etisalat, orange, vodafone,

Индия

any,

Ирландия

any, lycamobile,

Камбоджа

any,

Лаос

any, etl, telekom, tplus, unitel,

Гаити

any, natcom,

Кот д'Ивуар

any, moov, mtn, orange,

Гамбия

africel, any, comium, gamcel, qcell,

Сербия

any, mobtel, mts, vip,

Йемен

any, mtn, sabafon, yemen_mobile,

ЮАР

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

Румыния

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

Колумбия

any, claro,

Эстония

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

Азербайджан

any,

Канада (вирт.)

any, cellular, lucky, rogers,

Марокко

any, iam, inwi, itissalat, orange,

Гана

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

Аргентина

any,

Узбекистан

any, beeline, mts, ucell, uzmobile,

Камерун

any, mtn, nexttel, orange,

Чад

airtel, any, salam, tigo,

Германия

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

Литва

any, tele2, telia,

Хорватия

a1, any, tele2, tmobile,

Швеция

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

Ирак

any, asiacell, korek, zain,

Нидерланды

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

Латвия

any, tele2,

Австрия

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

Беларусь

any, life, mdc, mts,

Таиланд

ais, any, dtac, truemove,

Сауд. Аравия

any,

Мексика

any, telcel,

Тайвань

any, chunghwa, fareast,

Испания

altecom, any, euskaltel, lebara, lycamobile, movistar, orange, vodafone, yoigo, you_mobile,

Иран

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

Алжир

any, djezzy, mobilis, ooredoo,

Словения

any,

Бангладеш

any,

Сенегал

any, expresso, free, orange,

Турция

any, turkcell,

Чехия

any, o2, tmobile, vodafone,

Шри-Ланка

any,

Перу

any,

Пакистан

any,

Новая Зеландия

2degree, any, vodafone,

Гвинея

any, cellcom, mtn, orange,

Мали

any, malitel, orange, telecel,

Венесуэла

any,

Эфиопия

any,

Монголия

any, beeline,

Бразилия

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

Афганистан

any, salaam,

Уганда

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

Ангола

any,

Кипр

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

Франция

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

Новая Гвинея

any,

Мозамбик

any,

Непал

any,

Бельгия

any,

Болгария

any,

Венгрия

any,

Молдова

any, moldcell, orange, unite,

Италия

any,

Парагвай

any,

Гондурас

any,

Тунис

any,

Никарагуа

any,

Тимор-Лесте

any,

Боливия

any,

Коста Рика

any,

Гватемала

any, claro, movistar, tigo,

ОАЭ

any,

Зимбабве

any,

Пуэрто-Рико

any,

Судан

any, mtn, sudani_one, zain,

Того

any,

100

Кувейт

any,

101

Сальвадор

any,

102

Ливия

any,

103

Ямайка

any, digi,

104

Тринидад и Тобаго

any,

105

Эквадор

any,

106

Свазиленд

any,

107

Оман

any,

108

Босния и Герцеговина

any,

109

Доминиканская Республика

altice, any, claro, viva,

111

Катар

any,

113

Куба

any,

112

Панама

any,

114

Мавритания

any, chinguitel, mattel, mauritel,

115

Сьерра-Леоне

africel, airtel, any, qcell,

116

Иордания

any, orange, umniah, xpress, zain,

117

Португалия

any, lycamobile, vodafone,

118

Барбадос

any,

119

Бурунди

any,

120

Бенин

any,

121

Бруней

any,

122

Багамы

any,

123

Ботсвана

any, be_mobile, mascom, orange,

124

Белиз

any,

125

ЦАР

any,

126

Доминика

any,

127

Гренада

any,

128

Грузия

any, beeline, geocell, hamrah_e_aval, magticom,

129

Греция

any, cosmote, q_telecom, vodafone,

130

Гвинея-Бисау

any,

131

Гайана

any,

132

Исландия

any,

133

Коморы

any,

134

Сент-Китс и Невис

any,

135

Либерия

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

136

Лесото

any,

137

Малави

any,

138

Намибия

any,

139

Нигер

any,

140

Руанда

any,

141

Словакия

any,

142

Суринам

any,

143

Таджикистан

any,

144

Монако

any,

145

Бахрейн

any,

146

Реюньон

any,

147

Замбия

any,

148

Армения

any, viva, vivo,

149

Сомали

any,

150

Конго

any,

151

Чили

any,

152

Буркина-Фасо

airtel, any, onatel, telecel,

153

Ливан

alfa, any, ogero, touch,

154

Габон

any,

155

Албания

any,

156

Уругвай

any,

157

Маврикий

any,

158

Бутан

any,

159

Мальдивы

any,

160

Гваделупа

any,

161

Туркменистан

any,

162

Французская Гвиана

any,

163

Финляндия

any,

164

Сент-Люсия

any,

165

Люксембург

any,

166

Сент-Винсент и Гренадин

any,

167

Экваториальная Гвинея

any,

168

Джибути

any,

169

Антигуа и Барбуда

any,

170

Острова Кайман

any,

171

Черногория

any,

172

Дания

any, lycamobile,

173

Швейцария

any,

174

Норвегия

any,

175

Австралия

any,

176

Эритрея

any,

177

Южный Судан

any,

178

Сан-Томе и Принсипи

any,

179

Аруба

any,

180

Монтсеррат

any,

181

Ангилья

any,

182

Япония

any,

183

Северная Македония

any,

184

Республика Сейшелы

any,

185

Новая Каледония

any,

186

Кабо-Верде

any,

187

США

any, lycamobile, tmobile,

190

Южная Корея

any,

189

Фиджи

any,

195

Бермуды

any,

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

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

Grindr

РСА

Tencent QQ

Квартплата+

Gojek

Swvl

YouStar

Skroutz

Setel

KFC

Lenta

GoFundMe

OfferUp

Switips

Tosla

TradingView

СберМегаМаркет

humblebundle

Revolut

Mail.ru

OffGamers

CliQQ

Meliuz

premium.one

HQ Trivia

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

Sizeer

Airbnb

Burger King

SuperS

Uklon

MapleSEA

iQIYI

Cita Previa

Перекресток

Twitter

Киви

ssoidnet

Megogo

Fiverr

МВидео

hamrahaval

Socios

pof.com

Rediffmail

CAIXA

Праймериз 2020

Coinbase

ProtonMail

Icrypex

Truecaller

Band

Iwplay

Giftcloud

Zalo

Tinder

MyMusicTaste

AgriDevelop

ЗдравСити

Lamoda

Около

Hotline

SnappFood

Inboxlv

CafeBazaar

Pyro Music

CoinField

Iti

Divar

Lidl

McDonalds

Tatneft

СберМаркет

Prom

Gamer

MOMO

Allegro

Not in list

X5ID

Foody

Okko

Букмекерские

Pairs

Taobao

Dent

Ok.ru

Line msg

Huya

OLX

ВкусВилл

BlaBlaCar

Carousell

Baidu

WestStein

Rozetka

Betfair

dodopizza

Yaay

Zilch

TanTan

Humta

PayPal

Olacabs

WeChat

СпортМастер

IndiaGold

Alfa

Юла

Delivery Club

Bisu

Karusel

Vivo

Viber

Picpay

KazanExpress

163СOM

Imo

Mailru Group

Mylove

Douyu

ezbuy

kufarby

Grab

Microsoft

RuTube

Surveytime

Вконтакте

TikTok/Douyin

IFood

EasyPay

kolesa.kz

YouGotaGift

OnTaxi

paycell

GlobalTel

Магнит

Santander

Paxful

Payberry

Magnolia

Banqi

GalaxyWin

CMTcuzdan

Indomaret

Touchance

Instagram

PGbonus

Hermes

Onet

99app

Whoosh

MPL

Keybase

MrQ

Gett

Mobile01

SpotHit

Fastmail

HandyPick

PaddyPower

BitClout

Michat

Gittigidiyor

Monese

Hopi

Digikala

IVI

Poshmark

Seosprint

SneakersnStuff

JDcom

Twilio

Drom

Zoho

ДругВокруг

Adidas

RoyalWin

Q12 Trivia

HeyBox

Algida

Sheerid

Payzapp

Weibo

Blued

Potato Chat

LiveScore

PurePlatfrom

Zomato

Haraj

irancell

IQOS

Amasia

KakaoTalk

Noon

Careem

Bykea

Nanovest

eBay

GroupMe

Uber

AliPay

Trendyol

Tango

Şikayet var

miloan

GalaxyChat

Kwai

MTS CashBack

AOL

dbrUA

Trip

Верный

Netflix

Rambler

Onlinerby

OkCupid

NoBroker

Aitu

Dream11

OVO

AVON

BillMill

Ininal

Paytm

ChaingeFinance

Taksheel

RedBook

Paysafecard

CDkeys

Brand20ua

Likee

Papara

Powerkredite

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

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

Описание

BAD_ACTION

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

BAD_KEY

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

BAD_LANG

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

NO_ACTIVATION

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

ERROR_SQL

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

ERROR_API

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