IMSDK
即时通信 IM 提供全球接入、单聊、群聊、消息推送、资料关系链托管、账号鉴权等全方位解决方案,并提供完备的 App 接入、后台管理接口。
TIMManagerJsonKey


一. SDK 基础 API 参数相关的 Json Key 定义


1.1 SdKConfig (初始化 ImSDK 的配置)

JSON 键 值类型 属 性 含 义
kTIMSdkConfigConfigFilePath string 只写(选填) 配置文件路径, 默认路径为"/"
kTIMSdkConfigLogFilePath string 只写(选填) 日志文件路径, 默认路径为"/"
kTIMSdkConfigMainThreadID int64 只写(选填) 主线程 ID


1.2 UserConfig (用户配置信息)

JSON 键 值类型 属 性 含 义
kTIMUserConfigIsDisableStorage bool 只写(选填) 是否禁用本地数据库, true 表示禁用, false 表示不禁用。 默认是 false


1.3 HttpProxyInfo (HTTP 代理配置信息)

JSON 键 值类型 属 性 含 义
kTIMHttpProxyInfoIp string 只写(必填) 代理的 IP
kTIMHttpProxyInfoPort int 只写(必填) 代理的端口
kTIMHttpProxyInfoUserName string 只写(选填) 认证的用户名
kTIMHttpProxyInfoPassword string 只写(选填) 认证的密码


1.4 Socks5ProxyInfo (SOCKS5 代理配置信息)

JSON 键 值类型 属 性 含 义
kTIMSocks string 只写(必填) socks5 代理的 IP
kTIMSocks int 只写(必填) socks5 代理的端口
kTIMSocks string 只写(选填) 认证的用户名
kTIMSocks string 只写(选填) 认证的密码


1.5 PACProxyInfo (PAC 代理配置信息)

JSON 键 值类型 属 性 含 义
kTIMPACProxyInfoUserName string 只写(选填) 认证的用户名
kTIMPACProxyInfoPassword string 只写(选填) 认证的密码


1.6 SetConfig (更新配置)

JSON 键 值类型 属 性 含 义
kTIMSetConfigLogLevel uint TIMLogLevel 只写(选填) 输出到日志文件的日志级别
kTIMSetConfigCallbackLogLevel uint TIMLogLevel 只写(选填) 日志回调的日志级别
kTIMSetConfigIsLogOutputConsole bool 只写(选填) 是否输出到控制台, 默认为 true
kTIMSetConfigUserConfig object UserConfig 只写(选填) 用户配置
kTIMSetConfigUserDefineData string 只写(选填) 自定义数据, 如果需要, 初始化前设置
注意
  • 开发者可以自定义的数据 (长度限制为 64 个字节), ImSDK 只负责透传给即时通信 IM 后台后, 可以通过第三方回调 状态变更回调 告知开发者业务后台。
kTIMSetConfigHttpProxyInfo object HttpProxyInfo 只写(选填) 设置 HTTP 代理, 如果需要, 在发送图片、文件、语音、视频前设置
注意
  • HTTP 代理主要用在发送图片、语音、文件、微视频等消息时, 将相关文件上传到 COS, 以及接收到图片、语音、文件、微视频等消息, 将相关文件下载到本地时用到
  • 设置时, 设置的 IP 不能为空, 端口不能为 0 (0 端口不可用) .如果需要取消 HTTP 代理, 只需将代理的 IP 设置为空字符串, 端口设置为 0
kTIMSetConfigSocks object Socks5ProxyInfo 只写(选填) 设置 SOCKS5 代理, 如果需要, 初始化前设置
注意
  • SOCKS5 代理需要在初始化之前设置。 设置之后 ImSDK 发送的所有协议会通过 SOCKS5 代理服务器发送的即时通信 IM 后台
kTIMSetConfigPACProxyInfo object PACProxyInfo 只写(选填) 设置 PAC 代理, 如果需要, 初始化前设置
kTIMSetConfigIsOnlyLocalDNSSource bool 只写(选填) 如果为 true, SDK 内部会在选择最优 IP 时只使用 LocalDNS


二. 用户资料 API 参数相关的 Json Key 定义


2.1 FriendShipGetProfileListParam (获取指定用户列表的个人资料的参数)

JSON 键 值类型 属 性 含 义
kTIMFriendShipGetProfileListParamIdentifierArray array string 只写 想要获取目标用户资料的 UserID 列表


2.2 TIMUserStatus (用户状态)

JSON 键 值类型 属 性 含 义
kTIMUserStatusIdentifier string 只读 用户 ID
kTIMUserStatusStatusType uint TIMUserStatusType 只读 用户的状态
kTIMUserStatusCustomStatus string 读写 用户的自定义状态
KTIMUserStatusOnlineDevices array 只读 用户在线终端


2.3 UserProfile (用户个人资料)

JSON 键 值类型 属 性 含 义
kTIMUserProfileIdentifier string 只读 用户 ID
kTIMUserProfileNickName string 只读 用户的昵称
kTIMUserProfileGender uint TIMGenderType 只读 性别
kTIMUserProfileFaceUrl string 只读 用户头像 URL
kTIMUserProfileFriendRemark string 只读 用户好友备注 (请注意, 本字段仅在消息的发送者资料中提供)
kTIMUserProfileSelfSignature string 只读 用户个人签名
kTIMUserProfileAddPermission uint TIMProfileAddPermission 只读 用户加好友的选项
kTIMUserProfileLocation string 只读 用户位置信息
kTIMUserProfileLanguage uint 只读 语言
kTIMUserProfileBirthDay uint 只读 生日
kTIMUserProfileLevel uint 只读 等级
kTIMUserProfileRole uint 只读 角色
kTIMUserProfileCustomStringArray array UserProfileCustomStringInfo 只读 请参考 自定义资料字段


2.4 UserProfileItem (用户自身资料可修改的各个项)

JSON 键 值类型 属 性 含 义
kTIMUserProfileItemNickName string 只写 修改用户昵称
kTIMUserProfileItemGender uint TIMGenderType 只写 修改用户性别
kTIMUserProfileItemFaceUrl string 只写 修改用户头像
kTIMUserProfileItemSelfSignature string 只写 修改用户签名
kTIMUserProfileItemAddPermission uint TIMProfileAddPermission 只写 修改用户加好友的选项
kTIMUserProfileItemLocation string 只写 修改位置
kTIMUserProfileItemLanguage uint 只写 修改语言
kTIMUserProfileItemBirthDay uint 只写 修改生日
kTIMUserProfileItemLevel uint 只写 修改等级
kTIMUserProfileItemRole uint 只写 修改角色
kTIMUserProfileItemCustomStringArray array UserProfileCustomStringInfo 只写 修改 自定义资料字段


2.5 UserProfileCustomStringInfo (用户自定义资料字段, 字符串)

JSON 键 值类型 属 性 含 义
kTIMUserProfileCustomStringInfoKey string 只写 用户自定义资料字段的 key 值 (包含前缀 Tag_Profile_Custom_)
kTIMUserProfileCustomStringInfoValue string 只写 该字段对应的字符串值, 字符串长度不得超过 500 字节


2.6 ProfileChangeElem (资料变更通知)

JSON 键 值类型 属 性 含 义
kTIMProfileChangeElemChangeType uint TIMProfileChangeType 只读 资料变更类型
kTIMProfileChangeElemFromIdentifier string 只读 资料变更用户的 UserID
kTIMProfileChangeElemUserProfileItem object UserProfileItem 只读 具体的变更信息, 只有当 kTIMProfileChangeElemChangeTypekTIMProfileChange_Profile 时有效