다음을 통해 공유

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

  • 아티클

서비스에서 지정된 수의 사용자 메시지 요약을 검색합니다. 이 URI의 도메인은 msg.xboxlive.com입니다.

설명

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

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

이 API가 지원하는 유일한 콘텐츠 유형은 각 호출의 HTTP 헤더에 필요한 "application/json"입니다.

URI 매개 변수

매개 변수 형식 설명
xuid 부호 없는 64비트 정수 요청하는 플레이어의 Xbox 사용자 ID(XUID)입니다.

쿼리 문자열 매개 변수

속성 유형 최대 길이 비고
maxItems 정수 100 반환된 최대 메시지 수.
continuationToken 문자열 이전 열거형 호출에서 반환된 문자열. 열거를 계속하는 데 사용됩니다.
skipItems 정수 100 건너뛸 메시지 수. continuationToken이 있는 경우 무시됩니다.

권한 부여

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

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

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

HTTP 상태 코드

서비스는 이 리소스에서 이 메서드를 통해 수행한 요청에 대한 응답으로 이 섹션의 상태 코드 중 하나를 반환합니다. Xbox Live 서비스에서 사용되는 표준 HTTP 상태 코드의 전체 목록은 표준 HTTP 상태 코드를 참조하세요.

코드 설명
200 요청에 성공했습니다.
400 서비스가 형식이 잘못된 요청을 이해할 수 없습니다. 일반적으로 잘못된 매개 변수입니다.
403 사용자 또는 서비스에 대해 요청이 허용되지 않습니다.
404 유효한 XUID가 URI에 없습니다.
409 기본 컬렉션이 전달된 연속 토큰에 따라 변경되었습니다.
416 건너뛸 항목 수가 사용 가능한 항목 수보다 큽니다.
500 일반적인 서버 측 오류.

JSON(JavaScript Object Notation) 응답

성공적으로 호출되면 서비스는 결과 데이터를 JSON 형식으로 반환합니다.

속성 유형 최대 길이 비고
results Message[] 100 사용자 메시지의 배열
pagingInfo PagingInfo 현재 결과 집합에 대한 페이징 정보

메시지

속성 유형 최대 길이 비고
헤더 헤더 사용자 메시지 헤더
messageSummary 문자열 20 UTF-8, 일반적으로 메시지의 처음 20자
속성 유형 최대 길이 비고
id 문자열 50 메시지 세부 정보를 검색하거나 메시지를 삭제하는 데 사용되는 메시지 식별자입니다.
isRead 부울 사용자가 이미 메시지 세부 정보를 읽었음을 나타내는 플래그입니다.
sent DateTime 메시지를 보낸 UTC 날짜 및 시간입니다. (서비스에서 제공됨)
expiration DateTime 메시지가 만료되는 UTC 날짜 및 시간입니다. (모든 메시지는 향후 결정될 최대 수명을 가짐)
messageType 문자열 50 메시지 유형: 사용자, 시스템, FriendRequest, 비디오, QuickChat, VideoChat, PartyChat, 타이틀, GameInvite.
senderXuid ulong 보낸 사람의 XUID.
sender 문자열 15 보낸 사람의 게이머태그.
hasAudio 부울 메시지에 오디오(음성) 첨부 파일이 있는지 여부입니다.
hasPhoto 부울 메시지에 사진 첨부 파일이 있는지 여부입니다.
hasText 부울 메시지에 텍스트가 포함되는지 여부입니다.

페이징 정보

속성 유형 최대 길이 비고
continuationToken 문자열 100 서버에서 선택적으로 반환됩니다. 나중에 호출하여 열거를 계속할 수 있습니다.
totalItems 정수 받은 편지함의 총 메시지 수입니다.

샘플 응답

{
          "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 문자열 오류의 출처를 나타냅니다.
errorCode 정수 오류와 관련이 있는 숫자 코드(null일 수 있음).
errorMessage 문자열 세부 정보를 표시하도록 구성된 경우 오류에 대한 세부 정보입니다.

참고 항목

부모

/users/xuid({xuid})/inbox

표준 HTTP 상태 코드 참조