tencent cloud

文档反馈

API 概述

最后更新时间:2024-02-19 09:33:53
    腾讯即时通信 IM 的跨平台 C 接口(API)。
    各个平台的下载链接:
    Windows 平台 IM SDK
    iOS 平台 IM SDK
    Mac 平台 IM SDK
    Android 平台 IM SDK
    回调分两种,一种是指调用接口的异步返回,另外一种指后台推送的通知。回调在 IM SDK 内部的逻辑线程触发,跟调用接口的线程可能不是同一线程。 在 Windows 平台,如果调用 TIMInit 接口进行初始化 IM SDK 之前,已创建了 UI 的消息循环,且调用 TIMInit 接口的线程为主 UI 线程,则 IM SDK 内部会将回调抛到主 UI 线程调用。
    注意:
    如果接口的参数字符串包含非英文的字符,请使用 UTF-8 编码。

    事件回调接口

    API
    描述
    增加接收新消息回调
    删除接收新消息回调
    设置消息已读回执回调
    设置接收的消息被撤回回调
    设置消息内元素相关文件上传进度回调
    设置群组系统消息回调
    设置群组属性变更回调
    设置会话事件回调
    设置会话未读消息总数变更的回调
    设置网络连接状态监听回调
    设置被踢下线通知回调
    设置票据过期回调
    设置添加好友的回调
    设置删除好友的回调
    设置更新好友资料的回调
    设置好友添加请求的回调
    设置好友申请被删除的回调
    设置好友申请已读的回调
    设置黑名单新增的回调
    设置黑名单删除的回调
    设置日志回调
    设置消息在云端被修改后回传回来的消息更新通知回调

    IM SDK 初始化相关接口

    API
    描述
    IM SDK 初始化
    IM SDK 卸载
    获取 IM SDK 版本号
    设置额外的用户配置
    获取服务器当前时间

    登录登出相关接口

    API
    描述
    登录
    登出
    获取登录状态
    获取登录用户的 userID

    会话相关接口

    API
    描述
    删除会话
    获取最近联系人的会话列表
    查询一组会话列表
    设置指定会话的草稿
    删除指定会话的草稿
    设置会话置顶
    获取所有会话总的未读消息数

    消息相关接口

    API
    描述
    发送新消息
    根据消息 messageID 取消发送中的消息
    根据消息 messageID 查询本地的消息列表
    消息上报已读
    标记所有消息为已读(5.8及其以上版本支持)
    消息撤回
    根据消息定位精准查找指定会话的消息
    导入消息列表到指定会话
    保存自定义消息
    获取指定会话的消息列表
    删除指定会话的消息
    删除指定会话的本地及漫游消息列表
    清空指定会话的消息
    设置针对某个用户的 C2C 消息接收选项(支持批量设置)
    查询针对某个用户的 C2C 消息接收选项
    设置群消息的接收选项
    下载消息内元素到指定文件路径(图片、视频、音频、文件)
    下载合并消息
    群发消息,该接口不支持向群组发送消息。
    搜索本地消息。
    设置消息自定义数据。

    群组相关接口

    API
    描述
    创建群组
    删除(解散)群组
    申请加入群组
    退出群组
    邀请加入群组
    删除群组成员
    获取已加入群组列表
    获取群组信息列表
    修改群信息
    获取群成员信息列表
    修改群成员信息
    获取群未决信息列表。
    群未决信息是指还没有处理的操作,例如,邀请加群或者请求加群操作还没有被处理,称之为群未决信息
    上报群未决信息已读
    处理群未决信息
    获取指定群在线人数
    搜索群列表
    搜索群成员列表
    初始化群属性,会清空原有的群属性列表
    设置群属性,已有该群属性则更新其 value 值,没有该群属性则添加该群属性
    删除群属性
    获取群指定属性,keys 传 nil 则获取所有群属性。

    用户资料相关接口

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

    关系链相关接口

    API
    描述
    获取好友列表
    添加好友
    处理好友请求
    更新好友资料(备注等)
    删除好友
    检测好友类型(单向或双向)
    创建好友分组
    获取指定好友分组的分组信息
    修改好友分组
    删除好友分组
    添加指定用户到黑名单
    获取黑名单列表
    从黑名单中删除指定用户列表
    获取好友添加请求未决信息列表
    删除指定好友添加请求未决信息
    上报好友添加请求未决信息已读
    搜索好友
    获取好友信息

    废弃接口

    API
    描述
    创建会话
    发送新消息(推荐使用 TIMMsgSendMessage 接口)
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持