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
|
kTIMGroupTipGroupChangeInfoUint64Value | uint64 | 只读 | 根据变更类型表示不同的值, 当前只有 info_flag 为 kTIMGroupTipChangeFlag_DefaultPermissions 时有效 |
JSON 键 | 值类型 | 属 性 | 含 义 |
kTIMGroupTipsElemTipType | uint TIMGroupTipType | 只读 | 群消息类型 |
kTIMGroupTipsElemJoinType | uint TIMGroupJoinType | 只读 | 加群类型, TIMGroupTipType 为 kTIMGroupTip_Invite 时有效, 从 8.0 版本开始支持 |
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_Invite 、 kTIMGroupTip_Quit 、 kTIMGroupTip_Kick 时有效 |
kTIMGroupTipsElemPlatform | string | 只读 | 操作方平台信息 |
kTIMGroupTipsElemMemberMarkInfoArray | array GroupTipMemberMarkChangeInfo | 只读 | 群成员标记变更信息列表, 仅当 kTIMGroupTipsElemTipType 值为 kTIMGroupTip_MemberMarkChange 时有效 |
kTIMGroupTipsElemPinnedMessageList | - | 只读 | 变更的置顶群消息 |
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 | 只读 | 群成员在线终端列表 |
JSON 键 | 值类型 | 属 性 | 含 义 |
kTIMCreateGroupParamGroupName | string | 只写(必填) | 群组名称, 最长 100 字节, 使用 UTF-8 编码, 1 个汉字占 3 个字节 |
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 版本开始支持。 群成员在没有加入任何权限组时的默认权限, 仅在 kTIMCreateGroupParamEnablePermissionGroup 为 true 时生效 |
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 | 只读 | 用户所在群的个人信息 |
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 版本开始支持 |
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 版本开始支持 |
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 | 只写(必填) | 修改标识, 可设置多个值按位或 |
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 | 只写(选填) | 请参考 自定义字段 |
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 |