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 مراجعه کنید.