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


一. 好友资料 API 参数相关的 Json Key 定义


1.1 FriendProfileCustomStringInfo (好友自定义资料字段)

JSON 键 值类型 属 性 含 义
kTIMFriendProfileCustomStringInfoKey string 只写 好友自定义资料字段 key, 首先要在 控制台 (功能配置 -> 好友自定义字段) 配置好友自定义字段, key 可以添加 Tag_SNS_Custom_ 前缀, 也可以不添加 Tag_SNS_Custom_ 前缀
kTIMFriendProfileCustomStringInfoValue string 只写 好友自定义资料字段 value


1.2 FriendProfile (好友资料)

JSON 键 值类型 属 性 含 义
kTIMFriendProfileIdentifier string 只读 好友 UserID
kTIMFriendProfileGroupNameArray array string 只读 好友分组名称列表
kTIMFriendProfileRemark string 只读 好友备注, 最大 96 字节, 获取自己资料时, 该字段为空
kTIMFriendProfileAddWording string 只读 好友申请时的添加理由
kTIMFriendProfileAddSource string 只读 好友申请时的添加来源
kTIMFriendProfileAddTime uint64 只读 添加好友的 UTC 时间戳
kTIMFriendProfileUserProfile object UserProfile 只读 好友的个人资料
kTIMFriendProfileCustomStringArray array FriendProfileCustomStringInfo 只读 自定义好友字段


1.3 FriendProfileItem (好友资料可修改的各个项)

JSON 键 值类型 属 性 含 义
kTIMFriendProfileItemRemark string 只写 修改好友备注
kTIMFriendProfileItemGroupNameArray array string 只写 修改好友分组名称列表
kTIMFriendProfileItemCustomStringArray array FriendProfileCustomStringInfo 只写 修改 自定义好友字段


1.4 FriendshipModifyFriendProfileParam (修改好友资料接口的参数)

JSON 键 值类型 属 性 含 义
kTIMFriendshipModifyFriendProfileParamIdentifier string 只写 被修改的好友的 UserID
kTIMFriendshipModifyFriendProfileParamItem object FriendProfileItem 只写 修改的好友资料各个选项


1.5 FriendProfileUpdate (好友资料更新信息)

JSON 键 值类型 属 性 含 义
kTIMFriendProfileUpdateIdentifier string 只写 资料更新的好友的 UserID
kTIMFriendProfileUpdateItem object FriendProfileItem 只写 资料更新的 Item


1.6 FriendChangeElem (好友变更通知)

JSON 键 值类型 属 性 含 义
kTIMFriendChangeElemChangeType uint TIMFriendChangeType 只读 资料变更类型
kTIMFriendChangeElemFriendAddIdentifierArray array string 只读 新增的好友 UserID 列表, 只有当 change_type 为 kTIMFriendChange_FriendAdd 时有效
kTIMFriendChangeElemFriendDelIdentifierArray array string 只读 删除的好友 UserID 列表, 只有当 change_type 为 kTIMFriendChange_FriendDel 时有效
kTIMFriendChangeElemFriendAddPendencyItemArray array FriendAddPendency 只读 好友申请的未决列表, 只有当 change_type 为 kTIMFriendChange_PendencyAdd 时有效
kTIMFriendChangeElemPendencyDelIdentifierArray array string 只读 被删除的好友申请的未决列表, 只有当 change_type 为 kTIMFriendChange_PendencyDel 时有效
kTIMFriendChangeElemPendencyReadedReportTimestamp uint64 只读 未决已读上报时间戳, 只有当 change_type 为 kTIMFriendChange_PendencyReadedReport 时有效
kTIMFriendChangeElemBlackListAddIdentifierArray array string 只读 新增的黑名单 UserID 列表, 只有当 change_type 为 kTIMFriendChange_BlackListAdd 时有效
kTIMFriendChangeElemBlackListDelIdentifierArray array string 只读 删除的黑名单 UserID 列表, 只有当 change_type 为 kTIMFriendChange_BlackListDel 时有效
kTIMFriendChangeElemFriendProfileUpdateItemArray array FriendProfileUpdate 只读 好友资料更新列表, 只有当 change_type 为 kTIMFriendChange_FriendProfileUpdate 时有效
kTIMFriendChangeElemFriendGroupAddIdentifierArray array string 只读 新增的好友分组名称列表, 只有当 change_type 为 kTIMFriendChange_FriendGroupAdd 时有效
kTIMFriendChangeElemFriendGroupDelIdentifierArray array string 只读 删除的好友分组名称列表, 只有当 change_type 为 kTIMFriendChange_FriendGroupDel 时有效
kTIMFriendChangeElemFriendGroupModifyIdentifierArray array string 只读 修改的好友分组名称列表, 只有当 change_type 为 kTIMFriendChange_FriendGroupModify 时有效


二. 好友申请 API 参数相关的 Json Key 定义


2.1 FriendshipAddFriendParam (添加好友接口的参数)

JSON 键 值类型 属 性 含 义
kTIMFriendshipAddFriendParamIdentifier string 只写 请求加好友对应的 UserID
kTIMFriendshipAddFriendParamFriendType uint TIMFriendType 只写 请求添加好友的好友类型
kTIMFriendshipAddFriendParamRemark string 只写 预备注
kTIMFriendshipAddFriendParamGroupName string 只写 预分组名
kTIMFriendshipAddFriendParamAddSource string 只写 加好友来源描述
kTIMFriendshipAddFriendParamAddWording string 只写 加好友附言


2.2 FriendshipDeleteFriendParam (删除好友接口的参数)

JSON 键 值类型 属 性 含 义
kTIMFriendshipDeleteFriendParamFriendType uint TIMFriendType 只写 删除好友, 指定删除的好友类型
kTIMFriendshipDeleteFriendParamIdentifierArray array string 只写(选填) 删除好友 UserID 列表


2.3 FriendAddPendency (好友申请未决信息)

JSON 键 值类型 属 性 含 义
kTIMFriendAddPendencyIdentifier string 只读 添加好友请求方的 UserID
kTIMFriendAddPendencyNickName string 只读 添加好友请求方的昵称
kTIMFriendAddPendencyAddSource string 只读 添加好友请求方的来源
kTIMFriendAddPendencyAddWording string 只读 添加好友请求方的附言


2.4 FriendshipGetPendencyListParam (分页获取好友申请未决信息列表的参数)

JSON 键 值类型 属 性 含 义
kTIMFriendshipGetPendencyListParamType uint TIMFriendPendencyType 只写 添加好友的未决请求类型
kTIMFriendshipGetPendencyListParamStartSeq uint64 只写 分页获取未决请求的起始 seq, 返回的结果包含最大 seq, 作为获取下一页的起始 seq
kTIMFriendshipGetPendencyListParamStartTime uint64 只写 获取未决信息的开始时间戳
kTIMFriendshipGetPendencyListParamLimitedSize int 只写 获取未决信息列表, 每页的数量


2.5 PendencyPage (好友申请未决信息页)

JSON 键 值类型 属 性 含 义
kTIMPendencyPageStartTime uint64 只读 未决请求信息页的起始时间
kTIMPendencyPageUnReadNum uint64 只读 未决请求信息页的未读数量
kTIMPendencyPageCurrentSeq uint64 只读 未决请求信息页的当前 Seq
kTIMPendencyPagePendencyInfoArray array FriendAddPendencyInfo 只读 未决请求信息页的未决信息列表


2.6 FriendAddPendencyInfo (好友申请未决信息)

JSON 键 值类型 属 性 含 义
kTIMFriendAddPendencyInfoType uint TIMFriendPendencyType 只读 好友添加请求未决类型
kTIMFriendAddPendencyInfoIdentifier string 只读 好友添加请求未决的 UserID
kTIMFriendAddPendencyInfoNickName string 只读 好友添加请求未决的昵称
kTIMFriendAddPendencyInfoFaceUrl string 只读 好友添加请求未决的头像
kTIMFriendAddPendencyInfoAddTime uint64 只读 发起好友申请的时间
kTIMFriendAddPendencyInfoAddSource string 只读 好友添加请求未决的添加来源
kTIMFriendAddPendencyInfoAddWording string 只读 好友添加请求未决的添加附言


2.7 FriendResponse (处理好友申请未决信息接口的参数)

JSON 键 值类型 属 性 含 义
kTIMFriendResponseIdentifier string 只写(必填) 响应好友添加的 UserID
kTIMFriendResponseAction uint TIMFriendResponseAction 只写(必填) 响应好友添加的动作
kTIMFriendResponseRemark string 只写(选填) 好友备注
kTIMFriendResponseGroupName string 只写(选填) 好友分组列表


2.8 FriendshipDeletePendencyParam (删除好友申请未决信息接口的参数)

JSON 键 值类型 属 性 含 义
kTIMFriendshipDeletePendencyParamType uint TIMFriendPendencyType 只读 添加好友的未决请求类型
kTIMFriendshipDeletePendencyParamIdentifierArray array string 只读 删除好友未决请求的 UserID 列表


三. 检查好友关系 API 参数相关的 Json Key 定义


3.1 FriendshipCheckFriendTypeParam (检测好友的类型接口的参数)

JSON 键 值类型 属 性 含 义
kTIMFriendshipCheckFriendTypeParamCheckType uint TIMFriendType 只写 要检测的好友类型
kTIMFriendshipCheckFriendTypeParamIdentifierArray array string 只写 要检测的好友 UserID 列表


3.2 FriendshipCheckFriendTypeResult (检测好友的类型接口返回)

JSON 键 值类型 属 性 含 义
kTIMFriendshipCheckFriendTypeResultIdentifier string 只读 被检测的好友 UserID
kTIMFriendshipCheckFriendTypeResultRelation uint TIMFriendCheckRelation 只读 检测成功时返回的好友的类型
kTIMFriendshipCheckFriendTypeResultCode int 错误码 只读 检测的结果
kTIMFriendshipCheckFriendTypeResultDesc string 只读 检测好友失败的描述信息


四. 好友操作(添加、删除、加黑名单等) API 参数相关的 Json Key 定义


4.1 FriendResult (关系链操作接口的返回结果)

JSON 键 值类型 属 性 含 义
kTIMFriendResultIdentifier string 只读 关系链操作的用户 ID
kTIMFriendResultCode int 错误码 只读 关系链操作的结果
kTIMFriendResultDesc string 只读 关系链操作失败的详细描述


五. 好友分组 API 参数相关的 Json Key 定义


5.1 CreateFriendGroupParam (创建好友分组接口参数)

JSON 键 值类型 属 性 含 义
kTIMFriendshipCreateFriendGroupParamNameArray array string 只写 创建分组的名称列表
kTIMFriendshipCreateFriendGroupParamIdentifierArray array string 只写 要放到创建的分组的好友 UserID 列表


5.2 FriendGroupInfo (好友分组信息)

JSON 键 值类型 属 性 含 义
kTIMFriendGroupInfoName string 只读 分组名称
kTIMFriendGroupInfoCount uint64 只读 当前分组的好友个数
kTIMFriendGroupInfoIdentifierArray array string 只读 当前分组内好友 UserID 列表


5.3 FriendshipModifyFriendGroupParam (修改好友分组信息的接口参数)

JSON 键 值类型 属 性 含 义
kTIMFriendshipModifyFriendGroupParamName string 只写 要修改的分组名称
kTIMFriendshipModifyFriendGroupParamNewName string 只写(选填) 修改后的分组名称
kTIMFriendshipModifyFriendGroupParamDeleteIdentifierArray array string 只写(选填) 要从当前分组删除的好友 UserID 列表
kTIMFriendshipModifyFriendGroupParamAddIdentifierArray array string 只写(选填) 当前分组要新增的好友 UserID 列表


六. 好友搜索 API 参数相关的 Json Key 定义


6.1 FriendSearchParam (搜索好友的参数)

JSON 键 值类型 属 性 含 义
kTIMFriendshipSearchParamKeywordList array string 只写 搜索的关键字列表, 关键字列表最多支持 5 个
kTIMFriendshipSearchParamSearchFieldList array uint TIMFriendshipSearchFieldKey 只写 好友搜索类型


6.2 FriendInfoGetResult (搜索好友结果)

JSON 键 值类型 属 性 含 义
kTIMFriendshipFriendInfoGetResultIdentifier string 只读 好友 user_id
kTIMFriendshipFriendInfoGetResultRelationType uint TIMFriendshipRelationType 只读 好友关系
kTIMFriendshipFriendInfoGetResultErrorCode uint 只读 错误码
kTIMFriendshipFriendInfoGetResultErrorMessage string 只读 错误描述
kTIMFriendshipFriendInfoGetResultFriendInfo array uint FriendProfile 只读 好友资料


七. 公众号管理 API 参数相关的 Json Key 定义


7.1 OfficialAccountInfo (公众号信息)

JSON 键 值类型 属 性 含 义
kTIMOfficialAccountID string 只读 公众号 ID
kTIMOfficialAccountName string 只读 公众号名称
kTIMOfficialAccountFaceUrl string 只读 公众号头像 URL
kTIMOfficialAccountOwnerUserID string 只读 公众号所有者
kTIMOfficialAccountIntroduction string 只读 公众号介绍
kTIMOfficialAccountOrganization string 只读 公众号组织
kTIMOfficialAccountCreateTime uint64 只读 公众号创建时间, 单位: 秒
kTIMOfficialAccountSubscriberCount uint64 只读 公众号订阅者数量
kTIMOfficialAccountSubscribeTime uint64 只读 公众号订阅时间, 单位: 秒
kTIMOfficialAccountCustomData string 只读 公众号自定义字段


7.2 GetOfficialAccountInfoResult (获取公众号信息列表接口的返回)

JSON 键 值类型 属 性 含 义
kTIMGetOfficialAccountInfoResultCode int 错误码 只读 获取公众号详细资料的结果
kTIMGetOfficialAccountInfoResultDesc string 只读 获取公众号详细资料失败的描述信息
kTIMGetOfficialAccountInfo object OfficialAccountInfo 只读 公众号详细信息


八. 关注/粉丝 API 参数相关的 Json Key 定义


8.1 FollowOperationResult (关注/取关操作接口的返回结果)

JSON 键 值类型 属 性 含 义
kTIMFollowOperationResultUserID string 只读 关注/取关操作的用户 ID
kTIMFollowOperationResultCode int 错误码 只读 关注/取关的操作返回码
kTIMFollowOperationResultInfo string 只读 关注/取关操作的返回结果描述


8.2 FollowListResult (获取 关注/粉丝/互关 列表的结果)

JSON 键 值类型 属 性 含 义
KTIMFollowListResultNextCursor string 只读 下一次拉要取列表的起始位置
KTIMFollowListResultUerInfoList array UserProfile 只读 用户资料列表


8.3 FollowInfo (用户关注信息)

JSON 键 值类型 属 性 含 义
kTIMFollowInfoResultCode int 错误码 只读 获取用户关注数量信息的返回码
kTIMFollowInfoResultInfo string 只读 获取用户关注数量信息的返回结果描述
kTIMFollowInfoUserID string 只读 用户 ID
kTIMFollowInfoFollowingCount uint64 只读 用户的关注数量
kTIMFollowInfoFollowersCount uint64 只读 用户的粉丝数量
kTIMFollowInfoMutualFollowersCount uint64 只读 用户的互关数量


8.4 FollowTypeCheckResult (指定用户关注类型的检查结果)

JSON 键 值类型 属 性 含 义
kTIMFollowTypeCheckResultUserID string 只读 用户 ID
kTIMFollowTypeCheckResultCode int 错误码 只读 关注类型的检查的返回码
kTIMFollowTypeCheckResultInfo string 只读 关注类型的检查的返回结果描述
kTIMFollowTypeCheckResultFollowType uint TIMFollowType 只读 关注类型