接入流程

更新时间: 2024/11/26 10:23:18

本文介绍使用 V10 系列网易云信即时通讯 SDK(NetEase IM SDK,简称 NIM SDK)的基本接入流程概述,您可以参考对应的文档完成 NIM SDK 接入,为应用项目实现即时通讯功能。

支持平台

V10 系列 NIM SDK 适配了以下客户端开发平台和开发框架,其中鸿蒙(HarmonyOS)平台适配仅在 V10 系列 NIM SDK 中提供。您可以前往 资源下载 页面下载对应版本的 SDK 和 Demo。

Android iOS macOS/Windows Web/uni-app/小程序 Node.js/Electron HarmonyOS Flutter
✔️️ ✔️️ ✔️️ ✔️️ ✔️️ ✔️️ ✔️️

使用网易云信即时通讯 V10 系列客户端 NIM SDK 时,请同时调用配套的 服务端 API(RESTful)请勿 调用 V9 及更低版本系列客户端 NIM SDK 配套的服务端 API。

流程概述

  flowchart LR
    classDef default fill:#337EFF,stroke:#337EFF,stroke-width:0px,color:#FFFFFF;

    A("创建应用") --> B(开通 IM 产品) --> C("注册 IM 账号") --> D("集成 SDK") --> E("初始化") --> F("登录 IM 账号") --> G("实现应用功能")
    click A "https://doc.yunxin.163.com/console/guide/TIzMDE4NTA?platform=console"
    click B "https://doc.yunxin.163.com/messaging2/guide/jU0Mzg0MTU?platform=client#%E7%AC%AC%E4%B8%80%E6%AD%A5%E5%BC%80%E9%80%9A-im-%E5%A5%97%E9%A4%90%E5%8C%85"
    click C "https://doc.yunxin.163.com/messaging2/guide/jU0Mzg0MTU?platform=client#%E7%AC%AC%E4%BA%8C%E6%AD%A5%E6%B3%A8%E5%86%8C-im-%E8%B4%A6%E5%8F%B7"
    click D "https://doc.yunxin.163.com/messaging2/guide/DA5NzIyMjc?platform=client"
    click E "https://doc.yunxin.163.com/messaging2/guide/TY4OTgyMDk?platform=client"
    click F "https://doc.yunxin.163.com/messaging2/guide/Dk1MTY4MzA?platform=client"
    click G "https://doc.yunxin.163.com/messaging2/guide/TcxNjM0ODc?platform=client"
步骤 操作 说明
1 创建应用并获取 App Key 网易云信控制台 中创建应用,获取到该应用的密钥(App Key),后续集成 SDK 时在代码中填入使用。
2 开通 IM 产品 网易云信控制台 中,为已创建的应用开通 IM 产品服务。

3

注册 IM 账号

  • 如果您有具体的业务需求,那么可以通过服务端接口(/im/v2/accounts)注册 IM 账号,具体请参考 注册 IM 账号
  • 如果您只需要进行简单的体验或者快速测试,那么可以在 网易云信控制台 注册账号。
4 集成 SDK 根据项目具体的开发平台或开发框架,将 NIM SDK 快速集成到您的项目中,填入 AppKey 等开发者身份验证信息。
5 初始化 SDK 初始化时,可配置第三方离线推送服务、会话已读多端同步、群消息已读和融合存储等重要功能。
6 登录 IM 账号 根据业务选择所需的鉴权方式,使用第三步中您创建的 IM 账号完成用户账号登录验证。

7

功能实现

实现即时通讯主要功能模块:

此文档是否对你有帮助?
有帮助
去反馈
  • 支持平台
  • 流程概述