REST Resource: brands.agents

منبع: نماینده

یک نهاد محاوره‌ای که نماینده یک برند است.

نمایش JSON 
{
  "name": string,
  "displayName": string,
  "brandName": string,
  "isArchived": boolean,

  // Union field detail_info can be only one of the following:
  "rcsBusinessMessagingAgent": {
    object (RcsBusinessMessagingAgent)
  }
  // End of list of possible types for union field detail_info.
}
فیلدها
name

string

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

فقط خواندنی. تعریف شده توسط پلتفرم.

displayName

string

الزامی. نامی که عامل به کاربران نمایش می‌دهد. حداکثر ۴۰ کاراکتر.

پس از تأیید نماینده قابل تغییر نیست.

brandName

string

فقط خروجی. نام تجاری مرتبط با نماینده.

isArchived

boolean

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

فیلد union detail_info . شامل فیلدهای مورد نیاز برای محصول خاص است.

الزامی. detail_info فقط می‌تواند یکی از موارد زیر باشد:

rcsBusinessMessagingAgent

object ( RcsBusinessMessagingAgent )

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

RcsBusinessMessagingAgent

اطلاعات نماینده به طور خاص مربوط به RCS برای کسب و کار. برای ایجاد نماینده، توصیه می‌شود حداقل یک روش تماس (تلفن، ایمیل یا وب‌سایت) با برچسب مربوطه ارائه دهید. برای راه‌اندازی نماینده، حداقل یک روش تماس (تلفن، ایمیل یا وب‌سایت) با برچسب مربوطه مورد نیاز است.

نمایش JSON 
{
  "description": string,
  "logoUri": string,
  "heroUri": string,
  "phoneNumbers": [
    {
      object (PhoneEntry)
    }
  ],
  "emails": [
    {
      object (EmailEntry)
    }
  ],
  "websites": [
    {
      object (WebEntry)
    }
  ],
  "privacy": {
    object (WebEntry)
  },
  "termsConditions": {
    object (WebEntry)
  },
  "color": string,
  "billingConfig": {
    object (RcsBusinessMessagingAgentBillingConfig)
  },
  "agentUseCase": enum (AgentUseCase),
  "hostingRegion": enum (HostingRegion),
  "partner": {
    object (PartnerEntry)
  },
  "launchDetails": {
    string: {
      object (RcsBusinessMessagingRegionLaunch)
    },
    ...
  },
  "indiaPrincipalEntityId": string
}
فیلدها
description

string

الزامی. توضیحات مربوط به نماینده که برای کاربران قابل مشاهده است. حداکثر ۱۰۰ کاراکتر. برای جزئیات بیشتر به ویرایش اطلاعات نماینده مراجعه کنید.

logoUri

string

الزامی. آدرس اینترنتی (URL) لوگوی نماینده که برای عموم قابل دسترس باشد. حداکثر ۵۰ کیلوبایت.

پس از تأیید نماینده قابل تغییر نیست.

heroUri

string

الزامی. آدرس اینترنتی (URL) تصویر قهرمان (hero image) برای عامل (agent) که به صورت عمومی در دسترس باشد. حداکثر ۲۰۰ کیلوبایت.

پس از تأیید نماینده قابل تغییر نیست.

phoneNumbers[]

object ( PhoneEntry )

اختیاری. شماره تلفن‌های مرتبط با نماینده. در صورت عدم ارائه ایمیل و وب‌سایت، الزامی است.

emails[]

object ( EmailEntry )

اختیاری. آدرس‌های ایمیل مرتبط با نماینده. در صورت عدم ارائه شماره تلفن و وب‌سایت، الزامی است.

websites[]

object ( WebEntry )

اختیاری. وب‌سایت‌های مرتبط با نماینده. حداکثر ۳. در صورت عدم ارائه شماره تلفن و ایمیل، الزامی است.

privacy

object ( WebEntry )

الزامی. سیاست حفظ حریم خصوصی مرتبط با نماینده.

termsConditions

object ( WebEntry )

الزامی. شرایط و ضوابط مرتبط با نماینده.

color

string

الزامی. رنگ تم عامل که برای کاربران با فرمت هگز قابل مشاهده است. به عنوان مثال، #FF6347.

billingConfig

object ( RcsBusinessMessagingAgentBillingConfig )

الزامی. پیکربندی صورتحساب برای نماینده.

agentUseCase

enum ( AgentUseCase )

اختیاری. مورد استفاده ربات.

hostingRegion

enum ( HostingRegion )

الزامی. منطقه میزبانی برای یک نماینده.

partner

object ( PartnerEntry )

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

launchDetails

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

فقط خروجی. جزئیات راه‌اندازی برای اپراتور. فقط برای اپراتورها و فقط با جزئیات راه‌اندازی مربوط به اپراتوری که تماس را برقرار می‌کند، پر می‌شود.

indiaPrincipalEntityId

string

اختیاری. شناسه نهاد اصلی کسب و کار در هند (PE ID) کسب و کار مرتبط با نماینده. در صورت برنامه ریزی برای راه اندازی نماینده در هند، الزامی است.

ورود تلفن

شماره تلفنی که به نماینده مربوطه متصل است.

نمایش JSON 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
فیلدها
phoneNumber

object ( Phone )

الزامی. شماره تلفن در دو قالب ممکن: یا قالب کامل E.164 (برای مثال، "+12223334444") یا یک شماره تلفن محلی/رایگان بدون قالب‌بندی بدون '+'، پیشوند یا کد کشور (برای مثال، "6502530000"). توجه: شماره‌های اضطراری مجاز نیستند.

label

string

الزامی. برچسب برای شماره تلفن.

ورود ایمیل

ایمیلی که با نماینده مرتبط است.

نمایش JSON 
{
  "address": string,
  "label": string
}
فیلدها
address

string

الزامی. یک آدرس ایمیل.

label

string

الزامی. برچسب برای آدرس ایمیل.

ورود به وب

یک منبع مبتنی بر وب مرتبط با عامل.

نمایش JSON 
{
  "uri": string,
  "label": string
}
فیلدها
uri

string

الزامی. یک URI عمومی مرتبط با عامل. باید از پروتکل HTTP یا HTTPS استفاده کند.

label

string

برای websites الزامی است، در غیر این صورت اختیاری است. برچسب برای آدرس اینترنتی (URI).

پیکربندی RcsBusinessMessagingAgentBillingConfig

پیکربندی صورتحساب برای نماینده.

نمایش JSON 
{
  "billingCategory": enum (BillingCategory)
}
فیلدها
billingCategory

enum ( BillingCategory )

دسته بندی صورتحساب برای نماینده.

دسته بندی صورتحساب

دسته‌های صورتحساب پشتیبانی‌شده

انوم‌ها
BILLING_CATEGORY_UNSPECIFIED دسته بندی مشخص نشده است.
CONVERSATIONAL_LEGACY

دسته بندی قدیمی برای پشتیبانی از پیکربندی صورتحساب نمایندگان موجود. به جای آن CONVERSATIONAL استفاده کنید.

CONVERSATIONAL برای جلسات طولانی‌تر و پیچیده‌تر طراحی شده است که در آن کاربر و برند مجموعه‌ای از پیام‌ها را رد و بدل می‌کنند.
SINGLE_MESSAGE

جایگزین پیامک با یک تجربه پیام‌رسانی غنی‌تر می‌شود. هرگز به عنوان یک ابزار مکالمه‌ای معرفی نشده است.

BASIC_MESSAGE

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

NON_CONVERSATIONAL نشان‌دهنده یک دسته‌بندی صورتحساب غیر محاوره‌ای است که جایگزین دسته‌بندی‌های قدیمی SINGLE_MESSAGE و BASIC_MESSAGE می‌شود. این برای اپراتورهایی است که عمدتاً در ارتباط یک‌طرفه (A2P) فعالیت می‌کنند.

مورد استفاده عامل

انواع موارد استفاده عامل مورد استفاده در ذخیره‌سازی.

انوم‌ها
AGENT_USE_CASE_UNSPECIFIED مورد استفاده مشخص نشده است.
TRANSACTIONAL مأمورانی که فقط پیام‌های ضروری، لازم و حساس به زمان ارسال می‌کنند.
PROMOTIONAL نمایندگانی که پیام‌های فروش، بازاریابی و تبلیغاتی ارسال می‌کنند. نوع پیش‌فرض.
OTP نمایندگانی که فقط رمزهای عبور یکبار مصرف ارسال می‌کنند.
MULTI_USE عامل‌هایی که چندین مورد استفاده دارند. این شامل عامل‌هایی می‌شود که یک مورد استفاده آنها بلافاصله راه‌اندازی می‌شود، در حالی که مورد استفاده دوم برای انتشار در آینده برنامه‌ریزی شده است. برای اطلاعات بیشتر، به مستندات چند منظوره مراجعه کنید.

هاستینگ ریجن

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

انوم‌ها
HOSTING_REGION_UNSPECIFIED منطقه میزبانی نامشخص.
NORTH_AMERICA آمریکای شمالی.
EUROPE اروپا.
ASIA_PACIFIC آسیا و اقیانوسیه.

ورود شریک

شریک مرتبط با نماینده.

نمایش JSON 
{
  "partnerId": string,
  "displayName": string,
  "company": string
}
فیلدها
partnerId

string

فقط خروجی. شناسه منحصر به فرد برای شریک.

displayName

string

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

company

string

فقط خروجی. نام عمومی شرکت برای شریک داده شده.

Rcsکسب و کارپیام رسانیمنطقهراه اندازی

جزئیات مربوط به راه‌اندازی نمایندگی RCS for Business برای هر منطقه.

نمایش JSON 
{
  "launchState": enum (LaunchState),
  "comment": string,
  "updateTime": string,
  "isHidden": boolean
}
فیلدها
launchState

enum ( LaunchState )

وضعیت پرتاب برای یک منطقه.

comment

string

نظر از شرکت مخابراتی.

updateTime

string ( Timestamp format)

آخرین زمان به‌روزرسانی.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

isHidden

boolean

اختیاری. مشخص می‌کند که آیا عامل برای حامل به عنوان پنهان علامت‌گذاری شده است یا خیر، که بر قابلیت مشاهده نماهای کنسول و API تأثیر می‌گذارد.

لانچ‌استیت

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

انوم‌ها
LAUNCH_STATE_UNSPECIFIED حالت نامشخص.
LAUNCH_STATE_UNLAUNCHED نهاد راه‌اندازی نشده است.
LAUNCH_STATE_PENDING راه‌اندازی در حال بررسی.
LAUNCH_STATE_LAUNCHED راه اندازی شد.
LAUNCH_STATE_REJECTED پرتاب رد شده است.
LAUNCH_STATE_SUSPENDED پرتاب به حالت تعلیق درآمده است.
LAUNCH_STATE_PENDING_UNLAUNCH

منسوخ شده: این حالت دیگر استفاده نمی‌شود.

در حال بررسی، از حالت اجرا خارج شوید.

LAUNCH_STATE_INVALID_IN_GMB

منسوخ شده: این حالت دیگر استفاده نمی‌شود.

راه‌اندازی نامعتبر است زیرا فهرست مرتبط «Google برای کسب‌وکار من» از پیام‌رسانی پشتیبانی نمی‌کند. تأیید مجدد در «Google برای کسب‌وکار من» به‌طور خودکار در اینجا دوباره راه‌اندازی می‌شود. فقط برای مکان‌ها قابل اجرا است.

روش‌ها

create

 یک نماینده جدید برای نمایندگی یک برند ایجاد می‌کند.

delete
(deprecated)

 منسوخ شده: حذف عامل منسوخ شده است.

get

 در مورد یک نماینده اطلاعات کسب کنید.

getLaunch

 اطلاعات راه‌اندازی یک عامل را دریافت می‌کند.

getVerification

 اطلاعات تأیید را برای یک نماینده دریافت می‌کند.

list

 تمام عوامل مرتبط با یک برند را فهرست می‌کند.

patch

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

requestLaunch

 فرآیند راه‌اندازی برای یک عامل را آغاز می‌کند.

requestVerification

 اطلاعات تأیید کسب و کار را برای یک نماینده ارسال می‌کند.

updateLaunch

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

updateVerification

 وضعیت تأیید را برای یک عامل به‌روزرسانی می‌کند.