资料管理
资料系统简介
即时通信 IM 开放了用户资料托管能力,提供资料相关的一整套完整解决方案。如果您想让每个用户都有自己的资料,并且轻松实现资料的设置和拉取功能,那么您可以选择即时通信 IM 的资料托管服务:
即时通信 IM 提供资料的存储能力,确保您的数据具备异地容灾、多地部署和自动扩容/缩容的能力,帮助您从服务器宕机、多拷贝主从复制和扩容缩容等复杂处理流程中得到完全地解放。
即时通信 IM 提供业界通用的业务处理流程,帮助您在用户资料的业务逻辑上彻底地解放。
即时通信 IM 提供专业的运营流程和运营团队,全年99.99%的稳定服务质量,帮助您为用户提供具有稳定口碑的服务。
即时通信 IM 提供简单易用的服务接口和快捷接入的帮助指引,全程为您提供星级服务。
使用即时通信 IM 的资料托管服务,可以得到以下能力:
标配资料字段的存储、读写能力。
自定义资料字段的存储、读写能力。
资料字段
资料是用来描述用户属性的一组数据,即时通信 IM 资料系统支持标配资料字段和自定义资料字段。资料字段有如下特性:
资料字段通过 Key-Value 来表示。
Key 为 String 类型,其命名仅支持英文大小写字母、数字、下划线。
Value 有以下几种类型:
a. uint32_t 类型的整数(自定义资料字段不支持)。
b. uint64_t 类型的整数(自定义资料字段不支持)。
c. string 类型的字符串(string 的长度不得超过500字节)。
d. bytes 类型的一段 buffer(buffer 的长度不得超过500字节)。
支持配置每个 Key 的读权限和写权限,资料字段的读写权限如下:
权限名称 | 权限类型 | 备注 |
读权限 | App 可读 App 管理员可读 | 可选择读权限的一个或多个类型 |
写权限 | App 可写 App 管理员可写 | 可选择写权限的一个或多个类型 |
标配资料字段
目前即时通信 IM 支持的标配资料字段如下:
字段名称 | 类型 | 描述 | 更新时有 Push | 备注 |
Tag_Profile_IM_Nick | string | 昵称 | 有 | 长度不得超过500个字节 |
Tag_Profile_IM_Gender | string | 性别 | 有 | Gender_Type_Unknown:没设置性别 Gender_Type_Female:女性 Gender_Type_Male:男性 |
Tag_Profile_IM_BirthDay | uint32 | 生日 | 有 | 推荐用法:20190419 |
Tag_Profile_IM_Location | string | 所在地 | 有 | 长度不得超过16个字节,推荐用法如下: App 本地定义一套数字到地名的映射关系 后台实际保存的是4个 uint32_t 类型的数字 其中第一个 uint32_t 表示国家 第二个 uint32_t 用于表示省份 第三个 uint32_t 用于表示城市 第四个 uint32_t 用于表示区县 |
Tag_Profile_IM_SelfSignature | string | 个性签名 | 有 | 长度不得超过500个字节 |
Tag_Profile_IM_AllowType | string | 加好友验证方式 | 有 | AllowType_Type_NeedConfirm:需要经过自己确认对方才能添加自己为好友 AllowType_Type_AllowAny:允许任何人添加自己为好友 AllowType_Type_DenyAny:不允许任何人添加自己为好友 |
Tag_Profile_IM_Language | uint32 | 语言 | 有 | App 本地定义数字与语言的映射关系,需要 App 本地将语言对应的数字转换为文字 |
Tag_Profile_IM_Image | string | 头像URL | 有 | 长度不得超过500个字节 |
Tag_Profile_IM_AdminForbidType | string | 管理员禁止加好友标识 | 有 | AdminForbid_Type_None:默认值,允许加好友 AdminForbid_Type_SendOut:禁止该用户发起加好友请求 |
Tag_Profile_IM_Level | uint32 | 等级 | 有 | 通常一个 UINT-8 数据即可保存一个等级信息您可以考虑拆分保存,从而实现多种角色的等级信息 |
Tag_Profile_IM_Role | uint32 | 角色 | 有 | 通常一个 UINT-8 数据即可保存一个角色信息您可以考虑拆分保存,从而保存多种角色信息 |
自定义资料字段
自定义资料字段是各 App 根据各自业务需要而设置的用户数据。通过自定义资料,各 App 可以将一些额外数据附加到用户资料上,并通过现有接口进行读写操作。
自定义资料字段的申请
自定义资料字段的名称(Key):详情可参见 自定义资料字段的命名规范
自定义资料字段的类型(Value):详情可参见 资料字段
自定义资料字段的读权限及写权限:详情可参见 资料字段
自定义资料字段的命名规范
自定义资料字段的命名规则如下:
自定义资料字段的名称包括前缀和关键字两部分。
自定义资料字段的前缀是:Tag_Profile_Custom。
关键字:必须是英文字母,且长度不得超过8字节,建议用一个英文单词或该英文单词的缩写。
示例:某 App 要申请的自定义字段的关键字是 Test,则自定义资料字段的名称是:Tag_Profile_Custom_Test。