集成 SDK(Web & 小程序)

最近更新时间:2019-08-27 11:26:05

本文主要介绍如何快速地将腾讯云 IM SDK 集成到您的 Web 或者小程序项目中。

准备工作

在集成 Web SDK 前,请确保您已完成以下步骤,请参见 一分钟跑通 Demo

  • 创建了腾讯云即时通信 IM 应用,并获取到 SDKAppID。
  • 获取密钥信息。

集成 SDK

您可以通过以下方式集成 SDK:

NPM 集成

在您的项目中使用 npm 安装相应的 IM SDK 依赖。

Web 项目:

// IM Web SDK
npm install tim-js-sdk --save
// 发送图片、文件等消息需要的 COS SDK
npm install cos-js-sdk-v5 --save

在项目脚本里引入模块。

import TIM from 'tim-js-sdk';
import COS from "cos-js-sdk-v5";

小程序项目:

// IM 小程序 SDK
npm install tim-wx-sdk --save
// 发送图片、文件等消息需要的 COS SDK
npm install cos-wx-sdk-v5 --save

在项目脚本里引入模块,并初始化。

import TIM from 'tim-wx-sdk';
import COS from "cos-wx-sdk-v5";

更详细的初始化流程和 API 使用介绍请参见 SDK 初始化

Script 集成

在您的项目中使用 script 标签引入 SDK,并初始化。

相关资源

<script src="./tim.min.js"></script>
<script src="./cos-js-sdk-v5.min.js"></script>
<script>
var options = {
  SDKAppID: 0 // 接入时需要将0替换为您的即时通信应用的 SDKAppID
};
// 创建 SDK 实例,TIM.create() 方法对于同一个 SDKAppID 只会返回同一份实例
var tim = TIM.create(options);
</script>

更详细的初始化流程和 API 使用介绍请参见 SDK 初始化

常见问题

1. 小程序如果需要上线或者部署正式环境怎么办?
请在【微信公众平台】>【开发】>【开发设置】>【服务器域名】中进行域名配置:

将以下域名添加到 request 合法域名

域名 说明 是否必须
https://webim.tim.qq.com Web IM 业务域名 必须
https://yun.tim.qq.com Web IM 业务域名 必须
https://pingtas.qq.com Web IM 统计域名 必须

将以下域名添加到 uploadFile 合法域名

域名 说明 是否必须
https://cos.ap-shanghai.myqcloud.com 文件上传域名 必须

将以下域名添加到 downloadFile 合法域名

域名 说明 是否必须
https://cos.ap-shanghai.myqcloud.com 文件下载域名 必须