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

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="no_answer_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:attribute name="shuffle" type="xs:boolean"/>
</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>
CODE

Пример:

Запрос:

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="test_name" description="Проверка unicode имен" script_id="063f86fccbeae10b" lines_limit="2" calls_limit="2" recall_timeout="60" time_interval="09:00-18:00" min_duration="5">
            <numbers>
                <number digits="4000">
                    <property name="debt" value="500"/>
                    <property name="name" value="vitaliy"/>
                </number>
                <number digits="4001">
                    <property name="debt" value="500"/>
                    <property name="name" value="Александр"/>
                </number>
                <number digits="4003">
                    <property name="debt" value="500"/>
                    <property name="name" value="maksim"/>
                </number>
                <number digits="4004">
                    <property name="debt" value="500"/>
                    <property name="name" value="alexey"/>
                </number>
            </numbers>
            <results>
                <script id="063f86fccbeae10b">
                    <block name="ivr_3" output="3" result="Выборал3"/>
                    <block name="play_4" output="true" result="Уведомлен"/>
                </script>
            </results>
            <operator_numbers>
                <number digits="4005"/>
                <number digits="4007"/>
            </operator_numbers>
            <property_descriptions>
                <property name="debt" data_name="debts" report_name="Задолженность"/>
                <property name="name" data_name="FIO"/>
            </property_descriptions>
        </template>
    </request>
</in>
CODE

Ответ:200

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

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="no_answer_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:attribute name="shuffle" type="xs:boolean"/>
    </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>
CODE

Запрос:

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="063f86fccbeae10b"/>
    </request>
</in>
CODE

Ответ: 200

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_template_info.xsd">
    <result>
        <template id="063f86fccbeae10b" name="info4lab" description="info for labs" script="play3" script_id="0631ad22420a1493" call_success_by_variable="" shuffle="false" lines_limit="0" calls_limit="1" recall_timeout="900" no_answer_timeout="20" priority="4" save_all_attempts="true" min_duration="15" time_interval="09:00-18:00">
            <numbers>
                <number digits="240464"/>
                <number digits="416977"/>
            </numbers>
            <results>
                <script id="0631ad22420a1493">
                    <block name="begin_1" output="true" result=""/>
                    <block name="play_2" 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>
CODE

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="no_answer_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:attribute name="shuffle" type="xs:boolean"/>
    </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>

CODE

Запрос:

http://192.168.1.21:9999/commands/dialer_template_set

<in
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_template_set.xsd">
    <request domain="biysk.local">
        <template id="063f86fccbeae10b" name="info4lab" description="info for labs" script_id="0631ad22420a1493">
            <numbers>
                <number digits="240464">
                    <property name="debt" value="500"/>
                    <property name="name" value="Светлана"/>
                </number>
                <number digits="416977">
                    <property name="debt" value="500"/>
                    <property name="name" value="Александр"/>
                </number>
            </numbers>
            <property_descriptions>
                <property name="debt" data_name="debts" report_name="Задолженность"/>
                <property name="name" data_name="FIO"/>
            </property_descriptions>
        </template>
    </request>
</in>

CODE

Ответ:

200

 
<?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>
CODE

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>
CODE

Запрос:

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>
CODE

Ответ:

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_template_list.xsd">
    <result>
        <template id="062d88f9c13c91d4" name="test2" description="jhgk" script="market_dialer" call_success_by_variable="" lines_limit="1" calls_limit="1" recall_timeout="1" priority="4" time_interval="09:00-18:00">
            <operator_numbers>
                <number digits="240244"/>
            </operator_numbers>
        </template>
        <template id="0627ec911ac5a8ee" name="опрос" description="реклама для абонентов" script="obzvon" call_success_by_variable="10" lines_limit="1" calls_limit="2" recall_timeout="900" priority="4" time_interval="09:00-11:00">
            <operator_numbers>
                <number digits="240469"/>
            </operator_numbers>
        </template>
        <template id="062d8904806b398a" name="ustp-1" description="Сбор бригады 1" script="NOT FOUND (Id = 06202b326f2fd9e8)" call_success_by_variable="" lines_limit="2" calls_limit="2" recall_timeout="60" priority="2" time_interval="00:00-23:59">
            <operator_numbers>
                <number digits="240101"/>
            </operator_numbers>
        </template>
        <template id="062d87eafcc580cd" name="market1" description="акция по новым услугам" script="obzvon" call_success_by_variable="" lines_limit="2" calls_limit="1" recall_timeout="60" priority="4" time_interval="08:00-17:00">
            <operator_numbers>
                <number digits="240244"/>
            </operator_numbers>
        </template>
    </result>
</out>
CODE

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>

CODE

Запрос:

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="062d88f9c13c91d4"/>
    </request>
</in>
CODE

Ответ:

<?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>
CODE