魔镜内嵌

编辑文档更新于 2024-11-11 06:14:32

魔镜的魔镜内嵌功能帮助你快速在你的内部系统中嵌入魔镜功能，仅需少量开发成本即可实现以下功能：

直接在内部系统中查看魔镜通话列表页面，例如通话列表页面
直接在内部系统中查看通话调查详情页面，以及通话质量页面

使用步骤

第一步：访问内嵌设置

1.登录控制台，点击左侧菜单中的 BRTC,选择魔镜
2.进入需内嵌的功能页面，例如通话列表
3.点击页面右侧内嵌悬浮按钮，访问内嵌设置

第二步：获取魔镜功能页面URL

参考下图代码（以 Node.js 为例），在服务端发送 HTTP 请求获取水晶球功能页面的 URL

const request = require("request-promise");
const url = await request({
    method: "post",
    url : "https://brtc-api.baijiayun.com/vcs/paas/api/get_embed_location",
    json: true,
    auth: {
        user_name: <key >,
        password: <secret>
    },
    body: {               
        "internet_site": "https://brtc-api.baijiayun.com/brtcadmin/#/analysis",
        "feature": "call_search",
        "app_id": "xxxx"
    }
});

1. HTTP 基本认证

发送请求时，你需要通过 key 和 secret 获取 token 字段并填入 HTTP 请求头部。详情请见 API 基本认证

key: 客户 ID
secret: 客户密钥

2. 获取魔镜功能列表页面URL

调用此方法 (需进行上一步的Basic认证)，你可以获取水晶球功能列表页 URL，例如通话列表页 URL

数据格式

请求和响应的格式为 JSON

基本信息

请求基本信息	描述
方法	POST
请求URL	https://brtc-api.baijiayun.com/vcs/paas/api/get_embed_location

请求参数

包体参数

参数	类型	是否必填	描述
app_id	string	是	BRTC 给开发者分配的 appId，唯一标识一个应用
feature	string	是	魔镜内嵌功能。当前仅支持 call_search,即通话列表功能
internet_site	string	否	魔镜通话列表URL(可支持个性域名)
search_type	int	否	通话搜索类型(1: 通话ID 2: 教室ID 3: 用户ID)
search_text	string	否	通话搜索内容(联合搜索类型字段查询到对应的通话/教室/用户)
search_status	int	否	通话搜索状态(0: 全部 1: 进行中 2: 已结束)
start_ts	int	否	搜索开始时间( 秒级时间戳，例如:1678084342)
end_ts	int	否	搜索结束时间(秒级时间戳，例如:1678098742)

请求示例

{
  "internet_site":"https://brtc-api.baijiayun.com/brtcadmin/#/analysis",
  "feature":"call_search",
  "app_id":"xxxx",
  "search_type":1,
  "search_status":2,
  "search_text":"123",
  "start_ts":1678084342,
  "end_ts":1678098742
}

响应参数

从data字段中可提取出参数来自定义对接

参数	描述
token	动态密钥。有效期为 2 小时，你需要每 2 小时更新动态密钥
app_id	同app_id请求参数说明
search_type	同search_type请求参数说明
search_text	同search_text请求参数说明
search_status	同search_status请求参数说明
start_ts	同start_ts请求参数说明
end_ts	同end_ts请求参数说明

响应示例

{
    "code": 200,
    "msg": "success",
    "data": "https://brtc-api.baijiayun.com/brtcadmin/#/analysis?app_id=xxxx&search_type=1&search_status=2&start_ts=1678084342&end_ts=1678098742&token=xxxxxxxxxxxxxxx"
}

内嵌通话列表页面如图：

3. 获取通话详情页面URL

将以下参数与 URL 拼接，即可获取通话详情页面 URL：

https://brtc-api.baijiayun.com/brtcadmin/#/analysis/call_detail

参数	类型	是否必填	描述
token	string	是	动态密钥，从上一步获取的水晶球功能列表 URL 中获得
app_id	string	是	BRTC 给开发者分配的 appId，唯一标识一个应用
call_id	string	是	通话Id
app_name	string	否	应用名称

拼接示例如下

https://brtc-api.baijiayun.com/brtcadmin/#/analysis/call_detail?token=xxxxxxxx&app_id=xxx&app_name=xxxx&call_id=xxxxx)

拼接完成后，你需要内嵌通话详情页面 URL 至客户端。详见内嵌魔镜页面至客户端

4. 获取通话质量详情页面URL

将以下参数与 URL 拼接，即可获取通话质量详情页面 URL：

https://brtc-api.baijiayun.com/brtcadmin/#/analysis/call_quality_detail

参数	类型	是否必填	描述
token	string	是	动态密钥，从上一步获取的水晶球功能列表 URL 中获得
app_id	string	是	BRTC 给开发者分配的 appId，唯一标识一个应用
call_id	string	是	通话Id
sender_id	string	是	发送端用户 ID
receiver_id	string	是	接收端用户 ID
app_name	string	否	应用名称

拼接示例如下

https://brtc-api.baijiayun.com/brtcadmin/#/analysis/call_quality_detail?token=xxxxxxxx&app_id=xxx&app_name=xxxx&call_id=xxxxx&sender_id=xxxx&receiver_id=xxxx)

拼接完成后，你需要内嵌通话详情页面 URL 至客户端。详见内嵌魔镜页面至客户端

内嵌质量详情页.png

5.内嵌魔镜页面至客户端

选择客户端开发平台，复制下代码片段至客户端

<iframe
   src={iframe_url}
   frameBorder={0}
   width="100%"
   height="100%"
   sandbox="allow-same-origin allow-scripts allow-popups allow-downloads"
/>

API限制

水晶球内嵌 RESTful API 的调用限制

获取通话列表限制

限制	规则
请求次数	每秒 50 次，每天 1000 次

通话详情限制

限制	规则
请求次数	每秒 50 次，每天 1000 次

通话质量详情限制

限制	规则
请求次数	每秒 50 次，每天 1000 次

常见问题

Q: 为什么内嵌的页面是空白的？
A: 浏览器会对网页进行安全识别。当你在网页中内嵌第三方页面时，部分浏览器会判定第三方页面不安全并将其拦截。解决方案如下：

如果你的浏览器安装了广告屏蔽插件，你需要在插件中设置禁止过滤内嵌页面
如果你使用 Safari 浏览器，你需要进入偏好设置 > 隐私 > 网站跟踪，并取消勾选阻止跨站跟踪