华为云用户手册

HWRtcConnChangeReason 表19 网络连接状态改变原因 枚举值 描述 HWRtcConnChangeConnecting 正在连接 HWRtcConnChangeJoinSuccess 加入房间成功 HWRtcConnChangeReconnecting 重连中 HWRtcConnChangeReconnectSuccess 重连成功 HWRtcConnChangeJoinFailed 加入房间失败 HWRtcConnChangeReconncetFailed 重连失败 HWRtcConnChangeInterrupted 连接中断 HWRtcConnChangeKeepAliveTimeout 心跳超时 HWRtcConnChangeLeaveRoom 主动离开房间 HWRtcConnChangeJoinServerError 服务器异常 HWRtcConnChangeSFUBreakdown sfu服务故障 HWRtcConnChangeJoinRoomAuthFailed 鉴权失败，appid或者签名错误 HWRtcConnChangeJoinRoomAuthRetry 鉴权重试 HWRtcConnChangeJoinRoomAuthClockSync 时钟同步 HWRtcConnChangeUrlNotRight URL错误400 HWRtcConnChangeJoinRoomServiceUnreachable 服务不可达503 HWRtcConnChangeInternalError 内部错误 HWRtcConnChangeKickedOff 被踢 HWRtcConnChangeSignatureExpired 签名过期

HWRtcJoinParam 表3 入会参数 属性 类型 描述 userId NSString 用户ID，支持最大长度64，支持数字、字母大小写、下划线、中线、"."字符 userName NSString 用户昵称，支持最大长度128 ctime long long 签名时间戳，单位秒，有signature时必选 authorization NSString 签名，必填，鉴权私钥请在应用管理中获取，签名的具体生成方法请参见接入鉴权。支持最大长度为1024。 role HWRtcRole 角色 optionalInfo NSString 其他信息 roomId NSString 房间Id，支持最大长度64，支持数字、字母大小写、下划线、中线字符 autoSubscribeVideo bool 是否自动订阅视频 autoSubscribeAudio bool 是否自动订阅音频 scenario HWRtcRemoteAudioMode 使用的场景 0：主动订阅（默认） 1：TopN（千人） 2：P2P 3：RTSA CMD自动订阅

HWRtcEngineConfig 表9 引擎配置 属性 类型 描述 appId NSString 应用ID，只有App ID相同的应用程序才能进入同一个房间进行互动。appId获取方法请参见应用管理 countryCode NSString 国家码，具体值请参见国家码对照表 enableHaTrace BOOL 打点开关 muteAudioRoute BOOL 是否禁音频路由 enableLog BOOL 是否记录日志 logLevel HWRtcLogLevel 日志级别，具体请参见HWRtcLogLevel，默认值为HWRtcLogLevelDebug，推荐使用HWRtcLogLevelDebug logPath NSString 日志路径，需调用方保证路径合法可用，rtc仅做基础校验 logSize int 日志大小，默认值10M，推荐10M

setRemoteVideoStreamType public abstract int setRemoteVideoStreamType(String userId, HRTCVideoStreamType type); 【功能说明】 大小流模式，设置指定订阅的远端视频流类型。 【请求参数】 userId：远端用户唯一标识。 type：订阅的视频流类型，分为大流和小流，具体请参见HRTCVideoStreamType。

setLayoutDirect public abstract void setLayoutDirect(HRTCOrientationMode layoutDirect); 【功能说明】 设置显示模式，区分横屏和竖屏，用于保证摄像头方向与本地界面方向一致。 【请求参数】 layoutDirect：0表示横屏模式，1表示竖屏模式，2表示横屏重力感应，3表示重力感应，4表示竖屏模式且不会随设备旋转改变采集角度，5表示adaptive模式，适用非dns模式推流外的大部分场景，能自动适配app的布局，自动调整采集方向。 【返回参数】 无

客户端错误码 本章节介绍了SDK的客户端错误码HRTCErrorCode的详细信息。 当SDK运行出现网络、媒体相关等错误时，SDK无法自动恢复，需要App干预或进行用户提示。 枚举 错误码 描述 错误原因 HRTC_ERR_CODE_SUCCESS 0 成功 - HRTC_ERR_CODE_SDK_INTERNAL_ERROR 90000001 SDK内部系统错误 SDK内部异常。 HRTC_ERR_CODE_MSG_TOOLARGE 90000002 发送的消息太大 发送消息时，消息体太大。 HRTC_ERR_CODE_MEM_NOT_ENOUGH 90000003 内存不足 内存申请不到。 HRTC_ERR_CODE_SYNSEND_MSG_ERR 90000004 消息发送失败 消息队列异常，导致内部消息发送失败。 HRTC_ERR_CODE_PARAM_ERROR 90000005 参数错误 包括如下两方面： 接口入参无效。 内部参数错误。 HRTC_ERR_CODE_API_CALLED_IN_WRONG_ORDER 90000006 API接口调用顺序不当 当前只有日志设置必须在初始化之前。 HRTC_ERR_CODE_SETUP_LOCAL_VIEW_FAIL 90000007 设置本地窗口失败 该错误码仅Android平台返回。 HRTC_ERR_CODE_START_REMOTE_STREAM_VIEW_FAIL 90000008 设置远端窗口失败 publisher场景没有远端画面，不应该设置；用户不存在；处于离会中等。 HRTC_ERR_CODE_SET_DEVICE_FAIL 90000009 设置设备失败 设置播放、录音、视频设备失败。 HRTC_ERR_CODE_INITIALIZING 90000010 初始化过程中 初始化过程中，不能再做初始化或者去初始化操作。 HRTC_ERR_CODE_UN_INITIALIZING 90000011 去初始化过程中 去初始化过程中，不能再做初始化或者去初始化操作。 HRTC_ERR_CODE_LOG_UPLOADING 90000012 日志正在上传 日志正在上传过程中。 HRTC_ERR_CODE_MEDIA_PORT_ERROR 90000013 媒体端口获取失败 音频从10010开始，视频从10020开始，尝试10次，端口都被占用了。 HRTC_ERR_CODE_WATCH_VIEW_TOO_MUCH 90000014 视频选看超过规格 当前支持最多设置16个设置远端窗口，若超过，则会失败。 HRTC_ERR_CODE_MEDIA_CMP_ERR 90000015 媒体协商失败 与服务器之间媒体协商失败。 HRTC_ERR_CODE_SERVER_NO_RESPONSE 90000016 服务器没有响应 选看在2-4s内没有收到服务器的响应。 HRTC_ERR_CODE_USER_ROLE_CHANGE_FAIL 90000017 角色切换失败 角色切换失败。 HRTC_ERR_CODE_JOIN_ROOM_FAIL 90000018 加入房间失败 加入房间失败。 HRTC_ERR_CODE_JOIN_ROOM_STATUS_BUSY 90000019 加入房间失败 已在房间中或正在网络探测中。 HRTC_ERR_CODE_JOIN_ROOM_SERVER_ERROR 90000020 加入房间失败 加入房间失败，服务器异常。 HRTC_ERR_CODE_JOIN_ROOM_SERVICE_UNREACHABLE 90000021 加入房间失败 加入房间失败，服务不可达。 HRTC_ERR_CODE_JOIN_ROOM_AUTH_FAIL 90000022 加入房间失败 加入房间失败，鉴权失败。 HRTC_ERR_CODE_JOIN_ROOM_AUTH_RETRY 90000023 加入房间失败 加入房间失败，鉴权重试。 HRTC_ERR_CODE_JOIN_ROOM_CLOCK_SYNC 90000024 加入房间失败 加入房间失败，时钟同步。 HRTC_ERR_CODE_JOIN_ROOM_URL_NOT_RIGHT 90000025 加入房间失败 加入房间失败，url错误。 HRTC_ERR_CODE_KICKED_OFF 90000026 被踢出房间 相同用户ID等原因，被踢出房间。 HRTC_ERR_CODE_SCREEN_CAPTURE_FAIL 90000027 共享失败 房间内已经存在辅流等原因，导致共享失败。 HRTC_ERR_CODE_EXT_MEDIA_OUTPUT 90000028 设置输出设备错误 当开启媒体数据输出时，不允许设置输出设备，否则会报此异常。 HRTC_ERR_CODE_RECONNECT_FAILED 90000029 连接异常 重连失败。 HRTC_ERR_CODE_SERVER_BREAK_DOWN 90000030 服务器异常 服务器宕机。 HRTC_ERR_CODE_SIGNATURE_EXPIRED 90000031 签名过期 签名已过期。 HRTC_ERR_CODE_SET_REMOTE_RENDER_MODE_FAIL 90000032 设置视图模式失败 设置远端窗口模式失败。 HRTC_ERR_CODE_SET_REMOTE_AUDIO_MUTE_FAIL 90000033 设置远端音频接收失败 订阅或取消订阅音频失败。 HRTC_ERR_CODE_SET_USEROLE_NOT_ALLOWED 90000036 跨房后，不允许在本房间内做角色切换 跨房后，不允许在本房间内做角色切换，通过onError返回。 HRTC_ERR_CODE_EXT_MEDIA_CAPTURE_INPUT 90000037 当前为第三方采集模式，禁用该操作 开启第三方采集模式后，禁用部分操作。 HRTC_ERR_CODE_SET_EXTAUDIO_CAPTURE_FAIL 90000038 设置第三方音频采集失败 设置第三方音频采集失败。 HRTC_ERR_CODE_SET_EXTVIDEO_CAPTURE_FAIL 90000039 设置第三方视频采集失败 设置第三方视频采集失败。 HRTC_ERR_CODE_SET_SHARE_COMPUTER_SOUND_FAIL 90000040 设置共享声音开关失败 设置共享声音开关失败。 HRTC_ERR_CODE_SET_LOCAL_AUDIO_MUTE_FAIL 90000041 启停上行音频流失败 启停上行音频流失败。 HRTC_ERR_CODE_SET_LOCAL_VIDEO_MUTE_FAIL 90000042 启停上行视频流失败 启停上行视频流失败。 HRTC_ERR_CODE_USER_REMOVED 90000043 用户被移除 用户被移除。 HRTC_ERR_CODE_ROOM_DISMISSED 90000044 房间被解散 房间被解散。 HRTC_ERR_CODE_SETUP_REMOTE_VIEW_FAIL 90000045 设置远端View失败 设置远端View失败。 HRTC_ERR_CODE_REGION_NOT_COVERED 90000048 区域未覆盖 所在区域不能提供SparkRTC服务。 HRTC_ERR_CODE_SET_EXTDATA_CAPTURE_FAIL 90000049 设置第三方辅流采集失败 设置第三方辅流采集失败 HRTC_ERR_CODE_NOT_SUPPORT 90000050 该平台不支持此功能 该平台不支持此功能 HRTC_ERR_CODE_AUDIO_ROUTE_HANDLER_NOT_INIT 90000051 音频路由没有初始化 音频路由没有初始化 HRTC_ERR_CODE_AUDIO_ROUTE_PLUGIN_CONNECTED 90000052 音频路由外设连接 音频路由外设连接 HRTC_ERR_CODE_AUDIO_ROUTE_NO_NEED_CHANGE 90000053 音频设置路由和当前路由相同 音频设置路由和当前路由相同 HRTC_ERR_CODE_AUDIO_ROUTE_CHANGE_ERROR 90000054 音频路由切换失败 音频路由切换失败 HRTC_ERR_CODE_AUDIO_ROUTE_CLOSED 90000055 音频路由控制开关关闭，无法切换路由 音频路由控制开关关闭，无法切换路由 HRTC_ERR_CODE_LOCAL_AUDIO_DISABLE_FAIL 90000056 当前未推音频流 当前未推音频流 HRTC_ERR_CODE_ROLE_NOT_SUPPORT 90000057 当前角色不支持该操作 当前角色不支持该操作 HRTC_ERR_CODE_ENABLE_BACKGROUND_FAIL 90000058 没有动态加载ML图像分割库，不能支持背景虚化和背景替换能力 没有动态加载ML图像分割库，不能支持背景虚化和背景替换能力 HRTC_ERR_CODE_ENABLE_BACKGROUND_FAIL 90000059 背景虚化或背景替换开启失败 背景虚化或背景替换开启失败 HRTC_ERR_CODE_COMMAND_REMOTEUSER_FAIL 90000060 发送CMD时，目标用户不存在 发送CMD时，目标用户不存在 HRTC_ERR_CODE_COMMAND_NOTENABLED 90000061 CMD没有被启用 CMD没有被启用 HRTC_ERR_CODE_MSG_TOOQUICK 90000062 发送的消息太频繁 发送的消息太频繁 HRTC_ERR_CODE_MSG_API_CALL_UNREASONABLE 90000063 API调用不合理 API调用不合理 HRTC_ERR_CODE_VIDEO_BAD_STATE 90000064 模块状态错误 模块状态错误 HRTC_ERR_CODE_AUDIO_SHARE_FAIL 90000065 声音共享失败 声音共享失败 父主题： 接口参考

onAudioFramePlayback - (BOOL)onAudioFramePlayback:(HWRtcAudioFrame * _Nonnull)audioFrame; 【功能说明】 需要播放的音频数据回调，从接口回调中取到音频数据以作后处理。 【回调参数】 HWRtcAudioFrame ：音频数据格式，具体请参见HWRtcAudioFrame。 【返回参数】 YES：处理结果成功。 NO：处理结果失败。

onAudioFrameRecord - (BOOL)onAudioFrameRecord:(HWRtcAudioFrame * _Nonnull)audioFrame; 【功能说明】 音频采集原始数据回调，对音频数据的修改会发送到远端。 【回调参数】 HWRtcAudioFrame：音频数据格式，具体请参见HWRtcAudioFrame。 【返回参数】 YES：处理结果成功。 NO：处理结果失败。

ERP角色分配 使用企业管理员账号登录IMC管理后台。 单击业务管理-应用管理-单位应用管理，选择SparkPack (SAP Business One)-更多-角色管理 在角色管理里面，单击角色设置，调整该用户为相应的角色。 调整完角色后，单击确定保存，则在ERP系统内会更新为相应的角色。如果是管理员，则在ERP系统内拥有最高权限。如果是用户，则需要ERP管理员登录到ERP系统进行对其进行授权。 父主题： ERP应用授权管理（存量整改）

ERP角色分配 使用企业管理员账号登录IMC管理后台。 单击业务管理-应用管理-单位应用管理，选择SparkPack 企业ERP-更多-角色管理 在角色管理里面，单机角色设置，调整该用户为相应的角色。 调整完角色后，单击确定保存，则在ERP系统内会更新为相应的角色。如果是管理员，则在ERP系统内拥有最高权限。如果是用户，则需要ERP管理员登录到ERP系统进行对其进行授权。 父主题： ERP应用授权管理

操作步骤 客户获取主机公网IP 通过询问运营商/目标主机访问第三方IP查询网站等方法，获取当前办公主机对应公网IP。 获取租户信息 通过以下步骤获取租户ID、租户名信息 登录用户，进入华为云控制台。在右上角显示租户/用户名处鼠标悬停，出现下拉框后选择“我的凭证”，进入API凭证页面。 下图中红框所选部分即为租户名/租户ID 提交华为云工单至SparkPack 提交工单时请提供前两步骤中获取的信息，即： 租户ID、租户名称 主机公网IP列表 收集放通主机公网IP列表后，通过提交工单方式提交至 SparkPack。后续将在1个工作日内完成登录访问控制的配置。 父主题： 限制ip登录功能

如何创建SparkPack企业ERP客户端的快捷方式登录？ 解决方案 1）打开谷歌浏览器，输入用户登录地址： https://macroverse.huaweicloud.com/unified-login/#/portal-login?ind=IMC&appId=e3a8574e-4b56-43bc-b27d-011f93fb2bed 2）点击右上角“自定义及控制”，选择更多工具创建快捷方式。 3）在弹出的窗口里，输入SparkPack企业ERP，点击创建按钮。 4）此时SparkPack 企业ERP的桌面快捷方式已经创建成功，下次登录时双击该快捷方式即可。 父主题： FAQ

步骤一：创建团队信息 登录AppStage业务控制台。 在快捷入口区域选择“开发中心”，进入开发中心工作台。 在工作台下方“我的团队”区域，单击右侧“创建团队”。 在“创建团队”页面，设置团队相关参数，参数配置请参见表1。 表1 创建团队参数说明 参数名称 参数说明 团队名称 必填项，团队的命名。 团队归属部门 必填项，选择系统中已提前创建的部门，部门的创建方法请参见添加部门。 关联服务 必填项，选择系统中已提前创建的服务，服务创建方法请参见服务管理。 团队LOGO 必填项，单击系统默认图片上的“点击修改”，可选择本地图片自定义LOGO图片。 团队简介（可选） 非必填项，团队空间的功能描述或其他备注信息。 单击“创建”。 在“我的团队”区域可查看到创建的团队的卡片。

步骤五：配置安全组规则 为网络配置安全组策略，并将需要纳管的虚拟机加入到新建的安全组上。 需要接入的虚拟机加入到新建的安全组上，未将虚拟机加入到上述安全组会导致纳管失败。 进入安全组列表页面。 在安全组列表右上方，单击“创建安全组”。 进入“创建安全组”页面。 根据界面提示，设置安全组参数，具体参数如表3所示，配置完成后单击“确定”。 表3 安全组参数 参数名称 参数说明 名称 设置安全组名称，建议设置为sg-wisecloud。 企业项目 创建安全组时，可以将安全组加入已启用的企业项目。 模板 创建安全组的时候，系统为您提供了几种常见的安全组模板。安全组模板中预先配置了入方向规则和出方向规则，您可以根据业务选择所需的模板，快速完成安全组的创建。 描述 安全组的描述信息，非必填项。 在安全组列表中查看已创建的安全组，单击安全组所在行“操作”列的“配置规则”，进入安全组规则配置页面。 配置入方向规则，出方向默认全部放通。 在“入方向规则”页签，单击“添加规则”。 在“添加入方向规则”对话框，根据界面提示，设置入方向规则参数，具体参数如表4所示。 单击“+”按钮，可以依次增加多条入方向规则，配置完成后单击“确定”。 表4 入方项规则 优先级 策略 类型 协议端口 源地址 描述 1 允许 TCP：22 IPv4 10.200.2.0/23 AppStage业务开放端口 1 允许 TCP：5443 IPv4 10.250.0.0/22 AppStage的ERS管理面 1 允许 TCP：3306 说明： AppStage数据库默认端口为3306，如果已修改端口，按实际端口配置，可在华为云控制台数据库实例详情页面查看端口信息。 IPv4 10.200.6.0/24 AppStage的数据库端口 1 允许 ICMP：全部 IPv4 10.200.0.0/15 网络ping测试（网络验证通可删除）

步骤三：购买带宽包 CC云连接创建好之后默认为10kb左右网络测试，需购买带宽包。 在云连接实例基本信息页面，单击“带宽包”，切换至“带宽包”页签。 在“带宽包”页签，单击“购买带宽包”。 根据表2填写对应参数，单击“立即购买”。 表2 购买带宽包参数 参数名称 参数说明 计费模式 包年/包月。 用户根据需要选择购买时长，按照年或月为单位进行购买。 带宽包名称 带宽包的名称。 长度为1~64个字符，支持数字、英文字母、下划线、中划线和“.”。 计费方式 按宽带计费。 云连接按照带宽的大小进行计费。 互通类型 支持大区内互通/跨大区互通。 大区内互通指配置域间带宽的区域在所选择的大区内。 跨大区互通指配置域间带宽的区域包含不同的大区。 互通大区 需要实现互通的大区，即配置域间带宽时涉及的区域所在的大区。 带宽 带宽是所有域间带宽的总和，请根据网络情况提前做好规划。 单位Mbit/s。 购买时长 按照用户需求，选择对应的购买时间。 可支持自动续费。 企业项目 企业项目是一种云资源管理方式，企业项目管理服务提供统一的云资源按项目管理，以及项目内的资源管理、成员管理。 云连接实例 选择需要绑定的云连接名称。 支持绑定/暂时不绑定。 在订单确认页面再次确认购买带宽包的信息，单击“去支付”。 单击“确认付款”。 在带宽包列表中可查看带宽包信息，如果“状态”为“正常”，表示购买成功。

步骤二：为对等连接配置路由 在“对等连接”页面，单击已接受的对等连接请求所在行“操作”列的“修改”，默认进入“基本信息”页签。 单击“本端路由”，切换至“本端路由”页签。 单击“此处”，进入VPC路由表添加该对等连接的路由。 单击“添加路由”，添加如表1所示的路由。 表1 路由信息 目的地址 下一跳类型 下一跳 描述 10.200.0.0/15 对等连接 创建的对等连接 AppStage虚机网段 10.250.0.0/22 对等连接 创建的对等连接 AppStage容器网段

步骤三：配置安全组规则 为网络配置安全组策略，并将需要纳管的虚拟机加入到新建的安全组上。 需要接入的虚拟机加入到新建的安全组上，未将虚拟机加入到上述安全组会导致纳管失败。 进入安全组列表页面。 在安全组列表右上方，单击“创建安全组”。 进入“创建安全组”页面。 根据界面提示，设置安全组参数，具体参数如表2所示，配置完成后单击“确定”。 表2 安全组参数 参数名称 参数说明 名称 设置安全组名称，建议设置为sg-wisecloud。 企业项目 创建安全组时，可以将安全组加入已启用的企业项目。 模板 创建安全组的时候，系统为您提供了几种常见的安全组模板。安全组模板中预先配置了入方向规则和出方向规则，您可以根据业务选择所需的模板，快速完成安全组的创建。 描述 安全组的描述信息，非必填项。 在安全组列表中查看已创建的安全组，单击安全组所在行“操作”列的“配置规则”，进入安全组规则配置页面。 配置入方向规则，出方向默认全部放通。 在“入方向规则”页签，单击“添加规则”。 在“添加入方向规则”对话框，根据界面提示，设置入方向规则参数，具体参数如表3所示。 单击“+”按钮，可以依次增加多条入方向规则，配置完成后单击“确定”。 表3 入方项规则 优先级 策略 类型 协议端口 源地址 描述 1 允许 TCP：22 IPv4 10.200.2.0/23 AppStage业务开放端口 1 允许 TCP：5443 IPv4 10.250.0.0/22 AppStage的ERS管理面 1 允许 TCP：3306 说明： AppStage数据库默认端口为3306，如果已修改端口，按实际端口配置，可在华为云控制台数据库实例详情页面查看端口信息。 IPv4 10.200.6.0/24 AppStage的数据库端口 1 允许 ICMP：全部 IPv4 10.200.0.0/15 网络ping测试（网络验证通可删除）

功能介绍 表1 运行时引擎主要功能 服务分类 服务名称 服务简介 微服务开发 微服务平台 微服务平台（NUWA Runtime，简称NUWA）是一款全代管式微服务计算平台，可快速、安全地部署和扩缩容器化应用，是一个广义的Serverless平台，提供容器级别的完全托管的能力，目标是让业务看不到云。管理平台标准化业务的部署形式，业务只需要提供软件包，NUWA Runtime借助底层的弹性伸缩平台完成网络配置、双云集群部署、日志自动收集、灰度多阶段升级等。 负载均衡 负载均衡（Software/Server Load Balancer，简称SLB）基于Nginx/OpenResty构建，作为业务前置的流量开关，提供反向代理；负载均衡、路由分发、灰度分流、限流降级、访问控制、监控告警等能力。 服务发现 服务发现（NUWA Cloud Map，简称Cloud Map）是NUWA的重要组成部分，它设计的目的是作为云服务统一的服务注册发现中心，主要是为解决业务依赖环境配置繁琐的难题，具有服务注册和发现、业务故障隔离、服务路由、服务间调用关系正向设计和治理、微服务配置中心等特性。 数据库治理 数据库治理（WiseDBA）是一站式数据库管理平台与数据库专家服务，为用户提供数据库台账、自动化SQL变更、数据查询、自动化数据提取、性能分析、负载分析、数据库风险诊断等功能。 安全 访问凭证管理服务 访问凭证管理服务（Access Credential Management Service，简称ACMS）提供了微服务之间请求认证、敏感配置的托管和分发功能。 父主题： 运行时引擎简介

CDN数据 支持查看CDN流量、CDN峰值带宽、流量命中率、请求命中率以及请求总数的具体情况，如表1所示。 图1 CDN数据 表1 CDN统计数据项说明 数据统计项 说明 CDN流量 指定时间跨度的CDN流量。 CDN峰值带宽 指定时间跨度的CDN峰值带宽。 流量命中率 流量命中率=命中缓存产生的流量/请求总流量，请求总流量为命中缓存产生的流量和请求回源产生的流量之和。 请求命中率 请求命中率=命中缓存的请求数/请求总数。 请求总数 指定时间跨度内的请求总数。 由于实际产生的网络流量包括TCP/IP包头和TCP重传消耗，因此账单的计费数据可能与展示的流量图不完全一致。

描述 会议中任何人都可以通过该接口首次启动会议的实时字幕。当会议处于开启实时字幕状态时，会议中任何人都可以订阅实时字幕推送消息帧。 会议结束时，会议的实时字幕才会停止。 表1 请求文本 参数 类型 描述 action String 消息类型，必须为ConfControl。 sequence String 消息序列，消息帧的唯一标识。 type String 会控类型，必须为REALTIMESUBTITLE。 data String 具体的请求JSON字符串，参考表2 data数据结构。 表2 data数据结构 参数名称 是否必须 参数类型 描述 conferenceID 是 String 会议ID。 confToken 是 String 会控Token。 isSubtitle 否 Integer 0：停止实时字幕 1：启动实时字幕 subtitleType 否 Integer 字幕显示方式： 0：声音最大的2方发言人 sisProperty 否 String 所使用的模型: chinese_16k_general：中文普通话（默认） chinese_16k_trial：庭审模式 id 否 Array of strings 字幕显示方式为“指定发言人”时必填。发言会场ID列表（6.3.5章节在线与会者推送的pid），最多4人。

开启实时字幕示例 var confToken = 获取会控Token接口; var openRealTimeSubtitle = JSON.stringify({ sequence: "000000000000000002611382273463", action: "ConfControl", type: "REALTIMESUBTITLE", data: JSON.stringify({ conferenceID: "986812232", confToken: confToken, isSubtitle: "1", subtitleType: "0" }), });

实时字幕推送示例 { "action": "RealTimeSubtitleNotify", "version": "1614936396556", "createTime": "1614936396556", "msgID": "e20544e37d9411ebbae3fd5b302953d3", "msgMode": 0, "confID": "981112355", "data": { "msgs ": [{ "subtitleLang": "Mandarin", "translateText": "实时字幕。 ", "id ": "c0196fb9-c9c3-47ba-a685-05223552de2f" }], "isFinal ": false, "timestamp ": 1614936396553, "beginTime": 1528680, "endTime": 1530900, "participantID": "984r8z9f4p6p6pry97yfan6z76681f09" } }

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 337 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 630c3bc684928cfa780860fe6a14f38f Server: api-gateway X-Request-Id: d689482097c019094f8aa41e57e52e8e { "data": { "token": "stb15afe94b97a5cd7f152d5308c420dbdce85beda4a3b39f26", "tmpWsToken": "stba0a69f40a78e50f3789e72386f7da84809fbc86a1400bea5", "wsURL": "wss://119.3.200.83:443", "role": 1, "expireTime": 1576651143250, "userID": "ff808081699b56cb0169be103500012b", "orgID": "15659", "confTokenExpireTime": 1800, "vmrCurrentConfID": "914083901", "supportNotifyType": [ "INCREMENT" ] }, "addressToken": "stbWdPZ2ooVesQTWqZESu7AjVlH9Pv4O1KcQ", "gloablPublicIP": "meeting.huaweicloud.com" }

请求消息示例 GET /v1/mmc/control/conferences/token?conferenceID=914083901 Connection: keep-alive X-Password: ******* X-Login-Type: 1 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

响应参数 表4 响应参数 参数 类型 描述 data data object 会控Token信息。 addressToken String 企业通讯录查询临时Token。 gloablPublicIP String 华为云会议Portal地址。 表5 data数据结构说明 参数 类型 描述 token String 会控Token。有效期半个小时。 说明： 会控Token支持两种使用方式： 1、后续所有会控接口，都可以直接使用该token，如：X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb。 2、使用Bse64转码使用，转码格式，Basic空格+Base64(token),示例如下：X-Conference-Authorization:Basic Y25yYjQyNmNhMzgyMWY4YTE4ZTc4ZDU5ZGE1NzJhNDIxNjQ0YzUyZGZkOWE0NzMwMjk4。 tmpWsToken String 会控WebSocket建链鉴权Token。 wsURL String 会控WebSocket建链URL。 role Integer 会议中的角色。 0 ：普通与会者 1 ：会议主持人 expireTime long 会控Token过期时间戳（单位：毫秒）。 userID String 会议预定者的用户UUID。 orgID String 会议所属企业ID。 participantID String 终端请求时，返回终端入会后会场ID。 说明： 该参数将废弃，请勿使用。 confTokenExpireTime Integer 会控Token有效时长（单位秒）。 vmrCurrentConfID String 云会议室会议的当前会议ID。 supportNotifyType Array of strings 会控WebSocket消息推送支持类型。

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 说明： 创建会议时返回的conferenceID。不是vmrConferenceID。 X-Conference-Authorization 否 String Header 会控Token。 说明： 仅会控Token保活场景需要携带 如果会话已过期并且请求中携带了密码，则进行重新鉴权并回复新的会控Token X-Password 是 String Header 会议的主持人密码。 说明： 对于会控Token保活场景，不对主持人密码鉴权。 X-Login-Type 是 Integer Header 请求类型。 1：固定为1。 X-Nonce 否 String Header 用户临时nonce token。

描述 该接口用于查询已经结束的会议。管理员可以查询本企业内所有的历史会议，普通用户仅能查询自己创建或者被邀请的历史会议。不带查询参数时，默认查询权限范围内的历史会议。 普通用户如果只是通过会议ID或者会议链接接入会议，不是预定者会前邀请或者会中主持人邀请的，则历史会议中无法查到 如果同一个会议召开并结束多次，则会产生多条历史会议（会议ID相同，会议UUID不同） 历史会议记录默认保留6个月，最长保留12个月。保留时间管理员可在“会议设置”的“历史会议留存时间”中修改

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 userUUID 否 string Query 用户的UUID。 说明： 该参数将废弃，请勿使用。 offset 否 Integer Query 查询偏移量。默认为0。 limit 否 Integer Query 查询数量。默认是20，最大500条。 searchKey 否 string Query 查询条件。会议主题、会议预约人和会议ID等可作为搜索内容。 queryAll 否 Boolean Query 是否查询企业下所有用户的历史会议。 true：查询所有用户的历史会议 false：仅查询管理员自己的历史会议 说明： 仅对企业管理员生效。 startDate 是 long Query 查询的起始时间戳（单位毫秒）。 endDate 是 long Query 查询的截止时间戳（单位毫秒）。 sortType 否 String Query 查询结果排序类型。 ASC_StartTIME：根据会议开始时间升序排序 DSC_StartTIME：根据会议开始时间降序排序 ASC_RecordTYPE：根据是否具有录播文件排序，之后默认按照会议开始时间升序排序 DSC_RecordTYPE：根据是否含有录播文件排序，之后默认按照会议开始时间降序排序 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Authorization-Type 否 String Header 标识是否为第三方portal过来的请求。 说明： 该参数将废弃，请勿使用。 X-Site-Id 否 String Header 用于区分到哪个HCSO站点鉴权。 说明： 该参数将废弃，请勿使用。

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 2420 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 43bee1151af8115d90358994a7c14cfc Server: api-gateway X-Request-Id: 53c883710d86aebf01e92ce7bcea1984 { "data": [ { "conferenceID": "914083388", "mediaTypes": "Voice,Video,Data", "subject": "user8001测试会议", "size": 1, "timeZoneID": "56", "startTime": "2019-11-18 23:31", "endTime": "2019-11-18 23:32", "conferenceState": "Destroyed", "accessNumber": "+991117", "language": "zh-CN", "passwordEntry": [ { "conferenceRole": "general", "password": "******" } ], "userUUID": "ff8080816a024f05016a4e2342480a60", "scheduserName": "test008", "multiStreamFlag": 1, "conferenceType": 0, "confType": "IMMEDIATELY", "isAutoMute": 1, "isAutoRecord": 0, "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083388/1f215673e636444b55845ee1d1af630e8d8ca0235e491972", "recordType": 0, "recordAuxStream": 0, "recordAuthType": 0, "confConfigInfo": { "prolongLength": 15, "isGuestFreePwd": false, "isSendNotify": true, "isSendSms": true, "isAutoMute": true, "isSendCalendar": true, "callInRestriction": 0, "allowGuestStartConf": true, "isHardTerminalAutoMute": true, "enableWaitingRoom": true }, "vmrFlag": 0, "scheduleVmr": false, "isHasRecordFile": false, "partAttendeeInfo": [ { "phone": "+99111****380", "name": "user8002", "type": "normal" } ], "terminlCount": 0, "normalCount": 1, "deptName": "wangyue", "confUUID": "9a0fa6d10a5b11eaae5e191763c22c0e" }, { "conferenceID": "914088193", "mediaTypes": "Voice,Video,Data", "subject": "user8001的会议", "size": 1, "timeZoneID": "56", "startTime": "2019-11-18 23:31", "endTime": "2019-11-18 23:31", "conferenceState": "Destroyed", "accessNumber": "+991117", "language": "zh-CN", "passwordEntry": [ { "conferenceRole": "general", "password": "******" } ], "userUUID": "ff8080816a024f05016a4e2342480a60", "scheduserName": "test008", "multiStreamFlag": 1, "conferenceType": 0, "confType": "IMMEDIATELY", "isAutoMute": 1, "isAutoRecord": 0, "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914088193/5b00be0e5121eb2f6f865162a4bc7f1f7f05d37cd802dded", "recordType": 2, "recordAuxStream": 0, "recordAuthType": 0, "confConfigInfo": { "prolongLength": 15, "isGuestFreePwd": false, "isSendNotify": true, "isSendSms": true, "isAutoMute": true, "isSendCalendar": true, "callInRestriction": 0, "allowGuestStartConf": true, "isHardTerminalAutoMute": true, "enableWaitingRoom": true }, "vmrFlag": 0, "scheduleVmr": false, "isHasRecordFile": false, "partAttendeeInfo": [ { "phone": "+991116004380", "name": "user8002", "type": "normal" } ], "terminlCount": 0, "normalCount": 1, "deptName": "wangyue", "confUUID": "7c421ac60a5b11eaa5e83b30677ab12b" }, { "conferenceID": "914085971", "mediaTypes": "Voice,Video,Data", "subject": "user8001的会议", "size": 1, "timeZoneID": "56", "startTime": "2019-11-18 23:30", "endTime": "2019-11-18 23:31", "conferenceState": "Destroyed", "accessNumber": "+991117", "language": "zh-CN", "passwordEntry": [ { "conferenceRole": "general", "password": "******" } ], "userUUID": "ff8080816a024f05016a4e2342480a60", "scheduserName": "test008", "multiStreamFlag": 1, "conferenceType": 0, "confType": "IMMEDIATELY", "isAutoMute": 1, "isAutoRecord": 0, "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914085971/40300b325ad71ad1ff2c1dbdda1250328ccd8ec9ff45bd03", "recordType": 2, "recordAuxStream": 0, "recordAuthType": 0, "confConfigInfo": { "prolongLength": 15, "isGuestFreePwd": false, "isSendNotify": true, "isSendSms": true, "isAutoMute": true, "isSendCalendar": true, "callInRestriction": 0, "allowGuestStartConf": true, "isHardTerminalAutoMute": true, "enableWaitingRoom": true }, "vmrFlag": 0, "scheduleVmr": false, "isHasRecordFile": false, "partAttendeeInfo": [ { "phone": "+99111****380", "name": "user8002", "type": "normal" } ], "terminlCount": 0, "normalCount": 1, "deptName": "wangyue", "confUUID": "6d2a6cd90a5b11eaa5e8f14973e50d03" } ], "offset": 0, "limit": 20, "count": 3 }

请求消息示例 GET /v1/mmc/management/conferences/history?startDate=1574092800000&endDate=1574179199999 Connection: keep-alive X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)