- 动态与公告
- 产品简介
- 购买指南
- 体验 Demo
- 下载中心
- 快速入门
- 含 UI 集成方案（荐）
- 无 UI 集成方案
- 客户端 API
- 服务端 API
- 场景方案
- 控制台指南
- 常见问题
- 协议与认证
- IM 政策
- 平滑迁移方案
- 错误码
- 联系我们
- 动态与公告
- 产品简介
- 购买指南
- 体验 Demo
- 下载中心
- 快速入门
- 含 UI 集成方案（荐）
- 无 UI 集成方案
- 客户端 API
- 服务端 API
- 场景方案
- 控制台指南
- 常见问题
- 协议与认证
- IM 政策
- 平滑迁移方案
- 错误码
- 联系我们
腾讯即时通信 IM 的跨平台 C 接口（API）。
各个平台的下载链接：
回调分两种，一种是指调用接口的异步返回，另外一种指后台推送的通知。回调在 IM SDK 内部的逻辑线程触发，跟调用接口的线程可能不是同一线程。
在 Windows 平台，如果调用 TIMInit 接口进行初始化 IM SDK 之前，已创建了 UI 的消息循环，且调用 TIMInit 接口的线程为主 UI 线程，则 IM SDK 内部会将回调抛到主 UI 线程调用。
注意：如果接口的参数字符串包含非英文的字符，请使用 UTF-8 编码。
事件回调接口
| API | 描述 |
|---|---|
| TIMAddRecvNewMsgCallback | 增加接收新消息回调 |
| TIMRemoveRecvNewMsgCallback | 删除接收新消息回调 |
| TIMSetMsgReadedReceiptCallback | 设置消息已读回执回调 |
| TIMSetMsgRevokeCallback | 设置接收的消息被撤回回调 |
| TIMSetMsgElemUploadProgressCallback | 设置消息内元素相关文件上传进度回调 |
| TIMSetGroupTipsEventCallback | 设置群组系统消息回调 |
| TIMSetGroupAttributeChangedCallback | 设置群组属性变更回调 |
| TIMSetConvEventCallback | 设置会话事件回调 |
| TIMSetConvTotalUnreadMessageCountChangedCallback | 设置会话未读消息总数变更的回调 |
| TIMSetNetworkStatusListenerCallback | 设置网络连接状态监听回调 |
| TIMSetKickedOfflineCallback | 设置被踢下线通知回调 |
| TIMSetUserSigExpiredCallback | 设置票据过期回调 |
| TIMSetOnAddFriendCallback | 设置添加好友的回调 |
| TIMSetOnDeleteFriendCallback | 设置删除好友的回调 |
| TIMSetUpdateFriendProfileCallback | 设置更新好友资料的回调 |
| TIMSetFriendAddRequestCallback | 设置好友添加请求的回调 |
| TIMSetFriendApplicationListDeletedCallback | 设置好友申请被删除的回调 |
| TIMSetFriendApplicationListReadCallback | 设置好友申请已读的回调 |
| TIMSetFriendBlackListAddedCallback | 设置黑名单新增的回调 |
| TIMSetFriendBlackListDeletedCallback | 设置黑名单删除的回调 |
| TIMSetLogCallback | 设置日志回调 |
| TIMSetMsgUpdateCallback | 设置消息在云端被修改后回传回来的消息更新通知回调 |
IM SDK 初始化相关接口
| API | 描述 |
|---|---|
| TIMInit | IM SDK 初始化 |
| TIMUninit | IM SDK 卸载 |
| TIMGetSDKVersion | 获取 IM SDK 版本号 |
| TIMSetConfig | 设置额外的用户配置 |
| TIMGetServerTime | 获取服务器当前时间 |
登录登出相关接口
| API | 描述 |
|---|---|
| TIMLogin | 登录 |
| TIMLogout | 登出 |
| TIMGetLoginStatus | 获取登录状态 |
| TIMGetLoginUserID | 获取登录用户的 userID |
会话相关接口
| API | 描述 |
|---|---|
| TIMConvDelete | 删除会话 |
| TIMConvGetConvList | 获取最近联系人的会话列表 |
| TIMConvGetConvInfo | 查询一组会话列表 |
| TIMConvSetDraft | 设置指定会话的草稿 |
| TIMConvCancelDraft | 删除指定会话的草稿 |
| TIMConvPinConversation | 设置会话置顶 |
| TIMConvGetTotalUnreadMessageCount | 获取所有会话总的未读消息数 |
消息相关接口
| API | 描述 |
|---|---|
| TIMMsgSendMessage | 发送新消息 |
| TIMMsgCancelSend | 根据消息 messageID 取消发送中的消息 |
| TIMMsgFindMessages | 根据消息 messageID 查询本地的消息列表 |
| TIMMsgReportReaded | 消息上报已读 |
| TIMMsgMarkAllMessageAsRead | 标记所有消息为已读（5.8及其以上版本支持） |
| TIMMsgRevoke | 消息撤回 |
| TIMMsgFindByMsgLocatorList | 根据消息定位精准查找指定会话的消息 |
| TIMMsgImportMsgList | 导入消息列表到指定会话 |
| TIMMsgSaveMsg | 保存自定义消息 |
| TIMMsgGetMsgList | 获取指定会话的消息列表 |
| TIMMsgDelete | 删除指定会话的消息 |
| TIMMsgListDelete | 删除指定会话的本地及漫游消息列表 |
| TIMMsgClearHistoryMessage | 清空指定会话的消息 |
| TIMMsgSetC2CReceiveMessageOpt | 设置针对某个用户的 C2C 消息接收选项（支持批量设置） |
| TIMMsgGetC2CReceiveMessageOpt | 查询针对某个用户的 C2C 消息接收选项 |
| TIMMsgSetGroupReceiveMessageOpt | 设置群消息的接收选项 |
| TIMMsgDownloadElemToPath | 下载消息内元素到指定文件路径（图片、视频、音频、文件） |
| TIMMsgDownloadMergerMessage | 下载合并消息 |
| TIMMsgBatchSend | 群发消息，该接口不支持向群组发送消息。 |
| TIMMsgSearchLocalMessages | 搜索本地消息。 |
| TIMMsgSetLocalCustomData | 设置消息自定义数据。 |
群组相关接口
| API | 描述 |
|---|---|
| TIMGroupCreate | 创建群组 |
| TIMGroupDelete | 删除（解散）群组 |
| TIMGroupJoin | 申请加入群组 |
| TIMGroupQuit | 退出群组 |
| TIMGroupInviteMember | 邀请加入群组 |
| TIMGroupDeleteMember | 删除群组成员 |
| TIMGroupGetJoinedGroupList | 获取已加入群组列表 |
| TIMGroupGetGroupInfoList | 获取群组信息列表 |
| TIMGroupModifyGroupInfo | 修改群信息 |
| TIMGroupGetMemberInfoList | 获取群成员信息列表 |
| TIMGroupModifyMemberInfo | 修改群成员信息 |
| TIMGroupGetPendencyList | 获取群未决信息列表。 群未决信息是指还没有处理的操作，例如，邀请加群或者请求加群操作还没有被处理，称之为群未决信息 |
| TIMGroupReportPendencyReaded | 上报群未决信息已读 |
| TIMGroupHandlePendency | 处理群未决信息 |
| TIMGroupGetOnlineMemberCount | 获取指定群在线人数 |
| TIMGroupSearchGroups | 搜索群列表 |
| TIMGroupSearchGroupMembers | 搜索群成员列表 |
| TIMGroupInitGroupAttributes | 初始化群属性，会清空原有的群属性列表 |
| TIMGroupSetGroupAttributes | 设置群属性，已有该群属性则更新其 value 值，没有该群属性则添加该群属性 |
| TIMGroupDeleteGroupAttributes | 删除群属性 |
| TIMGroupGetGroupAttributes | 获取群指定属性，keys 传 nil 则获取所有群属性。 |
用户资料相关接口
| API | 描述 |
|---|---|
| TIMProfileGetUserProfileList | 获取指定用户列表的个人资料 |
| TIMProfileModifySelfUserProfile | 修改自己的个人资料 |
关系链相关接口
| API | 描述 |
|---|---|
| TIMFriendshipGetFriendProfileList | 获取好友列表 |
| TIMFriendshipAddFriend | 添加好友 |
| TIMFriendshipHandleFriendAddRequest | 处理好友请求 |
| TIMFriendshipModifyFriendProfile | 更新好友资料（备注等） |
| TIMFriendshipDeleteFriend | 删除好友 |
| TIMFriendshipCheckFriendType | 检测好友类型（单向或双向） |
| TIMFriendshipCreateFriendGroup | 创建好友分组 |
| TIMFriendshipGetFriendGroupList | 获取指定好友分组的分组信息 |
| TIMFriendshipModifyFriendGroup | 修改好友分组 |
| TIMFriendshipDeleteFriendGroup | 删除好友分组 |
| TIMFriendshipAddToBlackList | 添加指定用户到黑名单 |
| TIMFriendshipGetBlackList | 获取黑名单列表 |
| TIMFriendshipDeleteFromBlackList | 从黑名单中删除指定用户列表 |
| TIMFriendshipGetPendencyList | 获取好友添加请求未决信息列表 |
| TIMFriendshipDeletePendency | 删除指定好友添加请求未决信息 |
| TIMFriendshipReportPendencyReaded | 上报好友添加请求未决信息已读 |
| TIMFriendshipSearchFriends | 搜索好友 |
| TIMFriendshipGetFriendsInfo | 获取好友信息 |
废弃接口
| API | 描述 |
|---|---|
| TIMConvCreate | 创建会话 |
| TIMMsgSendNewMsg | 发送新消息（推荐使用 TIMMsgSendMessage 接口） |
是
否
本页内容是否解决了您的问题？