DELETE (/users/xuid({xuid})/inbox/{messageId})
ユーザーの受信トレイのユーザー メッセージを削除します。
これらの URI のドメインは msg.xboxlive.com です。
- 解説
- URI パラメーター
- Authorization
- リクエストの本文
- HTTP ステータス コード
- JavaScript Object Notation (JSON) 応答
- プライバシー設定がリソースに与える影響
解説
削除操作はべき等です。
この API がサポートする唯一のコンテンツ タイプは "application/json" で、これは各呼び出しの HTTP ヘッダーに必須です。
URI パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| xuid | 符号なし 64 ビット整数 | 要求を行っているプレイヤーの Xbox ユーザー ID (XUID)。 |
| messageId | 文字列 [50] | 取得または削除するメッセージの ID です。 |
Authorization
ユーザー メッセージを削除するには、独自のユーザー クレームを用意する必要があります。
リクエストの本文
この要求の本体で送信されるオブジェクトはありません。
HTTP ステータス コード
サービスは、このリソースに対してこのメソッドで実行された要求に応答して、このセクションのステータス コードのいずれかを返します。 Xbox Live サービスで使用される標準 HTTP ステータス コードの一覧については、「標準 HTTP ステータス コード」を参照してください。
| コード | 説明 |
|---|---|
| 204 | 成功です。 |
| 403 | XUID を変換できないか、有効な XUID クレームが見つかりません。 |
| 404 | URI 内のメッセージ ID を解析できないか、URI に XUID がありません。 |
| 500 | 一般的なサーバー側のエラーです。 |
JavaScript Object Notation (JSON) 応答
エラーが発生した場合、サービスは errorResponse オブジェクトを返すことがあります。このオブジェクトには、サービスの環境からの値が含まれる場合があります。
| プロパティ | 種類 | 説明 |
|---|---|---|
| errorSource | 文字列 | エラーが発生した場所を示します。 |
| errorCode | int | エラーと関連付けられた数値のコード (null でもかまいません)。 |
| errorMessage | 文字列 | 詳細を示すように構成されている場合のエラーの詳細。 |
プライバシー設定がリソースに与える影響
独自のユーザー メッセージの削除のみが可能です。