Для AI-агентов: markdown этой страницы — /docs-content/humanresources/node-operations/communications-get.md индекс документации — /llms.txt

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

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

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

Общий параметр filter этим эндпоинтом не применяется. По умолчанию API сохраняет прежний ответ HTTP 200 и прежние данные, добавляет заголовок Warning: 299 - "filter is not supported on this endpoint and was ignored", а сервер фиксирует использование неподдерживаемого фильтра в журнале.

Параметры

Параметр Тип Обяз. Описание
Параметр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 Код Описание
HTTP200 КодWarning: 299 ОписаниеФильтр игнорируется по умолчанию; прежние данные сохраняются, предупреждение передаётся заголовком Warning.
HTTP400 только при включённом строгом режиме КодUNSUPPORTED_FILTER ОписаниеСерверный режим выключен по умолчанию; до его включения эндпоинт сохраняет HTTP 200 и прежние данные.
HTTP400 КодINVALID_PARAMS ОписаниеИдентификатор узла в пути не является положительным целым числом
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа humanresources
HTTP401 КодTOKEN_MISSING ОписаниеУ API-ключа не настроены токены Битрикс24

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

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