API概述 本文档主要介绍华为云会议服务对外开放的RESTful API,开发者可通过这些API将华为云会议的音视频会议功能集成到自己的业务系统中。
设置打点日志上传开关 接口描述 调用此接口,可以设置是否将打点日志上传到服务端。 1、该接口在入会前和入会中均可设置。 2、如果不调用该接口,默认上传打点日志到服务端。
设置会场名 接口功能 该接口用于设置会场名。 函数原型 renameSelf(renameSelfInfo: RenameSelfInfo, onRenameSelfResult?: (ret: SDKERR, reason: string) => void): void 请求参数
显示会议窗口 接口功能 当会议主窗口处于最小化或者被其他窗口覆盖时,使用该接口将会议主窗口拉到最上层。一般用于从会议列表中拉起正在进行的会议窗口。 函数原型 showMeetingWindow(onShowMeetingWindowResult?: (ret: SDKERR, reason
初始化 接口功能 该接口用于启动并且初始化SDK。注意事项:1、调用该接口之前请先修改HwmSdk文件夹下HwmSdk.exe文件的名称;2、该接口用于启动并初始化SDK,在调用其他接口之前必须先调用该接口并等待初始化回调结果;3、每次调用初始化接口会重新启动SDK,之前所有设置与操作将不复存在
修改云会议室信息 接口功能 该接口用于修改云会议室信息。注意事项:1、该接口在已登录状态下才能调用;2、所有字段必填,调用该接口前需要获取VMR列表,不需要变更的数据请使用获取VMR列表接口返回的数据赋值。 函数原型 changeVmrInfo(vmrInfoParam: ChangeVmrInfoParam
界面配置 接口功能 该接口用于配置定制化参数,自定义会议中界面的部分元素。 函数原型 config(uiConfig: string, onConfigResult?: (ret: SDKERR, reason: string) => void): void 请求参数 表1 入参说明
设置日志保存路径 接口功能 该接口用于设置日志的保存路径。注意事项:1、该接口非必需调用,若不设置,则使用默认路径。 函数原型 setLogPath(logPathInfo: LogPathInfo, onSetLogPathResult?: (ret: SDKERR, reason
设置来电应答方式 接口功能 该接口用于设置来电应答: 原始弹框、自动拒绝或自动接听。 函数原型 setAnswerType(inComingAnswerTypeInfo: InComingAnswerTypeInfo, onSetAnswerTypeResult?: (ret: SDKERR
禁用提示音 接口功能 该接口用于禁用提示音。 函数原型 disableVoicePrompts(voicePromptsInfo: VoicePromptsInfo, onDisableVoicePromptsResult?: (ret: SDKERR, reason: string
拒绝会议邀请 接口功能 该接口用于拒绝会议邀请 函数原型 rejectConf(onRejectConfResult?: (ret: SDKERR, reason: string) => void): void 请求参数 表1 入参说明 参数名称 是否必选 参数类型 参数说明 onRejectConfResult
接受会议邀请 接口功能 该接口用于接受会议邀请 函数原型 acceptConf(acceptConfParam: AcceptConfParam, onAcceptConfResult?: (ret: SDKERR, reason: string) => void): void 请求参数
设置头像风格 接口功能 该接口用于设置头像风格。 函数原型 setAvatarStyle(avatarStyle: AvatarStyle, onSetAvatarStyleResult?: (ret: SDKERR, reason: string) => void): void
离开会议 接口功能 该接口用于离开会议。注意事项:1、不在会议中不应调用此接口;2、调用该接口离开会议,会议不会结束,在会议存在期间可以再次入会。 函数原型 leaveConf(onLeaveConfResult?: (ret: SDKERR, reason: string) =>
获取会议列表 接口功能 该接口用于获取会议列表(仅对mac平台生效)。注意事项:1、已登录状态,首次收到会议列表通知之后,调用才有效,否则返回为空的列表 函数原型 getConfList(onGetConfListResult?: (ret: SDKERR, reason: string
设置(会控)保底ip地址 接口功能 该接口用于设置(会控)保底ip地址。注意事项:1、多个地址中间用分号隔开,最多支持4个地址 函数原型 setGuaranteedIpAddresses(guaranteedIpAddresses: string): SDKERR 请求参数 表1
显示提示信息 接口功能 该接口用于显示提示信息 函数原型 showToast(toastInfo: ToastInfo, onShowToastResult?: (ret: SDKERR, reason: string) => void): void 请求参数 表1 入参说明 参数名称
加入会议 接口功能 该接口用于通过会议ID和密码加入已经存在的会议。在登录和未登录状态下都可以调用该接口。 函数原型 joinConfById(joinConfByIdInfo: JoinConfByIdInfo, onJoinConfByIdResult?: (ret: SDKERR
订阅会议列表通知 接口功能 收到该通知时,表示会议列表信息发生变更。 函数原型 setOnConfListChangedCB(onConfListChanged: (confListInfo: ConfListInfo) => void): void 请求参数 表1 入参说明 参数名称
订阅窗口句柄通知 接口功能 收到该通知时,窗口句柄信息发生变更。 函数原型 setOnRenderWindowInfoListChangedCB(onRenderWindowInfoListChanged: (hwndInfo: HwndListInfo) => void): void