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


一. 群组系统通知相关 Json Key 定义


1.1 GroupTipGroupChangeInfo (群组系统消息-群组信息修改)

JSON 键 值类型 属 性 含 义
kTIMGroupTipGroupChangeInfoFlag uint TIMGroupTipGroupChangeFlag 只读 群消息修改群信息标志
kTIMGroupTipGroupChangeInfoValue string 只读 修改的后值, 不同的 info_flag 字段, 具有不同的含义
kTIMGroupTipGroupChangeInfoKey string 只读 自定义信息对应的 key 值, 只有 info_flag 为 kTIMGroupTipChangeFlag_Custom 时有效
kTIMGroupTipGroupChangeInfoBoolValue bool 只读 根据变更类型表示不同的值, 当前在 info_flag 为 kTIMGroupTipChangeFlag_ShutupAll 或者 kTIMGroupTipChangeFlag_EnablePermissionGroup 时有效
kTIMGroupTipGroupChangeInfoIntValue int 只读 根据变更类型表示不同的值
注意
仅针对以下类型有效:
  • 从 6.5 版本开始, 当 info_flag 为 kTIMGroupTipChangeFlag_MessageReceiveOpt 时, 该字段标识了群消息接收选项发生了变化, 其取值详见 TIMReceiveMessageOpt
  • 从 6.5 版本开始, 当 info_flag 为 kTIMGroupTipChangeFlag_GroupAddOpt 时, 该字段标识了申请加群审批选项发生了变化, 其取值详见 TIMGroupAddOption
  • 从 7.1 版本开始, 当 info_flag 为 kTIMGroupTipChangeFlag_GroupApproveOpt 时, 该字段标识了邀请进群审批选项发生了变化, 取值类型详见 TIMGroupAddOption
kTIMGroupTipGroupChangeInfoUint uint64 只读 根据变更类型表示不同的值, 当前只有 info_flag 为 kTIMGroupTipChangeFlag_DefaultPermissions 时有效


1.2 GroupTipMemberChangeInfo (群组系统消息-群组成员禁言)

JSON 键 值类型 属 性 含 义
kTIMGroupTipMemberChangeInfoIdentifier string 只读 群组成员 ID
kTIMGroupTipMemberChangeInfoShutupTime uint 只读 禁言时间


1.3 GroupTipMemberMarkChangeInfo (群组系统消息-群组成员标记变更)

JSON 键 值类型 属 性 含 义
kTIMGroupTipMemberChangeInfoEnableMark bool 只读 群成员被标记或取消标记
kTIMGroupTipMemberMarkChangeInfoMarkType uint 只读 标记类型
kTIMGroupTipMemberMarkChangeInfoUserIDList array string 只读 群成员 userID 列表


1.4 GroupTipsElem (群组系统消息元素)

注意
JSON 键 值类型 属 性 含 义
kTIMGroupTipsElemTipType uint TIMGroupTipType 只读 群消息类型
kTIMGroupTipsElemOpUser string 只读 操作者 ID
kTIMGroupTipsElemGroupId string 只读 群组 ID
kTIMGroupTipsElemUserArray array string 只读 被操作的账号列表
kTIMGroupTipsElemGroupChangeInfoArray array GroupTipGroupChangeInfo 只读 群资料变更信息列表, 仅当 kTIMGroupTipsElemTipType 值为 kTIMGroupTip_GroupInfoChange 时有效
kTIMGroupTipsElemMemberChangeInfoArray array GroupTipMemberChangeInfo 只读 群成员变更信息列表, 仅当 kTIMGroupTipsElemTipType 值为 kTIMGroupTip_MemberInfoChange 时有效
kTIMGroupTipsElemOpUserInfo object UserProfile 只读 操作者个人资料
kTIMGroupTipsElemOpGroupMemberInfo object GroupMemberInfo 只读 群成员信息
kTIMGroupTipsElemChangedUserInfoArray array UserProfile 只读 被操作者列表资料
kTIMGroupTipsElemChangedGroupMemberInfoArray array GroupMemberInfo 只读 群成员信息列表
kTIMGroupTipsElemMemberNum uint 只读 当前群成员数, 只有当事件消息类型为 kTIMGroupTip_InvitekTIMGroupTip_QuitkTIMGroupTip_Kick 时有效
kTIMGroupTipsElemPlatform string 只读 操作方平台信息
kTIMGroupTipsElemMemberMarkInfoArray array GroupTipMemberMarkChangeInfo 只读 群成员标记变更信息列表, 仅当 kTIMGroupTipsElemTipType 值为 kTIMGroupTip_MemberMarkChange 时有效
kTIMGroupTipsElemPinnedMessageList - 只读 变更的置顶群消息


二. 群组管理 API 参数相关的 Json Key 定义


2.1 GroupMemberInfo (群成员信息)

JSON 键 值类型 属 性 含 义
kTIMGroupMemberInfoIdentifier string 读写(必填) 群组成员 ID
kTIMGroupMemberInfoGroupId string 只读 群组 ID
kTIMGroupMemberInfoJoinTime uint 只读 群组成员加入时间
kTIMGroupMemberInfoMemberRole uint TIMGroupMemberRole 读写(选填) 群组成员角色
kTIMGroupMemberInfoMsgFlag uint TIMReceiveMessageOpt 只读 成员接收消息的选项
kTIMGroupMemberInfoMsgSeq uint 只读 消息序列号
kTIMGroupMemberInfoShutupTime uint 只读 成员禁言时间
kTIMGroupMemberInfoNameCard string 只读 成员群名片
kTIMGroupMemberInfoNickName string 只读 好友昵称
kTIMGroupMemberInfoFriendRemark string 只读 好友备注
kTIMGroupMemberInfoFaceUrl string 只读 好友头像
kTIMGroupMemberInfoCustomInfo array GroupMemberInfoCustomString 只读 请参考 自定义字段
kTIMGroupMemberInfoIsOnline string 只读 群成员是否在线
KTIMGroupMemberInfoOnlineDevices array 只读 群成员在线终端列表


2.2 CreateGroupParam (创建群组接口的参数)

JSON 键 值类型 属 性 含 义
kTIMCreateGroupParamGroupName string 只写(必填) 群组名称
kTIMCreateGroupParamGroupId string 只写(选填) 群组 ID, 不填时创建成功回调会返回一个后台分配的群 ID, 如果创建社群 (Community) 需要自定义群组 ID, 那必须以 " @TGS#_ " 作为前缀
kTIMCreateGroupParamGroupType uint TIMGroupType 只写(选填) 群组类型, 默认为 Public
kTIMCreateGroupIsSupportTopic bool 只写(选填) 社群是否支持创建话题, 只在群类型为 Community 时有效
kTIMCreateGroupParamGroupMemberArray array GroupMemberInfo 只写(选填) 群组初始成员数组, 成员个数不能超过 20 (7.1 及其以上版本开始限制)
kTIMCreateGroupParamNotification string 只写(选填) 群组公告
kTIMCreateGroupParamIntroduction string 只写(选填) 群组简介
kTIMCreateGroupParamFaceUrl string 只写(选填) 群组头像 URL
kTIMCreateGroupParamAddOption uint TIMGroupAddOption 只写(选填) 申请加群审批选项, 不同类型的群组支持的申请加群审批选项请参考 官网
kTIMCreateGroupParamApproveOption uint TIMGroupAddOption 只写(选填) 邀请进群审批选项, 不同类型的群组支持的邀请进群审批选项请参考 官网
kTIMCreateGroupParamMaxMemberCount uint 只写(选填) 群组最大成员数
kTIMCreateGroupParamCustomInfo array GroupInfoCustomString 只读(选填) 请参考 自定义字段
kTIMCreateGroupParamEnablePermissionGroup bool 只写(选填) 开启权限组功能, 仅支持社群, 7.8 版本开始支持。 开启后, 管理员角色的权限失效, 用群权限、话题权限和权限组能力来对社群、话题进行管理
kTIMCreateGroupParamDefaultPermissions uint64 只写(选填) 群默认权限, 仅支持社群, 7.8 版本开始支持。 群成员在没有加入任何权限组时的默认权限, 仅在 enablePermissionGroup = true 打开权限组之后生效


2.3 CreateGroupResult (创建群组接口的返回)

JSON 键 值类型 属 性 含 义
kTIMCreateGroupResultGroupId string 只读 创建的群 ID


2.4 GroupSelfInfo (群组内本人的信息)

JSON 键 值类型 属 性 含 义
kTIMGroupSelfInfoJoinTime uint 只读 加入群组时间
kTIMGroupSelfInfoRole uint 只读 用户在群组中的角色
kTIMGroupSelfInfoUnReadNum uint 只读 消息未读计数
kTIMGroupSelfInfoMsgFlag uint TIMReceiveMessageOpt 只读 消息接收选项


2.5 GroupBaseInfo (群组基础信息, 获取已加入群组列表接口的返回信息)

JSON 键 值类型 属 性 含 义
kTIMGroupBaseInfoGroupId string 只读 群组 ID
kTIMGroupBaseInfoGroupName string 只读 群组名称
kTIMGroupBaseInfoGroupType uint TIMGroupType 只读 群组类型
kTIMGroupBaseInfoFaceUrl string 只读 群组头像 URL
kTIMGroupBaseInfoInfoSeq uint 只读 群资料的 Seq, 群资料的每次变更都会增加这个字段的值
kTIMGroupBaseInfoLatestSeq uint 只读 群最新消息的 Seq。 群组内每一条消息都有一条唯一的消息 Seq, 且该 Seq 是按照发消息顺序而连续的。 从 1 开始, 群内每增加一条消息, LatestSeq 就会增加 1
kTIMGroupBaseInfoReadedSeq uint 只读 用户所在群已读的消息 Seq
kTIMGroupBaseInfoMsgFlag uint 只读 消息接收选项
kTIMGroupBaseInfoIsShutupAll bool 只读 当前群组是否设置了全员禁言
kTIMGroupBaseInfoSelfInfo object GroupSelfInfo 只读 用户所在群的个人信息


2.6 GroupInfoCustomString (群资料自定义字段)

JSON 键 值类型 属 性 含 义
kTIMGroupInfoCustomStringInfoKey string 只写 自定义字段的 key
kTIMGroupInfoCustomStringInfoValue string 只写 自定义字段的 value


2.7 GroupDetailInfo (群组详细信息)

JSON 键 值类型 属 性 含 义
kTIMGroupDetailInfoGroupId string 只读 群组 ID
kTIMGroupDetailInfoGroupType uint TIMGroupType 只读 群组类型
kTIMGroupDetailInfoIsSupportTopic bool 只读 社群是否支持创建话题, 只在群类型为 Community 时有效
kTIMGroupDetailInfoGroupName string 只读 群组名称
kTIMGroupDetailInfoNotification string 只读 群组公告
kTIMGroupDetailInfoIntroduction string 只读 群组简介
kTIMGroupDetailInfoFaceUrl string 只读 群组头像 URL
kTIMGroupDetailInfoCreateTime uint 只读 创建群组的 UTC 时间戳
kTIMGroupDetailInfoInfoSeq uint 只读 群资料的 Seq, 群资料的每次变更都会增加这个字段的值
kTIMGroupDetailInfoLastInfoTime uint 只读 上次修改群信息的 UTC 时间戳
kTIMGroupDetailInfoNextMsgSeq uint 只读 群最新消息的 Seq
kTIMGroupDetailInfoLastMsgTime uint 只读 最新群组消息时间
kTIMGroupDetailInfoMemberNum uint 只读 群组当前成员数量
kTIMGroupDetailInfoMaxMemberNum uint 只读 群组最大成员数量
kTIMGroupDetailInfoAddOption uint TIMGroupAddOption 只读 群组申请加群审批选项
kTIMGroupDetailInfoApproveOption uint TIMGroupAddOption 只读 群组邀请进群审批选项
kTIMGroupDetailInfoVisible uint 只读 群组成员是否对外可见
kTIMGroupDetailInfoSearchable uint 只读 群组是否能被搜索
kTIMGroupDetailInfoIsShutupAll bool 只读 群组是否被设置了全员禁言
kTIMGroupDetailInfoOwnerIdentifier string 只读 群组所有者 ID
kTIMGroupDetailInfoCustomInfo array GroupInfoCustomString 只读 请参考 自定义字段
kTIMGroupDetailInfoEnablePermissionGroup bool 只读 开启权限组功能, 仅在社群生效, 7.8 版本开始支持
kTIMGroupDetailInfoDefaultPermissions uint 只读 群组权限, 仅在社群生效, 7.8 版本开始支持


2.8 GetGroupInfoResult (获取群组信息列表接口的返回)

JSON 键 值类型 属 性 含 义
kTIMGetGroupInfoResultCode int 错误码 只读 获取群组详细信息的结果
kTIMGetGroupInfoResultDesc string 只读 获取群组详细失败的描述信息
kTIMGetGroupInfoResultInfo object GroupDetailInfo 只读 群组详细信息


2.9 GroupSearchParam (群搜索参数)

JSON 键 值类型 属 性 含 义
TIMGroupSearchParamKeywordList array string 只写(选填) 搜索关键字列表, 最多支持 5 个
TIMGroupSearchParamFieldList array TIMGroupSearchFieldKey 只写(选填) 搜索域列表


2.10 GroupModifyInfoParam (设置群信息接口的参数)

JSON 键 值类型 属 性 含 义
kTIMGroupModifyInfoParamGroupId string 只写(必填) 群组 ID
kTIMGroupModifyInfoParamModifyFlag uint TIMGroupModifyInfoFlag 只写(必填) 修改标识, 可设置多个值按位或
kTIMGroupModifyInfoParamGroupName string 只写(选填) 修改群组名称, 当 modify_flag 包含 kTIMGroupModifyInfoFlag_Name 时必填, 其他情况不用填
kTIMGroupModifyInfoParamNotification string 只写(选填) 修改群公告, 当 modify_flag 包含 kTIMGroupModifyInfoFlag_Notification 时必填, 其他情况不用填
kTIMGroupModifyInfoParamIntroduction string 只写(选填) 修改群简介, 当 modify_flag 包含 kTIMGroupModifyInfoFlag_Introduction 时必填, 其他情况不用填
kTIMGroupModifyInfoParamFaceUrl string 只写(选填) 修改群头像 URL, 当 modify_flag 包含 kTIMGroupModifyInfoFlag_FaceUrl 时必填, 其他情况不用填
kTIMGroupModifyInfoParamAddOption uint 只写(选填) 申请加群审批选项, 当 modify_flag 包含 kTIMGroupModifyInfoFlag_AddOption 时必填, 其他情况不用填
kTIMGroupModifyInfoParamApproveOption uint 只写(选填) 邀请进群审批选项, 当 modify_flag 包含 kTIMGroupModifyInfoFlag_ApproveOption 时必填, 其他情况不用填
kTIMGroupModifyInfoParamMaxMemberNum uint 只写(选填) 修改群最大成员数, 当 modify_flag 包含 kTIMGroupModifyInfoFlag_MaxMemberNum 时必填, 其他情况不用填
kTIMGroupModifyInfoParamVisible uint 只写(选填) 修改群是否可见, 当 modify_flag 包含 kTIMGroupModifyInfoFlag_Visible 时必填, 其他情况不用填
kTIMGroupModifyInfoParamSearchAble uint 只写(选填) 修改群是否允许被搜索, 当 modify_flag 包含 kTIMGroupModifyInfoFlag_Searchable 时必填, 其他情况不用填
kTIMGroupModifyInfoParamIsShutupAll bool 只写(选填) 修改群是否全体禁言, 当 modify_flag 包含 kTIMGroupModifyInfoFlag_ShutupAll 时必填, 其他情况不用填
kTIMGroupModifyInfoParamOwner string 只写(选填) 修改群主所有者, 当 modify_flag 包含 kTIMGroupModifyInfoFlag_Owner 时必填, 其他情况不用填。 此时 modify_flag 不能包含其他值, 当修改群主时, 同时修改其他信息已无意义
kTIMGroupModifyInfoParamCustomInfo array GroupInfoCustomString 只写(选填) 请参考 自定义字段
kTIMGroupModifyInfoParamEnablePermissionGroup bool 只写(选填) 修改是否开启权限组功能, 仅支持社群, 7.8 版本开始支持
kTIMGroupModifyInfoParamDefaultPermissions uint 只写(选填) 修改群权限, 仅支持社群, 7.8 版本开始支持


2.11 GroupAttributes (设置群属性的 map 对象)

JSON 键 值类型 属 性 含 义
TIMGroupAttributeKey string 只写 群属性 map 的 key
TIMGroupAttributeValue string 只写 群属性 map 的 value


2.12 GroupCounter (群计数器信息)

JSON 键 值类型 属 性 含 义
kTIMGroupCounterKey string 读写 群计数器的 key 值
kTIMGroupCounterValue int64 读写 群计数器的 value 值


2.13 GroupGetOnlineMemberCountResult (获取指定群在线人数结果)

JSON 键 值类型 属 性 含 义
TIMGroupGetOnlineMemberCountResult int 只读 指定群的在线人数


三. 话题 API 参数相关的 Json Key 定义


3.1 TIMGroupTopicInfo (获取指定群话题信息结果)

JSON 键 值类型 属 性 含 义
kTIMGroupTopicInfoTopicID string 读写 话题 ID, 只能在创建话题或者修改话题信息的时候设置。 组成方式为: 社群 ID + @TOPIC_xxx, 例如社群 ID 为 @TGS_123, 则话题 ID 为 @TGS_123@TOPIC_xxx
kTIMGroupTopicInfoTopicName string 读写 话题名称
kTIMGroupTopicInfoIntroduction string 读写 话题介绍
kTIMGroupTopicInfoNotification string 读写 话题公告
kTIMGroupTopicInfoTopicFaceURL string 读写 话题头像
kTIMGroupTopicInfoIsAllMuted bool 读写 话题全员禁言
kTIMGroupTopicInfoSelfMuteTime uint32 读写 当前用户在话题中的禁言时间
kTIMGroupTopicInfoCustomString string 读写 话题自定义字段
kTIMGroupTopicInfoRecvOpt uint TIMReceiveMessageOpt 只读 话题消息接收选项, 修改话题消息接收选项请调用 setGroupReceiveMessageOpt 接口
kTIMGroupTopicInfoDraftText string 读写 话题草稿
kTIMGroupTopicInfoUnreadCount uint64 只读 话题消息未读数量
kTIMGroupTopicInfoLastMessage object Message 只读 话题 lastMessage
kTIMGroupTopicInfoGroupAtInfoArray array GroupAtInfo 只读 话题 at 信息列表
kTIMGroupTopicInfoModifyFlag uint TIMGroupModifyInfoFlag 只写(必填) 修改标识, 可设置多个值按位或


3.2 TIMGroupTopicOperationResult (话题操作结果)

JSON 键 值类型 属 性 含 义
kTIMGroupTopicOperationResultErrorCode int 只读 结果 0: 成功; 非 0: 失败
kTIMGroupTopicOperationResultErrorMessage string 只读 如果删除失败, 会返回错误信息
kTIMGroupTopicOperationResultTopicID string 只读 如果删除成功, 会返回对应的 topicID


3.3 TIMGroupTopicInfoResult (获取话题信息的结果)

JSON 键 值类型 属 性 含 义
kTIMGroupTopicInfoResultErrorCode int 只读 结果 0: 成功; 非 0: 失败
kTIMGroupTopicInfoResultErrorMessage string 只读 如果删除失败, 会返回错误信息
kTIMGroupTopicInfoResultTopicInfo object TIMGroupTopicInfo 只读 如果获取成功, 会返回对应的 info


四. 群成员管理 API 参数相关的 Json Key 定义


4.1 GroupMemberGetInfoOption (获取群组成员信息的选项)

JSON 键 值类型 属 性 含 义
kTIMGroupMemberGetInfoOptionRoleFlag uint64 TIMGroupMemberRoleFlag 读写(选填) 根据成员角色过滤, 默认值为 kTIMGroupMemberRoleFlag_All, 获取所有角色


4.2 GroupGetMemberInfoListParam (获取群成员列表接口的参数)

JSON 键 值类型 属 性 含 义
kTIMGroupGetMemberInfoListParamGroupId string 只写(必填) 群组 ID
kTIMGroupGetMemberInfoListParamIdentifierArray array string 只写(选填) 群成员 ID 列表
kTIMGroupGetMemberInfoListParamOption object GroupMemberGetInfoOption 只写(选填) 获取群成员信息的选项
kTIMGroupGetMemberInfoListParamNextSeq uint64 只写(选填) 分页拉取标志, 第一次拉取填 0, 回调成功如果不为零, 需要分页, 调用接口传入再次拉取, 直至为 0


4.3 GroupGetMemberInfoListResult (获取群成员列表接口的返回)

JSON 键 值类型 属 性 含 义
kTIMGroupGetMemberInfoListResultNexSeq uint64 只读 下一次拉取的标志, server 返回 0 表示没有更多的数据, 否则在下次获取数据时填入这个标志
kTIMGroupGetMemberInfoListResultInfoArray array GroupMemberInfo 只读 成员信息列表


4.4 GroupMemberSearchParam (群成员搜索参数)

JSON 键 值类型 属 性 含 义
TIMGroupMemberSearchParamGroupidList array string 只写(选填) 指定群 ID 列表, 若为不填则搜索全部群中的群成员
TIMGroupMemberSearchParamKeywordList array string 只写(必填) 搜索关键字列表, 最多支持 5 个
TIMGroupMemberSearchParamFieldList array TIMGroupMemberSearchFieldKey 只写(必填) 搜索域列表


4.5 GroupSearchGroupMembersResult (群成员搜索结果)

JSON 键 值类型 属 性 含 义
TIMGroupSearchGroupMembersResultGroupID array string 只读 群 id 列表
TIMGroupSearchGroupMembersResultMemberInfoList array GroupMemberInfo 只读 群成员的列表


4.6 GroupMemberInfoCustomString (群成员信息自定义字段)

JSON 键 值类型 属 性 含 义
kTIMGroupMemberInfoCustomStringInfoKey string 只写 自定义字段的 key
kTIMGroupMemberInfoCustomStringInfoValue string 只写 自定义字段的 value


4.7 GroupModifyMemberInfoParam (设置群成员信息接口的参数)

JSON 键 值类型 属 性 含 义
kTIMGroupModifyMemberInfoParamGroupId string 只写(必填) 群组 ID
kTIMGroupModifyMemberInfoParamIdentifier string 只写(必填) 被设置信息的成员 ID
kTIMGroupModifyMemberInfoParamModifyFlag uint TIMGroupMemberModifyInfoFlag 只写(必填) 修改类型, 可设置多个值按位或
kTIMGroupModifyMemberInfoParamMsgFlag uint TIMReceiveMessageOpt 只写(选填) 修改消息接收选项, 当 modify_flag 包含 kTIMGroupMemberModifyFlag_MsgFlag 时必填, 其他情况不用填
kTIMGroupModifyMemberInfoParamMemberRole uint TIMGroupMemberRole 只写(选填) 修改成员角色, 当 modify_flag 包含 kTIMGroupMemberModifyFlag_MemberRole 时必填, 其他情况不用填
kTIMGroupModifyMemberInfoParamShutupTime uint 只写(选填) 修改禁言时间, 当 modify_flag 包含 kTIMGroupMemberModifyFlag_ShutupTime 时必填, 其他情况不用填
kTIMGroupModifyMemberInfoParamNameCard string 只写(选填) 修改群名片, 当 modify_flag 包含 kTIMGroupMemberModifyFlag_NameCard 时必填, 其他情况不用填
kTIMGroupModifyMemberInfoParamCustomInfo array GroupMemberInfoCustomString 只写(选填) 请参考 自定义字段


4.8 GroupInviteMemberParam (邀请成员接口的参数)

JSON 键 值类型 属 性 含 义
kTIMGroupInviteMemberParamGroupId string 只写(必填) 群组 ID
kTIMGroupInviteMemberParamIdentifierArray array string 只写(必填) 被邀请加入群组用户 ID 数组
kTIMGroupInviteMemberParamUserData string 只写(选填) 用于自定义数据


4.9 GroupInviteMemberResult (邀请成员接口的返回)

JSON 键 值类型 属 性 含 义
kTIMGroupInviteMemberResultIdentifier string 只读 被邀请加入群组的用户 ID
kTIMGroupInviteMemberResultResult uint HandleGroupMemberResult 只读 邀请结果


4.10 GroupDeleteMemberParam (删除成员接口的参数)

JSON 键 值类型 属 性 含 义
kTIMGroupDeleteMemberParamGroupId string 只写(必填) 群组 ID
kTIMGroupDeleteMemberParamIdentifierArray array string 只写(必填) 被删除群组成员数组
kTIMGroupDeleteMemberParamUserData string 只写(选填) 用于自定义数据
kTIMGroupDeleteMemberParamDuration uint32_t 只写(选填) 自被踢出群组开始算起, 禁止被踢用户重新申请加群的时间间隔, 单位: 秒。 7.2 版本开始支持


4.11 GroupDeleteMemberResult (删除成员接口的返回)

JSON 键 值类型 属 性 含 义
kTIMGroupDeleteMemberResultIdentifier string 只读 删除的成员 ID
kTIMGroupDeleteMemberResultResult uint HandleGroupMemberResult 只读 删除结果


五. 群未决 API 参数相关的 Json Key 定义


5.1 GroupPendencyOption (获取群未决信息列表的参数)

JSON 键 值类型 属 性 含 义
kTIMGroupPendencyOptionStartTime uint64 只写(必填) 设置拉取时间戳, 第一次请求填 0, 后边根据 server 返回的 GroupPendencyResultkTIMGroupPendencyResultNextStartTime 指定的时间戳进行填写
kTIMGroupPendencyOptionMaxLimited uint 只写(选填) 拉取的建议数量, server 可根据需要返回或多或少, 不能作为完成与否的标志


5.2 GroupPendency (群未决信息定义)

JSON 键 值类型 属 性 含 义
kTIMGroupPendencyGroupId string 读写 群组 ID
kTIMGroupPendencyFromIdentifier string 读写 请求者的 ID, 例如: 请求加群: 请求者, 邀请加群: 邀请人
kTIMGroupPendencyFromNickName string 只读 请求者的昵称
kTIMGroupPendencyFromFaceUrl string 只读 请求者的头像
kTIMGroupPendencyToIdentifier string 读写 判决者的 ID, 处理此条“加群的未决请求”的管理员 ID
kTIMGroupPendencyAddTime uint64 只读 未决信息添加时间
kTIMGroupPendencyPendencyType uint TIMGroupPendencyType 只读 未决请求类型
kTIMGroupPendencyHandled uint TIMGroupPendencyHandle 只读 群未决处理状态
kTIMGroupPendencyHandleResult uint TIMGroupPendencyHandleResult 只读 群未决处理操作类型
kTIMGroupPendencyApplyInviteMsg string 只读 申请或邀请附加信息
kTIMGroupPendencyFromUserDefinedData string 只读 申请或邀请者自定义字段
kTIMGroupPendencyApprovalMsg string 只读 审批信息: 同意或拒绝信息
kTIMGroupPendencyToUserDefinedData string 只读 审批者自定义字段
kTIMGroupPendencyKey string 只读 签名信息, 客户不用关心
kTIMGroupPendencyAuthentication string 只读 签名信息, 客户不用关心
kTIMGroupPendencySelfIdentifier string 只读 自己的 ID


5.3 GroupPendencyResult (获取群未决信息列表的返回)

JSON 键 值类型 属 性 含 义
kTIMGroupPendencyResultNextStartTime uint64 只读 下一次拉取的起始时戳, server 返回 0 表示没有更多的数据, 否则在下次获取数据时以这个时间戳作为开始时间戳
kTIMGroupPendencyResultReadTimeSeq uint64 只读 已读上报的时间戳
kTIMGroupPendencyResultUnReadNum uint 只读 未决请求的未读数
kTIMGroupPendencyResultPendencyArray array GroupPendency 只读 群未决信息列表


5.4 GroupHandlePendencyParam (处理群未决消息接口的参数)

JSON 键 值类型 属 性 含 义
kTIMGroupHandlePendencyParamIsAccept bool 只写(选填) true 表示接受, false 表示拒绝。 默认为 false
kTIMGroupHandlePendencyParamHandleMsg string 只写(选填) 同意或拒绝信息, 默认为空字符串
kTIMGroupHandlePendencyParamPendency object GroupPendency 只写(必填) 未决信息详情