华为云用户手册

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header Access Token。通过执行App ID鉴权接口返回的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 app_name 是 String Body 企业应用名称 description 否 String Body 企业应用描述

请求示例 POST https://{endpoint}/v1/mmc/cqs/media/qos?conferenceid=969271421&appid=605876aefa163e971ba21f8a40097b51&confuuid=cabcf4ec031749f594cdfc26bf0dba9e{ "users": [ { "pid": "913e3ce2345e11ef8dec5f2fea0eff1a", "accessMediaType": "MGR" } ]}

响应示例 状态码： 200 { "returnCode": 0, "returnDesc": "Success", "qosList": [ { "participantID": "913e3ce2345e11ef8dec5f2fea0eff1a", "netRate": "5", "bandWidthUp": 98, "bandWidthDown": 0, "lostPacketRateUp": 0, "lostPacketRateDown": 0, "delay": 77, "videoQos": { "upList": [], "downList": [] }, "audioQos": { "upList": [ { "codecType": "OPUS", "bandWidth": 81, "lostPacketRate": 0, "delay": 77, "jitter": 10, "resolutionHeight": 0, "resolutionWidth": 0, "frameRate": 0 } ], "downList": [] }, "auxQos": { "upList": [ { "codecType": "H.265", "bandWidth": 17, "lostPacketRate": 0, "delay": 121, "jitter": 11, "resolutionHeight": 0, "resolutionWidth": 0, "frameRate": 2, "codecUserId": "913e3ce2345e11ef8dec5f2fea0eff1a" } ], "downList": [] } } ]}

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMTContent-Type: application/json;charset=UTF-8Content-Length: 2450Connection: keep-aliveExpires: 0Pragma: No-cacheCache-Control: no-cachehttp_proxy_id: 6fba0eff9f832b463580fb06c5b0ff9cServer: api-gatewayX-Request-Id: ac9f75ec3c97c823f128526a924532b2{ "data": [ { "conferenceID": "914083136", "mediaTypes": "Data,Video,Voice", "subject": "user01的会议", "size": 1, "timeZoneID": "56", "startTime": "2019-12-18 07:28", "endTime": "2019-12-18 09:28", "conferenceState": "Created", "accessNumber": "+991117", "language": "zh-CN", "passwordEntry": [ { "conferenceRole": "chair", "password": "******" }, { "conferenceRole": "general", "password": "******" } ], "userUUID": "ff808081699b56cb0169be103500012b", "scheduserName": "user8002", "multiStreamFlag": 1, "conferenceType": 0, "confType": "IMMEDIATELY", "isAutoMute": 1, "isAutoRecord": 0, "chairJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083136/6a30b8b5a325105da031442627828e496f91021ece36405f", "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083136/9505dc3349228b1ce0db8165590cc977bcff89785130fe0d", "recordType": 0, "recordAuxStream": 0, "confConfigInfo": { "isSendNotify": true, "isSendSms": true, "isAutoMute": true }, "vmrFlag": 0, "scheduleVmr": false, "isHasRecordFile": false, "partAttendeeInfo": [ { "phone": "+99111*****815", "name": "user01", "role": 0, "isMute": 0, "type": "normal" } ], "terminlCount": 0, "normalCount": 1, "deptName": "wangyue", "confUUID": "050c7898216811eaa6958bf3bb9ac167" } ], "offset": 0, "limit": 20, "count": 1}

请求消息示例 GET /v1/mmc/management/conferencesConnection: keep-aliveX-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjCuser-agent: WeLink -desktopHost: api.meeting.huaweicloud.comUser-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

请求消息示例 PUT /v1/mmc/control/conferences/participants/role?conferenceID=914083136&participantID=d2c3ae64216e11eabc510dc9b62e3a80Connection: keep-aliveX-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfbContent-Type: application/jsonuser-agent: WeLink-desktopContent-Length: 22Host: api.meeting.huaweicloud.comUser-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191){ "applyChair": 1, "chairmanPwd": "******"}

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 userUUID 否 String Query 用户的UUID。 说明： 仅管理员有权限查询本企业其他用户的会议列表；普通账号该字段无效，只能查询自己的。 offset 否 Integer Query 查询偏移量。默认为0。 limit 否 Integer Query 查询数量。默认是20，最大500条。 queryAll 否 Boolean Query 是否查询企业下所有用户的会议记录。默认值为false。 true：查询所有用户的会议 false：仅查询管理员自己创建的会议 说明： 仅对企业管理员生效。 searchKey 否 String Query 查询条件 。会议主题、会议预约人和会议ID等可作为搜索内容。长度限制为1-128个字符。 queryConfMode 否 String Query 查询时间范围。 ADAY：一天 AWEEK：一周 AMONTH：一个月 ALL：查询所有 sortType 否 String Query 查询结果排序。 ASC_StartTIME：按会议开始时间升序排序 DSC_StartTIME：按会议开始时间降序排序 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Authorization-Type 否 String Header 标识是否为第三方portal过来的请求。 说明： 该参数将废弃，请勿使用。 X-Site-Id 否 String Header 用于区分到哪个H CS O站点鉴权。 说明： 该参数将废弃，请勿使用。

响应消息示例 HTTP/1.1 200Date: Wed, 18 Dec 2019 06:20:40 GMTContent-Type: application/json;charset=UTF-8Content-Length: 39Connection: keep-alivehttp_proxy_id: 8e6fe9e1d0a45e33398f426a227e855aServer: api-gatewayX-Request-Id: 8957e54c2881f52125edd6439995fbf7

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"applyChair":0}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/participants/role?conferenceID=914083136&participantID=d2c3ae64216e11eabc510dc9b62e3a80

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMTContent-Type: application/json;charset=UTF-8Content-Length: 39Connection: keep-alivehttp_proxy_id: 81e59ca1730e459417bf8b6c5376ecfaServer: api-gatewayX-Request-Id: 2a40022a27536e9fbf3dba3dc7d4d443

请求消息示例 PUT /v1/mmc/control/conferences/lock?conferenceID=914083136Connection: keep-aliveX-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfbContent-Type: application/jsonContent-Length: 20Host: api.meeting.huaweicloud.comUser-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191){ "isLock":1}

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"isLock": 1}' 'https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/lock?conferenceID=914083136'

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 participantID 是 String Query 与会者标识。 X-Conference-Authorization 是 String Header 会控Token，通过获取会控token接口获得。 applyChair 是 Integer Body 1：申请主持人 0：释放主持人 chairmanPwd 否 String Body 当申请主持人时，携带主持人密码。

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 说明： 创建会议时返回的conferenceID。不是vmrConferenceID。 offset 否 Integer Query 查询偏移量。默认为0。针对PageParticipant 中的与会者分页。 limit 否 Integer Query 查询数量。默认值20。 searchKey 否 String Query 查询条件。长度限制为1-128个字符。 userUUID 否 String Query 用户的UUID。 说明： 该参数将废弃，请勿使用。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Type 否 Integer Header 默认值为0。 0：不区分终端和与会人 1：分页查询区分终端和与会人，结果合并返回 2：单独查询终端和与会人，结果单独返回 X-Query-Type 否 Integer Header 当“X-Type”为“2”时，该字段有效。默认值为0。 0：查询与会人 1：查询终端 X-Authorization-Type 否 String Header 标识是否为第三方portal过来的请求。 说明： 该参数将废弃，请勿使用。 X-Site-Id 否 String Header 用于区分到哪个HCSO站点鉴权。 说明： 该参数将废弃，请勿使用。

请求消息示例 GET /v1/mmc/management/conferences/online/confDetail?conferenceID=914083136Connection: keep-aliveX-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjCuser-agent: WeLink-desktopHost: api.meeting.huaweicloud.comUser-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

响应消息示例 HTTP/1.1 200Date: Wed, 18 Dec 2019 06:20:40 GMTContent-Type: application/json;charset=UTF-8Content-Length: 1394Connection: keep-aliveExpires: 0Pragma: No-cacheCache-Control: no-cachehttp_proxy_id: 1e4af24ea29c6641dd73e3a6a027f007Server: api-gatewayX-Request-Id: 696def7842d59349fd7e33319dce3e21{ "conferenceData": { "conferenceID": "914083136", "mediaTypes": "Voice,Data,Video", "subject": "user01的会议", "size": 1, "timeZoneID": "56", "startTime": "2019-12-18 07:28", "endTime": "2019-12-18 09:28", "conferenceState": "Created", "accessNumber": "+991117", "language": "zh-CN", "passwordEntry": [ { "conferenceRole": "chair", "password": "******" }, { "conferenceRole": "general", "password": "******" } ], "userUUID": "ff808081699b56cb0169be103500012b", "scheduserName": "user8002", "multiStreamFlag": 1, "conferenceType": 0, "confType": "IMMEDIATELY", "isAutoMute": 1, "isAutoRecord": 0, "chairJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083136/6a30b8b5a325105da031442627828e496f91021ece36405f", "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083136/9505dc3349228b1ce0db8165590cc977bcff89785130fe0d", "recordType": 0, "recordAuxStream": 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****815", "name": "user01", "type": "normal" } ], "terminlCount": 0, "normalCount": 1, "deptName": "wangyue", "confUUID": "050c7898216811eaa6958bf3bb9ac167" }, "data": { "offset": 0, "limit": 20, "count": 1, "data": [ { "participantID": "+991116003815", "name": "user01", "role": 0, "state": "MEETTING", "attendeeType": "normal", "accountId": "user01" } ] }}

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 X-Conference-Authorization 是 String Header 会控Token，通过获取会控token接口获得。 viewType 是 Integer Body 主持人观看的画面类型。 0： 主持人轮询 1： 主持人观看多画面 2： 主持人选看会场 participantID 否 String Body 被主持人选看的会场。 当为主持人选看会场时为必填参数。 switchTime 否 Integer Body 轮询间隔，单位：秒。主持人轮询时，必填字段。 范围:[10-120]，默认值：10。 status 否 Integer Body 启动/停止轮询。主持人轮询时，必填字段。 0： 停止轮询 1： 启动轮询

请求消息示例 PUT /v1/mmc/control/conferences/chairView?conferenceID=914083136Connection: keep-aliveX-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfbcontent-type: application/jsonuser-agent: WeLink-desktopHost: api.meeting.huaweicloud.comUser-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191){"viewType":0}

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"viewType":0,"switchTime":"30","status":1}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/chairView?conferenceID=914083136

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMTContent-Type: application/json;charset=UTF-8Content-Length: 39Connection: keep-aliveExpires: 0Pragma: No-cacheCache-Control: no-cachehttp_proxy_id: 571b4dfceff545fae29aa14cea761079Server: api-gatewayX-Request-Id: f78b007ec2dabf1498620131c7bc19e0

响应消息示例 响应示例（普通会议） HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMTContent-Type: application/json;charset=UTF-8Content-Length: 1811Connection: keep-aliveExpires: 0Pragma: No-cacheCache-Control: no-cachehttp_proxy_id: acf5bd2cc7c7f90fe7ab6b95a8c753d5Server: api-gatewayX-Request-Id: e2bc0a1429cb2fd52db88ba6fa2c44a8{ "conferenceData": { "conferenceID": "914083136", "mediaTypes": "Voice,Data,Video", "subject": "user01的会议", "size": 1, "timeZoneID": "56", "startTime": "2019-12-18 07:28", "endTime": "2019-12-18 09:28", "conferenceState": "Created", "accessNumber": "+991117", "language": "zh-CN", "passwordEntry": [ { "conferenceRole": "chair", "password": "******" }, { "conferenceRole": "general", "password": "******" } ], "userUUID": "ff808081699b56cb0169be103500012b", "scheduserName": "user8002", "multiStreamFlag": 1, "conferenceType": 0, "confType": "IMMEDIATELY", "isAutoMute": 1, "isAutoRecord": 0, "chairJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083136/6a30b8b5a325105da031442627828e496f91021ece36405f", "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083136/9505dc3349228b1ce0db8165590cc977bcff89785130fe0d", "recordType": 0, "recordAuxStream": 0, "confConfigInfo": { "isSendNotify": true, "isSendSms": true, "isAutoMute": true }, "vmrFlag": 0, "scheduleVmr": false, "isHasRecordFile": false, "partAttendeeInfo": [ { "phone": "+99111****815", "name": "user01", "type": "normal" } ], "terminlCount": 0, "normalCount": 1, "deptName": "wangyue", "confUUID": "050c7898216811eaa6958bf3bb9ac167" }, "data": { "offset": 0, "limit": 20, "count": 1, "data": [ { "participantID": "+991116003815", "name": "user01", "role": 0, "state": "MEETTING", "attendeeType": "normal", "accountId": "user01" } ] }}

请求消息示例 请求示例（普通会议） GET /v1/mmc/management/conferences/confDetail?conferenceID=914083136Connection: keep-aliveX-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjCuser-agent: WeLink-desktopHost: api.meeting.huaweicloud.comUser-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

请求参数 表1 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 说明： 创建会议时返回的conferenceID。不是vmrConferenceID。 offset 否 Integer Query 查询偏移量。默认为0。针对PageParticipant 中的与会者分页。 limit 否 Integer Query 查询数量。默认值20。 searchKey 否 String Query 查询条件。长度限制为1-128个字符。 userUUID 否 String Query 用户的UUID。 说明： 该参数将废弃，请勿使用。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Type 否 Integer Header 默认值为0。 0：不区分终端和与会人 1：分页查询区分终端和与会人，结果合并返回 2：单独查询终端和与会人，结果单独返回 X-Query-Type 否 Integer Header 当“X-Type”“2”时，有效。默认为0。 0：查询与会人 1：查询终端 X-Authorization-Type 否 String Header 标识是否为第三方portal过来的请求。 说明： 该参数将废弃，请勿使用。 X-Site-Id 否 String Header 用于区分到哪个HCSO站点鉴权。 说明： 该参数将废弃，请勿使用。

响应参数 表3 响应参数 参数 类型 描述 conferenceData ConferenceInfo object 会议信息。 data PageParticipant object 与会者列表。 表4 PageParticipant 数据结构 参数 类型 描述 limit Integer 每页的记录数。 count Integer 总记录数。 offset Integer 查询偏移量。 data Array of ParticipantInfo objects 被邀请的与会者信息。包含预约会议时邀请的与会者和会中主持人邀请的与会者。 说明： 不返回会中主动加入的与会者信息。 表5 ParticipantInfo 数据结构 参数 类型 描述 participantID String 与会者的号码。 name String 与会者的名称。 subscriberID String 与会者的号码（预留字段）。 role Integer 与会者的角色。 1：会议主持人 0：普通与会者 state String 用户状态。目前固定返回MEETTING。 address String 终端所在会议室信息（预留字段）。 attendeeType String 与会者终端类型。 “normal”：软终端。 “terminal”：会议室或硬终端。 “outside”：外部与会人。 “mobile”：用户手机号码。 accountId String 与会者的账号。 如果是账号/密码鉴权场景，表示华为云会议账号 如果是APP ID鉴权场景，表示第三方的User ID phone2 String 预留字段。 phone3 String 预留字段。 email String 邮件地址。 sms String 短信通知的手机号码。 deptName String 部门名称。 userUUID String 预订者的用户UUID。 appId String App ID。参考“App ID的申请”。 isAutoInvite Integer 会议开始时是否自动邀请该与会者。默认值由企业级配置决定。 0： 不自动邀请 1： 自动邀请 说明： 仅对并发会议资源的随机会议ID的会议生效。 isNotOverlayPidName Boolean 是否不叠加会场名（VDC场景下适用）。 true：不叠加 false：叠加

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 contact 是 String Body 后台自动识别是手机号还是邮箱。 如果为手机号，必须加上国家码，例如中国大陆手机为“+86xxxxxxxxxxx”，当填写手机号时 “country”参数必填。 maxLength：255 minLength：1 country 否 String Body 手机号所属的国家。 默认值：chinaPR。 长度：0-255。 verificationCode 否 String Body 验证码，在校验的场景时需要携带。

请求消息示例 POST /v1/usg/dcs/member/verification-code/verifyConnection: keep-aliveX-Access-Token: stb3te1tKXh5mDfICbiSOP0GOoqwkWEDgfB9Content-Type: application/jsonContent-Length: 68Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191){ "contact": "+86136********", "country": "chinaPR", "verificationCode": "753927"}

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMTContent-Type: application/json;charset=UTF-8Content-Length: 143Connection: keep-alivePragma: No-cacheCache-Control: no-cacheServer: api-gatewayX-Request-Id: eed03de09b96dec5643adbbb55acf674

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stb3te1tKXh5mDfICbiSOP0GOoqwkWEDgfB9' -d '{"contact": "+86136********","country": "chinaPR","verificationCode": "753927"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/member/verification-code/verify

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 deptCode 否 String Body 部门编码，企业内唯一，若携带则以携带为准，不支持修改。 maxLength：32 deptName 是 String Body 部门名称。 maxLength：128 minLength：1 parentDeptCode 否 String Body 父部门编码，默认为根部门。 默认值：1 maxLength：32 note 否 String Body 备注。 maxLength：96 minLength：0 inPermission 否 String Body 其他用户对该部门下用户的访问权限。 UNLIMITED：默认，不做限制 OPEN：公开，其他部门都可访问（无论对方权限如何配置） outPermission 否 String Body 该部门下用户访问权限控制。 UNLIMITED：不限制 ONLY_SELF：仅能查询自己 SELF_AND_CHILD_DEPARTMENT：该部门下用户能查询本部门及子部门通讯录 DESIGNATED_DEPARTMENT：该部门下用户能查询指定部门通讯录 designatedOutDeptCodes 否 Array of strings Body 允许访问的部门列表，仅outPermission为DESIGNATED_DEPARTMENT时有效，最多支持配置150个部门。 sortLevel 否 Integer Body 部门排序号，序号越小，部门排序越靠前。 minimum: 1 maximum: 10000

请求消息示例 POST /v1/usg/dcs/corp/deptConnection: keep-aliveX-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlkiContent-Type: application/jsonContent-Length: 31Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "deptName": "test999"}