List Blocked Messages

List CometChat blocked messages with REST API to review content stopped by moderation rules.

GET /moderation/blocked-messages

List Blocked Messages

cURL

curl --request GET \
  --url https://{appId}.api-{region}.cometchat.io/v3/moderation/blocked-messages \
  --header 'apikey: <api-key>'

import requests

url = "https://{appId}.api-{region}.cometchat.io/v3/moderation/blocked-messages"

headers = {"apikey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {apikey: '<api-key>'}};

fetch('https://{appId}.api-{region}.cometchat.io/v3/moderation/blocked-messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{appId}.api-{region}.cometchat.io/v3/moderation/blocked-messages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{appId}.api-{region}.cometchat.io/v3/moderation/blocked-messages"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apikey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{appId}.api-{region}.cometchat.io/v3/moderation/blocked-messages")
  .header("apikey", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{appId}.api-{region}.cometchat.io/v3/moderation/blocked-messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "data": [
    {
      "ruleId": "image-moderation",
      "ruleName": "AI Image Moderation",
      "revisionId": "253156be20433c97_image-moderation_4",
      "condition": {
        "id": 1,
        "isKeywordsReferencePresent": false,
        "isMediaPresent": true,
        "entity": "message",
        "operand": "image",
        "category": "word",
        "operator": "contains",
        "value": [
          "Any unsafe content_greaterThan_70"
        ],
        "message": [
          "Image contains Any unsafe content with confidence greater than 70"
        ],
        "weight": 1
      },
      "message": {
        "id": "65",
        "muid": "_5zytzmceo",
        "conversationId": "superhero1_user_superhero2",
        "sender": "superhero1",
        "receiverType": "user",
        "receiver": "superhero2",
        "category": "message",
        "type": "image",
        "data": {
          "metadata": {
            "file": []
          },
          "resource": "WEB-4_0_3-ffa565b2-476e-493d-aeb5-4c750aae3ab1-1719925738505",
          "url": "https://data-eu.cometchat.io/2601293c931567f7/media/1719993037_336554568_9e044ea0ed5817381b189680f392bafe.jpeg",
          "attachments": [
            {
              "name": "download.jpeg",
              "extension": "jpeg",
              "size": 4761,
              "mimeType": "image/jpeg",
              "url": "https://data-eu.cometchat.io/2601293c931567f7/media/1719993037_336554568_9e044ea0ed5817381b189680f392bafe.jpeg"
            }
          ],
          "entities": {
            "sender": {
              "entity": {
                "uid": "superhero1",
                "name": "Iron Man",
                "avatar": "https://data-eu.cometchat.io/assets/images/avatars/ironman.png",
                "status": "offline",
                "role": "default"
              },
              "entityType": "user"
            },
            "receiver": {
              "entity": {
                "uid": "superhero2",
                "name": "Captain America",
                "avatar": "https://data-eu.cometchat.io/assets/images/avatars/captainamerica.png",
                "status": "offline",
                "role": "default",
                "conversationId": "superhero1_user_superhero2"
              },
              "entityType": "user"
            }
          },
          "moderation": {
            "status": "pending"
          }
        },
        "sentAt": 1719993037,
        "updatedAt": 1719993037
      },
      "action": [
        "blockMessage"
      ],
      "createdAt": 1719993038,
      "updatedAt": 1719993038
    }
  ],
  "meta": {
    "current": {
      "limit": 50,
      "count": 20
    }
  }
}

Authorizations

apikey · string · header · required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Response

200 - application/json

List Blocked Messages

data · object

Show child attributes