new_releases Aktualizacje: sprawdź
informacje o wersji, aby poznać nowe funkcje i aktualizacje.
Method: users.batchGet
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Pobiera numery telefonów obsługiwane przez RCS w przypadku listy użytkowników.
Zwracany ładunek zawiera listę numerów telefonów obsługiwanych przez RCS, które platforma RBM ma dostęp do danych określonych użytkowników. Zwrócone zostaną tylko te numery telefonów z obsługą RCS u operatora, u którego działa agent.
Zwrócony ładunek zawiera też wartości, których można użyć do oszacowania potencjalnego zasięgu listy numerów telefonów niezależnie od stanu uruchomienia agenta.
Maksymalnie 600 zapytań na minutę (QPM).
Żądanie HTTP
POST https://rcsbusinessmessaging.googleapis.com/v1/users:batchGet
Adres URL używa składni transkodowania gRPC.
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
| Zapis JSON |
{
"users": [
string
],
"agentId": string
} |
| Pola |
users[] |
string
Lista numerów telefonów użytkowników w formacie E.164.
|
agentId |
string
Wymagane. Unikalny identyfikator agenta.
|
Treść odpowiedzi
Odpowiedź z danymi użytkownika dotyczącymi zasięgu RBM.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
| Zapis JSON |
{
"reachableUsers": [
string
],
"totalRandomSampleUserCount": integer,
"reachableRandomSampleUserCount": integer
} |
| Pola |
reachableUsers[] |
string
Lista numerów telefonów użytkowników, z którymi RBM może się skontaktować. Obejmuje tylko użytkowników u tych operatorów, u których został uruchomiony agent.
|
totalRandomSampleUserCount |
integer
Liczba numerów telefonów wybranych losowo z: reachableUsers. Zwykle ta wartość stanowi ok. 75% łącznej liczby żądanych numerów telefonów. Jeśli liczba żądanych numerów telefonów jest mniejsza niż 500, ta wartość wynosi 0.
|
reachableRandomSampleUserCount |
integer
Liczba numerów telefonów z losowo wybranej listy, które są dostępne przez RCS u wszystkich operatorów bez względu na stan uruchamiania agenta. Stosunek tej wartości do wartości totalRandomSampleUserCount może przybliżyć potencjalny zasięg dla listy użytkowników.
|
Zakresy autoryzacji
Wymaga następującego zakresu OAuth:
https://www.googleapis.com/auth/rcsbusinessmessaging
Więcej informacji znajdziesz w OAuth 2.0 Overview.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 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)."]]
