傳送伺服器邀請

使用指定的連線字串傳送邀請給 XBOX 使用者。此 API 可讓遊戲伺服器傳送邀請給 XBOX Live 使用者。要求本文包含受邀者用來加入伺服器的連線字串。連線字串可以包含遊戲伺服器 IP，或指向使用者所在工作階段的指標。無論平台為何，邀請都會傳送至所有已註冊的端點。

POST /titles/{titleId}/invites/server

URI 參數

參數	位置	必要	類型	描述
titleId	path	TRUE	integer	傳送要求所針對之遊戲的 titleId。

要求標頭

名稱	必要	類型	描述
Authorization	TRUE	integer	呼叫端必須以 XBL 3.0 授權格式提供 XToken。例如，Authorization: XBL3.0 x=2553948354698;>encrypted token<)
Content-Type	TRUE	string	ContentType 必須設定為 application/json

要求本文

名稱	必要	類型	描述
invitedUsers	TRUE	string[]	接收邀請之使用者的 XUID。XUID 以 10 進位整數表示。最多 16 個 XUID。
sender	TRUE	string	代表其傳送邀請之使用者的識別碼。
connectionString		string	連線字串是在邀請送達使用者時傳遞給遊戲的內容。連線字串通常包含伺服器 IP 等資訊，讓受邀使用者能夠加入。如果連線字串欄位保留空白，則會以空的連線字串叫用遊戲。連線字串的長度限制為 512 個字元。
platform		Platform

回應

名稱	類型	描述
204 No Content
已成功傳送邀請。
400 Bad Request	ErrorResponse	處理要求時發生錯誤。可能的錯誤碼：“RequestValidationError: 要求驗證失敗。”、” AuthorizationError: 不允許呼叫端存取資源。要求過多。“
其他狀態碼	ThrottledEntity	要求過多。標頭 Retry-After: integer

ErrorResponse

名稱	類型	描述
debugMessage	string	可用於偵錯、人類可讀的錯誤訊息版本。
errorCode	string	錯誤碼列舉。

Platform

名稱	類型	描述
Android	string
IOS	string
Nintendo	string
PlayStation	string
Scarlett	string
Win32	string
WindowsOneCore	string
XboxOne	string

SendServerInviteRequest

名稱	類型	描述
connectionString	string	連線字串是在邀請送達使用者時傳遞給遊戲的內容。連線字串通常包含伺服器 IP 等資訊，讓受邀使用者能夠加入。如果連線字串欄位保留空白，則會以空的連線字串叫用遊戲。連線字串的長度限制為 512 個字元。
invitedUsers	string[]	接收邀請之使用者的 XUID。XUID 以 10 進位整數表示。最多 16 個 XUID。
platform	Platform
sender	string	代表其傳送邀請之使用者的識別碼。

ThrottledEntity

名稱	類型	描述
currentRequests	string	目前的要求數 - 並行或速率。
debugMessage	string	可用於偵錯、人類可讀的節流訊息版本。
limitType	string	限制類型，亦即並行或速率。
maxRequests	string	允許的最大要求數 - 並行或速率。
periodInSeconds	string	超過速率或並行限制時所套用的期間 (以秒為單位)。
version	string	目前的節流合約版本。

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Additional pages

Reference

POST /titles/{titleId}/invites/server API

傳送伺服器邀請

URI 參數

要求標頭

要求本文

回應

定義

ErrorResponse

Platform

SendServerInviteRequest

ThrottledEntity

​傳送伺服器邀請

​URI 參數

​要求標頭

​要求本文

​回應

​定義

​ErrorResponse

​Platform

​SendServerInviteRequest

​ThrottledEntity

傳送伺服器邀請

URI 參數

要求標頭

要求本文

回應

定義

ErrorResponse

Platform

SendServerInviteRequest

ThrottledEntity