Activate User SIP Device voximplant.user.activatePhone
Scope:
telephonyWho can execute the method: user with User Settings — Modify access permission
The method voximplant.user.activatePhone sets a flag indicating the presence of a SIP device for an employee.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
USER_ID* |
User identifier. You can obtain the identifier 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}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/voximplant.user.activatePhone
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"USER_ID":1269,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/voximplant.user.activatePhone
try
{
const response = await $b24.callMethod(
'voximplant.user.activatePhone',
{
USER_ID: 1269
}
);
const result = response.getData().result;
console.log('Data:', result);
}
catch (error)
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'voximplant.user.activatePhone',
[
'USER_ID' => 1269,
]
);
$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.activatePhone',
{
USER_ID: 1269
},
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.activatePhone',
[
'USER_ID' => 1269,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": 1,
"time": {
"start": 1773666334,
"finish": 1773666335.198412,
"duration": 1.1984119415283203,
"processing": 1,
"date_start": "2026-03-16T16:05:34+01:00",
"date_finish": "2026-03-16T16:05:35+01:00",
"operating_reset_at": 1773666934,
"operating": 0.4791221618652344
}
}
Returned Data
|
Name |
Description |
|
result |
Result of the method execution.
|
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "",
"error_description": "Parameter USER_ID is not set"
}
|
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 |
|
— |
|
Insufficient permissions to activate the user's SIP device |
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 allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |