new_releases التعديلات: يمكنك الاطّلاع على
ملاحظات الإصدار للتعرّف على الميزات الجديدة وتحديثات المنتجات.
Method: users.batchGet
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
الحصول على أرقام الهواتف المزوّدة بخدمة RCS لقائمة من المستخدمين
تحتوي الحمولة التي تم عرضها على قائمة بأرقام الهواتف المزوّدة بخدمة RCS والتي يمكن للمستخدمين المحدّدين الوصول إليها من خلال منصة RBM. لن يتم عرض سوى أرقام الهواتف المزوّدة بخدمة RCS لمشغِّل شبكة الجوّال الذي تم إطلاق الوكيل من خلاله.
تحتوي الحمولة المعروضة أيضًا على قيم يمكن استخدامها لتقدير مدى الوصول المحتمل لقائمة من أرقام الهواتف بغض النظر عن حالة إطلاق الوكيل.
600 طلب بحث في الدقيقة كحد أقصى (QPM).
طلب HTTP
POST https://rcsbusinessmessaging.googleapis.com/v1/users:batchGet
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
| تمثيل 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 تقريبًا من إجمالي أرقام الهواتف المطلوبة. تكون هذه القيمة 0 إذا كان عدد أرقام الهاتف المطلوبة أقل من 500.
|
reachableRandomSampleUserCount |
integer
عدد أرقام الهواتف من القائمة المختارة عشوائيًا والتي يمكن الوصول إليها عبر خدمات الاتصالات التفاعلية (RCS) على مستوى جميع مشغّلي شبكات الجوّال، بغض النظر عن حالة إطلاق الوكيل يمكن أن تقرّب النسبة بين هذه القيمة وtotalRandomSampleUserCount مدى الوصول المحتمل لقائمة من المستخدمين.
|
نطاقات التفويض
يجب توفير نطاق OAuth التالي:
https://www.googleapis.com/auth/rcsbusinessmessaging
لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\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)."]]
