GET (/users/xuid({xuid})/inbox/{messageId})
특정 사용자 메시지에 대한 자세한 메시지 텍스트를 검색하여 서비스에서 읽음으로 표시합니다.
이 URI의 도메인은 msg.xboxlive.com
입니다.
- 비고
- URI 매개 변수
- Authorization
- 요청 본문
- 리소스에 대한 개인 정보 설정의 영향
- HTTP 상태 코드
- JSON(JavaScript Object Notation) 응답
설명
get 작업은 사용자, 시스템 및 FriendRequest 메시지 유형에서만 수행할 수 있습니다.
이 URI는 Xbox.com에서 새로 고침해야 합니다. 현재 Xbox 360은 사용자가 서명하고 다시 로그인할 때까지 읽음/읽지 않음 상태를 업데이트하지 않습니다.
이 API가 지원하는 유일한 콘텐츠 유형은 각 호출의 HTTP 헤더에 필요한 "application/json"입니다.
URI 매개 변수
매개 변수 | 형식 | 설명 |
---|---|---|
xuid | 부호 없는 64비트 정수 | 요청하는 플레이어의 Xbox 사용자 ID(XUID)입니다. |
messageId | string[50] | 검색 또는 삭제 중인 메시지의 ID입니다. |
Authorization
사용자 메시지를 검색하려면 사용자 소유의 클레임이 있어야 합니다.
요청 본문
이 요청의 본문에는 개체가 전송되지 않습니다.
리소스에 대한 개인 정보 설정의 영향
자체 사용자 메시지만 검색할 수 있습니다.
HTTP 상태 코드
서비스는 이 리소스에서 이 메서드를 통해 수행한 요청에 대한 응답으로 이 섹션의 상태 코드 중 하나를 반환합니다. Xbox Live 서비스에서 사용되는 표준 HTTP 상태 코드의 전체 목록은 표준 HTTP 상태 코드를 참조하세요.
코드 | 설명 |
---|---|
200 | 성공. |
400 | XUID를 적절하게 변환할 수 없습니다. |
403 | XUID를 변환할 수 없거나 유효한 XUID 클레임을 찾을 수 없습니다. |
404 | 유효한 XUID가 누락되었거나 메시지 ID를 찾을 수 없거나 잘못 구문 분석되었습니다. |
500 | 일반 서버 측 오류이거나 메시지 유형이 GET에 유효하지 않습니다. |
JSON(JavaScript Object Notation) 응답
성공적으로 호출되면 서비스는 결과 데이터를 JSON 형식으로 반환합니다. 루트 개체는 UserMessageHeader 개체입니다.
UserMessageHeader
속성 | 유형 | 최대 길이 | 비고 |
---|---|---|---|
헤더 | 헤더 | JSON 개체 | |
messageText | 문자열 | 256 | UTF-8 |
헤더
속성 | 유형 | 최대 길이 | 비고 |
---|---|---|---|
sent | DateTime | 메시지를 보낸 날짜 및 시간입니다. (서비스에서 제공됨) | |
expiration | DateTime | 메시지가 만료되는 날짜 및 시간입니다. (모든 메시지는 향후 결정될 최대 수명을 가짐) | |
messageType | 문자열 | 13 | 메시지 유형: 사용자, 시스템, FriendRequest. |
senderXuid | ulong | 보낸 사람의 XUID. | |
sender | 문자열 | 15 | 보낸 사람의 게이머태그. |
hasAudio | 부울 | 메시지에 오디오(음성) 첨부 파일이 있는지 여부입니다. | |
hasPhoto | 부울 | 메시지에 사진 첨부 파일이 있는지 여부입니다. | |
hasText | 부울 | 메시지에 텍스트가 포함되는지 여부입니다. |
샘플 응답
{
"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 | 문자열 | 오류의 출처를 나타냅니다. |
errorCode | 정수 | 오류와 관련이 있는 숫자 코드(null일 수 있음). |
errorMessage | 문자열 | 세부 정보를 표시하도록 구성된 경우 오류에 대한 세부 정보입니다. |