SDK 集成

更新时间: 2024/03/15 14:03:14

本文介绍如何将包含信令模块的 NIM SDK 集成到您的小程序项目。

前提条件

  • 已在微信公众平台中进入小程序后台 > 开发 > 开发设置 > 服务器域名,将以下域名填入指定的 “request 合法域名” / “socket 合法域名” / “uploadFile 合法域名” / “downloadFile 合法域名” 中。

    更多相关说明,请参见配置服务器域名

    若您需要在其他平台(如支付宝)运行示例源码或开发上述平台的小程序,请在对应平台配置服务器域名。

    配置分类 域名 说明
    request 合法域名 https://lbs.netease.im 请求 LBS 地址
    https://wlnimsc0.netease.im:443 IM 必需
    https://statistic.live.126.net 数据上报
    https://abt-online.netease.im 用于 A/B Test
    socket 合法域名 wss://wlnimsc0.netease.im IM 必需
    wss://wlnimsc1.netease.im 聊天室必需
    uploadFile 合法域名 https://nos.netease.com 文件上传,如发送文件类消息
    downloadFile合法域名 https://nim-nosdn.netease.im 文件下载,如下载语音

集成 SDK

下载 SDK

前往 SDK 下载页面 下载最新的 Web SDK 文件。

通过以下命令安装 SDK。

npm install nim-web-sdk-ng@"<1"

引入 SDK

解压后,将 node_modules/nim-web-sdk-ng/dist/NIM_MINIAPP_SDK.js 复制到您的工程中,例如在项目根路径/3rd 路径下,再进行相对路径引用。

后续步骤

集成 SDK 后, 需进行初始化并登录

相关参考

信令目前兼容小程序环境,但仍存在一些限制。具体参见已知问题

此文档是否对你有帮助?
有帮助
去反馈
  • 前提条件
  • 集成 SDK
  • 下载 SDK
  • 引入 SDK
  • 后续步骤
  • 相关参考