POST(/users/batch)

아티클
05/10/2023

사용자 배치의 프레즌스를 가져옵니다. 이 URI의 도메인은 userpresence.xboxlive.com입니다.

비고
Authorization
리소스에 대한 개인 정보 설정의 영향
필수 요청 헤더
선택적 요청 헤더
요청 본문
응답 본문

설명

이 메서드는 배치 사용자에 대한 현재 상태 정보를 알아보려는 모든 클라이언트, 서비스 또는 타이틀에 의해 사용되어야 합니다.

이 배치 요청에 대한 응답은 심도 및 경로별로 필터링할 수 있습니다. 소비자는 이를 사용하여 사용자에 대한 현재 상태를 확인하고 표시할 수 있습니다. 이 API의 필터는 속성에서 OR로 적용되지만 여러 속성 전반에서는 AND가 적용됩니다.

권한 부여

유형	필수	설명	누락된 경우 응답
XUID	예	호출자의 Xbox 사용자 ID(XUID)	403 Forbidden

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

이 메서드는 항상 200 OK를 반환하지만 응답 본문에서 내용을 반환하지 않을 수 있습니다.

요청 사용자	대상 사용자의 개인 정보 설정	동작
나	-	200 OK
친구	모두	200 OK
친구	친구만	200 OK
친구	차단	200 OK
친구가 아닌 사용자	모두	200 OK
친구가 아닌 사용자	친구만	200 OK
친구가 아닌 사용자	차단	200 OK
타사 사이트	모두	200 OK
타사 사이트	친구만	200 OK
타사 사이트	차단	200 OK

필수 요청 헤더

헤더	형식	설명
Authorization	문자열	HTTP 인증을 위한 인증 자격 증명입니다. 예제 값: "XBL3.0 x=<userhash>;<token>".
x-xbl-contract-version	문자열	이 요청을 연결해야 하는 Xbox LIVE 서비스의 이름/번호를 작성합니다. 헤더의 유효성과 권한 부여 토큰의 클레임 등을 확인한 이후에만 요청이 해당 서비스로 라우팅됩니다. 예제 값: 3, vnext.
수락	문자열	허용 가능한 콘텐츠-유형입니다. 프레즌스가 지원하는 대상은 application/json이지만 헤더에 지정되어야 합니다.
Accept-Language	문자열	응답의 문자열에 사용할 수 있는 로캘입니다. 예제 값: en-US.
Host	문자열	서버의 도메인 이름입니다. 예제 값: presencebeta.xboxlive.com.
Content-Length	문자열	요청 본문의 길이입니다. 예제 값: 312.

선택적 요청 헤더

헤더	형식	설명
X-RequestedServiceVersion		이 요청을 연결해야 하는 Xbox LIVE 서비스의 이름/번호를 작성합니다. 헤더의 유효성과 권한 부여 토큰의 클레임 등을 확인한 이후에만 요청이 해당 서비스로 라우팅됩니다. 기본값: 1.

요청 본문

필수 멤버

멤버	설명
users	프레즌스를 알아보고자 하는 사용자의 XUID 목록으로, 한 번에 최대 1100개의 XUID 표시.

선택적 멤버

멤버	설명
deviceTypes	알아보고자 하는 사용자가 사용하는 장치 유형 목록. 배열이 빈 경우 모든 가능한 장치 유형으로 기본 설정됩니다(필터링되지 않음).
titles	알아보고자 하는 사용자의 장치 유형 목록. 배열이 빈 경우 모든 가능한 타이틀로 기본 설정됩니다(필터링되지 않음).
level	가능한 값: user - 사용자 노드 가져오기 device - 사용자 및 장치 노드 가져오기 title - 기본 타이틀 레벨 정보 가져오기 all - 리치 프레즌스 정보, 미디어 정보 또는 두 가지 모두 가져오기 기본값은 "title"입니다.
onlineOnly	이 속성 true인 경우 배치 작업에서 오프라인 사용자(숨겨진 사용자 포함)에 대한 기록을 필터링합니다. 제공되지 않은 경우 온라인 및 오프라인 사용자가 모두 반환됩니다.

금지된 멤버

요청에서 다른 모든 멤버는 금지됩니다.

샘플 요청

{
  users:
  [
    "1234567890",
    "4567890123",
    "7890123456"
  ]
}

응답 본문

샘플 응답

이 메서드는 PresenceRecord를 반환합니다.

{
  xuid:"0123456789",
  state:"online",
  devices:
  [{
    type:"D",
    titles:
    [{
      id:"12341234",
      name:"Contoso 5",
      state:"active",
      placement:"fill",
      timestamp:"2012-09-17T07:15:23.4930000",
      activity:
      {
        richPresence:"Team Deathmatch on Nirvana"
      }
    },
    {
      id:"12341235",
      name:"Contoso Waypoint",
      timestamp:"2012-09-17T07:15:23.4930000",
      placement:"snapped",
      state:"active",
      activity:
      {
        richPresence:"Using radar"
      }
    }]
  },
  {
    type:W8,
    titles:
    [{
      id:"23452345",
      name:"Contoso Gamehelp",
      state:"active",
      placement:"full",
      timestamp:"2012-09-17T07:15:23.4930000",
      activity:
      {
        richPresence:"Nirvana page",
      }
    }]
  }]
}

참고 항목

부모

/users/batch

다음을 통해 공유