Получить настройки пользователей voximplant.user.get

Scope: telephony

Кто может выполнять метод: пользователь с правом Настройки пользователя — Изменение

Метод voximplant.user.get возвращает настройки пользователей.

Для приложений вызов метода требует подтверждения администратора.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

USER_ID*
integer/array

Идентификатор пользователя или массив идентификаторов пользователей.

Получить идентификатор можно методом user.get

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"USER_ID":[1269, 1271]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/voximplant.user.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"USER_ID":[1269, 1271],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/voximplant.user.get

try
        {
            const response = await $b24.callMethod(
                'voximplant.user.get',
                {
                    USER_ID: [1269, 1271]
                }
            );
        
            const result = response.getData().result;
            console.log('Data:', result);
        }
        catch (error)
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'voximplant.user.get',
                    [
                        'USER_ID' => [1269, 1271],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'voximplant.user.get',
            {
                USER_ID: [1269, 1271]
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error(), result.error_description());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'voximplant.user.get',
            [
                'USER_ID' => [1269, 1271],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": [
                {
                "ID": "1269",
                "DEFAULT_LINE": null,
                "PHONE_ENABLED": "Y",
                "SIP_SERVER": "ip.b24-6059-1584795982.bitrixphone.com",
                "SIP_LOGIN": "phone1269",
                "SIP_PASSWORD": "28fec473a88a",
                "INNER_NUMBER": null
                },
                {
                "ID": "1271",
                "DEFAULT_LINE": null,
                "PHONE_ENABLED": "Y",
                "SIP_SERVER": "ip.b24-6059-158475982.bitrixphone.com",
                "SIP_LOGIN": "phone1271",
                "SIP_PASSWORD": null,
                "INNER_NUMBER": null
                }
            ],
            "time": {
                "start": 1773667386,
                "finish": 1773667386.23801,
                "duration": 0.23800992965698242,
                "processing": 0,
                "date_start": "2026-03-16T16:23:06+03:00",
                "date_finish": "2026-03-16T16:23:06+03:00",
                "operating_reset_at": 1773667986,
                "operating": 0
            }
        }

Возвращаемые данные

Название `тип`	Описание
result `object`	Массив настроек пользователей
ID `string`	Идентификатор пользователя
DEFAULT_LINE `string`	Номер исходящей линии по умолчанию
PHONE_ENABLED `string`	Признак наличия SIP-аппарата. Возможные значения: `Y` — SIP-аппарат у пользователя активирован `N` — SIP-аппарат у пользователя не активирован
SIP_SERVER `string`	Адрес сервера для подключения SIP-аппарата
SIP_LOGIN `string`	Логин для подключения SIP-аппарата
SIP_PASSWORD `string`	Пароль для подключения SIP-аппарата
INNER_NUMBER `string`	Внутренний номер пользователя
time `time`	Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400, 401, 403

{
            "error": "METHOD_CONFIRM_WAITING",
            "error_description": "Waiting for confirmation"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание	Значение
—	`Parameter USER_ID is not set`	Не указан обязательный параметр `USER_ID`
`METHOD_CONFIRM_WAITING`	`Waiting for confirmation`	Ожидается подтверждение администратора портала на вызов метода
`METHOD_CONFIRM_DENIED`	`Method call denied`	Администратор запретил вызов метода для текущего токена
`ACCESS_DENIED`	`Access denied! You have no permission to query selected users`	Недостаточно прав для получения настроек пользователей

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Обзор методов

Активировать SIP-аппарат

Получить настройки пользователей voximplant.user.get

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение