get a moderation setting

curl --request GET \
  --url https://apix.us.amity.co/api/v2/moderation-settings \
  --header 'Authorization: <authorization>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://apix.us.amity.co/api/v2/moderation-settings"

headers = {
    "Authorization": "<authorization>",
    "X-API-Key": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: '<authorization>', 'X-API-Key': '<api-key>'}
};

fetch('https://apix.us.amity.co/api/v2/moderation-settings', 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://apix.us.amity.co/api/v2/moderation-settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "X-API-Key: <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://apix.us.amity.co/api/v2/moderation-settings"

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

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v2/moderation-settings")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["X-API-Key"] = '<api-key>'

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

{
  "status": "<string>",
  "data": {
    "maxRepetition": 123,
    "maxRepetitionTimeout": 123,
    "blacklistMuteTimeout": 123,
    "whitelistMuteTimeout": 123,
    "maxRepetitionMuteTimeout": 123,
    "enableImageModeration": true,
    "imageModeration": {
      "nudity": 123,
      "suggestive": 123,
      "violence": 123,
      "disturbing": 123
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "status": "error",
  "code": 400,
  "message": "Bad Request."
}

{
  "status": "error",
  "code": 500,
  "message": "Unexpected error"
}

GET

api

moderation-settings

get a moderation setting

curl --request GET \
  --url https://apix.us.amity.co/api/v2/moderation-settings \
  --header 'Authorization: <authorization>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://apix.us.amity.co/api/v2/moderation-settings"

headers = {
    "Authorization": "<authorization>",
    "X-API-Key": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: '<authorization>', 'X-API-Key': '<api-key>'}
};

fetch('https://apix.us.amity.co/api/v2/moderation-settings', 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://apix.us.amity.co/api/v2/moderation-settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "X-API-Key: <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://apix.us.amity.co/api/v2/moderation-settings"

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

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v2/moderation-settings")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["X-API-Key"] = '<api-key>'

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

{
  "status": "<string>",
  "data": {
    "maxRepetition": 123,
    "maxRepetitionTimeout": 123,
    "blacklistMuteTimeout": 123,
    "whitelistMuteTimeout": 123,
    "maxRepetitionMuteTimeout": 123,
    "enableImageModeration": true,
    "imageModeration": {
      "nudity": 123,
      "suggestive": 123,
      "violence": 123,
      "disturbing": 123
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "status": "error",
  "code": 400,
  "message": "Bad Request."
}

{
  "status": "error",
  "code": 500,
  "message": "Unexpected error"
}

Authorizations

X-API-Key

string

header

required

Headers

Authorization

string

required

Response

Moderation Setting Information

status

string

data

object

Show child attributes

update rule of blacklist.update a moderation setting

⌘I