IM 翻译插件
注意
- IMLib 从 5.1.2 版本开始支持翻译插件。
- 该插件暂仅适用于使用新加坡数据中心的应用。详见海外数据中心。
融云即时通讯业务提供翻译插件,可为 IMLib SDK 快速接入外部翻译服务,由融云服务端负责对接外部翻译服务供应商的鉴权、API 调用、账号管理、计费等流程。翻译插件支持翻译文本。
目前已支持接入 Google 翻译服务。
翻译流程
服务开通
该功能为付费增值服务。如有需求,请前往控制台 IM 翻译页面开通服务。
关于 IM 翻译服务费用,详见 IM 翻译计费说明。
客户端鉴权
客户端需要持有有效的 JWT Token,才能向融云请求翻译结果。
您的 App 服务端需要调用融云服务端 API 接口获取 JWT Token,然后返回给客户端。详见服务端文档获取 JWT Token。
注意
翻译插件鉴权专用的 JWT Token 不同于 IM 用户连接 IM 服务的 Token,请注意区分。
JWT
JWT 全称 JSON web Token,是为了在网络应用环境间传递声明而执行的一种基于 JSON 的开放标准。 JWT 包含 header、payload、signature 三部分。通过解析 payload 部分可获取到 Token 有效期和 UserId 等信息。
获取和刷新 JWT Token 流程图
IMKit 使用翻译插件
Web IMKit 暂不支持使用翻译插件。
IMLib 使用翻译插件
-
安装插件
示例代码
-
NPM 方式:
npm install @rongcloud/engine @rongcloud/imlib-next @rongcloud/plugin-translate -S
-
CDN 方式:
<script src="https://cdn.ronghub.com/RCTranslate-1.0.1.prod.js"></script>
-
-
初始化,并连接融云 IM 服务。
示例代码
import * as RCTranslate from '@rongcloud/plugin-translate'
import * as RongIMLib from '@rongcloud/imlib-next'
// 初始化 IM
RongIMLib.init({ appkey: '<appkey>' })
const translateClient = RongIMLib.installPlugin(RCTranslate.installer)
RongIMLib.connect('<token>').then(res => {
if (res.code === 0) {
console.log('连接成功')
}
}) -
在用户登录成功之后,需先判断当前是否已开通翻译服务。
示例代码
translateClient.isSupport()
-
在确认支持翻译服务之后,可以开始进行客户端鉴权。App 需要向自身的应用服务器发起请求,由应用服务器调用融云服务端 API 获取 JWT Token。App 获取 JWT Token 后,通过
setAuthToken
接口设置到 SDK 中。示例代码
translateClient.setAuthToken('<鉴权token>')
-
调用
translateText
翻译文本示例代码
const params = {
content: '', // 要翻译的文本
target: RCTranslate.LanguageVerify.zh_CN, // 目标语言类型
source: RCTranslate.LanguageVerify.en // 源语言类型
}
translateClient.translateText(params).then(({code, data}) => {
if (code === RCTranslate.TranslateCode.TranslateCodeSuccess) {
// data: 翻译结果
console.log('翻译成功', data)
} else {
// code: 失败状态码
console.log('翻译失败', code)
}
})