API Document

NOTES

- API - that is a protocol between your software and our service.
- API is needed in order to automate the process of receiving SMS messages on your side.
- All requests (supported by POST and GET) must go to http://vps.sms3t.com/stubs/handler_api.php .
- Our API the same like sms-activate.org
- You can change your hosts to use it
- C:\Windows\System32\drivers\etc\
45.32.107.10 sms-activate.org
- ATTENTION! If you replace host, there will be an https protocol error. To avoid it, send requests without https using http
- In all queries, there must be an API key in the form of the parameter "api_key"

Request the number of available phones

http://vps.sms3t.com/stubs/handler_api.php?api_key=$api_key&action=getNumbersStatus&country=$country&operator=$operator

PARAMETERS

$api_key - API key
$country * - Country numbers (10: VietNam)
- * optional field. If not specified, then by default the quantity will be displayed in accordance with the setting in the left menu.
$operator * - Mobile operator numbers, you can specify several numbers separated by commas (available only for **):
- * optional field. If not specified, then by default the quantity will be displayed in accordance with the setting in the left menu.
- ** available for $country = 10

ANSWER

The response of the service will be in json format, example:


									{"vk_0":149,"ok_0":190,"wa_0":64,"vi_0":140,"tg_0":86,"wb_0":14,"go_0":146,"av_0":251,"av_1":156,"fb_0":58}

Where to the dash - the name of the service, after the designation whether to turn on call redirection. 0 - do not turn on. 1 - turn on. The numbers with redirection, we unfortunately do not provide yet

Balance inquiry

http://vps.sms3t.com/stubs/handler_api.php?api_key=$api_key&action=getBalance

PARAMETERS

$api_key - API key

ANSWER

ACCESS_BALANCE:'account balance'

POSSIBLE MISTAKES

BAD_KEY - Invalid API key
ERROR_SQL - SQL server error

Order number

http://vps.sms3t.com/stubs/handler_api.php?api_key=$api_key&action=getNumber&service=$service&operator=$operator&ref=$ref&country=$country&phoneException=$phoneException

PARAMETERS

$api_key - API key
$service - Ordering service
$phoneException * - Excluding prefixes for Russian numbers. Specify with commas. Recording format: country code and 3 to 6 digits of the mask (for example 7918,7900111). The default is the value set in the left menu.
- * optional parameter accepts 0(not perform , set by default), 1(perform)
$operator * - Mobile operator numbers, you can specify several numbers separated by commas (available only for **):
- * optional field. If not specified, then by default the quantity will be displayed in accordance with the setting in the left menu.
- ** available for $country = 10
$ref - Pass referral identifier.
$country - Country numbers (10: VietNam)

By getting the number through the API, you agree with the project rules

ANSWER

NO_NUMBERS - No numbers
NO_BALANCE - Balance ended
ACCESS_NUMBER:$id:$number , where ($id - id operations,$number - phone number)

POSSIBLE MISTAKES

BAD_ACTION - Incorrect action
BAD_SERVICE - Incorrect service name
BAD_KEY - Invalid API key
ERROR_SQL - SQL server error

Change of activation status

http://vps.sms3t.com/stubs/handler_api.php?api_key=$api_key&action=setStatus&status=$status&id=$id

PARAMETERS

$api_key - API key
$id - activationID
$forward * - Phone number to be redirected to
- * Mandatory only if the parameter forward = 1 was passed with getNumber.
$status * - Activation status

1	report the readiness of the number (SMS to the number sent)
3	request another code (free)
6	complete activation*
8	report the number used and cancel the activation

* complete activation (if the status was "code received" - marks successfully and finishes, if there was "preparation" - deletes and marks the error, if it was status "waiting for repetition" - translates activation into waiting for sms)

Simple logic of api chronology:


									Get the number using the getNumber method after this, the following actions are available:

									8 - Cancel the activation (if the number does not match you)

									1 - Notify that SMS has been sent (optional)

									To activation with status 1:

									8 - Cancel activation

									Immediately after receiving the code:

									3 - Request another SMS

									6 - Confirm SMS code and complete activation

									To activation with status 3:

									6 - Confirm SMS code and complete activation

ANSWER

ACCESS_READY - Number readiness confirmed
ACCESS_RETRY_GET - Waiting for a new sms
ACCESS_ACTIVATION - Service successfully activated
ACCESS_CANCEL - Activation canceled

POSSIBLE MISTAKES

ERROR_SQL - SQL server error
NO_ACTIVATION - Activation id does not exist
BAD_SERVICE - Incorrect service name
BAD_STATUS - Incorrect status
BAD_KEY - Invalid API key
BAD_ACTION - Incorrect action

Get activation status

http://vps.sms3t.com/stubs/handler_api.php?api_key=$api_key&action=getStatus&id=$id

PARAMETERS

$api_key - API key
$id - activationID

ANSWER

STATUS_WAIT_CODE - Waiting for sms
STATUS_WAIT_RETRY:'past, inappropriate code' - waiting for code clarification
STATUS_WAIT_RESEND - Waiting for re-sending SMS *
- * software should click send SMS again and change status to 6
STATUS_CANCEL - Activation canceled
STATUS_OK'activation code' - code received

POSSIBLE MISTAKES

NO_ACTIVATION - Activation id does not exist
ERROR_SQL - SQL server error
BAD_KEY - Invalid API key
BAD_ACTION - Incorrect action

Get current prices by country

http://vps.sms3t.com/stubs/handler_api.php?api_key=$api_key&action=getPrices&service=$service&country=$country

PARAMETERS

$api_key - API key
$service - Short name of the service (optional, by default all services)
$country - Country code name (Optional, defaults to all countries)

ANSWER

JSON - object in the format:

{"A country":{"Service":{"cost":Cost,"count":Quant}}}

List of countries and operators

Id	Name	Operators
10	Vietnam	any, mobifone, vietnamobile, viettel, vinaphone

List of services

Short name	Name