v2

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

Request Body

Content-Typeapplication/json
Schema
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-Typeapplication/json
Schema
schemaobject
responsestringRequired
Enum:01Example:1

Examples

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-Typeapplication/json
Schema
schemaobjectError answer: response and message hold the same error code.
responsestringRequired
Enum:ERROR_PARAMS
messagestringRequired
Example:ERROR_PARAMS
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...