tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
即时通信 IM
    文档
    Download PDF

    Swift

    最后更新时间：2024-12-02 15:10:30
    下载PDF
      注意
      新老版本 API 请勿混合使用。

      初始化登录接口

      初始化并成功登录，是正常使用腾讯云 Chat 服务的前提。
      API
      描述
      initSDK
      初始化
      unInitSDK
      反初始化
      添加 Chat SDK 监听
      移除 Chat SDK 监听
      获取版本号
      获取服务器当前时间
      login
      登录
      logout
      退出登录
      获取登录用户
      获取登录状态

      简单消息收发接口

      如果您只需要使用文本和信令（即一段自定义buffer）消息，只需要使用这套简单消息收发接口即可。
      API
      描述
      设置基本消息（文本消息和自定义消息）的事件监听器，请不要同 addAdvancedMsgListener 混用
      移除基本消息（文本消息和自定义消息）的事件监听器
      发送单聊（C2C）普通文本消息
      发送单聊（C2C）自定义（信令）消息
      发送群聊普通文本消息
      发送群聊自定义（信令）消息

      信令接口

      API
      描述
      添加信令监听
      移除信令监听
      invite
      邀请某个人
      邀请群内的某些人
      cancel
      邀请方取消邀请
      accept
      接收方接收邀请
      reject
      接收方拒绝邀请
      获取信令信息
      添加邀请信令（可以用于群离线推送消息触发的邀请信令）
      修改邀请信令

      高级消息收发接口

      如果您需要收发图片、视频、文件等富媒体消息，并需要撤回消息、标记已读、查询历史消息等高级功能，推荐使用下面这套高级消息接口（简单消息接口和高级消息接口请不要混用）。
      API
      描述
      设置高级消息的事件监听器，请不要同 addSimpleMsgListener 混用
      移除高级消息监听器
      创建文本消息
      创建自定义消息
      创建图片消息
      创建语音消息
      创建视频消息
      创建文件消息
      创建地理位置消息
      创建表情消息
      创建合并转发消息
      创建单条转发消息
      创建定向群消息
      创建带 @ 标记的群消息
      发送消息，消息对象可以由 createXXXMessage 接口创建得来
      设置单聊消息秒打扰
      获取单聊消息免打扰状态
      设置群聊消息免打扰状态
      设置全局消息接收选项（可实现按天重复）
      设置全局消息接收选项
      获取登录用户全局消息接收选项
      获取单聊（C2C）历史消息
      获取群组历史消息
      获取历史消息高级接口
      撤回消息，消息对象可以由 createXXXMessage 接口创建得来
      修改消息，消息对象可以由 createXXXMessage 接口创建得来
      设置单聊（C2C）消息已读
      设置群组消息已读
      标记所有会话为已读
      删除本地消息
      删除本地及云端的消息
      清空单聊本地及云端的消息
      清空群组本地及云端的消息
      向群组消息列表中添加一条消息
      向单聊消息列表中添加一条消息
      根据 msgID 查找本地消息
      搜索本地消息
      发送消息已读回执
      获取消息已读回执
      获取群消息已读群成员列表
      设置消息扩展
      获取消息扩展
      删除消息扩展
      添加消息回应
      删除消息回应
      批量获取多条消息回应信息
      分页拉取消息回应全量用户资料
      翻译文本消息
      设置单聊（C2C）消息已读（待废弃接口，请使用 cleanConversationUnreadMessageCount 接口）
      设置群组消息已读（待废弃接口，请使用 cleanConversationUnreadMessageCount 接口）
      标记所有会话为已读（待废弃接口，请使用 cleanConversationUnreadMessageCount 接口）

      群组相关接口

      腾讯云 Chat SDK 支持五种预设的群组类型，每种类型都有其适用场景：
      工作群（Work）：创建后不能自由加入，必须由已经在群的用户邀请入群，同旧版本中的 Private。
      公开群（Public）：用户申请加入，但需要群主或管理员审批。
      会议群（Meeting）：适合跟 TRTC 结合实现视频会议和在线教育等场景，支持随意进出，支持查看进群前的历史消息，同旧版本中的 ChatRoom。
      社群（Community）：创建后可以随意进出，适合用于知识分享和游戏交流等超大社区群聊场景。该功能支持终端 SDK 5.8.1668 增强版及以上版本、Web SDK 2.17.0 及以上版本，需 购买进阶版，登录控制台 并开启社群开关后方可使用，开关路径：Applications > Your App > Chat > Configuration > Group Configuration > Community。
      直播群（AVChatRoom）：适合直播弹幕聊天室等场景，支持随意进出，人数无上限。
      API
      描述
      添加群组相关的事件监听器
      移除群组相关的事件监听器
      创建群组（简单版本）
      创建群组（高级版本），可在建群同时设置群信息和初始的群成员
      joinGroup
      加入群组
      quitGroup
      退出群组
      解散群组（仅群组和管理员可以解散）
      获取已经加入的群列表（不包括已加入的直播群）
      拉取群资料
      搜索群列表
      修改群资料
      初始化群属性
      设置群属性
      删除群属性
      获取群属性
      获取群在线人数
      设置群计数器
      获取群计数器
      递增群计数器
      递减群计数器
      获取群成员列表
      获取指定的群成员资料
      搜索指定的群成员资料
      修改指定的群成员资料
      禁言
      禁言全体群成员
      邀请他人入群
      踢人
      切换群成员的角色
      标记群成员
      转让群主
      获取加群的申请列表
      同意某一条加群申请
      拒绝某一条加群申请
      标记申请列表为已读

      社群话题相关接口

      如果您需要在社群下创建话题，请使用这套接口。社群用来管理群成员，社群下的所有话题不仅可以共享社群成员，还可以独立收发消息而不相互干扰。
      API
      描述
      添加社群监听器
      移除社群监听器
      创建支持话题的社群
      获取当前用户已经加入的支持话题的社群列表
      创建话题
      删除话题
      修改话题信息
      获取话题列表

      会话列表相关接口

      会话列表，即登录微信或 QQ 后首屏看到的列表，包含会话节点、会话名称、群名称、最后一条消息以及未读消息数等元素。
      API
      描述
      添加会话监听器
      移除会话监听器
      获取会话列表
      获取指定单个会话
      获取指定多个会话
      获取会话列表（高级接口）
      删除会话
      删除会话列表
      设置会话草稿
      设置会话自定义数据
      置顶会话
      标记会话
      获取会话总未读数
      获取根据 filter 过滤的会话未读总数
      注册监听指定 filter 的会话未读总数变化
      取消监听指定 filter 的会话未读总数变化
      清理会话的未读消息计数
      创建会话分组
      获取会话分组列表
      删除会话分组
      重命名会话分组
      添加会话到一个会话分组
      从一个会话分组中删除会话

      用户资料相关接口

      包含查询用户资料、修改个人资料以及屏蔽某人消息（即把某用户加入黑名单中）的相关接口。
      API
      描述
      获取用户资料
      修改个人资料
      订阅用户资料
      取消订阅用户资料
      订阅用户状态
      取消订阅用户状态
      屏蔽某人的消息（添加该用户到黑名单中）
      取消某人的消息屏蔽（把该用户从黑名单中移除）
      获取黑名单列表

      离线推送相关接口

      如果想要在 App 切后台时依然能够实时收到消息，可以使用离线推送服务，详细配置请参见 离线推送。
      API
      描述
      设置 APNs 监听
      setAPNS
      配置 APNs 推送信息
      setVOIP
      配置 VoIP 推送信息

      好友管理相关接口

      腾讯云 Chat SDK 在收发消息时默认不检查好友关系。如需实现“先加好友，再发消息” 的交互体验，您可以登录控制台修改 Relationship Check。开启后，用户只能给好友发送消息。当用户给非好友发消息时，SDK 会报 20009 错误码。配置路径为：Applications > Your App > Chat > Configuration > Login and Message > Relationship Check。
      使用如下接口增删好友和管理好友列表。
      API
      描述
      添加关系链的监听器，用于接收好友列表和黑名单的变更事件
      移除关系链的监听器
      获取好友列表
      获取指定好友资料
      设置指定好友资料
      搜索好友列表
      addFriend
      添加好友
      删除好友
      检查指定用户的好友关系
      获取好友申请列表
      同意好友申请
      拒绝好友申请
      删除好友申请
      设置好友申请已读
      新建好友分组
      获取分组列表
      删除好友分组
      修改好友分组的名称
      添加好友到一个好友分组
      从好友分组中删除好友
      订阅公众号
      取消订阅公众号
      获取公众号列表
      关注用户
      取消关注用户
      获取我的关注列表
      获取我的互关列表
      获取指定用户的 关注/粉丝/互关 数量信息
      检查指定用户的关注类型
      联系我们

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

      联系我们
      技术支持

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

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款