GET (/users/xuid()/inbox/)

Récupère le texte détaillé d’un message d’utilisateur particulier et le marque comme lu sur le service. Le domaine de ces URI est msg.xboxlive.com.

Remarques
Paramètres d’URI
Autorisation
Corps de la requête
Effet des paramètres de confidentialité sur la ressource
Codes d’état HTTP
Réponse JSON (JavaScript Object Notation)

Remarques

L’opération GET ne peut être effectuée que sur les types de messages User, System et FriendRequest. Cet URI nécessite une actualisation sur Xbox.com. Actuellement, la XBOX 360 ne met pas à jour l’état lu/non lu tant que l’utilisateur ne s’est pas déconnecté puis reconnecté. 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.

Paramètres d’URI

Paramètre	Type	Description
xuid	entier non signé de 64 bits	Identifiant d’utilisateur XBOX (XUID) du joueur qui effectue la requête.
messageId	string[50]	Identifiant du message récupéré ou supprimé.

Autorisation

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

Corps de la requête

Aucun objet n’est envoyé dans le corps de cette requête.

Effet des paramètres de confidentialité sur la ressource

Vous seul pouvez récupérer vos propres messages d’utilisateur.

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 services XBOX Live, consultez Codes d’état HTTP standard. | Code| Description| | --- | --- | --- | --- | --- | | 200| Réussite.| | 400| Le XUID ne peut pas être converti correctement.| | 403| Le XUID ne peut pas être converti ou aucune revendication XUID valide n’a été trouvée.| | 404| Un XUID valide est manquant, ou l’identifiant du message est introuvable ou mal analysé.| | 500| Erreur générale côté serveur, ou le type de message n’est pas valide pour GET.|

Réponse JSON (JavaScript Object Notation)

Si l’appel réussit, le service retourne les données de résultats au format JSON. L’objet racine est un objet UserMessageHeader.

UserMessageHeader

Propriété	Type	Longueur maximale	Remarques
header	Header		Objet JSON
messageText	string	256	UTF-8

Propriété	Type	Longueur maximale	Remarques
sent	DateTime		Date et heure d’envoi du message. (Fournies par le service.)
expiration	DateTime		Date et heure d’expiration du message. (Tous les messages ont une durée de vie maximale, qui sera déterminée ultérieurement.)
messageType	string	13	Types de messages : User, System, FriendRequest.
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.

Exemple de réponse

{
          "header":
          {
            "expiration":"2011-10-11T23:59:59.9999999",
            "messageType":"User",
            "senderXuid":"123456789",
            "sender":"Striker",
            "sent":"2011-05-08T17:30:00Z",
            "hasAudio":false,
            "hasPhoto":false,
            "hasText":true
          },
        "messageText":"random user text up to 256 characters"
        }

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 permet d’afficher les détails.|

Voir aussi

Parent

/users/xuid()/inbox

Introduction

Onboarding & Access

Setup & Install

Build Your First Title

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

GET (/users/xuid()/inbox/)

Remarques

Paramètres d’URI

Autorisation

Corps de la requête

Effet des paramètres de confidentialité sur la ressource

Codes d’état HTTP

Réponse JSON (JavaScript Object Notation)

UserMessageHeader

Header

Exemple de réponse

Réponse d’erreur

Voir aussi

Parent

Référence Codes d’état HTTP standard

​GET (/users/xuid()/inbox/)

​Remarques

​Paramètres d’URI

​Autorisation

​Corps de la requête

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

​Codes d’état HTTP

​Réponse JSON (JavaScript Object Notation)

​UserMessageHeader

​Header

​Exemple de réponse

​Réponse d’erreur

​Voir aussi

Parent

Référence Codes d’état HTTP standard

GET (/users/xuid()/inbox/)

Remarques

Paramètres d’URI

Autorisation

Corps de la requête

Effet des paramètres de confidentialité sur la ressource

Codes d’état HTTP

Réponse JSON (JavaScript Object Notation)

UserMessageHeader

Header

Exemple de réponse

Réponse d’erreur

Voir aussi