POST Chat

Report Message

A reported message is temporarily removed from the chat event stream until it is evaluated by a moderator.

POST /api/v3/{appid}/chat/rooms/{roomid}/events/{eventid}/report

A reported message is temporarily removed from the chat event stream until it is evaluated by a moderator.

POST PARAMETERS

userid : (optional) The application provided userid of the user who reported the abuse.
reporttype: (required) This is the classification of the reported post. It must be one of the below values (note that 'false' represents information considered false by the reporter:
- abuse
- spam
- selfharm
- hate
- violence
- harassment
- nudity
- illegal
- false
- other

RESPONSE CODES

200 | OK : Sweet, sweet success.
400 | BadRequest : Something is wrong with your request. View response message and errors list for details.
403 | Forbidden : The userid issuing the request is banned from chatting in this room (or is banned globally), or, attempted to report an event that was published by a moderator or admin.

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

eventid path

string TalkLabs ID required

The TalkLabs assigned chat event ID.

Request

JSON body

Send as application/json.

reportType

integer · int32 required

userId

string customer-defined required

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

Request example

{
  "reportType": {},
  "userId": "u-8842"
}

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}/events/${EVENT_ID}/report" \
  --header "Accept: application/json" \
  --header "x-api-token: ${TALKLABS_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "reportType": {},
  "userId": "u-8842"
}'

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

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

const result = await response.json();

import json
import os
import requests

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

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

Environment variables TALKLABS_APP_ID TALKLABS_API_TOKEN

Response