#Настроить средства коммуникации

PATCH /v1/humanresources/nodes/:id/communications

Настраивает привязку средства коммуникации к узлу организационной структуры по его идентификатору. Тип средства задаётся полем communicationType.

#Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор узла. Список: GET /v1/humanresources/nodes?type=DEPARTMENT

#Поля запроса (body)

Поле Тип Обяз. Описание
communicationType string да Тип средства коммуникации. Допустимые значения: CHAT, CHANNEL, COLLAB
ids number[] нет Идентификаторы существующих средств для привязки к узлу
removeIds number[] нет Идентификаторы привязанных средств для отвязки от узла
createDefault boolean нет Создать и привязать новое средство выбранного типа. По умолчанию false
withChildren boolean нет Применить изменение и к дочерним узлам. По умолчанию false

#Примеры

#curl — личный ключ

Terminal 
curl -X PATCH -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"communicationType": "CHAT"}' \
  https://vibecode.bitrix24.tech/v1/humanresources/nodes/23/communications

#curl — OAuth-приложение

Terminal 
curl -X PATCH -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"communicationType": "CHAT"}' \
  https://vibecode.bitrix24.tech/v1/humanresources/nodes/23/communications

#JavaScript — личный ключ

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/humanresources/nodes/23/communications',
  {
    method: 'PATCH',
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ communicationType: 'CHAT' }),
  }
)
const body = await res.json()
console.log(body.success)

#JavaScript — OAuth-приложение

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/humanresources/nodes/23/communications',
  {
    method: 'PATCH',
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ communicationType: 'CHAT' }),
  }
)
const body = await res.json()

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успешной обработке запроса
data.success boolean Признак применения настройки на стороне Битрикс24

#Пример ответа

JSON 
{
  "success": true,
  "data": {
    "success": true
  }
}

#Пример ответа при ошибке

400 — не передано обязательное поле communicationType:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Ошибка при валидации объекта запроса",
    "validation": [
      {
        "field": "MISSING_COMMUNICATIONTYPE",
        "message": "Parameter \"communicationType\" is required."
      }
    ]
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_PARAMS Не передано поле communicationType — в error.validation приходит MISSING_COMMUNICATIONTYPE
400 INVALID_PARAMS Передано недопустимое значение communicationType — в error.validation приходит INVALID_COMMUNICATIONTYPE с перечнем допустимых значений
400 INVALID_PARAMS Идентификатор узла в пути не является положительным целым числом
403 SCOPE_DENIED Ключу не хватает скоупа humanresources
401 TOKEN_MISSING У API-ключа не настроены токены Битрикс24

Полный список общих ошибок API — Ошибки.

#Известные особенности

Привязка, отвязка и создание комбинируются в одном запросе. ids, removeIds и createDefault можно передать вместе — одним вызовом привязать одни средства, отвязать другие и создать новое. withChildren распространяет изменение на дочерние узлы.

#Смотрите также