new_releases Mises à jour : Consultez les
notes de version pour découvrir les nouvelles fonctionnalités et les mises à jour du produit.
Method: users.batchGet
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
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 accessibles par la plate-forme RBM pour les utilisateurs spécifiés. Seuls les numéros de téléphone compatibles RCS pour l'opérateur avec 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) au 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 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[] |
string
Liste des numéros de téléphone des utilisateurs que le RBM peut joindre. N'inclut que les utilisateurs des opérateurs avec 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 issus de la liste sélectionnée de manière aléatoire et accessibles via le RCS auprès de tous les opérateurs, quel que soit l'état du lancement de l'agent. Le ratio entre cette valeur et totalRandomSampleUserCount peut estimer la couverture potentielle pour 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 OAuth 2.0 Overview.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[[["\u003cp\u003eThis endpoint retrieves a list of RCS-enabled phone numbers for specified users that are reachable by the RBM platform, limited to carriers where the agent is launched.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of \u003ccode\u003ereachableUsers\u003c/code\u003e, indicating which phone numbers are RCS-enabled and accessible via the launched agent's carriers.\u003c/p\u003e\n"],["\u003cp\u003eIt provides \u003ccode\u003etotalRandomSampleUserCount\u003c/code\u003e and \u003ccode\u003ereachableRandomSampleUserCount\u003c/code\u003e to estimate the potential reach of a user list, irrespective of the agent's launch status.\u003c/p\u003e\n"],["\u003cp\u003eThe API endpoint is \u003ccode\u003ePOST https://rcsbusinessmessaging.googleapis.com/v1/users:batchGet\u003c/code\u003e, with a maximum request rate of 600 queries per minute.\u003c/p\u003e\n"],["\u003cp\u003eTo make the call to this endpoint, the request body requires a list of user's phone number in E.164 format, and the agents unique identifier.\u003c/p\u003e\n"]]],[],null,["# Method: users.batchGet\n\nGets the RCS-enabled phone numbers for a list of users.\n\nThe returned payload contains a list of RCS-enabled phone numbers reachable by the RBM platform for the specified users. Only phone numbers that are RCS-enabled for a carrier the agent is launched on will be returned.\n\nThe returned payload also contains values that can be used to estimate the potential reach of a list of phone numbers regardless of the launch status of the agent.\n\nMaximum 600 queries per minute (QPM).\n\n### HTTP request\n\n`POST https://rcsbusinessmessaging.googleapis.com/v1/users:batchGet`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------|\n| ``` { \"users\": [ string ], \"agentId\": string } ``` |\n\n| Fields ||\n|-----------|--------------------------------------------------------|\n| `users[]` | `string` List of users' phone numbers in E.164 format. |\n| `agentId` | `string` Required. The agent's unique identifier. |\n\n### Response body\n\nResponse with RBM-reachability user data.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"reachableUsers\": [ string ], \"totalRandomSampleUserCount\": integer, \"reachableRandomSampleUserCount\": integer } ``` |\n\n| Fields ||\n|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `reachableUsers[]` | `string` List of users' phone numbers that RBM can reach. Only includes users on carriers that the agent is launched on. |\n| `totalRandomSampleUserCount` | `integer` Count of phone numbers randomly selected from [reachableUsers](/business-communications/rcs-business-messaging/reference/rest/v1/users/batchGet#body.BatchGetUsersResponse.FIELDS.reachable_users). Typically, this value is \\~75% of the total requested phone numbers. This value is `0` if the count of requested phone numbers is less than 500. |\n| `reachableRandomSampleUserCount` | `integer` Count of phone numbers from the randomly selected list that are RCS-reachable across all carriers, regardless of the agent's launch status. The ratio between this value and [totalRandomSampleUserCount](/business-communications/rcs-business-messaging/reference/rest/v1/users/batchGet#body.BatchGetUsersResponse.FIELDS.total_random_sample_user_count) can approximate the potential reach for a list of users. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/rcsbusinessmessaging`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
