# 预约会议 -------------------------------------------------------- 管理员或普通用户可以过该接口创建会议。 ### 请求格式说明 ** 调试工具:** 在线调试

请求方式: POST (HTTPS)

请求地址: https://open.welink.huaweicloud.com/api/meeting/v1/createconference?userId={userId}

认证方式: access_token,请参考获取access_token

请求头部:

Content-Type: application/json
x-wlk-Authorization: access_token

请求参数示例:

{ 
    "conferenceType":0,
    "mediaTypes":"HDVideo",
    "startTime": "2020-04-03 02:30",
    "length": 120,
    "subject":"研发技术会议",
    "attendees":
   [ 
      { 
           "name":"zhangsan",
           "accountId":"zhangsan@example",
         "role":"0",
         "phone":"+8615xxxx387xx",
         "isMute":"0"
      },
      { 
           "accountId":"lisi@example ",
         "name":" lisi",
         "role":"1",
         "phone":"+8613xxxx27xx",
         "isMute":"1"
      }
   ]   
}

请求param参数说明:

参数名 参数说明 类型 必选
必选 userId,用户帐号,如zhangsan@xxx String

请求body参数说明:

参数名 参数说明 类型 必选
conferenceType 0 : 普通会议(默认);
1 : 周期会议,此时cycleParams必须填写。
Int
startTime 会议开始时间。采用UTC时间。 会议本地的开始时间要通过startTime和timeZoneID计算得到。比如startTime为UTC 2020-03-20 02:00, timeZoneID为56,对应东八区, 则本地会议开始时间为东八区的2020-03-20 10:00。预定创建会议时,如果没有指定开始时间,或填空串,则表示会议马上开始。格式:YYYY-MM-DD HH:MM String
length 会议持续时长。单位分钟,最长1440,最短15,默认为30。 Int
subject 会议主题。长度限制为128个字符。 String
mediaTypes 会议的媒体类型。
由1个或多个枚举String组成,多个枚举时,每个枚举值之间通过”,”逗号分隔,枚举值如下:
“Voice”:语音
“Video”:标清视频
“HDVideo”:高清视频(与Video互斥,如果同时选择Video、HDVideo,则系统默认选择Video)
“Telepresence”:智真(与HDVideo、Video互斥,如果同时选择,系统使用Telepresence)。(预留字段)
“Data”:多媒体(AS会根据系统配置决定是否自动添加Data)
String
attendees 预定会议时,指定的与会者列表。该与会者列表可以用于发送会议通知、会议提醒、会议开始时候进行自动邀请。请参考RestAttendeeDTO RestAttendeeDTO [0..*]
isAutoRecord 会议是否自动启动录制,在录播类型为:录播、直播+录播时有效。1 :true:自动启动录制;0 :false:不自动启动录制。(默认) Int
encryptMode 会议媒体加密模式。0 : auto:自适应加密;1 : must:强制加密;2 : 不出现:不加密 Int
language 会议的默认语言,默认值由会议AS定义,MediaX是“zh-CN”,对于系统支持的语言,按照RFC3066规范传递。zh-CN:简体中文;en-US:美国英文 String
timeZoneID 开始时间的时区信息。时区信息参考时区映射关系 String
recordType 录播类型。0: 禁用;1: 直播;2: 录播;3: 直播+录播 Int
liveAddress 主流直播地址。最大不超过255个字符。在录播类型为 :直播、直播+录播时有效。 String
auxAddress 辅流直播地址。最大不超过255个字符。在录播类型为: 直播、直播+录播时有效。 String
recordAuxStream 是否录制辅流。在录播类型为:录播、直播+录播时有效。0:否;1:是 Int
confConfigInfo 会议其他配置信息,用于其他会议配置参数。后续新增的会议配置参数都在该结构中定义。 RestConfConfigDTO
vmrFlag 是否使用VMR召开预约会议。0:不使用VMR;1:使用VMR Int
vmrID 用于识别用户开会时绑定的VMR会议室。不为空,则用ID查询VMR信息;为空,则查用户所有VMR,如果有个人VMR,用个人;没有,取最小VMRID String

RestAttendeeDTO数据结构:

参数名 参数说明 类型 必选
accountId 与会者账号,即用户的userId String
name 与会者名称或昵称,长度限制为96个字符。 String
role 会议中的角色。1:会议主席;0:普通与会者(默认);2:单向会场(预留字段) Int
phone 号码(可支持SIP、TEL号码格式)。最大不超过127个字符。当type为telepresence时,且设备为三屏智真,则该字段填写中屏号码。(三屏智真为预留字段) String
phone2 取值类型同phone。当type为telepresence时,且设备为三屏智真,则该字段填写左屏号码。(三屏智真为预留字段) String
phone3 取值类型同phone。当type为telepresence时,且设备为三屏智真,则该字段填写右屏号码。(三屏智真为预留字段) String
email 邮件地址。最大不超过255个字符。 String
sms 短信通知的手机号码。最大不超过32个字符。 String
isAutoInvite 会议开始时是否自动邀请该与会者。0:不自动邀请;1:自动邀请(默认) Int
type 默认值由会议AS定义,号码类型枚举值如下:
“normal”:语音、高清、标清与会者地址(默认),软终端用户。
“telepresence”:智真与会者地址类型,单屏、三屏智真均属此类。(三屏智真为预留字段)
“terminal”:会议室或硬终端。
“outside”:外部与会人。
“anonymous”:匿名入会。
“mobile”:软终端用户手机。
“telephone”:软终端用户固定电话,暂不使用。
String
address 终端所在会议室信息。 String
deptName 组织名称。最大不超过128个字符。 String

RestConfConfigDTO数据结构:

参数名 参数说明 类型 必选
isGuestFreePwd 来宾是否免密。
True:免密
False:不免密
默认值由会议模板决定,适用于随机id会议。
Boolean
isSendNotify 是否需要发送会议邮件通知。
True:需要
False:不需要
默认值由会议模板决定。
Boolean
isSendSms 是否需要发送会议通知。
True:需要
False:不需要
默认值由会议模板决定。
Boolean

时区映射关系:

参数值 时区信息
1 (GMT-12:00) Eniwetok, Kwajalein
2 (GMT-11:00) Midway Island, Samoa
3 (GMT-10:00) Hawaii
4 (GMT-09:00) Alaska
5 (GMT-08:00) Pacific Time(US&Canada);Tijuana
6 (GMT-07:00) Arizona
7 (GMT-07:00) Mountain Time(US&Canada)
8 (GMT-06:00) Central America
9 (GMT-06:00) Central Time(US&Canada)
10 (GMT-06:00) Mexico City
11 (GMT-06:00) Saskatchewan
12 (GMT-05:00) Bogota, Lima, Quito
13 (GMT-05:00) Eastern Time(US&Canada)
14 (GMT-05:00) Indiana(East)
15 (GMT-04:00) Atlantic time(Canada)
16 (GMT-04:00) Caracas, La Paz
17 (GMT-04:00) Santiago
18 (GMT-03:30) Newfoundland
19 (GMT-03:00) Brasilia
20 (GMT-03:00) Buenos Aires, Georgetown
21 (GMT-03:00) Greenland
22 (GMT-02:00) Mid-Atlantic
23 (GMT-01:00) Azores
24 (GMT-01:00) Cape Verde Is.
25 (GMT) Casablanca, Monrovia
26 (GMT) Greenwich Mean Time:Dublin, Edinburgh, Lisbon, London
27 (GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna
28 (GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague
29 (GMT+01:00) Brussels, Copenhagen, Madrid, Paris
30 (GMT+01:00) Sarajevo, Skopje, Sofija, Warsaw, Zagreb
31 (GMT+01:00) West Central Africa
32 (GMT+02:00) Athens, Vilnius
33 (GMT+02:00) Bucharest
34 (GMT+02:00) Cairo
35 (GMT+02:00) Harare, Pretoria
36 (GMT+02:00) Helsinki, Riga, Tallinn
37 (GMT+02:00) Jerusalem
38 (GMT+03:00) Baghdad, Minsk
39 (GMT+03:00) Kuwait, Riyadh
40 (GMT+03:00) Moscow, St. Petersburg
41 (GMT+03:00) Nairobi, Istanbul
42 (GMT+03:30) Tehran
43 (GMT+04:00) Abu Dhabi, Muscat, Volgograd
44 (GMT+04:00) Baku, Tbilisi, Yerevan
45 (GMT+04:30) Kabul
46 (GMT+05:00) Ekaterinburg
47 (GMT+05:00) Islamabad, Karachi, Tashkent
48 (GMT+05:30) Calcutta, Chennai, Mumbai, New Delhi
49 (GMT+05:45) Kathmandu
50 (GMT+06:00) Almaty
51 (GMT+06:00) Astana, Dhaka
52 (GMT+05:30) Sri Jayawardenepura
53 (GMT+06:30) Rangoon
54 (GMT+07:00) Bangkok, Hanoi, Jakarta
55 (GMT+07:00) Novosibirsk, Krasnoyarsk
56 (GMT+08:00) Beijing, Chongqing, Hong Kong, Urumqi, Taipei
57 (GMT+08:00) Ulaan Bataar
58 (GMT+08:00) Kuala Lumpur, Singapore
59 (GMT+08:00) Perth
60 (GMT+09:00) Osaka, Sapporo, Tokyo
61 (GMT+09:00) Seoul
62 (GMT+09:00) Yakutsk
63 (GMT+09:30) Adelaide
64 (GMT+09:30) Darwin
65 (GMT+10:00) Brisbane
66 (GMT+10:00) Canberra, Melbourne, Sydney
67 (GMT+10:00) Guam, Port Moresby
68 (GMT+10:00) Hobart
69 (GMT+10:00) Vladivostok
70 (GMT+11:00) Magadan, Solomon Is., New Caledonia
71 (GMT+12:00) Auckland, Welington
72 (GMT+12:00) Fiji
73 (GMT+13:00) Nuku'alofa
74 (GMT+08:00) Irkutsk
75 (GMT) Casablanca
76 (GMT+04:00) Baku
77 (GMT+12:00) Kamchatka, Marshall Is.

请求示例:

curl -X POST \
  'https://open.welink.huaweicloud.com/api/meeting/v1/createconference?userId=zhangshan@example' \
  -H 'Content-Type: application/json' \
  -H 'x-wlk-Authorization: access_token' \
  -d '{"请求参数 json格式"}'

响应格式说明

返回结果示例:

{
    "code": "0",
    "message": "Success",
    "data": [
              {
                "conferenceID": "914266362",
                "mediaTypes": "Data,Voice,HDVideo",
                "subject": "研发技术会议",
                "size": 2,
                "timeZoneID": "56",
                "startTime": "2020-04-03 02:30",
                "endTime": "2020-04-03 04:30",
                "conferenceState": "Schedule",
                "accessNumber": "+991117",
                "language": "zh-CN",
                "passwordEntry": 
                    [
                      {
                        "conferenceRole": "chair",
                        "password": "936755"
                      },
                      {
                        "conferenceRole": "general",
                        "password": "22xxxx"
                      }
                    ],
                "userId": "zhangshan@example",
                "scheduserName": " zhangshan ",
                "multiStreamFlag": 1,
                "conferenceType": 0,
                "confType": "FUTURE",
                "isAutoMute": 1,
                "isAutoRecord": 0,
                "chairJoinUri": "https://bmeeting.huaweicloud.com:36443/#/j/914266362/8f466b3748e64c9019deaad388209046cc0388eaaa06d0d6",
                "guestJoinUri": "https://bmeeting.huaweicloud.com:36443/#/j/914266362/7875d825c195715ac073db2749c4ebf57ddf5a7b00fd6d2a",
                "recordType": 0,
                "recordAuxStream": 0,
                "confConfigInfo": 
                    {
                        "inviteMode": "AUTO_INVITE",
                        "prolongLength": 15,
                        "dispatchMode": "AUTO_DISPATCH",
                        "isGuestFreePwd": false,
                        "isSendNotify": true,
                        "isSendSms": true,
                        "isSendCalendar": true,
                        "isAutoMute": true
                    },
                "vmrFlag": 0,
                "scheduleVmr": false,
                "isHasRecordFile": false,
                "terminlCount": 0,
                "normalCount": 2,
                "deptName": "XXXX有限公司"
              }
            ]
}

返回参数说明:

参数名 必选 类型 参数说明
code string 数据正常返回“0”,如果发生错误,会返回对应的错误码
message string 返回信息,包括接口请求发生错误时的详细信息
data ConferenceInfo [0..1] 会议信息,见ConferenceInfo数据结构:

ConferenceInfo数据结构:

参数名 必选 类型 参数说明
conferenceId String 会议ID,长度限制为不超过32个字符。
subject String 会议主题,长度限制为128个字符。
size Integer 会议方数。
timeZoneID String 时区映射关系
startTime String 会议起始时间 (YYYY-MM-DD HH:MM )
endTime String 会议结束时间 (YYYY-MM-DD HH:MM )
mediaTypes String 会议的媒体类型。由1个或多个枚举String组成,多个枚举时,每个枚举值之间通过”,”逗号分隔,枚举值如下:
“Voice”:语音
“Video”:标清视频
“HDVideo”:高清视频(与Video互斥,如果同时选择Video、HDVideo,则系统默认选择Video)
“Telepresence”:智真(与HDVideo、Video互斥,如果同时选择,系统使用Telepresence)。(预留字段)
“Data”:多媒体
conferenceState String ConferenceState是一个枚举的String:
“Schedule”:预定状态
“Creating”:正在创建状态
“Created”:会议已经被创建,并正在召开
“Destroyed”:会议已经关闭
目前只会返回Created状态,会议预约没有召开也是该状态。
language String 会议语言
accessNumber String 会议接入码
passwordEntry PasswordEntry[0..*] 会议密码条目。预订者返回主席密码和来宾密码:主席查询时返回主席密码;来宾查询时返回来宾密码。见表PasswordEntry数据结构:
userId String 会议预订者帐号
scheduserName String 会议预订者账号名称,长度最大限制为96个字符。
deptName String 会议预订者的组织名称。最大不超过96个字符。
multiStreamFlag int 标识是否为多流视频会议。
0:单流会议
1:多流会议
conferenceType int 0 : 普通会议
1 : 周期会议,此时cycleParams必须填写
isAutoMute int 是否入会自动闭音。
isAutoRecord int 是否自动开启录音。
chairJoinUri String 主席会议链接地址。
guestJoinUri String 普通与会者会议链接地址。
recordType int 录播类型。0: 禁用;1: 直播;2: 录播;3: 直播+录播
auxAddress String 辅流直播地址
liveAddress String 主流直播地址
recordAuxStream int 是否录制辅流。0:否;1:是
liveUrl String 直播播放地址
confConfigInfo RestConfConfigDTO 会议其他配置信息
confUUID String 会议的UUID(一个预约会议可能召开多次,对应多个历史会议,所以0531后的版本不再使用该字段查询历史会议详情)
isHasRecordFile boolean True:有录播文件
False:没有录播文件(默认)
partAttendeeInfo RestAttendeeDTO [0..*] 部分与会方信息,硬件终端/与会人最多各显示20条记录。见RestAttendeeDTO
terminlCount Int 硬终端个数
normalCount Int 普通终端个数

PasswordEntry数据结构:

参数名 必选 类型 参数说明
conferenceRole String 会议角色。
“chair”:会议主席
“general”:普通与会者
“audience”:旁听会场(预留字段)
password String 会议中角色的密码,明文。

结果。 ""

    无结果。 ""