跳到主要内容

准备工作

本文档面向需要将融云控制台功能无缝嵌入到自己业务系统的开发者。通过内嵌 SDK,您可以将控制台的特定页面以 <iframe> 的形式集成到您的管理后台,实现统一的操作体验。

在开始集成融云控制台 SDK 之前,请您仔细阅读以下内容,它将引导您完成所有必要的准备工作。

功能概述

浏览器兼容性

支持现代浏览器,需要 ES6+ 和 postMessage API 支持。

建议使用 Chrome 浏览器访问嵌入的控制台页面。如果使用 Safari,请确认在 Safari 浏览器 > 设置... > 隐私 中未勾选 防止跨站跟踪。控制台嵌入页面基于 Cookie 识别登录状态,Safari 开启该选项后可能会阻止 Cookie 传递,导致无法直接登录。

Safari 隐私设置:防止跨站跟踪

开发环境

  • Node.js: 14+ (如使用 npm 安装)
  • 包管理器: npm 6+ 或 yarn 1.x+

获取 Access Key

您需要从融云控制台获取有效的 Access Key:

  1. 登录融云开发者控制台

  2. 进入应用管理页面,选择对应应用的密钥管理

    密钥管理

  3. 点击创建 Access Key 按钮创建密钥。

    创建 Access Key

提示

Access Key 具有高权限,请妥善保管,不要在客户端代码中硬编码。

获取需要嵌入页面的代码 (page_code)

用户管理页面user_manage
群组管理页面group_manage
封禁用户管理页面blocked_user_manage
聊天室管理页面chatroom_manage
操作日志页面operation_log
录制文件管理页面recording_manage
测试用户管理页面test_user_mgt_embed
客服管理页面customer_service_manage
敏感词设置页面sensitive_word_settings
IM Server API 调试页面im_server_api
推送测试页面test_push
RTC Server API 调试页面rtc_server_api
IM 服务功能配置页面im_service_config
RTC 服务功能配置页面rtc_service_config