> For the complete documentation index, see [llms.txt](https://docs.ggwp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ggwp.com/chinese-simplified/api-wen-dang-bao-gao/biao-zhun-tao-can/bao-gao-api.md).

# 报告 API

\[ 基础 URL: `api.ggwp.com`]

`POST` /reporting/v1/report

## **描述**

此 API 端点用于与 GGWP 的 Reports Service 集成。它接收有关举报类型、涉及各方以及每条传入举报的其他上下文信息。GGWP Reports Service 拥有一系列模型，会依赖这些信息来评估举报和举报人的可信度、对事件进行优先级排序，并调整玩家信誉分。 

GGWP 开箱即支持一组精选的举报类别。以下是附有通用定义的列表，请注意它们可能会因游戏而异：

* **挂机** - 长时间离开键盘，在进行中的游戏中没有积极参与
* **作弊** - 使用未经授权、违反游戏规则的方法来获得不公平优势，通常通过使用第三方软件或脚本。作弊示例包括使用自瞄、透视、传送等。
* **表扬** - 对游戏中任何积极行为对另一名玩家表示认可或赞扬
* **利用漏洞** - 滥用或误用游戏中的故障、漏洞或非预期功能，以获得不公平优势
* **恶意捣乱** - 故意干扰或破坏其他玩家的游戏体验，或为了个人娱乐而骚扰其他玩家。恶意捣乱的例子包括偷战利品、阻挡队友、故意输掉比赛等。
* **仇恨言论** - 基于宗教、族裔、国籍、种族、性别、性取向或其他身份因素，针对其他玩家使用歧视性、贬损性语言或侮辱性词汇
* **不当用户名** - 使用包含粗俗、冒犯性或仇恨性内容的用户名
* **言语辱骂** - 对其他玩家使用侮辱性、贬损性或煽动性语言。这类语言极不尊重他人，可能会让其他玩家感到非常不舒服，甚至想要离开对话
* **诈骗** - 试图欺骗或诱使其他玩家执行非故意且可能有害的操作。诈骗示例包括试图获取地址、银行账户或信用卡号码等个人信息，以及诱导玩家点击恶意链接
* **刷屏** - 在游戏聊天中反复发送大量未经请求或无关的消息，以干扰或骚扰其他玩家
* **队友击杀** - 故意击杀或攻击队友
* **其他**

在入驻期间还可以添加额外的自定义类别。

## **参数**

`请求体`：包含以下字段的字典：

* **reporter\_id**：提交举报的玩家的唯一标识符
* **reportee\_id**：被举报玩家的唯一标识符
* （可选） **reporter\_name**：提交举报的玩家姓名
* （可选） **reportee\_name**：被举报玩家姓名
* **category**：举报类别名称。如果可能，请使用上文所述的精选举报类别列表。也支持其他自定义类别，但需要额外的校准时间，以反映它们对信誉的影响 
* （可选） **session\_id**：唯一会话标识符。这将作为汇总和验证举报时的上下文边界。
* （可选） **时间戳**：举报提交时间 *YYYY-MM-DD HH:MM:SS* 格式，使用 UTC。如果未提供，则会在其位置添加服务器端 UTC 时间戳
* （可选） **comment**：玩家在提交举报时可能留下的任何评论。这有助于评估举报的可信度。
* （可选） **message\_id**：被举报消息或帖子的唯一标识符，取自 [Chat API](https://docs.ggwp.com/api-docs-chat/standard-package/chat-api)。它提供了在仪表板上查看和验证违规内容所需的直接上下文。
* 示例调用

  ```bash
  curl --request POST 'https://api.ggwp.com/reporting/v1/report' \\
  --header 'x-api-key: api_key' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "reporter_id":"<player_id_1>",
      "reportee_id":"<player_id_2>",
      "reporter_name": "Sniper 7",
      "reportee_name": "Skuller89",
      "备注": "ggez",
      "timestamp": "2022-12-30 07:44:37",
      "category": "言语辱骂",
      "session_id": "<unique_session_id>",
      "message_id": "<chat_message_id>"
  }'
  ```

## **输出**

* 200 - 操作成功

  ```json
  {
      "success": true
  }
  ```
* 400
  * 错误响应。举报尚未插入到系统中。&#x20;
  * 验证项
    * &#x20;`时间戳` 无效或位于未来时间。
    * `message_id` 无效（未找到对应的聊天消息）。
    * `reportee_id` 与消息作者不一致（当提供 message\_id 时）。
    * `session_id` 与消息中的内容不一致（当提供 message\_id 时）。
* 403
  * 无效或缺失的 API 密钥
* 500
  * 错误响应。举报尚未插入到系统中。处理请求时服务器发生了错误