v2

Confirm that your server is up

GEThttps://{ourserver.com}/api/resellers

Confirms that your server is up and does nothing else. POST to the same URL works the same way.

Instead of sending sendNumbersOnline every 5 minutes, you can send this request, without parameters, at the same interval. If your server has not confirmed uptime for more than 10 minutes, all numbers you added through this API are removed.

Other requests confirm uptime too: sendNumbersOnline, addNumber(s), removeNumber(s), checkNumber(s), addMessage(s). A request with the test parameter does not.

Parameters

header1
NameTypeDescription
Authorization*string

see more here

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

Responses

200Uptime is confirmed
Content-Typeapplication/json
Schema
schemaobject
responsestringRequired
Enum:1Example:1

Examples

success

Uptime is confirmed

{
  "response": "1"
}
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...