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
| Name | Type | Description |
|---|---|---|
Authorization* | string | see more here |
query1
| Name | Type | Description |
|---|---|---|
test | string | Test mode. It can also be passed in the request body.
A request with any non-empty Enum: test1test2 |
Responses
200Uptime is confirmed
application/jsonschemaobject
1Example:1Examples
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.
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"
}