开始使用 IM 产品
更新时间: 2024/03/29 10:34:40
以下流程主要是如何接入云信 IM 国内单元。
1. 创建云信帐号
如果您还没有网易云信帐号,请访问注册。
如果您已经有网易云信帐号,请直接登录。
2. 创建应用并获取 App Key
创建应用是体验或使用网易云信各款产品和服务的首要前提,您可以参考创建应用文档在网易云信控制台创建一个应用,并查看该应用的 App Key。
3. 开通 IM 专业版
IM 专业版支持 Android、iOS、PC、Web 等主流平台的单聊、群聊、支持文字、图片、语音、视频、地理位置等消息类型,同时支持自定义消息,满足个性化需求。请联系云信商务经理,一对一沟通您的具体需求。
使用 IM 专业版功能前,需要在控制台开通 IM 专业版服务,操作步骤如下:
-
在控制台首页应用管理选择应用进入应用配置页面,然后单击 IM即时通讯下的免费试用或正式开通。
-
如需免费试用 IM 专业版,则在免费试用界面指定 IM 节点的服务区域为国内或海外(适用有出海及国际化业务场景),并单击立即试用。 如需正式开通 IM 专业版,则跳过该步骤。
- 免费试用期限为 7 个自然日,试用结束后默认当前应用为IM即时通讯 免费版,您将无法使用 IM 专业版支持的功能。
- 试用结束后,您可以单击套餐升级将免费版升级为专业版,具体开通步骤请参考第 3 步。
-
如需正式开通 IM 专业版,则在套餐对比界面指定 IM 节点的服务区域为国内或海外(适用有出海及国际化业务场景),仔细查看套餐详情,并单击选择该套餐。
-
按应用的实际需求配置服务,控制台会生成预估费用,设置不少于预估费用的充值金额。
关于具体的计费策略,请参考计费方式或咨询商务经理。
-
勾选我已阅读并同意《网易云信服务条款》和《禁止从事任何违法犯罪活动的声明》,并单击提交订单。
-
单击立即支付完成订单支付。开通完成后基本信息页面IM即时通讯 专业版状态为已开通,您可以单击功能配置继续开通和配置具体功能。
请确保账户余额中有足够的金额开通服务。
4. 注册 IM 账号
网易云信 IM 账号是云信 IM 系统中用户的唯一身份标识,通过 IM 账号在应用中使用各种 IM 服务。
开发者将自身应用与云信 IM 对接时,需要注册 IM 账号与自身应用中的账号相对应。您可以根据业务需要注册多个云信 IM 账号来构成应用的账户体系。
注册方式
注册云信 IM 账号可以根据场景分成两种方式:
- 服务端注册:如果您有具体的业务需求,那么可以通过服务端接口注册 IM 账号,具体请参考注册云信 IM 账号。
- 控制台获取:如果您只需要进行简单的体验或者快速测试,那么可以在云信控制台创建账号,具体请参见下文。
- IM 分为免费版和专业版。免费版账号数上限为100个,专业版没有限制。
- 为了保护业务账户的隐私和安全,需要区分测试账户和业务账户,所以通过服务端接口注册的账号不会出现在云信控制台的账号列表中。
- 通过服务端接口注册账户成功后,云信将返回
account_id
与token
,请在应用服务器上维护account_id
与token
信息列表。
控制台配置
-
在控制台首页应用管理选择应用进入应用配置页面,然后单击 IM即时通讯 专业版下的功能配置按钮进入 IM 即时通讯配置页。
-
在顶部选择基础功能页签,单击测试账号管理下的子功能配置。
-
单击新建账号,在弹窗填写账号、昵称、密码后,单击确定。
在云信控制台创建的 IM 账户信息与服务端的账户信息相对应:
- 账号:
accid
- 密码:
token
- 昵称:
name
- 账号:
-
(可选)对于创建好的测试账号,您可以在控制台进行修改昵称,重置密码,以及禁用操作。
5. 配置基础功能/全局功能
-
在控制台首页应用管理选择应用进入应用配置页面,然后单击 IM即时通讯 专业版下的功能配置按钮进入 IM 即时通讯配置页。
-
在顶部选择基础功能或全局功能页签,开启或配置所需功能。
基础功能
需要单独开通和配置的基础功能说明请参考如下列表:
基础功能 | 功能介绍 | 默认值 |
---|---|---|
IM 服务区域 | 服务区域决定了该应用下产品(此处仅对 IM 产品生效)的数据处理和存储,将在哪个区域的单元节点完成。服务区域在正式开通 IM 专业版时指定。 | 无 |
信令 | 开启信令服务 | 默认不开启 |
API 调试 | API 调试测验 | 支持 |
测试账号管理 | 通过控制台创建的账号管理。单击子功能配置创建和管理 IM 账号。 | 支持 |
登录策略 | 设置用户登录应用服务器或云信服务器的方式。单击编辑设置登录鉴权方式。 | 静态 token |
多端登录模式 | 设置用户在不同端的登录模式。单击编辑设置多端登录与互踢。 | 桌面 PC 与 Web 端互踢 移动 Android 与 iOS 端互踢 桌面与移动端同时登录 |
第三方回调 | 单击编辑设置第三方回调的默认服务器地址。 | 无 |
iOS 应用角标未读数上限 | 针对 iOS 应用角标的未读消息数上限配置,最大配置为 99。 | 0 |
应用服务器 IP 白名单 | 仅支持设置的 IP 地址访问,多用于安全防护功能。 | 默认不开启 |
第三方厂商消息分类 | 开启后会将所有通过云信的消息默认配置为配置字段用以各平台的消息分类(单独设置的以设置的为准)。单击子功能配置设置各推送厂商的消息分类。 | 无 |
推送通知 TTL | 设置推送离线消息的存活时间,填写推送通知服务必须向终端节点发送消息的秒数(60 秒 - 604800 秒/7天)。 | 默认不填写 |
自定义推送 | 配置自定义推送文案(通知栏现实的文案),最多可配 100 种自定义文案,每种自定义文案用一个自定义类型来标识。 | 默认不开启 |
添加好友逻辑配置 | 开启后,用户直接调用同意协议或接口添加好友时,系统将进行判断对方是否有发起好友申请。 | 默认不开启 |
单聊消息配置 | 设置非好友关系是否允许发送单聊消息。 | 默认允许 |
消息扩展字段上限调整 | 单条消息可扩展字段的长度上限。 | 1024 |
消息attach字段大小上限 | 修改发送图片/语音/视频/文件消息的 attach 字段上限。 |
4096 |
消息漫游 | 设置用户是否可拉取云端漫游消息。 | 默认不开启 |
消息撤回时长 | 设置用户发送消息后可在多长时间内操作撤回。 | 120 秒 |
撤回消息覆盖策略 | 设置用户撤回消息时是否需要覆盖原始消息的推送。 | 默认不覆盖 |
PC 端在线,强推消息策略配置 | 设置当 PC 端在线时阻止强推消息推到手机端。 | 默认不开启 |
被拉黑时被拉黑者无法唤起呼叫 | 开启后被拉黑者无法呼叫对方。 | 默认不开启 |
IM 离线原因抄送配置 | 开通后抄送内 IM 的 logoutReason 字段可区分是被踢还是主动登出还是掉线。 |
默认不开启 |
聊天室离线原因抄送配置 | 开通后抄送内聊天室的 logoutReason 字段可区分是被踢还是主动登出还是掉线。 |
默认不开启 |
拉黑场景可以正常下发消息已读回执通知 | 开启后若已拉黑对方,则对方的已读回执仍可以发送。 | 默认不开启 |
全局功能
需要单独开通和配置的全局功能说明请参考如下列表:
基础功能 | 功能介绍 | 默认值 |
---|---|---|
好友数 | 单击编辑设置单用户可添加好友数上限。 | 3000 |
在线状态订阅 | 可获取用户的当前在线状态(一般用于用户列表、会话界面显示用户在线或离线)。 | 默认不开启 |
单向消息删除 | 单向删除指一方删除不影响其他方的消息存储。 | 默认不开启 |
会话置顶 | 会话置顶指服务端维护需要个性化配置的会话。 | 默认不开启 |
全员广播 | 即广播通知,单条消息可发送给所有用户。 | 默认不开启 |
历史消息 | 单击编辑设置用户可查询的历史消息范围。 | 默认 1 年 |
高保障消息抄送 | 当客户服务器遇到阻塞或故障不能接受消息时,云信会缓存需要抄送的消息,待客户自有服务器恢复正常后重新抄送,保障抄送消息完整到达。该功能为增值服务。 | 默认不开启 |
客户端反垃圾 | 客户端反垃圾用于配置聊天时希望被过滤的敏感词、违禁词,开通后可在子功能配置进行应用级别的客户端词条配置。该功能为增值服务。 | 默认不开启 |
登录登出事件记录查询 | 可随时查询用户的登录登出事件。该功能为增值服务。 | 默认不开启 |
会话消息标记 | 需要实现 PIN 消息功能时,需开通此功能。类似 slack 里 pin 的能力,可针对某条消息做单独标记,并在标记列表单独展示。该功能为增值服务。 | 默认不开启 |
会话消息回复 | 需要实现 Thread 消息功能时,需开通此功能。可根据某条消息单独进入一个独立会话序。该功能为增值服务。 | 默认不开启 |
消息快捷评论 | 开启后,可针对某条消息直接进行点表情操作(每条消息最多点亮 100 个表情)。该功能为增值服务。 | 默认不开启 |
全文云端消息检索 | 开启后,针对关键词搜索,可提供应用级别的全文检索消息。该功能为增值服务。 | 默认不开启 |
IM存储清理任务管理 | IM 存储提交系统任务自动清理。单击子功能配置新建和管理清理任务。 | 默认支持 |