tencent cloud

Feedback

Last updated: 2023-07-17 16:12:29

    Feature Description

    To block a user's messages, add the user to the blocklist.

    Blocking a user

    By adding a user to the blocklist, you can block all the messages sent by the user. Therefore, this API can be used to block the messages of a specified user.
    If user A and user B are friends, the two-way friend relationship is terminated when either A or B is blocked by the other user.
    If either user A or user B is blocked by the other user, neither user A nor user B can start a conversation with the other user.
    If either user A or user B is blocked by the other user, neither user A nor user B can send a friend request to the other user.
    API
    chat.addToBlacklist(options);
    Parameter
    The options parameter is of the Object type. It contains the following attribute values:
    Name
    Type
    Description
    userIDList
    Array
    List of userID values of the users to be added to the blocklist. The number of userID values cannot exceed 1,000 per request.
    Returned value
    Promise
    Sample
    let promise = chat.addToBlacklist({userIDList: ['user1', 'user2']});
    promise.then(function(imResponse) {
    console.log(imResponse.data);
    console.warn('addToBlacklist error:', imError); // Failed to add the user to the blocklist
    });

    Unblocking a user

    After a user is removed from the blocklist, messages from the user can be received.
    API
    chat.removeFromBlacklist(options);
    Parameter
    The options parameter is of the Object type. It contains the following attribute values:
    Name
    Type
    Description
    userIDList
    Array
    List of userID values of the users to be removed from the blocklist. The number of userID values cannot exceed 1,000 per request.
    Returned value
    Promise
    Sample
    let promise = chat.removeFromBlacklist({userIDList: ['user1', 'user2']});
    console.log(imResponse.data);
    console.warn('removeFromBlacklist error:', imError); // Failed to remove the user from the blocklist
    });

    Getting the blocklist

    The blocklist cached in the SDK can be obtained. When a friend list is updated, the SDK will deliver the TencentCloudChat.EVENT.FRIEND_GROUP_LIST_UPDATED event.
    API
    chat.getBlacklist();
    Returned value
    Promise
    Sample
    let promise = chat.getBlacklist();
    promise.then(function(imResponse) {
    console.log(imResponse.data);
    }).catch(function(imError) {
    console.warn('getBlacklist error:', imError); // Failed to obtain the blocklist
    });

    Notification of a change in the blocklist

    Sample
    let onBlacklistUpdated = function(event) {
    console.log(event.data);
    };
    chat.on(TencentCloudChat.EVENT.BLACKLIST_UPDATED, onBlacklistUpdated);
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support