List Rules
curl --request GET \
--url https://apimgmt.cometchat.io/apps/{appId}/moderation/rules \
--header 'key: <key>' \
--header 'secret: <secret>'import requests
url = "https://apimgmt.cometchat.io/apps/{appId}/moderation/rules"
headers = {
"key": "<key>",
"secret": "<secret>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {key: '<key>', secret: '<secret>'}};
fetch('https://apimgmt.cometchat.io/apps/{appId}/moderation/rules', 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://apimgmt.cometchat.io/apps/{appId}/moderation/rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"key: <key>",
"secret: <secret>"
],
]);
$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://apimgmt.cometchat.io/apps/{appId}/moderation/rules"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("key", "<key>")
req.Header.Add("secret", "<secret>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apimgmt.cometchat.io/apps/{appId}/moderation/rules")
.header("key", "<key>")
.header("secret", "<secret>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apimgmt.cometchat.io/apps/{appId}/moderation/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["key"] = '<key>'
request["secret"] = '<secret>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "moderation-test",
"name": "Video Moderation",
"description": "AI-powered video moderation to detect unsafe content.",
"enabled": true,
"conditions": [
{
"id": 1,
"isKeywordsReferencePresent": false,
"isMediaPresent": true,
"entity": "message",
"operand": "image",
"category": "word",
"operator": "contains",
"value": [
"violence_greaterThan_30"
],
"message": [
"Image contains violence with confidence greater than 30"
]
}
],
"action": [
"blockMessage"
],
"active": true,
"createdAt": 1720003247,
"updatedAt": 1720003247,
"revisionId": "253179cf5f665257_moderation-test_1"
},
{
"id": "video-moderation1",
"name": "Video Moderation",
"description": "AI-powered video moderation to detect unsafe content.",
"enabled": true,
"conditions": [
{
"id": 1,
"isKeywordsReferencePresent": false,
"isMediaPresent": true,
"entity": "message",
"operand": "image",
"category": "word",
"operator": "contains",
"value": [
"violence_greaterThan_30"
],
"message": [
"Image contains violence with confidence greater than 30"
]
}
],
"action": [
"blockMessage"
],
"active": true,
"createdAt": 1720000488,
"updatedAt": 1720000488,
"revisionId": "253179cf5f665257_video-moderation1_1"
},
{
"id": "text-profanity-filter",
"name": "Text Profanity filter",
"description": "Detect and censor profanity in text messages.",
"enabled": true,
"conditions": [
{
"id": 1,
"isKeywordsReferencePresent": true,
"isMediaPresent": false,
"entity": "message",
"operand": "text",
"category": "word",
"operator": "contains",
"value": [
"profanity-list"
]
}
],
"action": [
"blockMessage"
],
"active": true,
"createdAt": 1718355386,
"updatedAt": 1720006272,
"revisionId": "253157108b5294c4_profanity-filter_25",
"default": true
},
{
"id": "image-moderation",
"name": "AI Image Moderation",
"description": "AI-powered image moderation to detect unsafe content.",
"enabled": false,
"conditions": [
{
"id": 1,
"isKeywordsReferencePresent": false,
"isMediaPresent": true,
"entity": "message",
"operand": "image",
"category": "word",
"operator": "contains",
"value": [
"AnyOf_greaterThan_30"
]
}
],
"action": [
"blockMessage"
],
"active": true,
"createdAt": 1718350200,
"updatedAt": 1719932600,
"revisionId": "253157108b5294c4_image-moderation_11",
"default": true
},
{
"id": "video-moderation",
"name": "AI Video Moderation",
"description": "AI-powered video moderation to detect unsafe content.",
"enabled": false,
"conditions": [
{
"id": 1,
"isKeywordsReferencePresent": false,
"isMediaPresent": true,
"entity": "message",
"operand": "video",
"category": "word",
"operator": "contains",
"value": [
"AnyOf_greaterThan_30"
]
}
],
"action": [
"dropMessage"
],
"active": true,
"createdAt": 1718350199,
"updatedAt": 1720006008,
"revisionId": "253157108b5294c4_video-moderation_10",
"default": true
},
{
"id": "custom-profanity-filter",
"name": "Custom Profanity filter",
"description": "Detect and censor profanity in custom messages.",
"enabled": false,
"conditions": [
{
"id": 1,
"isListReferencePresent": true,
"isMediaPresent": false,
"entity": "message",
"operand": "custom",
"category": "word",
"operator": "contains",
"value": [
"profanity-list"
]
}
],
"action": [
"dropMessage"
],
"active": true,
"createdAt": 1718341200,
"updatedAt": 1719819136,
"revisionId": "253157108b5294c4_profanity-filter_8",
"default": true
},
{
"id": "contact_details_filter",
"name": "Contact details filter",
"description": "Identifies and removes phone numbers from text",
"enabled": false,
"conditions": [
{
"id": 1,
"isKeywordsReferencePresent": false,
"isMediaPresent": false,
"entity": "message",
"operand": "text",
"category": "pattern",
"operator": "contains",
"value": [
"\\\\+?(\\\\d{1,3})?{-.\\\\s}?\\\\(?\\\\d{1,4}?\\\\)?{-.\\\\s}?\\\\d{1,4}{-.\\\\s}?\\\\d{1,4}{-.\\\\s}?\\\\d{1,9}"
]
},
{
"id": 2,
"isKeywordsReferencePresent": false,
"isMediaPresent": false,
"entity": "message",
"operand": "custom",
"category": "pattern",
"operator": "contains",
"value": [
"\\\\+?(\\\\d{1,3})?{-.\\\\s}?\\\\(?\\\\d{1,4}?\\\\)?{-.\\\\s}?\\\\d{1,4}{-.\\\\s}?\\\\d{1,4}{-.\\\\s}?\\\\d{1,9}"
]
}
],
"action": [
"blockMessage"
],
"active": true,
"createdAt": 1718186338,
"updatedAt": 1719836048,
"revisionId": "2531882e5e289115_contact_details_filter_3",
"default": true
},
{
"id": "email_filter",
"name": "Email filter",
"description": "Identify and remove email address from messages",
"enabled": false,
"conditions": [
{
"id": 1,
"isKeywordsReferencePresent": false,
"isMediaPresent": false,
"entity": "message",
"operand": "text",
"category": "pattern",
"operator": "contains",
"value": [
"^{a-zA-Z0-9._%+-}+@{a-zA-Z0-9.-}+\\\\.{a-zA-Z}{2,}$"
]
},
{
"id": 2,
"isKeywordsReferencePresent": false,
"isMediaPresent": false,
"entity": "message",
"operand": "custom",
"category": "pattern",
"operator": "contains",
"value": [
"^{a-zA-Z0-9._%+-}+@{a-zA-Z0-9.-}+\\\\.{a-zA-Z}{2,}$"
]
}
],
"action": [
"blockMessage"
],
"active": true,
"createdAt": 1718099938,
"updatedAt": 1719836049,
"revisionId": "2531882e5e289115_contact_email_filter_5",
"default": true
}
],
"meta": {
"current": {
"limit": 50,
"count": 8
}
}
}Moderation
List Rules
Retrieve a list of all moderation rules.
GET
/
apps
/
{appId}
/
moderation
/
rules
List Rules
curl --request GET \
--url https://apimgmt.cometchat.io/apps/{appId}/moderation/rules \
--header 'key: <key>' \
--header 'secret: <secret>'import requests
url = "https://apimgmt.cometchat.io/apps/{appId}/moderation/rules"
headers = {
"key": "<key>",
"secret": "<secret>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {key: '<key>', secret: '<secret>'}};
fetch('https://apimgmt.cometchat.io/apps/{appId}/moderation/rules', 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://apimgmt.cometchat.io/apps/{appId}/moderation/rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"key: <key>",
"secret: <secret>"
],
]);
$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://apimgmt.cometchat.io/apps/{appId}/moderation/rules"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("key", "<key>")
req.Header.Add("secret", "<secret>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apimgmt.cometchat.io/apps/{appId}/moderation/rules")
.header("key", "<key>")
.header("secret", "<secret>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apimgmt.cometchat.io/apps/{appId}/moderation/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["key"] = '<key>'
request["secret"] = '<secret>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "moderation-test",
"name": "Video Moderation",
"description": "AI-powered video moderation to detect unsafe content.",
"enabled": true,
"conditions": [
{
"id": 1,
"isKeywordsReferencePresent": false,
"isMediaPresent": true,
"entity": "message",
"operand": "image",
"category": "word",
"operator": "contains",
"value": [
"violence_greaterThan_30"
],
"message": [
"Image contains violence with confidence greater than 30"
]
}
],
"action": [
"blockMessage"
],
"active": true,
"createdAt": 1720003247,
"updatedAt": 1720003247,
"revisionId": "253179cf5f665257_moderation-test_1"
},
{
"id": "video-moderation1",
"name": "Video Moderation",
"description": "AI-powered video moderation to detect unsafe content.",
"enabled": true,
"conditions": [
{
"id": 1,
"isKeywordsReferencePresent": false,
"isMediaPresent": true,
"entity": "message",
"operand": "image",
"category": "word",
"operator": "contains",
"value": [
"violence_greaterThan_30"
],
"message": [
"Image contains violence with confidence greater than 30"
]
}
],
"action": [
"blockMessage"
],
"active": true,
"createdAt": 1720000488,
"updatedAt": 1720000488,
"revisionId": "253179cf5f665257_video-moderation1_1"
},
{
"id": "text-profanity-filter",
"name": "Text Profanity filter",
"description": "Detect and censor profanity in text messages.",
"enabled": true,
"conditions": [
{
"id": 1,
"isKeywordsReferencePresent": true,
"isMediaPresent": false,
"entity": "message",
"operand": "text",
"category": "word",
"operator": "contains",
"value": [
"profanity-list"
]
}
],
"action": [
"blockMessage"
],
"active": true,
"createdAt": 1718355386,
"updatedAt": 1720006272,
"revisionId": "253157108b5294c4_profanity-filter_25",
"default": true
},
{
"id": "image-moderation",
"name": "AI Image Moderation",
"description": "AI-powered image moderation to detect unsafe content.",
"enabled": false,
"conditions": [
{
"id": 1,
"isKeywordsReferencePresent": false,
"isMediaPresent": true,
"entity": "message",
"operand": "image",
"category": "word",
"operator": "contains",
"value": [
"AnyOf_greaterThan_30"
]
}
],
"action": [
"blockMessage"
],
"active": true,
"createdAt": 1718350200,
"updatedAt": 1719932600,
"revisionId": "253157108b5294c4_image-moderation_11",
"default": true
},
{
"id": "video-moderation",
"name": "AI Video Moderation",
"description": "AI-powered video moderation to detect unsafe content.",
"enabled": false,
"conditions": [
{
"id": 1,
"isKeywordsReferencePresent": false,
"isMediaPresent": true,
"entity": "message",
"operand": "video",
"category": "word",
"operator": "contains",
"value": [
"AnyOf_greaterThan_30"
]
}
],
"action": [
"dropMessage"
],
"active": true,
"createdAt": 1718350199,
"updatedAt": 1720006008,
"revisionId": "253157108b5294c4_video-moderation_10",
"default": true
},
{
"id": "custom-profanity-filter",
"name": "Custom Profanity filter",
"description": "Detect and censor profanity in custom messages.",
"enabled": false,
"conditions": [
{
"id": 1,
"isListReferencePresent": true,
"isMediaPresent": false,
"entity": "message",
"operand": "custom",
"category": "word",
"operator": "contains",
"value": [
"profanity-list"
]
}
],
"action": [
"dropMessage"
],
"active": true,
"createdAt": 1718341200,
"updatedAt": 1719819136,
"revisionId": "253157108b5294c4_profanity-filter_8",
"default": true
},
{
"id": "contact_details_filter",
"name": "Contact details filter",
"description": "Identifies and removes phone numbers from text",
"enabled": false,
"conditions": [
{
"id": 1,
"isKeywordsReferencePresent": false,
"isMediaPresent": false,
"entity": "message",
"operand": "text",
"category": "pattern",
"operator": "contains",
"value": [
"\\\\+?(\\\\d{1,3})?{-.\\\\s}?\\\\(?\\\\d{1,4}?\\\\)?{-.\\\\s}?\\\\d{1,4}{-.\\\\s}?\\\\d{1,4}{-.\\\\s}?\\\\d{1,9}"
]
},
{
"id": 2,
"isKeywordsReferencePresent": false,
"isMediaPresent": false,
"entity": "message",
"operand": "custom",
"category": "pattern",
"operator": "contains",
"value": [
"\\\\+?(\\\\d{1,3})?{-.\\\\s}?\\\\(?\\\\d{1,4}?\\\\)?{-.\\\\s}?\\\\d{1,4}{-.\\\\s}?\\\\d{1,4}{-.\\\\s}?\\\\d{1,9}"
]
}
],
"action": [
"blockMessage"
],
"active": true,
"createdAt": 1718186338,
"updatedAt": 1719836048,
"revisionId": "2531882e5e289115_contact_details_filter_3",
"default": true
},
{
"id": "email_filter",
"name": "Email filter",
"description": "Identify and remove email address from messages",
"enabled": false,
"conditions": [
{
"id": 1,
"isKeywordsReferencePresent": false,
"isMediaPresent": false,
"entity": "message",
"operand": "text",
"category": "pattern",
"operator": "contains",
"value": [
"^{a-zA-Z0-9._%+-}+@{a-zA-Z0-9.-}+\\\\.{a-zA-Z}{2,}$"
]
},
{
"id": 2,
"isKeywordsReferencePresent": false,
"isMediaPresent": false,
"entity": "message",
"operand": "custom",
"category": "pattern",
"operator": "contains",
"value": [
"^{a-zA-Z0-9._%+-}+@{a-zA-Z0-9.-}+\\\\.{a-zA-Z}{2,}$"
]
}
],
"action": [
"blockMessage"
],
"active": true,
"createdAt": 1718099938,
"updatedAt": 1719836049,
"revisionId": "2531882e5e289115_contact_email_filter_5",
"default": true
}
],
"meta": {
"current": {
"limit": 50,
"count": 8
}
}
}Path Parameters
AppID in which the extension has to be enabled/disabled
Query Parameters
The number of records to fetch.
Response
200 - application/json
List Rule
Show child attributes
Show child attributes
⌘I