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

# GET (/users/xuid({xuid})/inbox)

> GET (/users/xuid({xuid})/inbox)

# GET (/users/xuid({xuid})/inbox)

Récupère un nombre spécifié de résumés de messages utilisateur à partir du service.
Le domaine de ces URI est `msg.xboxlive.com`.

* [Remarques](#ID4EV)
* [Paramètres d'URI](#ID4EEB)
* [Paramètres de chaîne de requête](#ID4EIC)
* [Autorisation](#ID4EGE)
* [Effet des paramètres de confidentialité sur la ressource](#ID4ETE)
* [Codes d'état HTTP](#ID4E5E)
* [Réponse JSON (JavaScript Object Notation)](#ID4EMH)

<a id="ID4EV" />

## Remarques

Un résumé de message utilisateur contient uniquement l'objet du message. Pour les messages générés par l'utilisateur, il s'agit actuellement des 20 premiers caractères du texte du message. Les messages système peuvent fournir un autre objet, tel que « LIVE System ».

Les messages sont retournés dans l'ordre inverse de leur envoi ; autrement dit, les messages les plus récents sont retournés en premier.

Le seul type de contenu pris en charge par cette API est « application/json », qui est requis dans les en-têtes HTTP de chaque appel.

<a id="ID4EEB" />

## Paramètres d'URI

| Paramètre | Type | Description |
| - | - | - |
| xuid | entier 64 bits non signé | XBOX User ID (XUID) du joueur qui effectue la requête. |

<a id="ID4EIC" />

## Paramètres de chaîne de requête

\| Propriété| Type| Longueur maximale| Remarques|
\| --- | --- | --- | --- | --- | --- | --- |
\| maxItems| int| 100| Nombre maximal de messages retournés.|
\| continuationToken| string|  | Chaîne retournée lors d'un appel d'énumération précédent ; utilisée pour poursuivre l'énumération.|
\| skipItems| int| 100| Nombre de messages à ignorer ; ignoré si continuationToken est présent.|

<a id="ID4EGE" />

## Autorisation

Vous devez disposer de votre propre revendication d'utilisateur pour récupérer un résumé de message utilisateur.

<a id="ID4ETE" />

## Effet des paramètres de confidentialité sur la ressource

Vous seul pouvez énumérer vos propres messages utilisateur.

<a id="ID4E5E" />

## Codes d'état HTTP

Le service retourne l'un des codes d'état de cette section en réponse à une requête effectuée avec cette méthode sur cette ressource. Pour obtenir la liste complète des codes d'état HTTP standard utilisés avec les XBOX Live Services, consultez [Codes d'état HTTP standard](/fr/reference/live/rest/additional/httpstatuscodes).

\| Code| Description|
\| --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| 200| La requête a réussi.|
\| 400| Le service n'a pas pu comprendre la requête mal formée. Généralement un paramètre non valide.|
\| 403| La requête n'est pas autorisée pour l'utilisateur ou le service.|
\| 404| Un XUID valide est manquant dans l'URI.|
\| 409| La collection sous-jacente a changé en fonction du jeton de continuation transmis.|
\| 416| Le nombre d'éléments à ignorer est supérieur au nombre d'éléments disponibles.|
\| 500| Erreur générale côté serveur.|

<a id="ID4EMH" />

## Réponse JSON (JavaScript Object Notation)

En cas de réussite de l'appel, le service retourne les données de résultats au format JSON.

| Propriété | Type | Longueur maximale | Remarques |
| - | - | - | - |
| results | Message\[] | 100 | Tableau de messages utilisateur |
| pagingInfo | PagingInfo | | Informations de pagination pour l'ensemble de résultats actuel |

#### Message

| Propriété | Type | Longueur maximale | Remarques |
| - | - | - | - |
| header | Header | | En-tête du message utilisateur |
| messageSummary | string | 20 | UTF-8 ; généralement les 20 premiers caractères du message |

#### Header

| Propriété | Type | Longueur maximale | Remarques |
| - | - | - | - |
| id | string | 50 | Identificateur du message, utilisé pour récupérer les détails du message ou supprimer des messages. |
| isRead | bool | | Indicateur signalant que l'utilisateur a déjà lu les détails du message. |
| sent | DateTime | | Date et heure UTC d'envoi du message. (Fournies par le service.) |
| expiration | DateTime | | Date et heure UTC d'expiration du message. (Tous les messages ont une durée de vie maximale, qui sera déterminée ultérieurement.) |
| messageType | string | 50 | Types de messages : User, System, FriendRequest, Video, QuickChat, VideoChat, PartyChat, Title, GameInvite. |
| senderXuid | ulong | | XUID de l'expéditeur. |
| sender | string | 15 | Gamertag de l'expéditeur. |
| hasAudio | bool | | Indique si le message comporte une pièce jointe audio (vocale). |
| hasPhoto | bool | | Indique si le message comporte une photo en pièce jointe. |
| hasText | bool | | Indique si le message contient du texte. |

#### Informations de pagination

| Propriété | Type | Longueur maximale | Remarques |
| - | - | - | - |
| continuationToken | string | 100 | Retourné facultativement par le serveur. Permet aux appels ultérieurs de poursuivre l'énumération. |
| totalItems | int | | Nombre total de messages dans la boîte de réception. |

#### Exemple de réponse

```cpp theme={null}
{
          "results":
          [
            {
              "header":
              {
                "expiration":"2011-10-11T23:59:59.9999999",
                "id":"opaqueBlobOfText",
                "messageType":"User",
                "isRead":false,
                "senderXuid":"123456789",
                "sender":"Striker",
                "sent":"2011-05-08T17:30:00Z",
                "hasAudio":false,
                "hasPhoto":false,
                "hasText":true
              },
            "messageSummary":"first 20 chars"
          },
          ...
        ],
        "pagingInfo":
          {
          "continuationToken":"opaqueBlobOfText"
          "totalItems":5,
          }
        }

```

#### Réponse d'erreur

En cas d'erreur, le service peut retourner un objet errorResponse, qui peut contenir des valeurs provenant de l'environnement du service.

\| Propriété| Type| Description|
\| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| errorSource| string| Indication de l'origine de l'erreur.|
\| errorCode| int| Code numérique associé à l'erreur (peut être null).|
\| errorMessage| string| Détails de l'erreur si la configuration autorise l'affichage des détails.|

<a id="ID4EIKAC" />

## Voir aussi

<a id="ID4EKKAC" />

##### Parent

[/users/xuid({xuid})/inbox](/fr/reference/live/rest/uri/users/uri-usersxuidinbox)

<a id="ID4EWKAC" />

##### Référence  [Codes d'état HTTP standard](/fr/reference/live/rest/additional/httpstatuscodes)


## Related topics

- [XblUserStatisticsGetSingleUserStatisticAsync](/zh-TW/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetsingleuserstatisticasync.md)
- [XblUserStatisticsGetSingleUserStatisticsAsync](/zh-TW/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetsingleuserstatisticsasync.md)
