При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Получить список коллег текущего пользователя im.department.colleagues.list», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

Получить список коллег текущего пользователя im.department.colleagues.list

Тут может не хватать некоторых данных — дополним в ближайшее время

• нужны правки под стандарт написания
• не указаны типы параметров
• отсутствуют примеры
• отсутствует ответ в случае ошибки

> Scope: im
>
> Кто может выполнять метод: любой пользователь

Метод im.department.colleagues.list получает список коллег текущего пользователя. Для руководителя метод вернет список подчиненных и всех руководителей.

• Если передан параметр USER_DATA = Y, то в ответе вместо массива идентификаторов будет передан массив объектов с информацией о пользователе.
• Метод поддерживает стандартную постраничную навигацию Bitrix24 Rest Api, но в добавок к ней есть возможность построить навигацию с помощью параметров OFFSET и LIMIT.

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

• JS

    // callListMethod рекомендуется использовать, когда необходимо получить весь набор списочных данных и объём записей относительно невелик (до примерно 1000 элементов). Метод загружает все данные сразу, что может привести к высокой нагрузке на память при работе с большими объемами.
    
    try {
      const response = await $b24.callListMethod(
        'im.department.colleagues.list',
        { USER_DATA: 'Y' },
        (progress) => { console.log('Progress:', progress) }
      )
      const items = response.getData() || []
      for (const entity of items) { console.log('Entity:', entity) }
    } catch (error) {
      console.error('Request failed', error)
    }
    
    // fetchListMethod предпочтителен при работе с крупными наборами данных. Метод реализует итеративную выборку с использованием генератора, что позволяет обрабатывать данные по частям и эффективно использовать память.
    
    try {
      const generator = $b24.fetchListMethod('im.department.colleagues.list', { USER_DATA: 'Y' }, 'ID')
      for await (const page of generator) {
        for (const entity of page) { console.log('Entity:', entity) }
      }
    } catch (error) {
      console.error('Request failed', error)
    }
    
    // callMethod предоставляет ручной контроль над процессом постраничного получения данных через параметр start. Подходит для сценариев, где требуется точное управление пакетами запросов. Однако при больших объемах данных может быть менее эффективным по сравнению с fetchListMethod.
    
    try {
      const response = await $b24.callMethod('im.department.colleagues.list', { USER_DATA: 'Y' }, 0)
      const result = response.getData().result || []
      for (const entity of result) { console.log('Entity:', entity) }
    } catch (error) {
      console.error('Request failed', error)
    }

• PHP

    try {
        $response = $b24Service
            ->core
            ->call(
                'im.department.colleagues.list',
                [
                    'USER_DATA' => 'Y'
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'users: ' . print_r($result->data(), true);
        echo 'total: ' . $result->total();
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error fetching colleagues list: ' . $e->getMessage();
    }

• BX24.js

    BX24.callMethod(
        'im.department.colleagues.list',
        {
            USER_DATA: 'Y'
        },
        function(result){
            if(result.error())
            {
                console.error(result.error().ex);
            }
            else
            {
                console.log('users', result.data());
                console.log('total', result.total());
            }
        }
    );

• PHP CRest

    $result = restCommand(
        'im.department.colleagues.list',
        Array(
            'USER_DATA' => 'Y'
        ),
        $_REQUEST[
            "auth"
        ]
    );    

• cURL

// пример для cURL

Ответ в случае успеха

При опции USER_DATA = N:

{
    "result": [1],
    "total": 1
}    

При опции USER_DATA = Y:

{    
    "result": [
        {
            "id": 1,
            "name": "Евгений Шеленков",
            "first_name": "Евгений",
            "last_name": "Шеленков",
            "work_position": "",
            "color": "#df532d",
            "avatar": "http://192.168.2.232/upload/resize_cache/main/1d3/100_100_2/shelenkov.png",
            "gender": "M",
            "birthday": "",
            "extranet": false,
            "network": false,
            "bot": false,
            "connector": false,
            "external_auth_id": "default",
            "status": "online",
            "idle": false,
            "last_activity_date": "2018-01-29T17:35:31+03:00",
            "desktop_last_date": false,
            "mobile_last_date": false,
            "departments": [
             50
            ],
            "absent": false,
            "phones": {
             "work_phone": "",
             "personal_mobile": "",
             "personal_phone": ""
            }
        }
    ],
    "total": 1
}    

Описание ключей

• id – идентификатор пользователя
• name – имя и фамилия пользователя
• first_name – имя пользователя
• last_name – фамилия пользователя
• work_position – должность
• color – цвет пользователя в формате hex
• avatar – ссылка на аватар (если пусто, значит аватар не задан)
• gender – пол пользователя
• birthday – день рождения пользователя в формате DD-MM, если пусто – не задан
• extranet – признак внешнего экстранет-пользователя (true/false)
• network – признак пользователя Битрикс24.Network (true/false)
• bot – признак бота (true/false)
• connector – признак пользователя открытых линий (true/false)
• external_auth_id – код внешней авторизации
• status – статус пользователя. Всегда отображается как online, даже если пользователь установил статус «Не беспокоить». Статус «Не беспокоить» влияет только на получение уведомлений и не виден другим пользователям
• idle – дата, когда пользователь отошел от компьютера, в формате АТОМ (если не задано, false)
• last_activity_date – дата последнего действия пользователя в формате АТОМ
• desktop_last_date – дата последнего действия в десктопном приложении в формате АТОМ (если не задано, false)
• mobile_last_date – дата последнего действия в мобильном приложении в формате АТОМ (если не задано, false)
• absent – дата, по какое число у пользователя отпуск, в формате АТОМ (если не задано, false)
• phones – массив номеров телефонов: work_phone – рабочий телефон, personal_mobile – мобильный телефон, personal_phone – домашний телефон