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

DELETE /api/resellers/removeNumbers

Удалить несколько номеров телефонов из текущего списка

Этот запрос позволяет массово удалять конкретные номера из списка Ваших текущих номеров.

Параметры

header1
НазваниеТипОписание
Authorization*string

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

query1
НазваниеТипОписание
teststring

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

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

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

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

Перечисление:test1test2

Тело запроса

Content-Typeapplication/json
Схема
Bodyobject
idsstring[]
itemsstring

ID номера

numbersstring[]
itemsstring

Номер телефона в международном формате (со знаком +)

Одно из
[0]object
[1]object

Ответы

200

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

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

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

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

Примеры

Example response from Onlinesim server when numbers were successfuly removed from the list
{
  "response": "1"
}
Example response from Onlinesim server when no numbers were removed from the list (e.g. because they were previously deleted ornot found on the account)
{
  "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 (см. <поле 0="code" 1="{}" 2="Access from IP"> ) - ERROR_RENT - аккаунт не имеет доступа к аренде

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

Примеры кода

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