GET (/users/xuid({xuid})/inbox)

指定された数のユーザー メッセージ概要をサービスから取得します。 これらの URI のドメインは msg.xboxlive.com です。

• 解説
• URI パラメーター
• クエリ文字列パラメーター
• Authorization
• プライバシー設定がリソースに与える影響
• HTTP ステータス コード
• JavaScript Object Notation (JSON) 応答

解説

ユーザー メッセージ概要にはメッセージの件名のみが含まれます。 ユーザー生成メッセージの場合、これは現時点で、メッセージ テキストの最初の 20 文字です。 システム メッセージは "LIVE System" のような代替の件名を提供する場合があります。

メッセージは送信されたときと逆の順序で返されます。つまり、新しいほうのメッセージが最初に返されます。

この API がサポートする唯一のコンテンツ タイプは "application/json" で、これは各呼び出しの HTTP ヘッダーに必須です。

URI パラメーター

クエリ文字列パラメーター

Authorization

ユーザー メッセージ概要を取得するには、独自のユーザー クレームを用意する必要があります。

プライバシー設定がリソースに与える影響

独自のユーザー メッセージの列挙のみが可能です。

HTTP ステータス コード

サービスは、このリソースに対してこのメソッドで実行された要求に応答して、このセクションのステータス コードのいずれかを返します。 Xbox Live サービスで使用される標準 HTTP ステータス コードの一覧については、「標準 HTTP ステータス コード」を参照してください。

JavaScript Object Notation (JSON) 応答

呼び出しが成功した場合、サービスは JSON 形式の結果データを返します。

メッセージ

ヘッダー

ページ情報

サンプル応答

{
          "results":
          [
            {
              "header":
              {
                "expiration":"2011-10-11T23:59:59.9999999",
                "id":"opaqueBlobOfText",
                "messageType":"User",
                "isRead":false,
                "senderXuid":"123456789",
                "sender":"Striker",
                "sent":"2011-05-08T17:30:00Z",
                "hasAudio":false,
                "hasPhoto":false,
                "hasText":true
              },
            "messageSummary":"first 20 chars"
          },
          ...
        ],
        "pagingInfo":
          {
          "continuationToken":"opaqueBlobOfText"
          "totalItems":5,
          }
        }

エラー応答

エラーが発生した場合、サービスは errorResponse オブジェクトを返すことがあります。このオブジェクトには、サービスの環境からの値が含まれる場合があります。

関連項目

親

/users/xuid({xuid})/inbox

リファレンス 標準 HTTP ステータス コード