GET_NUMBER - number request

This request gets new operation on your service Create operation for 15 minutes

Example

axios.post(
  'http://__HUB__', 
  {action: "GET_NUMBER", country: "russia",operator: "any",service: "vk", sum: 40, key: "APIKEY"},
  {headers: {'Content-Type': 'application/json; charset=utf-8'}}
)

Request example with exceptionPhoneSet:

axios.post(
  'http://__HUB__', 
  {action: "GET_NUMBER", country: "russia",operator: "any",service: "vk", sum: 40, key: "APIKEY",  "exceptionPhoneSet": ["7918","79281"]},
  {headers: {'Content-Type': 'application/json; charset=utf-8'}}
)

Parameters

Parameter name Parameter Data type Description/Value
action required STRING GET_NUMBER
key required STRING API key
country required STRING Country name.
See countries list
service required STRING Service name.
See services list
operator required STRING Operator name.
See operators list
sum required INT Service price
exceptionPhoneSet optional ARRAY Prefixes list that should NOT be issued while number request. Format: country + part of a number(7937, 7917123)

Result

After successful execution of the request you will get the JSON format response like this:

json {"number": 79281234567, "activationId": 355, "status": "SUCCESS"} или json {"status": "NO_NUMBERS"}

Result Description/Value
status Request status SUCCESS or ERROR
number Number
activationId Operation ID

ERRORS

Result Description
NO_NUMBERS Numbers for this parameters are missing