> ## 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 Object Notation(JSON) 응답](#ID4EMH)

## 설명

사용자 메시지 요약에는 메시지 제목만 포함됩니다. 사용자가 생성한 메시지의 경우, 현재 메시지 텍스트의 처음 20자입니다. 시스템 메시지는 “LIVE System”과 같은 대체 제목을 제공할 수 있습니다.

메시지는 전송된 순서의 반대 순서로 반환됩니다. 즉, 새 메시지가 먼저 반환됩니다.

이 API가 지원하는 유일한 콘텐츠 형식은 “application/json”이며, 모든 호출의 HTTP 헤더에서 필수입니다.

## URI 매개 변수

| 매개 변수 | 형식 | 설명 |
| - | - | - |
| xuid | unsigned 64-bit integer | 요청을 수행하는 플레이어의 XBOX User ID(XUID)입니다. |

## 쿼리 문자열 매개 변수

\| 속성| 형식| 최대 길이| 설명|
\| --- | --- | --- | --- | --- | --- | --- |
\| maxItems| int| 100| 반환되는 최대 메시지 수입니다.|
\| continuationToken| string|  | 이전 열거 호출에서 반환된 문자열로, 열거를 계속하는 데 사용됩니다.|
\| skipItems| int| 100| 건너뛸 메시지 수입니다. continuationToken이 있는 경우 무시됩니다.|

## 권한 부여

사용자 메시지 요약을 검색하려면 자신의 사용자 클레임이 있어야 합니다.

## 리소스에 대한 개인 정보 설정의 영향

자신의 사용자 메시지만 열거할 수 있습니다.

## HTTP 상태 코드

이 리소스에서 이 메서드로 수행한 요청에 대한 응답으로 서비스는 이 섹션의 상태 코드 중 하나를 반환합니다. XBOX Live Services에서 사용되는 표준 HTTP 상태 코드의 전체 목록은 [Standard HTTP status codes](https://devdocs.xbox.com/ko/reference/live/rest/additional/httpstatuscodes)를 참고하십시오.

\| 코드| 설명|
\| --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| 200| 요청이 성공했습니다.|
\| 400| 서비스가 잘못된 형식의 요청을 이해할 수 없습니다. 일반적으로 잘못된 매개 변수입니다.|
\| 403| 사용자 또는 서비스에 대해 요청이 허용되지 않습니다.|
\| 404| URI에 유효한 XUID가 없습니다.|
\| 409| 전달된 continuation token을 기준으로 기본 컬렉션이 변경되었습니다.|
\| 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://devdocs.xbox.com/ko/reference/live/rest/uri/users/uri-usersxuidinbox)

##### 참조  [Standard HTTP status codes](https://devdocs.xbox.com/ko/reference/live/rest/additional/httpstatuscodes)


## Related topics

- [XblUserStatisticsGetSingleUserStatisticAsync](https://devdocs.xbox.com/ja-jp/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetsingleuserstatisticasync.md)
- [XblUserStatisticsGetSingleUserStatisticsAsync](https://devdocs.xbox.com/ja-jp/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetsingleuserstatisticsasync.md)
