Настроить прокси облачного телефона

Справочник API

Настроить прокси облачного телефона

Request

Привязывает прокси к одному или нескольким облачным телефонам.

Предварительные условия: укажите хотя бы одно из ids или uniqueIds. Телефоны должны принадлежать вашей команде; включёнными им быть не обязательно. Если вы указываете proxyId, он должен существовать, иначе вызов отклоняется.
Эффект: если proxyId опущен или равен 0, повторно используется существующий прокси с полностью совпадающими данными подключения, а если совпадений нет, в вашей команде создаётся новая запись прокси. Состояние проверки прокси сбрасывается, а предыдущий прокси запоминается.
Завершение: синхронное. Включённые телефоны получают новый прокси немедленно — перезапуск не требуется; выключенные подхватят его при следующем запуске.
Повтор: повторная привязка существующего proxyId идемпотентна, но повторение вызова с «сырыми» данными подключения может каждый раз создавать ещё одну запись прокси, когда дедупликация не срабатывает.

Задокументированные бизнес-ошибки: 33300, 33303, 33320, 14023. Значения кодов см. в Error Codes. Любая операция может дополнительно вернуть общие коды.

Bodyapplication/jsonrequired

idsArray of strings

Список идентификаторов окружений облачных телефонов

Example:

[
  "1558968155668507"
]

uniqueIdsArray of integers

Список отображаемых порядковых номеров окружений облачных телефонов (используется для сопоставления, если envIds не переданы)

Example:

[
  1001
]

proxyobject(CloudPhoneProxyDto)

Настройки прокси

curl -i -X POST \
  http://127.0.0.1:40000/api/cloudphone/setProxy \
  -H 'Content-Type: application/json' \
  -d '{
    "ids": [
      "1558968155668507"
    ],
    "uniqueIds": [
      1001
    ],
    "proxy": {
      "proxyIp": "192.168.1.100",
      "proxyPort": 8080,
      "proxyProvider": 2
    }
  }'

Responses

Успех. data для этой операции всегда null; результат передаётся через code.

Bodyapplication/json

codeinteger

Код ответа: 0 = успех, >0 = ошибка

datanull

msgstring or null

Сообщение; заполняется при code > 0

requestIdstring

Уникальный идентификатор запроса; укажите его при обращении в поддержку

Response

{
  "code": 0,
  "data": null,
  "msg": null,
  "requestId": "0d8b6f1c-9f4e-4d02-9d1a-7c3f5a1b2c3d"
}