Дерево страниц
Перейти к концу метаданных
Переход к началу метаданных

Hc_calls_active

Команда отображает список активных разговоров.

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

/domain/<DOMAIN>/calls/list --active true

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

POST

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

http://host:port/commands/calls_active

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

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

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

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

  <xs:complexType name="domainType">
    <xs:attribute name="name" type="xs:string" use="required"/>
    <xs:attribute name="calls_limit" type="xs:integer"/>
  </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>

  <xs:complexType name="callType">
<!--
    <xs:sequence>
      <xs:element name="property" type="propertyType" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
-->
    <xs:attribute name="id" type="xs:string" use="required"/>
    <xs:attribute name="call_ref" type="xs:string"/>
    <xs:attribute name="stage" type="xs:string"/>
    <xs:attribute name="ocgpn_a" type="xs:string"/>
    <xs:attribute name="ocdpn_b" type="xs:string"/>
    <xs:attribute name="start_time" type="xs:string"/>
    <xs:attribute name="alerting_time" type="xs:string"/>
    <xs:attribute name="answer_time" type="xs:string"/>
    <xs:attribute name="display_name_a" type="xs:string"/>
    <xs:attribute name="display_name_b" type="xs:string"/>
    <xs:attribute name="category_a" type="xs:string"/>
    <xs:attribute name="category_b" type="xs:string"/>
    <xs:attribute name="iface_a" type="xs:string"/>
    <xs:attribute name="iface_b" type="xs:string"/>
  </xs:complexType>

  <xs:complexType name="domainOutType">
    <xs:sequence>
      <xs:element name="call" type="callType" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="name" type="xs:string" use="required"/>
  </xs:complexType>

  <!-- in-->
  <xs:element name="in">
    <xs:complexType>
      <xs:all>
    <xs:element name="request">
      <xs:complexType>
        <xs:sequence>
          <xs:element name="domain" type="domainType" minOccurs="1" maxOccurs="1"/>
        </xs:sequence>
      </xs:complexType>
    </xs:element>
      </xs:all>
    </xs:complexType>
  </xs:element>

  <!-- out-->
  <xs:element name="out">
    <xs:complexType>
      <xs:choice>
        <!--Positive case-->
        <xs:element name="response">
          <xs:complexType>
        <xs:all>
          <xs:element name="domain" type="domainOutType"/>
        </xs:all>
          </xs:complexType>
        </xs:element>
        <!--Or error-->
        <xs:element name="error" type="errorType"/>
      </xs:choice>
    </xs:complexType>
  </xs:element>
</xs:schema>

Пример:

Запрос:

http://192.168.1.21:9999/commands/calls_active

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

Код ответа:

200

Ответ:

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_calls_active.xsd">
    <response>
        <domain name="biysk.local">
            <call id="" call_ref="3033252287" stage="answered" iface_a="bsk1" iface_b="ems1" display_name_a="241000" display_name_b="" start_time="02.10.2018 12:57:55" alerting_time="02.10.2018 12:57:55" answer_time="02.10.2018 12:57:56"/>
            <call id="" call_ref="3036947638" stage="answered" iface_a="bsk1" iface_b="ems1" display_name_a="241001" display_name_b="" start_time="02.10.2018 12:57:56" alerting_time="02.10.2018 12:57:56" answer_time="02.10.2018 12:57:56"/>
            <call id="" call_ref="3037446783" stage="answered" iface_a="bsk1" iface_b="ems1" display_name_a="241002" display_name_b="" start_time="02.10.2018 12:57:56" alerting_time="02.10.2018 12:57:56" answer_time="02.10.2018 12:57:57"/>
            <call id="" call_ref="3041141736" stage="answered" iface_a="bsk1" iface_b="ems1" display_name_a="241003" display_name_b="" start_time="02.10.2018 12:57:57" alerting_time="02.10.2018 12:57:57" answer_time="02.10.2018 12:57:57"/>
            <call id="" call_ref="3041641576" stage="answered" iface_a="bsk1" iface_b="ems1" display_name_a="241004" display_name_b="" start_time="02.10.2018 12:57:57" alerting_time="02.10.2018 12:57:57" answer_time="02.10.2018 12:57:58"/>
            <call id="" call_ref="3045335875" stage="answered" iface_a="bsk1" iface_b="ems1" display_name_a="241005" display_name_b="" start_time="02.10.2018 12:57:58" alerting_time="02.10.2018 12:57:58" answer_time="02.10.2018 12:57:58"/>
            <call id="" call_ref="3045835816" stage="answered" iface_a="bsk1" iface_b="ems1" display_name_a="241006" display_name_b="" start_time="02.10.2018 12:57:58" alerting_time="02.10.2018 12:57:58" answer_time="02.10.2018 12:57:59"/>
            <call id="" call_ref="3049530097" stage="answered" iface_a="bsk1" iface_b="ems1" display_name_a="241007" display_name_b="" start_time="02.10.2018 12:57:59" alerting_time="02.10.2018 12:57:59" answer_time="02.10.2018 12:57:59"/>
            <call id="" call_ref="3050029889" stage="answered" iface_a="bsk1" iface_b="ems1" display_name_a="241008" display_name_b="" start_time="02.10.2018 12:57:59" alerting_time="02.10.2018 12:57:59" answer_time="02.10.2018 12:58:00"/>
            <call id="" call_ref="3053723989" stage="answered" iface_a="bsk1" iface_b="ems1" display_name_a="241009" display_name_b="" start_time="02.10.2018 12:58:00" alerting_time="02.10.2018 12:58:00" answer_time="02.10.2018 12:58:00"/>
        </domain>
    </response>
</out>

Hc_domain_call_statistics

Команда для получения значения общей статистики вызовов домена.

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

domain/<DOMAIN>/calls/statistics

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

POST

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

http://host:port/commands/domain_call_statistics

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

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

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

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema
    xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:include schemaLocation="error.xsd"/>
    <!-- idType -->
    <xs:simpleType name="idType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="cp">
                <xs:annotation>
                    <xs:documentation xml:lang="en">
                        Simple calls
                    </xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="tc">
                <xs:annotation>
                    <xs:documentation xml:lang="en">
                        Teleconference calls
                    </xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="cc-active-agents">
                <xs:annotation>
                    <xs:documentation xml:lang="en">
                        Logged in call center operators
                    </xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="tsmn-concurrent-calls">
                <xs:annotation>
                    <xs:documentation xml:lang="en">
                        Call on TSMN service
                    </xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="add-on-conferences">
                <xs:annotation>
                    <xs:documentation xml:lang="en">
                        Add-On conferences
                    </xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="meet-me-conferences">
                <xs:annotation>
                    <xs:documentation xml:lang="en">
                        Add-On conferences
                    </xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="chat-room-conferences">
                <xs:annotation>
                    <xs:documentation xml:lang="en">
                        Chat rooms
                    </xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="dialer-channels">
                <xs:annotation>
                    <xs:documentation xml:lang="en">
                        Calls from dialer subsystem
                    </xs:documentation>
                </xs:annotation>
            </xs:enumeration>
        </xs:restriction>
    </xs:simpleType>
    <!-- statisticType -->
    <xs:complexType name="statisticType">
        <xs:attribute name="id" type="idType" use="required"/>
        <xs:attribute name="activeCalls" type="xs:token" use="optional"/>
        <xs:attribute name="topActiveCalls" type="xs:token" use="optional"/>
        <xs:attribute name="callLimit" type="xs:token" use="optional"/>
        <xs:attribute name="totalCalls" type="xs:token" use="optional"/>
        <xs:attribute name="rejectedCalls" type="xs:token" use="optional"/>
        <xs:attribute name="cps" type="xs:token" use="optional"/>
    </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:complexType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>
    <!-- out-->
    <xs:element name="out">
        <xs:complexType>
            <xs:choice>
                <!--Positive case-->
                <xs:element name="response">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element name="statistic" type="statisticType" minOccurs="0" maxOccurs="unbounded"/>
                        </xs:sequence>
                    </xs:complexType>
                </xs:element>
                <!--Or error-->
                <xs:element name="error" type="errorType"/>
            </xs:choice>
        </xs:complexType>
    </xs:element>
</xs:schema>

Пример:

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

<?xml version="1.0" encoding="UTF-8"?>
<in>
    <request domain="biysk.local"/>
</in>

Код ответа:

200

Ответ:

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_domain_call_statistics.xsd">
    <response>
        <statistic id="add-on-conferences" rejectedCalls="0" totalCalls="0" cps="0" activeCalls="0" topActiveCalls="0"/>
        <statistic id="cc-active-agents" rejectedCalls="0" totalCalls="0" cps="0" activeCalls="0" topActiveCalls="0"/>
        <statistic id="chat-room-conferences" rejectedCalls="0" totalCalls="0" cps="0" activeCalls="0" topActiveCalls="0"/>
        <statistic id="cp" rejectedCalls="0" totalCalls="114" callLimit="2000" cps="0" activeCalls="40" topActiveCalls="51"/>
        <statistic id="dialer-channels" rejectedCalls="0" totalCalls="0" cps="0" activeCalls="0" topActiveCalls="0"/>
        <statistic id="meet-me-conferences" rejectedCalls="0" totalCalls="0" cps="0" activeCalls="0" topActiveCalls="0"/>
        <statistic id="tc" rejectedCalls="0" totalCalls="0" cps="0" activeCalls="0" topActiveCalls="0"/>
        <statistic id="tsmn-concurrent-calls" rejectedCalls="0" totalCalls="0" cps="0" activeCalls="0" topActiveCalls="0"/>
    </response>
</out>
  • Нет меток