> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.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 物件標記法 (JSON) 回應](#ID4EMH)
## 備註
使用者訊息摘要只包含訊息主旨。對於使用者產生的訊息，目前這是訊息文字的前 20 個字元。系統訊息可能會提供替代主旨，例如 "LIVE System"。
訊息會以傳送順序的相反順序傳回；也就是說，較新的訊息會先傳回。
此 API 唯一支援的內容類型為 "application/json"，每次呼叫的 HTTP 標頭中都必須包含此內容類型。
## URI 參數
| 參數 | 類型 | 描述 |
| - | - | - |
| xuid | 不帶正負號的 64 位元整數 | 提出要求之玩家的 XBOX 使用者識別碼 (XUID)。 |
## 查詢字串參數
\| 屬性| 類型| 最大長度| 備註|
\| --- | --- | --- | --- | --- | --- | --- |
\| maxItems| int| 100| 傳回的訊息數目上限。|
\| continuationToken| string| | 先前列舉呼叫中傳回的字串；用來繼續列舉。|
\| skipItems| int| 100| 要略過的訊息數目；如果有 continuationToken 則會忽略。|
## 授權
您必須擁有自己的使用者宣告，才能擷取使用者訊息摘要。
## 隱私權設定對資源的影響
只有您可以列舉您自己的使用者訊息。
## HTTP 狀態碼
服務會傳回本節中的其中一個狀態碼，以回應在此資源上使用此方法所提出的要求。如需搭配 XBOX Live 服務使用的標準 HTTP 狀態碼完整清單，請參閱[標準 HTTP 狀態碼](/zh-TW/reference/live/rest/additional/httpstatuscodes)。
\| 代碼| 描述|
\| --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| 200| 要求成功。|
\| 400| 服務無法理解格式錯誤的要求。通常是參數無效。|
\| 403| 使用者或服務不允許此要求。|
\| 404| URI 中缺少有效的 XUID。|
\| 409| 根據傳入的接續權杖，基礎集合已變更。|
\| 416| 要略過的項目數目大於可用項目的數目。|
\| 500| 一般伺服器端錯誤。|
## JavaScript 物件標記法 (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 | | 訊息是否包含文字。 |
#### 分頁資訊
| 屬性 | 類型 | 最大長度 | 備註 |
| - | - | - | - |
| 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](/zh-TW/reference/live/rest/uri/users/uri-usersxuidinbox)
##### 參考 [標準 HTTP 狀態碼](/zh-TW/reference/live/rest/additional/httpstatuscodes)
## Related topics
- [XblUserStatisticsGetSingleUserStatisticAsync](/zh-TW/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetsingleuserstatisticasync.md)
- [XblUserStatisticsGetSingleUserStatisticsAsync](/zh-TW/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetsingleuserstatisticsasync.md)