Получить статус SIP-регистрации voximplant.sip.status

Scope: telephony

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

Метод voximplant.sip.status возвращает текущий статус SIP-регистрации для облачной АТС.

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

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

Название
тип

Описание

REG_ID*
integer

Идентификатор SIP-регистрации.

Идентификатор можно получить с помощью метода voximplant.sip.get

Примеры кода

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

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
        
try
        {
            const response = await $b24.callMethod(
                'voximplant.sip.status',
                {
                    REG_ID: 150907
                }
            );
            
            const result = response.getData().result;
            console.log('Data:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('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>';

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

HTTP-статус: 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+03:00",
                "date_finish": "2026-03-12T16:54:04+03:00",
                "operating_reset_at": 1773324244,
                "operating": 0.15053892135620117
            }
        }

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

Название
тип

Описание

result
object

Объект со статусом SIP-регистрации

REG_ID
integer

Идентификатор SIP-регистрации

LAST_UPDATED
string

Дата и время последнего обновления статуса SIP-регистрации

ERROR_MESSAGE
string

Текстовое описание ошибки регистрации

STATUS_CODE
integer

Числовой код состояния или ошибки регистрации

STATUS_RESULT
string

Результат регистрации.

Возможные значения:

  • success — SIP-регистрация успешно выполнена
  • error — при SIP-регистрации произошла ошибка
  • in_progress — SIP-регистрация выполняется в данный момент
  • wait — SIP-регистрация ожидает запуска

time
time

Информация о времени выполнения запроса

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

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

{
            "error": "REG_ID_NOT_FOUND",
            "error_description": "Настройки не найдены"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

Значение

REG_ID_NOT_FOUND

Настройки не найдены

SIP-регистрация с указанным REG_ID не найдена

ACCESS_DENIED

Access denied!

Недостаточно прав для получения статуса SIP-регистрации

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

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-подключение
Следующая
Удалить SIP-подключение