Прием смс - Документация 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

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

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

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

NO_BALANCE

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

NO_NUMBERS

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

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

id

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

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

id

integer

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

lang

string

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

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

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

Описание

STATUS_WAIT_CODE

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

STATUS_CANCEL

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

STATUS_OK:CODE

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

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

ID

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

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

0

Россия

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

1

Украина

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

2

Казахстан

activ, altel, any, beeline, tele2,

3

Китай

any, chinamobile, unicom,

5

Мьянма

any, telenor,

6

Индонезия

any, axis, indosat, telkomsel,

8

Кения

airtel, any, telkom,

10

Вьетнам

any, mobifone, vietnamobile, viettel, vinaphone,

11

Кыргызстан

any, beeline, megacom, o!,

12

США

any,

15

Польша

any, klucz, orange,

16

Англия

any, ee, lebara, lycamobile, o2, threeuk, tmobile, vodafone,

19

Нигерия

airtel, any, etisalat, glomobile, mtn,

20

Макао

3macao, any,

21

Египет

any, etisalat, orange, vodafone,

23

Ирландия

any, lycamobile,

25

Лаос

any, telekom, unitel,

26

Гаити

any, natcom,

27

Кот д'Ивуар

any, moov, mtn, orange,

28

Гамбия

africel, any, comium, gamcel, qcell,

29

Сербия

any, mobtel, mts, vip,

30

Йемен

any, mtn, sabafon,

31

ЮАР

any, vodacom,

32

Румыния

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

34

Эстония

any, elisa, goodline, super, tele2,

35

Азербайджан

any, azerfon,

36

Канада

any, lucky,

38

Гана

any, glomobile, millicom, mtn, vodafone,

40

Узбекистан

any, mts, ucell, uzmobile,

42

Чад

airtel, any, salam, tigo,

43

Германия

any, lebara, o2,

44

Литва

any, telia,

45

Хорватия

any,

46

Швеция

any, comviq, lycamobile, tele2,

47

Ирак

any, asiacell, korek,

48

Нидерланды

any, lebara, lycamobile,

49

Латвия

any, tele2,

50

Австрия

any,

51

Беларусь

any, life, mdc, mts,

56

Испания

any, lebara,

59

Словения

any,

63

Чехия

any,

67

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

2degree, any, vodafone,

68

Гвинея

any, cellcom, mtn, orange,

69

Мали

any, malitel, telecel,

73

Бразилия

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

75

Уганда

airtel, any,

77

Кипр

any,

78

Франция

any, lycamobile,

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

ID

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

vk

Вконтакте

ok

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

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

ДругВокруг

bd

Пятерочка

kp

HQ Trivia

dt

Delivery Club

ya

Яндекс

mt

Steam

oi

Tinder

fd

Mamba, MeetMe

zz

Dent

kt

KakaoTalk

pm

AOL

tn

LinkedIN

qq

Tencent QQ

mg

Магнит

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

СпортМастер

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

Перекресток

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

Квартплата+

qe

GG

yw

Grindr

uz

OffGamers

gx

Hepsiburadacom

re

Coinbase

tj

RADA NABU

ts

PayPal

rt

hily

sf

SneakersnStuff

ot

Нет в списке

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

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

Описание

BAD_ACTION

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

BAD_KEY

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

BAD_LANG

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

NO_ACTIVATION

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

ERROR_SQL

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