Report a message, user, or channel

Users can report suspicious or harassing messages and other users who use abusive language in a channel. They can also report the channel itself if there is any inappropriate content or activity in the channel. Based on this functionality and our report API, you can build your own in-app system for managing objectionable content and subject.

To use report API, you can use getReportCategoryInfoList API to retrieve the list of available report categories. Once the category list is fetched, allow the user to select one of the categories. The selected category can be included as a parameter when invoking report API.

Swift

SendbirdChat.getReportCategoryInfoList { reportCategoryInfoList, error in
    guard let reportCategoryInfoList = reportCategoryInfoList else {
        // Handle error.
        return
    }
    
    // select a report category to report
    let reportCategoryInfo = reportCategoryInfoList[0]

    // Report a message
    channel.reportMessage(
        message,
        reportCategoryInfo: reportCategoryInfo,
        reportDescription: DESCRIPTION
    ) { error in
        guard error == nil else {
            // Handle error.
            return
        }
    }
    
    // Report a user
    channel.reportUser(
        user,
        reportCategoryInfo: reportCategoryInfo,
        reportDescription: DESCRIPTION
    ) { error in
        guard error == nil else {
            // Handle error.
            return
        }
    }
    
    // Report a channel
    channel.report(
        reportCategoryInfo: reportCategoryInfo,
        reportDescription: DESCRIPTION
    ) { error in
        guard error == nil else {
            // Handle error.
            return
        }
    }
}

List of parameters

Parameter name	Type	Description
message	BaseMessage	Specifies the message to report for its suspicious, harassing, or inappropriate content.
offendingUser	User	Specifies the user who uses offensive or abusive language such as sending explicit messages or inappropriate comments.
reportCategoryInfo	ReportCategoryInfo	Specifies a report category that indicates the reason for reporting. You can retrieve ReportCategoryInfo through `getReportCategoryInfoList()`. The default categories are `suspicious`, `harassing`, `inappropriate`, and `spam`, but if you have enabled Advanced Moderation, you can add custom categories through the Sendbird Dashboard.
reportDescription	String	Specifies additional information to include in the report.

Sample app