SDK APIs (Web & Mini Program)

Last updated: 2021-01-05 10:04:44


    TIM is the namespace of the IM Web SDK and provides the static method create() for creating SDK instances, the event constant EVENT, and the type constant TYPES.


    API Description
    create Creates an SDK instance.

    SDK Instance

    Term Description
    Message Message indicates the content to be sent and carries multiple attributes which specify whether you are the sender, the sender account, the message generation time, and so on.
    Conversation Two types of Conversation are available:
  • Client to Client (C2C): a one-to-one chat, involving only 2 participants.
  • GROUP: a group chat, involving more than 2 participants.
  • Profile Profile describes the basic information of a user, including the nickname, gender, personal signature, and profile photo address.
    Group Group in IM SDK is a communication system for group chatting, including Work, Public, Meeting, and AVChatRoom.
    GroupMember (Group member) GroupMember indicates the basic information of each group member, such as the ID, nickname, role, and the time of joining the group.
    Group notification A group notification is generated when an event such as group member addition or deletion occurs. You can configure whether to display group notifications to group members.
    For more information about group notification types, see Message.GroupTipPayload.
    Group system message For example, when a user applies for joining a group, the group admin receives a system message. After the admin accepts or denies the application, the IM SDK returns the application result to the access terminal, and then the user can view the result displayed on the access terminal.
    For more information about types of group system messages, see Message.GroupSystemNoticePayload.
    Message display on screen This is the process by which messages, including text and images, are displayed on the computer or phone screen after the user clicks send.


    API Description
    login Logs in to the IM.
    logout Logs out of the IM console.


    API Description
    createTextMessage Creates a text message.
    createImageMessage Creates an image message.
    createAudioMessage Creates a voice message.
    createVideoMessage Creates a video message.
    createCustomMessage Creates a custom message.
    createFaceMessage Creates an emoji message.
    createFileMessage Creates a file message.
    sendMessage Sends a message.
    revokeMessage Recalls a message.
    resendMessage Resends a message.
    getMessageList Obtains the message list.
    setMessageRead Sets a message to the read state.


    API Description
    getConversationList Obtains the conversation list.
    getConversationProfile Obtains the conversation information.
    deleteConversation Deletes a conversation.


    API Description
    getMyProfile Obtains your personal profile.
    getUserProfile Obtains the profile of a user.
    updateMyProfile Updates your personal profile.
    getBlacklist Obtains your blocklist.
    addToBlacklist Adds a user to the blocklist.
    removeFromBlacklist Deletes a user from the blocklist.


    API Description
    getGroupList Obtains the group list.
    getGroupProfile Obtains the group profile.
    createGroup Creates a group.
    dismissGroup Disbands a group.
    updateGroupProfile Modifies the group profile.
    joinGroup Applies to join a group.
    quitGroup Quits a group.
    searchGroupByID Searches for a group.
    changeGroupOwner Transfers the ownership of a group.
    handleGroupApplication Processes an application for joining a group.
    setMessageRemindType Specifies the notification type of group messages.

    Group member

    API Description
    getGroupMemberList Obtains the group member list.
    getGroupMemberProfile Obtains a group member’s profile.
    addGroupMember Adds a group member.
    deleteGroupMember Deletes a group member.
    setGroupMemberMuteTime Configures the muting period for a group member.
    setGroupMemberRole Modifies the role of a group member.
    setGroupMemberNameCard Configures the name card for a group member.
    setGroupMemberCustomField Configures a custom field for a group member.


    API Description
    on Enables event listening.
    off Disables event listening.
    registerPlugin Registers a plugin.
    setLogLevel Configures the log level.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback