ru.sms_activate

Class SMSActivateApi

java.lang.Object

ru.sms_activate.SMSActivateApi

public class SMSActivateApi
extends Object

The class is a high-level API for interacting with the SMS-Activate API. API capabilities allow you to work with the service through your software. Before starting work, you must have an API key and a referral link to use all the API capabilities. Use the methods that are implemented in this class.

All methods and constructor in SMSActivateApi throw SMSActivateWrongParameterException

Before request set referral identifier

See Also:

SMSActivateWrongParameterException, SMSActivateBaseException, SMSActivateWrongParameter, SMSActivateBaseTypeError

Field Summary

Fields

Modifier and Type	Field and Description
static int	MINIMAL_RENT_TIME The minimal rent time.

Constructor Summary

Constructors

Constructor and Description
SMSActivateApi(@NotNull String apiKey) Constructor API sms-activate with API key.

Method Summary

Modifier and Type	Method and Description
@NotNull SMSActivateActivation	getAdditionalService(int parentActivationId, @NotNull String service) Returns the activation for additional service by forwarding.
@NotNull SMSActivateActivation	getAdditionalService(@NotNull SMSActivateActivation parentActivation, @NotNull String service) Returns the activation for additional service by forwarding.
@NotNull SMSActivateGetPricesResponse	getAllPrices() Returns the all actual prices in all countries and all services.
@NotNull String	getApiKey() Returns the API key.
@NotNull BigDecimal	getBalance() Returns the current account balance in rubles.
@NotNull SMSActivateGetBalanceAndCashBackResponse	getBalanceAndCashBack() Returns the current account balance and cashBack in rubles.
@NotNull SMSActivateGetCountriesResponse	getCountries() Returns the country with information.
@NotNull SMSActivateGetFullSmsResponse	getFullSms(int activationId) Returns the specified object from server with text sms.
@NotNull SMSActivateGetFullSmsResponse	getFullSms(@NotNull SMSActivateActivation activation) Returns the specified object from server with text sms.
@NotNull SMSActivateGetMultiServiceNumberResponse	getMultiServiceNumber(int countryId, @NotNull Map<String,Boolean> serviceMap) Returns the specified object with activations id by countryId, multiService.
@NotNull SMSActivateGetMultiServiceNumberResponse	getMultiServiceNumber(int countryId, @NotNull Map<String,Boolean> serviceMap, @Nullable Set<String> operatorSet) Returns the specified object with activations id by countryId, multiService.
@NotNull SMSActivateGetMultiServiceNumberResponse	getMultiServiceNumber(int countryId, @NotNull Set<String> multiServiceSet) Returns the specified object id by countryId, multiService.
@NotNull SMSActivateActivation	getNumber(int countryId, @NotNull String service) Returns the activation by service, countryId.
@NotNull SMSActivateActivation	getNumber(int countryId, @NotNull String service, boolean forward) Returns the activation by service, countryId.
@NotNull SMSActivateActivation	getNumber(int countryId, @NotNull String service, boolean forward, @Nullable Set<String> operatorSet, @Nullable Set<String> phoneExceptionSet) Returns the activation by service, countryId, phoneException, operator, forward
@NotNull SMSActivateGetNumbersStatusResponse	getNumbersStatus(@Nullable Integer countryId, @Nullable Set<String> operatorSet) Returns the available services by country and operator.
@NotNull SMSActivateGetNumbersStatusResponse	getNumbersStatusByDefaultSettingFromSite() Returns the available services from setting site.
@NotNull SMSActivateGetPricesResponse	getPricesAllCountryByServiceShortName(@NotNull String serviceShortName) Returns the all actual price services by country id.
@NotNull SMSActivateGetPricesResponse	getPricesAllServicesByCountryId(int countryId) Returns the all actual price services by country id.
@NotNull SMSActivateGetPricesResponse	getPricesByCountryIdAndServiceShortName(@Nullable Integer countryId, @Nullable String serviceShortName) Returns the actual rent prices by country and service short name.
@NotNull SMSActivateGetQiwiRequisitesResponse	getQiwiRequisites() Returns the qiwi response with data on wallet.
@Nullable String	getRef() Returns the referral link.
@NotNull SMSActivateGetRentListResponse	getRentList() Returns the current rents.
@NotNull SMSActivateRentActivation	getRentNumber(int countryId, @NotNull String service) Returns the object rent on 4 by countryId and service short name.
@NotNull SMSActivateRentActivation	getRentNumber(int countryId, @NotNull String service, int hours) Returns the object rent on 4 by countryId and service short name.
@NotNull SMSActivateRentActivation	getRentNumber(int countryId, @NotNull String service, @Nullable String operator, int hours, @Nullable String urlWebhook) Returns the object rent on time.
@NotNull SMSActivateGetRentServicesAndCountriesResponse	getRentServicesAndCountries(int countryId, @Nullable Set<String> operatorSet, int hours) Returns the rent object with countries supported rent and accessed services by country.
@NotNull SMSActivateGetRentStatusResponse	getRentStatus(int rentId) Returns the list sms.
@NotNull SMSActivateGetRentStatusResponse	getRentStatus(@NotNull SMSActivateRentActivation rentActivation) Returns the list sms.
@NotNull SMSActivateGetStatusResponse	getStatus(int activationId) Returns the state by id activation.
@NotNull SMSActivateGetStatusResponse	getStatus(@NotNull SMSActivateActivation activation) Returns the state by activation.
void	setRef(@NotNull String ref) If you are a partner of sms-activate set the referral identifier.
@NotNull SMSActivateRentStatus	setRentStatus(int rentId, @NotNull SMSActivateClientRentStatus status) Sets the status on rent.
@NotNull SMSActivateRentStatus	setRentStatus(SMSActivateRentActivation rentActivation, @NotNull SMSActivateClientRentStatus status) Sets the status on rent.
void	setSmsActivateExceptionListener(@NotNull SMSActivateExceptionListener smsActivateExceptionListener) Sets the listener on error.
void	setSmsActivateWebClientListener(@NotNull SMSActivateWebClientListener smsActivateWebClientListener) Sets the listener on request to server.
@NotNull SMSActivateSetStatusResponse	setStatus(int activationId, @NotNull SMSActivateClientStatus status) Sets the status activation.
@NotNull SMSActivateSetStatusResponse	setStatus(@NotNull SMSActivateActivation activation, @NotNull SMSActivateClientStatus status) Sets the status activation.
@NotNull SMSActivateSetStatusResponse	setStatusWithForwardPhone(int activationId, @NotNull SMSActivateClientStatus status, @Nullable Long forwardPhone) Sets the status activation.
@Nullable String	waitSms(int activationId, int maxWaitMinutes) Wait the sms on activation by minutes.
@Nullable String	waitSms(@NotNull SMSActivateActivation activation, int maxWaitMinutes) Wait the sms on activation by minutes.
@NotNull List<SMSActivateSMS>	waitSmsForRent(int rentId, int maxWaitMinutes) Returns a list of sms that came for rent after a while.
@NotNull List<SMSActivateSMS>	waitSmsForRent(@NotNull SMSActivateRentActivation rentActivation, int maxWaitMinutes) Returns a list of sms that came for rent after a while.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MINIMAL_RENT_TIME

public static final int MINIMAL_RENT_TIME

The minimal rent time.

See Also:

Constant Field Values

Constructor Detail

SMSActivateApi

public SMSActivateApi(@NotNull
                      @NotNull String apiKey)
               throws SMSActivateWrongParameterException

Constructor API sms-activate with API key.

Parameters:

apiKey - API key (not be null).

Throws:

SMSActivateWrongParameterException - if api-key is incorrect.

Method Detail

setSmsActivateWebClientListener

public void setSmsActivateWebClientListener(@NotNull
                                            @NotNull SMSActivateWebClientListener smsActivateWebClientListener)

Sets the listener on request to server.

Parameters:

smsActivateWebClientListener - listener on request to server.

setSmsActivateExceptionListener

public void setSmsActivateExceptionListener(@NotNull
                                            @NotNull SMSActivateExceptionListener smsActivateExceptionListener)

Sets the listener on error.

Parameters:

smsActivateExceptionListener - listener on error.

getApiKey

@NotNull
public @NotNull String getApiKey()

Returns the API key.

Returns:

apiKey API key (not be null).

setRef

public void setRef(@NotNull
                   @NotNull String ref)

If you are a partner of sms-activate set the referral identifier. For example ref=softgorregtelegram. The referral identifier are given by support.

Parameters:

ref - referral identifier.

getRef

@Nullable
public @Nullable String getRef()

Returns the referral link.

Returns:

referral link.

getBalance

@NotNull
public @NotNull BigDecimal getBalance()
                                         throws SMSActivateBaseException

Returns the current account balance in rubles.

Returns:

current account balance in rubles.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;

SMSActivateBaseException

getBalanceAndCashBack

@NotNull
public @NotNull SMSActivateGetBalanceAndCashBackResponse getBalanceAndCashBack()
                                                                                  throws SMSActivateBaseException

Returns the current account balance and cashBack in rubles.

Returns:

current account balance and cashBack in rubles.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;

SMSActivateBaseException

getNumbersStatusByDefaultSettingFromSite

@NotNull
public @NotNull SMSActivateGetNumbersStatusResponse getNumbersStatusByDefaultSettingFromSite()
                                                                                                throws SMSActivateBaseException

Returns the available services from setting site.

Returns:

the available services.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;

SMSActivateBaseException

getNumbersStatus

@NotNull
public @NotNull SMSActivateGetNumbersStatusResponse getNumbersStatus(@Nullable
                                                                               @Nullable Integer countryId,
                                                                               @Nullable
                                                                               @Nullable Set<String> operatorSet)
                                                                        throws SMSActivateBaseException

Returns the available services by country and operator.

Parameters:

countryId - id country.

operatorSet - set names operators mobile network.

Returns:

available services by county and operator (not be null).

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;
• WRONG_COUNTRY_ID - if country id is incorrect;
• WRONG_OPERATOR - if operator or countryId is incorrect.

SMSActivateBaseException

getNumber

@NotNull
public @NotNull SMSActivateActivation getNumber(int countryId,
                                                          @NotNull
                                                          @NotNull String service)
                                                   throws SMSActivateBaseException

Returns the activation by service, countryId.

Parameters:

countryId - id country.

service - service name for activation.

Returns:

activation.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

SMSActivateBannedException - if your account has been banned.

Types errors:

Base type error in this method:

• NO_NUMBERS - if currently no numbers;
• NO_BALANCE - if your balance is less than the price;

Wrong parameter type error:

• BAD_KEY - if your api-key is incorrect;
• BAD_SERVICE - if service is incorrect;
• WRONG_COUNTRY_ID - if country id is incorrect.

SMSActivateBaseException

getNumber

@NotNull
public @NotNull SMSActivateActivation getNumber(int countryId,
                                                          @NotNull
                                                          @NotNull String service,
                                                          boolean forward)
                                                   throws SMSActivateBaseException

Returns the activation by service, countryId.

Parameters:

countryId - id country.

service - service name for activation.

forward - true if need number phone with redirection else false.

Returns:

activation.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

SMSActivateBannedException - if your account has been banned.

Types errors:

Base type error in this method:

• NO_NUMBERS - if currently no numbers;
• NO_BALANCE - if your balance is less than the price;

Wrong parameter type error:

• BAD_KEY - if your api-key is incorrect;
• BAD_SERVICE - if service is incorrect;
• WRONG_COUNTRY_ID - if country id is incorrect.

SMSActivateBaseException

getNumber

@NotNull
public @NotNull SMSActivateActivation getNumber(int countryId,
                                                          @NotNull
                                                          @NotNull String service,
                                                          boolean forward,
                                                          @Nullable
                                                          @Nullable Set<String> operatorSet,
                                                          @Nullable
                                                          @Nullable Set<String> phoneExceptionSet)
                                                   throws SMSActivateBaseException

Returns the activation by service, countryId, phoneException, operator, forward

Parameters:

countryId - id country.

service - service name for activation.

operatorSet - set mobile operators if operatorSet is null then .

phoneExceptionSet - set excepted id numbers prefix if phoneExceptionSet is null then.

forward - is it necessary to request a number with forwarding.

Returns:

activation.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

SMSActivateBannedException - if your account has been banned.

Types errors:

Base type error in this method:

• NO_NUMBERS - if currently no numbers;
• NO_BALANCE - if your balance is less than the price;
• WRONG_COUNTRY_ID - if country id is incorrect.

Wrong parameter type error:

• BAD_KEY - if your api-key is incorrect;
• WRONG_OPERATOR - if operator or countryId is incorrect;
• BAD_SERVICE - if service is incorrect;
• WRONG_PHONE_EXCEPTION - if one or more numbers prefix is incorrect.
• WRONG_COUNTRY_ID - if country id is incorrect.

SMSActivateBaseException

getMultiServiceNumber

@NotNull
public @NotNull SMSActivateGetMultiServiceNumberResponse getMultiServiceNumber(int countryId,
                                                                                         @NotNull
                                                                                         @NotNull Set<String> multiServiceSet)
                                                                                  throws SMSActivateBaseException

Returns the specified object id by countryId, multiService.
Separator for multiService is commas.

Parameters:

countryId - id country.

multiServiceSet - services for ordering (not be null).

Returns:

SMSActivateGetMultiServiceNumberResponse object.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

SMSActivateBannedException - if your account has been banned.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;
• WRONG_OPERATOR - if operator or countryId is incorrect;
• BAD_SERVICE - if service is incorrect;
• WRONG_COUNTRY_ID - if country id is incorrect;
• NOT_AVAILABLE - if country not supported multi-service.

SMSActivateBaseException

getMultiServiceNumber

@NotNull
public @NotNull SMSActivateGetMultiServiceNumberResponse getMultiServiceNumber(int countryId,
                                                                                         @NotNull
                                                                                         @NotNull Map<String,Boolean> serviceMap)
                                                                                  throws SMSActivateBaseException

Returns the specified object with activations id by countryId, multiService.
Separator for multiService, multiForward and operator is commas.

Parameters:

countryId - id country.

serviceMap - map service where key is service name, value is forward.

Returns:

specified object with activations.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

SMSActivateBannedException - if your account has been banned.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;
• WRONG_OPERATOR - if operator or countryId is incorrect;
• BAD_SERVICE - if service is incorrect;
• WRONG_COUNTRY_ID - if country id is incorrect;
• NOT_AVAILABLE - if country not supported multi-service.

SMSActivateBaseException

getMultiServiceNumber

@NotNull
public @NotNull SMSActivateGetMultiServiceNumberResponse getMultiServiceNumber(int countryId,
                                                                                         @NotNull
                                                                                         @NotNull Map<String,Boolean> serviceMap,
                                                                                         @Nullable
                                                                                         @Nullable Set<String> operatorSet)
                                                                                  throws SMSActivateBaseException

Returns the specified object with activations id by countryId, multiService.
Separator for multiService, multiForward and operator is commas.

Parameters:

countryId - id country.

serviceMap - map service where key is service name, value is forward.

operatorSet - mobile operator.

Returns:

specified object with activations.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

SMSActivateBannedException - if your account has been banned.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;
• WRONG_OPERATOR - if operator or countryId is incorrect;
• BAD_SERVICE - if service is incorrect;
• WRONG_COUNTRY_ID - if country id is incorrect;
• NOT_AVAILABLE - if country not supported multi-service.

SMSActivateBaseException

setStatus

@NotNull
public @NotNull SMSActivateSetStatusResponse setStatus(int activationId,
                                                                 @NotNull
                                                                 @NotNull SMSActivateClientStatus status)
                                                          throws SMSActivateBaseException

Sets the status activation.

Get number using getNumber method after that the following actions are available:
CANCEL - Cancel activation (if the number did not suit you)
MESSAGE_WAS_SENT - Report that SMS has been sent (optional)

To activate with status READY:
CANCEL - Cancel activation

Immediately after receiving the code:
REQUEST_ONE_MORE_CODE - Request another SMS
FINISH - Confirm SMS code and complete activation

To activate with status RETRY_GET:
FINISH - Confirm SMS code and complete activation

Parameters:

activationId - id to set activation status (not be null).

status - value to establish (not be null).

Returns:

access activation.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;
• BAD_STATUS - if service is incorrect;
• NO_ACTIVATION - if activation is not exist.

SMSActivateBaseException

setStatus

@NotNull
public @NotNull SMSActivateSetStatusResponse setStatus(@NotNull
                                                                 @NotNull SMSActivateActivation activation,
                                                                 @NotNull
                                                                 @NotNull SMSActivateClientStatus status)
                                                          throws SMSActivateBaseException

Sets the status activation.

Get number using getNumber method after that the following actions are available:
CANCEL - Cancel activation (if the number did not suit you)
MESSAGE_WAS_SENT - Report that SMS has been sent (optional)

To activate with status READY:
CANCEL - Cancel activation

Immediately after receiving the code:
REQUEST_ONE_MORE_CODE - Request another SMS
FINISH - Confirm SMS code and complete activation

To activate with status RETRY_GET:
FINISH - Confirm SMS code and complete activation

Parameters:

activation - activation to set activation status (not be null).

status - value to establish (not be null).

Returns:

access activation.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;
• BAD_STATUS - if service is incorrect;
• NO_ACTIVATION - if activation is not exist.

SMSActivateBaseException

setStatusWithForwardPhone

@NotNull
public @NotNull SMSActivateSetStatusResponse setStatusWithForwardPhone(int activationId,
                                                                                 @NotNull
                                                                                 @NotNull SMSActivateClientStatus status,
                                                                                 @Nullable
                                                                                 @Nullable Long forwardPhone)
                                                                          throws SMSActivateBaseException

Sets the status activation.

Get number using getNumber method after that the following actions are available:
CANCEL - Cancel activation (if the number did not suit you)
SEND_READY_NUMBER - Report that SMS has been sent (optional)

To activate with status READY:
CANCEL - Cancel activation

Immediately after receiving the code:
REQUEST_ONE_MORE_CODE - Request another SMS
FINISH - Confirm SMS code and complete activation

To activate with status RETRY_GET:
FINISH - Confirm SMS code and complete activation

Parameters:

activationId - id to set activation status (not be null).

status - value to establish (not be null).

forwardPhone - number phone for forward.

Returns:

access activation.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;
• BAD_STATUS - if service is incorrect;
• NO_ACTIVATION - if activation is not exist.

SMSActivateBaseException

getStatus

@NotNull
public @NotNull SMSActivateGetStatusResponse getStatus(int activationId)
                                                          throws SMSActivateBaseException

Returns the state by id activation.

Parameters:

activationId - id activation to get activation state.

Returns:

state activation.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;
• NO_ACTIVATION - if activation is not exist.

SMSActivateBaseException

getStatus

@NotNull
public @NotNull SMSActivateGetStatusResponse getStatus(@NotNull
                                                                 @NotNull SMSActivateActivation activation)
                                                          throws SMSActivateBaseException

Returns the state by activation.

Parameters:

activation - activation to get state.

Returns:

state activation.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;
• NO_ACTIVATION - if activation is not exist.

SMSActivateBaseException

getFullSms

@NotNull
public @NotNull SMSActivateGetFullSmsResponse getFullSms(int activationId)
                                                            throws SMSActivateBaseException

Returns the specified object from server with text sms.

Parameters:

activationId - id activation.

Returns:

full text sms with status:

• if SMS arrived, then the answer will be with the FULL_SMS status
• if expected then WAIT_CODE
• if canceled then CANCEL

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;
• NO_ACTIVATION - if activation is not exist.

SMSActivateBaseException

getFullSms

@NotNull
public @NotNull SMSActivateGetFullSmsResponse getFullSms(@NotNull
                                                                   @NotNull SMSActivateActivation activation)
                                                            throws SMSActivateBaseException

Returns the specified object from server with text sms.

Parameters:

activation - activation to get fullSMS.

Returns:

full text sms with status:

• if SMS arrived, then the answer will be with the FULL_SMS status
• if expected then WAIT_CODE
• if canceled then CANCEL

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;
• NO_ACTIVATION - if activation is not exist.

SMSActivateBaseException

getAllPrices

@NotNull
public @NotNull SMSActivateGetPricesResponse getAllPrices()
                                                             throws SMSActivateBaseException

Returns the all actual prices in all countries and all services.

Returns:

price list country.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;

SMSActivateBaseException

getPricesAllServicesByCountryId

@NotNull
public @NotNull SMSActivateGetPricesResponse getPricesAllServicesByCountryId(int countryId)
                                                                                throws SMSActivateBaseException

Returns the all actual price services by country id.

Parameters:

countryId - id country.

Returns:

all actual price services by country id.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;
• WRONG_COUNTRY_ID - if country id is incorrect.

SMSActivateBaseException

getPricesAllCountryByServiceShortName

@NotNull
public @NotNull SMSActivateGetPricesResponse getPricesAllCountryByServiceShortName(@NotNull
                                                                                             @NotNull String serviceShortName)
                                                                                      throws SMSActivateBaseException

Returns the all actual price services by country id.

Parameters:

serviceShortName - short name service.

Returns:

all actual price services by country id.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;
• WRONG_COUNTRY_ID - if country id is incorrect.

SMSActivateBaseException

getPricesByCountryIdAndServiceShortName

@NotNull
public @NotNull SMSActivateGetPricesResponse getPricesByCountryIdAndServiceShortName(@Nullable
                                                                                               @Nullable Integer countryId,
                                                                                               @Nullable
                                                                                               @Nullable String serviceShortName)
                                                                                        throws SMSActivateBaseException

Returns the actual rent prices by country and service short name.

Parameters:

countryId - id number (default 0).

serviceShortName - service for needed price list (default null).

  null, null -> all service and all country

  countryId, null -> all service in country

  null, serviceShortName -> all country by service

Returns:

price list country.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;
• WRONG_OPERATOR - if country id is incorrect;
• WRONG_SERVICE - if service is incorrect;
• WRONG_COUNTRY_ID - if country id is incorrect.

SMSActivateBaseException

getCountries

@NotNull
public @NotNull SMSActivateGetCountriesResponse getCountries()
                                                                throws SMSActivateBaseException

Returns the country with information.

Returns:

country with information.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;

SMSActivateBaseException

getQiwiRequisites

@NotNull
public @NotNull SMSActivateGetQiwiRequisitesResponse getQiwiRequisites()
                                                                          throws SMSActivateBaseException

Returns the qiwi response with data on wallet.

Returns:

qiwi response with data on wallet with status:

• SUCCESS - all is OK;
• FALSE - acceptance of qiwi payments is not possible.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;

SMSActivateBaseException

getAdditionalService

@NotNull
public @NotNull SMSActivateActivation getAdditionalService(@NotNull
                                                                     @NotNull SMSActivateActivation parentActivation,
                                                                     @NotNull
                                                                     @NotNull String service)
                                                              throws SMSActivateBaseException

Returns the activation for additional service by forwarding.

Parameters:

parentActivation - activation to get additional service.

service - service short name.

Returns:

id activation for additional service by forwarding

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Base type error in this method:

• NO_BALANCE - if your balance is less than the price.

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;
• WRONG_ADDITIONAL_SERVICE - if additional service is incorrect;
• WRONG_ACTIVATION_ID - if id parent is incorrect;
• WRONG_SECURITY - if trying to transfer an activation ID without forwarding, or a completed / inactive activation;
• REPEAT_ADDITIONAL_SERVICE - if ordered again service that has already been purchased;

SMSActivateBaseException

getAdditionalService

@NotNull
public @NotNull SMSActivateActivation getAdditionalService(int parentActivationId,
                                                                     @NotNull
                                                                     @NotNull String service)
                                                              throws SMSActivateBaseException

Returns the activation for additional service by forwarding.

Parameters:

parentActivationId - id activation.

service - service short name.

Returns:

id activation for additional service by forwarding

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Base type error in this method:

• NO_BALANCE - if your balance is less than the price.

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;
• WRONG_ADDITIONAL_SERVICE - if additional service is incorrect;
• WRONG_ACTIVATION_ID - if id parent is incorrect;
• WRONG_SECURITY - if trying to transfer an activation ID without forwarding, or a completed / inactive activation;
• REPEAT_ADDITIONAL_SERVICE - if ordered again service that has already been purchased;

SMSActivateBaseException

getRentServicesAndCountries

@NotNull
public @NotNull SMSActivateGetRentServicesAndCountriesResponse getRentServicesAndCountries(int countryId,
                                                                                                     @Nullable
                                                                                                     @Nullable Set<String> operatorSet,
                                                                                                     int hours)
                                                                                              throws SMSActivateBaseException

Returns the rent object with countries supported rent and accessed services by country.

Parameters:

countryId - id country (default 0).

operatorSet - mobile operators.

hours - rent time in hours (default 4).

Returns:

the rent object with countries supported rent and accessed services by country.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter error types in this method:

• BAD_KEY - if your api-key is incorrect;
• WRONG_COUNTRY_ID - if country id is incorrect.

SMSActivateBaseException

getRentNumber

@NotNull
public @NotNull SMSActivateRentActivation getRentNumber(int countryId,
                                                                  @NotNull
                                                                  @NotNull String service)
                                                           throws SMSActivateBaseException

Returns the object rent on 4 by countryId and service short name.

Parameters:

countryId - id country.

service - service to which you need to get a number.

Returns:

object rent.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Base type error in this method:

• NO_NUMBERS - if currently no numbers;
• NO_BALANCE - if your balance is less than the price;

Wrong parameter type error:

• BAD_KEY - if your api-key is incorrect;
• BAD_SERVICE - if service is incorrect;
• ACCOUNT_INACTIVE - if no free numbers.

SMSActivateBaseException

getRentNumber

@NotNull
public @NotNull SMSActivateRentActivation getRentNumber(int countryId,
                                                                  @NotNull
                                                                  @NotNull String service,
                                                                  int hours)
                                                           throws SMSActivateBaseException

Returns the object rent on 4 by countryId and service short name.

Parameters:

countryId - id country.

service - service to which you need to get a number.

hours - rent time in hours.

Returns:

object rent.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Base type error in this method:

• NO_NUMBERS - if currently no numbers;
• NO_BALANCE - if your balance is less than the price;

Wrong parameter type error:

• BAD_KEY - if your api-key is incorrect;
• BAD_SERVICE - if service is incorrect;
• ACCOUNT_INACTIVE - if no free numbers.

SMSActivateBaseException

getRentNumber

@NotNull
public @NotNull SMSActivateRentActivation getRentNumber(int countryId,
                                                                  @NotNull
                                                                  @NotNull String service,
                                                                  @Nullable
                                                                  @Nullable String operator,
                                                                  int hours,
                                                                  @Nullable
                                                                  @Nullable String urlWebhook)
                                                           throws SMSActivateBaseException

Returns the object rent on time.

Parameters:

countryId - id country (default 0 - Russia).

service - service to which you need to get a number.

operator - mobile operator.

hours - rent time in hours (default MINIMAL_RENT_TIME hour).

urlWebhook - url for webhook.

Returns:

object rent.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Base type error in this method:

• NO_NUMBERS - if currently no numbers;
• NO_BALANCE - if your balance is less than the price;

Wrong parameter type error:

• BAD_KEY - if your api-key is incorrect;
• BAD_SERVICE - if service is incorrect;
• ACCOUNT_INACTIVE - if no free numbers;
• WRONG_OPERATOR - if operator is incorrect;
• WRONG_COUNTRY_ID - if country id is incorrect.

SMSActivateBaseException

getRentStatus

@NotNull
public @NotNull SMSActivateGetRentStatusResponse getRentStatus(int rentId)
                                                                  throws SMSActivateBaseException

Returns the list sms.

Parameters:

rentId - id received in response when ordering a number.

Returns:

list sms.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter type error:

• BAD_KEY - if your api-key is incorrect;
• NO_ID_RENT - if is not input.
• STATUS_WAIT_CODE - if not sms.
• STATUS_CANCEL - if rent is canceled.
• STATUS_FINISH - if rent is finished.

SMSActivateBaseException

getRentStatus

@NotNull
public @NotNull SMSActivateGetRentStatusResponse getRentStatus(@NotNull
                                                                         @NotNull SMSActivateRentActivation rentActivation)
                                                                  throws SMSActivateBaseException

Returns the list sms.

Parameters:

rentActivation - to get the list sms.

Returns:

list sms.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter type error:

• BAD_KEY - if your api-key is incorrect;
• NO_ID_RENT - if is not input.
• STATUS_WAIT_CODE - if not sms.
• STATUS_CANCEL - if rent is canceled.
• STATUS_FINISH - if rent is finished.

SMSActivateBaseException

setRentStatus

@NotNull
public @NotNull SMSActivateRentStatus setRentStatus(int rentId,
                                                              @NotNull
                                                              @NotNull SMSActivateClientRentStatus status)
                                                       throws SMSActivateBaseException

Sets the status on rent.

Parameters:

rentId - id activation for set status rent.

status - status rent.

Returns:

response status from server.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter type error:

• BAD_KEY - if your api-key is incorrect;
• NO_ID_RENT - if is not input.
• INCORRECT_STATUS - if status is incorrect.
• CANT_CANCEL - if it is impossible to cancel the rent (more than 20 min.).
• ALREADY_FINISH - if rent is finished.
• ALREADY_CANCEL - if rent is canceled.
• INVALID_PHONE - if id is incorrect.

SMSActivateBaseException

setRentStatus

@NotNull
public @NotNull SMSActivateRentStatus setRentStatus(SMSActivateRentActivation rentActivation,
                                                              @NotNull
                                                              @NotNull SMSActivateClientRentStatus status)
                                                       throws SMSActivateBaseException

Sets the status on rent.

Parameters:

rentActivation - rent to set status.

status - status rent.

Returns:

response status from server.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Wrong parameter type error:

• BAD_KEY - if your api-key is incorrect;
• NO_ID_RENT - if is not input.
• INCORRECT_STATUS - if status is incorrect.
• CANT_CANCEL - if it is impossible to cancel the rent (more than 20 min.).
• ALREADY_FINISH - if rent is finished.
• ALREADY_CANCEL - if rent is canceled.
• INVALID_PHONE - if id is incorrect.

SMSActivateBaseException

getRentList

@NotNull
public @NotNull SMSActivateGetRentListResponse getRentList()
                                                              throws SMSActivateBaseException

Returns the current rents.

Returns:

current rents.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

Types errors:

Base type error in this method:

• NO_NUMBERS - if no rented phone numbers numbers.

Wrong parameter type error:

• BAD_KEY - if your api-key is incorrect;

SMSActivateBaseException

waitSms

@Nullable
public @Nullable String waitSms(int activationId,
                                           int maxWaitMinutes)
                                    throws SMSActivateBaseException

Wait the sms on activation by minutes.

Parameters:

activationId - activation id to get sms.

maxWaitMinutes - minutes to wait.

Returns:

code from sms.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

SMSActivateBaseException

waitSms

@Nullable
public @Nullable String waitSms(@NotNull
                                           @NotNull SMSActivateActivation activation,
                                           int maxWaitMinutes)
                                    throws SMSActivateBaseException

Wait the sms on activation by minutes.

Parameters:

activation - activation to get sms.

maxWaitMinutes - minutes to wait.

Returns:

code from sms.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

SMSActivateBaseException

waitSmsForRent

@NotNull
public @NotNull List<SMSActivateSMS> waitSmsForRent(@NotNull
                                                              @NotNull SMSActivateRentActivation rentActivation,
                                                              int maxWaitMinutes)
                                                       throws SMSActivateBaseException

Returns a list of sms that came for rent after a while.

Parameters:

rentActivation - rent for rent for which you need to return the list of sms.

maxWaitMinutes - how many minutes to wait.

Returns:

list of sms that came for rent.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

SMSActivateBaseException

waitSmsForRent

@NotNull
public @NotNull List<SMSActivateSMS> waitSmsForRent(int rentId,
                                                              int maxWaitMinutes)
                                                       throws SMSActivateBaseException

Returns a list of sms that came for rent after a while.

Parameters:

rentId - rent for rent for which you need to return the list of sms.

maxWaitMinutes - how many minutes to wait.

Returns:

list of sms that came for rent.

Throws:

SMSActivateWrongParameterException - if one of parameters is incorrect.

SMSActivateUnknownException - if error type not documented.

SMSActivateBaseException