Envoyer une invitation

Envoie une invitation à un utilisateur XBOX Live. Cette API permet à un client de jeu d’envoyer une invitation à un utilisateur XBOX Live pour un titre spécifique. L’invitation est envoyée à tous les points de terminaison inscrits, quelle que soit la plateforme.

POST /titles/{titleId}/invites

Paramètres d’URI

Paramètre	Emplacement	Obligatoire	Type	Description
titleId	path	TRUE	integer	Le titleId du jeu pour lequel la requête est envoyée.

En-tête de requête

Nom	Obligatoire	Type	Description
Authorization	TRUE	integer	L’appelant doit fournir un XToken au format d’autorisation XBL 3.0. Par exemple, Authorization: XBL3.0 x=2553948354698;>encrypted token<)
Content-Type	TRUE	string	ContentType doit être défini sur application/json

Corps de la requête

Nom	Obligatoire	Type	Description
invitedUsers	TRUE	string[]	Les XUID des utilisateurs auxquels l’invitation est envoyée. Le XUID est représenté sous la forme d’un entier en base 10. Le maximum est de 16 XUID.
connectionString		string	La chaîne de connexion est ce qui est transmis au jeu lorsque l’invitation parvient à l’utilisateur. La chaîne de connexion contient généralement des informations telles que l’adresse IP du serveur pour permettre à l’utilisateur invité de rejoindre la partie. Si le champ de la chaîne de connexion est laissé vide, le titre est appelé avec une chaîne de connexion vide. La longueur de la chaîne de connexion est limitée à 512 caractères.
platform		Platform

Réponses

Nom	Type	Description
204 No Content
L’invitation a été envoyée avec succès.
400 Bad Request	ErrorResponse	Une erreur s’est produite lors du traitement de la requête. Codes d’erreur possibles : “RequestValidationError: The request validation has failed.”, ” AuthorizationError: The caller is not allowed to access the resource. Too many requests.”
Autres codes d’état	ThrottledEntity	Trop de requêtes. En-têtes Retry-After: integer

ErrorResponse

Nom	Type	Description
debugMessage	string	Version lisible du message d’erreur, utilisable pour le débogage.
errorCode	string	Énumération du code d’erreur.

Platform

Nom	Type	Description
Android	string
IOS	string
Nintendo	string
PlayStation	string
Scarlett	string
Win32	string
WindowsOneCore	string
XboxOne	string

SendInviteRequest

Si la plateforme n’est pas définie dans la requête, l’invitation permettra au destinataire de rejoindre la partie sur n’importe quelle plateforme sur laquelle le jeu peut être joué. Sinon, elle n’inclura que la plateforme indiquée. Remarque : l’exception à cette règle est que si Scarlett n’est pas configurée comme plateforme, les invitations spécifiant XboxOne seront également envoyées aux appareils Scarlett.

Nom	Type	Description
connectionString	string	La chaîne de connexion est ce qui est transmis au jeu lorsque l’invitation parvient à l’utilisateur. La chaîne de connexion contient généralement des informations telles que l’adresse IP du serveur pour permettre à l’utilisateur invité de rejoindre la partie. Si le champ de la chaîne de connexion est laissé vide, le titre est appelé avec une chaîne de connexion vide. La longueur de la chaîne de connexion est limitée à 512 caractères.
invitedUsers	string[]	Les XUID des utilisateurs auxquels l’invitation est envoyée. Le XUID est représenté sous la forme d’un entier en base 10. Le maximum est de 16 XUID.
platform	Platform

ThrottledEntity

Nom	Type	Description
currentRequests	string	Nombre actuel de requêtes (simultanéité ou débit).
debugMessage	string	Version lisible du message de limitation, utilisable pour le débogage.
limitType	string	Le type de limite, c’est-à-dire simultanéité ou débit.
maxRequests	string	Nombre maximal de requêtes autorisées (simultanéité ou débit).
periodInSeconds	string	La période en secondes qui s’applique lorsque les limites de débit ou de simultanéité sont dépassées.
version	string	Version actuelle du contrat de limitation.

Introduction

Onboarding & Access

Setup & Install

Build Your First Title

Envoyer une invitation

Envoyer une invitation

Paramètres d’URI

En-tête de requête

Corps de la requête

Réponses

Définitions

ErrorResponse

Platform

SendInviteRequest

ThrottledEntity

​Envoyer une invitation

​Paramètres d’URI

​En-tête de requête

​Corps de la requête

​Réponses

​Définitions

​ErrorResponse

​Platform

​SendInviteRequest

​ThrottledEntity

Envoyer une invitation

Paramètres d’URI

En-tête de requête

Corps de la requête

Réponses

Définitions

ErrorResponse

Platform

SendInviteRequest

ThrottledEntity