Method: users.batchGet

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

La charge utile renvoyée contient une liste de numéros de téléphone compatibles RCS joignables par la plate-forme RCS for Business 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 qui peuvent être utilisées pour 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

Important : La méthode users.batchGet nécessite l'utilisation de points de terminaison régionaux. Les demandes doivent contenir des numéros de téléphone provenant d'une seule région géographique. Si vous envoyez des numéros de téléphone de plusieurs régions dans une même requête ou à un point de terminaison régional incorrect, une erreur 400 Bad Request se produira.

Points de terminaison régionaux :

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.

Tous les numéros de téléphone d'une même demande doivent appartenir à la même région géographique. Les requêtes contenant des numéros de téléphone provenant de plusieurs régions ou envoyées au mauvais point de terminaison régional échoueront et renverront une erreur 400 Bad Request.
agentId

string

Obligatoire. Identifiant unique de l'agent.

Corps de la réponse

Réponse avec des données sur l'accessibilité des utilisateurs pour RCS for Business.

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,
  "reachableUsersMap": {
    string: {
      object (ReachableUsers)
    },
    ...
  }
}
Champs
reachableUsers[]

string

Liste des numéros de téléphone des utilisateurs que RCS for Business peut contacter. N'inclut que les utilisateurs des opérateurs sur lesquels l'agent est lancé.
totalRandomSampleUserCount

integer

Nombre de numéros de téléphone sélectionnés au hasard dans reachableUsers. En général, cette valeur représente 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 au hasard qui sont joignables par RCS sur tous les opérateurs, quel que soit l'état de lancement de l'agent. Le ratio entre cette valeur et totalRandomSampleUserCount peut donner une estimation de la couverture potentielle d'une liste d'utilisateurs.
reachableUsersMap

map (key: string, value: object (ReachableUsers))

Uniquement en sortie. Mappage de l'ID du fournisseur à une liste d'utilisateurs joignables sur ce fournisseur. Ce champ n'est renseigné que pour les numéros de téléphone américains.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la OAuth 2.0 Overview.

ReachableUsers

Liste des utilisateurs joignables sur un opérateur spécifique.

Représentation JSON 
{
  "reachableUsers": [
    string
  ]
}
Champs
reachableUsers[]

string

Liste des utilisateurs joignables sur un opérateur spécifique. Ce champ n'est renseigné que pour les numéros de téléphone américains.