REST Resource: conversations.messages

संसाधन: मैसेज

किसी एजेंट और उपयोगकर्ता के बीच हुई बातचीत का मैसेज.

जेएसओएन के काेड में दिखाना 
{
  "name": string,
  "messageId": string,
  "representative": {
    object (Representative)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "fallback": string,
  "containsRichText": boolean,

  // Union field content can be only one of the following:
  "text": string,
  "image": {
    object (Image)
  },
  "richCard": {
    object (RichCard)
  }
  // End of list of possible types for union field content.
}
फ़ील्ड
name

string

मैसेज का नाम, जैसा कि Business Messages ने सेट किया है. यह "बातचीत/{conversationId}/messages/{messageId}" में होता है, जहां {conversationId} एक यूनीक आईडी होता है और {messageId}, मैसेज का यूनीक आईडी होता है.
messageId

string

ज़रूरी है. मैसेज का यूनीक आइडेंटिफ़ायर, जिसे एजेंट असाइन करता है. अगर कोई मैसेज उसी messageId को इस्तेमाल करने की कोशिश करता है जो पिछले मैसेज में था, तो इससे मैसेज की सही डिलीवरी पर असर पड़ सकता है.
representative

object (Representative)

मैसेज भेजने वाले प्रतिनिधि (मानव या चैटबॉट) के बारे में जानकारी.
suggestions[]

object (Suggestion)

सुझाए गए उन जवाबों की सूची जो मैसेज से जुड़े सुझाव के चिप की सूची के तौर पर दिखते हैं. ज़्यादा से ज़्यादा 13 सुझाव.

ये चिप सिर्फ़ तब दिखते हैं, जब इनसे जुड़ा मैसेज, बातचीत में सबसे हाल ही का मैसेज होता है. इसमें एजेंट और उपयोगकर्ता के मैसेज भी शामिल होते हैं. उपयोगकर्ता, सुझाए गए जवाब पर टैप करके एजेंट को मैसेज का जवाब दे सकता है.
fallback

string

ज़रूरी नहीं. फ़ॉलबैक टेक्स्ट तब दिखता है, जब उपयोगकर्ता के डिवाइस पर इस तरह के मैसेज या कॉन्टेंट काम नहीं करता. ज़्यादा से ज़्यादा 3,072 वर्ण.
containsRichText

boolean

ज़रूरी नहीं. अगर true, तो इससे पता चलता है कि मैसेज में रिच टेक्स्ट है. अगर मैसेज का फ़ॉर्मैट अमान्य है, तो Business Messages गड़बड़ी दिखाएगा.
यूनियन फ़ील्ड content. मैसेज का कॉन्टेंट. content इनमें से सिर्फ़ एक हो सकता है:
text

string

टेक्स्ट मैसेज. ज़्यादा से ज़्यादा 3,072 वर्ण.
image

object (Image)

इमेज मैसेज.
richCard

object (RichCard)

रिच कार्ड मैसेज.

इमेज

इमेज.

जेएसओएन के काेड में दिखाना 
{

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
फ़ील्ड
यूनियन फ़ील्ड content. इमेज कॉन्टेंट. content इनमें से सिर्फ़ एक हो सकता है:
contentInfo

object (ContentInfo)

इमेज के बारे में जानकारी, जिसमें इमेज का यूआरएल और इमेज के थंबनेल का यूआरएल शामिल होता है.

ContentInfo

कॉन्टेंट की जानकारी वाला मैसेज.

जेएसओएन के काेड में दिखाना 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "forceRefresh": boolean,
  "altText": string
}
फ़ील्ड
fileUrl

string

फ़ाइल का यूआरएल, जिसे सार्वजनिक तौर पर ऐक्सेस किया जा सकता है. जब प्लैटफ़ॉर्म फ़ाइल को फ़ेच करता है, तब प्लैटफ़ॉर्म, एचटीटीपी हेडर में मौजूद कॉन्टेंट-टाइप फ़ील्ड से फ़ाइल का MIME टाइप तय करता है. यूआरएल से मिलने वाले एचटीटीपी रिस्पॉन्स में कॉन्टेंट-टाइप फ़ील्ड मौजूद होना चाहिए और सटीक होना चाहिए.

ज़्यादा से ज़्यादा 5 एमबी.

इस्तेमाल किए जा सकने वाले कॉन्टेंट टाइप: image/jpeg, image/jpg, image/png, image/webp
thumbnailUrl

string

ज़रूरी नहीं. थंबनेल का यूआरएल, जिसे सार्वजनिक तौर पर ऐक्सेस किया जा सकता है.

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

ज़्यादा से ज़्यादा 25 केबी.

इस्तेमाल किए जा सकने वाले कॉन्टेंट टाइप: image/jpeg, image/jpg, image/png, image/webp
forceRefresh

boolean

अगर इन्हें सेट किया जाता है, तो प्लैटफ़ॉर्म, बताए गए यूआरएल से फ़ाइल और थंबनेल फ़ेच करता है. भले ही, प्लैटफ़ॉर्म पर फ़ाइल (और/या थंबनेल की) कैश मेमोरी में सेव की गई कॉपी मौजूद हों.
altText

string

सुलभता के मकसद से मीडिया के बारे में जानकारी देने वाला टेक्स्ट.

RichCard

एजेंट से उपयोगकर्ता को भेजा गया स्टैंडअलोन रिच कार्ड या रिच कार्ड का कैरसेल.

जेएसओएन के काेड में दिखाना 
{

  // Union field card can be only one of the following:
  "standaloneCard": {
    object (StandaloneCard)
  },
  "carouselCard": {
    object (CarouselCard)
  }
  // End of list of possible types for union field card.
}
फ़ील्ड
यूनियन फ़ील्ड card. संभावित तरह के रिच कार्ड. card इनमें से सिर्फ़ एक हो सकता है:
standaloneCard

object (StandaloneCard)

स्टैंडअलोन कार्ड.
carouselCard

object (CarouselCard)

कार्ड का कैरसेल.

StandaloneCard

स्टैंडअलोन कार्ड.

जेएसओएन के काेड में दिखाना 
{
  "cardContent": {
    object (CardContent)
  }
}
फ़ील्ड
cardContent

object (CardContent)

कार्ड का कॉन्टेंट.

CardContent

कार्ड का कॉन्टेंट.

जेएसओएन के काेड में दिखाना 
{
  "title": string,
  "description": string,
  "media": {
    object (Media)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ]
}
फ़ील्ड
title

string

ज़रूरी नहीं. कार्ड का टाइटल. ज़्यादा से ज़्यादा 200 वर्ण.
description

string

ज़रूरी नहीं. कार्ड के बारे में जानकारी. ज़्यादा से ज़्यादा 2,000 वर्ण.
media

object (Media)

ज़रूरी नहीं. कार्ड में शामिल करने के लिए मीडिया.
suggestions[]

object (Suggestion)

ज़रूरी नहीं. कार्ड में शामिल करने के लिए सुझावों की सूची. ज़्यादा से ज़्यादा चार सुझाव.

मीडिया

रिच कार्ड में मौजूद मीडिया फ़ाइल.

जेएसओएन के काेड में दिखाना 
{
  "height": enum (Height),

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
फ़ील्ड
height

enum (Height)

रिच कार्ड में मीडिया की ऊंचाई.
यूनियन फ़ील्ड content. मीडिया कॉन्टेंट. content इनमें से सिर्फ़ एक हो सकता है:
contentInfo

object (ContentInfo)

फ़ाइल के बारे में जानकारी, जिसमें फ़ाइल का यूआरएल और उसके थंबनेल का यूआरएल शामिल होता है.

ऊंचाई

मीडिया ऊंचाई

Enums
HEIGHT_UNSPECIFIED जानकारी नहीं दी गई.
SHORT 112 डीपी.
MEDIUM 168 डीपी.
TALL 264 डीपी. कार्ड की चौड़ाई SMALL पर सेट होने पर, रिच कार्ड कैरसेल के लिए यह सुविधा उपलब्ध नहीं होती.

सुझाव

चिप सूची में मौजूद सुझाव.

जेएसओएन के काेड में दिखाना 
{

  // Union field option can be only one of the following:
  "reply": {
    object (SuggestedReply)
  },
  "action": {
    object (SuggestedAction)
  },
  "liveAgentRequest": {
    object (LiveAgentRequest)
  },
  "authenticationRequest": {
    object (AuthenticationRequest)
  }
  // End of list of possible types for union field option.
}
फ़ील्ड
यूनियन फ़ील्ड option. सुझाया गया जवाब. option इनमें से सिर्फ़ एक हो सकता है:
reply

object (SuggestedReply)

उपयोगकर्ता के लिए तय टेक्स्ट के साथ जवाब देने का सुझाव.
action

object (SuggestedAction)

सुझाई गई ऐसी कार्रवाई जो डिवाइस पर नेटिव कार्रवाई शुरू करती है.
liveAgentRequest

object (LiveAgentRequest)

इस बातचीत में किसी लाइव एजेंट को शामिल करने का अनुरोध किया गया हो.
authenticationRequest

object (AuthenticationRequest)

पुष्टि करने की प्रक्रिया शुरू करने का अनुरोध.

SuggestedReply

टैप करने पर, मैसेज का जवाब एजेंट को भेज दिया जाता है.

जेएसओएन के काेड में दिखाना 
{
  "text": string,
  "postbackData": string
}
फ़ील्ड
text

string

सुझाए गए जवाब में दिखाया गया टेक्स्ट और जब उपयोगकर्ता उस पर टैप करता है, तब उसे एजेंट को भेज दिया जाता है. ज़्यादा से ज़्यादा 25 वर्ण.
postbackData

string

वह स्ट्रिंग जो एजेंट को तब मिलती है, जब उपयोगकर्ता सुझाए गए जवाब पर टैप करता है. ज़्यादा से ज़्यादा 2,048 वर्ण.

SuggestedAction

टैप करने पर, डिवाइस पर संबंधित नेटिव कार्रवाई शुरू हो जाती है.

जेएसओएन के काेड में दिखाना 
{
  "text": string,
  "postbackData": string,

  // Union field action can be only one of the following:
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "dialAction": {
    object (DialAction)
  }
  // End of list of possible types for union field action.
}
फ़ील्ड
text

string

सुझाई गई कार्रवाई में दिखाया गया टेक्स्ट. ज़्यादा से ज़्यादा 25 वर्ण.
postbackData

string

वह स्ट्रिंग जो एजेंट को तब मिलती है, जब उपयोगकर्ता सुझाई गई कार्रवाई पर टैप करता है. ज़्यादा से ज़्यादा 2,048 वर्ण.
यूनियन फ़ील्ड action. उपयोगकर्ता के सुझाई गई कार्रवाई पर टैप करने से, डिवाइस पर शुरू की गई नेटिव कार्रवाई. action इनमें से सिर्फ़ एक हो सकता है:
openUrlAction

object (OpenUrlAction)

इस यूआरएल को खोलता है.
dialAction

object (DialAction)

इससे उपयोगकर्ता का डिफ़ॉल्ट डायलर ऐप्लिकेशन खुलता है.

OpenUrlAction

इस यूआरएल को खोलता है.

जेएसओएन के काेड में दिखाना 
{
  "url": string
}
फ़ील्ड
url

string

यूआरएल

DialAction

इससे उपयोगकर्ता का डिफ़ॉल्ट डायलर ऐप्लिकेशन खुलता है. इसमें, दर्ज किए गए फ़ोन नंबर को पहले से भरा हुआ होता है.

जेएसओएन के काेड में दिखाना 
{
  "phoneNumber": string
}
फ़ील्ड
phoneNumber

string

ज़रूरी है. आरएफ़सी 3966 फ़ॉर्मैट में दिया गया फ़ोन नंबर. उदाहरण के लिए, "+1-201-555-0123".

LiveAgentRequest

इस टाइप के लिए कोई फ़ील्ड नहीं है.

टैप करने पर, लाइव एजेंट को बातचीत में शामिल होने का अनुरोध भेजा जाता है.

AuthenticationRequest

बातचीत की पुष्टि करने का अनुरोध करना.

जेएसओएन के काेड में दिखाना 
{

  // Union field authentication_type can be only one of the following:
  "oauth": {
    object (Oauth)
  }
  // End of list of possible types for union field authentication_type.
}
फ़ील्ड
यूनियन फ़ील्ड authentication_type. पुष्टि करने का तरीका. authentication_type इनमें से सिर्फ़ एक हो सकता है:
oauth

object (Oauth)

OAuth के ज़रिए पुष्टि करने के बारे में जानकारी.

OAuth

OAuth के ज़रिए पुष्टि करने के बारे में जानकारी.

जेएसओएन के काेड में दिखाना 
{
  "clientId": string,
  "codeChallenge": string,
  "scopes": [
    string
  ],
  "codeChallengeMethod": string
}
फ़ील्ड
clientId

string

ज़रूरी है. अनुमति देने का अनुरोध करने वाले ऐप्लिकेशन का आईडी.
codeChallenge

string

ज़रूरी है. कोड चैलेंज का इस्तेमाल, ऐक्सेस टोकन को बदलने के लिए किया जाता है.
scopes[]

string

ज़रूरी है. वह कलेक्शन जो अनुरोध के दायरे के बारे में बताता है.
codeChallengeMethod

string

ज़रूरी नहीं. कोड चैलेंज का तरीका, जिसका इस्तेमाल कोड चैलेंज को जनरेट करने के लिए किया जाता है. अगर यह पैरामीटर शामिल नहीं किया जाता, तो सर्वर plain मान लेता है.

CarouselCard

कार्ड का कैरसेल.

जेएसओएन के काेड में दिखाना 
{
  "cardWidth": enum (CardWidth),
  "cardContents": [
    {
      object (CardContent)
    }
  ]
}
फ़ील्ड
cardWidth

enum (CardWidth)

कैरसेल में शामिल कार्ड की चौड़ाई.
cardContents[]

object (CardContent)

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

CardWidth

कैरसेल में शामिल कार्ड की चौड़ाई.

Enums
CARD_WIDTH_UNSPECIFIED जानकारी नहीं दी गई
SMALL 136 डीपी. लंबे मीडिया को शामिल नहीं किया जा सकता.
MEDIUM 280 डीपी.

तरीके

create

 किसी एजेंट से किसी उपयोगकर्ता को मैसेज भेजता है.

updateReceipt

 एजेंट से किसी उपयोगकर्ता को मैसेज की रसीद भेजता है.