即时通信 IM IM SDK 关键类型-客户端 API-文档中心-腾讯云

SDK 基础 API 参数相关的 Json Key 定义
名称
含义
﻿SdKConfig﻿
初始化 IM SDK 的配置
﻿UserConfig﻿
用户配置信息
﻿HttpProxyInfo﻿
HTTP 代理配置信息
﻿Socks5ProxyInfo﻿
SOCKS5 代理配置信息
﻿PACProxyInfo﻿
PAC 代理配置信息
﻿SetConfig﻿
更新配置
用户资料 API 参数相关的 Json Key 定义
名称
含义
﻿FriendShipGetProfileListParam﻿
获取指定用户列表的个人资料的参数
﻿TIMUserStatus﻿
用户状态
﻿UserProfile﻿
用户个人资料
﻿UserProfileItem﻿
用户自身资料可修改的各个项
﻿UserProfileCustomStringInfo﻿
用户自定义资料字段, 字符串
﻿ProfileChangeElem﻿
资料变更通知
消息收发 API 参数相关的 Json Key 定义
名称
含义
﻿ElemType﻿
消息元素的类型
﻿TextElem﻿
文本元素
﻿CustomElem﻿
自定义元素
﻿ImageElem﻿
图片元素
﻿SoundElem﻿
音频元素
﻿VideoElem﻿
视频元素
﻿FileElem﻿
文件元素
﻿LocationElem﻿
位置元素
﻿FaceElem﻿
表情元素
﻿MergerElem﻿
合并消息元素
﻿GroupMessageAtALL﻿
@ 群里所有人的参数
﻿GroupTipsElem﻿
群组系统消息元素
﻿GroupReportElem﻿
群组系统通知元素
﻿Message﻿
消息
﻿MsgBatchSendParam﻿
消息群发接口的参数
﻿MsgBatchSendResult﻿
消息群发接口的返回
﻿DownloadElemParam﻿
下载元素接口的参数
﻿MsgDownloadElemResult﻿
下载元素接口的返回
消息拉取、查找、删除操作 API 参数相关的 Json Key 定义
名称
含义
﻿MsgGetMsgListParam﻿
获取历史消息接口的参数
﻿MsgLocator﻿
消息定位符
﻿MessageSearchParam﻿
消息搜索参数
﻿MessageSearchResultItem﻿
消息搜索结果项
﻿MessageSearchResult﻿
消息搜索结果返回
﻿MsgDeleteParam﻿
消息删除接口的参数
消息接收选项 API 参数相关的 Json Key 定义
名称
含义
﻿GetC2CRecvMsgOptResult﻿
查询 C2C 消息接收选项的返回
﻿TIMReceiveMessageOptInfo﻿
全局消息消息接收选项
消息翻译、已读回执、扩展、回应等 API 参数相关的 Json Key 定义
名称
含义
﻿MessageTranslateTextResult﻿
文本消息翻译结果
﻿MessageReceipt﻿
消息已读回执
﻿MessageExtension﻿
消息扩展信息
﻿MessageExtensionResult﻿
消息扩展操作结果
﻿MessageReaction﻿
消息回应信息
﻿MessageReactionResult﻿
消息回应列表拉取结果
﻿MessageReactionUserResult﻿
消息回应用户列表拉取结果
﻿MessageReactionChangeInfo﻿
消息回应列表更新信息
会话 API 参数相关的 Json Key 定义
名称
含义
﻿Draft﻿
草稿信息
﻿GroupAtInfo﻿
群 @ 信息
﻿ConvInfo﻿
会话信息
﻿TIMConversationListFilter﻿
获取会话列表高级接口的 filter
﻿TIMConversationListResult﻿
获取会话列表的结果
﻿GetConversationListParam﻿
获取指定的会话列表
﻿GetTotalUnreadNumberResult﻿
获取会话未读消息个数
﻿TIMConversationOperationResult﻿
会话操作结果
群组系统通知相关 Json Key 定义
名称
含义
﻿GroupTipGroupChangeInfo﻿
群组系统消息-群组信息修改
﻿GroupTipMemberChangeInfo﻿
群组系统消息-群组成员禁言
﻿GroupTipMemberMarkChangeInfo﻿
群组系统消息-群组成员标记变更
﻿GroupTipsElem﻿
群组系统消息元素
群组管理 API 参数相关的 Json Key 定义
名称
含义
﻿GroupMemberInfo﻿
群成员信息
﻿CreateGroupParam﻿
创建群组接口的参数
﻿CreateGroupResult﻿
创建群组接口的返回
﻿GroupSelfInfo﻿
群组内本人的信息
﻿GroupBaseInfo﻿
群组基础信息, 获取已加入群组列表接口的返回信息
﻿GroupInfoCustomString﻿
群资料自定义字段
﻿GroupDetailInfo﻿
群组详细信息
﻿GetGroupInfoResult﻿
获取群组信息列表接口的返回
﻿GroupSearchParam﻿
群搜索参数
﻿GroupModifyInfoParam﻿
设置群信息接口的参数
﻿GroupAttributes﻿
设置群属性的 map 对象
﻿GroupCounter﻿
群计数器信息
GroupGetOnlineMemberCountResult
获取指定群在线人数结果
话题 API 参数相关的 Json Key 定义
名称
含义
﻿TIMGroupTopicInfo﻿
获取指定群话题信息结果
﻿TIMGroupTopicOperationResult﻿
话题操作结果
﻿TIMGroupTopicInfoResult﻿
获取话题信息的结果
群成员管理 API 参数相关的 Json Key 定义
名称
含义
﻿GroupMemberGetInfoOption﻿
获取群组成员信息的选项
﻿GroupGetMemberInfoListParam﻿
获取群成员列表接口的参数
﻿GroupGetMemberInfoListResult﻿
获取群成员列表接口的返回
﻿GroupMemberSearchParam﻿
群成员搜索参数
﻿GroupSearchGroupMembersResult﻿
群成员搜索结果
﻿GroupMemberInfoCustomString﻿
群成员信息自定义字段
﻿GroupModifyMemberInfoParam﻿
设置群成员信息接口的参数
﻿GroupInviteMemberParam﻿
邀请成员接口的参数
﻿GroupInviteMemberResult﻿
邀请成员接口的返回
﻿GroupDeleteMemberParam﻿
删除成员接口的参数
﻿GroupDeleteMemberResult﻿
删除成员接口的返回
群未决 API 参数相关的 Json Key 定义
名称
含义
﻿GroupPendencyOption﻿
获取群未决信息列表的参数
﻿GroupPendency﻿
群未决信息定义
﻿GroupPendencyResult﻿
获取群未决信息列表的返回
﻿GroupHandlePendencyParam﻿
处理群未决消息接口的参数
社群 API 参数相关的 Json Key 定义
名称
含义
﻿TopicInfo﻿
话题信息
﻿TopicOperationResult﻿
话题操作结果
﻿TopicInfoResult﻿
获取话题信息的结果
﻿PermissionGroupInfo﻿
权限组信息
﻿TopicPermissionMap﻿
话题权限 map
﻿PermissionGroupInfoResult﻿
获取权限组信息的结果
﻿PermissionGroupOperationResult﻿
权限组操作结果
﻿PermissionGroupMemberOperationResult﻿
权限组成员处理结果
﻿PermissionGroupMemberInfoResult﻿
获取权限组成员列表接口的返回
﻿TopicPermissionResult﻿
获取话题权限列表接口的返回
﻿PermissionGroupCallback﻿
权限组相关监听回调
好友资料 API 参数相关的 Json Key 定义
名称
含义
﻿FriendProfileCustomStringInfo﻿
好友自定义资料字段
﻿FriendProfile﻿
好友资料
﻿FriendProfileItem﻿
好友资料可修改的各个项
﻿FriendshipModifyFriendProfileParam﻿
修改好友资料接口的参数
﻿FriendProfileUpdate﻿
好友资料更新信息
好友申请 API 参数相关的 Json Key 定义
名称
含义
﻿FriendshipAddFriendParam﻿
添加好友接口的参数
﻿FriendshipDeleteFriendParam﻿
删除好友接口的参数
﻿FriendAddPendency﻿
好友申请未决信息
﻿FriendshipGetPendencyListParam﻿
分页获取好友申请未决信息列表的参数
﻿PendencyPage﻿
好友申请未决信息页
﻿FriendAddPendencyInfo﻿
好友申请未决信息
﻿FriendResponse﻿
处理好友申请未决信息接口的参数
﻿FriendshipDeletePendencyParam﻿
删除好友申请未决信息接口的参数
检查好友关系 API 参数相关的 Json Key 定义
名称
含义
﻿FriendshipCheckFriendTypeParam﻿
检测好友的类型接口的参数
﻿FriendshipCheckFriendTypeResult﻿
检测好友的类型接口返回
好友操作（添加、删除、加黑名单等） API 参数相关的 Json Key 定义
名称
含义
﻿FriendResult﻿
关系链操作接口的返回结果
好友分组 API 参数相关的 Json Key 定义
名称
含义
﻿CreateFriendGroupParam﻿
创建好友分组接口参数
﻿FriendGroupInfo﻿
好友分组信息
﻿FriendshipModifyFriendGroupParam﻿
修改好友分组信息的接口参数
好友搜索 API 参数相关的 Json Key 定义
名称
含义
﻿FriendSearchParam﻿
搜索好友的参数
﻿FriendInfoGetResult﻿
搜索好友结果
公众号管理 API 参数相关的 Json Key 定义
名称
含义
﻿OfficialAccountInfo﻿
公众号信息
﻿GetOfficialAccountInfoResult﻿
获取公众号信息列表接口的返回
关注/粉丝 API 参数相关的 Json Key 定义
名称
含义
﻿FollowOperationResult﻿
关注/取关操作接口的返回结果
﻿FollowListResult﻿
获取 关注/粉丝/互关 列表的结果
﻿FollowInfo﻿
用户关注信息
﻿FollowTypeCheckResult﻿
指定用户关注类型的检查结果
离线推送 API 参数相关的 Json Key 定义
名称
含义
﻿OfflinePushToken﻿
设置离线推送配置信息
﻿IOSOfflinePushConfigSoundConfig﻿
iOS 离线推送声音设置选项
﻿IOSOfflinePushConfig﻿
消息在 iOS 系统上的离线推送配置
﻿AndroidOfflinePushConfig﻿
消息在 Android 系统上的离线推送配置
﻿OfflinePushConfig﻿
消息离线推送配置
信令 API 参数相关的 Json Key 定义
名称
含义
﻿SignalingInfo﻿
信令基础信息定义
交流与反馈
﻿点此进入 IM 社群，享有专业工程师的支持，解决您的难题。
﻿

名称	含义
SdKConfig	初始化 IM SDK 的配置
UserConfig	用户配置信息
HttpProxyInfo	HTTP 代理配置信息
Socks5ProxyInfo	SOCKS5 代理配置信息
PACProxyInfo	PAC 代理配置信息
SetConfig	更新配置

名称	含义
FriendShipGetProfileListParam	获取指定用户列表的个人资料的参数
TIMUserStatus	用户状态
UserProfile	用户个人资料
UserProfileItem	用户自身资料可修改的各个项
UserProfileCustomStringInfo	用户自定义资料字段, 字符串
ProfileChangeElem	资料变更通知

名称	含义
ElemType	消息元素的类型
TextElem	文本元素
CustomElem	自定义元素
ImageElem	图片元素
SoundElem	音频元素
VideoElem	视频元素
FileElem	文件元素
LocationElem	位置元素
FaceElem	表情元素
MergerElem	合并消息元素
GroupMessageAtALL	@ 群里所有人的参数
GroupTipsElem	群组系统消息元素
GroupReportElem	群组系统通知元素
Message	消息
MsgBatchSendParam	消息群发接口的参数
MsgBatchSendResult	消息群发接口的返回
DownloadElemParam	下载元素接口的参数
MsgDownloadElemResult	下载元素接口的返回

名称	含义
MsgGetMsgListParam	获取历史消息接口的参数
MsgLocator	消息定位符
MessageSearchParam	消息搜索参数
MessageSearchResultItem	消息搜索结果项
MessageSearchResult	消息搜索结果返回
MsgDeleteParam	消息删除接口的参数

名称	含义
GetC2CRecvMsgOptResult	查询 C2C 消息接收选项的返回
TIMReceiveMessageOptInfo	全局消息消息接收选项

名称	含义
MessageTranslateTextResult	文本消息翻译结果
MessageReceipt	消息已读回执
MessageExtension	消息扩展信息
MessageExtensionResult	消息扩展操作结果
MessageReaction	消息回应信息
MessageReactionResult	消息回应列表拉取结果
MessageReactionUserResult	消息回应用户列表拉取结果
MessageReactionChangeInfo	消息回应列表更新信息

名称	含义
Draft	草稿信息
GroupAtInfo	群 @ 信息
ConvInfo	会话信息
TIMConversationListFilter	获取会话列表高级接口的 filter
TIMConversationListResult	获取会话列表的结果
GetConversationListParam	获取指定的会话列表
GetTotalUnreadNumberResult	获取会话未读消息个数
TIMConversationOperationResult	会话操作结果

名称	含义
GroupTipGroupChangeInfo	群组系统消息-群组信息修改
GroupTipMemberChangeInfo	群组系统消息-群组成员禁言
GroupTipMemberMarkChangeInfo	群组系统消息-群组成员标记变更
GroupTipsElem	群组系统消息元素

名称	含义
GroupMemberInfo	群成员信息
CreateGroupParam	创建群组接口的参数
CreateGroupResult	创建群组接口的返回
GroupSelfInfo	群组内本人的信息
GroupBaseInfo	群组基础信息, 获取已加入群组列表接口的返回信息
GroupInfoCustomString	群资料自定义字段
GroupDetailInfo	群组详细信息
GetGroupInfoResult	获取群组信息列表接口的返回
GroupSearchParam	群搜索参数
GroupModifyInfoParam	设置群信息接口的参数
GroupAttributes	设置群属性的 map 对象
GroupCounter	群计数器信息
GroupGetOnlineMemberCountResult	获取指定群在线人数结果

名称	含义
TIMGroupTopicInfo	获取指定群话题信息结果
TIMGroupTopicOperationResult	话题操作结果
TIMGroupTopicInfoResult	获取话题信息的结果

名称	含义
FollowOperationResult	关注/取关操作接口的返回结果
FollowListResult	获取关注/粉丝/互关列表的结果
FollowInfo	用户关注信息
FollowTypeCheckResult	指定用户关注类型的检查结果

名称	含义
GroupMemberGetInfoOption	获取群组成员信息的选项
GroupGetMemberInfoListParam	获取群成员列表接口的参数
GroupGetMemberInfoListResult	获取群成员列表接口的返回
GroupMemberSearchParam	群成员搜索参数
GroupSearchGroupMembersResult	群成员搜索结果
GroupMemberInfoCustomString	群成员信息自定义字段
GroupModifyMemberInfoParam	设置群成员信息接口的参数
GroupInviteMemberParam	邀请成员接口的参数
GroupInviteMemberResult	邀请成员接口的返回
GroupDeleteMemberParam	删除成员接口的参数
GroupDeleteMemberResult	删除成员接口的返回

名称	含义
GroupPendencyOption	获取群未决信息列表的参数
GroupPendency	群未决信息定义
GroupPendencyResult	获取群未决信息列表的返回
GroupHandlePendencyParam	处理群未决消息接口的参数

名称	含义
TopicInfo	话题信息
TopicOperationResult	话题操作结果
TopicInfoResult	获取话题信息的结果
PermissionGroupInfo	权限组信息
TopicPermissionMap	话题权限 map
PermissionGroupInfoResult	获取权限组信息的结果
PermissionGroupOperationResult	权限组操作结果
PermissionGroupMemberOperationResult	权限组成员处理结果
PermissionGroupMemberInfoResult	获取权限组成员列表接口的返回
TopicPermissionResult	获取话题权限列表接口的返回
PermissionGroupCallback	权限组相关监听回调

名称	含义
FriendProfileCustomStringInfo	好友自定义资料字段
FriendProfile	好友资料
FriendProfileItem	好友资料可修改的各个项
FriendshipModifyFriendProfileParam	修改好友资料接口的参数
FriendProfileUpdate	好友资料更新信息

名称	含义
FriendshipAddFriendParam	添加好友接口的参数
FriendshipDeleteFriendParam	删除好友接口的参数
FriendAddPendency	好友申请未决信息
FriendshipGetPendencyListParam	分页获取好友申请未决信息列表的参数
PendencyPage	好友申请未决信息页
FriendAddPendencyInfo	好友申请未决信息
FriendResponse	处理好友申请未决信息接口的参数
FriendshipDeletePendencyParam	删除好友申请未决信息接口的参数

名称	含义
FriendshipCheckFriendTypeParam	检测好友的类型接口的参数
FriendshipCheckFriendTypeResult	检测好友的类型接口返回

名称	含义
FriendResult	关系链操作接口的返回结果

名称	含义
CreateFriendGroupParam	创建好友分组接口参数
FriendGroupInfo	好友分组信息
FriendshipModifyFriendGroupParam	修改好友分组信息的接口参数

名称	含义
FriendSearchParam	搜索好友的参数
FriendInfoGetResult	搜索好友结果

名称	含义
OfficialAccountInfo	公众号信息
GetOfficialAccountInfoResult	获取公众号信息列表接口的返回

IM SDK 关键类型

本页目录：

SDK 基础 API 参数相关的 Json Key 定义

用户资料 API 参数相关的 Json Key 定义

消息收发 API 参数相关的 Json Key 定义

消息拉取、查找、删除操作 API 参数相关的 Json Key 定义

消息接收选项 API 参数相关的 Json Key 定义

消息翻译、已读回执、扩展、回应等 API 参数相关的 Json Key 定义

会话 API 参数相关的 Json Key 定义

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

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

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

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

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

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

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

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

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

好友操作（添加、删除、加黑名单等） API 参数相关的 Json Key 定义

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

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

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

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

离线推送 API 参数相关的 Json Key 定义

信令 API 参数相关的 Json Key 定义

交流与反馈

名称	含义
OfflinePushToken	设置离线推送配置信息
IOSOfflinePushConfigSoundConfig	iOS 离线推送声音设置选项
IOSOfflinePushConfig	消息在 iOS 系统上的离线推送配置
AndroidOfflinePushConfig	消息在 Android 系统上的离线推送配置
OfflinePushConfig	消息离线推送配置