v2

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

Phone number with the country code (an optional leading + is ignored). Required if id is not passed.

idinteger

ID of the number returned when it was added. Required if number is not passed.

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
header1
NameTypeDescription
Authorization*string

see more here

Responses

2001 if a number was removed, 0 if nothing matched
Content-Typeapplication/json
Schema
schemaobject
responsestringRequired
Enum:01Example:1

Examples

removed

The number is removed

{
  "response": "1"
}
notFound

No such number on your list (never added or already removed)

{
  "response": "0"
}
400Neither number nor id is passed
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...