GX Technology : APIs - Moderation Reports - v1

Moderation Reports

Report a Player

Create a moderation report based on the action of one player reporting another player for bad or abusive chat.

Parameters

	Identifier of the player being reported

Request Body

JSON document containing the following: (including authentication information)

Field	Value	Description
`reporter`	identifier	Indicates the id of the player making the report - required
`location`	String	Identifying string of the game in which the chat occurred - required
`room`	String	Identifying string of the room where the chat was occuring - required
`timestamp`	Number	Unix epoch value for when the report was made in-game - required
`reason_id`	Number	ID for the reason this player is being reported (see setting.ban_reason)
`priority`	Number	Value for the priority (-1 = High, 0 = Normal, 1 = Low) (optional, defaults to '0')
`language`	2-char ISO	What language the chat was occurring in, i.e. 'en' = English etc

Example Request

{
  "client_id" : "pim_world",
  "client_token" : "79a8c24ce27d6cfc210975eca9476e0cca4458b9",
  "reporter" : "{cf81389b-bdba-4050-84d4-3a480bd60b8a}",
  "location" : "urn:gid:CLP",
  "room" : "urn:jid:igloo777@com.disney",
  "timestamp" : 1338508800,
  "reason_id" : 10,
  "priority" : 0,
  "language" : "es"
}

Response

200 OK with a JSON document containing the result of the process

Example Response - Success

200 OK

{"result":"success","message":""}

Example Response - Error #1

403 Forbidden

{"result":"error","message":"Authentication failed"}

Example Response - Error #2

406 Not Acceptable

{"result":"error","message":"Invalid reason_id given"}

Example Response - Error #3

406 Not Acceptable

{"result":"error","message":"Timestamp cannot be in the future"}

setting.ban_reason data

These are the values that would be used by systems in-game to create moderation reports.

Value	Reason	Public Reason
"5"	"Swearing"	"Swearing"
"6"	"Bullying or Being Mean"	"Bullying or Being Mean"
"7"	"Disclosing Personal Info"	"Attempted to Reveal Personal Information"
"8"	"Inappropriate Talk"	"Inappropriate Talk"
"10"	"Asking for Personal Info"	"Attempted to Obtain Personal Information"
"11"	"Bad Name"	"Inappropriate Penguin Name"
"12"	"Bad Igloo"	"Inappropriate Igloo Furniture Layout"