检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
状态码 状态码 描述 200 操作成功。 400 参数异常。 错误码 当您使用华为云会议服务端API时,如果遇到“MMC”或者“USG”开头的错误码,请参考华为云API错误中心。 父主题: 接口参考
登录 Login 接口描述 该接口用于登录。登录分为华为云会议账户登录和AppID登录,由authType参数决定。 注意事项 创建会议,被邀入会等功能只有在登录后才能使用,若不登录,将无法体验完整会议功能。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。
会场选看 描述 该接口用于专业会议终端(如TE系列等)选看其他与会者。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 PUT 请求地址 /v1/mmc/control/conferences/partView 传输协议 HTTPS 请求参数
注销登录 描述 该接口提供注销功能。服务器收到请求后,删除该Token。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 DELETE 请求地址 /v1/usg/acs/token 传输协议 HTTPS 请求参数 表2 参数说明 参数 是否必须
查询多画面布局 功能介绍 该接口用于查询当前会议已保存的多画面布局。 调试 您可以在API Explorer中调试该接口。 URI GET /v1/mmc/control/conferences/layOut 表1 Query参数 参数 是否必选 参数类型 描述 conferenceID
当clientType取值为非72时,同一个userId,同时最多能创建1个Token。 Token有效期是12~24小时。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 POST 请求地址 /v2/usg/acs/auth/appauth 传输协议 HTTPS 请求参数
取消预约会议 描述 该接口用于取消已预约的会议。企业管理员可以取消本企业下用户创建的会议,普通用户只能取消自己创建的会议。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 DELETE 请求地址 /v1/mmc/management/conferences
修改密码 描述 企业成员通过该接口实现用户修改密码功能,服务器收到请求,修改用户密码并返回结果。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 PUT 请求地址 /v1/usg/acs/password 传输协议 HTTPS 请求参数 表2
查询历史会议详情 描述 该接口用户查询指定历史会议的详情。管理员可以查询本企业内所有的历史会议详情,普通用户仅能查询自己创建或者被邀请的历史会议详情。 调试 您可以在API Explorer中直接运行调试该接口。 接口原型 表1 接口原型 请求方法 GET 请求地址 /v1/mm
登录 登录分为账号密码鉴权登录和App ID鉴权登录。 login:password: 接口描述 该接口用于通过账号密码鉴权登录。 注意事项 创建会议,被邀入会等功能只有在登录后才能使用,若不登录,将无法体验完整会议功能。 回调error表示错误信息,nil表示成功。 方法定义 1
EndConf 接口描述 该接口用于结束会议。 注意事项 不在会议中不应调用此接口。 调用该接口,会议将结束,无法再次加入该会议。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
锁定会议 描述 该接口用于锁定或解锁会议。锁定会议后,不允许新的来宾主动加入会议。会议锁定后使用主持人密码/主持人链接加入会议或者主持人邀请来宾不受影响。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 PUT 请求地址 /v1/mmc/
设置多画面 描述 设置会议多画面。该接口废弃不用,请使用“设置自定义多画面”接口。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 PUT 请求地址 /v1/mmc/control/conferences/display/multiPicture
退出 Exit 接口描述 用于退出SDK。 注意事项 该接口用于退出SDK,调用该接口之后SDK不可使用。 应用退出时请调用该接口,若不调用该接口,则SDK无法退出,应用退出后SDK进程将继续存在。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。
启停会议录制 描述 该接口用于启动或停止会议云录制。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 PUT 请求地址 /v1/mmc/control/conferences/record 传输协议 HTTPS 请求参数 表2 参数说明 参数
查询SSO登录配置 描述 该接口用于查询SSO登录的鉴权配置。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 GET 请求地址 /v1/usg/acs/authorizeconfig 传输协议 HTTPS 请求参数 表2 参数说明 参数
退出登录 Logout 接口描述 该接口用于退出已登录的华为云会议账号。 注意事项 请在已登录的场景下调用。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
邀请与会者 描述 该接口用于邀请与会者加入会议。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 POST 请求地址 /v1/mmc/control/conferences/participants 传输协议 HTTPS 请求参数 表2 参数说明
重命名与会者 描述 该接口用于修改指定与会者的名称。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 PUT 请求地址 /v1/mmc/control/conferences/participants/name 传输协议 HTTPS 请求参数
企业管理员通过该接口批量修改用户状态,当用户账号数资源或者电子白板(SmartRooms)资源到期后,若企业内对应资源的用户账号超过数量后会被系统随机自动停用,此时可通过该接口修改用户的状态。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法