초대 보내기

Xbox Live 사용자에게 초대를 보냅니다.

이 API를 사용하면 게임 클라이언트가 특정 타이틀에 대해 Xbox Live 사용자에게 초대를 보낼 수 있습니다. 초대는 플랫폼에 관계없이 등록된 모든 엔드포인트로 전송됩니다.

POST /titles/{titleId}/invites

URI 매개 변수

매개 변수	그런 다음	필수	유형	설명
titleId	path	TRUE	정수	요청이 전송되는 게임의 titleId입니다.

이름	필수	유형	설명
Authorization	TRUE	정수	호출자는 XBL 3.0 인증 형식으로 XToken을 제공해야 합니다. 예를 들어 권한 부여: XBL3.0 x=2553948354698;>암호화된 토큰<)
콘텐츠 종류	TRUE	문자열	ContentType을 application/json으로 설정해야 합니다.

이름	필수	유형	설명
invitedUsers	TRUE	string[]	초대를 보내는 사용자의 XUID입니다. XUID는 밑이 10인 정수로 표시됩니다. 최대 16개의 XUID입니다.
connectionString		문자열	연결 문자열은 초대가 사용자에게 도달하면 게임에 전달됩니다. 연결 문자열에는 일반적으로 초대된 사용자가 참가할 수 있도록 서버 IP와 같은 정보가 포함됩니다. 연결 문자열 필드가 비어 있으면 빈 연결 문자열을 사용하여 제목이 호출됩니다. 연결 문자열의 길이는 512자로 제한됩니다.
플랫폼		플랫폼

이름	유형	설명
204 콘텐츠 없음
초대를 보냈습니다.
400 잘못된 요청	ErrorResponse	요청을 처리하는 동안 오류가 발생했습니다. 가능한 오류 코드: " RequestValidationError: 요청 유효성 검사에 실패했습니다.", " AuthorizationError: 호출자가 리소스에 액세스할 수 없습니다. 요청이 너무 많습니다. “
기타 상태 코드	ThrottledEntity	요청이 너무 많습니다. 헤더 Retry-After: 정수

이름	유형	설명
디버그 메시지	문자열	디버깅에 사용할 수 있는 오류 메시지의 사람이 읽을 수 있는 버전입니다.
errorCode	문자열	오류 코드 열거형.

요청에서 플랫폼이 설정되지 않은 경우 초대를 통해 수신자가 게임을 플레이할 수 있는 모든 플랫폼에서 참가할 수 있습니다. 그렇지 않으면 나열된 플랫폼만 포함됩니다.

참고: 이에 대한 예외는 Scarlett이 플랫폼으로 구성되지 않은 경우 XboxOne을 지정하는 초대가 Scarlett 장치로도 전송된다는 것입니다.

이름	유형	설명
connectionString	문자열	연결 문자열은 초대가 사용자에게 도달하면 게임에 전달됩니다. 연결 문자열에는 일반적으로 초대된 사용자가 참가할 수 있도록 서버 IP와 같은 정보가 포함됩니다. 연결 문자열 필드가 비어 있으면 빈 연결 문자열을 사용하여 제목이 호출됩니다. 연결 문자열의 길이는 512자로 제한됩니다.
invitedUsers	string[]	초대를 보내는 사용자의 XUID입니다. XUID는 밑이 10인 정수로 표시됩니다. 최대 16개의 XUID입니다.
플랫폼	플랫폼

이름	유형	설명
currentRequests	문자열	현재 요청 수 - 동시성 또는 속도입니다.
디버그 메시지	문자열	디버깅에 사용할 수 있는 스로틀 메시지의 사람이 읽을 수 있는 버전입니다.
제한 유형	문자열	제한 유형, 즉 동시성 또는 비율입니다.
maxRequests	문자열	허용되는 최대 요청 수 - 동시성 또는 속도.
periodInSeconds	문자열	속도 또는 동시성 제한이 초과될 때 적용되는 기간(초)입니다.
version	문자열	현재 스로틀 계약 버전입니다.