Remove a number
DELETEhttps://{ourserver.com}/api/resellers/removeNumber
Removes one of your numbers added through this API, by phone number or by ID. You can use it instead of sendNumbersOnline to change the list precisely.
Pass number, id or both: every number that matches either of them is removed. The parameters can
also be passed in the request body.
The request also confirms that your server is up.
Parameters
query3
| Name | Type | Description |
|---|---|---|
number | string | Phone number with the country code (an optional leading |
id | integer | ID of the number returned when it was added. Required if |
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
2001 if a number was removed, 0 if nothing matched
application/jsonschemaobject
01Example:1Examples
The number is removed
{
"response": "1"
}No such number on your list (never added or already removed)
{
"response": "0"
}400Neither number nor id is passed
application/jsonschemaobjectError answer: response and message hold the same error code.
ERROR_PARAMSERROR_PARAMS401No 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"
}