Hc_sip_number_modifications_clean

Команда сброса настроек SIP-модификаторов.

Аналог команды в CoCon:

domain/<DOMAIN>/sip/modifications/clean

Метод HTTP-запроса:

POST

Шаблон HTTP-запроса:

http://host:port/commands/sip_number_modifications_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:annotation>
    <xs:documentation xml:lang="en">
      Clean properties of sip number modifications.
      Usage: http://server:9999/commands/sip_number_modifications_clean.
      Implementation: hc_sip_number_modifications_clean.erl.
      Git: git@git.eltex.loc:httpTerminal.git.
      Copyright (c) 2015, Eltex. All rights reserved.
    </xs:documentation>
	</xs:annotation>
	<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_number_modifications_clean

<?xml version="1.0"?>
<in
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_sip_number_modifications_clean.xsd">
    <request>
        <domain_options>
            <system />
            <domain name="biysk.local">
                <option name="list"/>
            </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_number_modifications_clean.xsd">
    <result>
        <domain_options>
            <system/>
            <domain name="biysk.local">
                <success option="list"/>
            </domain>
        </domain_options>
    </result>
</out>
CODE

Hc_sip_number_modifications_info

Команда просмотра настроек SIP-модификаторов.

Аналог команды в CoCon:

domain/<DOMAIN>/sip/modifications/info

Метод HTTP-запроса:

POST

Шаблон HTTP-запроса:

http://host:port/commands/sip_number_modifications_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:annotation>
    <xs:documentation xml:lang="en">
      Show properties of sip number modifications.
      Usage: http://server:9999/commands/sip_number_modifications_info.
      Implementation: hc_sip_number_modifications_info.erl.
      Git: git@git.eltex.loc:httpTerminal.git.
      Copyright (c) 2015, Eltex. All rights reserved.
    </xs:documentation>
  </xs:annotation>

	<xs:include schemaLocation="error.xsd"/>
	<xs:include schemaLocation="ecm_common.xsd"/>

	<xs:complexType name="sipNumberModificationsType">
	  <xs:complexContent>
	    <xs:extension base="baseOptionsType">
	      <xs:attribute name="list" 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_number_modifications_info

<?xml version="1.0"?>
<in xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="hc_sip_number_modifications_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_number_modifications_info.xsd">
    <result>
        <domain_options>
            <system>
                <options xs:type="sipNumberModificationsType"/>
            </system>
            <domain name="biysk.local">
                <options xs:type="sipNumberModificationsType" list=""rule1","cgpn","222*","$","---$";"rule2","cgpn","xx8x.","$","+(777)$""/>
            </domain>
        </domain_options>
    </result>
</out>
CODE

Hc_sip_number_modifications_set

Команда настройки SIP-модификаторов.

Аналог команды в CoCon:

domain/<DOMAIN>/sip/modifications/set

Метод HTTP-запроса:

POST

Шаблон HTTP-запроса:

http://host:port/commands/sip_modifications_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:annotation>
        <xs:documentation xml:lang="en">
            Set sip number modifications
            Usage: http://server:9999/commands/sip_number_modifications_set.
            Implementation: hc_sip_number_modifications_set.erl.
            Git: git@git.eltex.loc:httpTerminal.git.
            Copyright (c) 2015, Eltex. All rights reserved.
        </xs:documentation>
    </xs:annotation>
    <xs:include schemaLocation="error.xsd"/>
    <xs:include schemaLocation="ecm_common.xsd"/>

    <xs:complexType name="sipNumberModificationsType">
        <xs:complexContent>
            <xs:extension base="baseOptionsType">
	      <xs:attribute name="list" 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_modifications_set

<?xml version="1.0"?>
<in
xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_sip_number_modifications_set.xsd">
<request>
<domain_options>
<system>
<options xs:type="sipNumberModificationsType"/>
</system>
<domain name="biysk.local">
<options xs:type="sipNumberModificationsType" list=""rule1","cgpn","222*","$","---$";"rule2","cgpn","xx8x.","$","+(777)$""/>
</domain>
</domain_options>
</request>
</in>

Ответ: 200

<?xml version="1.0"?>
<in
xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_sip_number_modifications_set.xsd">
<request>
<domain_options>
<system>
<options xs:type="sipNumberModificationsType"/>
</system>
<domain name="biysk.local">
<options xs:type="sipNumberModificationsType" list=""rule1","cgpn","222*","$","---$";"rule2","cgpn","xx8x.","$","+(777)$""/>
</domain>
</domain_options>
</request>
</in>