Документация по API
Партнерская программа для разработчиков
Наш сервис предоставляет на выбор 2 вида API:
| API #1: 100% идентичный API смсэрея/смс-активейт | API #2: 100% идентичный API смс-рег |
Таким образом, Вы можете использовать совместно с GetSMS.ONLINE программное обеспечение, написанное под вышеперечисленные сервисы, добавив в конец файла:
C:\Windows\System32\drivers\etc\hosts
Следующую строку:
88.99.25.161 service-domain.com
Где service-domain.com - адрес сайта сервиса активаций с которым работает программное обеспечение.
API #1
Ссылка для запросов: http://api.getsms.online/stubs/handler_api.php
Тип параметров: POST или GET
Интервал между запросами: до 50 запросов в секунду с одного IP, так же результаты типа NO_NUMBERS кэшируются на 3-10 секунд (в зависимости от нагрузки)
Пример: http://api.getsms.online/stubs/handler_api.php?api_key=123456789&action=getPrices
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = getPrices
Возвращаемые значения:
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = getPrices
Возвращаемые значения:
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
Пример: http://api.getsms.online/stubs/handler_api.php?api_key=123456789&action=getNumbersStatus
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = getNumbersStatus
country = СТРАНА (ru - Россия, kz - Казахстан)
Возвращаемые значения:
Ответ:
{"ot_0":70,"av_0":98,"av_1":98,"fb_0":98,"go_0":92,"ig_0":97,"ok_0":86,"tg_0":97,"tw_0":98,"vi_0":98,"vk_0":75,"wb_0":3,"wa_0":98}
Где до черточки - название сервиса, после обозначение нужно ли включать переадресацию. 0 - не включать. 1 - включать.
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = getNumbersStatus
country = СТРАНА (ru - Россия, kz - Казахстан)
Возвращаемые значения:
Ответ:
{"ot_0":70,"av_0":98,"av_1":98,"fb_0":98,"go_0":92,"ig_0":97,"ok_0":86,"tg_0":97,"tw_0":98,"vi_0":98,"vk_0":75,"wb_0":3,"wa_0":98}
Где до черточки - название сервиса, после обозначение нужно ли включать переадресацию. 0 - не включать. 1 - включать.
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
Пример: http://api.getsms.online/stubs/handler_api.php?api_key=123456789&action=getBalance
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = getBalance
Возвращаемые значения:
Ответ:
ACCESS_BALANCE:БАЛАНС_СЧЕТА
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
ERROR_SQL - Ошибка SQL-сервера
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = getBalance
Возвращаемые значения:
Ответ:
ACCESS_BALANCE:БАЛАНС_СЧЕТА
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
ERROR_SQL - Ошибка SQL-сервера
Внимание! Данный функционал работает в тестовом режиме и доступен только для номеров Мегафон.
Пример: http://api.getsms.online/stubs/handler_api.php?api_key=123456789&action=getNumberBalance&num=79251234567
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = getBalance
num = НОМЕР_ТЕЛЕФОНА
Возвращаемые значения:
Ответ:
NUM_BALANCE: БАЛАНС_СЧЕТА_НОМЕРА
ИЛИ
ORDER_ACCEPTED - данное сообщение означает что баланс не может быть показан сразу, ваш заказ на проверку баланса получен системой и его можно будет узнать по истечению некоторого времени(от нескольких секунд до пары минут), после получения этого сообщения ваша программа должна повторять API запрос например раз в 10 секунд, пока не будет получен ответ "NUM_BALANCE: БАЛАНС_СЧЕТА_НОМЕРА" или иной, отличный от "ORDER_ACCEPTED"
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
ERROR_SQL - Ошибка SQL-сервера
WRONG_NUMBER - Не найдена успешная активация Avito+Пер. с вашего аккаунта с использованием этого номера
CANT_GET_BALANCE_FROM_THIS_NUMBER - На данном номере функция проверки баланса не была активована
TEMPORARY_ERROR - Ошибка получения баланса номера. Попробуйте снова через 10 минут.
Функция не работает для номеров которые были использованы для активации Avito+Пер. ранее чем 22.10.2016!
Пример: http://api.getsms.online/stubs/handler_api.php?api_key=123456789&action=getNumberBalance&num=79251234567
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = getBalance
num = НОМЕР_ТЕЛЕФОНА
Возвращаемые значения:
Ответ:
NUM_BALANCE: БАЛАНС_СЧЕТА_НОМЕРА
ИЛИ
ORDER_ACCEPTED - данное сообщение означает что баланс не может быть показан сразу, ваш заказ на проверку баланса получен системой и его можно будет узнать по истечению некоторого времени(от нескольких секунд до пары минут), после получения этого сообщения ваша программа должна повторять API запрос например раз в 10 секунд, пока не будет получен ответ "NUM_BALANCE: БАЛАНС_СЧЕТА_НОМЕРА" или иной, отличный от "ORDER_ACCEPTED"
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
ERROR_SQL - Ошибка SQL-сервера
WRONG_NUMBER - Не найдена успешная активация Avito+Пер. с вашего аккаунта с использованием этого номера
CANT_GET_BALANCE_FROM_THIS_NUMBER - На данном номере функция проверки баланса не была активована
TEMPORARY_ERROR - Ошибка получения баланса номера. Попробуйте снова через 10 минут.
Функция не работает для номеров которые были использованы для активации Avito+Пер. ранее чем 22.10.2016!
Пример: http://api.getsms.online/stubs/handler_api.php?api_key=123456789&action=getNumber&service=fb&country=ru
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = getNumber
country = СТРАНА_И_ОПЕРАТОР_НОМЕРА
service = ТРЕБУЕМЫЙ_СЕРВИС
forward = ВАРИАНТ №1, ВЫПОЛНИТЬ ЛИ УСТАНОВКУ ПЕРЕАДРЕСАЦИИ(0 - НЕТ, 1 - ДА) (только для Avito+Переадресация)
forward = ВАРИАНТ №2, НОМЕР ТЕЛЕФОНА ДЛЯ ПЕРЕАДРЕСАЦИИ (только для Avito+Переадресация)
count = ПЛАНИРУЕМОЕ_КОЛИЧЕСТВО_СМС_НА_ПОЛУЧАЕМЫЙ_НОМЕР
Таблица стран и операторов:
ru_beeline - Россия/Beeline
ru_mts - Россия/MTS
ru_megafon - Россия/Megafon
ru_tele2 - Россия/Tele2
ru_aiva - Россия/Aiva
ru - Россия/Любой
ua_beeline - Украина/Beeline
ua_kyivstar - Украина/Киевстар
ua_djuice - Украина/djuice
ua_mts - Украина/MTS
ua_jeans - Украина/Jeans
ua_life - Украина/Life :)
ua - Украина/Любой
kz_beeline - Казахстан/Beeline
kz_aktiv - Казахстан/Aktiv
kz_tele2 - Казахстан/Tele2
kz - Казахстан/Любой
by - Белоруссия/Любой
pl - Польша/Любой
uk - Великобритания/Любой
de - Германия/Любой
or - Любой
Таблица сервисов:
or/ot - Не в списке
mg - OpenAI
me - Yappy
dt - IZI KZ
tg - Telegram
wa - WhatsApp
oi - Букмекеры
pm - Joyride
sn - OLX
td - Tinder
nd - Pandao
nv - Naver
bc - BlaBCar
vk - VK.com
ds - Discord
at/av - Avito
yl - Youla
uk - MeetMe
ub - Uber
kt - KakaoT
ma - Mail.ru
ig - Instagram
ok - OK.ru
mb - Yahoo
fb - Facebook
mm - Microsoft
sm - Steam
wb - WeChat
we - AOL
gm/go - Google
tw - Twitter
vr/vi - Viber
ya - Yandex
Возвращаемые значения:
Ответ:
ACCESS_NUMBER:ID_АКТИВАЦИИ:ПОЛУЧЕННЫЙ_НОМЕР
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
ERROR_SQL - Ошибка SQL-сервера
BAD_SERVICE - Неверный сервис
BAD_COUNTRY - Неверная страна
NO_MEANS - Недостаточно средств на счету
NO_NUMBER - Нет номеров с заданными параметрами
Напоминаем, получение повторных смс совершенно бесплатно. Т.е. один раз заплатив за SMS от Facebook на номер +79501231234, в дальнейшем, вы сможете бесплатно получать на этот номер сколько угодно смс от Facebook, пока сим карта в нашем оборудовании не будет заменена, после замены сим карты получение повторных смс будет невозможно.
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = getNumber
country = СТРАНА_И_ОПЕРАТОР_НОМЕРА
service = ТРЕБУЕМЫЙ_СЕРВИС
forward = ВАРИАНТ №1, ВЫПОЛНИТЬ ЛИ УСТАНОВКУ ПЕРЕАДРЕСАЦИИ(0 - НЕТ, 1 - ДА) (только для Avito+Переадресация)
forward = ВАРИАНТ №2, НОМЕР ТЕЛЕФОНА ДЛЯ ПЕРЕАДРЕСАЦИИ (только для Avito+Переадресация)
count = ПЛАНИРУЕМОЕ_КОЛИЧЕСТВО_СМС_НА_ПОЛУЧАЕМЫЙ_НОМЕР
Таблица стран и операторов:
ru_beeline - Россия/Beeline
ru_mts - Россия/MTS
ru_megafon - Россия/Megafon
ru_tele2 - Россия/Tele2
ru_aiva - Россия/Aiva
ru - Россия/Любой
ua_beeline - Украина/Beeline
ua_kyivstar - Украина/Киевстар
ua_djuice - Украина/djuice
ua_mts - Украина/MTS
ua_jeans - Украина/Jeans
ua_life - Украина/Life :)
ua - Украина/Любой
kz_beeline - Казахстан/Beeline
kz_aktiv - Казахстан/Aktiv
kz_tele2 - Казахстан/Tele2
kz - Казахстан/Любой
by - Белоруссия/Любой
pl - Польша/Любой
uk - Великобритания/Любой
de - Германия/Любой
or - Любой
Таблица сервисов:
or/ot - Не в списке
mg - OpenAI
me - Yappy
dt - IZI KZ
tg - Telegram
wa - WhatsApp
oi - Букмекеры
pm - Joyride
sn - OLX
td - Tinder
nd - Pandao
nv - Naver
bc - BlaBCar
vk - VK.com
ds - Discord
at/av - Avito
yl - Youla
uk - MeetMe
ub - Uber
kt - KakaoT
ma - Mail.ru
ig - Instagram
ok - OK.ru
mb - Yahoo
fb - Facebook
mm - Microsoft
sm - Steam
wb - WeChat
we - AOL
gm/go - Google
tw - Twitter
vr/vi - Viber
ya - Yandex
Возвращаемые значения:
Ответ:
ACCESS_NUMBER:ID_АКТИВАЦИИ:ПОЛУЧЕННЫЙ_НОМЕР
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
ERROR_SQL - Ошибка SQL-сервера
BAD_SERVICE - Неверный сервис
BAD_COUNTRY - Неверная страна
NO_MEANS - Недостаточно средств на счету
NO_NUMBER - Нет номеров с заданными параметрами
Напоминаем, получение повторных смс совершенно бесплатно. Т.е. один раз заплатив за SMS от Facebook на номер +79501231234, в дальнейшем, вы сможете бесплатно получать на этот номер сколько угодно смс от Facebook, пока сим карта в нашем оборудовании не будет заменена, после замены сим карты получение повторных смс будет невозможно.
Пример: http://api.getsms.online/stubs/handler_api.php?api_key=123456789&action=getRepeat&service=fb&number=79601230000
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = getRepeat
number = ТРЕБУЕМЫЙ_НОМЕР
service = ТРЕБУЕМЫЙ_СЕРВИС
Возвращаемые значения:
Ответ:
ACCESS_NUMBER:ID_АКТИВАЦИИ:ПОЛУЧЕННЫЙ_НОМЕР
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
ERROR_SQL - Ошибка SQL-сервера
BAD_SERVICE - Неверный сервис
NO_MEANS - Недостаточно средств на счету
NO_NUMBER - В вашей истории активаций нет такого номера либо он не в сети
DOUBLE_RETRY - По данному номеру уже заказана повторная активация
Внимание! Повторы по Avito+Переадресация обрабатываются как обычный Avito, повторная установка переадресации и пополнение счета симкарты не предусмотрены.
Напоминаем - получение повторных смс совершенно бесплатно. Т.е. например один раз заплатив за смс от Facebook на номер +79501231234 в дальнейшем вы сможете бесплатно получать на этот номер сколько угодно смс от Facebook пока сим карта в нашем оборудовании не будет заменена, после замены сим карты получение повторных смс будет невозможно.
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = getRepeat
number = ТРЕБУЕМЫЙ_НОМЕР
service = ТРЕБУЕМЫЙ_СЕРВИС
Возвращаемые значения:
Ответ:
ACCESS_NUMBER:ID_АКТИВАЦИИ:ПОЛУЧЕННЫЙ_НОМЕР
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
ERROR_SQL - Ошибка SQL-сервера
BAD_SERVICE - Неверный сервис
NO_MEANS - Недостаточно средств на счету
NO_NUMBER - В вашей истории активаций нет такого номера либо он не в сети
DOUBLE_RETRY - По данному номеру уже заказана повторная активация
Внимание! Повторы по Avito+Переадресация обрабатываются как обычный Avito, повторная установка переадресации и пополнение счета симкарты не предусмотрены.
Напоминаем - получение повторных смс совершенно бесплатно. Т.е. например один раз заплатив за смс от Facebook на номер +79501231234 в дальнейшем вы сможете бесплатно получать на этот номер сколько угодно смс от Facebook пока сим карта в нашем оборудовании не будет заменена, после замены сим карты получение повторных смс будет невозможно.
Пример: http://api.getsms.online/stubs/handler_api.php?api_key=123456789&action=setStatus&id=123&status=1
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = setStatus
id = ID_АКТИВАЦИИ
status = УСТАНАВЛИВАЕМЫЙ_СТАТУС
forward = Российский номер телефона на который нужно выполнить переадресацию (обязательно, только если при getNumber был передан параметр forward=1)
Таблица возможных статусов:
Для активации со статусом:
0 [Ожидание готовности]:
-1 = Отмена активации
1 = Уведомление, что SMS отправлена
10 = Уведомление, что номер уже занят
1 [Ожидание кода]:
-1 = Отмена активации
2 [Код получен, ожидание проверки клиентом]:
6 = Код верный, завершение активации
3 = Код не верный, запрос уточнения
3 [Ожидание уточнения]:
6 = Отмена уточнения, завершение активации
4 [Ожидание скрина]:
6 = Отмена уточнения, завершение активации
5 [Ожидание переотправки SMS]:
-1 = Отмена активации
1 = Уведомление, что SMS отправлена
Возвращаемые значения:
Ответ:
ACCESS_CANCEL - Активация успешно отменена
ACCESS_ERROR_NUMBER_GET - Номер отмечен как использованный
ACCESS_READY - Система уведомлена о том, что SMS отправлена
ACCESS_RETRY_GET - Уточнение успешно запрошено
ACCESS_ACTIVATION - Активация успешно завершена
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
ERROR_SQL - Ошибка SQL-сервера
BAD_STATUS - Неверный статус
NO_ACTIVATION - Неверный ID активации
Если заказано больше 1 SMS на номер, то после установки статуса 6 [Активация завершена], функция вернет новую активацию на тот же номер, то есть ответ будет аналогичен ответу getNumber.
Напоминаем - получение повторных смс совершенно бесплатно. Т.е. например один раз заплатив за смс от Facebook на номер +79501231234 в дальнейшем вы сможете бесплатно получать на этот номер сколько угодно смс от Facebook пока сим карта в нашем оборудовании не будет заменена, после замены сим карты получение повторных смс будет невозможно.
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = setStatus
id = ID_АКТИВАЦИИ
status = УСТАНАВЛИВАЕМЫЙ_СТАТУС
forward = Российский номер телефона на который нужно выполнить переадресацию (обязательно, только если при getNumber был передан параметр forward=1)
Таблица возможных статусов:
Для активации со статусом:
0 [Ожидание готовности]:
-1 = Отмена активации
1 = Уведомление, что SMS отправлена
10 = Уведомление, что номер уже занят
1 [Ожидание кода]:
-1 = Отмена активации
2 [Код получен, ожидание проверки клиентом]:
6 = Код верный, завершение активации
3 = Код не верный, запрос уточнения
3 [Ожидание уточнения]:
6 = Отмена уточнения, завершение активации
4 [Ожидание скрина]:
6 = Отмена уточнения, завершение активации
5 [Ожидание переотправки SMS]:
-1 = Отмена активации
1 = Уведомление, что SMS отправлена
Возвращаемые значения:
Ответ:
ACCESS_CANCEL - Активация успешно отменена
ACCESS_ERROR_NUMBER_GET - Номер отмечен как использованный
ACCESS_READY - Система уведомлена о том, что SMS отправлена
ACCESS_RETRY_GET - Уточнение успешно запрошено
ACCESS_ACTIVATION - Активация успешно завершена
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
ERROR_SQL - Ошибка SQL-сервера
BAD_STATUS - Неверный статус
NO_ACTIVATION - Неверный ID активации
Если заказано больше 1 SMS на номер, то после установки статуса 6 [Активация завершена], функция вернет новую активацию на тот же номер, то есть ответ будет аналогичен ответу getNumber.
Напоминаем - получение повторных смс совершенно бесплатно. Т.е. например один раз заплатив за смс от Facebook на номер +79501231234 в дальнейшем вы сможете бесплатно получать на этот номер сколько угодно смс от Facebook пока сим карта в нашем оборудовании не будет заменена, после замены сим карты получение повторных смс будет невозможно.
Пример: http://api.getsms.online/stubs/handler_api.php?api_key=123456789&action=getStatus&id=123
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = getStatus
id = ID_АКТИВАЦИИ
Возвращаемые значения:
Ответ:
STATUS_CANCEL - Активация отменена
STATUS_WAIT_READY - Ожидаение готовности
STATUS_WAIT_CODE - Ожидание кода
STATUS_OK:КОД_ИЗ_SMS - Код получен
STATUS_WAIT_RETRY - Ожидание уточнения кода
STATUS_WAIT_SCREEN - Ожидание скрина
STATUS_WAIT_RESEND - Ожидание переотправки SMS (Система ждет, пока вы переотправите SMS)
STATUS_ACCESS:КОД_ИЗ_SMS - Активация завершена
STATUS_ACCESS_SCREEN:КОД_ИЗ_SMS - Активация завершена согласно скрину
STATUS_ERROR_NUMBER - Проблемы с номером
STATUS_ERROR_SERVICE - SMS приходят не от того сервиса, что заказан. Активация отменена
STATUS_ERROR - Ошибка системы
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
ERROR_SQL - Ошибка SQL-сервера
NO_ACTIVATION - Неверный ID активации
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = getStatus
id = ID_АКТИВАЦИИ
Возвращаемые значения:
Ответ:
STATUS_CANCEL - Активация отменена
STATUS_WAIT_READY - Ожидаение готовности
STATUS_WAIT_CODE - Ожидание кода
STATUS_OK:КОД_ИЗ_SMS - Код получен
STATUS_WAIT_RETRY - Ожидание уточнения кода
STATUS_WAIT_SCREEN - Ожидание скрина
STATUS_WAIT_RESEND - Ожидание переотправки SMS (Система ждет, пока вы переотправите SMS)
STATUS_ACCESS:КОД_ИЗ_SMS - Активация завершена
STATUS_ACCESS_SCREEN:КОД_ИЗ_SMS - Активация завершена согласно скрину
STATUS_ERROR_NUMBER - Проблемы с номером
STATUS_ERROR_SERVICE - SMS приходят не от того сервиса, что заказан. Активация отменена
STATUS_ERROR - Ошибка системы
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
ERROR_SQL - Ошибка SQL-сервера
NO_ACTIVATION - Неверный ID активации
В случае если время активации (20 минут) истекло, но вы так и не получили SMS, то выданный вам в этой активации номер попадает
в ваш личный "черный список", он больше не будет вам выдаваться на активациях под сервис который вы заказывали тогда, когда
смс не была получена.
Так же номер попадает в черный список в том случае если вы помечаете его как "использованный".
Таким образом вы можете видеть на любом другом аккаунте что под ваш сервис у нас осталось например 3 номера, но со своего аккаунты вы видите ноль, и при попыпке получить номер система сообщает вам что номеров нет, так как все эти 3 номера у вас в "черном списке".
Данная API функция полностью очистит ваш личный "черный список".
Пример: http://api.getsms.online/stubs/handler_api.php?api_key=123456789&action=cleanblacklist
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = cleanblacklist
Возвращаемые значения:
Ответ:
OK
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
ERROR_SQL - Ошибка SQL-сервера
Так же номер попадает в черный список в том случае если вы помечаете его как "использованный".
Таким образом вы можете видеть на любом другом аккаунте что под ваш сервис у нас осталось например 3 номера, но со своего аккаунты вы видите ноль, и при попыпке получить номер система сообщает вам что номеров нет, так как все эти 3 номера у вас в "черном списке".
Данная API функция полностью очистит ваш личный "черный список".
Пример: http://api.getsms.online/stubs/handler_api.php?api_key=123456789&action=cleanblacklist
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = cleanblacklist
Возвращаемые значения:
Ответ:
OK
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
ERROR_SQL - Ошибка SQL-сервера
1. Получить номер, вызывая функцию getNumber
2. Установить статус активации 1, вызывая функцию setStatus
3. Дождаться кода из SMS, вызывая функцию getStatus
4. Установить статус активации 6, вызывая функцию setStatus
2. Установить статус активации 1, вызывая функцию setStatus
3. Дождаться кода из SMS, вызывая функцию getStatus
4. Установить статус активации 6, вызывая функцию setStatus
Пример: http://api.getsms.online/stubs/handler_api.php?api_key=123456789&action=getRentNumberSMS&number=123
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = getRentNumberSMS
number = АРЕНДОВАННЫЙ_НОМЕР
count = КОЛИЧЕСТВО_ПОСЛЕДНИХ_СМС
Возвращаемые значения:
Ответ:
{"response":"0","items":[{ id_message: "123", date: "1551809583", sender: "7900000001", text: "text1" }, { id_message: "122", date: "1551809443", sender:"7900000001" text: "text2" }]}
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
ERROR_SQL - Ошибка SQL-сервера
WRONG_NUMBER - Неверный номер
Пример: http://api.getsms.online/stubs/handler_api.php?api_key=123456789&action=getRentList
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = getRentList
Возвращаемые значения:
Ответ:
{"response":"0","description": "success","data": { "rents":[{ number: 79801212123, time_start: 1540800475, time_end: 1553674075 }, { number: 79801212124, time_start: 1540800475, time_end: 1553674075 }]}}
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
ERROR_SQL - Ошибка SQL-сервера
RENT_LIST_EMPTY - Активных аренд нет
Пример: http://api.getsms.online/stubs/handler_api.php?api_key=123456789&action=getRentOneDay
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = getRentOneDay / getRentOneWeek / getRentOneMonth
forqiwi = yes (опционально, если номер нужен для QIWI)
number = 79771231231 (опционально, если продляем уже действующую аренду)
Возвращаемые значения:
Ответ:
success: X, где X - арендованный номер телефона
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
ERROR_SQL - Ошибка SQL-сервера
too low balance - Не хватает средств
no numbers - нет номеров
error, please try again - неизвестная ошибка, попробуйте снова
Пример: http://api.getsms.online/stubs/handler_api.php?api_key=123456789&action=callAvito
Параметры:
api_key = ВАШ_API_КЛЮЧ
action = callAvito
id = ID_АКТИВАЦИИ
Возвращаемые значения:
Ответ:
SUCCESS
Ошибки:
NO_KEY - Не указан API-ключ
NO_ACTION - Не указана API-функция
BAD_KEY - Неверный API-ключ
BAD_ACTION - Неверная API-функция
ERROR_SQL - Ошибка SQL-сервера
BAD_STATUS - Неверный статус
NO_ACTIVATION - Неверный ID активации
NUMBER_OFFLINE - Сим карта заменена, звонок невозможен (доступ к функции звонка гарантируется в течении 2ч с момента совершения активации)
API #2
Ссылка для запросов: http://api.getsms.online/METHOD_NAME.php
Тип параметров: POST или GET
Интервал между запросами: до 50 запросов в секунду с одного IP, так же результаты типа NO_NUMBERS кэшируются на 3-10 секунд (в зависимости от нагрузки)
METHOD_NAME = getBalance
Параметры:
apikey = ВАШ_API_КЛЮЧ
Возвращаемые значения:
Обычный ответ:
{"response":"1","balance":"SUM"} где:
1 - означает успешное выполнение метода
SUM = состояние баланса.
Ответ в случае ошибки:
{"response":"ERROR","error_msg":"MESSAGE"} где:
MESSAGE = описание ошибки, может принимать одно из следующих значений:
ERROR_NO_KEY - Не указан API-ключ
ERROR_WRONG_KEY - Неверный API-ключ
Параметры:
apikey = ВАШ_API_КЛЮЧ
Возвращаемые значения:
Обычный ответ:
{"response":"1","balance":"SUM"} где:
1 - означает успешное выполнение метода
SUM = состояние баланса.
Ответ в случае ошибки:
{"response":"ERROR","error_msg":"MESSAGE"} где:
MESSAGE = описание ошибки, может принимать одно из следующих значений:
ERROR_NO_KEY - Не указан API-ключ
ERROR_WRONG_KEY - Неверный API-ключ
METHOD_NAME = getNum
Параметры:
country = страна
Возможные значения:
ru_beeline - Россия/Beeline
ru_mts - Россия/MTS
ru_megafon - Россия/Megafon
ru_tele2 - Россия/Tele2
ru - Россия/Любой
ua_beeline - Украина/Beeline
ua_kyivstar - Украина/Киевстар
ua_djuice - Украина/djuice
ua_mts - Украина/MTS
ua_jeans - Украина/Jeans
ua_life - Украина/Life :)
ua - Украина/Любой
kz_beeline - Казахстан/Beeline
kz_aktiv - Казахстан/Aktiv
kz_tele2 - Казахстан/Tele2
kz - Казахстан/Любой
by - Белоруссия/Любой
pl - Польша/Любой
uk - Великобритания/Любой
de - Германия/Любой
all - Любой
service = сервис
Возможные значения:
other - Не в списке
mg - OpenAI
me - Yappy
dt - IZI KZ
telegram - Telegram
whatsapp - WhatsApp
oi - Букмекеры
pm - Joyride
sn - OLX
td - Tinder
nd - Pandao
nv - Naver
bc - BlaBCar
vk - VK.com
ds - Discord
avito - Avito
yl - Youla
uk - MeetMe
ub - Uber
kt - KakaoT
ma - Mail.ru
instagram - Instagram
classmates - OK.ru
mb - Yahoo
facebook - Facebook
mm - Microsoft
sm - Steam
wb - WeChat
we - AOL
gmail - Google
twitter - Twitter
Viber - Viber
ya - Yandex
Возвращаемые значения:
Обычный ответ:
{"response":"1","tzid":"TZID"} где:
1 - означает успешное выполнение метода
TZID = id вашей операции.
Ответ в случае ошибки:
{"response":"ERROR","error_msg":"MESSAGE"} где:
MESSAGE = описание ошибки, может принимать одно из следующих значений:
ERROR_NO_KEY - Не указан API-ключ
ERROR_WRONG_KEY - Неверный API-ключ
WARNING_LOW_BALANCE - недостаточно денег на счету
Service not define - неопределен сервис
%mn% to this TZID not applicable - метод %mn% к указаному TZID не применим
There is no TZID value - не указан или указан не верно TZID
There is no %param% value - не задано значение параметра %param%
Параметры:
country = страна
Возможные значения:
ru_beeline - Россия/Beeline
ru_mts - Россия/MTS
ru_megafon - Россия/Megafon
ru_tele2 - Россия/Tele2
ru - Россия/Любой
ua_beeline - Украина/Beeline
ua_kyivstar - Украина/Киевстар
ua_djuice - Украина/djuice
ua_mts - Украина/MTS
ua_jeans - Украина/Jeans
ua_life - Украина/Life :)
ua - Украина/Любой
kz_beeline - Казахстан/Beeline
kz_aktiv - Казахстан/Aktiv
kz_tele2 - Казахстан/Tele2
kz - Казахстан/Любой
by - Белоруссия/Любой
pl - Польша/Любой
uk - Великобритания/Любой
de - Германия/Любой
all - Любой
service = сервис
Возможные значения:
other - Не в списке
mg - OpenAI
me - Yappy
dt - IZI KZ
telegram - Telegram
whatsapp - WhatsApp
oi - Букмекеры
pm - Joyride
sn - OLX
td - Tinder
nd - Pandao
nv - Naver
bc - BlaBCar
vk - VK.com
ds - Discord
avito - Avito
yl - Youla
uk - MeetMe
ub - Uber
kt - KakaoT
ma - Mail.ru
instagram - Instagram
classmates - OK.ru
mb - Yahoo
facebook - Facebook
mm - Microsoft
sm - Steam
wb - WeChat
we - AOL
gmail - Google
twitter - Twitter
Viber - Viber
ya - Yandex
Возвращаемые значения:
Обычный ответ:
{"response":"1","tzid":"TZID"} где:
1 - означает успешное выполнение метода
TZID = id вашей операции.
Ответ в случае ошибки:
{"response":"ERROR","error_msg":"MESSAGE"} где:
MESSAGE = описание ошибки, может принимать одно из следующих значений:
ERROR_NO_KEY - Не указан API-ключ
ERROR_WRONG_KEY - Неверный API-ключ
WARNING_LOW_BALANCE - недостаточно денег на счету
Service not define - неопределен сервис
%mn% to this TZID not applicable - метод %mn% к указаному TZID не применим
There is no TZID value - не указан или указан не верно TZID
There is no %param% value - не задано значение параметра %param%
METHOD_NAME = setReady
Параметры:
apikey = ВАШ_API_КЛЮЧ
tzid = Идентификатор операции
Возвращаемые значения:
Обычный ответ:
{"response":"1"} где:
1 - означает успешное выполнение метода
Ответ в случае ошибки:
{"response":"ERROR","error_msg":"MESSAGE"} где:
MESSAGE = описание ошибки, может принимать одно из следующих значений:
ERROR_NO_KEY - Не указан API-ключ
ERROR_WRONG_KEY - Неверный API-ключ
Параметры:
apikey = ВАШ_API_КЛЮЧ
tzid = Идентификатор операции
Возвращаемые значения:
Обычный ответ:
{"response":"1"} где:
1 - означает успешное выполнение метода
Ответ в случае ошибки:
{"response":"ERROR","error_msg":"MESSAGE"} где:
MESSAGE = описание ошибки, может принимать одно из следующих значений:
ERROR_NO_KEY - Не указан API-ключ
ERROR_WRONG_KEY - Неверный API-ключ
METHOD_NAME = getState
Параметры:
apikey = ВАШ_API_КЛЮЧ
tzid = Идентификатор операции
Возвращаемые значения:
Обычный ответ:
{"response":"RESPONSE","service":"SERVICE","number":"NUMBER","msg":"ANSWER"} где:
NUMBER — выделенный номер, ANSWER — код из смс, SERVICE — сервис, значения такие же как в методе getNum
RESPONSE принимает одно из следующих значений:
TZ_NUM_PREPARE — выдан номер, ожидается выполнение метода SetReady
TZ_NUM_WAIT — ожидается ответ
TZ_NUM_ANSWER — поступил ответ
TZ_NUM_WAIT2 — ожидается уточнение полученного кода
WARNING_NO_NUMS — нету подходящих номеров
Также если время по операции уже истекло то получите следующие значения:
TZ_OVER_OK — операция завершена
TZ_OVER_EMPTY — ответ не поступил за отведенное время или вы не отправили запрос методом setReady
Ответ в случае ошибки:
{"response":"ERROR","error_msg":"MESSAGE"} где:
MESSAGE = описание ошибки, может принимать одно из следующих значений:
ERROR_NO_KEY - Не указан API-ключ
ERROR_WRONG_KEY - Неверный API-ключ
There is no TZID value - не указан или указан не верно TZID
Параметры:
apikey = ВАШ_API_КЛЮЧ
tzid = Идентификатор операции
Возвращаемые значения:
Обычный ответ:
{"response":"RESPONSE","service":"SERVICE","number":"NUMBER","msg":"ANSWER"} где:
NUMBER — выделенный номер, ANSWER — код из смс, SERVICE — сервис, значения такие же как в методе getNum
RESPONSE принимает одно из следующих значений:
TZ_NUM_PREPARE — выдан номер, ожидается выполнение метода SetReady
TZ_NUM_WAIT — ожидается ответ
TZ_NUM_ANSWER — поступил ответ
TZ_NUM_WAIT2 — ожидается уточнение полученного кода
WARNING_NO_NUMS — нету подходящих номеров
Также если время по операции уже истекло то получите следующие значения:
TZ_OVER_OK — операция завершена
TZ_OVER_EMPTY — ответ не поступил за отведенное время или вы не отправили запрос методом setReady
Ответ в случае ошибки:
{"response":"ERROR","error_msg":"MESSAGE"} где:
MESSAGE = описание ошибки, может принимать одно из следующих значений:
ERROR_NO_KEY - Не указан API-ключ
ERROR_WRONG_KEY - Неверный API-ключ
There is no TZID value - не указан или указан не верно TZID
METHOD_NAME = setOperationOk
Параметры:
apikey = ВАШ_API_КЛЮЧ
tzid = Идентификатор операции
Возвращаемые значения:
Обычный ответ:
{"response":"1","tzid":"TZID"} где:
1 - означает успешное выполнение метода
TZID = id вашей операции.
Ответ в случае ошибки:
{"response":"ERROR","error_msg":"MESSAGE"} где:
MESSAGE = описание ошибки, может принимать одно из следующих значений:
ERROR_NO_KEY - Не указан API-ключ
ERROR_WRONG_KEY - Неверный API-ключ
There is no TZID value - не указан или указан не верно TZID
Параметры:
apikey = ВАШ_API_КЛЮЧ
tzid = Идентификатор операции
Возвращаемые значения:
Обычный ответ:
{"response":"1","tzid":"TZID"} где:
1 - означает успешное выполнение метода
TZID = id вашей операции.
Ответ в случае ошибки:
{"response":"ERROR","error_msg":"MESSAGE"} где:
MESSAGE = описание ошибки, может принимать одно из следующих значений:
ERROR_NO_KEY - Не указан API-ключ
ERROR_WRONG_KEY - Неверный API-ключ
There is no TZID value - не указан или указан не верно TZID
METHOD_NAME = setOperationRevise
Параметры:
apikey = ВАШ_API_КЛЮЧ
tzid = Идентификатор операции
Возвращаемые значения:
Обычный ответ:
{"response":"1","tzid":"TZID"} где:
1 - означает успешное выполнение метода
TZID = id вашей операции.
Ответ в случае ошибки:
{"response":"ERROR","error_msg":"MESSAGE"} где:
MESSAGE = описание ошибки, может принимать одно из следующих значений:
ERROR_NO_KEY - Не указан API-ключ
ERROR_WRONG_KEY - Неверный API-ключ
There is no TZID value - не указан или указан не верно TZID
Параметры:
apikey = ВАШ_API_КЛЮЧ
tzid = Идентификатор операции
Возвращаемые значения:
Обычный ответ:
{"response":"1","tzid":"TZID"} где:
1 - означает успешное выполнение метода
TZID = id вашей операции.
Ответ в случае ошибки:
{"response":"ERROR","error_msg":"MESSAGE"} где:
MESSAGE = описание ошибки, может принимать одно из следующих значений:
ERROR_NO_KEY - Не указан API-ключ
ERROR_WRONG_KEY - Неверный API-ключ
There is no TZID value - не указан или указан не верно TZID
METHOD_NAME = getNumRepeat
Параметры:
apikey = ВАШ_API_КЛЮЧ
tzid = Идентификатор операции по которой требуется повтор.
Возвращаемые значения:
Обычный ответ:
{"response":"RESPONSE","tzid":"NEWTZID"} где:
1 - означает успешное выполнение метода
NEWTZID = id новой операции.
RESPONSE принимает одно из следующих значений:
0 — повтор по указанной операции невозможен;
1 — запрос выполнен успешно;
3 — Этот номер сейчас занят. Попробуйте позже.
Ответ в случае ошибки:
{"response":"ERROR","error_msg":"MESSAGE"} где:
MESSAGE = описание ошибки, может принимать одно из следующих значений:
ERROR_NO_KEY - Не указан API-ключ
ERROR_WRONG_KEY - Неверный API-ключ
There is no TZID value - не указан или указан не верно TZID
Параметры:
apikey = ВАШ_API_КЛЮЧ
tzid = Идентификатор операции по которой требуется повтор.
Возвращаемые значения:
Обычный ответ:
{"response":"RESPONSE","tzid":"NEWTZID"} где:
1 - означает успешное выполнение метода
NEWTZID = id новой операции.
RESPONSE принимает одно из следующих значений:
0 — повтор по указанной операции невозможен;
1 — запрос выполнен успешно;
3 — Этот номер сейчас занят. Попробуйте позже.
Ответ в случае ошибки:
{"response":"ERROR","error_msg":"MESSAGE"} где:
MESSAGE = описание ошибки, может принимать одно из следующих значений:
ERROR_NO_KEY - Не указан API-ключ
ERROR_WRONG_KEY - Неверный API-ключ
There is no TZID value - не указан или указан не верно TZID
METHOD_NAME = setOperationUsed
Параметры:
apikey = ВАШ_API_КЛЮЧ
tzid = Идентификатор операции
Возвращаемые значения:
Обычный ответ:
{"response":"1","tzid":"TZID"} где:
1 - означает успешное выполнение метода
TZID = id вашей операции.
Ответ в случае ошибки:
{"response":"ERROR","error_msg":"MESSAGE"} где:
MESSAGE = описание ошибки, может принимать одно из следующих значений:
ERROR_NO_KEY - Не указан API-ключ
ERROR_WRONG_KEY - Неверный API-ключ
There is no TZID value - не указан или указан не верно TZID
Параметры:
apikey = ВАШ_API_КЛЮЧ
tzid = Идентификатор операции
Возвращаемые значения:
Обычный ответ:
{"response":"1","tzid":"TZID"} где:
1 - означает успешное выполнение метода
TZID = id вашей операции.
Ответ в случае ошибки:
{"response":"ERROR","error_msg":"MESSAGE"} где:
MESSAGE = описание ошибки, может принимать одно из следующих значений:
ERROR_NO_KEY - Не указан API-ключ
ERROR_WRONG_KEY - Неверный API-ключ
There is no TZID value - не указан или указан не верно TZID