REST Resource: conversations.messages

Kaynak: Mesaj

Temsilci ile kullanıcı arasındaki görüşmede bulunan 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 belirlenen adı. "İletiler/{dönş.Id}/messages/{messageId}" olarak çözümlenir. Burada {ileti dizisiKimliği}, görüşmenin benzersiz kimliği, {messageId} ise mesajın benzersiz kimliğidir.
messageId

string

Zorunlu. Mesajın, aracı tarafından atanan benzersiz tanımlayıcısıdır. Bir ileti, önceki iletiyle aynı messageId öğesini kullanmaya çalışırsa iletinin uygun teslimi bu durumdan etkilenebilir.
representative

object (Representative)

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

object (Suggestion)

İlişkili mesajdan sonra öneri çiplerinin listesi olarak görünen önerilen yanıtların listesi. En fazla 13 öneri.

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

string

İsteğe bağlı. Kullanıcının cihazı mesaj 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 belirtir. Mesaj geçersiz biçimlendirme içeriyorsa Business Messages hata döndürür.
Birleştirme alanı content. 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
Birleştirme alanı content. Resim içeriği. content şunlardan yalnızca biri olabilir:
contentInfo

object (ContentInfo)

Görselin URL'si ve küçük resmin URL'si de dahil olmak üzere 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 HTTP üstbilgilerindeki içerik türü alanından dosyanın MIME türünü belirler. Content-type 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 herkese açık URL'si.

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

Maksimum 25 KB.

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

boolean

Bu parametre ayarlanırsa platform, dosyanın (ve/veya küçük resmin) önbelleğe alınmış kopyaları 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 kartlar 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
Birleştirme alanı card. 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 eklenecek önerilerin listesi. En fazla 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.
Birleştirme alanı content. Medya içeriği. content şunlardan yalnızca biri olabilir:
contentInfo

object (ContentInfo)

Dosya 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 DP. 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
Birleştirme alanı option. Önerilen yanıt. option şunlardan yalnızca biri olabilir:
reply

object (SuggestedReply)

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

object (SuggestedAction)

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

object (LiveAgentRequest)

Canlı bir temsilcinin görüşmeye katılma isteği.
authenticationRequest

object (AuthenticationRequest)

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

SuggestedReply

Dokunulduğunda kısa yanıtı 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

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 aracının aldığı dize. Maksimum 2.048 karakter.
Birleştirme alanı action. 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

Kullanıcının varsayılan numara çevirici uygulamasını, belirtilen telefon numarası doldurulmuş olarak açar.

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

string

Zorunlu. RFC 3966 biçiminde 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 ileti dizisinin 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
Birleştirme alanı authentication_type. Kimlik doğrulama türü. authentication_type şunlardan yalnızca biri olabilir:
oauth

object (Oauth)

OAuth aracılığıyla kimlik doğrulama ile ilgili 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ı değişimi 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 eklenmezse sunucu plain değerini 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ın içerik listesi. Ruloda en az 2, en fazla 10 kart olabilir.

CardWidth

Banttaki kartların genişliği.

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

Yöntemler

create

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

updateReceipt

 Bir temsilciden kullanıcıya gelen iletinin makbuzunu gönderir.