tencent cloud

文档反馈

JavaScript

最后更新时间:2024-10-30 11:51:44

    功能描述

    在删除好友或退出群组后,如果不需要查看好友或群会话的历史消息,可以选择删除会话。

    删除会话

    注意
    1. 删除会话默认不会多端同步,如果需要多端同步,您可以在 Chat Console 开启多端同步。开关路径:Applications > Your App > Chat > Configuration > Login and Message > Multi-client Synchronization Settings。
    2. 支持批量删除会话(每次最多支持删除100个会话),同时可选择是否清空会话历史消息。
    接口
    chat.deleteConversation(conversationID);
    参数
    Name
    Type
    Description
    conversationID
    String
    会话 ID。
    会话 ID 组成方式:
    C2C${userID}(单聊)
    GROUP{groupID}(群聊)
    @TIM#SYSTEM(系统通知会话)
    返回值
    Promise
    示例
    // 删除单一会话, 并清空会话历史消息
    let promise = chat.deleteConversation('C2CExample');
    promise.then(function(imResponse) {
    // 删除会话成功
    const { conversationID } = imResponse.data; // 被删除的会话 ID
    }).catch(function(imError) {
    console.warn('deleteConversation error:', imError); // 删除会话失败的相关信息
    });
    // 删除单一会话, 不清空会话历史消息
    let promise = chat.deleteConversation({conversationIDList: ['C2CExample'], clearHistoryMessage: false});
    promise.then(function(imResponse) {
    // 删除会话成功
    const { conversationIDList } = imResponse.data; // 被删除的会话 ID 列表
    }).catch(function(imError) {
    console.warn('deleteConversation error:', imError); // 删除会话失败的相关信息
    });
    // 删除多个会话, 并清空会话历史消息
    let promise = chat.deleteConversation({conversationIDList: ['C2CExample', 'GROUPExample']});
    promise.then(function(imResponse) {
    // 删除会话成功
    const { conversationIDList } = imResponse.data; // 被删除的会话 ID 列表
    }).catch(function(imError) {
    console.warn('deleteConversation error:', imError); // 删除会话失败的相关信息
    });
    // 删除多个会话, 不清空会话历史消息
    let promise = chat.deleteConversation({conversationIDList: ['C2CExample', 'GROUPExample'], clearHistoryMessage: false});
    promise.then(function(imResponse) {
    // 删除会话成功
    const { conversationIDList } = imResponse.data; // 被删除的会话 ID 列表
    }).catch(function(imError) {
    console.warn('deleteConversation error:', imError); // 删除会话失败的相关信息
    });
    
    联系我们

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

    技术支持

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

    7x24 电话支持