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

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

Hc_dialer_campaign_declare

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

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

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

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

POST

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

http://host:port/commands/dialer_campaign_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">
    <!-- campaignType -->
    <xs:complexType name="campaignType">
        <xs:sequence>
            <xs:element name="number" type="numberType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
        <xs:attribute name="name" type="xs:string" use="required"/>
        <xs:attribute name="template" type="xs:string" use="required"/>
        <xs:attribute name="start_type" type="xs:string" use="required"/>
        <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="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="numberType">
        <xs:sequence>
            <xs:element name="property" type="propertyType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
        <xs:attribute name="digits" type="xs:string"/>
    </xs:complexType>

    <xs:complexType name="propertyType">
        <xs:attribute name="name" type="xs:string" use="required"/>
        <xs:attribute name="value" 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="campaign" type="campaignType"/>
                        </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="campaign_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_campaign_declare

<?xml version="1.0"?>
<in
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_campaign_declare.xsd">
    <request domain="biysk.local">
        <campaign name="test_debt1" template="test_http_set_cmd" start_type="now" operator_number="240464" lines_limit="2" calls_limit="4" recall_timeout="60" time_interval="09:00-18:00" min_duration="5">
            <number digits="240471">
                <property name="debt" value="100"/>
                <property name="name" value="Svetlana"/>
            </number>
            <number digits="240475">
                <property name="debt" value="500"/>
                <property name="name" value="home_Aleksndr"/>
            </number>
            <number digits="89236501973">
                <property name="debt" value="500"/>
                <property name="name" value="mob_Aleksandr"/>
            </number>
            <number digits="471040">
                <property name="debt" value="10000"/>
                <property name="name" value="city_rtk_ewsd"/>
            </number>
        </campaign>
    </request>
</in>

Ответ:

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

Hc_dialer_campaign_info

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

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

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

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

POST

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

http://host:port/commands/dialer_campaign_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">
    <!-- campaignType -->
    <xs:complexType name="campaignType">
        <xs:attribute name="campaign_id" type="xs:string"/>
        <xs:attribute name="name" 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="time_interval" type="xs:string"/>
        <xs:attribute name="min_duration" type="xs:nonNegativeInteger"/>
        <xs:attribute name="start_time" type="xs:string"/>
        <xs:attribute name="update_time" type="xs:string"/>
        <xs:attribute name="status" type="xs:string"/>
        <xs:sequence>
            <xs:element name="call" type="callType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
    </xs:complexType>
    <xs:complexType name="callType">
        <xs:attribute name="number" type="xs:string"/>
        <xs:attribute name="start_time" type="xs:string"/>
        <xs:attribute name="answer_time" type="xs:string"/>
        <xs:attribute name="release_time" type="xs:string"/>
        <xs:attribute name="retry_number" type="xs:string"/>
        <xs:attribute name="status" type="xs:string"/>
        <xs:attribute name="result" type="xs:string"/>
    </xs:complexType>
    <!-- campaignsType -->
    <xs:complexType name="campaignsType">
        <xs:sequence>
            <xs:element name="campaign" type="campaignType" 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="campaign_id" type="xs:nonNegativeInteger" use="required"/>
                        <xs:attribute name="active" type="xs:boolean" default="false"/>
                        <xs:attribute name="limit" type="xs:nonNegativeInteger" default="50"/>
                        <xs:attribute name="show_options" type="xs:boolean" default="false"/>
                    </xs:complexType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>
    <!-- out-->
    <xs:element name="out">
        <xs:complexType>
            <xs:all>
                <xs:element name="campaign" type="campaignType"/>
            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>

Запрос:

http://192.168.1.21:9999/commands/dialer_campaign_info

<?xml version="1.0"?>
<in
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="hc_dialer_campaign_info.xsd">
    <request domain="biysk.local" campaign_id="5" limit="5"/>
</in>

Ответ:
<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_campaign_info.xsd">
    <campaign>
        <call number="240471" start_time="27.01.2018 06:49:51" answer_time="27.01.2018 06:50:16" release_time="27.01.2018 06:50:16" retry_number="2" status="failled" result="ok"/>
        <call number="240475" start_time="27.01.2018 06:49:56" answer_time="27.01.2018 06:50:14" release_time="27.01.2018 06:50:15" retry_number="2" status="failled" result="ok"/>
        <call number="471040" start_time="27.01.2018 06:49:50" answer_time="27.01.2018 06:50:08" release_time="27.01.2018 06:50:10" retry_number="2" status="failled" result="ok"/>
        <call number="89236501973" start_time="27.01.2018 06:50:15" answer_time="27.01.2018 06:50:22" release_time="27.01.2018 06:50:23" retry_number="2" status="failled" result="ok"/>
    </campaign>
</out>

Hc_dialer_campaign_action

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

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

/domain/<DOMAIN>/ss/dialer/<start|stop|pause|unpause>

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

POST

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

http://host:port/commands/dialer_campaign_action

Код 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">
    <!-- actionType -->
    <xs:complexType name="actionType">
        <xs:attribute name="name" type="xs:string" use="required"/>
        <xs:attribute name="campaign_id" type="xs:nonNegativeInteger"/>
    </xs:complexType>

    <!-- in-->
    <xs:element name="in">
        <xs:complexType>
            <xs:all>
                <xs:element name="request">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="action" type="actionType"/>
                        </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_campaign_action

Запрос (pause):

<?xml version="1.0"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_campaign_action.xsd">
    <request domain="biysk.local">
        <action name="pause" campaign_id="5"/>
    </request>
</in>

Запрос (unpause):

<?xml version="1.0"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_campaign_action.xsd">
    <request domain="biysk.local">
        <action name="unpause" campaign_id="7"/>
    </request>
</in>

Запрос (stop):

<?xml version="1.0"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_campaign_action.xsd">
    <request domain="biysk.local">
        <action name="stop" campaign_id="6"/>
    </request>
</in>

Запрос (remove):

<?xml version="1.0"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_campaign_action.xsd">
    <request domain="biysk.local">
        <action name="remove" campaign_id="5"/>
    </request>
</in>

Ответ (pause):

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

Ответ (unpause):

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

Ответ (stop):

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

Ответ (remove):

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

Hc_dialer_campaign_list

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

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

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

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

POST

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

http://host:port/commands/dialer_campaign_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">
    <!-- campaignType -->
    <xs:complexType name="campaignType">
        <xs:attribute name="campaign_id" type="xs:string" use="required"/>
        <xs:attribute name="name" type="xs:string" use="required"/>
        <xs:attribute name="operator_number" type="xs:string" use="required"/>
        <xs:attribute name="lines_limit" type="xs:string" use="required"/>
        <xs:attribute name="calls_limit" type="xs:string" use="required"/>
        <xs:attribute name="recall_timeout" type="xs:string" use="required"/>
        <xs:attribute name="time_interval" type="xs:string" use="required"/>
        <xs:attribute name="min_duration" type="xs:string" use="required"/>
        <xs:attribute name="start_time" type="xs:string" use="required"/>
        <xs:attribute name="update_time" type="xs:string" use="required"/>
        <xs:attribute name="status" type="xs:string" use="required"/>
    </xs:complexType>
    <!-- campaignsType -->
    <xs:complexType name="campaignsType">
        <xs:sequence>
            <xs:element name="campaign" type="campaignType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
    </xs:complexType>
    <xs:complexType name="requestType">
        <xs:sequence>
            <xs:element name="filter" type="filterType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
        <xs:attribute name="domain" type="xs:string" use="required"/>
    </xs:complexType>
    <xs:complexType name="valueType">
        <xs:attribute name="operator" type="xs:string" use="required"/>
        <xs:attribute name="value" type="xs:string" use="required"/>
    </xs:complexType>
    <xs:complexType name="filterType">
        <xs:sequence>
            <xs:element name="property" type="valueType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
        <xs:attribute name="property" type="xs:string" use="required"/>
        <xs:attribute name="delim" type="xs:string" use="required"/>
    </xs:complexType>
    <!-- in-->
    <xs:element name="in">
        <xs:complexType>
            <xs:all>
                <xs:element name="request" type="requestType"/>
            </xs:all>
        </xs:complexType>
    </xs:element>
    <!-- out-->
    <xs:element name="out">
        <xs:complexType>
            <xs:all>
                <xs:element name="result" type="campaignsType"/>
            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>

Запрос:

http://192.168.1.21:9999/commands/dialer_campaign_list

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

Ответ:

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_campaign_list.xsd">
    <result>
        <campaign campaign_id="4" name="test_debt1" operator_number="240464" lines_limit="2" calls_limit="4" recall_timeout="60" time_interval="09:00-18:00" min_duration="5" start_time="27.01.2018 05:44:24" update_time="27.01.2018 05:48:13" status="wait_time"/>
        <campaign campaign_id="5" name="test_debt1" operator_number="240464" lines_limit="4" calls_limit="2" recall_timeout="60" time_interval="09:00-18:00" min_duration="5" start_time="27.01.2018 06:48:34" update_time="27.01.2018 06:50:23" status="finished"/>
        <campaign campaign_id="6" name="test_debt1" operator_number="240464" lines_limit="4" calls_limit="2" recall_timeout="60" time_interval="09:00-18:00" min_duration="5" start_time="27.01.2018 07:07:55" update_time="27.01.2018 07:09:34" status="finished"/>
        <campaign campaign_id="7" name="test_debt1" operator_number="240464" lines_limit="2" calls_limit="4" recall_timeout="60" time_interval="09:00-18:00" min_duration="5" start_time="27.01.2018 07:07:59" update_time="27.01.2018 07:12:14" status="finished"/>
    </result>
</out>

Hc_dialer_campaign_start

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

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

/domain/<DOMAIN>/ss/dialer/start

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

POST

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

http://host:port/commands/dialer_campaign_start

Код 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">
    <!-- actionType -->
    <xs:complexType name="startType">
        <xs:attribute name="campaign_id" type="xs:nonNegativeInteger" use="required"/>
        <xs:attribute name="start_type" 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="start" type="startType"/>
                        </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="campaign_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_campaign_start

Запрос (start_type=now):

<?xml version="1.0"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_campaign_start.xsd">
    <request domain="biysk.local">
        <start campaign_id="7" start_type="now"/>
    </request>
</in>

Запрос (start_type=manual):

<?xml version="1.0"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_campaign_start.xsd">
    <request domain="biysk.local">
        <start campaign_id="5" start_type="manual"/>
    </request>
</in>

Запрос (start_type=datetime):

<?xml version="1.0"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_campaign_start.xsd">
    <request domain="biysk.local">
        <start campaign_id="5" start_type="27.01.2018 14:25:00"/>
    </request>
</in>

Ответ:

<?xml version="1.0"?>
<out xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_dialer_campaign_start.xsd">
    <response campaign_id="5"/>
</out>
  • Нет меток