ECSS-10, версия 3.11
Быстрые ссылки
Дерево страниц
Перейти к концу метаданных
Переход к началу метаданных

Hc_tts_domain_options_info

Просмотр значений опций TTS уровня домена.

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

/domain/<DOMAIN>/tts/properties/info

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

POST

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

http://host:port/commands/tts_domain_options_info

Код HTTP-ответа:

  • 200 – в случае успеха;
  • 404 – в случае ошибки.

XSD-схема XML-запроса/ответа:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema
    xmlns:xs="http://www.w3.org/2001/XMLSchema" id="tts_domain_options_info">
    <xs:annotation>
        <xs:documentation xml:lang="en">
            Show TTS options.
            Copyright (c) 2015, Eltex. All rights reserved.
        </xs:documentation>
    </xs:annotation>
    <xs:include schemaLocation="error.xsd" />
    <xs:include schemaLocation="ecm_common.xsd" />
    <!--cdr_typeType-->
    <xs:simpleType name = "cdr_typeType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="extended"/>
            <xs:enumeration value="normal"/>
            <xs:enumeration value="manual"/>
        </xs:restriction>
    </xs:simpleType>
    <!--cdr_typeType-->
    <xs:simpleType name = "cdr_time_roundingType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="downside"/>
            <xs:enumeration value="upside"/>
            <xs:enumeration value="downside_with_delta"/>
            <xs:enumeration value="upside_with_delta"/>
            <xs:enumeration value="mathematically"/>
            <xs:enumeration value="millisecond"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:complexType name="ttsOptionsType">
        <xs:complexContent>
            <xs:extension base="baseOptionsType">
                <xs:attribute name="adaptation" type="xs:string" use="optional"/>
                <xs:attribute name="autoclean_enabled" type="xs:boolean" use="optional"/>
                <xs:attribute name="autoclean_start_at" type="xs:string" use="optional"/>
                <xs:attribute name="enabled" type="xs:boolean" use="optional"/>
                <xs:attribute name="sign_cdr_enabled" type="xs:boolean" use="optional"/>
                <xs:attribute name="actual_calls_enabled" type="xs:boolean" use="optional"/>
                <xs:attribute name="actual_calls_archive_size" type="xs:integer" use="optional"/>
                <xs:attribute name="cdr_generation_enabled" type="xs:boolean" use="optional"/>
                <xs:attribute name="cdr_type" type="cdr_typeType" use="optional"/>
                <xs:attribute name="cdr_time_rounding" type="cdr_time_roundingType" use="optional"/>
                <xs:attribute name="manual_cdr_columns" type="xs:string" use="optional"/>
                <xs:attribute name="partial_cdr_timeout" type="xs:integer" use="optional"/>
                <xs:attribute name="purge_older_than" type="xs:string" use="optional"/>
            </xs:extension>
        </xs:complexContent>
    </xs:complexType>
    <!-- in -->
    <xs:element name="in">
        <xs:complexType>
            <xs:all>
                <xs:element name="request" minOccurs="1" maxOccurs="1">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="domain_options" type="domainInfoInType" minOccurs="1" maxOccurs="1" />
                        </xs:all>
                    </xs:complexType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>
    <!-- in -->
    <!-- out -->
    <xs:element name="out">
        <xs:complexType>
            <xs:choice>
                <xs:element name="result">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="domain_options" type="domainInfoOutType" minOccurs="1" maxOccurs="1" />
                        </xs:all>
                    </xs:complexType>
                </xs:element>
                <xs:element name="error" type="errorType" minOccurs="1" maxOccurs="1" />
            </xs:choice>
        </xs:complexType>
    </xs:element>
    <!-- out -->
</xs:schema>

Пример:

Запрос:
http://192.168.1.21:9999/commands/tts_domain_options_info

<?xml version="1.0" encoding="UTF-8"?>
<in
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tts_domain_options_info.xsd">
    <request>
        <domain_options domain="biysk.local" />
    </request>
</in>

Ответ:

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tts_domain_options_info.xsd">
    <result>
        <domain_options>
            <system>
                <options xs:type="ttsOptionsType"/>
            </system>
            <domain name="biysk.local">
                <options xs:type="ttsOptionsType" sign_cdr_enabled="false" purge_older_than="2 month" partial_cdr_timeout="300" manual_cdr_columns="type,datetime,kod_a,kod_b,nai_a,nai_b,n_tr_gr_a,n_tr_gr_b,t_ecd,t_dba,cause_isup,cause_int,completind,origin_dig,dialed_dig,actsusb,categ_a,place,rec_seq,servuser,servindic,treatment,conn_id,redirected,redirection,orig_called,src_ip,dst_ip,port_a,port_b,diagnostic" enabled="true" cdr_type="extended" cdr_time_rounding="downside" cdr_generation_enabled="true" autoclean_start_at="every 1 day at 00:00" autoclean_enabled="true" adaptation="undefined" actual_calls_enabled="true" actual_calls_archive_size="1000"/>
            </domain>
        </domain_options>
    </result>
</out>

Hc_tts_domain_options_set

Установка значений свойств TTS на уровне домена.

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

/domain/<DOMAIN>/tts/properties/set

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

POST

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

http://host:port/commands/tts_domain_options_set

Код HTTP-ответа:

  • 200 – в случае успеха;
  • 404 – в случае ошибки.

XSD-схема XML-запроса/ответа:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema
    xmlns:xs="http://www.w3.org/2001/XMLSchema" id="tts_domain_options_set">
    <xs:annotation>
        <xs:documentation xml:lang="en">
            Change TTS domain options.
            Copyright (c) 2015, Eltex. All rights reserved.
        </xs:documentation>
    </xs:annotation>
    <xs:include schemaLocation="error.xsd" />
    <xs:include schemaLocation="ecm_common.xsd" />
    <!--cdr_typeType-->
    <xs:simpleType name = "cdr_typeType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="extended"/>
            <xs:enumeration value="normal"/>
            <xs:enumeration value="manual"/>
        </xs:restriction>
    </xs:simpleType>
    <!--cdr_typeType-->
    <xs:simpleType name = "cdr_time_roundingType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="downside"/>
            <xs:enumeration value="upside"/>
            <xs:enumeration value="downside_with_delta"/>
            <xs:enumeration value="upside_with_delta"/>
            <xs:enumeration value="mathematically"/>
            <xs:enumeration value="millisecond"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:complexType name="ttsOptionsType">
        <xs:complexContent>
            <xs:extension base="baseOptionsType">
                <xs:attribute name="autoclean_enabled" type="xs:boolean" use="optional"/>
                <xs:attribute name="autoclean_start_at" type="xs:string" use="optional"/>
                <xs:attribute name="adaptation" type="xs:string" use="optional"/>
                <xs:attribute name="enabled" type="xs:boolean" use="optional"/>
                <xs:attribute name="sign_cdr_enabled" type="xs:boolean" use="optional"/>
                <xs:attribute name="actual_calls_enabled" type="xs:boolean" use="optional"/>
                <xs:attribute name="actual_calls_archive_size" type="xs:integer" use="optional"/>
                <xs:attribute name="cdr_generation_enabled" type="xs:boolean" use="optional"/>
                <xs:attribute name="manual_cdr_columns" type="xs:string" use="optional"/>
                <xs:attribute name="cdr_type" type="cdr_typeType" use="optional"/>
                <xs:attribute name="cdr_time_rounding" type="cdr_time_roundingType" use="optional"/>
                <xs:attribute name="partial_cdr_timeout" type="xs:integer" use="optional"/>
                <xs:attribute name="purge_older_than" type="xs:string" use="optional"/>
            </xs:extension>
        </xs:complexContent>
    </xs:complexType>
    <!-- in -->
    <xs:element name="in">
        <xs:complexType>
            <xs:all>
                <xs:element name="request">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="domain_options" type="domainSetInType" minOccurs="1" maxOccurs="1" />
                        </xs:all>
                    </xs:complexType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>
    <!-- in -->
    <!-- out -->
    <xs:element name="out">
        <xs:complexType>
            <xs:choice>
                <xs:element name="result">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="domain_options" type="domainSetOutType" minOccurs="1" maxOccurs="1" />
                        </xs:all>
                    </xs:complexType>
                </xs:element>
                <xs:element name="error" type="errorType" minOccurs="1" maxOccurs="1" />
            </xs:choice>
        </xs:complexType>
    </xs:element>
    <!-- out -->
</xs:schema>

Пример:

Запрос:
http://192.168.1.21:9999/commands/tts_domain_options_set

<in
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tts_domain_options_set.xsd">
    <request>
        <domain_options>
            <system>
                <options xs:type="ttsOptionsType"/>
            </system>
            <domain name="biysk.local">
                <options xs:type="ttsOptionsType" purge_older_than="3 month" partial_cdr_timeout="600" />
            </domain>
        </domain_options>
    </request>
</in>

Ответ:

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tts_domain_options_set.xsd">
    <result>
        <domain_options>
            <system/>
            <domain name="biysk.local">
                <success option="partial_cdr_timeout"/>
                <success option="purge_older_than"/>
            </domain>
        </domain_options>
    </result>
</out>

Hc_tts_domain_options_clean

Сброс значений свойств TTS уровня домена в значения по умолчанию.

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

/domain/<DOMAIN>/tts/properties/clean

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

POST

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

http://host:port/commands/tts_domain_options_clean

Код HTTP-ответа:

  • 200 – в случае успеха;
  • 404 – в случае ошибки.

XSD-схема XML-запроса/ответа:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema
    xmlns:xs="http://www.w3.org/2001/XMLSchema" id="tts_domain_options_set">
    <xs:annotation>
        <xs:documentation xml:lang="en">
            Change TTS domain options.
            Copyright (c) 2015, Eltex. All rights reserved.
        </xs:documentation>
    </xs:annotation>
    <xs:include schemaLocation="error.xsd" />
    <xs:include schemaLocation="ecm_common.xsd" />
    <!--cdr_typeType-->
    <xs:simpleType name = "cdr_typeType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="extended"/>
            <xs:enumeration value="normal"/>
            <xs:enumeration value="manual"/>
        </xs:restriction>
    </xs:simpleType>
    <!--cdr_typeType-->
    <xs:simpleType name = "cdr_time_roundingType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="downside"/>
            <xs:enumeration value="upside"/>
            <xs:enumeration value="downside_with_delta"/>
            <xs:enumeration value="upside_with_delta"/>
            <xs:enumeration value="mathematically"/>
            <xs:enumeration value="millisecond"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:complexType name="ttsOptionsType">
        <xs:complexContent>
            <xs:extension base="baseOptionsType">
                <xs:attribute name="autoclean_enabled" type="xs:boolean" use="optional"/>
                <xs:attribute name="autoclean_start_at" type="xs:string" use="optional"/>
                <xs:attribute name="adaptation" type="xs:string" use="optional"/>
                <xs:attribute name="enabled" type="xs:boolean" use="optional"/>
                <xs:attribute name="sign_cdr_enabled" type="xs:boolean" use="optional"/>
                <xs:attribute name="actual_calls_enabled" type="xs:boolean" use="optional"/>
                <xs:attribute name="actual_calls_archive_size" type="xs:integer" use="optional"/>
                <xs:attribute name="cdr_generation_enabled" type="xs:boolean" use="optional"/>
                <xs:attribute name="manual_cdr_columns" type="xs:string" use="optional"/>
                <xs:attribute name="cdr_type" type="cdr_typeType" use="optional"/>
                <xs:attribute name="cdr_time_rounding" type="cdr_time_roundingType" use="optional"/>
                <xs:attribute name="partial_cdr_timeout" type="xs:integer" use="optional"/>
                <xs:attribute name="purge_older_than" type="xs:string" use="optional"/>
            </xs:extension>
        </xs:complexContent>
    </xs:complexType>
    <!-- in -->
    <xs:element name="in">
        <xs:complexType>
            <xs:all>
                <xs:element name="request">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="domain_options" type="domainSetInType" minOccurs="1" maxOccurs="1" />
                        </xs:all>
                    </xs:complexType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>
    <!-- in -->
    <!-- out -->
    <xs:element name="out">
        <xs:complexType>
            <xs:choice>
                <xs:element name="result">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="domain_options" type="domainSetOutType" minOccurs="1" maxOccurs="1" />
                        </xs:all>
                    </xs:complexType>
                </xs:element>
                <xs:element name="error" type="errorType" minOccurs="1" maxOccurs="1" />
            </xs:choice>
        </xs:complexType>
    </xs:element>
    <!-- out -->
</xs:schema>

Пример:

Запрос:
http://192.168.1.21:9999/commands/tts_domain_options_clean

<?xml version="1.0" encoding="UTF-8"?>
<in
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tts_domain_options_clean.xsd">
    <request>
        <domain_options>
            <system/>
            <domain name="biysk.local">
                <option name="purge_older_than"/>
            </domain>
        </domain_options>
    </request>
</in>

Ответ:

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tts_domain_options_clean.xsd">
    <result>
        <domain_options>
            <system/>
            <domain name="biysk.local">
                <success option="purge_older_than"/>
            </domain>
        </domain_options>
    </result>
</out>
  • Нет меток