Method: users.availability.get

اطلاعات در دسترس بودن برای یک کاربر انسانی در Google Chat را برمی‌گرداند. برای مثال، می‌توان از این برای بررسی آنلاین یا غایب بودن کاربر یا بازیابی پیام وضعیت سفارشی او استفاده کرد.

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

نیاز به احراز هویت کاربر با یکی از حوزه‌های مجوز زیر دارد:

  • https://www.googleapis.com/auth/chat.users.availability.readonly
  • https://www.googleapis.com/auth/chat.users.availability

درخواست HTTP

GET https://chat.googleapis.com/v1/{name=users/*/availability}

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

پارامترهای مسیر

پارامترها
name

string

الزامی. نام منبعی که قرار است بازیابی شود.

قالب: users/{user}/availability

{user} شناسه‌ی Person در People API یا Admin SDK directory API است. برای مثال، users/123456789 .

آدرس ایمیل کاربر یا me نیز می‌تواند به عنوان نام مستعار برای اشاره به تماس‌گیرنده استفاده شود. برای مثال، users/user@example.com یا users/me .

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

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

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

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

  • https://www.googleapis.com/auth/chat.users.availability
  • https://www.googleapis.com/auth/chat.users.availability.readonly

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.