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

ज़रूरी है. वह नाम जो एजेंट, लोगों को दिखाता है. ज़्यादा से ज़्यादा 40 वर्ण.

एजेंट की पुष्टि हो जाने के बाद, इसमें बदलाव नहीं किया जा सकता.
brandName

string

सिर्फ़ आउटपुट के लिए. एजेंट से जुड़े ब्रैंड का नाम.
isArchived

boolean

ज़रूरी नहीं. अगर true है, तो एजेंट को संग्रहित कर दिया जाता है और डिफ़ॉल्ट रूप से, सूची के नतीजों में शामिल नहीं किया जाता.

यूनियन फ़ील्ड detail_info. इसमें किसी खास प्रॉडक्ट के लिए ज़रूरी फ़ील्ड शामिल होते हैं.

ज़रूरी है. detail_info इनमें से सिर्फ़ एक हो सकता है:
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

RCS for Business के लिए एजेंट की पूरी जानकारी.

RcsBusinessMessagingAgent

एजेंट की जानकारी, खास तौर पर RCS for Business से जुड़ी हुई. एजेंट बनाने के लिए, हमारा सुझाव है कि आप कम से कम एक संपर्क जानकारी (फ़ोन, ईमेल या वेबसाइट) दें. साथ ही, उसके लिए सही लेबल चुनें. एजेंट को लॉन्च करने के लिए, कम से कम एक संपर्क जानकारी (फ़ोन, ईमेल या वेबसाइट) और उससे जुड़ा लेबल देना ज़रूरी है.

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

ज़रूरी है. उपयोगकर्ताओं को दिखने वाले एजेंट के बारे में जानकारी. ज़्यादा से ज़्यादा 100 वर्ण. ज़रूरी शर्तों के बारे में ज़्यादा जानने के लिए, एजेंट की जानकारी में बदलाव करना लेख पढ़ें.
logoUri

string

ज़रूरी है. एजेंट के लोगो का सार्वजनिक तौर पर उपलब्ध यूआरएल. ज़्यादा से ज़्यादा 50 केबी.

एजेंट की पुष्टि हो जाने के बाद, इसमें बदलाव नहीं किया जा सकता.
heroUri

string

ज़रूरी है. एजेंट के लिए हीरो इमेज का सार्वजनिक तौर पर उपलब्ध यूआरएल. ज़्यादा से ज़्यादा 200 केबी.

एजेंट की पुष्टि हो जाने के बाद, इसमें बदलाव नहीं किया जा सकता.
phoneNumbers[]

object (PhoneEntry)

ज़रूरी नहीं. एजेंट से जुड़े फ़ोन नंबर. अगर ईमेल और वेबसाइट नहीं दी गई हैं, तो यह जानकारी देना ज़रूरी है.
emails[]

object (EmailEntry)

ज़रूरी नहीं. एजेंट से जुड़े ईमेल पते. अगर फ़ोन नंबर और वेबसाइट का लिंक नहीं दिया गया है, तो यह जानकारी देना ज़रूरी है.
websites[]

object (WebEntry)

ज़रूरी नहीं. एजेंट से जुड़ी वेबसाइटें. ज़्यादा से ज़्यादा 3. अगर फ़ोन नंबर और ईमेल पता नहीं दिया गया है, तो यह जानकारी देना ज़रूरी है.
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

ज़रूरी नहीं. भारत में, एजेंट से जुड़े कारोबार की मुख्य इकाई का आइडेंटिफ़ायर (पीई आईडी). अगर आपको भारत में एजेंट लॉन्च करना है, तो यह जानकारी देना ज़रूरी है.

PhoneEntry

एजेंट से जुड़ा फ़ोन नंबर.

JSON के काेड में दिखाना 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
फ़ील्ड
phoneNumber

object (Phone)

ज़रूरी है. फ़ोन नंबर दो फ़ॉर्मैट में हो सकता है: पूरा E.164 फ़ॉर्मैट (उदाहरण के लिए, "+12223334444") या बिना फ़ॉर्मैट किया गया लोकल/टोल-फ़्री फ़ोन नंबर, जिसमें '+', प्रीफ़िक्स या देश का कोड शामिल न हो (उदाहरण के लिए, "6502530000"). ध्यान दें: आपातकालीन नंबरों की अनुमति नहीं है.
label

string

ज़रूरी है. फ़ोन नंबर के लिए लेबल.

EmailEntry

एजेंट से जुड़ा ईमेल पता.

JSON के काेड में दिखाना 
{
  "address": string,
  "label": string
}
फ़ील्ड
address

string

ज़रूरी है. ईमेल पता.
label

string

ज़रूरी है. ईमेल पते के लिए लेबल.

WebEntry

एजेंट से जुड़ा वेब पर मौजूद संसाधन.

JSON के काेड में दिखाना 
{
  "uri": string,
  "label": string
}
फ़ील्ड
uri

string

ज़रूरी है. एजेंट से जुड़ा ऐसा यूआरआई जिसे सार्वजनिक तौर पर ऐक्सेस किया जा सकता हो. एचटीटीपी या एचटीटीपीएस प्रोटोकॉल का इस्तेमाल करना ज़रूरी है.
label

string

websites के लिए ज़रूरी है, दूसरे कामों के लिए नहीं. यूआरआई के लिए लेबल.

RcsBusinessMessagingAgentBillingConfig

एजेंट के लिए बिलिंग कॉन्फ़िगरेशन.

JSON के काेड में दिखाना 
{
  "billingCategory": enum (BillingCategory)
}
फ़ील्ड
billingCategory

enum (BillingCategory)

एजेंट के लिए बिलिंग की कैटगरी.

BillingCategory

बिलिंग की कैटगरी, जिनके लिए यह सुविधा उपलब्ध है.

Enums
BILLING_CATEGORY_UNSPECIFIED कैटगरी मौजूद नहीं है.
CONVERSATIONAL_LEGACY

मौजूदा एजेंट के बिलिंग कॉन्फ़िगरेशन के साथ काम करने वाली लेगसी कैटगरी. इसके बजाय, CONVERSATIONAL का इस्तेमाल करें.
CONVERSATIONAL इसे लंबे और ज़्यादा मुश्किल सेशन के लिए डिज़ाइन किया गया है. इनमें उपयोगकर्ता और ब्रैंड के बीच कई मैसेज का आदान-प्रदान होता है.
SINGLE_MESSAGE

एसएमएस की जगह, मैसेजिंग का बेहतर अनुभव देता है. इसे कभी भी बातचीत वाले कॉल के तौर पर बिल नहीं किया जाता.
BASIC_MESSAGE

बिलिंग मॉडल, एसएमएस की तरह ही होता है. इसे कभी भी बातचीत वाले कॉल के तौर पर बिल नहीं किया जाता.
NON_CONVERSATIONAL यह नॉन-कन्वर्सेशनल बिलिंग कैटगरी को दिखाता है. यह लेगसी कैटगरी SINGLE_MESSAGE और BASIC_MESSAGE की जगह इस्तेमाल की जाती है. यह उन एजेंट के लिए है जो मुख्य रूप से एकतरफ़ा (A2P) बातचीत करते हैं.

AgentUseCase

स्टोरेज में इस्तेमाल किए गए एजेंट के इस्तेमाल के उदाहरण.

Enums
AGENT_USE_CASE_UNSPECIFIED इस्तेमाल का उदाहरण नहीं दिया गया है.
TRANSACTIONAL ऐसे एजेंट जो सिर्फ़ ज़रूरी, काम के, और समय के हिसाब से संवेदनशील मैसेज भेजते हैं.
PROMOTIONAL ऐसे एजेंट जो बिक्री, मार्केटिंग, और प्रमोशन से जुड़े मैसेज भेजते हैं. डिफ़ॉल्ट टाइप.
OTP ऐसे एजेंट जो सिर्फ़ एक बार इस्तेमाल किए जाने वाले पासवर्ड भेजते हैं.
MULTI_USE ऐसे एजेंट जिनका इस्तेमाल कई कामों के लिए किया जा सकता है. इसमें ऐसे एजेंट शामिल हैं जिनमें इस्तेमाल का एक उदाहरण तुरंत लॉन्च किया जाता है, जबकि दूसरे को आने वाले समय में रिलीज़ करने का प्लान बनाया जाता है. ज़्यादा जानकारी के लिए, एक से ज़्यादा बार इस्तेमाल किए जा सकने वाले दस्तावेज़ देखें.

HostingRegion

किसी एजेंट के लिए होस्टिंग के संभावित क्षेत्र. इनका इस्तेमाल, P2A मैसेज को क्षेत्र के हिसाब से सर्वर पर सही तरीके से रूट करने के लिए किया जाता है.

Enums
HOSTING_REGION_UNSPECIFIED होस्ट करने का इलाका तय नहीं किया गया है.
NORTH_AMERICA उत्तरी अमेरिका.
EUROPE यूरोप.
ASIA_PACIFIC एशिया पैसिफ़िक.

PartnerEntry

एजेंट से जुड़ा पार्टनर.

JSON के काेड में दिखाना 
{
  "partnerId": string,
  "displayName": string,
  "company": string
}
फ़ील्ड
partnerId

string

सिर्फ़ आउटपुट के लिए. पार्टनर के लिए यूनीक आइडेंटिफ़ायर.
displayName

string

सिर्फ़ आउटपुट के लिए. वह नाम जो कारोबारों को दिखाया जाएगा, ताकि वे प्रॉडक्ट के लिए पार्टनर को जोड़ सकें. यह पार्टनर के बीच यूनीक होना चाहिए.
company

string

सिर्फ़ आउटपुट के लिए. दिए गए पार्टनर के लिए, कंपनी का सार्वजनिक नाम.

RcsBusinessMessagingRegionLaunch

हर इलाके के लिए, RCS for Business एजेंट लॉन्च करने के बारे में जानकारी.

JSON के काेड में दिखाना 
{
  "launchState": enum (LaunchState),
  "comment": string,
  "updateTime": string,
  "isHidden": boolean
}
फ़ील्ड
launchState

enum (LaunchState)

किसी इलाके के लिए लॉन्च की स्थिति.
comment

string

मोबाइल और इंटरनेट सेवा देने वाली कंपनी की टिप्पणी.
updateTime

string (Timestamp format)

पिछली बार अपडेट करने का समय.

यह आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".
isHidden

boolean

ज़रूरी नहीं. इससे यह तय होता है कि एजेंट को कैरियर के लिए छिपाया गया है या नहीं. इससे कंसोल और एपीआई व्यू की दृश्यता पर असर पड़ता है.

LaunchState

किसी इकाई के लॉन्च की स्थिति. कैरियर और पार्टनर, दोनों के लिए लॉन्च की स्थिति में बदलाव करने की अनुमति के बारे में जानने के लिए, इवेंट पाना लेख पढ़ें.

Enums
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 My Business लिस्टिंग में मैसेज भेजने की सुविधा काम नहीं करती. Google My Business में फिर से पुष्टि करने पर, यह सुविधा अपने-आप फिर से चालू हो जाती है. यह सिर्फ़ जगहों के लिए लागू होता है.

तरीके

create

 यह किसी ब्रैंड को दिखाने के लिए, नया एजेंट बनाता है.

delete
(deprecated)

 हटा दिया गया: एजेंट को मिटाने की सुविधा हटा दी गई है.

get

 किसी एजेंट के बारे में जानकारी पाना.

getLaunch

 किसी एजेंट के लॉन्च की जानकारी मिलती है.

getVerification

 किसी एजेंट की पुष्टि करने के लिए दी गई जानकारी मिलती है.

list

 किसी ब्रैंड से जुड़े सभी एजेंट की सूची दिखाता है.

patch

 यह एजेंट के बारे में जानकारी अपडेट करता है.

requestLaunch

 किसी एजेंट को लॉन्च करने की प्रोसेस शुरू करता है.

requestVerification

 यह कुकी, किसी एजेंट के कारोबार की पुष्टि करने के लिए जानकारी सबमिट करती है.

updateLaunch

 किसी एजेंट के लिए लॉन्च की जानकारी अपडेट करता है.

updateVerification

 यह एजेंट की पुष्टि की स्थिति को अपडेट करता है.