voximplant.user.get
Получить настройки пользователей
Описание
Метод voximplant.user.get возвращает настройки пользователей.
Для приложений вызов метода требует подтверждения администратора.
Параметры
USER_ID
integer | integer[]
обязательный
Идентификатор пользователя или массив идентификаторов пользователей.
Получить идентификатор можно методом user.get
Примеры запроса
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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each user settings entry returned in result[]
type VoximplantUserResult = {
ID: string
DEFAULT_LINE: string | null
PHONE_ENABLED: string
SIP_SERVER: string
SIP_LOGIN: string
SIP_PASSWORD: string | null
INNER_NUMBER: string | null
}
try {
const response = await $b24.actions.v2.call.make<VoximplantUserResult[]>({
method: 'voximplant.user.get',
params: {
USER_ID: [1269, 1271],
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('User settings count:', result.length, result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getUserSettings() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'voximplant.user.get',
params: {
USER_ID: [1269, 1271],
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('User settings count:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getUserSettings)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.voximplant.user.get(
user_id=[
1269,
1271,
],
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "voximplant.user.get", b24.Params{
"USER_ID": []int{1269, 1271},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("voximplant.user.get: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
PhoneEnabled string `json:"PHONE_ENABLED"`
SipServer string `json:"SIP_SERVER"`
SipLogin string `json:"SIP_LOGIN"`
SipPassword string `json:"SIP_PASSWORD"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.PhoneEnabled)
}
Ответ
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
{
"error": "METHOD_CONFIRM_WAITING",
"error_description": "Waiting for confirmation"
}
| Код | Описание | Значение |
|---|---|---|
— |
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 |
Недостаточно прав для получения настроек пользователей |

