> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Envoyer une invitation de serveur

> Envoyer une invitation de serveur

# Envoyer une invitation de serveur

Envoie une invitation à un utilisateur XBOX avec la chaîne de connexion indiquée.

Cette API permet à un serveur de jeu d'envoyer une invitation à un utilisateur XBOX Live. Le corps de la requête contient une chaîne de connexion que l'invité utilise pour se joindre au serveur. La chaîne de connexion peut contenir l'adresse IP du serveur de jeu ou un pointeur vers une session dans laquelle se trouve l'utilisateur. L'invitation est envoyée à tous les points de terminaison inscrits, quelle que soit la plateforme.

```http theme={null}
POST /titles/{titleId}/invites/server
```

<a id="uri-parameters" />

## Paramètres d'URI

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

<a id="request-header" />

## 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 |

<a id="request-body" />

## Corps de la requête

| Nom | Obligatoire | Type | Description |
| - | - | - | - |
| invitedUsers | TRUE | string\[] | Le XUID des utilisateurs à qui l'invitation est envoyée. Le XUID est représenté sous forme d'entier en base 10. Le maximum est de 16 XUID. |
| sender | TRUE | string | L'identifiant de l'utilisateur au nom duquel l'invitation est envoyée. |
| 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 habituellement des renseignements comme l'adresse IP du serveur pour permettre à l'utilisateur invité de se joindre. 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](#platform) | |

<a id="responses" />

## Réponses

| Nom | Type | Description |
| - | - | - |
| 204 No Content | | |
| L'invitation a été envoyée avec succès. | | |
| 400 Bad Request | [ErrorResponse](#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](#throttledentity) | Trop de requêtes. En-têtes Retry-After: integer |

<a id="definitions" />

## Définitions

* [ErrorResponse](#errorresponse)
* [Platform](#platform)
* [SendServerInviteRequest](#sendserverinviterequest)
* [ThrottledEntity](#throttledentity)

<a id="errorresponse" />

### ErrorResponse

| Nom | Type | Description |
| - | - | - |
| debugMessage | string | Version lisible par l'humain du message d'erreur, utilisable pour le débogage. |
| errorCode | string | Énumération du code d'erreur. |

<a id="platform" />

### Platform

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

<a id="sendserverinviterequest" />

### SendServerInviteRequest

| 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 habituellement des renseignements comme l'adresse IP du serveur pour permettre à l'utilisateur invité de se joindre. 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\[] | Le XUID des utilisateurs à qui l'invitation est envoyée. Le XUID est représenté sous forme d'entier en base 10. Le maximum est de 16 XUID. |
| platform | [Platform](#platform) | |
| sender | string | L'identifiant de l'utilisateur au nom duquel l'invitation est envoyée. |

<a id="throttleentity" />

### ThrottledEntity

| Nom | Type | Description |
| - | - | - |
| currentRequests | string | Nombre actuel de requêtes - simultanéité ou débit. |
| debugMessage | string | Version lisible par l'humain du message de limitation, utilisable pour le débogage. |
| limitType | string | Le type de limite, c.-à-d. 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. |


## Related topics

- [Envoyer une invitation à un autre joueur pour rejoindre une partie multijoueur](/fr-CA/services/xbox-services/multiplayer/mpa/concepts/live-mpa-invites.md)
- [Jouer en multijoueur avec des amis à l'aide de Multiplayer Manager](/fr-CA/services/xbox-services/multiplayer/mpm/how-to/live-play-multiplayer-with-friends.md)
- [Tâches multijoueurs](/fr/services/xbox-services/multiplayer/mpsd/how-to/live-mpsd-how-tos.md)
- [Invitations de lobby](/fr-CA/services/playfab/multiplayer/lobby/lobby-invites.md)
- [Vue d'ensemble de la fonctionnalité Multiplayer Activity (MPA)](/fr/services/xbox-services/multiplayer/mpa/live-mpa-overview.md)