API 概述

最近更新时间:2019-08-30 18:49:26

腾讯即时通信 IM 的跨平台 C 接口(API)。

各个平台的下载链接:

回调分两种,一种是指调用接口的异步返回,另外一种指后台推送的通知。回调在 IM SDK 内部的逻辑线程触发,跟调用接口的线程可能不是同一线程。
在 Windows 平台,如果调用 TIMInit 接口进行初始化 IM SDK 之前,已创建了 UI 的消息循环,且调用 TIMInit 接口的线程为主 UI 线程,则 IM SDK 内部会将回调抛到主 UI 线程调用。

注意:

如果接口的参数字符串包含中文,请使用 UTF-8 编码。

事件回调接口

API 描述
TIMAddRecvNewMsgCallback 增加接收新消息回调
TIMRemoveRecvNewMsgCallback 删除接收新消息回调
TIMSetMsgReadedReceiptCallback 设置消息已读回执回调
TIMSetMsgRevokeCallback 设置接收的消息被撤回回调
TIMSetMsgElemUploadProgressCallback 设置消息内元素相关文件上传进度回调
TIMSetGroupTipsEventCallback 设置群组系统消息回调
TIMSetConvEventCallback 设置会话事件回调
TIMSetNetworkStatusListenerCallback 设置网络连接状态监听回调
TIMSetKickedOfflineCallback 设置被踢下线通知回调
TIMSetUserSigExpiredCallback 设置票据过期回调
TIMSetOnAddFriendCallback 设置添加好友的回调
TIMSetOnDeleteFriendCallback 设置删除好友的回调
TIMSetUpdateFriendProfileCallback 设置更新好友资料的回调
TIMSetFriendAddRequestCallback 设置好友添加请求的回调
TIMSetLogCallback 设置日志回调
TIMSetMsgUpdateCallback 设置消息在云端被修改后回传回来的消息更新通知回调

IM SDK 初始化相关接口

API 描述
TIMInit IM SDK 初始化
TIMUninit IM SDK 卸载
TIMGetSDKVersion 获取 IM SDK 版本号
TIMSetConfig 设置额外的用户配置

登录登出相关接口

API 描述
TIMLogin 登录
TIMLogout 登出

会话相关接口

API 描述
TIMConvCreate 创建会话
TIMConvDelete 删除会话
TIMConvGetConvList 获取本地缓存的会话列表
TIMConvSetDraft 设置指定会话的草稿
TIMConvCancelDraft 删除指定会话的草稿

消息相关接口

API 描述
TIMMsgSendNewMsg 发送新消息
TIMMsgReportReaded 消息上报已读
TIMMsgRevoke 消息撤回
TIMMsgFindByMsgLocatorList 根据消息定位精准查找指定会话的消息
TIMMsgImportMsgList 导入消息列表到指定会话
TIMMsgSaveMsg 保存自定义消息
TIMMsgGetMsgList 获取指定会话的消息列表
TIMMsgDelete 删除指定会话的消息
TIMMsgDownloadElemToPath 下载消息内元素到指定文件路径(图片、视频、音频、文件)
TIMMsgBatchSend 群发消息

群组相关接口

API 描述
TIMGroupCreate 创建群组
TIMGroupDelete 删除(解散)群组
TIMGroupJoin 申请加入群组
TIMGroupQuit 退出群组
TIMGroupInviteMember 邀请加入群组
TIMGroupDeleteMember 删除群组成员
TIMGroupGetJoinedGroupList 获取已加入群组列表
TIMGroupGetGroupInfoList 获取群组信息列表
TIMGroupModifyGroupInfo 修改群信息
TIMGroupGetMemberInfoList 获取群成员信息列表
TIMGroupModifyMemberInfo 修改群成员信息
TIMGroupGetPendencyList 获取群未决信息列表。
群未决信息是指还没有处理的操作,例如,邀请加群或者请求加群操作还没有被处理,称之为群未决信息
TIMGroupReportPendencyReaded 上报群未决信息已读
TIMGroupHandlePendency 处理群未决信息

用户资料相关接口

API 描述
TIMProfileGetUserProfileList 获取指定用户列表的个人资料
TIMProfileModifySelfUserProfile 修改自己的个人资料

关系链相关接口

API 描述
TIMFriendshipGetFriendProfileList 获取好友列表
TIMFriendshipAddFriend 添加好友
TIMFriendshipHandleFriendAddRequest 处理好友请求
TIMFriendshipModifyFriendProfile 更新好友资料(备注等)
TIMFriendshipDeleteFriend 删除好友
TIMFriendshipCheckFriendType 检测好友类型(单向或双向)
TIMFriendshipCreateFriendGroup 创建好友分组
TIMFriendshipGetFriendGroupList 获取指定好友分组的分组信息
TIMFriendshipModifyFriendGroup 修改好友分组
TIMFriendshipDeleteFriendGroup 删除好友分组
TIMFriendshipAddToBlackList 添加指定用户到黑名单
TIMFriendshipGetBlackList 获取黑名单列表
TIMFriendshipDeleteFromBlackList 从黑名单中删除指定用户列表
TIMFriendshipGetPendencyList 获取好友添加请求未决信息列表
TIMFriendshipDeletePendency 删除指定好友添加请求未决信息
TIMFriendshipReportPendencyReaded 上报好友添加请求未决信息已读