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

DELETE /api/resellers/removeNumber

Удалить номер телефона с сервера Onlinesim

Этот запрос позволяет удалять конкретные номера из списка Ваших текущих номеров. Обратите внимание, что в запросе обязательно необходимо передать либо номер в международном формате, либо его ID, указанный при добавлении. Передача обоих параметров одновременно не допускается.

Вы можете использовать этот запрос вместо sendNumbersOnline для изменения списка номеров, удаляя некоторые ранее переданные номера из списка.

Параметры

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

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

idinteger

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

teststring

Опциональное поле для тела запросов Reseller API v2. Может принимать одно из двух значений: test1 или test2.

Будучи равным test1 отправит запрос на сервер, но данные, переданные таким запросом не будут сохранены нашим сервером (не вызовет исполнения функции).

Если параметр будет равен test2, то сервер Onlinesim в ответе вернет тело Вашего запроса.

Может передаваться как query-параметр (для GET) или как поле в теле запроса (для POST). Оба способа эквивалентны, но одновременно использовать их не рекомендуется.

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

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

Ответы

200

Ответ сервера Onlinesim

Content-Typeapplication/json
Схема
Responseobject
responseoneOf

1, если запрос был выполнен успешно, либо выведет сообщение об ошибке

Одно из
[0]string
[1]integer

Примеры

Example response from Onlinesim server when number was successfuly removed from the list
{
  "response": "1"
}
Example response from Onlinesim server when trying to remove a number that was not found on the list (either it wasn't added previously or it was already removed)
{
  "response": "0"
}
Incorrect key passed
[
  {
    "response": "ERROR_WRONG_KEY"
  }
]
400

Отсутствуют или неверно указаны параметры (запрос должен содержать параметры в теле с правильными именами, как описано в документации)

Content-Typeapplication/json
Схема
Responseobject
responsestringОбязательный
Перечисление:ERROR_PARAMS
messagestringОбязательный
401

Не авторизован. В запросе отсутствует или использован некорректный API-ключ. Некоторые эндпоинты могут возвращать статус 200 с сообщением ERROR_WRONG_KEY вместо 401 — проверяйте тело ответа

Content-Typetext/plain
Схема
Responsestring
Перечисление:Unauthorized
403

Доступ запрещен. Запрос был понят сервером, но отклонён из-за недостаточных прав доступа

Content-Typeapplication/json
Схема
Responseobject
errorobjectОбязательный
statusinteger

HTTP код ответа в текстовом формате

codestring
messagestring

Возможные коды ошибок: - ERROR_DISABLED - аккаунт партнера не активирован - ERROR_IP - IP адрес не находится в списке разрешенных - allowlist (см. <поле > ) - ERROR_RENT - аккаунт не имеет доступа к аренде

Перечисление:ERROR_DISABLEDERROR_IPERROR_RENT
messagestringОбязательный
Перечисление:ERROR_DISABLEDERROR_IPERROR_RENT
detailsobject[]Обязательный
itemsobject

Примеры кода

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