tencent cloud

文档反馈

JavaScript

最后更新时间:2024-11-20 15:50:47

    功能描述

    会话置顶,指的是把好友或者群会话固定在会话列表的最前面,方便用户查找。置顶状态会存储在服务器,切换终端设备后,置顶状态会同步到新设备上。 调用接口成功后会话列表重新排序,SDK 会派发事件 TencentCloudChat.EVENT.CONVERSATION_LIST_UPDATED
    说明:
    置顶会话数上限 50,不支持增加。

    置顶与取消置顶会话

    接口
    chat.pinConversation(options);
    参数 options 为 Object 类型,包含的属性值如下:
    参数
    Name
    Type
    Description
    conversationID
    String
    会话 ID。会话 ID 组成方式:
    C2C${userID}(单聊)
    GROUP{groupID}(群聊)
    @TIM#SYSTEM (群系统会话)
    GROUP${topicID} (话题会话)
    isPinned
    Boolean
    true 表示置顶会话
    false 表示取消置顶会话
    返回值
    Promise
    示例
    let promise = chat.pinConversation({ conversationID: 'C2CExample', isPinned: true });
    promise.then(function(imResponse) {
    // 置顶会话成功
    const { conversationID } = imResponse.data; // 被置顶的会话 ID
    }).catch(function(imError) {
    const { code } = imError;
    // code - 50002 会话 ID 无效
    console.warn('pinConversation error:', imError); // 置顶会话失败的相关信息
    });
    let promise = chat.pinConversation({ conversationID: 'C2CExample', isPinned: false });
    promise.then(function(imResponse) {
    // 取消置顶会话成功
    const { conversationID } = imResponse.data; // 被取消置顶的会话 ID
    }).catch(function(imError) {
    console.warn('pinConversation error:', imError); // 取消置顶会话失败的相关信息
    });
    
    联系我们

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

    技术支持

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

    7x24 电话支持