REST Resource: conversations.messages

Kaynak: Mesaj

Temsilci ile kullanıcı arasındaki görüşmede yer alan bir mesaj.

JSON gösterimi 
{
  "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.
}
Alanlar
name

string

Mesajın, Business Messages tarafından ayarlanan adı. "conversation/{conversationId}/messages/{messageId}" olarak çözümlenir; burada {conversationId} ileti dizisinin benzersiz kimliği, {messageId} ise iletinin benzersiz kimliğidir.
messageId

string

Zorunlu. Mesajın temsilci tarafından atanan benzersiz tanımlayıcısı. Bir ileti, önceki iletiyle aynı messageId öğesini kullanmaya çalışırsa iletinin düzgün şekilde teslim edilmesi bu durumdan etkilenebilir.
representative

object (Representative)

Mesajı gönderen temsilciyle (insan veya chatbot) ilgili ayrıntılar.
suggestions[]

object (Suggestion)

İlişkili mesajın ardından öneri çiplerinden oluşan bir liste olarak görünen önerilen yanıtların listesi. Maksimum 13 öneri.

Çipler yalnızca ilişkili mesaj, görüşmedeki en son mesaj olduğunda (hem temsilci hem de kullanıcı mesajları dahil) gösterilir. Kullanıcı, önerilen bir yanıta dokunarak kısa mesajı temsilciye gönderebilir.
fallback

string

İsteğe bağlı. Kullanıcının cihazı ileti türünü veya içeriği desteklemiyorsa görüntülenen yedek metin. Maksimum 3.072 karakter.
containsRichText

boolean

İsteğe bağlı. true ise iletinin zengin metin içerdiğini gösterir. Mesaj geçersiz biçimlendirme içeriyorsa Business Messages hata döndürür.
content alanı. Bir iletinin içeriği. content şunlardan yalnızca biri olabilir:
text

string

Kısa mesaj. Maksimum 3.072 karakter.
image

object (Image)

Resim mesajı.
richCard

object (RichCard)

Zengin Kart mesajı.

Resim

Bir resim.

JSON gösterimi 
{

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
Alanlar
content alanı. Resim içeriği. content şunlardan yalnızca biri olabilir:
contentInfo

object (ContentInfo)

Görselin URL'si ve küçük resminin URL'si de dahil olmak üzere bir görsel hakkında bilgiler.

ContentInfo

İçerik bilgilerini içeren ileti.

JSON gösterimi 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "forceRefresh": boolean,
  "altText": string
}
Alanlar
fileUrl

string

Dosyanın herkese açık URL'si. Platform, dosyayı getirdiğinde dosyanın MIME türünü HTTP üstbilgilerindeki içerik türü alanından belirler. İçerik türü alanı, URL'den gelen HTTP yanıtında mevcut ve doğru olmalıdır.

Maksimum 5 MB.

Desteklenen içerik türleri: resim/jpeg, resim/jpg, resim/png, resim/webp
thumbnailUrl

string

İsteğe bağlı. Küçük resmin herkes tarafından erişilebilen URL'si.

Küçük resim URL'si sağlamazsanız platform, kullanıcının cihazı dosyayı indirene kadar boş bir yer tutucu küçük resim gösterir.

En fazla 25 KB.

Desteklenen içerik türleri: resim/jpeg, resim/jpg, resim/png, resim/webp
forceRefresh

boolean

Ayarlanırsa platform, dosyanın (ve/veya küçük resmin) önbelleğe alınmış kopyalarını almış olsa bile belirtilen URL'lerden dosyayı ve küçük resmi getirir.
altText

string

Erişilebilirlik amacıyla medyayla ilgili ayrıntıları açıklayan metin.

RichCard

Bağımsız bir zengin kart veya aracıdan kullanıcıya gönderilen zengin kart bandı.

JSON gösterimi 
{

  // 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.
}
Alanlar
card alanı. Olası zengin kart türleri. card şunlardan yalnızca biri olabilir:
standaloneCard

object (StandaloneCard)

Bağımsız kart.
carouselCard

object (CarouselCard)

Kart bandı.

StandaloneCard

Bağımsız kart.

JSON gösterimi 
{
  "cardContent": {
    object (CardContent)
  }
}
Alanlar
cardContent

object (CardContent)

Kart içeriği.

CardContent

Kart içeriği.

JSON gösterimi 
{
  "title": string,
  "description": string,
  "media": {
    object (Media)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ]
}
Alanlar
title

string

İsteğe bağlı. Kartın başlığı. Maksimum 200 karakter.
description

string

İsteğe bağlı. Kartın açıklaması. Maksimum 2.000 karakter.
media

object (Media)

İsteğe bağlı. Karta eklenecek medya.
suggestions[]

object (Suggestion)

İsteğe bağlı. Karta dahil edilecek önerilerin listesi. Maksimum 4 öneri.

Medya

Zengin kart içindeki bir medya dosyası.

JSON gösterimi 
{
  "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.
}
Alanlar
height

enum (Height)

Zengin kart içindeki medyanın yüksekliği.
content alanı. Medya içeriği. content şunlardan yalnızca biri olabilir:
contentInfo

object (ContentInfo)

Dosyanın URL'si ve dosyanın küçük resminin URL'si de dahil olmak üzere dosya hakkında bilgiler.

Boy

Medya yüksekliği

Sıralamalar
HEIGHT_UNSPECIFIED Belirtilmedi.
SHORT 112 DP
MEDIUM 168 DP.
TALL 264 DPY. Kart genişliği SMALL olarak ayarlandığında zengin kart ruloları için kullanılamaz.

Öneri

Çip listesindeki bir öneri.

JSON gösterimi 
{

  // 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.
}
Alanlar
option alanı. Önerilen yanıt. option şunlardan yalnızca biri olabilir:
reply

object (SuggestedReply)

Kullanıcının belirtilen metinle yanıt vermesi için öneri.
action

object (SuggestedAction)

Cihazda yerel bir işlem başlatan önerilen işlem.
liveAgentRequest

object (LiveAgentRequest)

Canlı müşteri temsilcisinin görüşmeye katılma isteği.
authenticationRequest

object (AuthenticationRequest)

Kimlik doğrulama akışını başlatma isteği.

SuggestedReply

Dokunulduğunda kısa mesajı temsilciye geri gönderir.

JSON gösterimi 
{
  "text": string,
  "postbackData": string
}
Alanlar
text

string

Önerilen yanıtta gösterilen ve kullanıcı dokunduğunda temsilciye gönderilen metin. Maksimum 25 karakter
postbackData

string

Bir kullanıcı önerilen yanıta dokunduğunda temsilcinin aldığı dize. Maksimum 2.048 karakter.

SuggestedAction

Dokunulduğunda, cihazda ilgili yerel işlemi başlatır.

JSON gösterimi 
{
  "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.
}
Alanlar
text

string

Önerilen işlemde gösterilen metin. Maksimum 25 karakter
postbackData

string

Bir kullanıcı önerilen işleme dokunduğunda temsilcinin aldığı dize. Maksimum 2.048 karakter.
action alanı. Kullanıcı önerilen işleme dokunduğunda cihazda başlatılan yerel işlem. action şunlardan yalnızca biri olabilir:
openUrlAction

object (OpenUrlAction)

Belirtilen URL'yi açar.
dialAction

object (DialAction)

Kullanıcının varsayılan numara çevirici uygulamasını açar.

OpenUrlAction

Belirtilen URL'yi açar.

JSON gösterimi 
{
  "url": string
}
Alanlar
url

string

URL

DialAction

Belirtilen telefon numarası doldurulmuş olarak kullanıcının varsayılan numara çevirici uygulamasını açar.

JSON gösterimi 
{
  "phoneNumber": string
}
Alanlar
phoneNumber

string

Zorunlu. RFC 3966 biçiminde belirtilen, belirtilen telefon numarası. Örneğin, "+1-201-555-0123".

LiveAgentRequest

Bu türde alan yok.

Dokunulduğunda, canlı müşteri temsilcisinin görüşmeye katılması için istek gönderir.

AuthenticationRequest

Bir görüşmenin kimliğini doğrulama isteği.

JSON gösterimi 
{

  // 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.
}
Alanlar
authentication_type alanı. Kimlik doğrulama türü. authentication_type şunlardan yalnızca biri olabilir:
oauth

object (Oauth)

OAuth aracılığıyla kimlik doğrulama ayrıntıları.

OAuth

OAuth aracılığıyla kimlik doğrulama ayrıntıları.

JSON gösterimi 
{
  "clientId": string,
  "codeChallenge": string,
  "scopes": [
    string
  ],
  "codeChallengeMethod": string
}
Alanlar
clientId

string

Zorunlu. Yetkilendirme isteyen uygulamanın kimliği.
codeChallenge

string

Zorunlu. Erişim jetonlarını değiştirmek için kullanılan kod sorgulaması.
scopes[]

string

Zorunlu. İsteğin kapsamlarını belirten bir dizi.
codeChallengeMethod

string

İsteğe bağlı. Kod sorgulamasını oluşturmak için kullanılan kod sorgulama yöntemi. Bu parametre atlanırsa sunucu plain olduğunu varsayar.

CarouselCard

Kart bandı.

JSON gösterimi 
{
  "cardWidth": enum (CardWidth),
  "cardContents": [
    {
      object (CardContent)
    }
  ]
}
Alanlar
cardWidth

enum (CardWidth)

Banttaki kartların genişliği.
cardContents[]

object (CardContent)

Banttaki her kart için içerik listesi. Bantta en az 2 ve en fazla 10 kart olabilir.

CardWidth

Banttaki kartların genişliği.

Sıralamalar
CARD_WIDTH_UNSPECIFIED Belirtilmedi
SMALL 136 DP. Uzun medya dahil edilemiyor.
MEDIUM 280 DP

Yöntemler

create

 Bir temsilciden kullanıcıya mesaj gönderir.

updateReceipt

 Bir temsilciden kullanıcıya mesaj için makbuz gönderir.