В данном разделе описаны команды для управления шаблонами дозвона.

Hc_dialer_template_declare

Команда предназначена для создания шаблона дозвона.

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

/domain/<DOMAIN>/ss/dialer/template/declare

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

POST

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

http://host:port/commands/dialer_template_declare

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

При выполнении команды HTTP-терминал может ответить следующими сообщениями:

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

XSD-схема XML-файла c ответом:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
    <xs:include schemaLocation="dialer_common.xsd"/>
    <xs:complexType name="templateType">
        <xs:all>
            <xs:element name="numbers" type="numbersType" minOccurs="0"/>
            <xs:element name="results" type="scriptsType" minOccurs="0"/>
            <xs:element name="operator_numbers" type="operatorNumbersType" minOccurs="0"/>
            <xs:element name="property_descriptions" type="propertyDesctiptionsType" minOccurs="0"/>
        </xs:all>
        <xs:attribute name="name" type="xs:string" use="required"/>
        <xs:attribute name="description" type="xs:string" use="required"/>
        <xs:attribute name="script_id" type="xs:string" use="required"/>
        <xs:attribute name="call_success_by_variable" type="xs:string"/>
        <xs:attribute name="lines_limit" type="xs:nonNegativeInteger"/>
        <xs:attribute name="calls_limit" type="xs:nonNegativeInteger"/>
        <xs:attribute name="recall_timeout" type="xs:nonNegativeInteger"/>
        <xs:attribute name="priority" type="xs:nonNegativeInteger"/>
        <xs:attribute name="save_all_attempts" type="xs:boolean"/>
        <xs:attribute name="time_interval" type="xs:string"/>
        <xs:attribute name="min_duration" type="xs:nonNegativeInteger"/>
        <xs:attribute name="group" type="xs:string"/>
    </xs:complexType>

    <!-- in-->
    <xs:element name="in">
        <xs:complexType>
            <xs:all>
                <xs:element name="request">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="template" type="templateType"/>
                        </xs:all>
                        <xs:attribute name="domain" type="xs:string" use="required"/>
                    </xs:complexType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>

    <!-- out-->
    <xs:complexType name="responseType">
        <xs:attribute name="template_id" type="xs:string" use="required"/>
    </xs:complexType>

    <xs:element name="out">
        <xs:complexType>
            <xs:all>
                <xs:element name="response" type="responseType"/>
            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>

Запрос:

http://192.168.1.21:9999/commands/dialer_template_declare

<?xml version="1.0"?>
<in
	xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_template_declare.xsd">
	<request domain="biysk.local">
		<template name="city_debt1" description="Внутренние и городские должники" script_id="06202b326f2fd9e8"  lines_limit="2" calls_limit="2" recall_timeout="60" time_interval="09:00-18:00" min_duration="1">
			<operator_numbers>
				<number digits="240101"/>
			</operator_numbers>
			<numbers>
				<number digits="89913699011"/>
				<number digits="240475"/>
				<number digits="471040"/>
				<number digits="240502"/>
			</numbers>
		</template>
	</request>
</in>

Ответ:

<?xml version="1.0"?>
<out
	xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_template_declare.xsd">
	<response template_id="0625ed804ab9fd38"/>
</out>

Hc_dialer_template_info

Команда просмотра свойств шаблона дозвона.

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

/domain/<DOMAIN>/ss/dialer/template/info

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

POST

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

http://host:port/commands/dialer_template_info

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

При выполнении команды HTTP-терминал может ответить следующими сообщениями:

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

XSD-схема XML-файла c ответом:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
    <xs:include schemaLocation="dialer_common.xsd"/>

    <xs:complexType name="templateReqType">
        <xs:attribute name="id" type="xs:string" use="required"/>
    </xs:complexType>

    <!-- in-->
    <xs:element name="in">
        <xs:complexType>
            <xs:all>
                <xs:element name="request">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="template" type="templateReqType"/>
                        </xs:all>
                        <xs:attribute name="domain" type="xs:string" use="required"/>
                    </xs:complexType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>

    <xs:complexType name="templateType">
        <xs:all>
            <xs:element name="numbers" type="numbersType" minOccurs="0"/>
            <xs:element name="results" type="scriptsType" minOccurs="0"/>
            <xs:element name="operator_numbers" type="operatorNumbersType" minOccurs="0"/>
            <xs:element name="property_descriptions" type="propertyDesctiptionsType" minOccurs="0"/>
        </xs:all>
        <xs:attribute name="id" type="xs:string" use="required"/>
        <xs:attribute name="name" type="xs:string" use="required"/>
        <xs:attribute name="description" type="xs:string" use="required"/>
        <xs:attribute name="script" type="xs:string" use="required"/>
        <xs:attribute name="script_id" type="xs:string" use="required"/>
        <xs:attribute name="call_success_by_variable" type="xs:string"/>
        <xs:attribute name="lines_limit" type="xs:nonNegativeInteger"/>
        <xs:attribute name="calls_limit" type="xs:nonNegativeInteger"/>
        <xs:attribute name="recall_timeout" type="xs:nonNegativeInteger"/>
        <xs:attribute name="priority" type="xs:nonNegativeInteger"/>
        <xs:attribute name="save_all_attempts" type="xs:boolean"/>
        <xs:attribute name="time_interval" type="xs:string"/>
        <xs:attribute name="min_duration" type="xs:nonNegativeInteger"/>
        <xs:attribute name="group" type="xs:string"/>
    </xs:complexType>

    <xs:complexType name="resultType">
        <xs:all>
            <xs:element name="template" type="templateType"/>
        </xs:all>
    </xs:complexType>

    <!-- out-->
    <xs:element name="out">
        <xs:complexType>
            <xs:all>
                <xs:element name="result" type="resultType"/>
            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>

Запрос:

http://192.168.1.21:9999/commands/dialer_template_info

<in xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="hc_dialer_template_info.xsd">
    <request domain="biysk.local">
        <template id="0625ed1e7db31f18"/>
    </request>
</in>

Ответ:

<?xml version="1.0"?>
<out
	xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_template_info.xsd">
	<result>
		<template id="0625ed1e7db31f18" name="ustp-1" description="Сбор бригады УСТП-GPON" script="dialer" script_id="06202b326f2fd9e8" call_success_by_variable="" lines_limit="1" calls_limit="2" recall_timeout="60" priority="2" save_all_attempts="true" min_duration="5" time_interval="00:00-23:59">
			<numbers>
				<number digits="89913699011"/>
				<number digits="240475"/>
				<number digits="471040"/>
				<number digits="240502"/>
			</numbers>
			<results>
				<script id="06202b326f2fd9e8">
					<block name="begin_1" output="true" result=""/>
					<block name="play_3" output="true" result=""/>
				</script>
			</results>
			<operator_numbers>
				<number digits="240101"/>
			</operator_numbers>
			<property_descriptions>
				<property name="number_digits_meta" data_name="Номер" report_name=""/>
			</property_descriptions>
		</template>
	</result>
</out>

Hc_dialer_template_set

Команда предназначена для изменения свойств шаблона дозвона.

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

/domain/<DOMAIN>/ss/dialer/template/set

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

POST

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

http://host:port/commands/dialer_template_set

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

При выполнении команды HTTP-терминал может ответить следующими сообщениями:

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

XSD-схема XML-файла c ответом:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
    <xs:include schemaLocation="dialer_common.xsd"/>
    <!-- campaignType -->
    <xs:complexType name="templateType">
        <xs:all>
            <xs:element name="numbers" type="numbersType" minOccurs="0"/>
            <xs:element name="results" type="scriptsType" minOccurs="0"/>
            <xs:element name="operator_numbers" type="operatorNumbersType" minOccurs="0"/>
            <xs:element name="property_descriptions" type="propertyDesctiptionsType" minOccurs="0"/>
        </xs:all>
        <xs:attribute name="id" type="xs:string" use="required"/>
        <xs:attribute name="name" type="xs:string"/>
        <xs:attribute name="description" type="xs:string"/>
        <xs:attribute name="script_id" type="xs:string"/>
        <xs:attribute name="call_success_by_variable" type="xs:string"/>
        <xs:attribute name="operator_number" type="xs:string"/>
        <xs:attribute name="lines_limit" type="xs:nonNegativeInteger"/>
        <xs:attribute name="calls_limit" type="xs:nonNegativeInteger"/>
        <xs:attribute name="recall_timeout" type="xs:nonNegativeInteger"/>
        <xs:attribute name="priority" type="xs:nonNegativeInteger"/>
        <xs:attribute name="save_all_attempts" type="xs:boolean"/>
        <xs:attribute name="time_interval" type="xs:string"/>
        <xs:attribute name="min_duration" type="xs:nonNegativeInteger"/>
        <xs:attribute name="group" type="xs:string"/>
    </xs:complexType>

    <!-- in-->
    <xs:element name="in">
        <xs:complexType>
            <xs:all>
                <xs:element name="request">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="template" type="templateType"/>
                        </xs:all>
                        <xs:attribute name="domain" type="xs:string" use="required"/>
                    </xs:complexType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>

    <!-- out-->
    <xs:complexType name="responseType">
        <xs:attribute name="result" type="xs:string" use="required"/>
    </xs:complexType>

    <xs:element name="out">
        <xs:complexType>
            <xs:all>
                <xs:element name="response" type="responseType"/>
            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>

Запрос:

http://192.168.1.21:9999/commands/dialer_template_set

<?xml version="1.0"?>
<in
	xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_template_set.xsd">
	<request domain="biysk.local">
		<template id="0625ed1e7db31f18" name="ustp-1" description="Сбор бригады 1" script_id="06202b326f2fd9e8" call_success_by_variable="" lines_limit="2" calls_limit="2" recall_timeout="60" priority="2" save_all_attempts="true" min_duration="5" time_interval="00:00-23:59">
			<numbers>
				<number digits="89913699011"/>
				<number digits="240475"/>
				<number digits="471040"/>
				<number digits="240502"/>
			</numbers>
		</template>
	</request>
</in>

Ответ:

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_template_set.xsd">
    <response result="ok"/>
</out>

Hc_dialer_template_list

Команда предназначена для просмотра списка шаблонов дозвона.

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

/domain/<DOMAIN>/ss/dialer/template/list

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

POST

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

http://host:port/commands/dialer_template_list

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

При выполнении команды HTTP-терминал может ответить следующими сообщениями:

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

XSD-схема XML-файла c ответом:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
    <xs:include schemaLocation="dialer_common.xsd"/>
    <xs:complexType name="templateType">
        <xs:all>
            <xs:element name="operator_numbers" type="operatorNumbersType" minOccurs="0"/>
        </xs:all>
        <xs:attribute name="id" type="xs:string" use="required"/>
        <xs:attribute name="name" type="xs:string" use="required"/>
        <xs:attribute name="description" type="xs:string" use="required"/>
        <xs:attribute name="lines_limit" type="xs:string"/>
        <xs:attribute name="calls_limit" type="xs:string"/>
        <xs:attribute name="recall_timeout" type="xs:string"/>
        <xs:attribute name="priority" type="xs:string"/>
        <xs:attribute name="call_success_by_variable" type="xs:string"/>
        <xs:attribute name="time_interval" type="xs:string"/>
        <xs:attribute name="script" type="xs:string"/>
    </xs:complexType>
    <xs:complexType name="templatesType">
        <xs:sequence>
            <xs:element name="template" type="templateType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
    </xs:complexType>
    <!-- in-->
    <xs:element name="in">
        <xs:complexType>
            <xs:all>
                <xs:element name="request">
                    <xs:complexType>
                        <xs:attribute name="domain" type="xs:string" use="required"/>
                        <xs:attribute name="format" type="xs:string" use="required"/>
                    </xs:complexType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>
    <!-- out-->
    <xs:element name="out">
        <xs:complexType>
            <xs:all>
                <xs:element name="result" type="templatesType"/>
            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>

Запрос:

http://192.168.1.21:9999/commands/dialer_template_list

<in xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="hc_dialer_template_list.xsd">
    <request domain="biysk.local" format="full"/>
</in>

Ответ:

<?xml version="1.0"?>
<out
	xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_template_list.xsd">
	<result>
		<template id="0625ed45ef32943e" name="test2" description="test_dialer 2" script="dialer" call_success_by_variable="" lines_limit="1" calls_limit="2" recall_timeout="1" priority="4" time_interval="09:00-18:00">
			<operator_numbers>
				<number digits="240475"/>
			</operator_numbers>
		</template>
		<template id="06202c284e8dcd78" name="dialer_test" description="шаблон обзвона абонентов" script="dialer" call_success_by_variable="" lines_limit="2" calls_limit="1" recall_timeout="60" priority="4" time_interval="09:00-18:00">
			<operator_numbers>
				<number digits="240473"/>
			</operator_numbers>
		</template>
		<template id="0625ed1e7db31f18" name="ustp-1" description="Сбор бригады УСТП-GPON" script="dialer" call_success_by_variable="" lines_limit="1" calls_limit="2" recall_timeout="60" priority="2" time_interval="00:00-23:59">
			<operator_numbers>
				<number digits="240101"/>
			</operator_numbers>
		</template>
	</result>
</out>

Hc_dialer_template_remove

Команда предназначена для удаления шаблона дозвона.

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

/domain/<DOMAIN>/ss/dialer/template/remove

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

POST

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

http://host:port/commands/dialer_template_remove

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

При выполнении команды HTTP-терминал может ответить следующими сообщениями:

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

XSD-схема XML-файла c ответом:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
    <!-- campaignType -->
    <xs:complexType name="templateType">
        <xs:attribute name="id" type="xs:string" use="required"/>
    </xs:complexType>

    <!-- in-->
    <xs:element name="in">
        <xs:complexType>
            <xs:all>
                <xs:element name="request">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="template" type="templateType"/>
                        </xs:all>
                        <xs:attribute name="domain" type="xs:string" use="required"/>
                    </xs:complexType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>

    <!-- out-->
    <xs:complexType name="responseType">
        <xs:attribute name="result" type="xs:string" use="required"/>
    </xs:complexType>

    <xs:element name="out">
        <xs:complexType>
            <xs:all>
                <xs:element name="response" type="responseType"/>
            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>

Запрос:

http://192.168.1.21:9999/commands/dialer_template_remove

<?xml version="1.0"?>
<in xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="hc_dialer_template_remove.xsd">
    <request domain="biysk.local">
        <template id="0625ed45ef32943e"/>
    </request>
</in>

Ответ:

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_template_remove.xsd">
    <response result="ok"/>
</out>