> 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/jp/apidokyumento-chat/pakkji/chat-api-v2regash.md). # Chat API v2（レガシー） > **旧バージョン** > > このページではレガシー版について説明しています `v2` Chat API のエンドポイント。既存の連携はこのバージョンを引き続き使用できますが、新しい連携では `v3`. > > 現在のバージョンはこちら: [Chat API v3](/jp/apidokyumento-chat/pakkji/chat-api-v3.md) \[ ベースURL: `api.ggwp.com`] `POST` /chat/v2/message ## **説明** この API エンドポイントは、入力メッセージ、セッション ID、ユーザー ID に加え、毒性フィルタリングの強度に関する設定可能なオプションの一覧を処理し、4つのレベルで情報を返します: * **メッセージ詳細** - 有害コンテンツの有無と深刻度を示す指標、および毒性を除去した入力メッセージのさまざまなバリエーション。 * **プレイヤー詳細** - その時点までの会話における特定ユーザーの行動を説明する属性。これには、検出された過去のインシデント種別一覧、プレイヤーのムード、評判スコア、現在のステータスが含まれます。 * **会話サマリー** - そのセッションにおけるこれまでのすべてのアクティビティを示す指標。これには、セッション継続時間、メッセージ数と参加者数、会話のムード、検出されたインシデント総数、およびその種類と深刻度が含まれます。 * **推奨事項** - そのユーザーの過去の履歴または最近の一連の有害行動により科されたペナルティに関する情報。これには、ペナルティ自体、トリガーとなったメッセージと時刻、ペナルティの継続時間が含まれます。 `recommended_message` フィールドは、ペナルティが有効な間は空文字列を返します。この API 出力のこの部分では、次のペナルティが提供されます: * セッションミュート: ユーザーはセッション/試合の残り時間の間ミュートされます。 * ミュート: ユーザーは特定の期間、すべてのセッション/試合でミュートされます。 ## **ヘッダー** *注: 設定が別途 GGWP と共有されている場合は不要です* 以下は設定可能なオプションの一覧です: * **violence**: 個人または集団に対する身体的危害や破壊を促進・称賛・脅迫する表現をフラグ付けします。これには、脅し、死を願う表現、暴力行為の議論が含まれます。サポートされるフィルター強度は次のとおりです: * off: このフィルターは無効です * low: 露骨で極端な暴力表現のみを除去します * 例: "がんになればいいのに", "死ねばいい", "お前の親を殺す", "ガス室に入れるべきだ" * medium: 上記に加えて、10代や子ども向けにふさわしくないその他の暴力的行為への言及を検閲します * 例: "レイプされた", "お前は痴漢か？" * high: 上記に加えて、軽度の暴力表現も除去します * 例: "奴らをリンチしよう", "あのチームは惨敗した", "殺人パーティー" * **sexual\_content**: 露骨な性的コメント、ほのめかし、または不適切もしくは不快な表現を含むメッセージをフラグ付けします。これには、ヌードの描写、性行為への言及、性的に示唆的な言葉が含まれます。サポートされるフィルター強度は次のとおりです: * off: このフィルターは無効です * low: 性的暴力への言及を含む極端な表現のみを除去します * 例: "お前をレイプする", "レイプ犯" * medium: 上記に加えて、性行為へのその他の言及や、中程度に露骨な性的表現も検閲します * 例: "お前のちんこを見せろ", "お前は俺の性奴隷だ", "ケツをしゃぶれ", "気持ちいいフェラが大好きだ" * high: 上記に加えて、子どもにとって不適切と見なされる軽度の性的表現も除去します * 例: "おっぱい", "ちんこ", "ポルノ", "アナル", "処女" * **verbal\_abuse**: 個人または集団に向けられた、敵意のある、侮辱的な、または見下すような言葉を含むメッセージをフラグ付けします。これには、個人攻撃、侮辱、軽蔑的な発言が含まれます。サポートされるフィルター強度は次のとおりです: * off: このフィルターは無効です * low: 非常に不快で侮辱的な語句のみを除去します * 例: "さっさと失せろクソ野郎", "お前はクソみたいに迷惑だ" * medium: 上記に加えて、その他の侮辱的な言葉や直接的な侮辱も検閲します * 例: "くそったれ", "クズ", "バカ", "アホ" * high: 上記に加えて、軽度の侮辱語も除去し、若年層に最も適しています * 例: "お前はバカだ", "間抜け", "インセル", "脳死" * **identity\_hate**: 宗教、民族、国籍、人種、性別、性的指向、その他のアイデンティティ要因に基づいて、個人または集団に対する差別的な言葉を使うメッセージをフラグ付けします。これには、差別語、憎悪的なコメント、または特定のアイデンティティ集団に対して否定的・侮辱的に関連づけられる用語が含まれます。サポートされるフィルター強度は次のとおりです: * off: このフィルターは無効です * low: 極端な憎悪表現のみを除去します * 例: "nigger", "faggot", "cunt", "retard", "chink" * medium: 上記に加えて、特定のアイデンティティ集団に一般的に関連づけられるその他の憎悪的な偏見表現も検閲します * 例: "お前って本当に女々しいな", "あの売春婦たちを見ろ", "トランス野郎", "あいつは白いゴミだ" * high: 上記に加えて、特定のアイデンティティ集団に対するより微妙な偏見と頻繁に関連づけられるアイデンティティ用語も除去します * 例: "それってすごくゲイっぽい", "ノーホモ", "クィアな雰囲気", "すべてのナチ" * **profanity**: 侮蔑的、下品、不適切な言葉、または罵り言葉を使うメッセージをフラグ付けします。サポートされるフィルター強度は次のとおりです: * off: このフィルターは無効です * medium: より露骨な汚い言葉や不快な罵り言葉を除去します * 例: "とっとと失せろ", "地獄に落ちろ", "クソ野郎ども", "黙れ負け犬" * high: 上記に加えて、軽度の罵り言葉も除去します * 例: "あー最悪", "くそったれ", "どっか行け", "初心者ども" * **link\_sharing**: 外部リンクを含むメッセージをフラグ付けし、プレイヤーが不適切なウェブサイト、広告、詐欺、その他潜在的に有害なコンテンツを共有するのを防ぎます。サポートされるフィルター強度は次のとおりです: * off: このフィルターは無効です * medium: 一般的に不適切または成人向けコンテンツに関連すると知られている URL を除去します（例: 性的コンテンツ、ギャンブルやその他の違法行為、フィッシング攻撃の可能性が高いもの） * high: すべての URL を除去します * **drugs**: ゲーム環境に不適切な違法物質、薬物使用、またはドラッグカルチャーへの言及をフラグ付けします。これには、薬物使用に関する議論、推奨、描写が含まれます。サポートされるフィルター値は次のとおりです: * off: このフィルターは無効です * on: このフィルターは有効で、すべての薬物への言及をブロックします * 例: "みんな薬物を使おう", "コカインを試すべき", "アル中", "メス中毒者" * **spam**: チャットやゲーム体験を妨げる、反復的または過剰なメッセージをフラグ付けします。サポートされるフィルター強度は次のとおりです: * off: このフィルターは無効です * on: このフィルターは有効です * **self\_harm**: 自傷、自殺、その他の自己破壊的行動を促進・称賛・示唆するコンテンツをフラグ付けします。サポートされるフィルター値は次のとおりです: * off: このフィルターは無効です * on: このフィルターは有効で、有害な行動を促す内容をブロックします * 例: "死んでしまえ", "喉を切れ", "自分を撃て", "人生をアンインストールしろ" * **pii**: 個人を特定できる情報（PII）を含むメッセージをフラグ付けします。これには、銀行番号、クレジットカード、メールアドレス、電話番号、住所が含まれます。サポートされるフィルター強度は次のとおりです: * off: このフィルターは無効です * medium: 認識されたパターンと文脈に基づき、PII を含む可能性が高いコンテンツを除去するデフォルト値です * *レガシーの別名*: 値 `on` はサポートされており、 `medium` * high: 信頼度に関係なく、一般的な PII 形式に一致するすべてのコンテンツを除去します * **solicitation**: 他のプレイヤーの低リスクな個人情報（例: 名前、電話番号）を取得しようとする、プラットフォーム外へ誘導する、または直接的もしくは疑わしい要求を通じて現実世界の価値（例: お金、デジタル資産）を引き出そうとするメッセージをフラグ付けします。サポートされるフィルター値は次のとおりです: * off: このフィルターは無効です * on: このフィルターは有効で、勧誘としてフラグ付けされたすべてのメッセージをブロックします * **scam**: 欺瞞的、操作的、または不誠実な手法を通じて、アカウント、ゲーム内/現実世界の資産、または高リスクの個人情報（例: 社会保障番号、クレジットカード情報、住所）を盗もうとする詐欺的な手口を含むメッセージをフラグ付けします。サポートされるフィルター値は次のとおりです: * off: このフィルターは無効です * on: このフィルターは有効で、詐欺としてフラグ付けされたすべてのメッセージをブロックします * **minor\_safety**: 児童へのグルーミング行為、加害意図、未成年の性的対象化、または子どもを搾取・操作・危険にさらそうとする試みを示す言葉を含むメッセージをフラグ付けします。サポートされるフィルター値は次のとおりです: * off: このフィルターは無効です * low: 未成年に関する性的コンテンツおよび暴力的コンテンツを除去します * 例: "お前の妹を犯すぞ", "子どもに触れる", "未成年は同意できる", "ロリコンは普通", "10歳児を襲う" * medium: 上記に加えて、グルーミング行為や、未成年と想定される相手との不適切な感情的信頼構築を示唆する表現も検閲します * 例: "年齢のわりに大人びているね", "私のことを親には言わないで", "同年代の人よりあなたに親近感を感じる" * high: 上記に加えて、個人的な質問、秘密にすること、境界を試すような行動を通じて未成年の安全上の懸念を引き起こす可能性のある表現も検閲します * 例: "17歳未満？", "何歳？", "両親は家にいる？", "これは私たちだけの秘密だよ" * **age\_concern**: ユーザーが明示的または暗黙的に年齢を示しているメッセージをフラグ付けします。このカテゴリは情報提供を目的としており、有害意図の検出ではなく、年齢を考慮した安全対策をサポートします。サポートされるフィルター値は次のとおりです: * off: このフィルターは無効です * low: ユーザーが13歳未満であることを示す表現を除去します * 例: "10歳です", "12歳です", "小学生です", "子どもです" * medium: 上記の例を含め、ユーザーが18歳未満であることを示す表現を除去します * 例: "15歳です", "17歳です", "高校生です", "未成年です" * high: 上記の例を含め、ユーザーが21歳未満であることを示す表現を除去します * 例: "19歳です", "まだ21歳じゃない", "法的にお酒は飲めない", "20歳です" 渡すサンプル JSON と base64 エンコードされた変数: {% code overflow="wrap" %} ```bash $ cat config.json { "violence": "off", "sexual_content": "low", "verbal_abuse": "medium", "identity_hate": "medium", "profanity": "high", "link_sharing": "high", "drugs": "off", "spam": "on", "self_harm": "on", "pii": "off", "solicitation": "off", "scam": "off", "minor_safety": "low" } $ base64 config.json ewogCSJ2aW9sZW5jZSI6ICJvZmYiLAoJInNleHVhbF9jb250ZW50IjogImxvdyIsCgkidmVyYmFsX2FidXNlIjogIm1lZGl1bSIsCgkiaWRlbnRpdHlfaGF0ZSI6ICJtZWRpdW0iLAoJInByb2Zhbml0eSI6ICJoaWdoIiwKCSJsaW5rX3NoYXJpbmciOiAiaGlnaCIsCgkiZHJ1Z3MiOiAib2ZmIiwKCSJzcGFtIjogIm9uIiwKCSJzZWxmX2hhcm0iOiAib24iLAoJInBpaSI6ICJvZmYiLCAKCSJzb2xpY2l0YXRpb24iOiAib2ZmIiwKCSJzY2FtIjogIm9mZiIsCgkibWlub3Jfc2FmZXR5IjogImxvdyIKfQ== $curl -H "x-api-config:ewogCSJ2aW9sZW5jZSI6ICJvZmYiLAoJInNleHVhbF9jb250ZW50IjogImxvdyIsCgkidmVyYmFsX2FidXNlIjogIm1lZGl1bSIsCgkiaWRlbnRpdHlfaGF0ZSI6ICJtZWRpdW0iLAoJInByb2Zhbml0eSI6ICJoaWdoIiwKCSJsaW5rX3NoYXJpbmciOiAiaGlnaCIsCgkiZHJ1Z3MiOiAib2ZmIiwKCSJzcGFtIjogIm9uIiwKCSJzZWxmX2hhcm0iOiAib24iLAoJInBpaSI6ICJvZmYiLCAKCSJzb2xpY2l0YXRpb24iOiAib2ZmIiwKCSJzY2FtIjogIm9mZiIsCgkibWlub3Jfc2FmZXR5IjogImxvdyIKfQ==" -H "x-api-key:" -XPOST https://api.ggwp.com/chat/v2/message -d "{"session_id": "match_7765", "message": "fucking retards everywhere", "user_id": "user989", "username": "nlxdz", "timestamp": "2022-06-02 16:49:02"}" ``` {% endcode %} 以下は、x-api-config `x-api-config` ヘッダーが渡されない場合のデフォルト設定です: ```json { "violence": "high", "sexual_content": "high", "verbal_abuse": "high", "identity_hate": "high", "profanity": "high", "link_sharing": "high", "drugs": "on", "spam": "on", "self_harm": "on", "pii": "medium", "solicitation": "off", "scam": "off", "minor_safety": "low", "age_concern": "off" } ``` ## **パラメータ** `body`: 以下のフィールドを含む辞書:\ (*UTF-8 エンコーディングである必要があります)* * **session\_id:** 会話チャネルの一意識別子。ゲームプレイのメッセージでは、単一の試合で展開される会話を識別できます。フォーラムや掲示板では、個別のスレッドや議論を表せます。プラットフォームに複数のチャネル種類（例: ロビー、試合、ダイレクトメッセージなど）がある場合は、会話タイプごとの詳細な分析を可能にするため、session\_id にこの情報を含めることを推奨します。推奨形式は次のとおりです: ```json session_id = "channelType_numericID" ``` * **message:** 会話中にユーザーが送信したメッセージ。1,000文字を超えることはできません。 * **user\_id:** メッセージを送信したプレイヤーまたはユーザーの一意識別子。 * (任意) **username**: ユーザーが選択した親しみやすい表示名の文字列。 * (任意) **timestamp**: メッセージが発生した時刻。UTC の YYYY-MM-DD HH:MM:SS.SSS または YYYY-MM-DD HH:MM:SS 形式。追加されていない場合は、代わりにサーバー側の UTC タイムスタンプが追加されます。 * (任意) **language**: 処理するメッセージの言語。省略した場合、API はメッセージ内容と過去のユーザー履歴から言語の検出を試みます。標準的な英語の言語名（例: `"english"` または `"spanish"`）、および ISO 639-1 の2文字言語コード（例: `"en"` または `"es"`）を受け付けます。 `"en-US"`, `"en-GB"`, `"pt-BR"`、および `"es-MX"` のような完全なロケールタグは現在サポートされていません。代わりに `"en"`, `"pt"`、または `"es"` を送信してください。 * (任意) **message\_index**: 送信されたメッセージを追跡するための文字列フィールドです。指定された場合、出力の `message_details` の下に含まれます。 * (任意) **message\_url**: メッセージに関連付けられた URL を追跡するための文字列フィールドです。http または https スキームのみ有効です。有効で指定された場合、ダッシュボードに表示されます。 * (任意) **metadata**: メッセージに関連するメタデータを追跡するための辞書フィールドです。5KB 未満である必要があります。有効なのは許可されたキーと対応する型のみです。サポートされるキー: * channel (string) - メッセージが送信される通信空間。例: dm, party, guild, local * participants (array\) - チャネルに参加している user\_id * map (string) - メッセージの発生元となる世界、レベル、または環境の識別子または名前 * map\_version (string) - マップのバージョン識別子。レイアウトなどの変更を追跡するために使用します * zone (string) - より細かな位置コンテキストのために使用される、マップ内のサブセクションまたは名前付き領域 * coordinates (object) - マップまたはゾーン内の空間的位置 * x (float) - X 軸方向の位置 * y (float) - Y 軸方向の位置 * z (float) - Z 軸方向の位置 例: ```json { "metadata": { "channel": "dm", "participants": ["user989", "user990"], "map":"golden_wasteland", "map_version":"2026.03.1", "zone":"cacti_forest", "coordinates":{ "x":123.45, "y":67.89, "z":-10.25 } } } ``` 注: 追加のメタデータキーもサポートできます。お使いのプラットフォームに適用される具体的なキーを定義するには、担当営業またはカスタマー担当者とご相談ください。 例: ```json { "session_id": "match_7765", "message": "fucking retards everywhere", "user_id": "user989", "username": "nlxdz", "timestamp": "2022-06-02 16:49:02" } ``` サンプル呼び出し: ```bash curl --request POST 'https://api.ggwp.com/chat/v2/message' \\ --header 'x-api-key: api_key' \\ --header 'Content-Type: application/json' \\ --data-raw '{ "session_id": "match_7765", "message": "fucking retards everywhere", "user_id": "user989", "username": "nlxdz", "timestamp": "2022-06-02 16:49:02" }' ``` ## **出力** * 200レスポンス - 成功した操作 以下のフィールドを含む辞書: * **message\_details**: ペイロードで渡されたメッセージに関する詳細 * message\_details.message\_id: メッセージに割り当てられた一意識別子。 * message\_details.original\_message: ユーザーが送信した生のメッセージ。 * message\_details.flag: メッセージがフラグ付けされたかどうかを示します。 * message\_details.severity: 毒性の深刻度（none、low、medium、high）。 * message\_details.filtered\_message: フラグ付けされた語句を除去したメッセージのバージョン。 * スペース区切りの言語（例: 英語）では、単語全体がフィルタリングされます。例: `You are a shithead` --> `You are a *****` * 明示的な単語境界のない言語（例: 韓国語、日本語、中国語）では、検出された語句そのものだけがフィルタリングされます。例: `좆까고 있네`--> `*****고 있네` * message\_details.replaced\_message: 元のメッセージの代わりに生成された、安全またはユーモラスな代替文。 * message\_details.recommended\_message: クライアントに渡す推奨メッセージ。アクティブユーザーの場合、この値のデフォルトは `filtered_message`です。ミュート中のユーザーでは、 `recommended_message` は空文字列になります。 * message\_details.language: メッセージの検出言語。 * message\_details.violence: メッセージに暴力が含まれている場合は true。 * message\_details.verbal\_abuse: メッセージに暴言が含まれている場合は true。 * message\_details.profanity: メッセージに不適切な言葉が含まれている場合は true。 * message\_details.sexual\_content: メッセージに性的コンテンツが含まれている場合は true。 * message\_details.identity\_hate: メッセージにアイデンティティ差別が含まれている場合は true。 * message\_details.drugs: メッセージに薬物への言及が含まれている場合は true。 * message\_details.self\_harm: メッセージに自傷が含まれている場合は true。 * message\_details.custom: メッセージにカスタムブロックリストの語句が含まれている場合は true。 * message\_details.spam: メッセージにスパムが含まれている場合は true。 * message\_details.link: メッセージに外部リンクが含まれている場合は true。 * message\_details.pii: メッセージに個人を特定できる情報が含まれている場合は true。 * **player\_details**: ペイロード内の `user_id` に関する詳細を含む辞書 `session_id` * player\_details.user\_id: ユーザーの一意識別子。 * player\_details.username: ユーザーの表示名。 * player\_details.num\_messages: 送信されたメッセージ総数。 * player\_details.num\_incidents: インシデント数。 * player\_details.cumulative\_mood: ユーザーのメッセージ全体の感情傾向。 * player\_details.min\_mood: ユーザーのメッセージで観測された最も低い感情傾向。 * player\_details.max\_mood: ユーザーのメッセージで観測された最も高い感情傾向。 * player\_details.incident\_types\_detected: ユーザーに関連付けられたインシデント種別の一覧。 * player\_details.incidents\_by\_severity: 深刻度ごとにグループ化したインシデントの内訳。 * player\_details.reputation\_score: 行動履歴から算出されたユーザー全体の評判スコア。 * player\_details.languages: ユーザーのメッセージから検出された言語。 * player\_details.user\_status: ユーザーの現在のモデレーション状態（例: active, muted）。 * player\_details.user\_status.status: 適用された具体的なモデレーション処置（muted など）。 * player\_details.user\_status.expiry\_at: モデレーション処置の期限が切れる時刻。 * **conversation\_summary**: ペイロード内の `session_id` のペイロード * conversation\_summary.start\_time: 会話セッションが開始されたタイムスタンプ。 * conversation\_summary.session\_duration: 会話の総継続時間（秒）。 * conversation\_summary.num\_messages: 会話内のメッセージ総数。 * conversation\_summary.num\_participants: 会話に参加しているユーザー数。 * conversation\_summary.num\_incidents: インシデントの総数。 * conversation\_summary.conversation\_mood: 会話全体の感情傾向。 * conversation\_summary.incident\_types\_detected: 会話全体で見つかったインシデント種別の一覧。 * conversation\_summary.incidents\_by\_severity: 深刻度ごとにグループ化したインシデントの内訳。 * **recommendations**: その `user_id` * recommendations.\.action: 推奨されるモデレーション処置（例: mute）。 * recommendations.\.trigger\_message: 推奨のトリガーとなった問題のあるメッセージ。 * recommendations.\.trigger\_time: トリガーとなったメッセージのタイムスタンプ。 * recommendations.\.duration: 処置を有効にしておく時間（秒）。 サンプル出力: ```json { "message_details": { "message_id": "20220602164902.482311-946bb8a9-0766-4c31-995a-d910da8531e5", "original_message": "あちこちでクソ野郎ども", "flag": true, "severity": "medium", "filtered_message": "***** ***** あちこち", "replaced_message": "ちょっと……楽しく遊ぶはずじゃなかったの？", "recommended_message": "", "language": "english", "violence": false, "verbal_abuse": true, "profanity": true, "sexual_content": false, "identity_hate": true, "drugs": false, "self_harm": false, "custom": false, "スパム": false, "リンク": false, "PII": false, "勧誘": false, "詐欺": false, "未成年の安全性": false, "年齢に関する懸念": false }, "player_details": { "user_id": "user989", "username": "nlxdz", "メッセージ数": 11, "インシデント数": 6, "累積ムード": 0.748, "最小ムード": 0.0, "最大ムード": 0.8615, "検出されたインシデントの種類": [ "口汚い暴言", "罵り言葉", "アイデンティティに対する憎悪表現" ], "深刻度別インシデント数": { "高": 2, "中": 3, "低": 1 }, "評判スコア": 245, "言語": [ "english" ], "ユーザー状態": { "状態": "ミュート中", "有効期限": "2022-06-03 16:49:00" } }, "会話要約": { "開始時刻": "2022-05-27 16:53:03", "セッション時間": 59, "メッセージ数": 46, "参加者数": 3, "インシデント数": 16, "会話のムード": 0.9816, "検出されたインシデントの種類": [ "口汚い暴言", "罵り言葉", "アイデンティティに対する憎悪表現", "性的嫌がらせ" ], "深刻度別インシデント数": { "高": 4, "中": 6, "低": 6 } }, "推奨事項": { "user989": [ { "アクション": "ミュート", "トリガーとなったメッセージ": "バカなホモ野郎", "トリガー時刻": "2022-06-02 16:49:00", "期間": 86400 } ] } } ``` * 400 * 無効または不正なリクエストです。考えられる原因: * 無効な JSON 入力 * 無効なヘッダー。メタデータが 5 KB を超えている、または許可されていないキーが含まれています * 無効 `x-api-config`、または許可されていないキーを含むもの * 必須フィールドがありません: `user_id`, `session_id`, `message` * 入力形式が無効です: タイムスタンプ形式が無効、メッセージ文字数制限超過など。 * 403 * 無効または不足している API キー * 500 * 内部サーバーエラー