Hc_sip_internal_messages - Управление текстовыми описаниями для внутренних кодов SIP
sip_internal_messages_clean
Команда возвращает дефолтные значения текстовых описаний для внутренних кодов SIP.
Аналог команды в CoCon:
domain/<DOMAIN>/sip/sip-internal-messages/clean
Метод http запроса:
POST
Шаблон http запроса:
http://host:port/commands/sip-internal-messages_clean
Код 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="sipStatusMessagesOptionsType">
<xs:complexContent>
<xs:extension base="baseOptionsType">
<xs:attribute name="code_100" type="xs:string" use="optional" />
<xs:attribute name="code_180" type="xs:string" use="optional" />
<xs:attribute name="code_181" type="xs:string" use="optional" />
<xs:attribute name="code_182" type="xs:string" use="optional" />
<xs:attribute name="code_183" type="xs:string" use="optional" />
<xs:attribute name="code_200" type="xs:string" use="optional" />
<xs:attribute name="code_202" type="xs:string" use="optional" />
<xs:attribute name="code_300" type="xs:string" use="optional" />
<xs:attribute name="code_301" type="xs:string" use="optional" />
<xs:attribute name="code_302" type="xs:string" use="optional" />
<xs:attribute name="code_305" type="xs:string" use="optional" />
<xs:attribute name="code_380" type="xs:string" use="optional" />
<xs:attribute name="code_400" type="xs:string" use="optional" />
<xs:attribute name="code_401" type="xs:string" use="optional" />
<xs:attribute name="code_402" type="xs:string" use="optional" />
<xs:attribute name="code_403" type="xs:string" use="optional" />
<xs:attribute name="code_404" type="xs:string" use="optional" />
<xs:attribute name="code_405" type="xs:string" use="optional" />
<xs:attribute name="code_406" type="xs:string" use="optional" />
<xs:attribute name="code_407" type="xs:string" use="optional" />
<xs:attribute name="code_408" type="xs:string" use="optional" />
<xs:attribute name="code_410" type="xs:string" use="optional" />
<xs:attribute name="code_413" type="xs:string" use="optional" />
<xs:attribute name="code_414" type="xs:string" use="optional" />
<xs:attribute name="code_415" type="xs:string" use="optional" />
<xs:attribute name="code_416" type="xs:string" use="optional" />
<xs:attribute name="code_420" type="xs:string" use="optional" />
<xs:attribute name="code_421" type="xs:string" use="optional" />
<xs:attribute name="code_422" type="xs:string" use="optional" />
<xs:attribute name="code_423" type="xs:string" use="optional" />
<xs:attribute name="code_433" type="xs:string" use="optional" />
<xs:attribute name="code_480" type="xs:string" use="optional" />
<xs:attribute name="code_481" type="xs:string" use="optional" />
<xs:attribute name="code_482" type="xs:string" use="optional" />
<xs:attribute name="code_483" type="xs:string" use="optional" />
<xs:attribute name="code_484" type="xs:string" use="optional" />
<xs:attribute name="code_485" type="xs:string" use="optional" />
<xs:attribute name="code_486" type="xs:string" use="optional" />
<xs:attribute name="code_487" type="xs:string" use="optional" />
<xs:attribute name="code_488" type="xs:string" use="optional" />
<xs:attribute name="code_489" type="xs:string" use="optional" />
<xs:attribute name="code_491" type="xs:string" use="optional" />
<xs:attribute name="code_493" type="xs:string" use="optional" />
<xs:attribute name="code_500" type="xs:string" use="optional" />
<xs:attribute name="code_501" type="xs:string" use="optional" />
<xs:attribute name="code_502" type="xs:string" use="optional" />
<xs:attribute name="code_503" type="xs:string" use="optional" />
<xs:attribute name="code_504" type="xs:string" use="optional" />
<xs:attribute name="code_505" type="xs:string" use="optional" />
<xs:attribute name="code_513" type="xs:string" use="optional" />
<xs:attribute name="code_600" type="xs:string" use="optional" />
<xs:attribute name="code_603" type="xs:string" use="optional" />
<xs:attribute name="code_604" type="xs:string" use="optional" />
<xs:attribute name="code_606" 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_internal_messages_clean
<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_sip_internal_messages_clean.xsd">
<request>
<domain_options>
<system />
<domain name="biysk.local">
<option name="unsupportedMedia"/>
</domain>
</domain_options>
</request>
</in>
CODE
Ответ: 200
<?xml version="1.0"?>
<out
xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_sip_internal_messages_clean.xsd">
<result>
<domain_options>
<system/>
<domain name="biysk.local">
<success option="unsupportedMedia"/>
</domain>
</domain_options>
</result>
</out>
CODE
sip_internal_messages_info
Команда возвращает текстовые описания для SIP-cause
Аналог команды в CoCon:
domain/<DOMAIN>/sip/sip-error-messages/info
Метод http запроса:
POST
Шаблон http запроса:
http://host:port/commands/sip_internal-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="sipInternalMessagesOptionsType">
<xs:complexContent>
<xs:extension base="baseOptionsType">
<xs:attribute name="normal" type="xs:string" use="optional" />
<xs:attribute name="originationDenied" type="xs:string" use="optional" />
<xs:attribute name="authorisationFailure" type="xs:string" use="optional" />
<xs:attribute name="unsupportedMedia" type="xs:string" use="optional" />
<xs:attribute name="aPtyAbandon" type="xs:string" use="optional" />
<xs:attribute name="invalidCollectedInformation" type="xs:string" use="optional" />
<xs:attribute name="collectInformationFailure" type="xs:string" use="optional" />
<xs:attribute name="aPtyDisc" type="xs:string" use="optional" />
<xs:attribute name="bPtyDisc" type="xs:string" use="optional" />
<xs:attribute name="routeSelectFailure" type="xs:string" use="optional" />
<xs:attribute name="routeFailure1" type="xs:string" use="optional" />
<xs:attribute name="routeFailure2" type="xs:string" use="optional" />
<xs:attribute name="invalidNumber" type="xs:string" use="optional" />
<xs:attribute name="unassignedNumber" type="xs:string" use="optional" />
<xs:attribute name="numberIncomplete" type="xs:string" use="optional" />
<xs:attribute name="oNoAnswer" type="xs:string" use="optional" />
<xs:attribute name="bPtyNoAnswer" type="xs:string" use="optional" />
<xs:attribute name="noCircuitAvailable" type="xs:string" use="optional" />
<xs:attribute name="terminationDenied" type="xs:string" use="optional" />
<xs:attribute name="notReachable" type="xs:string" use="optional" />
<xs:attribute name="bPtyBusyUDUB" type="xs:string" use="optional" />
<xs:attribute name="bPtyBusyNDUB" type="xs:string" use="optional" />
<xs:attribute name="ss7Failure" type="xs:string" use="optional" />
<xs:attribute name="calledPartyRejected" type="xs:string" use="optional" />
<xs:attribute name="tException" type="xs:string" use="optional" />
<xs:attribute name="systemFailure" type="xs:string" use="optional" />
<xs:attribute name="tooManyHops" type="xs:string" use="optional" />
<xs:attribute name="heartbeat" type="xs:string" use="optional" />
<xs:attribute name="heartbeat_timeout" type="xs:string" use="optional" />
<xs:attribute name="heartbeat_timeout_check" type="xs:string" use="optional" />
<xs:attribute name="session_timeout" type="xs:string" use="optional" />
<xs:attribute name="conversationTimeout" type="xs:string" use="optional" />
<xs:attribute name="uaPreemption" type="xs:string" use="optional" />
<xs:attribute name="reservedResourcesPreemted" type="xs:string" use="optional" />
<xs:attribute name="genericPreemption" type="xs:string" use="optional" />
<xs:attribute name="nonIpPreemption" type="xs:string" use="optional" />
<xs:attribute name="fork" 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_internal_messages_info
<?xml version="1.0"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_sip_internal_messages_info.xsd">
<request>
<domain_options domain="biysk.local" />
</request>
</in>
CODE
Ответ: 200
<?xml version="1.0"?>
<out
xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_sip_internal_messages_info.xsd">
<result>
<domain_options>
<system>
<options xs:type="sipInternalMessagesOptionsType"/>
</system>
<domain name="biysk.local">
<options xs:type="sipInternalMessagesOptionsType" unsupportedMedia="language:default,text:Unsupported media;language:en,text:Unsupported media;language:ru,text:Неподдерживаемый тип медии" unassignedNumber="language:default,text:Called number is wrong;language:en,text:Called number is wrong;language:ru,text:Вызываемый номер - неверный" uaPreemption="language:default,text:UA Preemption;language:en,text:UA Preemption;language:ru,text:UA Preemption" tooManyHops="language:default,text:Too Many Hops;language:en,text:Too Many Hops;language:ru,text:Слишком много переходов" terminationDenied="language:default,text:Call process is terminated;language:en,text:Call process is terminated;language:ru,text:Процесс вызова прерван" tException="language:default,text:Internal error;language:en,text:Internal error;language:ru,text:Внутренняя ошибка" systemFailure="language:default,text:Internal error;language:en,text:Internal error;language:ru,text:Внутренняя ошибка" ss7Failure="language:default,text:SS7 failure;language:en,text:SS7 failure;language:ru,text:" session_timeout="language:default,text:Conversation timeout;language:en,text:Conversation timeout;language:ru,text:Истекло время разговора" routeSelectFailure="language:default,text:Called number is wrong;language:en,text:Called number is wrong;language:ru,text:Вызываемый номер - неверный" routeFailure2="language:default,text:Called number is wrong;language:en,text:Called number is wrong;language:ru,text:Вызываемый номер - неверный" routeFailure1="language:default,text:Called number is wrong;language:en,text:Called number is wrong;language:ru,text:Вызываемый номер - неверный" reservedResourcesPreemted="language:default,text:Reserved Resources Preempted;language:en,text:Reserved Resources Preempted;language:ru,text:Reserved Resources Preempted" originationDenied="language:default,text:Call is broken in origination's leg;language:en,text:Call is broken in origination's leg;language:ru,text:" oNoAnswer="language:default,text:No answer;language:en,text:No answer;language:ru,text:Нет ответа" numberIncomplete="language:default,text:Address Incomplete;language:en,text:Address Incomplete;language:ru,text:Неполный адрес" notReachable="language:default,text:Destination is unreachable;language:en,text:Destination is unreachable;language:ru,text:Конечный пункт недостижим" normal="language:default,text:Call is complete;language:en,text:Call is complete;language:ru,text:Вызов завершен" nonIpPreemption="language:default,text:Non-IP Preemption;language:en,text:Non-IP Preemption;language:ru,text:Non-IP Preemption" noCircuitAvailable="language:default,text:Temporarily unavailable;language:en,text:Temporarily unavailable;language:ru,text:Временно недоступен" invalidNumber="language:default,text:Called number is wrong;language:en,text:Called number is wrong;language:ru,text:Вызываемый номер - неверный" invalidCollectedInformation="language:default,text:Invalid collected information;language:en,text:Invalid collected information;language:ru,text:" heartbeat_timeout_check="language:default,text:Remote session is inaccessible;language:en,text:Remote session is inaccessible;language:ru,text:Удаленный сеанс недоступен" heartbeat_timeout="language:default,text:Remote session is inaccessible;language:en,text:Remote session is inaccessible;language:ru,text:Удаленный сеанс недоступен" heartbeat="language:default,text:Remote session is inaccessible;language:en,text:Remote session is inaccessible;language:ru,text:Удаленный сеанс недоступен" genericPreemption="language:default,text:Generic Preemption;language:en,text:Generic Preemption;language:ru,text:Generic Preemption" fork="language:default,text:Forked leg is cancelled;language:en,text:Forked leg is cancelled;language:ru,text:Forked leg is cancelled" conversationTimeout="language:default,text:Conversation timeout;language:en,text:Conversation timeout;language:ru,text:Истекло время разговора" collectInformationFailure="language:default,text:Collect information failure;language:en,text:Collect information failure;language:ru,text:" calledPartyRejected="language:default,text:Call is rejected by destination's leg;language:en,text:Call is rejected by destination's leg;language:ru,text:" bPtyNoAnswer="language:default,text:No answer;language:en,text:No answer;language:ru,text:Нет ответа" bPtyDisc="language:default,text:Disconnect from B side;language:en,text:Disconnect from B side;language:ru,text:Отсоединение со стороны В" bPtyBusyUDUB="language:default,text:User is busy;language:en,text:User is busy;language:ru,text:Абонент занят" bPtyBusyNDUB="language:default,text:Destination is Busy;language:en,text:Destination is Busy;language:ru,text:Конечный пункт занят" authorisationFailure="language:default,text:Authorisation failure;language:en,text:Authorisation failure;language:ru,text:Авторизация неуспешна" aPtyDisc="language:default,text:Disconnect from A side;language:en,text:Disconnect from A side;language:ru,text:Отсоединение со стороны А" aPtyAbandon="language:default,text:Call is cancelled by A side;language:en,text:Call is cancelled by A side;language:ru,text:Вызов отменен стороной А"/>
</domain>
</domain_options>
</result>
</out>
CODE
sip_internal_messages_set
Команда задает значения текстовых описаний для SIP-cause
Аналог команды в CoCon:
domain/<DOMAIN>/sip/sip-error-messages/set
Метод http запроса:
POST
Шаблон http запроса:
http://host:port/commands/sip_internal_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_internal_messages_set
<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_sip_internal_messages_set.xsd">
<request>
<domain_options>
<system>
<options xs:type="sipInternalMessagesOptionsType"/>
</system>
<domain name="biysk.local">
<options xs:type="sipInternalMessagesOptionsType" unsupportedMedia="language:ru,text:Неподдерживаемый тип медии"/>
</domain>
</domain_options>
</request>
</in>
CODE
Ответ: 200
<?xml version="1.0"?>
<out
xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_sip_internal_messages_set.xsd">
<result>
<domain_options>
<system/>
<domain name="biysk.local">
<success option="unsupportedMedia"/>
</domain>
</domain_options>
</result>
</out>
CODE