संसाधन: AgentMessage
एजेंट से किसी उपयोगकर्ता को भेजा गया मैसेज.
जेएसओएन के काेड में दिखाना |
---|
{ "name": string, "sendTime": string, "contentMessage": { object ( |
फ़ील्ड | |
---|---|
name |
यह फ़ील्ड, आरबीएम प्लैटफ़ॉर्म से सेट करता है. एजेंट को मैसेज बनाते समय, इस मैसेज को शामिल न करें. इस फ़ील्ड में "phone/{E.164}/agentMessages/{messageId}" दिखाया जाता है. इसमें {E.164}, E.164 फ़ॉर्मैट में उपयोगकर्ता का फ़ोन नंबर है और एजेंट मैसेज के लिए एजेंट को असाइन किया गया आईडी {messageId} है. |
sendTime |
यह फ़ील्ड, आरबीएम प्लैटफ़ॉर्म से सेट करता है. एजेंट को मैसेज बनाते समय, इस मैसेज को शामिल न करें. इस फ़ील्ड से, उपयोगकर्ता को मैसेज भेजे जाने के समय का पता चलता है. RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड का रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक हो सकते हैं. उदाहरण: |
contentMessage |
एजेंट के मैसेज का कॉन्टेंट. |
यूनियन फ़ील्ड
|
|
expireTime |
ज़रूरी नहीं. यूटीसी में उस समय का टाइमस्टैंप जब इस संसाधन की समयसीमा खत्म हो जाती है. अगर यह वैल्यू सेट है या TTL (टीटीएल) फ़ील्ड सेट है, तो आउटपुट पर यह वैल्यू दी जाती है. RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड का रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक हो सकते हैं. उदाहरण: |
ttl |
ज़रूरी नहीं. सिर्फ़ इनपुट. अपने-आप निरस्त होने से पहले मैसेज कितने समय तक बना रहेगा. सेकंड में दी गई अवधि, जिसमें नौ भिन्नांक हो सकते हैं. साथ ही, यह ' |
AgentContentMessage
एजेंट से किसी उपयोगकर्ता को भेजे गए मैसेज का कॉन्टेंट.
जेएसओएन के काेड में दिखाना |
---|
{ "suggestions": [ { object ( |
फ़ील्ड | |
---|---|
suggestions[] |
सुझाए गए जवाबों और सुझाई गई कार्रवाइयों की सूची. यह सूची, संबंधित एजेंट के मैसेज के बाद सुझाव चिप की सूची के तौर पर दिखती है. ज़्यादा से ज़्यादा 11 सुझाव. ये चिप सिर्फ़ तब दिखते हैं, जब किसी एजेंट से जुड़ा मैसेज, बातचीत में सबसे हाल का मैसेज हो. इसमें एजेंट और उपयोगकर्ता के मैसेज, दोनों शामिल हैं. डिवाइस पर नेटिव ऐक्शन शुरू करने के लिए, उपयोगकर्ता सुझाए गए जवाब पर टैप करके, मैसेज का जवाब वापस एजेंट को भेज सकता है. इसके अलावा, उपयोगकर्ता सुझाई गई किसी कार्रवाई पर टैप भी कर सकता है. |
यूनियन फ़ील्ड content . एजेंट मैसेज content का कॉन्टेंट, इनमें से सिर्फ़ एक हो सकता है: |
|
text |
टेक्स्ट को UTF-8 में एन्कोड किया गया. |
fileName |
फ़ाइल का यूनीक नाम. जब कोई एजेंट फ़ाइल अपलोड करता है, तो आरबीएम प्लैटफ़ॉर्म फ़ाइल का नाम दिखाता है. नीचे अपलोड किए गए RbmFile के समर्थन में बहिष्कृत किया गया |
uploadedRbmFile |
इसमें उस फ़ाइल और थंबनेल के लिए आइडेंटिफ़ायर शामिल होते हैं जिन्हें आरबीएम सर्वर पर अपलोड करता है और दिखाता है |
richCard |
स्टैंडअलोन रिच कार्ड. |
contentInfo |
फ़ाइल के बारे में जानकारी, जिसमें फ़ाइल का यूआरएल और उसके थंबनेल का यूआरएल शामिल है. आरबीएम प्लैटफ़ॉर्म, कैश मेमोरी से कॉन्टेंट उपलब्ध कराता है. हालांकि, एजेंट आरबीएम प्लैटफ़ॉर्म को कॉन्टेंट का नया वर्शन फ़ेच करने और कैश मेमोरी को रीफ़्रेश करने के लिए मजबूर कर सकता है. |
UploadedRbmFile
फ़ाइल और थंबनेल की जानकारी वाला मैसेज
जेएसओएन के काेड में दिखाना |
---|
{ "fileName": string, "thumbnailName": string } |
फ़ील्ड | |
---|---|
fileName |
फ़ाइल को अपलोड करते समय, आरबीएम प्लैटफ़ॉर्म से मिला फ़ाइल का नाम. |
thumbnailName |
थंबनेल का नाम, जो थंबनेल अपलोड करते समय आरबीएम प्लैटफ़ॉर्म से मिला था. |
RichCard
एजेंट की तरफ़ से उपयोगकर्ता को भेजा गया स्टैंडअलोन रिच कार्ड या रिच कार्ड का कैरसेल.
जेएसओएन के काेड में दिखाना |
---|
{ // Union field |
फ़ील्ड | |
---|---|
यूनियन फ़ील्ड card . स्टैंडअलोन कार्ड या कार्ड का कैरसेल. card इनमें से सिर्फ़ एक हो सकती है: |
|
carouselCard |
कार्ड का कैरसेल. |
standaloneCard |
स्टैंडअलोन कार्ड. |
CarouselCard
कार्ड का कैरसेल.
जेएसओएन के काेड में दिखाना |
---|
{ "cardWidth": enum ( |
फ़ील्ड | |
---|---|
cardWidth |
कैरसेल में मौजूद कार्ड की चौड़ाई. |
cardContents[] |
कैरसेल में मौजूद हर कार्ड के लिए कॉन्टेंट की सूची. एक कैरसेल में कम से कम दो कार्ड और ज़्यादा से ज़्यादा 10 कार्ड हो सकते हैं. |
CarouselCard.CardWidth
कैरसेल में मौजूद कार्ड की चौड़ाई.
Enums | |
---|---|
CARD_WIDTH_UNSPECIFIED |
जानकारी नहीं है. |
SMALL |
120 डीपी. ध्यान दें कि लंबे मीडिया का इस्तेमाल नहीं किया जा सकता. |
MEDIUM |
232 डीपी. |
CardContent
कार्ड का कॉन्टेंट
जेएसओएन के काेड में दिखाना |
---|
{ "title": string, "description": string, "media": { object ( |
फ़ील्ड | |
---|---|
title |
(ज़रूरी नहीं) कार्ड का टाइटल. ज़्यादा से ज़्यादा 200 वर्ण. |
description |
(ज़रूरी नहीं) कार्ड का ब्यौरा. ज़्यादा से ज़्यादा 2,000 वर्ण. |
media |
(ज़रूरी नहीं) कार्ड में शामिल करने के लिए मीडिया (इमेज, GIF, वीडियो). |
suggestions[] |
(ज़रूरी नहीं) कार्ड में शामिल करने के लिए सुझावों की सूची. ज़्यादा से ज़्यादा चार सुझाव. |
मीडिया
रिच कार्ड में मौजूद मीडिया फ़ाइल.
जेएसओएन के काेड में दिखाना |
---|
{ "height": enum ( |
फ़ील्ड | |
---|---|
height |
वर्टिकल लेआउट के साथ रिच कार्ड में मीडिया की ऊंचाई. हॉरिज़ॉन्टल लेआउट वाले स्टैंडअलोन कार्ड के लिए, ऊंचाई को पसंद के मुताबिक नहीं बनाया जा सकता. साथ ही, इस फ़ील्ड को अनदेखा कर दिया जाता है. |
यूनियन फ़ील्ड content . मीडिया कॉन्टेंट content में से सिर्फ़ एक को चुना जा सकता है: |
|
fileName |
फ़ाइल को अपलोड करते समय, आरबीएम प्लैटफ़ॉर्म से मिला फ़ाइल का यूनीक नाम. नीचे अपलोड किए गए RbmFile के समर्थन में बहिष्कृत किया गया |
uploadedRbmFile |
इसमें उस फ़ाइल और थंबनेल के लिए आइडेंटिफ़ायर शामिल होते हैं जिन्हें आरबीएम सर्वर पर अपलोड करता है और दिखाता है |
contentInfo |
फ़ाइल के बारे में जानकारी, जिसमें फ़ाइल का यूआरएल और उसके थंबनेल का यूआरएल शामिल है. आरबीएम प्लैटफ़ॉर्म, कैश मेमोरी से कॉन्टेंट उपलब्ध कराता है. हालांकि, एजेंट आरबीएम प्लैटफ़ॉर्म को कॉन्टेंट का नया वर्शन फ़ेच करने और कैश मेमोरी को रीफ़्रेश करने के लिए मजबूर कर सकता है. |
ContentInfo
कॉन्टेंट की जानकारी वाला मैसेज.
जेएसओएन के काेड में दिखाना |
---|
{ "fileUrl": string, "thumbnailUrl": string, "forceRefresh": boolean } |
फ़ील्ड | |
---|---|
fileUrl |
फ़ाइल का सार्वजनिक यूआरएल. जब प्लैटफ़ॉर्म, फ़ाइल को फ़ेच करता है, तब आरबीएम प्लैटफ़ॉर्म एचटीटीपी हेडर में मौजूद कॉन्टेंट-टाइप फ़ील्ड से फ़ाइल का MIME टाइप तय करता है. यूआरएल से मिलने वाले एचटीटीपी रिस्पॉन्स में कॉन्टेंट-टाइप फ़ील्ड मौजूद होना चाहिए और सटीक होना चाहिए. फ़ाइल का साइज़ 100 एमबी से ज़्यादा नहीं होना चाहिए. |
thumbnailUrl |
(ज़रूरी नहीं, सिर्फ़ इमेज और वीडियो फ़ाइलों के लिए) उस थंबनेल का यूआरएल जिसे सार्वजनिक तौर पर ऐक्सेस किया जा सकता है. ज़्यादा से ज़्यादा 100 केबी का साइज़. थंबनेल का यूआरएल नहीं देने पर, आरबीएम प्लैटफ़ॉर्म तब तक खाली प्लेसहोल्डर थंबनेल दिखाता है, जब तक उपयोगकर्ता का डिवाइस फ़ाइल को डाउनलोड नहीं करता. उपयोगकर्ता की सेटिंग के आधार पर, हो सकता है कि फ़ाइल अपने-आप डाउनलोड न हो और उपयोगकर्ता को 'डाउनलोड करें' बटन पर टैप करना पड़े. |
forceRefresh |
अगर इसे सेट किया जाता है, तो आरबीएम प्लैटफ़ॉर्म बताए गए यूआरएल से फ़ाइल और थंबनेल फ़ेच करता है. भले ही, प्लैटफ़ॉर्म पर फ़ाइल (और/या थंबनेल की) की कैश मेमोरी में सेव की गई कॉपी मौजूद हों. |
Media.Height
मीडिया ऊंचाई
Enums | |
---|---|
HEIGHT_UNSPECIFIED |
जानकारी नहीं है. |
SHORT |
112 डीपी. |
MEDIUM |
168 डीपी. |
TALL |
264 डीपी. कार्ड की चौड़ाई कम पर सेट होने पर, रिच कार्ड कैरसेल के लिए यह सुविधा उपलब्ध नहीं होती. |
सुझाव
रिच कार्ड या सुझाव वाले चिप की सूची में सुझाया गया जवाब या सुझाई गई कार्रवाई.
जेएसओएन के काेड में दिखाना |
---|
{ // Union field |
फ़ील्ड | |
---|---|
यूनियन फ़ील्ड option . सुझाया गया जवाब या सुझाई गई कार्रवाई option , इनमें से सिर्फ़ एक हो सकती है: |
|
reply |
एजेंट को मैसेज का जवाब भेजने के लिए, उपयोगकर्ता सुझाए गए जवाब पर टैप कर सकते हैं. |
action |
डिवाइस पर संबंधित नेटिव कार्रवाई शुरू करने के लिए, उपयोगकर्ता सुझाई गई कार्रवाई पर टैप कर सकते हैं. |
SuggestedReply
टैप करने पर, मैसेज का जवाब वापस एजेंट को भेज दिया जाता है.
जेएसओएन के काेड में दिखाना |
---|
{ "text": string, "postbackData": string } |
फ़ील्ड | |
---|---|
text |
वह टेक्स्ट जो सुझाए गए जवाब में दिखता है और जब उपयोगकर्ता उस पर टैप करता है, तब उसे एजेंट को वापस भेज दिया जाता है. ज़्यादा से ज़्यादा 25 वर्ण. |
postbackData |
base64 कोड में बदला गया पेलोड जो एजेंट को उपयोगकर्ता के इवेंट में तब मिलता है, जब उपयोगकर्ता सुझाए गए जवाब पर टैप करता है. |
SuggestedAction
टैप करने पर, डिवाइस पर इससे जुड़ी नेटिव कार्रवाई शुरू हो जाती है.
जेएसओएन के काेड में दिखाना |
---|
{ "text": string, "postbackData": string, "fallbackUrl": string, // Union field |
फ़ील्ड | |
---|---|
text |
सुझाई गई कार्रवाई में दिखने वाला टेक्स्ट. ज़्यादा से ज़्यादा 25 वर्ण. |
postbackData |
पेलोड (base64 कोड में बदला गया), उपयोगकर्ता के इवेंट में एजेंट को भेजा जाएगा. यह तब भेजा जाएगा, जब उपयोगकर्ता सुझाई गई कार्रवाई पर टैप करेगा |
fallbackUrl |
(ज़रूरी नहीं) अगर कोई क्लाइंट सुझाई गई कार्रवाई नहीं करता है, तो फ़ॉलबैक यूआरएल का इस्तेमाल करें. फ़ॉलबैक यूआरएल नई ब्राउज़र विंडो में खुलते हैं. |
यूनियन फ़ील्ड action . जब उपयोगकर्ता सुझाई गई कार्रवाई action पर टैप करता है, तो डिवाइस पर शुरू की गई नेटिव कार्रवाई इनमें से सिर्फ़ एक हो सकती है: |
|
dialAction |
यह उपयोगकर्ता का डिफ़ॉल्ट डायलर ऐप्लिकेशन खोलता है. इसमें एजेंट का तय किया गया फ़ोन नंबर पहले से भरा होता है. |
viewLocationAction |
यह उपयोगकर्ता का डिफ़ॉल्ट मैप ऐप्लिकेशन खोलता है और एजेंट की बताई गई जगह की जानकारी चुनता है या एजेंट की तय की गई क्वेरी के आधार पर, उपयोगकर्ता की जगह की जानकारी खोजता है. |
createCalendarEventAction |
इससे उपयोगकर्ता का डिफ़ॉल्ट कैलेंडर ऐप्लिकेशन खुलता है और नए कैलेंडर इवेंट फ़्लो को शुरू करता है, जिसमें एजेंट के तय किए गए इवेंट डेटा को पहले से भरा होता है. |
openUrlAction |
दिए गए यूआरएल से उपयोगकर्ता का डिफ़ॉल्ट वेब ब्राउज़र ऐप्लिकेशन खोलता है. अगर उपयोगकर्ता ने कोई ऐसा ऐप्लिकेशन इंस्टॉल किया है जो यूआरएल के डिफ़ॉल्ट हैंडलर के तौर पर रजिस्टर है, तो यह ऐप्लिकेशन खुलेगा. साथ ही, इसके आइकॉन का इस्तेमाल, सुझाई गई कार्रवाई के यूज़र इंटरफ़ेस (यूआई) में किया जाएगा. |
shareLocationAction |
यह आरसीएस ऐप्लिकेशन का जगह चुनने का विकल्प खोलता है. इससे उपयोगकर्ता, एजेंट को भेजने के लिए जगह चुन सकता है. |
DialAction
यह उपयोगकर्ता का डिफ़ॉल्ट डायलर ऐप्लिकेशन खोलता है. इसमें एजेंट का तय किया गया फ़ोन नंबर पहले से भरा होता है.
जेएसओएन के काेड में दिखाना |
---|
{ "phoneNumber": string } |
फ़ील्ड | |
---|---|
phoneNumber |
E.164 फ़ॉर्मैट में फ़ोन नंबर, उदाहरण के लिए, +12223334444. |
ViewLocationAction
यह उपयोगकर्ता का डिफ़ॉल्ट मैप ऐप्लिकेशन खोलता है और एजेंट की बताई गई जगह की जानकारी चुनता है या एजेंट की तय की गई क्वेरी के आधार पर, उपयोगकर्ता की जगह की जानकारी खोजता है.
जेएसओएन के काेड में दिखाना |
---|
{
"latLong": {
object ( |
फ़ील्ड | |
---|---|
latLong |
(ज़रूरी नहीं) दी गई जगह का अक्षांश और देशांतर. |
label |
(ज़रूरी नहीं) अक्षांश पर पिन किए गए पिन का लेबल. |
query |
(ज़रूरी नहीं, सिर्फ़ Android Messages क्लाइंट के लिए ही काम करता है) अक्षांश (देशांतर) और लेबल की जानकारी देने के बजाय, एजेंट कोई क्वेरी स्ट्रिंग तय कर सकता है. उन डिफ़ॉल्ट मैप ऐप्लिकेशन जो खोज की सुविधा (जैसे, Google Maps) के साथ काम करते हैं, उनके लिए इस सुझाई गई कार्रवाई पर टैप करने से उपयोगकर्ता की मौजूदा जगह की जानकारी दिखाई देती है. अगर क्वेरी काफ़ी सटीक है, तो एजेंट इसका इस्तेमाल दुनिया की किसी भी जगह को चुनने के लिए कर सकते हैं. उदाहरण के लिए, क्वेरी स्ट्रिंग को "Growing Tree Bank" पर सेट करने से उपयोगकर्ता के आस-पास की सभी Growing Tree Bank की सभी जगहें दिखेंगी. क्वेरी स्ट्रिंग को "1600 Amphitheler Parkway, Mountain View, CA 94043" पर सेट करने से वह विशिष्ट पता चुन लिया जाएगा, चाहे उपयोगकर्ता का स्थान कुछ भी हो. |
LatLng
ऐसा ऑब्जेक्ट जो अक्षांश/देशांतर के जोड़े को दिखाता है. डिग्री अक्षांश और डिग्री देशांतर को दर्शाने के लिए, इसे दो जोड़ों के रूप में दिखाया जाता है. जब तक अलग से न बताया गया हो, तब तक यह ऑब्जेक्ट WGS84 मानक के मुताबिक होना चाहिए. वैल्यू, सामान्य रेंज के अंदर होनी चाहिए.
जेएसओएन के काेड में दिखाना |
---|
{ "latitude": number, "longitude": number } |
फ़ील्ड | |
---|---|
latitude |
डिग्री में अक्षांश. यह [-90.0, +90.0] की रेंज में होना चाहिए. |
longitude |
डिग्री में देशांतर. यह [-180.0, +180.0] की रेंज में होना चाहिए. |
CreateCalendarEventAction
इससे उपयोगकर्ता का डिफ़ॉल्ट कैलेंडर ऐप्लिकेशन खुलता है और नए कैलेंडर इवेंट फ़्लो को शुरू करता है, जिसमें एजेंट के तय किए गए इवेंट डेटा को पहले से भरा होता है.
जेएसओएन के काेड में दिखाना |
---|
{ "startTime": string, "endTime": string, "title": string, "description": string } |
फ़ील्ड | |
---|---|
startTime |
इवेंट की शुरुआत का समय. RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड का रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक हो सकते हैं. उदाहरण: |
endTime |
इवेंट के खत्म होने का समय. RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड का रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक हो सकते हैं. उदाहरण: |
title |
इवेंट का नाम. |
description |
इवेंट की जानकारी. |
OpenUrlAction
इससे उपयोगकर्ता का डिफ़ॉल्ट वेब ब्राउज़र ऐप्लिकेशन, बताए गए यूआरएल पर खुलता है. अगर उपयोगकर्ता ने कोई ऐसा ऐप्लिकेशन इंस्टॉल किया है जो यूआरएल के डिफ़ॉल्ट हैंडलर के तौर पर रजिस्टर है, तो यह ऐप्लिकेशन खुलेगा. साथ ही, इसके आइकॉन का इस्तेमाल, सुझाई गई कार्रवाई के यूज़र इंटरफ़ेस (यूआई) में किया जाएगा.
जेएसओएन के काेड में दिखाना |
---|
{ "url": string } |
फ़ील्ड | |
---|---|
url |
यूआरएल |
StandaloneCard
स्टैंडअलोन कार्ड
जेएसओएन के काेड में दिखाना |
---|
{ "cardOrientation": enum ( |
फ़ील्ड | |
---|---|
cardOrientation |
कार्ड का ओरिएंटेशन. |
thumbnailImageAlignment |
हॉरिज़ॉन्टल लेआउट वाले स्टैंडअलोन कार्ड के लिए इमेज की झलक. |
cardContent |
कार्ड का कॉन्टेंट. |
StandaloneCard.CardOrientation
कार्ड का ओरिएंटेशन.
Enums | |
---|---|
CARD_ORIENTATION_UNSPECIFIED |
जानकारी नहीं है. |
HORIZONTAL |
हॉरिज़ॉन्टल लेआउट. अगर हॉरिज़ॉन्टल रिच कार्ड के |
VERTICAL |
वर्टिकल लेआउट. |
StandaloneCard.ThumbnailImageAlignment
हॉरिज़ॉन्टल लेआउट वाले स्टैंडअलोन कार्ड के लिए इमेज की झलक.
Enums | |
---|---|
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED |
जानकारी नहीं है. |
LEFT |
फ़ाइल की झलक, बाईं ओर अलाइन है. |
RIGHT |
फ़ाइल की झलक, दाईं ओर अलाइन है. |
तरीके |
|
---|---|
|
एजेंट से किसी उपयोगकर्ता को मैसेज भेजता है. |
|
उस एजेंट मैसेज को रद्द करता है जो भेजा गया है, लेकिन अभी तक डिलीवर नहीं हुआ. |