Skip to content

Latest commit

 

History

History
434 lines (293 loc) · 20.7 KB

SMSActivateApi.md

File metadata and controls

434 lines (293 loc) · 20.7 KB
Raw

SMSActivateApi

Метод HTTP запрос Описание
getBalance GET Возращает текущий баланс на аккаунте.
getBalanceAndCashBack GET Возращает баланс и кэшбэк на аккаунте.
getNumbersStatusByDefaultSettingFromSite GET Возращает информацию о доступных сервисах исходя из настроек сайтов.
getNumbersStatus GET Возращает информацию о доступных сервисах.
getNumber GET Возращает активацию.
getMultiServiceNumber GET Возращает активацию для нескольких сервисов.
setStatus GET Устанавливает статус активации.
setStatusWithForwardPhone GET Устанавливает статус.
getStatus GET Возвращает статус активации.
getFullSms GET Возвращает полную смс, которая пришла на активацию.
getAllPrices GET Возращает полный список цен на активации.
getPricesAllServicesByCountryId GET Возращает полный список цен на активации по идентификатору страны.
getPricesAllCountryByServiceShortName GET Возращает полный список цен на активаций для всех стран по выбранному сервису.
getPricesByCountryIdAndServiceShortName GET Возращает полный список цен на активации стране и сервису.
getCountries GET Возращает полный список всех стран.
getQiwiRequisites GET Возращает актуальные реквизиты Киви кошелька для пополнения баланса.
getAdditionalService GET Возращает дополнительный сервис для номера с переадрисацией.
getRentServicesAndCountries GET Возращает список сервисов и стран, которые поддерживают аренду.
getRentNumber GET Возвращает арендовый номер.
getRentStatus GET Возращает статус аренды.
setRentStatus GET Устанавливает статус аренды.
getRentList GET Возращает список арендованых номеров.
waitSms GET Останавливает поток на заданное число минут до прихода СМС на активацию, после чего возвращает текст СМС.
waitSmsForRent GET Останавливает поток на заданное число минут до прихода СМС на арендованный номер, после чего список СМС.
getCurrentActivations GET Возращает список текущих активаций.

getBalance

Возращает текущий баланс на аккаунте.

Принимаемые праметры: отсутсвуют

Возвращаемый тип: BigDecimal

getBalanceAndCashBack

Возращает сумму баланса и кэшбэка, как полный баланс на аккаунте.

Принимаемые праметры: отсутсвуют

Возвращаемый тип: SMSActivateGetBalanceAndCashBack

getNumbersStatusByDefaultSettingFromSite

Возвращает информацию о сервисах, исходя из настроек сайта.

Принимаемые параметры: отсутствуют

Возвращаемый тип: SMSActivateGetNumbersStatus

getNumbersStatus

Возращает информацию о доступных сервисах.

Принимаемые параметры:

Имя Тип Описание Обязательный
countryId Integer Идентификатор страны. Да.
operatorSet Set Set из операторов, которые доступны у сервиса. Да.

Возвращаемый тип: SMSActivateGetNumbersStatus

getNumber

Возращает активацию.

Принимаемые параметры:

Имя Тип Описание Обязательный
countryId int Идентификатор страны. Да.
service String Короткое имя сервиса. Да.
forward boolean Необходимо ли запросить номер с переадресацией. Нет.
operatorSet Set Набор операторов. Нет.
phoneException Set Исключающие префиксы только для России, набор чисел от 3 до 6 (7918,7900111). Нет.

Возвращаемый тип: SMSActivateActivation

getMultiServiceNumber

Возращает активацию для нескольких сервисов.

Принимаемые параметры:

Имя Тип Описание Обязательный
countryId int Идентификатор страны. Да.
serviceMap Set Набор сервисов, для которых приобретация активация. Да.
operatorSet Set Набор операторов. Нет.
multiForwardList List Список сервисов с переадрисацей. Нет.

Возвращаемый тип: SMSActivateGetMultiServiceNumberResponse

setStatus

Устанавливает статус активации.

Принимаемые параметры:

Имя Тип Описание Обязательный
activationId int Идентификатор активации Да.
status SMSActivateClientStatus Статус, который нужно установить активации. Да.

Вместо идентификатора активации можно передать полученный объет класса SMSActivateActivation после использования метода getNumber или одну из активаций после использования getMultiServiceNumber.

Возвращаемый тип: SMSActivateSetStatusResponse

setStatusWithForwardPhone

Устанавливает статус активации вместе с номером телефона, на который нужно выполнить переадресацию.

Принимаемые параметры:

Имя Тип Описание Обязательный.
activationId int Идентификатор активации. Да.
status SMSActivateClientStatus Статус активации, который нужно установить. Да.
forwardPhone Long Номер телефона на который нужно выполнить переадресацию. Да.

Возвращаемый тип: SMSActivateSetStatusResponse

getStatus

Возращает статус активации.

Имя Тип Описание Обязательный
activationId int Идентификатор активации. Да.

Вместо идентификатора активации можно передать полученный объет класса SMSActivateActivation после использования метода getNumber или одну из активаций после использования getMultiServiceNumber.

Возвращаемый тип: SMSActivateGetStatusResponse

getFullSms

Возвращает полную СМС, которая пришла на активацию.

Имя Тип Описание Обязательный
activationId int Идентификатор активации. Да.

Вместо идентификатора активации можно передать полученный объет класса SMSActivateActivation после использования метода getNumber или одну из активаций после использования getMultiServiceNumber.

Возвращаемый тип: SMSActivateGetFullSmsResponse

getAllPrices

Возвращает полный список цен на активации

Принимаемые параметры: отсуствуют

Возвращаемый тип: SMSActivateGetPricesResponse

getPricesAllServicesByCountryId

Возращает полный список сервисов по идентификатору страны.

Принимаемые параметры:

Имя Тип Описание Обязательный
countryId int Идентификатор страны. Да.

Возвращаемый тип: SMSActivateGetPricesResponse

getPricesAllCountryByServiceShortName

Принимаемые параметры:

Имя Тип Описание Обязательный
serviceShortName String Короткое имя сервиса Да.

Возвращаемый тип: SMSActivateGetPriceInfo

getPricesByCountryIdAndServiceShortName

Принимаемые параметры:

Имя Тип Описание Обязательный
countryId Integer Идентификатор страны. Да.
serviceShortName String Короткое имя сервиса Да.

Возвращаемый тип: SMSActivateGetPriceInfo

getCountries

Возращает полный список всех стран.

Принимаемые параметры: отсутствуют

Возвращаемый тип: SMSActivateGetCountriesResponse

getQiwiRequisites

Возвращает актуальный реквизиты киви кошелька для пополнения баланса.

Принимаемые параметры: отсутствуют

Возвращаемый тип: SMSActivateGetQiwiRequisitesResponse

getAdditionalService

Возвращает дополнительный сервис для номера с переадрисацией.

Имя Тип Описание Обязательный
activationId int Идентификатор активации. Да.
service String Короткое имя сервиса. Да.

Вместо идентификатора активации можно передать полученный объет класса SMSActivateActivation после использования метода getNumber или одну из активаций после использования getMultiServiceNumber.

Возвращаемый тип: SMSActivateActivation

getRentServicesAndCountries

Возвращает список сервисов и стран, поддерживают аренду.

Принимаемые параметры:

Имя Тип Описание Обязательный
countryId int Идентификатор страны. Да.
operatorSet Set Набор сотовых операторов
hours int Время аренды

Возвращаемый тип: SMSActivateGetRentServicesAndCountriesResponse

getRentNumber

Возращает арендовый номер.

Имя Тип Описание Обязательный
countryId int Идентификатор страны. Да.
service String Короткое имя сервиса. Да.
hours int Время аренды. Нет.
operator String Имя мобильного оператора. Нет.
urlWebhook String ... Нет.

Возвращаемый тип: SMSActivateRentActivation

getRentStatus

Возвращает статус аренды.

Имя Тип Описание Обязательный.
rentId int Идентификатор аредованного номера телефона. Да.

Вместо rentId можно передать объект SMSActivateRentActivation, который был получен после использования метода getRentNumber.

Возвращаемый тип: SMSActivateGetRentStatusResponse

setRentStatus

Устанавливает статус аренде.

Имя Тип Описание Обязательный
rentId int Идентификатор арендованного телефона. Да.
status SMSActivateClientRentStatus Статус аренды, который нужно установить. Да.

Вместо rentId можно передать объект SMSActivateRentActivation, который был получен после использования метода getRentNumber.

Возвращаемый тип: SMSActivateRentStatus

getRentList

Возращает список арендованых номеров.

Принимаемые параметры: отсутствуют

Возвращаемый тип: SMSActivateGetRentListResponse

waitSms

Останавливает поток на заданное число минут до прихода СМС на активацию, после чего возвращает текст СМС.

Принимаемые параметры:

Имя Тип Описание Обязательный
activationId int Идентификатор активации. Да.
maxWaitMinutes int Количество минут, которое необходимо ожидать СМС. Да.

Вместо идентификатора активации можно передать полученный объет класса SMSActivateActivation после использования метода getNumber или одну из активаций после использования getMultiServiceNumber.

Возвращаемый тип: String

waitSmsForRent

Останавливает поток на заданное число минут до прихода СМС на арендованный номер, после чего список СМС.

Принимаемые параметры:

Имя Тип Описание Обязательный
rentId int Идентификатор аренды. Да.
maxWaitMinutes int Количество минут, которое необходимо ожидать СМС. Да.

Вместо rentId можно передать объект SMSActivateRentActivation, который был получен после использования метода getRentNumber.

Возвращаемый тип: List<SMSActivateSMS>

getCurrentActivations

Возращает список текущих активаций.

Имя Тип Описание Обязательный
start int Порядковый номер первой запршиваемой активации. Да.
length int Порядковый номер последней запршиваемой активации. Да.

Возращаемый тип: SMSActivateGetCurrentActivations