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


一. 社群 API 参数相关的 Json Key 定义


1.1 TopicInfo (话题信息)

JSON 键 值类型 属 性 含 义
kTIMCommunityTopicInfoTopicID string 读写 话题 ID, 只能在创建话题或者修改话题信息的时候设置。 组成方式为: 社群 ID + @TOPIC_xxx, 例如社群 ID 为 @TGS_123, 则话题 ID 为 @TGS_123@TOPIC_xxx
kTIMCommunityTopicInfoTopicName string 读写 话题名称
kTIMCommunityTopicInfoIntroduction string 读写 话题介绍
kTIMCommunityTopicInfoNotification string 读写 话题公告
kTIMCommunityTopicInfoFaceURL string 读写 话题头像
kTIMCommunityTopicInfoIsAllMuted bool 读写 话题全员禁言
kTIMCommunityTopicInfoSelfMuteTime uint32 只读 当前用户在话题中的禁言时间
kTIMCommunityTopicInfoCustomString string 读写 话题自定义字段
kTIMCommunityTopicInfoRecvOpt uint TIMReceiveMessageOpt 只读 话题消息接收选项, 修改话题消息接收选项请调用 TIMMsgSetGroupReceiveMessageOpt 接口
kTIMCommunityTopicInfoDraftText string 读写 话题草稿
kTIMCommunityTopicInfoUnreadCount uint64 只读 话题消息未读数量
kTIMCommunityTopicInfoLastMessage object Message 只读 话题 lastMessage
kTIMCommunityTopicInfoReadSequence - 只读 话题已读消息的 sequence, 从 7.8 版本开始支持
kTIMCommunityTopicInfoGroupAtInfoArray array GroupAtInfo 只读 话题 at 信息列表
kTIMCommunityTopicInfoModifyFlag uint TIMGroupModifyInfoFlag 只写(必填) 修改标识, 可设置多个值按位或
kTIMCommunityTopicCreateTime uint32 只读 话题创建时间
kTIMCommunityTopicInfoDefaultPermissions uint64 读写 话题默认权限, 7.8 版本开始支持。 群成员在没有加入任何权限组时的默认权限, 仅在社群资料 V2TIMGroupInfo 中 enablePermissionGroup = true 打开权限组之后生效


1.2 TopicInfoResult (获取话题信息的结果)

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


1.3 TopicOperationResult (话题操作结果)

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


1.4 PermissionGroupInfo (权限组信息)

JSON 键 值类型 属 性 含 义
kTIMCommunityGroupID string 读写 社群 ID
kTIMPermissionGroupID string 读写 权限组 ID, 只能在创建话题或者修改话题信息的时候设置
kTIMPermissionGroupName string 读写 权限组名称
kTIMPermissionCustomData string 读写 权限组自定义数据
kTIMGroupPermission uint64 读写 社群权限
kTIMPermissionGroupMemberCount uint64 只读 权限组人数
kTIMPermissionGroupModifyInfoFlag uint TIMPermissionGroupModifyInfoFlag 只写(必填) 修改标识, 可设置多个值按位或


1.5 TopicPermissionMap (话题权限 map)

JSON 键 值类型 属 性 含 义
kTIMTopicPermissionKey string 读写 自定义字段的 key
kTIMTopicPermissionValue uint64 读写 自定义字段的 value


1.6 PermissionGroupInfoResult (获取权限组信息的结果)

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


1.7 PermissionGroupOperationResult (权限组操作结果)

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


1.8 PermissionGroupMemberOperationResult (权限组成员处理结果)

JSON 键 值类型 属 性 含 义
kTIMPermissionGroupMemberOperationResultIdentifier string 只读 被邀请加入权限组的用户 ID
kTIMPermissionGroupMemberOperationResultErrorCode uint TIMPermissionGroupMemberOperationResult 只读 处理结果


1.9 PermissionGroupMemberInfoResult (获取权限组成员列表接口的返回)

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


1.10 TopicPermissionResult (获取话题权限列表接口的返回)

JSON 键 值类型 属 性 含 义
kTIMTopicPermissionResultErrorCode int 只读 结果 0: 成功; 非 0: 失败
kTIMTopicPermissionResultErrorMessage string 只读 如果获取失败, 会返回错误信息
kTIMTopicPermissionResultTopicID string 只读 话题 ID
kTIMTopicPermissionResultTopicPermission uint64 只读 话题 权限
kTIMTopicPermissionResultGroupID string 只读 社群 ID
kTIMTopicPermissionResultPermissionGroupID string 只读 权限组 ID


1.11 PermissionGroupCallback (权限组相关监听回调)

JSON 键 值类型 属 性 含 义
kTIMTopicPermissionMap array 只读 话题权限 map
kTIMTopicIDList array 只读 删除话题权限的话题 id 列表
kTIMMemberIDList array 只读 权限组中添加或者删除成员的 id 列表