智慧服务,成就美好体验 项目咨询

主页 > 服务与支持 > 开发平台 > 服务端API参考 > 会议管理 > 接口参考 修改预约会议

入门使用

修改预约会议

更新时间:2019-11-19

描述

管理员或普通用户可以通过该接口修改预约会议。会议开始时,不能修改会议。

接口原型

表1 接口原型

请求方法

PUT

请求地址

/conferences/{conferenceid}

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

conferenceid

String

URL

会议标识。

Authorization

String

Header

授权令牌。将执行鉴权响应的accessToken

进行Base64转码操作

样例:Basic Base64(accessToken)

startTime

String

Body

会议开始时间。使用UTC时间。修改预约会议时,如果没有指定开始时间或填空串,则表示会议马上开始。

格式:YYYY-MM-DD HH:MM

length

Int

Body

会议持续时长。单位分钟,最长“1440”

默认值为“30”

subject

String

Body

会议主题。长度限制为128个字符。

mediaTypes

String

Body

会议的媒体类型。

由1个或多个枚举String组成,多个枚举时,每个枚举值之间通过”,”逗号分隔。

  • “Voice”:语音
  • “Video”:标清视频
  • “HDVideo”:高清视频(与“Video”互斥,如果同时选择“Video”“HDVideo”,则系统默认选择“Video”
  • “Telepresence”:智真(与“HDVideo”“Video”互斥,如果同时选择,系统使用“Telepresence”)(预留字段)
  • “Data”:多媒体(AS会根据系统配置决定是否自动添加Data)

attendees

Attendee[0..*]

Body

预定会议时,指定的与会者列表。

该与会者列表可以用于发送会议通知、会议提醒、会议开始时候进行自动邀请。

conferenceType

Int

Body

  • 0 : 普通会议,或者周期会议的子会议
  • 1 : 周期会议,此时“cycleParams”必须填写。

默认值为“0”

注:周期会议为预留字段。

cycleParams

有条件必选

CycleParams

Body

周期会议的参数。当会议是周期会议的时候该参数必须填写,否则服务器忽略该参数。

该参数包括周期会议的开始日期、结束日期、会议的周期和周期中的开会时间点。

(预留字段)

isAutoRecord

Int

Body

会议是否自动启动录制。该参数只有“recordType”“1”“2”“3”的情况才生效。

  • 1 :自动启动录制
  • 0 :不自动启动录制

默认值为“0”

encryptMode

Int

Body

会议媒体加密模式。

  • 0 : auto——自适应加密。
  • 1 : must——强制加密。
  • 2 : 不出现——不加密。

language

String

Body

会议的默认语言。默认值由会议AS定义。

对于系统支持的语言,按照RFC3066规范传递,取值如下:

  • zh-CN:简体中文。
  • en-US:美国英文。

timeZoneID

String

Body

开始时间的时区信息。

时区信息,参考时区映射关系

recordType

Int

Body

录播类型。

  • 0: 禁用 。
  • 1: 直播 。
  • 2: 录播 。
  • 3: 直播+录播。

liveChannelID

String

Body

直播推流频道ID,召开会议时,优先根据此ID查询频道的URL,查询不到则放弃推流;若不存在频道ID则直接使用liveAddress/ auxAddress两个URL。

liveAddress

String

Body

主流直播地址。

auxAddress

String

Body

辅流直播地址。

recordAuxStream

Int

Body

是否录制辅流。

  • 0:否。
  • 1:是。

confConfigInfo

ConfConfigInfo

Body

会议其他配置信息,用于其他会议配置参数。

后续新增的会议配置参数都在该结构中定义。

vmrFlag

Int

Body

是否使用VMR召开预约会议。

  • 0:不使用VMR。
  • 1:使用个人VMR。

vmrID

String

Body

用于识别用户开会时绑定的VMR会议室。

  • 不为空,则用ID查询VMR信息。
  • 为空,则查用户所有VMR,如果有个人VMR,用个人VMRID;没有个人VMR,取最小VMRID。

响应参数

表3 参数说明

参数

类型

描述

returnCode

Int

返回码。

returnDesc

String

返回描述。

data

ConferenceInfo[0..1]

会议信息。

请求消息示例

PUT /conferences/914038025
Connection: keep-alive
Authorization: Basic VFZQdG9tOUcwN2NMWGhMQ1phaXpRUDFsNkdlUzVvT05Q
Content-Type: application/json
user-agent: WeLink-desktop
Content-Length: 372
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
    "mediaTypes": "Voice,Video",
    "attendees": [
    {
        "name": "user01",
        "role": 1,
        "phone": "+8657********"
    }],
    "conferenceType": 0,
    "subject": "user01的会议"
}
 

响应消息示例

 

HTTP/1.1 200 
Date: Sat, 09 Mar 2019 07:12:49 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 1157
Connection: keep-alive
http_proxy_id: 462abfcfa8a41c2c5450eb7648bf5ad2
Server: api-gateway
X-Request-Id: 7ba6f742610c03a64262b126fb336a5d

{
    "returnCode": 0,
    "returnDesc": "Success",
    "data": [
    {
        "conferenceID": "914038025",
        "mediaTypes": "Voice,Data,Video",
        "subject": "user01的会议",
        "size": 1,
        "timeZoneID": "56",
        "startTime": "2019-03-10 08:04",
        "endTime": "2019-03-10 10:04",
        "conferenceState": "Schedule",
        "accessNumber": "+8657*******",
        "language": "zh-CN",
        "passwordEntry": [
        {
            "conferenceRole": "chair",
            "password": "222400"
        },
        {
            "conferenceRole": "general",
            "password": "896775"
        }],
        "userUUID": "ff8080816933ab4801694865840a00c2",
        "scheduserName": "user01",
        "multiStreamFlag": 1,
        "conferenceType": 0,
        "isAutoMute": 1,
        "isAutoRecord": 0,
        "chairJoinUri": "https://nmeeting.huaweicloud.com:38443/portal/j/914038025?p=26da22e56f444f8a3dc8746044d3bb8c2ded32a30b9325fd",
        "guestJoinUri": "https://nmeeting.huaweicloud.com:38443/portal/j/914038025?p=a21f8457701e3ee0a521b38f40591cebafc5450e94278930",
        "recordType": 0,
        "recordAuxStream": 0,
        "confConfigInfo": 
        {
            "inviteMode": "AUTO_INVITE",
            "prolongLength": 15,
            "dispatchMode": "AUTO_DISPATCH",
            "isGuestFreePwd": false,
            "isSendNotify": true,
            "isSendSms": true,
            "isAutoMute": true
        },
        "vmrFlag": 0,
        "scheduleVmr": false,
        "isHasRecordFile": false,
        "partAttendeeInfo": [
        {
            "phone": "+8657*******",
            "name": "user01",
            "role": 1,
            "isMute": 0,
            "type": "normal"
        }],
        "terminlCount": 0,
        "normalCount": 0,
        "deptName": "huawei_ffl ",
        "confUUID": "19d6009f67fe11e9b78bbf16aed73b3c"
    }]
}
 

CURL命令示例

curl -k -i -H 'content-type: application/json' -X PUT -H 'Authorization:Basic UHg4SmRpY3N3OERIRjN1UDE4Z0hHNlBGN2wzdDE3OWJv' -d '{"mediaTypes": "Voice","attendees": [{"name": "user02","role": 1,"phone": "+8657*******"}],"conferenceType": "0","subject": "user02 conference"}' 'https://api.meeting.huaweicloud.com/conferences/914007318'