v2

Удалить номер

DELETEhttps://{ourserver.com}/api/resellers/removeNumber

Удаляет один из Ваших номеров, добавленных через этот API, по номеру телефона или по ID. Вы можете использовать его вместо sendNumbersOnline, чтобы точечно изменять список.

Передайте number, id или оба: удаляется каждый номер, совпадающий с любым из них. Параметры можно также передать в теле запроса.

Запрос также подтверждает, что Ваш сервер работает.

Параметры

query3
НазваниеТипОписание
numberstring

Номер телефона с кодом страны (необязательный начальный + игнорируется). Обязателен, если не передан id.

idinteger

ID номера, полученный при его добавлении. Обязателен, если не передан number.

teststring

Тестовый режим. Его также можно передать в теле запроса.

  • test1 — запрос выполняется, и ответ приходит как обычно, но изменения в базе данных откатываются. Действия вне базы данных все равно происходят.
  • test2 — запрос не выполняется: ответ — отладочный дамп (HTML, HTTP 200) заголовков и тела запроса в том виде, в каком их получил наш сервер.

Запрос с любым непустым значением test не подтверждает, что Ваш сервер работает.

Перечисление:test1test2
header1
НазваниеТипОписание
Authorization*string

Смотрите подробнее тут

Ответы

2001, если номер удален, 0, если ничего не совпало
Content-Typeapplication/json
Схема
schemaobject
responsestringОбязательный
Перечисление:01Пример:1

Примеры

removed

Номер удален

{
  "response": "1"
}
notFound

Такого номера нет в Вашем списке (не добавлялся или уже удален)

{
  "response": "0"
}
400Не передан ни number, ни id
Content-Typeapplication/json
Схема
schemaobjectОтвет с ошибкой: response и message содержат один и тот же код ошибки.
responsestringОбязательный
Перечисление:ERROR_PARAMS
messagestringОбязательный
Пример:ERROR_PARAMS
401API-ключ не передан или не существует. Тело ответа — простой текст Unauthorized. Запрос с Accept: application/json вместо этого получает HTTP 200 с {"response":"ERROR_WRONG_KEY"}.
Content-Typetext/html
Схема
schemastring
Перечисление:Unauthorized.Пример:Unauthorized.
403Доступ запрещен: API-ключ действителен, но запрос отклонен. Коды ошибок:
  • ERROR_DISABLED — партнерский аккаунт не активирован;
  • ERROR_BANNED — партнерский аккаунт заблокирован;
  • ERROR_IP — запрос пришел с IP-адреса, которого нет в списке разрешенных для аккаунта;
  • ERROR_RENT — запрошен rent, но у аккаунта нет доступа к аренде (только addNumber).
Content-Typeapplication/json
Схема
schemaobject
responsestringОбязательный
Код ошибкиПеречисление:ERROR_DISABLEDERROR_BANNEDERROR_IPERROR_RENT
messagestringОбязательный
Тот же код ошибки

Примеры

ERROR_IP

Запрос с IP-адреса вне списка разрешенных

{
  "response": "ERROR_IP",
  "message": "ERROR_IP"
}

Примеры кода

Генерация примеров...