> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

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

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

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

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

* [解説](#ID4EV)
* [URI パラメーター](#ID4EEB)
* [クエリ文字列パラメーター](#ID4EIC)
* [認可](#ID4EGE)
* [プライバシー設定がリソースに与える影響](#ID4ETE)
* [HTTP 状態コード](#ID4E5E)
* [JavaScript Object Notation (JSON) 応答](#ID4EMH)

## 解説

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

メッセージは送信された順序の逆順で返されます。つまり、より新しいメッセージが先に返されます。

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

## URI パラメーター

| パラメーター | 型 | 説明 |
| - | - | - |
| xuid | 符号なし 64 ビット整数 | 要求を行うプレイヤーの XBOX ユーザー ID (XUID)。 |

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

\| プロパティ | 型 | 最大長 | 解説 |
\| --- | --- | --- | --- | --- | --- | --- |
\| maxItems | int | 100 | 返されるメッセージの最大数。 |
\| continuationToken | string |  | 前の列挙呼び出しで返された文字列。列挙を継続するために使用されます。 |
\| skipItems | int | 100 | スキップするメッセージ数。continuationToken が存在する場合は無視されます。 |

## 認可

ユーザー メッセージのサマリを取得するには、独自のユーザー クレームが必要です。

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

自分のユーザー メッセージを列挙できるのは自分だけです。

## HTTP 状態コード

サービスは、このリソースに対してこのメソッドを使用して行われた要求への応答として、このセクションのいずれかの状態コードを返します。XBOX Live サービスで使用される標準 HTTP 状態コードの完全な一覧については、「[標準 HTTP 状態コード](https://docs.xbox.com/ja-jp/reference/live/rest/additional/httpstatuscodes.md)」を参照してください。

\| コード | 説明 |
\| --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| 200 | 要求は成功しました。 |
\| 400 | サービスは正しくない形式の要求を解釈できませんでした。通常は無効なパラメーターです。 |
\| 403 | 要求はユーザーまたはサービスに対して許可されていません。 |
\| 404 | URI に有効な XUID がありません。 |
\| 409 | 渡された継続トークンに基づく基礎となるコレクションが変更されました。 |
\| 416 | スキップする項目の数が、使用可能な項目の数より大きくなっています。 |
\| 500 | 一般的なサーバー側のエラーです。 |

## JavaScript Object Notation (JSON) 応答

正常に呼び出された場合、サービスは結果データを JSON 形式で返します。

| プロパティ | 型 | 最大長 | 解説 |
| - | - | - | - |
| results | Message\[] | 100 | ユーザー メッセージの配列 |
| pagingInfo | PagingInfo | | 現在の結果セットのページング情報 |

#### Message

| プロパティ | 型 | 最大長 | 解説 |
| - | - | - | - |
| header | Header | | ユーザー メッセージ ヘッダー |
| messageSummary | string | 20 | UTF-8。通常はメッセージの最初の 20 文字 |

#### Header

| プロパティ | 型 | 最大長 | 解説 |
| - | - | - | - |
| id | string | 50 | メッセージ識別子。メッセージ詳細の取得やメッセージの削除に使用されます。 |
| isRead | bool | | ユーザーが既にメッセージの詳細を読んだことを示すフラグ。 |
| sent | DateTime | | メッセージが送信された UTC 日時。(サービスによって提供されます。) |
| expiration | DateTime | | メッセージの有効期限が切れる UTC 日時。(すべてのメッセージには最大存続期間があり、将来決定されます。) |
| messageType | string | 50 | メッセージの種類: User、System、FriendRequest、Video、QuickChat、VideoChat、PartyChat、Title、GameInvite。 |
| senderXuid | ulong | | 送信者の XUID。 |
| sender | string | 15 | 送信者のゲーマータグ。 |
| hasAudio | bool | | メッセージにオーディオ (音声) の添付ファイルがあるかどうか。 |
| hasPhoto | bool | | メッセージに写真の添付ファイルがあるかどうか。 |
| hasText | bool | | メッセージにテキストが含まれているかどうか。 |

#### Paging Info

| プロパティ | 型 | 最大長 | 解説 |
| - | - | - | - |
| continuationToken | string | 100 | サーバーによって省略可能で返されます。以降の呼び出しで列挙を継続できます。 |
| totalItems | int | | 受信トレイ内のメッセージの合計数。 |

#### 応答例

```cpp theme={null}
{
          "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 オブジェクトを返すことがあります。

\| プロパティ | 型 | 説明 |
\| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| errorSource | string | エラーの発生元を示します。 |
\| errorCode | int | エラーに関連付けられた数値コード (null の場合があります)。 |
\| errorMessage | string | 詳細を表示するように構成されている場合のエラーの詳細。 |

## 関連項目

##### 親

[/users/xuid({xuid})/inbox](https://docs.xbox.com/ja-jp/reference/live/rest/uri/users/uri-usersxuidinbox.md)

##### リファレンス  [標準 HTTP 状態コード](https://docs.xbox.com/ja-jp/reference/live/rest/additional/httpstatuscodes.md)


## Related topics

- [GET (/users/xuid({xuid})/inbox/{messageId})](https://docs.xbox.com/ja-jp/reference/live/rest/uri/users/uri-usersxuidinboxmessageidget.md)
- [/users/xuid({xuid})/inbox](https://docs.xbox.com/ja-jp/reference/live/rest/uri/users/uri-usersxuidinbox.md)
- [DELETE (/users/xuid({xuid})/inbox/{messageId})](https://docs.xbox.com/ja-jp/reference/live/rest/uri/users/uri-usersxuidinboxmessageiddelete.md)
- [/users/xuid({xuid})](https://docs.xbox.com/ja-jp/reference/live/rest/uri/presence/uri-usersxuid.md)
- [GET (/users/xuid({xuid}))](https://docs.xbox.com/ja-jp/reference/live/rest/uri/presence/uri-usersxuidget.md)