Method: brands.agents.requestLaunch

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

درخواست HTTP

POST https://businesscommunications.googleapis.com/v1/{name=brands/*/agents/*}:requestLaunch

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

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

پارامترها
name

string

الزامی. شناسه منحصر به فرد نماینده. اگر شناسه برند "1234" و شناسه نماینده "5678" باشد، این پارامتر به "brands/1234/agents/5678" تبدیل می‌شود.

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "agentLaunch": {
    object (AgentLaunch)
  }
}
فیلدها
agentLaunch

object ( AgentLaunch )

الزامی. عامل راه‌اندازی شده برای ایجاد. نام و وضعیت راه‌اندازی نادیده گرفته می‌شوند.

بدنه پاسخ

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

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

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

  • https://www.googleapis.com/auth/businesscommunications

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .