Remove several numbers
DELETEhttps://{ourserver.com}/api/resellers/removeNumbers
Removes several of your numbers added through this API, by phone number and/or by ID. Every number that
matches any value of ids or numbers is removed.
The request also confirms that your server is up.
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 |
Request Body
Content-Type
application/jsonSchema
schemaobjectAt least one of ids and numbers must be non-empty. A single value instead of an array is accepted.
idsinteger[]IDs of the numbers
numbersstring[]Phone numbers with the country code (an optional leading + is ignored)
Examples
byNumbersAndIds
Two numbers by phone number and one by ID
{
"numbers": [
"+4695000051",
"+4695000052"
],
"ids": [
110251
]
}Responses
2001 if at least one number was removed, 0 if nothing matched
Content-Type
application/jsonSchema
schemaobject
responsestringRequired
Enum:01Example:1Examples
removed
Numbers are removed
{
"response": "1"
}notFound
None of the numbers is on your list
{
"response": "0"
}400Both ids and numbers are missing or empty
Content-Type
application/jsonSchema
schemaobjectError answer: response and message hold the same error code.
responsestringRequired
Enum:ERROR_PARAMSmessagestringRequired
Example:ERROR_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.
Content-Type
text/htmlSchema
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).
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-Type
application/jsonSchema
schemaobject
responsestringRequired
Error codeEnum:ERROR_DISABLEDERROR_BANNEDERROR_IPERROR_RENTmessagestringRequired
The same error codeExamples
ERROR_IP
Request from an IP address outside the allowlist
{
"response": "ERROR_IP",
"message": "ERROR_IP"
}Code Samples
Generating examples...