更新时间:2024-04-29 GMT+08:00

创建周期性会议

描述

该接口用于预约周期性会议。

调试

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

接口原型

表1 接口原型

请求方法

POST

请求地址

/v1/mmc/management/cycleconferences

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

userUUID

String

Query

用户的UUID。

说明:

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

X-Access-Token

String

Header

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

X-Authorization-Type

String

Header

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

说明:

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

X-Site-Id

String

Header

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

说明:

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

startTime

String

Body

会议开始时间(UTC时间)。格式:yyyy-MM-dd HH:mm。

说明:
  • 创建预约会议时,如果没有指定开始时间或填空串,则表示会议马上开始
  • 时间是UTC时间,即0时区的时间

length

Integer

Body

会议持续时长,单位分钟。默认30分钟。

最大1440分钟(24小时),最小15分钟。

subject

String

Body

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

mediaTypes

String

Body

会议的媒体类型。

  • Voice:语音会议
  • HDVideo:视频会议

groupuri

String

Body

软终端创建即时会议时在当前字段带临时群组ID,由服务器在邀请其他与会者时在或者conference-info头域中携带。 长度限制为31个字符。

attendees

Array of Attendee objects

Body

与会者列表。

cycleParams

CycleParams object

Body

周期会议的参数,当会议是周期会议的时候该参数必须填写。

isAutoRecord

Integer

Body

会议是否自动启动录制,在录播类型为:录播、录播+直播时才生效。默认为不自动启动。

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

encryptMode

Integer

Body

会议媒体加密模式。默认值由企业级的配置填充。

  • 0:自适应加密
  • 1 : 强制加密
  • 2 : 不加密

language

String

Body

会议通知短信或邮件的语言。默认中文。

  • zh-CN:中文
  • en-US:英文

timeZoneID

String

Body

会议通知中会议时间的时区信息。时区信息,参考时区映射关系

说明:
  • 举例:“timeZoneID”:"26",则通过华为云会议发送的会议通知中的时间将会标记为如“2021/11/11 星期四 00:00 - 02:00 (GMT) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。
  • startDate和endDate中的日期是timeZoneID指定时区的日期。

recordType

Integer

Body

录播类型。默认为禁用。

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

liveAddress

String

Body

主流直播推流地址,在录播类型为 :直播、直播+录播时有效。最大不超过255个字符。

auxAddress

String

Body

辅流直播推流地址,在录播类型为 :直播、直播+录播时有效。最大不超过255个字符。

recordAuxStream

Integer

Body

是否录制辅流,在录播类型为:录播、录播+直播时有效。默认只录制视频主流,不录制辅流。

  • 0:不录制
  • 1:录制

confConfigInfo

ConfConfigInfo object

Body

会议其他配置信息。

recordAuthType

Integer

Body

录播观看鉴权方式,在录播类型为:录播、直播+录播时有效。

  • 0:可通过链接观看/下载
  • 1:企业用户可观看/下载
  • 2:与会者可观看/下载

vmrFlag

Integer

Body

是否使用云会议室或者个人会议ID召开预约会议。默认0。

  • 0:不使用云会议室或者个人会议ID
  • 1:使用云会议室或者个人会议ID

vmrID

String

Body

绑定给当前创会账号的VMR ID。通过查询云会议室及个人会议ID接口获取。

说明:
  • vmrID取上述查询接口中返回的id,不是vmrId
  • 创建个人会议ID的会议时,使用vmrMode=0的VMR;创建云会议室的会议时,使用vmrMode=1的VMR

concurrentParticipants

Integer

Body

会议方数,会议最大与会人数限制。

  • 0:无限制
  • 大于0:会议最大与会人数

supportSimultaneousInterpretation

Boolean

Body

会议是否支持同声传译

  • true:支持
  • false:不支持

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常。

响应参数

表4 响应参数

参数

类型

描述

[数组元素]

Array of ConferenceInfo

会议信息列表。

表5 Subconfs 数据结构

名称

类型

描述

cycleSubConfID

string

子会议UUID。

conferenceID

string

会议ID。

mediaType

string

会议的媒体类型。

  • Voice:语音
  • Video:标清视频
  • HDVideo:高清视频
  • Data:数据

startTime

string

会议起始时间(格式:YYYY-MM-DD HH:MM)。

endTime

string

会议结束时间(格式:YYYY-MM-DD HH:MM)。

isAutoRecord

Integer

是否自动开启云录制。

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

confConfigInfo

Confconfinginfo object

周期子会议其他配置信息。

recordAuthType

Integer

观看/下载录播的鉴权方式。

  • 0: 可通过链接观看/下载
  • 1: 企业用户可观看/下载
  • 2: 与会者可观看/下载

description

string

会议描述。长度限制为200个字符。

表6 Confconfiginfo 数据结构

名称

类型

描述

callInRestriction

Integer

允许加入会议的范围。

  • 0: 所有用户
  • 2: 企业内用户
  • 3: 被邀请用户

audienceCallInRestriction

Integer

允许加入网络研讨会的观众范围。

  • 0:所有用户
  • 2:企业内用户和被邀请用户

allowGuestStartConf

Boolean

是否允许来宾启动会议。

  • true: 允许来宾启动会议
  • false: 禁止来宾启动会议
说明:

仅随机会议ID有效。

enableWaitingRoom

Boolean

是否启用等候室。

showAudienceCountInfo

ShowAudienceCountInfo object

网络研讨会观众数显示策略。

表7 ShowAudienceCountInfo 数据结构

名称

类型

描述

showAudienceMode

Integer

观众显示策略:服务端用来计算观众人数下发给客户端控制观众显示。

  • 0: 不显示
  • 1: 倍增显示与会人数。基于实时与会人数或累计与会人次(假设为N),可以再进行倍增设置。支持设置倍增倍数X和基础人数Y,设置后,显示的人数为:N*X+Y

baseAudienceCount

Integer

基础人数。范围是0~10000。

multiple

Double

倍增倍数。范围是1~10, 支持设置到小数点后1位。

请求消息示例

POST /v1/mmc/management/cycleconferences
Connection: keep-alive
X-Access-Token: cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN
Content-Type: application/json
user-agent: WeLink-desktop
Content-Length: 548
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
{
    "subject": "例行周期会议",
    "mediaTypes": "Data,Voice,HDVideo",
    "startTime": "",
    "length": 120,
    "timeZoneID": "56",
    "vmrFlag": 1,
    "vmrID": "ff80808167ef1edf0167f339533f05a8",
    "cycleParams": {
        "startDate": "2021-08-31",
        "endDate": "2021-09-02",
        "cycle": "Day",
        "interval": 1,
        "preRemindDays": 1
    },
    "attendees": [
        {
            "userUUID": "ff80808167ef1edf0167f339533d05a6",
            "name": "苏州分部",
            "email": "******",
            "sms": "+991116006724",
            "deptName": "企业协同云服务项目群",
            "role": 0,
            "phone": "+99119*****724",
            "type": "normal"
        }
    ],
    "confConfigInfo": {
        "isSendNotify": "false",
        "isSendSms": "false",
        "isSendCalendar": "false"
    },
    "recordType": 0
}

响应消息示例

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 1153
Connection: keep-alive
http_proxy_id: 79ea4d8bdb461a4b811a117f9cf3dbde
Server: api-gateway
X-Request-Id: 1ccc1d7937dd0f66067aeecb9f1df241

[
    {
        "conferenceID": "986256843",
        "mediaTypes": "HDVideo,Data,Voice",
        "subject": "例行周期会议",
        "size": 0,
        "timeZoneID": "56",
        "startTime": "2021-09-01 08:39",
        "endTime": "2021-09-01 09:09",
        "conferenceState": "Schedule",
        "accessNumber": "+86571150",
        "language": "zh-CN",
        "passwordEntry": [
            {
                "conferenceRole": "chair",
                "password": "******"
            },
            {
                "conferenceRole": "general",
                "password": "******"
            }
        ],
        "userUUID": "fe235be7aa6045b98a33f27b365cbca9",
        "scheduserName": "苏州分部",
        "multiStreamFlag": 1,
        "conferenceType": 2,
        "confType": "CYCLE",
        "cycleParams": {
            "startDate": "2021-09-01",
            "cycle": "Day",
            "endDate": "2021-09-02",
            "cycleCount": 0,
            "interval": 1,
            "preRemindDays": 1
        },
        "isAutoMute": 0,
        "isHardTerminalAutoMute": 0,
        "isSoftTerminalAutoMute": 0,
        "isAutoRecord": 0,
        "chairJoinUri": "https://100.95.188.184:443/#/j/986256843/fa4def332cb83f5b1ec74c64d0658a8570f45ad3e8d0df8c",
        "guestJoinUri": "https://100.95.188.184:443/#/j/986256843/53f55ec44263d666e8ed70594624aa10497c631a91d3b8c1",
        "recordType": 0,
        "recordAuxStream": 0,
        "recordAuthType": 2,
        "confConfigInfo": {
            "inviteMode": "AUTO_INVITE",
            "prolongLength": 15,
            "isGuestFreePwd": false,
            "isSendNotify": true,
            "isSendSms": true,
            "isSendCalendar": true,
            "isAutoMute": false,
            "isHardTerminalAutoMute": false,
            "callInRestriction": 0,
            "audienceCallInRestriction": 0,
            "allowGuestStartConf": true,
            "enableWaitingRoom": false
        },
        "vmrFlag": 0,
        "scheduleVmr": false,
        "isHasRecordFile": false,
        "terminlCount": 0,
        "normalCount": 0,
        "deptName": "corpzxytest111",
        "confMode": "RTC",
        "webinar": false,
        "concurrentParticipants": 0,
        "subConfs": [
            {
                "cycleSubConfID": "fe24d1350a3611ecbe71a328ac3ca004",
                "conferenceID": "986256843",
                "startTime": "2021-09-01 08:39",
                "endTime": "2021-09-01 09:09",
                "mediaType": "HDVideo,Data,Voice",
                "isAutoRecord": 0,
                "recordAuthType": 2,
                "confConfigInfo": {
                    "callInRestriction": 0,
                    "audienceCallInRestriction": 0,
                    "allowGuestStartConf": true,
                    "enableWaitingRoom": false
                }
            },
            {
                "cycleSubConfID": "fe24d1360a3611ecbe71fdd2c36bc8c2",
                "conferenceID": "986256843",
                "startTime": "2021-09-02 08:39",
                "endTime": "2021-09-02 09:09",
                "mediaType": "HDVideo,Data,Voice",
                "isAutoRecord": 0,
                "recordAuthType": 2,
                "confConfigInfo": {
                    "callInRestriction": 0,
                    "audienceCallInRestriction": 0,
                    "allowGuestStartConf": true,
                    "enableWaitingRoom": false
                }
            }
        ]
    }
]

错误码

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

CURL命令示例

curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token:cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN' -d '{"conferenceType": "2","subject": "user01 conference","mediaTypes": "HDVideo","attendees": [{"name": "user01","role": 1,"phone": "+8657*******"}],
"cycleParams": {"startDate": "2021-08-31","endDate": "2021-09-02","cycle": "Day","interval": 1,"preRemindDays": 1}}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/cycleconferences'