创建 NERoom 应用

更新时间: 2023/09/27 03:29:38

创建 NERoom 应用时可以绑定该应用对应的场景模板,帮助您快速定制应用的 SDK。本文介绍如何在云信控制台创建 NERoom 应用。

注意事项

  • 一个账号最多创建 10 个 NERoom 应用。
  • NERoom 应用创建后不能删除,请根据您的实际需求创建 NERoom 应用。
  • 一个 NERoom 应用可以对应多个不同场景的模板,例如,您可以给 App 绑定语聊房和互动直播的模板。创建 NERoom 应用时只能选择一个模板,您可以在创建 NERoom 应用后,在查看应用详情页面添加其他模板。

前提条件

您已经在网易云信官网注册了云信账号,并完成实名认证。

原理介绍

  • 在网易云信控制台创建 NERoom 应用后,会生成 App Key、模板 ID 和角色 ID。通过 NERoom SDK 实现 App 时,需要传入这些参数,他们的对应关系如下图所示。

    NERoom应用的参数与App的关系.png

    1. 在初始化 NERoom SDK时,会用到 App Key。请设置为相应 NERoom 应用对应的 App Key。
    2. 在使用 NERoom SDK 进行创建房间时,需要填写模板 ID。请设置为相应 NERoom 应用对应的模板 ID,获取方法请参见如何获取模板 ID
    3. 用户进入房间时,App 需要告知 NERoom SDK 该用户的角色ID。请设置为相应 NERoom 应用对应的角色 ID,获取方法请参见如何获取角色 ID
  • 用户在对房间和成员进行操作时,NERoom Server 会进行权限校验。校验规则为:根据模板 ID 和角色 ID 查看该角色是否具备相应操作的权限。例如:角色 ID 为 host 的用户,进行删除房间和移除成员操作时,权限校验的流程如下图所示。

    NERoom权限校验.png

创建 NERoom 应用

  1. 登录网易云信控制台

  2. 在左侧导航栏中选择 NERoom > NERoom应用。在右上角单击创建应用

  3. 创建应用区域,填写应用的基本信息。单击下一步

    配置 说明
    应用名称 支持中文、英文、数字和特殊字符,长度为 1~20 个字符。
    行业类型 该应用的对应行业。
    内容简介 应用的备注说明或简单介绍,可选项,便于您标识该应用。长度为 1~200 个字符。
    节点选择 根据业务需要选择将数据存储在国内节点或海外节点。
    • 国内:数据存储在国内数据中心。适用于业务在国内,或有出海需求,但是数据不需要存储在海外数据中心的场景。
    • 海外:数据存储在新加坡的数据中心。适用于业务在海外或业务需要出海的场景。

    创建应用时请务必正确选择节点类型,不支持国内节点和海外节点间数据迁移。

    国内节点和海外节点的关系如下:

    • 应用级别的信息全局共享,如 App Key 信息、云信能力的开通和关闭。
    • 应用内的信息存储于各节点所属数据中心。
    • 国内节点和海外节点的 API 域名不互通,如果连接错误,会返回 403。
    • 海外节点相关域名会添加国内加速代理和海外其他地区的加速代理,提高访问速度。
  4. 创建NERoom应用

    1. 模板选择区域,选择系统自带的场景模板或自定义模板。单击下一步
    • 如果选择系统自带的场景模板,例如互动直播,该场景模板对应的角色和权限无法修改。
    • 如果选择自定义模板,您可以根据业务场景自定义角色以及各角色的权限。具体操作步骤请参见自定义场景

    选择NERoom模板

    1. 能力配置区域,单击下一步

    请联系云信商务经理开通相应能力产品的服务,页面中展示的能力仅供浏览。具体操作步骤请参见开通能力

    1. 配置成功区域,下载相应平台的 SDK。

    退出创建 NERoom 的页面后,您可以在开发者页面下载 SDK。具体操作步骤请参见下载 SDK

    1. 在右下角单击回到主页。 在 NERoom 应用列表中显示已创建的 NERoom 应用。
此文档是否对你有帮助?
有帮助
去反馈
  • 注意事项
  • 前提条件
  • 原理介绍
  • 创建 NERoom 应用