更新时间:2024-01-15 GMT+08:00
分享

查询历史会议列表

描述

该接口用于查询已经结束的会议。管理员可以查询本企业内所有的历史会议,普通用户仅能查询自己创建或者被邀请的历史会议。不带查询参数时,默认查询权限范围内的历史会议。

  • 普通用户如果只是通过会议ID或者会议链接接入会议,不是预定者会前邀请或者会中主持人邀请的,则历史会议中无法查到
  • 如果同一个会议召开并结束多次,则会产生多条历史会议(会议ID相同,会议UUID不同)
  • 历史会议记录默认保留6个月,最长保留12个月。保留时间管理员可在“会议设置”的“历史会议留存时间”中修改

调试

您可以在API Explorer中直接运行调试该接口。

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/mmc/management/conferences/history

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

userUUID

string

Query

用户的UUID。

说明:

该参数将废弃,请勿使用。

offset

Integer

Query

查询偏移量。默认为0。

limit

Integer

Query

查询数量。默认是20,最大500条。

searchKey

string

Query

查询条件。会议主题、会议预约人和会议ID等可作为搜索内容。

queryAll

Boolean

Query

是否查询企业下所有用户的历史会议。

  • true:查询所有用户的历史会议
  • false:仅查询管理员自己的历史会议
    说明:

    仅对企业管理员生效。

startDate

long

Query

查询的起始时间戳(单位毫秒)。

endDate

long

Query

查询的截止时间戳(单位毫秒)。

sortType

String

Query

查询结果排序类型。

  • ASC_StartTIME:根据会议开始时间升序排序
  • DSC_StartTIME:根据会议开始时间降序排序
  • ASC_RecordTYPE:根据是否具有录播文件排序,之后默认按照会议开始时间升序排序
  • DSC_RecordTYPE:根据是否含有录播文件排序,之后默认按照会议开始时间降序排序

X-Access-Token

String

Header

授权令牌。获取“执行App ID鉴权”响应的accessToken。

X-Authorization-Type

String

Header

标识是否为第三方portal过来的请求。

说明:

该参数将废弃,请勿使用。

X-Site-Id

String

Header

用于区分到哪个HCSO站点鉴权。

说明:

该参数将废弃,请勿使用。

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常。

响应参数

表4 响应参数

参数

类型

描述

offset

Integer

查询偏移量。

limit

Integer

每页的记录数。

count

Integer

总记录数。

data

Array of ConferenceInfo objects

会议列表。

请求消息示例

GET /v1/mmc/management/conferences/history?startDate=1574092800000&endDate=1574179199999
Connection: keep-alive
X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC
user-agent: WeLink-desktop
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

响应消息示例

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 2420
Connection: keep-alive
Expires: 0
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: 43bee1151af8115d90358994a7c14cfc
Server: api-gateway
X-Request-Id: 53c883710d86aebf01e92ce7bcea1984

{
    "data": [
        {
            "conferenceID": "914083388",
            "mediaTypes": "Voice,Video,Data",
            "subject": "user8001测试会议",
            "size": 1,
            "timeZoneID": "56",
            "startTime": "2019-11-18 23:31",
            "endTime": "2019-11-18 23:32",
            "conferenceState": "Destroyed",
            "accessNumber": "+991117",
            "language": "zh-CN",
            "passwordEntry": [
                {
                    "conferenceRole": "general",
                    "password": "******"
                }
            ],
            "userUUID": "ff8080816a024f05016a4e2342480a60",
            "scheduserName": "test008",
            "multiStreamFlag": 1,
            "conferenceType": 0,
            "confType": "IMMEDIATELY",
            "isAutoMute": 1,
            "isAutoRecord": 0,
            "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083388/1f215673e636444b55845ee1d1af630e8d8ca0235e491972",
            "recordType": 0,
            "recordAuxStream": 0,
            "recordAuthType": 0,
            "confConfigInfo": {
                "prolongLength": 15,
                "isGuestFreePwd": false,
                "isSendNotify": true,
                "isSendSms": true,
                "isAutoMute": true,
                "isSendCalendar": true,
                "callInRestriction": 0,
                "allowGuestStartConf": true,
                "isHardTerminalAutoMute": true,
                "enableWaitingRoom": true
            },
            "vmrFlag": 0,
            "scheduleVmr": false,
            "isHasRecordFile": false,
            "partAttendeeInfo": [
                {
                    "phone": "+99111****380",
                    "name": "user8002",
                    "type": "normal"
                }
            ],
            "terminlCount": 0,
            "normalCount": 1,
            "deptName": "wangyue",
            "confUUID": "9a0fa6d10a5b11eaae5e191763c22c0e"
        },
        {
            "conferenceID": "914088193",
            "mediaTypes": "Voice,Video,Data",
            "subject": "user8001的会议",
            "size": 1,
            "timeZoneID": "56",
            "startTime": "2019-11-18 23:31",
            "endTime": "2019-11-18 23:31",
            "conferenceState": "Destroyed",
            "accessNumber": "+991117",
            "language": "zh-CN",
            "passwordEntry": [
                {
                    "conferenceRole": "general",
                    "password": "******"
                }
            ],
            "userUUID": "ff8080816a024f05016a4e2342480a60",
            "scheduserName": "test008",
            "multiStreamFlag": 1,
            "conferenceType": 0,
            "confType": "IMMEDIATELY",
            "isAutoMute": 1,
            "isAutoRecord": 0,
            "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914088193/5b00be0e5121eb2f6f865162a4bc7f1f7f05d37cd802dded",
            "recordType": 2,
            "recordAuxStream": 0,
            "recordAuthType": 0,
            "confConfigInfo": {
                "prolongLength": 15,
                "isGuestFreePwd": false,
                "isSendNotify": true,
                "isSendSms": true,
                "isAutoMute": true,
                "isSendCalendar": true,
                "callInRestriction": 0,
                "allowGuestStartConf": true,
                "isHardTerminalAutoMute": true,
                "enableWaitingRoom": true
            },
            "vmrFlag": 0,
            "scheduleVmr": false,
            "isHasRecordFile": false,
            "partAttendeeInfo": [
                {
                    "phone": "+991116004380",
                    "name": "user8002",
                    "type": "normal"
                }
            ],
            "terminlCount": 0,
            "normalCount": 1,
            "deptName": "wangyue",
            "confUUID": "7c421ac60a5b11eaa5e83b30677ab12b"
        },
        {
            "conferenceID": "914085971",
            "mediaTypes": "Voice,Video,Data",
            "subject": "user8001的会议",
            "size": 1,
            "timeZoneID": "56",
            "startTime": "2019-11-18 23:30",
            "endTime": "2019-11-18 23:31",
            "conferenceState": "Destroyed",
            "accessNumber": "+991117",
            "language": "zh-CN",
            "passwordEntry": [
                {
                    "conferenceRole": "general",
                    "password": "******"
                }
            ],
            "userUUID": "ff8080816a024f05016a4e2342480a60",
            "scheduserName": "test008",
            "multiStreamFlag": 1,
            "conferenceType": 0,
            "confType": "IMMEDIATELY",
            "isAutoMute": 1,
            "isAutoRecord": 0,
            "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914085971/40300b325ad71ad1ff2c1dbdda1250328ccd8ec9ff45bd03",
            "recordType": 2,
            "recordAuxStream": 0,
            "recordAuthType": 0,
            "confConfigInfo": {
                "prolongLength": 15,
                "isGuestFreePwd": false,
                "isSendNotify": true,
                "isSendSms": true,
                "isAutoMute": true,
                "isSendCalendar": true,
                "callInRestriction": 0,
                "allowGuestStartConf": true,
                "isHardTerminalAutoMute": true,
                "enableWaitingRoom": true
            },
            "vmrFlag": 0,
            "scheduleVmr": false,
            "isHasRecordFile": false,
            "partAttendeeInfo": [
                {
                    "phone": "+99111****380",
                    "name": "user8002",
                    "type": "normal"
                }
            ],
            "terminlCount": 0,
            "normalCount": 1,
            "deptName": "wangyue",
            "confUUID": "6d2a6cd90a5b11eaa5e8f14973e50d03"
        }
    ],
    "offset": 0,
    "limit": 20,
    "count": 3
}

错误码

当您使用华为云会议服务端API时,如果遇到“MMC”或者“USG”开头的错误码,请参考华为云API错误中心

CURL命令示例

curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' 'https://api.meeting.huaweicloud.com/v1/mmc/management/conferences/history?startDate=1574092800000&endDate=1574179199999'
分享:

    相关文档

    相关产品