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

Hc_tc_meetings_active_info

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

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

/domain/<DOMAIN>/tc/meeting/active/info

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

POST

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

http://server:9999/commands/tc_meetings_active_info

Код ответа:

200 - успешно;
404 - ошибка.

XSD-схема, валидирующая входные и выходные данные:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
    <xs:include schemaLocation="common_types.xsd"/>
    <!-- Types -->
    <xs:complexType name="memberType">
        <xs:attribute name="id" type="xs:string" use="required"/>
        <xs:attribute name="voice" type="xs:string" use="required"/>
        <xs:attribute name="state" type="xs:string" use="required"/>
        <xs:attribute name="master" type="xs:boolean" use="optional"/>
        <xs:attribute name="hold" type="xs:boolean" use="optional"/>
    </xs:complexType>

    <xs:complexType name="meetingType">
        <xs:sequence>
            <xs:element name="member" type="memberType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
        <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="optional"/>
    </xs:complexType>

    <xs:complexType name="requestType">
        <xs:attribute name="domain" type="xs:string" use="required"/>
        <xs:attribute name="meeting" type="xs:string" use="optional"/>
    </xs:complexType>

    <xs:complexType name="responseType">
        <xs:sequence>
            <xs:element name="meeting" type="meetingType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
    </xs:complexType>

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

    <!-- out -->
    <xs:element name="out">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="response" type="responseType" minOccurs="1" maxOccurs="1"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
</xs:schema>

Примеры:

Вывести информацию обо всех активных совещаниях:
http://192.168.1.21:9999/commands/tc_meetings_active_info

<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="hc_tc_meetings_active_info.xsd">
    <request domain="test"/>
</in>

Ответ:200 Если есть активные конференции:

<?xml version="1.0"?>
<out xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="hc_tc_meetings_active_info.xsd">
    <response>
        <meeting id="836216376F0" name="test-tc-1" description="description">
            <member id="801" voice="on"  state="in_conf" master="true" hold="false"/>
            <member id="802" voice="off" state="online"  master="false" hold="false"/>
            <member id="803" voice="off" state="online"  master="false" hold="false"/>
        </meeting>
        <meeting id="836216376F1" name="test-tc-2" description="description">
            <member id="901" voice="on"  state="in_conf" master="true" hold="false"/>
            <member id="902" voice="off" state="online"  master="false" hold="false"/>
            <member id="903" voice="off" state="online"  master="false" hold="false"/>
        </meeting>
    </response>
</out>

Запрос с указание имени телеконференции:

http://192.168.23.34:9999/commands/tc_meetings_active_info

<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="hc_tc_meetings_active_info.xsd">
    <request domain="test" meeting="test-tc-1"/>
</in>

Ответ:200

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

Hc_tc_meetings_active_list

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

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

/domain/<DOMAIN>/tc/meeting/active/list


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


POST

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

http://server:9999/commands/tc_meetings_active_list

Код ответа:

200 - успешно;
404 - ошибка.

XSD-схема, валидирующая входные и выходные данные:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
    <!-- Types -->
    <xs:complexType name="meetingType">
        <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="optional"/>
    </xs:complexType>

    <xs:complexType name="requestType">
        <xs:attribute name="domain" type="xs:string" use="required"/>
    </xs:complexType>

    <xs:complexType name="responseType">
        <xs:sequence>
            <xs:element name="meeting" type="meetingType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
    </xs:complexType>

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

    <!-- out -->
    <xs:element name="out">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="response" type="responseType" minOccurs="1" maxOccurs="1"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
</xs:schema>


Примеры:

Вывести лист всех активных совещаний:
http://192.168.1.21:9999/commands/tc_meetings_active_list

<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="hc_tc_meetings_active_list.xsd">
    <request domain="test"/>
</in>

Ответ:200

<?xml version="1.0"?>
<out xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="hc_tc_meetings_active_list.xsd">
     <response>
        <meeting id="836216376F0" name="test-tc" description="description"/>
    </response>
</out>

Hc_tc_meetings_history

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

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

/domain/<DOMAIN>/tc/meeting/history

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

POST

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

http://server:9999/commands/tc_meetings_history

Код ответа:

200 - успешно;
404 - ошибка.

XSD-схема, валидирующая входные и выходные данные:

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

    <xs:complexType name="meetingType">
        <xs:sequence>
            <xs:element name="member" type="memberType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
        <xs:attribute name="id" type="xs:string" use="optional"/>
        <xs:attribute name="meeting_id" type="xs:string" use="required"/>
        <xs:attribute name="name" type="xs:string" use="required"/>
        <xs:attribute name="master" type="xs:string" use="required"/>
        <xs:attribute name="start_time" type="xs:string" use="required"/>
        <xs:attribute name="stop_time" type="xs:string" use="required"/>
        <xs:attribute name="duration" type="xs:string" use="required"/>
    </xs:complexType>

    <xs:simpleType name="orderByType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="id"/>
            <xs:enumeration value="name"/>
            <xs:enumeration value="start_time"/>
            <xs:enumeration value="stop_time"/>
        </xs:restriction>
    </xs:simpleType>

    <xs:simpleType name="sortByType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="desc"/>
            <xs:enumeration value="asc"/>
        </xs:restriction>
    </xs:simpleType>

    <xs:complexType name="lastType">
        <xs:attribute name="limit" type="xs:integer" use="optional"/>
        <xs:attribute name="order_by" type="orderByType" use="optional"/>
        <xs:attribute name="sort_by" type="sortByType" use="optional"/>
    </xs:complexType>

    <xs:complexType name="infoType">
        <xs:attribute name="id" type="xs:integer" use="required"/>
    </xs:complexType>

    <xs:complexType name="requestType">
        <xs:choice>
            <xs:element name="last" type="lastType"/>
            <xs:element name="info" type="infoType"/>
            <xs:element name="all"/>
        </xs:choice>
        <xs:attribute name="domain" type="xs:string" use="required"/>
    </xs:complexType>

    <xs:complexType name="responseType">
        <xs:choice>
            <xs:sequence>
                <xs:element name="meeting" type="meetingType" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:choice>
    </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="response" type="responseType"/>
            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>

Примеры:

Запрос информации о всех совещаниях:
http://192.168.1.21:9999/commands/tc_meetings_history

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

Ответ:

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_tc_meetings_history.xsd">
    <response>
        <meeting id="1" meeting_id="8362572E53B" name="tc_240475" master="240475" start_time="2017/12/09 20:26:15" stop_time="2017/12/09 20:28:32" duration="0:02:16">
            <member name="471040"/>
            <member name="89236501973"/>
        </meeting>
        <meeting id="3" meeting_id="8362572E53B" name="tc_240475" master="240475" start_time="2017/12/09 20:46:35" stop_time="2017/12/09 20:49:05" duration="0:02:29">
            <member name="89236501973"/>
        </meeting>
        <meeting id="5" meeting_id="8362572E53B" name="tc_240475" master="undefined" start_time="1970/01/01 07:00:00" stop_time="2017/12/09 20:49:05" duration="420229:49:05"/>
    </response>
</out>

Запрос подробной информации о совещании 3:

<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="hc_tc_meetings_history.xsd">
    <request domain="biysk.local">
        <info id="3" />
    </request>
</in>

Ответ:

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_tc_meetings_history.xsd">
    <response>
        <meeting name="tc_240475" meeting_id="8362572E53B" master="240475" start_time="2017/12/09 20:46:35" stop_time="2017/12/09 20:49:05" duration="0:02:29">
            <member name="89236501973"/>
        </meeting>
    </response>
</out>

Hc_tc_meetings_info

Команда предназначена для получения информации о совещаниях.

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

domain/<DOMAIN>/tc/meeting/info

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

POST

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

http://server:9999/commands/tc_meetings_info

Код ответа:

200 - успешно;
404 - ошибка.

XSD-схема, валидирующая входные и выходные данные:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
    <xs:include schemaLocation="common_types.xsd"/>
    <!-- Types -->
    <xs:complexType name="memberType">
        <xs:sequence>
            <xs:element name="property" type="propertyType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
        <xs:attribute name="name" type="xs:string" use="required"/>
    </xs:complexType>

    <xs:complexType name="groupType">
        <xs:sequence>
            <xs:element name="member" type="memberType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
        <xs:attribute name="id" type="xs:integer" use="required"/>
        <xs:attribute name="name" type="xs:string" use="required"/>
    </xs:complexType>

    <xs:complexType name="masterType">
        <xs:attribute name="id" type="xs:string" use="required"/>
        <xs:attribute name="read"  type="xs:boolean" use="optional"/>
        <xs:attribute name="write" type="xs:boolean" use="optional"/>
    </xs:complexType>

    <xs:complexType name="meetingType">
        <xs:sequence>
            <xs:element name="group" type="groupType" minOccurs="0" maxOccurs="unbounded"/>
            <xs:element name="master" type="masterType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
        <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="optional"/>
        <xs:attribute name="greeting_url" type="xs:string" use="optional"/>
        <xs:attribute name="is_public" type="xs:boolean"  use="required"/>
        <xs:attribute name="is_open" type="xs:boolean"  use="required"/>
    </xs:complexType>

    <xs:complexType name="requestType">
        <xs:attribute name="domain" type="xs:string" use="required"/>
        <xs:attribute name="meeting" type="xs:string" use="optional"/>
    </xs:complexType>

    <xs:complexType name="responseType">
        <xs:sequence>
            <xs:element name="meeting" type="meetingType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
    </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="response" type="responseType"/>
            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>

Примеры:

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

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

Ответ:

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_tc_meetings_info.xsd">
    <response>
        <meeting name="default" id="default" description="" greeting_url="" is_public="true" is_open="false"/>
        <meeting name="new_meeting" id="83620F86F67" description="" greeting_url="" is_public="true" is_open="true">
            <group id="1" name="">
                <member name="240101">
                    <property name="role" value="active"/>
                </member>
                <member name="240466">
                    <property name="role" value="active"/>
                </member>
            </group>
        </meeting>
        <meeting name="ltp-3" id="83622413D" description="" greeting_url="system://sounds/ai_conference_prompt.wav" is_public="true" is_open="true">
            <group id="1" name="">
                <member name="240101">
                    <property name="role" value="active"/>
                </member>
                <member name="240462">
                    <property name="role" value="active"/>
                </member>
                <member name="240464">
                    <property name="role" value="passive"/>
                </member>
                <member name="416977">
                    <property name="role" value="passive"/>
                </member>
            </group>
        </meeting>
        <meeting name="new_meeting2" id="83626ECEF82" description="мое новое совещание" greeting_url="system://sounds/ai_participant_of_conference.wav" is_public="true" is_open="true">
            <group id="1" name="Group One">
                <member name="240502">
                    <property name="role" value="passive"/>
                </member>
                <member name="240503">
                    <property name="role" value="active"/>
                </member>
                <member name="83832744787">
                    <property name="role" value="passive"/>
                </member>
            </group>
        </meeting>
    </response>
</out>

Hc_tc_meetings_list

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

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

domain/<DOMAIN>/tc/meeting/list

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

POST

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

http://server:9999/commands/tc_meetings_list

Код ответа:

200 - успешно;
404 - ошибка.

XSD-схема, валидирующая входные и выходные данные:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
    <!-- Types -->
    <xs:complexType name="meetingType">
        <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="optional"/>
    </xs:complexType>

    <xs:complexType name="requestType">
        <xs:attribute name="domain" type="xs:string" use="required"/>
    </xs:complexType>

    <xs:complexType name="responseType">
        <xs:sequence>
            <xs:element name="meeting" type="meetingType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
    </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="response" type="responseType"/>
            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>

Примеры:

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

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

Ответ:

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_tc_meetings_list.xsd">
    <response>
        <meeting name="default" id="default" description=""/>
        <meeting name="test_tc2" id="83624A7E487" description="web_tc"/>
        <meeting name="big_meeting" id="836235ECD74" description="&quot;for task 85999&quot;"/>
        <meeting name="240101_tc1" id="836263BD418" description="для менеджера 240101"/>
        <meeting name="tc_240519" id="83622B5102B" description="test 240519 + 240475"/>
        <meeting name="tc_240475" id="8362572E53B" description="проверка на простом ТА"/>
        <meeting name="test_ewsd_tc" id="8362096EF92" description="проверка селектора для инженеров EWSD"/>
    </response>
</out>
  • Нет меток