Method: users.availability.markAsDoNotDisturb

يضع علامة DO_NOT_DISTURB على المستخدم في Google Chat.

يضبط حالة توفّر المستخدم على DO_NOT_DISTURB حتى وقت انتهاء صلاحية محدّد. عند ضبط الحالة على DO_NOT_DISTURB، لن يتلقّى المستخدمون عادةً إشعارات.

لا تعدِّل هذه الطريقة سوى حالة توفّر المستخدم الذي تم التحقّق من هويته.

يتطلب مصادقة المستخدم باستخدام نطاق الأذونات:

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

طلب HTTP

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

يستخدم عنوان URL بنية تحويل الترميز إلى gRPC.

مَعلمات المسار

المعلمات
name

string

الحقل مطلوب. اسم مورد حالة التوفّر التي سيتم وضع علامة "عدم الإزعاج" عليها. التنسيق: users/{user}/availability

{user} هو رقم تعريف الشخص في People API أو Admin SDK Directory API. على سبيل المثال، users/123456789

يمكن أيضًا استخدام عنوان البريد الإلكتروني للمستخدم أو me كاسم مستعار للإشارة إلى المتصل. على سبيل المثال، users/user@example.com أو users/me

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

تمثيل JSON
{

  "expireTime": string,
  "ttl": string
}
الحقول
حقل الربط expiration الحقل مطلوب. وقت انتهاء صلاحية حالة التوفّر "عدم الإزعاج" سيتم وضع علامة "غير متوفّر" على المستخدم بعد انتهاء الصلاحية. يمكن أن يكون هذا الوقت سنة واحدة على الأكثر من الوقت الحالي. يمكن أن يكون expiration أحد الخيارَين التاليَين فقط:
expireTime

string (Timestamp format)

الطابع الزمني المطلق الذي تنتهي فيه صلاحية حالة "عدم الإزعاج"

ttl

string (Duration format)

المدة الزمنية من الوقت الحالي حتى انتهاء صلاحية حالة "عدم الإزعاج"

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نصها على مثال Availability.

نطاقات الأذونات

يجب توفير أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على دليل الأذونات.