SDK 文档

服务端 API

SDK API(Web & 小程序)

最近更新时间:2021-10-20 16:13:32

以下视频将帮助您快速了解 Web 和小程序端 SDK API:

TIM

TIM 是 IM Web SDK 的命名空间,提供了创建 SDK 实例的静态方法 create() ,以及事件常量 EVENT,类型常量 TYPES

初始化

API 描述
create 创建 SDK 实例。

SDK 实例

基本概念 说明
Message(消息) IM SDK 中 Message 表示要发送给对方的内容,消息包括若干属性,例如自己是否为发送者,发送人帐号以及消息产生时间等。
Conversation(会话) IM SDK 中 Conversation 分为两种:
  • C2C(Client to Client)会话,表示单聊情况,自己与对方建立的对话。
  • GROUP(群)会话,表示群聊情况下群内成员组成的会话。
  • Profile(资料) IM SDK 中 Profile 描述个人的常用基本信息,例如昵称、性别、个性签名以及头像地址等。
    Friend(好友) IM SDK 中 Friend 描述好友的常用基本信息,例如备注、分组等。
    FriendApplication(好友申请) IM SDK 中 FriendApplication 描述好友申请的常用基本信息,例如加好友来源、备注等。
    FriendGroup(好友分组) IM SDK 中 FriendGroup 描述好友分组的常用基本信息,例如分组名、分组成员等。
    Group(群组) IM SDK 中 Group 表示一个支持多人聊天的通信系统,支持好友工作群、陌生人社交群、临时会议群以及直播群。
    GroupMember(群成员) IM SDK 中 GroupMember 描述群内成员的常用基本信息,例如 ID、昵称、群内身份以及入群时间等。
    群提示消息 当有用户被邀请加入群组或被移出群组等事件发生时,群内会产生提示消息,接入侧可以根据实际需求展示给群组用户或忽略。
    群提示消息有多种类型,详细描述请参见 Message.GroupTipPayload
    群系统通知消息 当有用户申请加群等事件发生时,管理员会收到申请加群等系统消息。管理员同意或拒绝加群申请,IM SDK 会通过群系统通知消息将申请加群等相应消息发送给接入侧,由接入侧展示给用户。
    群系统通知消息有多种类型,详细描述请参见 Message.GroupSystemNoticePayload
    消息上屏 用户单击发送后,事先输入的文字或选择的图片等信息显示在用户电脑屏幕或手机屏幕上的过程。

    登录相关

    API 描述
    login 登录。
    logout 登出。

    消息

    API 描述
    createTextMessage 创建文本消息。
    createTextAtMessage 创建可以附带 @ 提醒功能的文本消息。
    createImageMessage 创建图片消息。
    createAudioMessage 创建音频消息。
    createVideoMessage 创建视频消息。
    createCustomMessage 创建自定义消息。
    createFaceMessage 创建表情消息。
    createFileMessage 创建文件消息。
    createMergerMessage 创建合并消息。
    downloadMergerMessage 下载合并消息。
    createForwardMessage 创建转发消息。
    sendMessage 发送消息。
    revokeMessage 撤回消息。
    resendMessage 重发消息。
    deleteMessage 删除消息。

    会话

    API 描述
    getMessageList 获取消息列表。
    setMessageRead 设置消息已读。
    getConversationList 获取会话列表。
    getConversationProfile 获取会话资料。
    deleteConversation 删除会话。
    pinConversation 置顶或取消置顶会话。

    资料

    API 描述
    getMyProfile 获取个人资料。
    getUserProfile 获取其他用户资料。
    updateMyProfile 更新个人资料。
    getBlacklist 获取我的黑名单列表。
    addToBlacklist 添加用户到黑名单列表。
    removeFromBlacklist 将用户从黑名单中移除。

    关系链

    API 描述
    getFriendList 获取 SDK 缓存的好友列表。
    addFriend 添加好友。
    deleteFriend 删除好友。
    checkFriend 校验好友关系。
    getFriendProfile 获取指定好友的好友数据和资料数据。
    updateFriend 更新好友的关系链数据。
    getFriendApplicationList 获取 SDK 缓存的好友申请列表。
    acceptFriendApplication 同意好友申请。
    refuseFriendApplication 拒绝好友申请。
    deleteFriendApplication 删除好友申请。
    setFriendApplicationRead 上报好友申请已读。
    getFriendGroupList 获取 SDK 缓存的好友分组列表。
    createFriendGroup 创建好友分组。
    deleteFriendGroup 删除好友分组。
    addToFriendGroup 添加好友到分组列表。
    removeFromFriendGroup 从好友分组移除好友。
    renameFriendGroup 修改好友分组的名称。

    群组

    API 描述
    getGroupList 获取群组列表。
    getGroupProfile 获取群详细资料。
    createGroup 创建群组。
    dismissGroup 解散群组。
    updateGroupProfile 修改群组资料。
    joinGroup 申请加群。
    quitGroup 退出群组。
    searchGroupByID 搜索群组。
    getGroupOnlineMemberCount 获取直播群在线人数。
    changeGroupOwner 转让群组。
    handleGroupApplication 处理申请加群。
    initGroupAttributes 初始化群属性。
    setGroupAttributes 设置群属性。
    deleteGroupAttributes 删除群属性。
    getGroupAttributes 获取群属性。

    群成员

    API 描述
    getGroupMemberList 获取群成员列表。
    getGroupMemberProfile 获取群成员资料。
    addGroupMember 添加群成员。
    deleteGroupMember 删除群成员。
    setGroupMemberMuteTime 设置群成员的禁言时间。
    setGroupMemberRole 修改群成员角色。
    setGroupMemberNameCard 设置群成员名片。
    setGroupMemberCustomField 设置群成员自定义字段。
    setMessageRemindType 设置群消息提示类型。

    其他

    API 描述
    on 监听事件。
    off 取消监听事件。
    registerPlugin 注册插件。
    setLogLevel 设置日志级别。
    destroy 销毁 SDK 实例。
    目录