Hc_sip_error_messages - управление текстовыми описаниями ошибок SIP
Hc_sip_error_messages_clean
Команда возвращает дефолтные значения текстовых описаний для ошибок SIP
Аналог команды в CoCon:
domain/<DOMAIN>/sip/sip-error-messages/clean
Метод http запроса:
POST
Шаблон http запроса:
http://host:port/commands/sip-error-messages_clean
Код http ответа
200 – в случае успеха;
404 – в случае ошибки.
Xsd схема XML запроса/ответа:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="error.xsd"/>
<xs:include schemaLocation="ecm_common.xsd"/>
<!-- resultType-->
<xs:complexType name="resultType">
<xs:all>
<xs:element name="domain_options" type="domainCleanOutType" minOccurs="1"/>
</xs:all>
</xs:complexType>
<!-- in-->
<xs:element name="in">
<xs:complexType>
<xs:sequence>
<xs:element name="request">
<xs:complexType>
<xs:all>
<xs:element name="domain_options" type="domainCleanInType"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- out -->
<xs:element name="out">
<xs:complexType>
<xs:choice>
<xs:element name="result" type="resultType"/>
<xs:element name="error" type="errorType"/>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
CODE
Пример:
Запрос: http://192.168.1.21:9999/commands/sip_error_messages_clean
<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_sip_error_messages_clean.xsd">
<request>
<domain_options>
<system />
<domain name="biysk.local">
<option name="code_1"/>
<option name="external"/>
</domain>
</domain_options>
</request>
</in>
CODE
Ответ:
<?xml version="1.0"?>
<out
xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_sip_error_messages_clean.xsd">
<result>
<domain_options>
<system/>
<domain name="biysk.local">
<success option="code_1"/>
<success option="external"/>
</domain>
</domain_options>
</result>
</out>
CODE
Hc_sip_error_messages_info
Команда возвращает текстовые описания для SIP-cause
Аналог команды в CoCon:
domain/<DOMAIN>/sip/sip-error-messages/info
Метод http запроса:
POST
Шаблон http запроса:
http://host:port/commands/sip-error-messages_info
Код http ответа
200 – в случае успеха;
404 – в случае ошибки.
Xsd схема XML запроса/ответа:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:include schemaLocation="error.xsd"/>
<xs:include schemaLocation="ecm_common.xsd"/>
<xs:complexType name="sipErrorMessagesOptionsType">
<xs:complexContent>
<xs:extension base="baseOptionsType">
<xs:attribute name="code_0" type="xs:string" use="optional" />
<xs:attribute name="code_1" type="xs:string" use="optional" />
<xs:attribute name="code_2" type="xs:string" use="optional" />
<xs:attribute name="code_3" type="xs:string" use="optional" />
<xs:attribute name="code_4" type="xs:string" use="optional" />
<xs:attribute name="code_5" type="xs:string" use="optional" />
<xs:attribute name="code_6" type="xs:string" use="optional" />
<xs:attribute name="code_7" type="xs:string" use="optional" />
<xs:attribute name="code_8" type="xs:string" use="optional" />
<xs:attribute name="code_9" type="xs:string" use="optional" />
<xs:attribute name="code_10" type="xs:string" use="optional" />
<xs:attribute name="code_11" type="xs:string" use="optional" />
<xs:attribute name="code_12" type="xs:string" use="optional" />
<xs:attribute name="code_14" type="xs:string" use="optional" />
<xs:attribute name="code_15" type="xs:string" use="optional" />
<xs:attribute name="code_16" type="xs:string" use="optional" />
<xs:attribute name="network_not_configured" type="xs:string" use="optional" />
<xs:attribute name="alias_declaration_error" type="xs:string" use="optional" />
<xs:attribute name="invalid_alias_digits" type="xs:string" use="optional" />
<xs:attribute name="wrong_identifier" type="xs:string" use="optional" />
<xs:attribute name="bad_template" type="xs:string" use="optional" />
<xs:attribute name="name_is_busy" type="xs:string" use="optional" />
<xs:attribute name="unknown_password" type="xs:string" use="optional" />
<xs:attribute name="unknown_login" type="xs:string" use="optional" />
<xs:attribute name="no_ldap_connection" type="xs:string" use="optional" />
<xs:attribute name="execution_error" type="xs:string" use="optional" />
<xs:attribute name="licence_limit" type="xs:string" use="optional" />
<xs:attribute name="bad_value" type="xs:string" use="optional" />
<xs:attribute name="wrong_set" type="xs:string" use="optional" />
<xs:attribute name="cancelled" type="xs:string" use="optional" />
<xs:attribute name="error_length" type="xs:string" use="optional" />
<xs:attribute name="error_contact_already_declared" type="xs:string" use="optional" />
<xs:attribute name="error_channel_id_not_found" type="xs:string" use="optional" />
<xs:attribute name="external" type="xs:string" use="optional" />
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- resultType-->
<xs:complexType name="resultType">
<xs:all>
<xs:element name="domain_options" type="domainInfoOutType" minOccurs="1"/>
</xs:all>
</xs:complexType>
<!-- in-->
<xs:element name="in">
<xs:complexType>
<xs:sequence>
<xs:element name="request">
<xs:complexType>
<xs:all>
<xs:element name="domain_options" type="domainInfoInType" minOccurs="1"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- out -->
<xs:element name="out">
<xs:complexType>
<xs:choice>
<xs:element name="result" type="resultType"/>
<xs:element name="error" type="errorType"/>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
CODE
Пример:
Запрос: http://192.168.1.21:9999/commands/sip_error_messages_info
<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_sip_error_messages_info.xsd">
<request>
<domain_options domain="biysk.local" />
</request>
</in>
CODE
Ответ:
<?xml version="1.0"?>
<out
xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_sip_error_messages_info.xsd">
<result>
<domain_options>
<system>
<options xs:type="sipErrorMessagesOptionsType"/>
</system>
<domain name="biysk.local">
<options xs:type="sipErrorMessagesOptionsType" wrong_set="language:default,text:Wrong parameters to set;language:en,text:Wrong parameters to set;language:ru,text:Неверный набор параметров" wrong_identifier="language:default,text:Wrong identifier;language:en,text:Wrong identifier;language:ru,text:Неверный идентификатор" unknown_password="language:default,text:password must be specified for login;language:en,text:password must be specified for login;language:ru,text:Для входа требуется указать пароль" unknown_login="language:default,text:login must be specified before password;language:en,text:login must be specified before password;language:ru,text:Логин должен быть указан перед паролем" no_ldap_connection="language:default,text:No connection with LDAP server;language:en,text:No connection with LDAP server;language:ru,text:Нет соединения с LDAP сервером" network_not_configured="language:default,text:Network parameters (node_ip or share_set) must be configured before;language:en,text:Network parameters (node_ip or share_set) must be configured before;language:ru,text:" name_is_busy="language:default,text:Identifiers name is busy;language:en,text:Identifiers name is busy;language:ru,text:Идентификатор занят" licence_limit="language:default,text:Licence limit is exceeded!;language:en,text:Licence limit is exceeded!;language:ru,text:Превышение лицензионных ограничений" invalid_alias_digits="language:default,text:Invalid digits in alias number;language:en,text:Invalid digits in alias number;language:ru,text:" external="" execution_error="language:default,text:Unexpected execution error;language:en,text:Unexpected execution error;language:ru,text:Неожиданная ошибка выполнения" error_length="language:default,text:Different length of ranges;language:en,text:Different length of ranges;language:ru,text:Разная длина диапазонов" error_contact_already_declared="language:default,text:This contact already mapped;language:en,text:This contact already mapped;language:ru,text:Контакт уже сопоставлен" error_channel_id_not_found="language:default,text:This channel id not declared;language:en,text:This channel id not declared;language:ru,text:Идентификатор канала не объявлен" code_9="language:default,text:Wrong authentication;language:en,text:Wrong authentication;language:ru,text:Ошибка аутентификации" code_8="language:default,text:Resource limit;language:en,text:Resource limit;language:ru,text:Огрничение ресурсов" code_7="language:default,text:Request URI to disallowed address;language:en,text:Request URI to disallowed address;language:ru,text:" code_6="language:default,text:Public call isn't allowed;language:en,text:Public call isn't allowed;language:ru,text:Внешние вызовы запрещены" code_5="language:default,text:Internal error at process of registration;language:en,text:Internal error at process of registration;language:ru,text:Внутренняя ошибка регистрации" code_4="language:default,text:Request from disallowed IP;language:en,text:Request from disallowed IP;language:ru,text:Запрос с запрещенного IP" code_3="language:default,text:The registration domain is wrong or missed;language:en,text:The registration domain is wrong or missed;language:ru,text:Неверный домен регистрации" code_2="language:default,text:The user name is wrong or missed;language:en,text:The user name is wrong or missed;language:ru,text:Неверный логин" code_16="language:default,text:Wrong parameters set;language:en,text:Wrong parameters set;language:ru,text:Неправильный набор параметров" code_15="language:default,text:Anonymity Disallowed;language:en,text:Anonymity Disallowed;language:ru,text:" code_14="language:default,text:Interface is blocked;language:en,text:Interface is blocked;language:ru,text:Интерфейс заблокирован" code_12="language:default,text:Contacts list is empty;language:en,text:Contacts list is empty;language:ru,text:Пустой список контактов" code_11="language:default,text:Calls are disallowed;language:en,text:Calls are disallowed;language:ru,text:Вызовы запрещены" code_10="language:default,text:Third party registration is disallowed;language:en,text:Third party registration is disallowed;language:ru,text:" code_1="language:default,text:Unknown subscriber (User name or/and registration domain are wrong);language:en,text:Unknown subscriber (User name or/and registration domain are wrong);language:ru,text:Неизвестный подписчик (неверный логин и/или домен регистрации)" code_0="language:default,text:Internal system error;language:en,text:Internal system error;language:ru,text:Внутренняя ошибка системы" cancelled="language:default,text:Operation was cancelled;language:en,text:Operation was cancelled;language:ru,text:Операция отменена" bad_value="language:default,text:Wrong (unknown or unspecified) value;language:en,text:Wrong (unknown or unspecified) value;language:ru,text:Неверное/неизвестное значение" bad_template="language:default,text:Bad templates definition;language:en,text:Bad templates definition;language:ru,text:" alias_declaration_error="language:default,text:Aliases declaration error;language:en,text:Aliases declaration error;language:ru,text:"/>
</domain>
</domain_options>
</result>
</out>
CODE
Hc_sip_error_messages_set
Команда задает значения текстовых описаний для SIP-cause
Аналог команды в CoCon:
domain/<DOMAIN>/sip/sip-error-messages/set
Метод http запроса:
POST
Шаблон http запроса:
http://host:port/commands/sip_error_messages_set
Код http ответа
200 – в случае успеха;
404 – в случае ошибки.
Xsd схема XML запроса/ответа:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:include schemaLocation="error.xsd"/>
<xs:include schemaLocation="ecm_common.xsd"/>
<xs:complexType name="sipErrorMessagesOptionsType">
<xs:complexContent>
<xs:extension base="baseOptionsType">
<xs:attribute name="code_0" type="xs:string" use="optional" />
<xs:attribute name="code_1" type="xs:string" use="optional" />
<xs:attribute name="code_2" type="xs:string" use="optional" />
<xs:attribute name="code_3" type="xs:string" use="optional" />
<xs:attribute name="code_4" type="xs:string" use="optional" />
<xs:attribute name="code_5" type="xs:string" use="optional" />
<xs:attribute name="code_6" type="xs:string" use="optional" />
<xs:attribute name="code_7" type="xs:string" use="optional" />
<xs:attribute name="code_8" type="xs:string" use="optional" />
<xs:attribute name="code_9" type="xs:string" use="optional" />
<xs:attribute name="code_10" type="xs:string" use="optional" />
<xs:attribute name="code_11" type="xs:string" use="optional" />
<xs:attribute name="code_12" type="xs:string" use="optional" />
<xs:attribute name="code_14" type="xs:string" use="optional" />
<xs:attribute name="code_15" type="xs:string" use="optional" />
<xs:attribute name="code_16" type="xs:string" use="optional" />
<xs:attribute name="network_not_configured" type="xs:string" use="optional" />
<xs:attribute name="alias_declaration_error" type="xs:string" use="optional" />
<xs:attribute name="invalid_alias_digits" type="xs:string" use="optional" />
<xs:attribute name="wrong_identifier" type="xs:string" use="optional" />
<xs:attribute name="bad_template" type="xs:string" use="optional" />
<xs:attribute name="name_is_busy" type="xs:string" use="optional" />
<xs:attribute name="unknown_password" type="xs:string" use="optional" />
<xs:attribute name="unknown_login" type="xs:string" use="optional" />
<xs:attribute name="no_ldap_connection" type="xs:string" use="optional" />
<xs:attribute name="execution_error" type="xs:string" use="optional" />
<xs:attribute name="licence_limit" type="xs:string" use="optional" />
<xs:attribute name="bad_value" type="xs:string" use="optional" />
<xs:attribute name="wrong_set" type="xs:string" use="optional" />
<xs:attribute name="cancelled" type="xs:string" use="optional" />
<xs:attribute name="error_length" type="xs:string" use="optional" />
<xs:attribute name="error_contact_already_declared" type="xs:string" use="optional" />
<xs:attribute name="error_channel_id_not_found" type="xs:string" use="optional" />
<xs:attribute name="external" type="xs:string" use="optional" />
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- resultType-->
<xs:complexType name="resultType">
<xs:all>
<xs:element name="domain_options" type="domainSetOutType" minOccurs="1"/>
</xs:all>
</xs:complexType>
<!-- in-->
<xs:element name="in">
<xs:complexType>
<xs:sequence>
<xs:element name="request">
<xs:complexType>
<xs:all>
<xs:element name="domain_options" type="domainSetInType"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- out -->
<xs:element name="out">
<xs:complexType>
<xs:choice>
<xs:element name="result" type="resultType" minOccurs="1" maxOccurs="1"/>
<xs:element name="error" type="errorType" minOccurs="1" maxOccurs="1"/>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
CODE
Пример:
Запрос: http://192.168.1.21:9999/commands/sip_error_messages_set
<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_sip_error_messages_set.xsd">
<request>
<domain_options>
<system>
<options xs:type="sipErrorMessagesOptionsType"/>
</system>
<domain name="biysk.local">
<options xs:type="sipErrorMessagesOptionsType" external="666:language:en,text:New desc;language:ru,text:Новое описание|667:language:en,text:Desc"/>
</domain>
</domain_options>
</request>
</in>
CODE
Ответ:
<?xml version="1.0"?>
<out
xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_sip_error_messages_set.xsd">
<result>
<domain_options>
<system/>
<domain name="biysk.local">
<success option="external"/>
</domain>
</domain_options>
</result>
</out>
CODE