POST (/users/batch)
Obtient la présence d’un lot d’utilisateurs. Le domaine de ces URI estuserpresence.xboxlive.com.
- Remarques
- Autorisation
- Effet des paramètres de confidentialité sur la ressource
- En-têtes de requête obligatoires
- En-têtes de requête facultatifs
- Corps de la requête
- Corps de la réponse
Remarques
Cette méthode doit être utilisée par tout client, service ou titre qui souhaite obtenir des renseignements de présence pour un lot d’utilisateurs. Les réponses à cette requête par lot peuvent être filtrées par profondeur et par chemin. Les consommateurs peuvent s’en servir pour connaître et afficher la présence d’un ensemble d’utilisateurs. Les filtres de cette API fonctionnent comme des OU au sein d’une propriété, mais comme des ET entre les propriétés.Autorisation
Effet des paramètres de confidentialité sur la ressource
Cette méthode retourne toujours 200 OK, mais peut ne retourner aucun contenu dans le corps de la réponse. | Utilisateur demandeur| Paramètre de confidentialité de l’utilisateur cible| Comportement| | --- | --- | --- | --- | --- | --- | --- | | moi| -| 200 OK| | ami| tout le monde| 200 OK| | ami| amis seulement| 200 OK| | ami| bloqué| 200 OK| | utilisateur non ami| tout le monde| 200 OK| | utilisateur non ami| amis seulement| 200 OK| | utilisateur non ami| bloqué| 200 OK| | site tiers| tout le monde| 200 OK| | site tiers| amis seulement| 200 OK| | site tiers| bloqué| 200 OK|En-têtes de requête obligatoires
| En-tête| Type| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Authorization| chaîne| Informations d’identification pour l’authentification HTTP. Exemple de valeur : “XBL3.0 x=<userhash>;<token>”.| | x-xbl-contract-version| chaîne| Nom ou numéro de build du service XBOX LIVE auquel cette requête doit être dirigée. La requête ne sera acheminée vers ce service qu’après vérification de la validité de l’en-tête, des revendications du jeton d’authentification, et ainsi de suite. Exemples de valeurs : 3, vnext.| | Accept| chaîne| Types de contenu (Content-Types) acceptables. Le seul pris en charge par Presence est application/json, mais il doit être indiqué dans l’en-tête.| | Accept-Language| chaîne| Paramètres régionaux acceptables pour les chaînes de la réponse. Exemples de valeurs : en-US.| | Host| chaîne| Nom de domaine du serveur. Exemple de valeur : presencebeta.xboxlive.com.| | Content-Length| chaîne| La longueur du corps de la requête. Exemple de valeur : 312.|En-têtes de requête facultatifs
| En-tête| Type| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | X-RequestedServiceVersion| | Nom ou numéro de build du service XBOX LIVE auquel cette requête doit être dirigée. La requête ne sera acheminée vers ce service qu’après vérification de la validité de l’en-tête, des revendications du jeton d’authentification, et ainsi de suite. Valeur par défaut : 1.|Corps de la requête
Membres obligatoires
| Membre| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | users| Liste des XUID des utilisateurs dont vous voulez connaître la présence, avec un maximum de 1100 XUID à la fois.|Membres facultatifs
| Membre| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | deviceTypes| Liste des types d’appareils utilisés par les utilisateurs qui vous intéressent. Si le tableau est laissé vide, tous les types d’appareils possibles sont utilisés par défaut (c’est-à-dire qu’aucun n’est exclu par filtrage).| | titles| Liste des types d’appareils dont les utilisateurs vous intéressent. Si le tableau est laissé vide, tous les titres possibles sont utilisés par défaut (c’est-à-dire qu’aucun n’est exclu par filtrage).| | level| Valeurs possibles :- user - obtenir les nœuds d’utilisateur
- device - obtenir les nœuds d’utilisateur et d’appareil
- title - obtenir les renseignements de base au niveau du titre
- all - obtenir les renseignements de Rich Presence, les renseignements multimédias, ou les deux
La valeur par défaut est « title ».| | onlineOnly| Si cette propriété a la valeur true, l’opération par lot exclut les enregistrements des utilisateurs hors ligne (y compris ceux qui sont masqués). Si elle n’est pas fournie, les utilisateurs en ligne et hors ligne sont retournés.|
