Hc_sip_status_messages - Управление текстовыми описаниями для SIP-cause
Hc_sip_status_messages_clean
Команда возвращает дефолтные значения текстовых описаний для SIP статусов
Аналог команды в CoCon:
domain/<DOMAIN>/sip/sip-status-messages/clean
Метод http запроса:
POST
Шаблон http запроса:
http://host:port/commands/sip-status-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_status_messages_clean
<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_sip_status_messages_clean.xsd">
<request>
<domain_options>
<system />
<domain name="biysk.local">
<option name="code_100"/>
<option name="external"/>
</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_status_messages_clean.xsd">
<result>
<domain_options>
<system/>
<domain name="biysk.local">
<success option="code_100"/>
<success option="external"/>
</domain>
</domain_options>
</result>
</out>
CODE
Hc_sip_status_messages_info
Команда возвращает текстовые описания для SIP-cause.
Аналог команды в CoCon:
domain/<DOMAIN>/sip/sip-status-messages/info
Метод http запроса:
POST
Шаблон http запроса:
http://host:port/commands/sip-status-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="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="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_status_messages_info
<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_sip_status_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_status_messages_info.xsd">
<result>
<domain_options>
<system>
<options xs:type="sipStatusMessagesOptionsType"/>
</system>
<domain name="biysk.local">
<options xs:type="sipStatusMessagesOptionsType" external="" code_606="language:default,text:Not Acceptable;language:en,text:Not Acceptable;language:ru,text:" code_604="language:default,text:Does not exist anywhere;language:en,text:Does not exist anywhere;language:ru,text:Абонент не существует" code_603="language:default,text:Decline;language:en,text:Decline;language:ru,text:Вызов отклонён" code_600="language:default,text:Busy Everywhere;language:en,text:Busy Everywhere;language:ru,text:Абонент не желает принимать вызов" code_513="language:default,text:Message Too Large;language:en,text:Message Too Large;language:ru,text:Размер сообщения слишком велик" code_505="language:default,text:SIP Version not supported;language:en,text:SIP Version not supported;language:ru,text:Версия SIP не поддерживается" code_504="language:default,text:Server Time-out;language:en,text:Server Time-out;language:ru,text:Истекло время ожидания ответа" code_503="language:default,text:Service Unavailable;language:en,text:Service Unavailable;language:ru,text:Обслуживание недоступно" code_502="language:default,text:Bad Gateway;language:en,text:Bad Gateway;language:ru,text:" code_501="language:default,text:Not Implemented;language:en,text:Not Implemented;language:ru,text:Не реализовано" code_500="language:default,text:Internal Server Error;language:en,text:Internal Server Error;language:ru,text:Внутренняя ошибка сервера" code_493="language:default,text:Undecipherable;language:en,text:Undecipherable;language:ru,text:Невозможно дешифровать" code_491="language:default,text:Request Pending;language:en,text:Request Pending;language:ru,text:Запрос отложен" code_489="language:default,text:Bad Event;language:en,text:Bad Event;language:ru,text:Неизвестное событие" code_488="language:default,text:Not Acceptable Here;language:en,text:Not Acceptable Here;language:ru,text:Запрос не принят" code_487="language:default,text:Request Terminated;language:en,text:Request Terminated;language:ru,text:Запрос отменён" code_486="language:default,text:Busy Here;language:en,text:Busy Here;language:ru,text:Абонент занят" code_485="language:default,text:Ambiguous;language:en,text:Ambiguous;language:ru,text:Неоднозначный адрес" code_484="language:default,text:Address Incomplete;language:en,text:Address Incomplete;language:ru,text:Неполный адрес" code_483="language:default,text:Too Many Hops;language:en,text:Too Many Hops;language:ru,text:Превышено допустимое число переходов" code_482="language:default,text:Loop Detected;language:en,text:Loop Detected;language:ru,text:Обнаружен замкнутый маршрут" code_481="language:default,text:Call Leg/Transaction Does Not Exist;language:en,text:Call Leg/Transaction Does Not Exist;language:ru,text:Действие не выполнено" code_480="language:default,text:Temporarily not available;language:en,text:Temporarily not available;language:ru,text:Временно недоступен" code_433="language:default,text:Anonymity Disallowed;language:en,text:Anonymity Disallowed;language:ru,text:" code_423="language:default,text:Interval Too Brief;language:en,text:Interval Too Brief;language:ru,text:Слишком короткий интервал" code_422="language:default,text:Session Interval Too Small;language:en,text:Session Interval Too Small;language:ru,text:Слишком короткий интервал между сессиями" code_421="language:default,text:Extension Required;language:en,text:Extension Required;language:ru,text:Требуется расширение" code_420="language:default,text:Bad Extension;language:en,text:Bad Extension;language:ru,text:Неизвестное расширение" code_416="language:default,text:Unsupported URI Scheme;language:en,text:Unsupported URI Scheme;language:ru,text:Неизвестный тип URI" code_415="language:default,text:Unsupported Media Type;language:en,text:Unsupported Media Type;language:ru,text:Неподдерживаемый тип медии" code_414="language:default,text:Request-URI Too Large;language:en,text:Request-URI Too Large;language:ru,text:Размер URI слишком велик" code_413="language:default,text:Request Entity Too Large;language:en,text:Request Entity Too Large;language:ru,text:Размер запроса слишком велик" code_410="language:default,text:Gone;language:en,text:Gone;language:ru,text:" code_408="language:default,text:Request Timeout;language:en,text:Request Timeout;language:ru,text:Время обработки запроса истекло" code_407="language:default,text:Proxy Authentication Required;language:en,text:Proxy Authentication Required;language:ru,text:Требуется аутентификация на прокис-сервере" code_406="language:default,text:Not Acceptable;language:en,text:Not Acceptable;language:ru,text:Не доступен" code_405="language:default,text:Method Not Allowed;language:en,text:Method Not Allowed;language:ru,text:Метод не поддерживается" code_404="language:default,text:Not Found;language:en,text:Not Found;language:ru,text:Не найдено" code_403="language:default,text:Forbidden;language:en,text:Forbidden;language:ru,text:Запрещено" code_402="language:default,text:Payment Required;language:en,text:Payment Required;language:ru,text:Требуется оплата" code_401="language:default,text:Unauthorized;language:en,text:Unauthorized;language:ru,text:Не авторизован" code_400="language:default,text:Bad Request;language:en,text:Bad Request;language:ru,text:Некорректный запрос" code_380="language:default,text:Alternative Service;language:en,text:Alternative Service;language:ru,text:Альтернативные услуги" code_305="language:default,text:Use Proxy;language:en,text:Use Proxy;language:ru,text:Использование прокси" code_302="language:default,text:Moved Temporarily;language:en,text:Moved Temporarily;language:ru,text:Временно не находится по адресу" code_301="language:default,text:Moved Permanently;language:en,text:Moved Permanently;language:ru,text:Не находится по адресу" code_300="language:default,text:Multiple Choices;language:en,text:Multiple Choices;language:ru,text:Выбор из набора" code_202="language:default,text:Accepted;language:en,text:Accepted;language:ru,text:Запрос принят" code_200="language:default,text:OK;language:en,text:OK;language:ru,text:ОК" code_183="language:default,text:Session Progress;language:en,text:Session Progress;language:ru,text:Прогресс" code_182="language:default,text:Queued;language:en,text:Queued;language:ru,text:В очереди" code_181="language:default,text:Call Is Being Forwarded;language:en,text:Call Is Being Forwarded;language:ru,text:Переадресация вызова" code_180="language:default,text:Ringing;language:en,text:Ringing;language:ru,text:Вызов" code_100="language:default,text:Trying;language:en,text:Trying;language:ru,text:Обработка"/>
</domain>
</domain_options>
</result>
</out>
CODE
Hc_sip_status_messages_set
Команда задает значения текстовых описаний для SIP-cause.
Аналог команды в CoCon:
domain/<DOMAIN>/sip/sip-status-messages/set
Метод http запроса:
POST
Шаблон http запроса:
http://host:port/commands/sip_status_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="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_status_messages_set
<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_sip_status_messages_set.xsd">
<request>
<domain_options>
<system>
<options xs:type="sipStatusMessagesOptionsType"/>
</system>
<domain name="biysk.local">
<options xs:type="sipStatusMessagesOptionsType" external="666:language:en,text:New desc;language:ru,text:Новое описание|667:language:en,text:Desc"/>
</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_status_messages_set.xsd">
<result>
<domain_options>
<system/>
<domain name="biysk.local">
<success option="external"/>
</domain>
</domain_options>
</result>
</out>
CODE