new_releases Updates: In den
Versionshinweisen finden Sie Informationen zu neuen Funktionen und Produktupdates.
Method: users.batchGet
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Ruft die RCS-fähigen Telefonnummern für eine Liste von Nutzern ab.
Die zurückgegebene Nutzlast enthält eine Liste von RCS-fähigen Telefonnummern, die über die RBM-Plattform für die angegebenen Nutzer erreichbar sind. Es werden nur Telefonnummern zurückgegeben, die für einen Mobilfunkanbieter, für den der Agent gestartet wird, RCS-fähig sind.
Die zurückgegebene Nutzlast enthält auch Werte, mit denen die potenzielle Reichweite einer Liste von Telefonnummern unabhängig vom Aktivierungsstatus des Agents geschätzt werden kann.
Maximal 600 Abfragen pro Minute (QPM).
HTTP-Anfrage
POST https://rcsbusinessmessaging.googleapis.com/v1/users:batchGet
Die URL verwendet die Syntax der gRPC-Transcodierung.
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
| JSON-Darstellung |
{
"users": [
string
],
"agentId": string
} |
| Felder |
users[] |
string
Liste der Telefonnummern von Nutzern im E.164-Format.
|
agentId |
string
Erforderlich. Die eindeutige Kennung des Agents.
|
Antworttext
Antwort mit Nutzerdaten zur RBM-Erreichbarkeit.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
| JSON-Darstellung |
{
"reachableUsers": [
string
],
"totalRandomSampleUserCount": integer,
"reachableRandomSampleUserCount": integer
} |
| Felder |
reachableUsers[] |
string
Liste der Telefonnummern von Nutzern, die RBM erreichen kann. Umfasst nur Nutzer von Mobilfunkanbietern, bei denen der Agent gestartet wurde.
|
totalRandomSampleUserCount |
integer
Anzahl der Telefonnummern, die zufällig aus reachableUsers ausgewählt wurden. Dieser Wert beträgt in der Regel ca. 75% der insgesamt angeforderten Telefonnummern. Dieser Wert ist 0, wenn die Anzahl der angeforderten Telefonnummern kleiner als 500 ist.
|
reachableRandomSampleUserCount |
integer
Anzahl der Telefonnummern aus der zufällig ausgewählten Liste, die unabhängig vom Aktivierungsstatus des Agents über RCS erreichbar sind. Das Verhältnis zwischen diesem Wert und totalRandomSampleUserCount kann die potenzielle Reichweite einer Liste von Nutzern annähern.
|
Autorisierungsbereiche
Erfordert den folgenden OAuth-Bereich:
https://www.googleapis.com/auth/rcsbusinessmessaging
Weitere Informationen finden Sie unter OAuth 2.0 Overview.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 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)."]]
