Get User Settings voximplant.user.get
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
telephonyWho can execute the method: user with User Settings — Modify access permission
The method voximplant.user.get returns user settings.
For applications, calling the method requires administrator confirmation.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
USER_ID* |
User ID or an array of user IDs. You can obtain the ID using the user.get method. |
Code Examples
How to Use Examples in Documentation
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>
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>';
Response Handling
HTTP Status: 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+01:00",
"date_finish": "2026-03-16T16:23:06+01:00",
"operating_reset_at": 1773667986,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Array of user settings |
|
ID |
User ID |
|
DEFAULT_LINE |
Default outgoing line number |
|
PHONE_ENABLED |
Indicator of SIP device availability. Possible values:
|
|
SIP_SERVER |
Address of the server for connecting the SIP device |
|
SIP_LOGIN |
Login for connecting the SIP device |
|
SIP_PASSWORD |
Password for connecting the SIP device |
|
INNER_NUMBER |
User's internal number |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400, 401, 403
{
"error": "METHOD_CONFIRM_WAITING",
"error_description": "Waiting for confirmation"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
Value |
|
— |
|
Required parameter |
|
|
|
Administrator confirmation is pending for the method call |
|
|
|
Administrator has denied the method call for the current token |
|
|
|
Insufficient permissions to retrieve user settings |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |