POST Moderate chat

Purge User Messages

command : The command to execute.

POST /api/v3/{appid}/chat/rooms/{roomid}/commands/purge

command: The command to execute. In this case, "*purge "

POST ARGUMENTS

userid: (required) The userid of the user owning the messages to be purged
byuserid: (optional) The userid of the user executing the purge command. If provided, this validates that the user executing the command has the rights to do it

Request

Parameters

Values in the path and query string.

appid path

string TalkLabs ID required

The TalkLabs application ID assigned to your account.

Example: your-app-id

roomid path

string TalkLabs ID required

The TalkLabs assigned room ID returned when the room was created.

Example: room-id

Request

JSON body

Send as application/json.

userid

string customer-defined required

The customer defined user ID from your application or identity system.

byuserid

string customer-defined

Request example

{
  "userid": "u-8842",
  "byuserid": "admin"
}

Response

Status codes

Every JSON response uses the API result envelope.

200 OK ApiResult

400 Bad Request ApiResult

403 Forbidden ApiResult

404 Not Found ApiResult

500 Internal Server Error ApiResult

curl --request POST \
  --url "https://api.sportstalk247.com/api/v3/${APP_ID}/chat/rooms/${ROOM_ID}/commands/purge" \
  --header "Accept: application/json" \
  --header "x-api-token: ${TALKLABS_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "userid": "u-8842",
  "byuserid": "admin"
}'

const appId = process.env.TALKLABS_APP_ID;
const roomid = 'room-id';

const response = await fetch(
  `https://api.sportstalk247.com/api/v3/${appId}/chat/rooms/${roomid}/commands/purge`,
{
  method: 'POST',
  headers: {
    Accept: 'application/json',
    'x-api-token': process.env.TALKLABS_API_TOKEN,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "userid": "u-8842",
  "byuserid": "admin"
}),
});

const result = await response.json();

import json
import os
import requests

app_id = os.environ["TALKLABS_APP_ID"]
roomid = "room-id"

response = requests.post(
    f"https://api.sportstalk247.com/api/v3/{app_id}/chat/rooms/{roomid}/commands/purge",
    headers={
        "Accept": "application/json",
        "x-api-token": os.environ["TALKLABS_API_TOKEN"],
    },
    json=json.loads(r'''{
  "userid": "u-8842",
  "byuserid": "admin"
}'''),
)
response.raise_for_status()
result = response.json()

Environment variables TALKLABS_APP_ID TALKLABS_API_TOKEN

Response