Get the numbers whose income is above a sum
GEThttps://{ourserver.com}/api/resellers/takeOffNumbers
Optional request. It returns your numbers whose income is greater than sum, so you can quickly see
which numbers have earned enough and can be replaced with new ones. The same data is on your personal
page.
All your numbers are checked, including those connected through equipment. This request does not confirm that your server is up.
Parameters
query2
| Name | Type | Description |
|---|---|---|
sum | integer | Income threshold in RUB, an integer (a fractional part is dropped). Numbers with income
greater than this value are returned: with Pass a negative value (for example Default: 50 |
test | string | Test mode. It can also be passed in the request body.
A request with any non-empty Enum: test1test2 |
header1
| Name | Type | Description |
|---|---|---|
Authorization* | string | see more here |
Responses
200Numbers whose income is greater than sum
application/jsonschemaobject
1Example:1listobject[]Required
Examples
twoNumbers17 lines
Two numbers above the threshold
{
"response": "1",
"list": [
{
"id": "40516575",
"number": "2203830000",
"sum": "75.76",
"country": "220"
},
{
"id": "40516576",
"number": "2203830001",
"sum": "58.76",
"country": "220"
}
]
}401No API key, or the key does not exist. The body is the plain text Unauthorized.
A request with Accept: application/json gets HTTP 200 with {"response":"ERROR_WRONG_KEY"} instead.
text/htmlUnauthorized.Example:Unauthorized.403Forbidden: the API key is valid, but the request is refused. Error codes:
ERROR_DISABLED — the partner account is not activated;
ERROR_BANNED — the partner account is blocked;
ERROR_IP — the request comes from an IP address that is not in the account's allowlist;
ERROR_RENT — rent is requested, but the account has no rent access (addNumber only).
ERROR_DISABLED — the partner account is not activated;ERROR_BANNED — the partner account is blocked;ERROR_IP — the request comes from an IP address that is not in the account's allowlist;ERROR_RENT — rent is requested, but the account has no rent access (addNumber only).application/jsonschemaobject
ERROR_DISABLEDERROR_BANNEDERROR_IPERROR_RENTExamples
Request from an IP address outside the allowlist
{
"response": "ERROR_IP",
"message": "ERROR_IP"
}