new_releases بهروزرسانیها :
یادداشتهای انتشار را برای ویژگیهای جدید و بهروزرسانیهای محصول بررسی کنید.
Method: users.batchGet
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
شماره تلفن های دارای RCS را برای لیستی از کاربران دریافت می کند.
محموله برگشتی شامل فهرستی از شمارههای تلفن دارای RCS است که توسط پلتفرم RBM برای کاربران مشخص شده قابل دسترسی است. فقط شمارههای تلفنی که برای شرکت مخابراتی که نماینده در آن راهاندازی میشود، فعال باشد، برگردانده میشوند.
محموله برگشتی همچنین حاوی مقادیری است که میتوان از آنها برای تخمین دسترسی بالقوه فهرست شمارههای تلفن بدون توجه به وضعیت راهاندازی عامل استفاده کرد.
حداکثر 600 پرس و جو در دقیقه (QPM).
درخواست HTTP
POST https://rcsbusinessmessaging.googleapis.com/v1/users:batchGet
URL از دستور GRPC Transcoding استفاده می کند.
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"users": [
string
],
"agentId": string
} |
فیلدها |
---|
users[] | string لیست شماره تلفن کاربران با فرمت E.164. |
agentId | string مورد نیاز. شناسه منحصر به فرد عامل. |
بدن پاسخگو
پاسخ با داده های کاربر با قابلیت دسترسی RBM.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"reachableUsers": [
string
],
"totalRandomSampleUserCount": integer,
"reachableRandomSampleUserCount": integer
} |
فیلدها |
---|
reachableUsers[] | string لیست شماره تلفن کاربرانی که RBM می تواند به آنها دسترسی پیدا کند. فقط شامل کاربرانی در حامل هایی می شود که عامل در آنها راه اندازی شده است. |
totalRandomSampleUserCount | integer تعداد شماره تلفنهایی که بهطور تصادفی از reachableUsers انتخاب شدهاند. به طور معمول، این مقدار ~75٪ از کل شماره تلفن های درخواستی است. اگر تعداد شماره تلفن های درخواستی کمتر از 500 باشد، این مقدار 0 است. |
reachableRandomSampleUserCount | integer تعداد شمارههای تلفن از فهرستی که بهطور تصادفی انتخاب شدهاند، بدون در نظر گرفتن وضعیت راهاندازی نماینده، در همه شرکتهای مخابراتی قابل دسترسی با RCS هستند. نسبت بین این مقدار و totalRandomSampleUserCount می تواند دسترسی بالقوه برای لیستی از کاربران را تقریبی کند. |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/rcsbusinessmessaging
برای اطلاعات بیشتر، بهOAuth 2.0 Overview .
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی."],[[["\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)."]]