GET (/users/xuid({xuid})/inbox/{messageId})
特定のユーザー メッセージの詳細なメッセージ テキストを取得し、サービスで読み取り済みとマーキングします。
これらの URI のドメインは msg.xboxlive.com です。
- 解説
- URI パラメーター
- Authorization
- リクエストの本文
- プライバシー設定がリソースに与える影響
- HTTP ステータス コード
- JavaScript Object Notation (JSON) 応答
解説
取得操作は、User、System、および FriendRequest のメッセージ タイプに対してのみ実行できます。
この URI は、Xbox.com での更新が必要です。 現時点では、ユーザーがサインアウトしてサインインするまで、Xbox 360 は読み取り済み/未読み取りの状態を更新しません。
この API がサポートする唯一のコンテンツ タイプは "application/json" で、これは各呼び出しの HTTP ヘッダーに必須です。
URI パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| xuid | 符号なし 64 ビット整数 | 要求を行っているプレイヤーの Xbox ユーザー ID (XUID)。 |
| messageId | 文字列 [50] | 取得または削除するメッセージの ID です。 |
Authorization
ユーザー メッセージを取得するには、独自のユーザー クレームを用意する必要があります。
リクエストの本文
この要求の本体で送信されるオブジェクトはありません。
プライバシー設定がリソースに与える影響
独自のユーザー メッセージの取得のみが可能です。
HTTP ステータス コード
サービスは、このリソースに対してこのメソッドで実行された要求に応答して、このセクションのステータス コードのいずれかを返します。 Xbox Live サービスで使用される標準 HTTP ステータス コードの一覧については、「標準 HTTP ステータス コード」を参照してください。
| コード | 説明 |
|---|---|
| 200 | 成功です。 |
| 400 | XUID を適切に変換できません。 |
| 403 | XUID を変換できないか、有効な XUID クレームが見つかりません。 |
| 404 | 有効な XUID が見つかりません。または、メッセージ ID が見つからないか、正しく解析されません。 |
| 500 | 一般的なサーバー側のエラー、またはメッセージ タイプが GET に対して有効ではありません。 |
JavaScript Object Notation (JSON) 応答
呼び出しが成功した場合、サービスは JSON 形式の結果データを返します。 ルート オブジェクトは UserMessageHeader オブジェクトです。
UserMessageHeader
| プロパティ | 種類 | 最大の長さ | 解説 |
|---|---|---|---|
| header | ヘッダー | JSON オブジェクト | |
| messageText | 文字列 | 256 | UTF-8 |
ヘッダー
| プロパティ | 種類 | 最大の長さ | 解説 |
|---|---|---|---|
| sent | DateTime | メッセージが送信された日付と時刻。 (サービスによって提供されます。) | |
| expiration | DateTime | メッセージの有効期限が切れる日付と時刻。 (すべてのメッセージには、将来決定される最長有効期間があります。) | |
| messageType | 文字列 | 13 | メッセージ タイプ: User、System、FriendRequest。 |
| senderXuid | ulong | 送信者の XUID。 | |
| sender | 文字列 | 15 | 送信者のゲーマータグ。 |
| hasAudio | bool | メッセージにオーディオ (ボイス) の添付ファイルがあるかどうか。 | |
| hasPhoto | bool | メッセージに写真の添付ファイルがあるかどうか。 | |
| hasText | bool | メッセージにテキストが含まれるかどうか。 |
サンプル応答
{
"header":
{
"expiration":"2011-10-11T23:59:59.9999999",
"messageType":"User",
"senderXuid":"123456789",
"sender":"Striker",
"sent":"2011-05-08T17:30:00Z",
"hasAudio":false,
"hasPhoto":false,
"hasText":true
},
"messageText":"random user text up to 256 characters"
}
エラー応答
エラーが発生した場合、サービスは errorResponse オブジェクトを返すことがあります。このオブジェクトには、サービスの環境からの値が含まれる場合があります。
| プロパティ | 種類 | 説明 |
|---|---|---|
| errorSource | 文字列 | エラーが発生した場所を示します。 |
| errorCode | int | エラーと関連付けられた数値のコード (null でもかまいません)。 |
| errorMessage | 文字列 | 詳細を示すように構成されている場合のエラーの詳細。 |