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

    List reports on a message

    Retrieves a list of reports on a message which contains suspicious, harassing, or inappropriate content.


    HTTP request

    GET https://api-{application_id}.sendbird.com/v3/report/{channel_type}/{channel_url}/messages/{message_id}
    

    Parameters

    The following table lists the parameters that this action supports.

    Parameters
    RequiredTypeDescription

    channel_type

    string

    Specifies the type of a channel. Acceptable values are open_channels and group_channels.

    channel_url

    string

    Specifies the URL of a channel.

    message_id

    string

    Specifies the unique ID of a reported message.

    OptionalTypeDescription

    token

    string

    Specifies a page token that indicates the starting index of results to retrieve. If not specified, the index is set to 0.

    limit

    int

    Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)

    ?token=rQ24R4aSpl1alE1WXlVb4SL1&limit=3
    

    Response

    If successful, this action returns a list of report resources on the message in the response body.

    {
        "report_logs": [
            {
                "report_type": "message",
                "report_category": "suspicious",
                "reporting_user": {
                    "user_id": "Matthew",
                    "nickname": "Mooch",
                    "profile_url": "https://sendbird.com/main/img/profiles/profile_44_512px.png",
                    "metadata": {
                        "location": "Singapore",
                        "marriage": "N"
                    }
                },
                "offending_user": {
                    "user_id": "Jane",
                    "nickname": "Trinity",
                    "profile_url": "https://sendbird.com/main/img/profiles/profile_432_512px.png",
                    "metadata": {
                        "location": "London",
                        "marriage": "N"
                    }
                },
                "reported_message": {
                    "message_id": 592281302,
                    "type": "MESG",
                    "custom_type": "",
                    "channel_url": "sendbird_group_channel_15110744_67c34500c14ffa4f9ad23a80d4426e40467ebb91",
                    "user": {
                        "user_id": "Jane",
                        "nickname": "Trinity",
                        "profile_url": "https://sendbird.com/main/img/profiles/profile_432_512px.png",
                        "metadata": {
                            "location": "London",
                            "marriage": "N"
                        }
                    },
                    "mention_type": "users",
                    "mentioned_users": [],
                    "is_removed": false,
                    "message": "Seriously, I am waiting for you at my secret website. Would you join me?",
                    "translations": {},
                    "data": "",
                    "created_at": 1568784875135,
                    "updated_at": 0,
                    "file": {}
                },
                "channel": {
                    "name": "Looking for someone to spend my time with...",
                    "channel_url": "sendbird_group_channel_15110744_67c34500c14ffa4f9ad23a80d4426e40467ebb91",
                    "cover_url": "",
                    "custom_type": "",
                    "unread_message_count": 0,
                    "unread_mention_count": 0,
                    "data": "",
                    "is_distinct": true,
                    "is_public": false,
                    "is_super": false,
                    "is_ephemeral": false,
                    "is_discoverable": false,
                    "is_access_code_required": false,
                    "member_count": 4,
                    "joined_member_count": 4,
                    "members": [
                        ... # A list of channel members.
                    ],
                    "max_length_message": -1,
                    "last_message": {
                        ... # The information of the channel's last message.
                    },
                    "created_at": 15687923728,
                    "freeze": false
                },
                "report_description": "",
                "created_at": 1568791754
            },
            ... # More reports on a message.
        ],
        "next": "LMZ2aVnQdE4EU3XWFNeF25dFkF~Ad~"
    }
    

    List of response properties

    Property nameTypeDescription

    report_logs

    nested object

    A list of reports on a message.

    next

    string

    The value for the token parameter to retrieve the next page in the result set.

    In the case of an error, an error object is returned. A detailed list of error codes is available here.