tencent cloud

文档反馈

SDK API(iOS & Mac)

最后更新时间:2023-03-13 15:34:52
    注意:

    新老版本 API 请勿混合使用

    初始化登录接口

    初始化并成功登录,是正常使用腾讯云 IM 服务的前提。

    API 描述
    initSDK 初始化
    unInitSDK 反初始化
    addIMSDKListener 添加 IM 监听
    removeIMSDKListener 移除 IM 监听
    getVersion 获取版本号
    getServerTime 获取服务器当前时间
    login 登录
    logout 退出登录
    getLoginUser 获取登录用户
    getLoginStatus 获取登录状态

    简单消息收发接口

    如果您只需要使用文本和信令(即一段自定义buffer)消息,只需要使用这套简单消息收发接口即可。

    API 描述
    addSimpleMsgListener 设置基本消息(文本消息和自定义消息)的事件监听器,
    请不要同 addAdvancedMsgListener 混用
    removeSimpleMsgListener 移除基本消息(文本消息和自定义消息)的事件监听器
    sendC2CTextMessage 发送单聊(C2C)普通文本消息
    sendC2CCustomMessage 发送单聊(C2C)自定义(信令)消息
    sendGroupTextMessage 发送群聊普通文本消息
    sendGroupCustomMessage 发送群聊自定义(信令)消息

    信令接口

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

    高级消息收发接口

    如果您需要收发图片、视频、文件等富媒体消息,并需要撤回消息、标记已读、查询历史消息等高级功能,推荐使用下面这套高级消息接口(简单消息接口和高级消息接口请不要混用)。

    API 描述
    addAdvancedMsgListener 设置高级消息的事件监听器,
    请不要同 addSimpleMsgListener 混用
    removeAdvancedMsgListener 移除高级消息监听器
    createTextMessage 创建文本消息
    createTextAtMessage 创建 @ 文本消息
    createCustomMessage 创建自定义消息
    createImageMessage 创建图片消息
    createSoundMessage 创建语音消息
    createVideoMessage 创建视频消息
    createFileMessage 创建文件消息
    createLocationMessage 创建地理位置消息
    createFaceMessage 创建表情消息
    createMergerMessage 创建合并转发消息
    createForwardMessage 创建单条转发消息
    createTargetedGroupMessage 创建定向群消息
    createAtSignedGroupMessage 创建带 @ 标记的群消息
    sendMessage 发送消息,消息对象可以由 createXXXMessage 接口创建得来
    setC2CReceiveMessageOpt 设置单聊消息免打扰
    getC2CReceiveMessageOpt 获取单聊消息免打扰状态
    setGroupReceiveMessageOpt 设置群聊消息免打扰状态
    getC2CHistoryMessageList 获取单聊(C2C)历史消息
    getGroupHistoryMessageList 获取群组历史消息
    getHistoryMessageList 获取历史消息高级接口
    revokeMessage 撤回消息,消息对象可以由 createXXXMessage 接口创建得来
    modifyMessage 消息变更
    markC2CMessageAsRead 设置单聊(C2C)消息已读
    markGroupMessageAsRead 设置群组消息已读
    markAllMessageAsRead 标记所有会话为已读
    deleteMessageFromLocalStorage 删除本地消息
    deleteMessages 删除本地及云端的消息
    clearC2CHistoryMessage 清空单聊本地及云端的消息
    clearGroupHistoryMessage 清空群聊本地及云端的消息
    insertGroupMessageToLocalStorage 向群组消息列表中添加一条消息
    insertC2CMessageToLocalStorage 向单聊消息列表中添加一条消息
    findMessages 根据 msgID 查找本地消息
    searchLocalMessages 搜索本地消息
    sendMessageReadReceipts 发送消息已读回执
    getMessageReadReceipts 获取消息已读回执
    getGroupMessageReadMemberList 获取群消息已读群成员列表
    setMessageExtensions 设置消息扩展
    getMessageExtensions 获取消息扩展
    deleteMessageExtensions 删除消息扩展
    translateText 翻译文本消息

    群组相关接口

    腾讯云 IM SDK 支持五种预设的群组类型,每种类型都有其适用场景:

    • 工作群(Work) :创建后不能自由加入,必须由已经在群的用户邀请入群,同旧版本中的 Private。
    • 公开群(Public) :用户申请加入,但需要群主或管理员审批。
    • 会议群(Meeting):适合跟 TRTC 结合实现视频会议和在线教育等场景,支持随意进出,支持查看进群前的历史消息,同旧版本中的 ChatRoom。
    • 社群(Community):创建后可以随意进出,适合用于知识分享和游戏交流等超大社区群聊场景。该功能支持终端 SDK 5.8.1668增强版及以上版本、Web SDK 2.17.0及以上版本,需 购买旗舰版 并在 控制台 >功能配置>群组配置>群功能配置>社群中开通。
    • 直播群(AVChatRoom):适合直播弹幕聊天室等场景,支持随意进出,人数无上限。
    API 描述
    setGroupListener 设置群组监听器(待废弃接口,请使用 addGroupListener 和 removeGroupListener 接口)
    addGroupListener 添加群组监听器
    removeGroupListener 移除群组监听器
    createGroup 创建群组(简单版本)
    createGroup 创建群组(高级版本),可在建群同时设置群信息和初始的群成员
    joinGroup 加入群组
    quitGroup 退出群组
    dismissGroup 解散群组(仅群主和管理员可以解散)
    getJoinedGroupList 获取已经加入的群列表(不包括已加入的直播群)
    getGroupsInfo 拉取群资料
    searchGroups 搜索群列表
    setGroupInfo 修改群资料
    initGroupAttributes 初始化群属性
    setGroupAttributes 设置群属性
    deleteGroupAttributes 删除群属性
    getGroupAttributes 获取群属性
    getGroupOnlineMemberCount 获取群在线人数
    getGroupMemberList 获取群成员列表
    getGroupMembersInfo 获取指定的群成员资料
    searchGroupMembers 搜索指定的群成员资料
    setGroupMemberInfo 修改指定的群成员资料
    muteGroupMember 禁言
    inviteUserToGroup 邀请他人入群
    kickGroupMember 踢人
    setGroupMemberRole 切换群成员的角色
    markGroupMemberList 标记群成员
    transferGroupOwner 转让群主
    getGroupApplicationList 获取加群的申请列表
    acceptGroupApplication 同意某一条加群申请
    refuseGroupApplication 拒绝某一条加群申请
    setGroupApplicationRead 标记申请列表为已读
    getJoinedCommunityList 获取当前用户已经加入的支持话题的社群列表
    createTopicInCommunity 创建话题
    deleteTopicFromCommunity 删除话题
    setTopicInfo 修改话题信息
    getTopicInfoList 获取话题列表

    会话列表相关接口

    会话列表,即登录后首屏看到的列表,包含会话节点、会话名称、群名称、最后一条消息以及未读消息数等元素。

    API 描述
    setConversationListener 设置会话监听器 (待废弃接口,请使用 addConversationListener 和 removeConversationListener 接口)
    addConversationListener 添加会话监听器
    removeConversationListener 移除会话监听器
    getConversationList 获取会话列表
    getConversation 获取指定单个会话
    getConversationList 获取指定多个会话
    getConversationListByFilter 获取会话高级接口,可以指定会话类型、标记类型、分组名等
    deleteConversation 删除会话
    setConversationDraft 设置会话草稿
    setConversationCustomData 设置会话自定义数据
    pinConversation 置顶会话
    markConversation 标记会话
    getTotalUnreadMessageCount 获取会话总未读数
    createConversationGroup 创建会话分组
    getConversationGroupList 获取会话分组列表
    deleteConversationGroup 删除会话分组
    renameConversationGroup 重命名会话分组
    addConversationsToGroup 添加会话到一个会话分组
    deleteConversationsFromGroup 从一个会话分组中删除会话

    用户资料相关接口

    包含查询用户资料、修改个人资料以及屏蔽某人消息(即把某用户加入黑名单中)的相关接口。

    API 描述
    getUsersInfo 获取用户资料
    setSelfInfo 修改个人资料
    getUserStatus 查询用户状态
    setSelfStatus 设置自己的状态
    subscribeUserStatus 订阅用户状态
    unsubscribeUserStatus 取消订阅用户状态
    addToBlackList 屏蔽某人的消息(添加该用户到黑名单中)
    deleteFromBlackList 取消某人的消息屏蔽(把该用户从黑名单中移除)
    getBlackList 获取黑名单列表

    离线推送相关接口

    如果想要在 App 切后台时依然能够实时收到 IM 消息,可以使用离线推送服务。

    API 描述
    setAPNSListener 设置 APNs 监听
    setAPNS 配置 APNS 推送信息
    setVOIP 配置 VOIP 推送信息

    好友管理相关接口

    腾讯云 IM 在收发消息时默认不检查是不是好友关系,您可以在 控制台 >功能配置>登录与消息>好友关系检查中开启"发送单聊消息检查关系链"开关,并使用如下接口增删好友和管理好友列表。

    API 描述
    setFriendListener 设置关系链与好友资料监听器(待废弃接口,请使用 addFriendListener 和 removeFriendListener 接口)
    addFriendListener 添加关系链监听器
    removeFriendListener 移除关系链监听器
    getFriendList 获取好友列表
    getFriendsInfo 获取指定好友资料
    setFriendInfo 设置指定好友资料
    searchFriends 搜索好友列表
    addFriend 添加好友
    deleteFromFriendList 删除好友
    checkFriend 检查指定用户的好友关系
    getFriendApplicationList 获取好友申请列表
    acceptFriendApplication 同意好友申请
    refuseFriendApplication 拒绝好友申请
    deleteFriendApplication 删除好友申请
    setFriendApplicationRead 设置好友申请已读
    createFriendGroup 新建好友分组
    getFriendGroups 获取分组信息
    deleteFriendGroup 删除好友分组
    renameFriendGroup 修改好友分组的名称
    addFriendsToFriendGroup 添加好友到一个好友分组
    deleteFriendsFromFriendGroup 从好友分组中删除好友
    联系我们

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

    技术支持

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

    7x24 电话支持