REST Resource: contactGroups

منبع: گروه تماس

یک گروه تماس

نمایندگی JSON
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (ContactGroupMetadata)
  },
  "groupType": enum (GroupType),
  "name": string,
  "formattedName": string,
  "memberResourceNames": [
    string
  ],
  "memberCount": integer,
  "clientData": [
    {
      object (GroupClientData)
    }
  ]
}
زمینه های
resourceName

string

نام منبع برای گروه تماس، اختصاص داده شده توسط سرور. یک رشته ASCII، به شکل contactGroups/{contactGroupId} .

etag

string

تگ موجودیت HTTP منبع. برای اعتبار سنجی وب کش استفاده می شود.

metadata

object ( ContactGroupMetadata )

فقط خروجی فراداده درباره گروه تماس

groupType

enum ( GroupType )

فقط خروجی نوع گروه تماس

name

string

نام گروه مخاطب که توسط مالک گروه تنظیم شده است یا نامی که سیستم برای گروه های سیستم ارائه کرده است.

برای contactGroups.create یا contactGroups.update نام باید منحصر به گروه مخاطبین کاربر باشد. تلاش برای ایجاد یک گروه با نام تکراری، خطای HTTP 409 را برمی‌گرداند.

formattedName

string

فقط خروجی نام ترجمه و قالب‌بندی شده در محلی حساب بیننده یا Accept-Language هدر HTTP برای نام‌های گروه‌های سیستم. نام‌های گروهی که توسط مالک تعیین می‌شوند، همان نام هستند.

memberResourceNames[]

string

فقط خروجی فهرست نام منابع افراد مخاطب که اعضای گروه تماس هستند. این فیلد فقط برای درخواست‌های GET پر شده است و فقط به تعداد maxMembers در درخواست دریافت، اعضا را برمی‌گرداند.

memberCount

integer

فقط خروجی تعداد کل مخاطبین گروه بدون توجه به حداکثر اعضای مشخص شده در درخواست.

clientData[]

object ( GroupClientData )

داده های مشتری گروه

ContactGroupMetadata

فراداده در مورد یک گروه تماس.

نمایندگی JSON
{
  "updateTime": string,
  "deleted": boolean
}
زمینه های
updateTime

string ( Timestamp format)

فقط خروجی آخرین زمانی که گروه به روز شد.

یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

deleted

boolean

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

نوع گروه

نوع گروه تماس

Enums
GROUP_TYPE_UNSPECIFIED نامشخص
USER_CONTACT_GROUP گروه مخاطب تعریف شده توسط کاربر
SYSTEM_CONTACT_GROUP گروه تماس تعریف شده از سیستم.

GroupClientData

داده های مشتری دلخواه که توسط مشتریان پر می شود. کلیدها و مقادیر تکراری مجاز هستند.

نمایندگی JSON
{
  "key": string,
  "value": string
}
زمینه های
key

string

کلید مشخص شده توسط مشتری از داده های مشتری.

value

string

مشتری مقدار داده های مشتری را مشخص کرده است.

مواد و روش ها

batchGet

 با مشخص کردن لیستی از نام منابع گروه تماس، فهرستی از گروه های مخاطب متعلق به کاربر تأیید شده را دریافت کنید.

create

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

delete

 با تعیین نام منبع گروه مخاطب، گروه تماس موجود متعلق به کاربر تأیید شده را حذف کنید.

get

 با تعیین نام منبع گروه تماس، یک گروه تماس خاص متعلق به کاربر تأیید شده دریافت کنید.

list

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

update

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