v2

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
NameTypeDescription
suminteger

Income threshold in RUB, an integer (a fractional part is dropped). Numbers with income greater than this value are returned: with sum = 37, a number that earned 37.00 RUB is not returned, one that earned 37.50 RUB is.

Pass a negative value (for example -1) to get all your numbers.

Default:50
teststring

Test mode. It can also be passed in the request body.

  • test1 — the request is executed and answered as usual, but its database changes are rolled back. Effects outside the database still happen.
  • test2 — the request is not executed: the answer is a debug dump (HTML, HTTP 200) of the request headers and body as our server received them.

A request with any non-empty test value does not confirm that your server is up.

Enum:test1test2
header1
NameTypeDescription
Authorization*string

see more here

Responses

200Numbers whose income is greater than sum
Content-Typeapplication/json
Schema
schemaobject
responsestringRequired
Enum:1Example:1
listobject[]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.
Content-Typetext/html
Schema
schemastring
Enum:Unauthorized.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).
Content-Typeapplication/json
Schema
schemaobject
responsestringRequired
Error codeEnum:ERROR_DISABLEDERROR_BANNEDERROR_IPERROR_RENT
messagestringRequired
The same error code

Examples

ERROR_IP

Request from an IP address outside the allowlist

{
  "response": "ERROR_IP",
  "message": "ERROR_IP"
}

Code Samples

Generating examples...