API ドキュメントの更新: チャット API ガイドの更新¶
APIの分類を変更し、いくつかのフィールド情報を修正しました。
http APIの更新¶
- メッセージAPIの分類を追加- API分類を変更- 既存: チャンネルAPI > お知らせメッセージ送信API
- 変更: メッセージAPI > チャンネルお知らせメッセージ送信API
 
- ユーザーお知らせメッセージAPIを追加
- チャンネルカスタムメッセージAPIを追加
- ユーザーカスタムメッセージAPIを追加
- チャンネルメッセージ履歴取得APIを追加
 
- API分類を変更
- 詳細なエラーコードを追加- HTTPステータスコード400のために新しいコードを追加- 400 カスタムメッセージサイズを超えました。最大サイズは8,000バイトです。: カスタムメッセージサイズを超えました(最大8,000バイト)
 
 
- HTTPステータスコード400のために新しいコードを追加
- 応答値からextraDataを削除- チャンネル取得API (response > data > members)
- チャンネル参加者取得API (response > data > members)
 
- chatHistoryAllowedメッセージ履歴取得の可用性を追加- 全チャンネルリストを取得するための応答値
- チャンネル取得のための応答値
- チャンネル作成のためのリクエスト値
- ユーザー参加チャンネルを取得するための応答値
 
- タイポを修正し、説明を変更- 全チャンネルリストを取得- クエリパラメータsizeフィールドの説明を変更- 既存: 最小10 ~ 最大100
- 変更: 最小1 ~ 最大10
 
 
- クエリパラメータ
- timestampMillisの時間タイプを変更- 整数 → 長整数
 
- チャンネルエントリー- リクエスト例を変更
 
- チャンネルメッセージ履歴取得- APIエンドポイントを変更
- パスパラメータからContent-Typeを削除
 
- チャンネル作成- リクエストデータにplayerIdが存在する場合のアクションに関するガイダンスを変更
 
- リクエストデータに
- チャンネル退出- 参加者のいないチャンネルで、チャンネルオーナーがSYSTEMでない場合、定期的に削除されることを説明を追加
 
- 参加者のいないチャンネルで、チャンネルオーナーが
- ユーザーのブロック- リアルタイムメッセージの送受信を制限する機能であることを説明を追加
 
- チャンネルお知らせメッセージ- リクエストデータにchannelIdとlangCodeが存在する場合のアクションに関するガイダンスを追加
 
- リクエストデータに
- 概要説明を改訂
- 表現を変更- 時間 → 日付
 
- 一部のスペーシングを修正
- 配列の表記を変更- 例: array→object array
 
- 例: 
 
- 全チャンネルリストを取得
websocket APIの変更¶
- パケットタイプ- NOTIFY_NOTICEを追加
 
- クライアント接続- リクエスト例を変更
 
- クライアント再接続- リクエスト例を変更
 
- 通知メッセージ- ユーザー通知メッセージに名前を変更
- 本文のplayerId情報を変更
 
- チャンネル通知メッセージ- 本文のchannelId情報を変更
 
- 本文の
- extraDataデータ送信パケットを変更- リクエスト値からextraDataを削除- CONNECT
- RECONNECT
 
- リクエスト値にextraDataを追加- CHANNEL_CHAT
- DIRECT_CHAT
 
- レスポンス値からextraDataを削除- NOTIFY_ENTER_CHANNEL
- NOTIFY_EXIT_CHANNEL
 
- レスポンスキー値を変更(fromExtra→extraData)- NOTIFY_CHANNEL_CHAT
- NOTIFY_DIRECT_CHAT
 
 
- リクエスト値から
- レスポンス値にtimestampMillisを追加- NOTIFY_ENTER_CHANNEL
- NOTIFY_EXIT_CHANNEL
- NOTIFY_DELETE_CHANNEL
- NOTIFY_CHANNEL_NOTICE
- NOTIFY_CHANNEL_CHAT
- NOTIFY_DIRECT_CHAT
 
- リクエスト値にlangCodeを追加- CONNECT
- RECONNECT
 
- ソケットサーバーイベントメッセージを追加- NOTIFY_NOTICE
 
- 非推奨パケットを削除- NOTIFY_DISCONNECT
 
