gethttps://{ourserver.com}/api/resellers/takeOffNumbers

GET /api/resellers/takeOffNumbers

Get information about numbers income

This request is optional, and you can skip this part. It returns income information of your online numbers, this data is also available on your personal page. It returns a list of online numbers of the account which income is greater than the specified sum parameter value.

This request can be used to quickly obtain information on what online numbers has reached the desired income and can be replaced with new ones.

Parameters

query2

Name	Type	Description
`sum`	`string`	Filter income value, in rubles. For example: if sum = 37.5, the request will return a list of online numbers which income is equal to 37.5 RUB or more If 0 passed as a value, the server returns a list of all online numbers of the account. Default:`50`
`test`	`string`	Optional field for the request body of Reseller API v2. Allowed values are `test1`, `test2`. While being assigned, `test1` value will allow the request to be passed, however the data won't be saved by our server (the function will not be executed by this request). While being assigned, `test2` value will print out your request's payload in response. Can be passed as query parameter (for GET) or as a field in request's body (for POST). Both ways are equivalent, but using them simultaneously is not recommended. Enum:`test1test2`

header1

Name	Type	Description
`Authorization`*	`string`	see more here

Responses

200

Onlinesim server response

Content-Typeapplication/json

Schema

Responseobject

responseoneOf

1, if request was successful, otherwise error message will come up

One Of

[0]string

[1]integer

listobject[]

itemsobject

idstring

Number ID

numberstring

Phone number in international format

sumstring

Total income earned by this number

countrystring

Country code (according to countries list)

Examples

Example response of Onlinesim server for takeOffNumbers request17 lines

{
  "response": 1,
  "list": [
    {
      "id": "40516575",
      "number": "2203830000",
      "sum": "75.76",
      "country": "220"
    },
    {
      "id": "40516576",
      "number": "2203830001",
      "sum": "58.76",
      "country": "220"
    }
  ]
}

Incorrect key passed

[
  {
    "response": "ERROR_WRONG_KEY"
  }
]

401

Unauthorized. The request is missing or uses an invalid API key. Some endpoints may return a 200 status with an ERROR_WRONG_KEY message instead of 401 — check the response body

Content-Typetext/plain

Schema

Responsestring

Enum:Unauthorized

403

Forbidden. The request was understood but refused due to insufficient permissions

Content-Typeapplication/json

Schema

Responseobject

errorobjectRequired

statusinteger

HTTP response code in text format

codestring

messagestring

Possible error codes: - ERROR_DISABLED - partner account is not activated - ERROR_IP - IP address is not in the list of allowed addresses - allowlist (see Access from IP field) - ERROR_RENT - account has no access to rent

Enum:ERROR_DISABLEDERROR_IPERROR_RENT

messagestringRequired

Enum:ERROR_DISABLEDERROR_IPERROR_RENT

detailsobject[]Required

itemsobject

Code Samples

Generating examples...