IM 即时通讯
Web
产品介绍
简介
主要功能
产品优势
海外数据中心
IM平滑迁移方案
接口及业务限制
功能介绍
帐号集成与登录
基础消息功能
群组功能
聊天室功能
聊天室标签功能
多端登录与互踢策略
质量数据监控台
体验 Demo
下载 SDK 与 Demo 源码
更新日志
IM UIKit 更新日志
NIM SDK 开发版更新日志
NIM SDK 稳定版更新日志
快速开始
跑通 IM Demo 源码
实现 IM 文本消息收发(不含 UI)
含 UI 集成
什么是 IM UIKit
IM UIKit 功能概览
快速集成 IM UIKit
非React框架集成 IM UIKit
组件导入
初始化
全局上下文
登录相关
实现消息收发及界面自定义
集成会话列表界面
集成会话消息界面
集成用户资料组件
集成通讯录界面
集成搜索组件
非 React 框架自定义渲染
主题样式设置
语言设置
初始化(兼容 NIM SDK)
不含 UI 集成
集成 SDK
浏览器环境集成
Node.js集成
初始化与登录相关
初始化与登录 IM
IM 连接相关
多端登录与互踢
消息相关
消息概述
消息收发
消息配置选项
广播消息收发
消息已读回执
消息撤回
消息重发与转发
本地消息
通知消息
群通知消息
超大群通知消息
历史消息
最近会话
用户资料托管
好友关系托管
用户关系托管
在线状态订阅
群组功能
群组概述
群组管理
群成员管理
群消息管理
超大群功能
系统通知
系统通知概述
内置系统通知管理
内置系统通知未读数
自定义系统通知收发
开通聊天室功能
聊天室
反垃圾(内容审核)
域名高可用
融合存储方案
扩展功能
工具方法
最佳实践
聊天室重要消息投递
API参考
SDK API (Web)
IM UIKit Store API
状态码
IM 控制台指南
创建应用
注册 IM 账号
升级服务
开通聊天室功能
配置应用客户端标识
常见问题
FAQ
服务协议

圈组接入流程(已不再维护))

更新时间: 2022/12/21 15:55:40

本文已不再维护和更新,请前往实现圈组消息收发查看圈组接入说明。

准备工作

在开始接入圈组前,建议您先了解圈组的主要概念、身份组系统和主要功能等。 详情请参见什么是圈组身份组系统圈组主要功能

步骤一:创建应用并开通服务、获取 App Key

如果您尚未创建获取 App Key 和开通 IM 即时通讯服务,在开始圈组 SDK 集成前,请先完成如下步骤。

  1. 网易云信控制台创建应用。详情请参见创建应用
  2. 获取 App key。详情请参见获取 App key
  3. 开通 IM 即时通讯服务。详情请参考开通服务

步骤二:获取 Token

登录圈组 SDK 时,需要传入 Token。获取 Token 的具体方法请参见账号集成与登录

步骤三:安装 npm 包

圈组功能基于 Web IM Elite 版本,并且以 npm 包形式提供。

  1. 请前往 nim-web-sdk-ng 下载 npm 包。
  2. 执行如下命名进行安装。
> npm install nim-web-sdk-ng@latest

> npm ls nim-web-sdk-ng
└── nim-web-sdk-ng@0.4.0 
  • 请安装 0.4.0 及以上版本的 npm 包。
  • npm 包目前只支持浏览器环境使用。

步骤四:初始化及登录

子步骤

  1. 将圈组 SDK 引入到您的 Web 应用项目。

    import QChatSDK from 'nim-web-sdk-ng/dist/QCHAT_BROWSER_SDK'
    
  2. 初始化圈组 SDK。在如下代码中填入您的App Key、Token、账号、Socket 连接地址和 debugLevel。具体参数说明请参见 圈组实例初始化参数

    const qchat = new QChatSDK({
      appkey: '{{YOUR_APP_KEY}}',
      token: '{{YOUR_TOKEN}}',
      account: '{{YOUR_ACCOUNT}}',
      linkAddresses: ['{{YOUR_ADDRESSES}}'],
      debugLevel: 'debug'
    })
    
  3. 为实例设置监听事件。

    qchat.on('logined', function (loginResult) { console.log(`login done!! ${loginResult}`) })
    
  4. 登录实例。

    await qchat.login()
    

初始化及登录相关重要参数说明,请参见初始化参数介绍

完整示例代码

初始化及登录的完整示例代码如下:

import QChatSDK from 'nim-web-sdk-ng/dist/QCHAT_BROWSER_SDK'

// 1 初始化
const qchat = new QChatSDK({
  appkey: '{{YOUR_APP_KEY}}',
  token: '{{YOUR_TOKEN}}',
  account: '{{YOUR_ACCOUNT}}',
  linkAddresses: ['{{YOUR_ADDRESSES}}'],
  debugLevel: 'debug'
})

// 2 初始化-实例设置监听事件
qchat.on('logined', function (loginResult) { console.log(`login done!! ${loginResult}`) })

// 3 实例登录
await qchat.login()

// 4 使用实例具体方法
await qchat.qchatMsg.sendMessage({
  serverId: '{{YOUR_SERVERID}}',
  channelId: '{{YOUR_CHANNELID}}',
  type: 'text',
  body: 'ddd',
})

后续功能开发

完成圈组登录后,请参见如下文档完成圈组服务器、频道、消息接收等圈组功能的开发:

此文档是否对你有帮助?
有帮助
我要吐槽
  • 准备工作
  • 步骤一:创建应用并开通服务、获取 App Key
  • 步骤二:获取 Token
  • 步骤三:安装 npm 包
  • 步骤四:初始化及登录
  • 子步骤
  • 完整示例代码
  • 后续功能开发