Skip to Content
v7.3.0参数配置即时通讯 IMAndroid

即时通讯 Android 端参数配置说明

本文提供网易云信私有化部署过程中即时通讯（IM）产品 Android 端的关键参数配置说明，帮助技术工程师正确配置客户端与服务端连接参数，确保系统正常运行。

配置参数概述

网易云信即时通讯（IM）私有化部署需要特定的配置参数才能正确连接到私有化环境。本文详细列出了 Android 端所需的全部配置参数，包括参数名称、配置说明及示例。

配置流程说明

配置过程中请确保参数名称、格式完全匹配，任何错误都可能导致连接失败。

  1. 服务器部署：技术人员首先需要完成服务器端部署。
  2. 获取服务器配置参数：从部署完成的服务器获取配置 JSON 数据。
  3. 客户端配置：根据本文将服务器参数正确映射到客户端 SDK 中。
  4. 验证连接：测试客户端是否能正确连接到私有化环境。

关键参数解释

以下是一些关键 IM 参数的概念解释：

  • LBS（Location Based Service）服务器：负责为客户端分配最佳连接的服务器地址，提供高可用性保障。
  • Link 服务器：IM 消息的实际连接服务器，负责消息路由和传输。
  • NOS（Network Object Storage）服务：网易云信的对象存储服务，用于存储和传输文件、图片等媒体内容。
  • 模块（Module）参数：用于客户端与服务器间安全通信的 RSA 加密公钥。
  • 握手模式：客户端与服务器建立连接时的身份验证和加密通道建立方式，分为旧握手模式和新握手模式。

正常私有化服务器部署完成后，获取到的 JSP 地址下的内容参数如下，上述参数参数均可在下面的参数获取。

关键参数解释

以下表格给出了 Android 端参数配置建议，其余参数一般不需要单独配置：

参数配置说明Android
weblbsUrlWeb 端获取客户端连接 link 的地址（客户端会请求 lbs 地址，LBS 会返回一连串能连接的 link 数组给客户端登录）不用填
link_webWeb/uni-app 的默认 link 地址（在 LBS 获取不到 link 的情况下，请求默认 link 连接）不用填
nosSslWeb 端使用使用 HTTPS 连接不用填
lbs除 Web，小程序，uni-app 的其他端获取 link 的地址（客户端会请求 LBS 地址，LBS 会返回一连串能连接的 link 数组给客户端登录）必填，对应初始化 SDKoption 的 ServerAddresses 的 LBS
link除 Web，小程序，uni-app 的其他端默认的 link 地址（在 LBS 获取不到 link 的情况下，请求默认 link 连接）必填，对应初始化 SDKoption 的 ServerAddresses 的 defaultLink
nos_lbs同 link 的 lbs，获取 nos 上传的服务器地址必填，对应初始化 SDKoption 的 ServerAddresses 的 nosUploadLbs
nos_uploader除去 Web，uni-app 和小程序端，对应的其他端的上传地址必填，对应初始化 SDKoption 的 ServerAddresses 的 nosUploadDefaultLink
nos_uploader_host除去 Web，uni-app 和小程序端，对应的其他端的上传域名必填，对应初始化 SDKoption 的 ServerAddresses 的 nosUpload
nego_key_neca_key_parta新握手模式下，非对称加密的公钥（一）
RSA 的 module 或者 SM2 的 x，对应 module 参数去掉前面的 00		必填，对应初始化 SDKoption 的 ServerAddresses 的 negoKeyEncaKeyParta
nego_key_neca_key_partb新握手模式下，非对称加密的公钥（二）
RSA 的 n 或者 SM2 的 y
一般固定为 10001		必填，对应初始化 SDKoption 的 ServerAddresses 的 negoKeyEncaKeyPartb
module 参数旧握手模式（默认）下，RSA 算法的 module，对应 nego_key_neca_key_parta 参数加上 00必填，对应初始化 SDKoption 的 ServerAddresses 的 module
nos_downloadernos 下载拼接地址，一般为 域名+/yunxin+/{object}，例如 file-im.xtkjdemo.com:443/yunxin/{object}选填，对应初始化 SDKoption 的 ServerAddresses 的 nosDownload
nos_accelerateCDN 加速域名的匹配格式。接到消息后附件里的链接若匹配到 nos_accelerate_host，会按这个格式替换。在 SDK 里默认叫 'https://{bucket}-nosdn.netease.im/{object}'选填，对应初始化 SDKoption 的 ServerAddresses 的 nosDownloadUrlFormat
nos_accelerate_hostCDN 加速域名的命中域名。在 SDK 里默认叫 ['nos.netease.com']。这里为空字符串代表放弃 CDN 加速域名设置。选填，对应初始化 SDKoption 的 ServerAddresses 的 nosAccess
statistic_server数据统计上报服务器地址，一般用于数据上报分析排查选填，对应初始化 SDKoption 的 compassDataEndpoint

配置示例

{
    "appkey": "a32e306cdeXXXXXXXXXXXX",
    "lbsUrl": "https://imuat.bolz.cn:2443/lbs/conf.jsp",
    "weblbsUrl": "https://imuat.bolz.cn:2443/lbs/webconf.jsp",
    "nosReplacement": "http://nos.netease.im",
    "nosAccess": "http://115.238.125.243:8000",
    "pubkeyVersion": "0",
    "chatroomDemoListUrl": "https://imuat.bolz.cn:2443/lbs/chatroomList.jsp",
    "websdkSsl": true,
    "nosSsl": true,
    "webchatroomAddr": [        "XX.XX.XX:2443"    ],
    "module": "00a9b3c8344c0cb5375aa884ce960412630a696d6f5f6d4cdb361b2940e921b8c4ba6e84edb3a5141d959c3120e6154420be6f570d60a9d87fa0ea4096efecf0a894f0c122a7151fe918e2c50fccdfd8e8aaadd385e77d8ae6a8dc012c793145bdc7a6816af2e9bc9ce5292dd7d8bd7fc2228XXXXXXXXXXXXXXXXXXXXXXXX9",
    "version": 0,
    "lbs": "https://imuat.bolz.cn:2443/lbs/conf.jsp",
    "link": "imuat.bolz.cn:10180",
    "link_web": "https://imuat.bolz.cn:2443",
    "nos_lbs": "https://imuat.bolz.cn:2443/lbs/noslbs.jsp",
    "nos_uploader": "https://imuat.bolz.cn:2443",
    "nos_uploader_host": "imuat.bolz.cn",
    "https_enabled": true,
    "nos_downloader": "imuat.bolz.cn:2443/{bucket}/{object}",
    "nos_downloader_v2": "imuat.bolz.cn:2443/{bucket}/{object}",
    "nos_accelerate": "",
    "nos_accelerate_host": "",
    "nt_server": "",
    "kibana_server": "",
    "statistic_server": "",
    "report_global_server": "",
    "multi_video": 1,
    "hand_shake_type": 0,
    "nego_key_neca": 1,
    "nego_key_enca_key_version": 0,
    "nego_key_enca_key_parta": "a9b3c8344c0cb5375aa884ce960412630a696d6f5f6d4cdb361b2940e921b8c4ba6e84edb3a5141d959c3120e6154420be6f570d60a9d87fa0ea4096efecf0a894f0c122a7151fe918e2c50fccdfd8e8aaadd385e77d8ae6a8dc012c793145bdc7a6816af2e9bc9ce5292dXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "nego_key_enca_key_partb": "10001",
    "comm_enca": 1
}
最后更新于
操作指南iOS