Get SIP Registration Status voximplant.sip.status
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 the Manage Numbers — Edit access permission
The method voximplant.sip.status returns the current SIP registration status for the cloud PBX.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
REG_ID* |
Identifier of the SIP registration. The identifier can be obtained using the voximplant.sip.get method. |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"REG_ID":150907}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/voximplant.sip.status
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"REG_ID":150907,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/voximplant.sip.status
// 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 the payload returned in result (match the "response handling" section of the page)
type SipStatusResult = {
REG_ID: number
LAST_UPDATED: string
ERROR_MESSAGE: string
STATUS_CODE: number
STATUS_RESULT: 'success' | 'error' | 'in_progress' | 'wait'
}
try {
const response = await $b24.actions.v2.call.make<SipStatusResult>({
method: 'voximplant.sip.status',
params: {
REG_ID: 150907,
},
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(result.STATUS_RESULT, result.STATUS_CODE, result.ERROR_MESSAGE)
}
} 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 getSipStatus() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'voximplant.sip.status',
params: {
REG_ID: 150907,
},
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(result.STATUS_RESULT, result.STATUS_CODE, result.ERROR_MESSAGE)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getSipStatus)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.voximplant.sip.status(
reg_id=150907,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'voximplant.sip.status',
[
'REG_ID' => 150907
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'voximplant.sip.status',
{
REG_ID: 150907
},
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.sip.status',
[
'REG_ID' => 150907
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "voximplant.sip.status", b24.Params{
"REG_ID": 150907,
})
if err != nil {
return fmt.Errorf("voximplant.sip.status: %w", err)
}
var item struct {
RegID b24.ID `json:"REG_ID"`
LastUpdated string `json:"LAST_UPDATED"`
ErrorMessage string `json:"ERROR_MESSAGE"`
StatusCode int `json:"STATUS_CODE"`
StatusResult string `json:"STATUS_RESULT"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.RegID, item.LastUpdated)
Response Handling
HTTP Status: 200
{
"result": {
"REG_ID": 150907,
"LAST_UPDATED": "2026-03-12 09:10:51",
"ERROR_MESSAGE": "",
"STATUS_CODE": 200,
"STATUS_RESULT": "success"
},
"time": {
"start": 1773323644,
"finish": 1773323644.70319,
"duration": 0.7031900882720947,
"processing": 0,
"date_start": "2026-03-12T16:54:04+01:00",
"date_finish": "2026-03-12T16:54:04+01:00",
"operating_reset_at": 1773324244,
"operating": 0.15053892135620117
}
}
Returned Data
|
Name |
Description |
|
result |
Object containing the SIP registration status |
|
REG_ID |
Identifier of the SIP registration |
|
LAST_UPDATED |
Date and time of the last update of the SIP registration status |
|
ERROR_MESSAGE |
Text description of the registration error |
|
STATUS_CODE |
Numeric code of the registration status or error |
|
STATUS_RESULT |
Result of the registration. Possible values:
|
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400, 403
{
"error": "REG_ID_NOT_FOUND",
"error_description": "Settings not found"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
|
SIP registration with the specified |
|
|
|
Insufficient permissions to retrieve the SIP registration status |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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 |