Chat / Platform API
Current version: v3
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Home
    /
    Chat
    /
    Platform API

    Overview

    The report feature allows you to build your own in-app system for reporting and removing objectionable content. You can use this feature with the filter and moderation feature to control or prohibit offensive and abusive messages, users, or channels.


    Resource representation

    The following table shows the list of properties in a report resource.

    Property nameTypeDescription

    reporting_user

    nested object

    The user who reports offensive and abusive messages, users, and channels.

    report_type

    string

    An object type which is reported by the reporting_user. Valid values are message, user, and channel.

    report_category

    string

    A report category which indicates the reason for reporting. Valid values are suspicious, harassing, inappropriate, spam, and custom.

    custom_report_category_name

    string

    The name of the custom report category.

    reported_message

    nested object

    The message which is reported for its suspicious, harassing, or inappropriate content.

    offending_user

    nested object

    The user who is reported for using offensive language.

    channel

    nested object

    Either an open channel or a group channel which is reported for its offensive messages or inappropriate activities.

    report_description

    string

    Additional information included in the report.

    created_at

    long

    The time that the report was created in Unix milliseconds.


    Actions

    • API endpoints are relative to the base URL allocated to your application. In this page, the /report endpoint refers to https://api-{application_id}.sendbird.com/v3/report.

    Note: If you want to know the ID and base URL of your application, sign in to the Sendbird dashboard, go to the Settings > Application > General, and then check the Application ID, API request URL.

    ActionHTTP Request

    List reports

    GET /report
    Retrieves a list of reports within an application.

    List reports on a user

    GET /report/users/{offending_user_id}
    Retrieves a list of reports on a user who sends offensive messages.

    List reports on a channel

    GET /report/{channel_type}/{channel_url}
    Retrieves a list of reports on a channel that has offensive messages or abusive activities.

    List reports on a message

    GET /report/{channel_type}/{channel_url}/messages/{message_id}
    Retrieves a list of reports on a message which contains suspicious, harassing, or inappropriate content.

    List moderated messages

    GET /report/{channel_type}/{channel_url}/profanity_messages
    Retrieves a list of messages that are moderated by the profanity filter.

    Get a moderated message

    GET /report/{channel_type}/{channel_url}/profanity_messages/{message_id}
    Retrieves information on a message that has been moderated by the profanity filter.

    Report a user

    POST /report/users/{offending_user_id}
    Reports a user who sends an offensive message in a channel.

    Report a channel

    POST /report/{channel_type}/{channel_url}
    Reports a specific channel that has offensive messages or abusive activities.

    Report a message

    POST /report/{channel_type}/{channel_url}/messages/{message_id}
    Reports a message considered suspicious, harassing, inappropriate, or spam.