#Средства коммуникации узла

GET /v1/humanresources/nodes/:id/communications

Возвращает средства коммуникации, привязанные к узлу организационной структуры: чаты, каналы и совместные пространства.

#Параметры

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

#Примеры

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

Terminal 
curl -H "X-Api-Key: YOUR_API_KEY" \
  https://vibecode.bitrix24.tech/v1/humanresources/nodes/23/communications

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

Terminal 
curl -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  https://vibecode.bitrix24.tech/v1/humanresources/nodes/23/communications

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

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/humanresources/nodes/23/communications',
  { headers: { 'X-Api-Key': 'YOUR_API_KEY' } }
)
const body = await res.json()
console.log(body.data.chats)

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

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/humanresources/nodes/23/communications',
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  }
)
const body = await res.json()

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.chats array Привязанные к узлу чаты
data.channels array Привязанные к узлу каналы (структура элемента совпадает с chats)
data.collabs array Привязанные к узлу совместные пространства (структура элемента совпадает с chats)
data.chats[].id number Идентификатор средства коммуникации
data.chats[].dialogId string Идентификатор диалога средства
data.chats[].title string Название
data.chats[].subtitle string Подзаголовок
data.chats[].avatar string Адрес изображения. Пустая строка, если изображение не задано
data.chats[].color string Цвет в формате HEX
data.chats[].type string Тип средства: CHAT, CHANNEL или COLLAB
data.chats[].isExtranet boolean Признак средства из экстранета
data.chats[].originalNodeId number | null Узел, из которого унаследована привязка. null, если привязка задана напрямую
data.chats[].hasAccess boolean Есть ли у текущего пользователя доступ к средству
data.chatsNoAccess number Количество привязанных чатов, к которым у текущего пользователя нет доступа
data.channelsNoAccess number Количество привязанных каналов, к которым у текущего пользователя нет доступа
data.collabsNoAccess number Количество привязанных совместных пространств, к которым у текущего пользователя нет доступа

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

JSON 
{
  "success": true,
  "data": {
    "chats": [
      {
        "id": 3645,
        "dialogId": "chat3645",
        "title": "Отдел продаж",
        "subtitle": "Закрытый чат",
        "avatar": "",
        "color": "#f76187",
        "type": "CHAT",
        "isExtranet": false,
        "originalNodeId": null,
        "hasAccess": true
      }
    ],
    "channels": [],
    "collabs": [],
    "chatsNoAccess": 0,
    "channelsNoAccess": 0,
    "collabsNoAccess": 0
  }
}

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

400 — некорректный идентификатор узла в пути:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "id must be a positive integer"
  }
}

#Ошибки

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

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

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