Method: users.batchGet

شماره تلفن‌های دارای قابلیت RCS را برای فهرستی از کاربران دریافت می‌کند.

فایل ارسالی شامل فهرستی از شماره تلفن‌های دارای قابلیت RCS است که توسط پلتفرم RCS for Business برای کاربران مشخص‌شده قابل دسترسی هستند. فقط شماره تلفن‌هایی که برای اپراتوری که عامل روی آن راه‌اندازی شده است، دارای قابلیت RCS باشند، بازگردانده می‌شوند.

بار داده‌ی بازگردانده شده همچنین حاوی مقادیری است که می‌توان از آنها برای تخمین میزان دسترسی بالقوه به لیستی از شماره تلفن‌ها، صرف نظر از وضعیت راه‌اندازی عامل، استفاده کرد.

حداکثر 600 پرس و جو در دقیقه (QPM).

مهم: متد users.batchGet نیاز به استفاده از نقاط انتهایی منطقه‌ای دارد. درخواست‌ها باید شامل شماره تلفن‌هایی از یک منطقه جغرافیایی واحد باشند. ارسال شماره تلفن از چندین منطقه در یک درخواست واحد یا ارسال به نقطه انتهایی منطقه‌ای نادرست منجر به خطای 400 Bad Request خواهد شد.

نقاط پایانی منطقه‌ای:

درخواست HTTP

POST https://rcsbusinessmessaging.googleapis.com/v1/users:batchGet

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "users": [
    string
  ],
  "agentId": string
}
فیلدها
users[]

string

فهرست شماره تلفن‌های کاربران با فرمت E.164.

تمام شماره تلفن‌های موجود در یک درخواست باید متعلق به یک منطقه جغرافیایی باشند. درخواست‌هایی که حاوی شماره تلفن از چندین منطقه باشند یا به نقطه پایانی منطقه‌ای نادرست ارسال شوند، با خطای 400 Bad Request مواجه خواهند شد.

agentId

string

الزامی. شناسه منحصر به فرد عامل.

بدنه پاسخ

پاسخ با داده‌های دسترسی کاربر برای RCS برای کسب‌وکار.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer,
  "reachableUsersMap": {
    string: {
      object (ReachableUsers)
    },
    ...
  }
}
فیلدها
reachableUsers[]

string

فهرست شماره تلفن‌های کاربرانی که RCS for Business می‌تواند با آنها تماس بگیرد. فقط شامل کاربرانی می‌شود که اپراتورشان روی آنها راه‌اندازی شده است.

totalRandomSampleUserCount

integer

تعداد شماره تلفن‌هایی که به طور تصادفی از بین reachableUsers انتخاب شده‌اند. معمولاً این مقدار حدود ۷۵٪ از کل شماره تلفن‌های درخواستی است. اگر تعداد شماره تلفن‌های درخواستی کمتر از ۵۰۰ باشد، این مقدار 0 است.

reachableRandomSampleUserCount

integer

تعداد شماره تلفن‌هایی از لیست تصادفی انتخاب شده که صرف نظر از وضعیت راه‌اندازی اپراتور، از طریق RCS در تمام اپراتورها قابل دسترسی هستند. نسبت بین این مقدار و totalRandomSampleUserCount می‌تواند تقریباً میزان دسترسی بالقوه برای یک لیست از کاربران را نشان دهد.

reachableUsersMap

map (key: string, value: object ( ReachableUsers ))

فقط خروجی. نگاشت شناسه اپراتور به لیستی از کاربران قابل دسترسی در آن اپراتور. این فیلد فقط برای شماره تلفن‌های ایالات متحده پر می‌شود.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/rcsbusinessmessaging

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

کاربران قابل دسترسی

فهرستی از کاربران قابل دسترسی در یک اپراتور خاص.

نمایش JSON 
{
  "reachableUsers": [
    string
  ]
}
فیلدها
reachableUsers[]

string

فهرستی از کاربران قابل دسترسی در یک اپراتور خاص. این فیلد فقط برای شماره تلفن‌های ایالات متحده پر می‌شود.