किसी एजेंट को लॉन्च करने की प्रोसेस शुरू करता है. लॉन्च होने के बाद, एजेंट उपयोगकर्ताओं के लिए उपलब्ध होता है. एक एजेंट के पास, एक बार में लॉन्च करने का सिर्फ़ एक इंस्टेंस हो सकता है.
एचटीटीपी अनुरोध
POST https://businesscommunications.googleapis.com/v1/{name=brands/*/agents/*}:requestLaunch
यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ पैरामीटर
| पैरामीटर | |
|---|---|
name |
ज़रूरी है. एजेंट का यूनीक आइडेंटिफ़ायर. अगर ब्रैंड आइडेंटिफ़ायर "1234" और एजेंट आइडेंटिफ़ायर "5678" है, तो यह पैरामीटर "brands/1234/agents/5678" के तौर पर दिखता है. |
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर का डेटा शामिल होता है:
| JSON के काेड में दिखाना |
|---|
{
"agentLaunch": {
object ( |
| फ़ील्ड | |
|---|---|
agentLaunch |
ज़रूरी है. एजेंट को लॉन्च करने के लिए. नाम और लॉन्च की स्थिति को अनदेखा कर दिया जाता है. |
जवाब का मुख्य भाग
कामयाब रहने पर, जवाब के मुख्य हिस्से में AgentLaunch का एक इंस्टेंस शामिल किया जाता है.
अनुमति पाने के लिंक
नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:
https://www.googleapis.com/auth/businesscommunications
ज़्यादा जानकारी के लिए, OAuth 2.0 Overview देखें.