REST Resource: conversations.messages

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

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

JSON के काेड में दिखाना 
{
  "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)

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

इमेज

इमेज.

JSON के काेड में दिखाना 
{

  // 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

इस मैसेज में कॉन्टेंट की जानकारी होती है.

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

string

फ़ाइल का सार्वजनिक रूप से ऐक्सेस किया जा सकने वाला यूआरएल. जब प्लैटफ़ॉर्म, फ़ाइल को फ़ेच करता है, तो यह प्लैटफ़ॉर्म, एचटीटीपी हेडर में content-type फ़ील्ड से फ़ाइल का 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

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

JSON के काेड में दिखाना 
{

  // 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

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

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

object (CardContent)

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

CardContent

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

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

string

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

string

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

object (Media)

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

object (Suggestion)

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

मीडिया

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

JSON के काेड में दिखाना 
{
  "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 पर सेट होने पर, यह रिच कार्ड कैरसेल के लिए उपलब्ध नहीं होता.

सुझाव

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

JSON के काेड में दिखाना 
{

  // 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

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

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

string

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

string

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

SuggestedAction

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

JSON के काेड में दिखाना 
{
  "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

तय किया गया यूआरएल खोलता है.

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

string

URL

DialAction

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

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

string

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

LiveAgentRequest

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

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

AuthenticationRequest

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

JSON के काेड में दिखाना 
{

  // 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 के ज़रिए पुष्टि करने के बारे में जानकारी.

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

string

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

string

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

string

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

string

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

CarouselCard

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

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

enum (CardWidth)

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

object (CardContent)

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

CardWidth

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

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

तरीके

create

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

updateReceipt

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