> ## 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/{messageId})

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

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

擷取特定使用者訊息的詳細訊息文字，並在服務上將其標示為已讀取。
這些 URI 的網域為 `msg.xboxlive.com`。

* [備註](#ID4EV)
* [URI 參數](#ID4EEB)
* [授權](#ID4ERB)
* [要求本文](#ID4E3B)
* [隱私權設定對資源的影響](#ID4EJC)
* [HTTP 狀態碼](#ID4EUC)
* [JavaScript 物件標記法 (JSON) 回應](#ID4EUE)

<a id="ID4EV" />

## 備註

取得作業只能在 User、System 和 FriendRequest 訊息類型上執行。

此 URI 需要在 Xbox.com 上重新整理。目前，XBOX 360 在使用者登出並重新登入之前，不會更新已讀取/未讀取狀態。

此 API 唯一支援的內容類型為 "application/json"，每次呼叫的 HTTP 標頭中都必須包含此內容類型。

<a id="ID4EEB" />

## URI 參數

| 參數 | 類型 | 描述 |
| - | - | - |
| xuid | 不帶正負號的 64 位元整數 | 提出要求之玩家的 XBOX 使用者識別碼 (XUID)。 |
| messageId | string\[50] | 要擷取或刪除之訊息的識別碼。 |

<a id="ID4ERB" />

## 授權

您必須擁有自己的使用者宣告，才能擷取使用者訊息。

<a id="ID4E3B" />

## 要求本文

此要求的本文中不會傳送任何物件。

<a id="ID4EJC" />

## 隱私權設定對資源的影響

只有您可以擷取您自己的使用者訊息。

<a id="ID4EUC" />

## HTTP 狀態碼

服務會傳回本節中的其中一個狀態碼，以回應在此資源上使用此方法所提出的要求。如需搭配 XBOX Live 服務使用的標準 HTTP 狀態碼完整清單，請參閱[標準 HTTP 狀態碼](/zh-TW/reference/live/rest/additional/httpstatuscodes)。

\| 代碼| 描述|
\| --- | --- | --- | --- | --- |
\| 200| 成功。|
\| 400| 無法正確轉換 XUID。|
\| 403| 無法轉換 XUID，或找不到有效的 XUID 宣告。|
\| 404| 缺少有效的 XUID，或找不到訊息識別碼或剖析不正確。|
\| 500| 一般伺服器端錯誤，或訊息類型對 GET 無效。|

<a id="ID4EUE" />

## JavaScript 物件標記法 (JSON) 回應

如果呼叫成功，服務會以 JSON 格式傳回結果資料。根物件是 UserMessageHeader 物件。

#### UserMessageHeader

| 屬性 | 類型 | 最大長度 | 備註 |
| - | - | - | - |
| header | Header | | JSON 物件 |
| messageText | string | 256 | UTF-8 |

#### Header

| 屬性 | 類型 | 最大長度 | 備註 |
| - | - | - | - |
| sent | DateTime | | 訊息傳送的日期和時間。(由服務提供。) |
| expiration | DateTime | | 訊息到期的日期和時間。(所有訊息都有最長存留期，將於日後決定。) |
| messageType | string | 13 | 訊息類型：User、System、FriendRequest。 |
| senderXuid | ulong | | 傳送者的 XUID。 |
| sender | string | 15 | 傳送者的玩家代號。 |
| hasAudio | bool | | 訊息是否有音訊 (語音) 附件。 |
| hasPhoto | bool | | 訊息是否有相片附件。 |
| hasText | bool | | 訊息是否包含文字。 |

#### 範例回應

```cpp theme={null}
{
          "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| string| 錯誤來源的指示。|
\| errorCode| int| 與錯誤相關聯的數值代碼 (可以是 null)。|
\| errorMessage| string| 如果設定為顯示詳細資料，則為錯誤的詳細資料。|

<a id="ID4E3DAC" />

## 另請參閱

<a id="ID4E5DAC" />

##### 上層

[/users/xuid({xuid})/inbox](/zh-TW/reference/live/rest/uri/users/uri-usersxuidinbox)

<a id="ID4EMEAC" />

##### 參考  [標準 HTTP 狀態碼](/zh-TW/reference/live/rest/additional/httpstatuscodes)


## Related topics

- [XblAchievementsGetAchievementsForTitleIdAsync](/reference/live/xsapi-c/achievements_c/functions/xblachievementsgetachievementsfortitleidasync.md)
- [XblUserStatisticsGetSingleUserStatisticAsync](/ko/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetsingleuserstatisticasync.md)