Method: users.batchGet

Récupère les numéros de téléphone compatibles avec le RCS pour une liste d'utilisateurs.

La charge utile renvoyée contient une liste des numéros de téléphone compatibles avec le RCS accessibles par la plate-forme RBM pour les utilisateurs spécifiés. Seuls les numéros de téléphone compatibles avec le RCS pour un opérateur sur lequel l'agent est lancé seront renvoyés.

La charge utile renvoyée contient également des valeurs permettant d'estimer la couverture potentielle d'une liste de numéros de téléphone, quel que soit l'état de lancement de l'agent.

600 requêtes par minute (RPM) maximum

Requête HTTP

POST https://rcsbusinessmessaging.googleapis.com/v1/users:batchGet

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "users": [
    string
  ],
  "agentId": string
}
Champs
users[]

string

Liste des numéros de téléphone des utilisateurs au format E.164.
agentId

string

Obligatoire. Identifiant unique de l'agent.

Corps de la réponse

Réponse avec les données utilisateur de la connectivité RBM.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer
}
Champs
reachableUsers[]

string

Liste des numéros de téléphone des utilisateurs que RBM peut contacter. Inclut uniquement les utilisateurs des opérateurs sur lesquels l'agent est lancé.
totalRandomSampleUserCount

integer

Nombre de numéros de téléphone sélectionnés de manière aléatoire dans reachableUsers. En général, cette valeur correspond à environ 75% du nombre total de numéros de téléphone demandés. Cette valeur est 0 si le nombre de numéros de téléphone demandés est inférieur à 500.
reachableRandomSampleUserCount

integer

Nombre de numéros de téléphone de la liste sélectionnée de manière aléatoire qui sont accessibles via le RCS auprès de tous les opérateurs, quel que soit l'état de lancement de l'agent. Le ratio entre cette valeur et totalRandomSampleUserCount peut donner une approximation de la couverture potentielle d'une liste d'utilisateurs.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/rcsbusinessmessaging

Pour en savoir plus, consultez la présentation d'OAuth 2.0.