Server Invite の送信

  • [アーティクル]

指定した接続文字列を使用して Xbox ユーザーに招待を送信します。

この API を使用すると、ゲーム サーバーは Xbox Live ユーザーに招待を送信できます。 要求の本文には、招待者がサーバーに参加するために使用する接続文字列が含まれています。 接続文字列には、ゲーム サーバーの IP またはユーザーが参加しているセッションへのポインタが含まれている可能性があります。 招待はプラットフォームに関係なく、登録されたすべてのエンドポイントに送信されます。

POST /titles/{titleId}/invites/server

URI パラメーター

パラメーター 受信 必須 種類 説明
titleId path TRUE integer 要求の送信先ゲームの titleId。

要求ヘッダー

名前 必須 種類 説明
Authorization TRUE integer 呼び出し元は、XBL 3.0 承認形式内で XToken を提供する必要があります。 たとえば、承認: XBL3.0 x=2553948354698;>暗号化されたトークン<)
Content-Type TRUE 文字列 ContentType は application/json に設定する必要があります

リクエストの本文

名前 必須 種類 説明
invitedUsers TRUE 文字列の配列 ユーザーの XUID 招待は送信中です。 XUID は、基数 10 の整数として表されます。 最大値は 16 XUID です。
sender TRUE 文字列 その人の代理で招待を送信するユーザーの ID。
connectionString 文字列 接続文字列は、ユーザーが招待を受け取ったときにゲームに渡されるものです。 接続文字列には通常、招待しているユーザーが参加できるようにするためのサーバー IP などの情報が含まれています。 接続文字列フィールドを空にすると、空の接続文字列でタイトルが呼び出されます。 接続文字列の長さは 512 文字に制限されています。
プラットフォーム プラットフォーム

応答

名前 種類 説明
204 No Content
招待が正常に送信されました。
400 Bad Request ErrorResponse 要求の処理中にエラーが発生しました。 考えられるエラー コード: "RequestValidationError: 要求の検証に失敗しました。"、"AuthorizationError: 呼び出し元はリソースへのアクセスを許可されていません。 要求が多すぎます。"
その他の状態コード ThrottledEntity 要求が多すぎます。 Headers Retry-After: 整数

定義

ErrorResponse

名前 種類 説明
debugMessage 文字列 デバッグに使用できる可読版のエラー メッセージ。
errorCode 文字列 エラー コードの列挙型。

プラットフォーム

名前 種類 説明
Android 文字列
IOS 文字列
Nintendo 文字列
PlayStation 文字列
Scarlett 文字列
Win32 文字列
WindowsOneCore 文字列
XboxOne 文字列

SendServerInviteRequest

名前 種類 説明
connectionString 文字列 接続文字列は、ユーザーが招待を受け取ったときにゲームに渡されるものです。 接続文字列には通常、招待しているユーザーが参加できるようにするためのサーバー IP などの情報が含まれています。 接続文字列フィールドを空にすると、空の接続文字列でタイトルが呼び出されます。 接続文字列の長さは 512 文字に制限されています。
invitedUsers 文字列の配列 ユーザーの XUID 招待は送信中です。 XUID は、基数 10 の整数として表されます。 最大値は 16 XUID です。
プラットフォーム プラットフォーム
sender 文字列 その人の代理で招待を送信するユーザーの ID。

ThrottledEntity

名前 種類 説明
currentRequests 文字列 現在のリクエスト数 - 同時接続数または割合。
debugMessage 文字列 デバッグに使用できる可読版のスロットル メッセージ。
LimitType 文字列 制限の種類、つまり同時接続数または割合。
maxRequests 文字列 許容される最大リクエスト数 - 同時接続数または割合。
periodInSeconds 文字列 割合または同時接続数の制限を超えたときに適用される秒単位の期間。
version 文字列 現在のスロットル契約バージョン。