Récupère les numéros de téléphone compatibles RCS d'une liste d'utilisateurs.
La charge utile renvoyée contient une liste de numéros de téléphone compatibles 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 d'un opérateur avec 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 du 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[] |
Liste des numéros de téléphone des utilisateurs au format E.164. |
agentId |
Obligatoire. Identifiant unique de l'agent. |
Corps de la réponse
Réponse avec des données utilisateur sur la joignabilité 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[] |
Liste des numéros de téléphone des utilisateurs que RBM peut joindre. N'inclut que les utilisateurs des opérateurs sur lesquels l'agent est lancé. |
totalRandomSampleUserCount |
Nombre de numéros de téléphone sélectionnés de manière aléatoire dans |
reachableRandomSampleUserCount |
Nombre de numéros de téléphone issus de la liste sélectionnée au hasard qui sont joignables via le RCS pour tous les opérateurs, quel que soit l'état du lancement de l'agent. Le ratio entre cette valeur et |
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.