REST Resource: phones.agentMessages

Kaynak: AgentMessage

Temsilciden kullanıcıya gönderilen mesaj.

JSON gösterimi 
{
  "name": string,
  "sendTime": string,
  "contentMessage": {
    object (AgentContentMessage)
  },

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}
Alanlar
name

string

Bu alan, RBM platformu tarafından ayarlanır. Temsilci mesajı oluştururken bu kodu eklemeyin. Alan, "phones/{E.164}/agentMessages/{messageId}" şeklinde çözümlenir. Burada {E.164} kullanıcının E.164 biçimindeki telefon numarası, {messageId}, temsilci mesajının temsilci tarafından atanan kimliğidir.
sendTime

string (Timestamp format)

Bu alan, RBM platformu tarafından ayarlanır. Temsilci mesajı oluştururken bu kodu eklemeyin. Alan, mesajın kullanıcıya gönderildiği zamanı çözümler.

Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
contentMessage

object (AgentContentMessage)

Temsilci mesajının içeriği.

Birleştirme alanı expiration.

expiration şunlardan yalnızca biri olabilir:
expireTime

string (Timestamp format)

İsteğe bağlı. Bu kaynağın süresinin dolmuş olarak değerlendirildiği zamanı gösteren UTC zaman damgası. Bu değer, ayarlanmışsa veya TTL alanı ayarlanırsa çıkışta sağlanır.

Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
ttl

string (Duration format)

İsteğe bağlı. Yalnızca giriş'e dokunun. İletinin otomatik olarak iptal edilmeden önce ne kadar süreyle geçerli olacağı.

"s" ile biten ve en fazla dokuz kesir basamağı olan, saniye cinsinden bir süre. Örnek: "3.5s".

AgentContentMessage

Temsilciden kullanıcıya gönderilen mesajın içeriği.

JSON gösterimi 
{
  "suggestions": [
    {
      object (Suggestion)
    }
  ],

  // Union field content can be only one of the following:
  "text": string,
  "fileName": string,
  "uploadedRbmFile": {
    object (UploadedRbmFile)
  },
  "richCard": {
    object (RichCard)
  },
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
Alanlar
suggestions[]

object (Suggestion)

İlişkili temsilci mesajından sonra öneri çiplerinin bir listesi olarak görünen önerilen yanıtların ve önerilen işlemlerin listesi. En fazla 11 öneri.

Çipler yalnızca ilişkili temsilci mesajı, görüşmedeki en son mesaj olduğunda (hem temsilci hem de kullanıcı mesajları dahil) gösterilir. Kullanıcı, metin yanıtını temsilciye göndermek için önerilen bir yanıta dokunabilir veya cihazda yerel bir işlem başlatmak için önerilen bir işleme dokunabilir.
Birleştirme alanı content. content aracısı mesajının içeriği aşağıdakilerden yalnızca biri olabilir:
text

string

UTF-8 olarak kodlanmış metin.
fileName
(deprecated)

string

Dosyanın benzersiz adı. Bir temsilci dosya yüklediğinde RBM platformu bir dosya adı döndürür. YüklenenRbmFile dosyası aşağıda kullanılmak üzere kullanımdan kaldırıldı
uploadedRbmFile

object (UploadedRbmFile)

RBM sunucusuna yüklenen ve sunucu tarafından sunulan bir dosya ve küçük resim için tanımlayıcılar içerir
richCard

object (RichCard)

Bağımsız bir zengin kart.
contentInfo

object (ContentInfo)

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

RBM platformu, bir önbellekten içerik sunar, ancak bir aracı, RBM platformunu içeriğin yeni bir sürümünü getirmeye ve önbelleği yenilemeye zorlayabilir.

UploadedRbmFile

Dosya ve küçük resim bilgilerini içeren ileti

JSON gösterimi 
{
  "fileName": string,
  "thumbnailName": string
}
Alanlar
fileName

string

Dosyanın, dosya yüklendiğinde RBM platformu tarafından döndürülen adı.
thumbnailName

string

Küçük resim yüklendiğinde RBM platformu tarafından döndürülen küçük resmin adı.

RichCard

Aracıdan kullanıcıya gönderilen zengin kart bandı veya bağımsız zengin kart.

JSON gösterimi 
{

  // Union field card can be only one of the following:
  "carouselCard": {
    object (CarouselCard)
  },
  "standaloneCard": {
    object (StandaloneCard)
  }
  // End of list of possible types for union field card.
}
Alanlar
Birleştirme alanı card. Bağımsız kart veya kart bandı. card şunlardan yalnızca biri olabilir:
carouselCard

object (CarouselCard)

Kart bandı.
standaloneCard

object (StandaloneCard)

Bağımsız kart.

CarouselCard

Kart bandı.

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

enum (CarouselCard.CardWidth)

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

object (CardContent)

Banttaki her kart için içerik listesi. Bant en az 2, en fazla 10 kart içerebilir.

CarouselCard.CardWidth

Banttaki kartların genişliği.

Sıralamalar
CARD_WIDTH_UNSPECIFIED Belirtilmedi.
SMALL 120 DPY. Uzun medyanın kullanılamayacağını unutmayın.
MEDIUM 232 DPY.

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ığı. En fazla 200 karakter.
description

string

(İsteğe bağlı) Kartın açıklaması. En fazla 2.000 karakter.
media

object (Media)

(İsteğe bağlı) Karta dahil edilecek medya (resim, GIF, video).
suggestions[]

object (Suggestion)

(İsteğe bağlı) Karta dahil edilecek önerilerin listesi. En fazla 4 öneri.

Medya

Zengin kart içindeki bir medya dosyası.

JSON gösterimi 
{
  "height": enum (Media.Height),

  // Union field content can be only one of the following:
  "fileName": string,
  "uploadedRbmFile": {
    object (UploadedRbmFile)
  },
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
Alanlar
height

enum (Media.Height)

Dikey düzende zengin kart içindeki medya yüksekliği. Yatay düzene sahip bağımsız bir kartta yükseklik özelleştirilemez ve bu alan yok sayılır.
Birleştirme alanı content. Medya içeriği content aşağıdakilerden yalnızca biri olabilir:
fileName
(deprecated)

string

Dosyanın, dosya yüklendiğinde RBM platformu tarafından döndürülen benzersiz adı. YüklenenRbmFile dosyası aşağıda kullanılmak üzere kullanımdan kaldırıldı
uploadedRbmFile

object (UploadedRbmFile)

RBM sunucusuna yüklenen ve sunucu tarafından sunulan bir dosya ve küçük resim için tanımlayıcılar içerir
contentInfo

object (ContentInfo)

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

RBM platformu, bir önbellekten içerik sunar, ancak bir aracı, RBM platformunu içeriğin yeni bir sürümünü getirmeye ve önbelleği yenilemeye zorlayabilir.

ContentInfo

İçerik bilgilerini içeren ileti.

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

string

Dosyanın herkese açık URL'si. RBM platformu, platform dosyayı getirdiğinde HTTP üstbilgilerindeki içerik türü alanından dosyanın MIME türünü belirler. İçerik türü alanı, URL'den gelen HTTP yanıtında mevcut ve doğru olmalıdır. Önerilen maksimum dosya boyutu 100 MB'tır.
thumbnailUrl

string

(İsteğe bağlı, yalnızca resim ve video dosyaları için) Küçük resmin herkese açık URL'si. Maksimum boyut 100 kB'tır.

Küçük resim URL'si sağlamazsanız kullanıcının cihazı dosyayı indirene kadar RBM platformu boş bir yer tutucu küçük resim görüntüler. Kullanıcının ayarlarına bağlı olarak dosya otomatik olarak indirilmeyebilir ve kullanıcının indir düğmesine dokunmasını gerektirebilir.
forceRefresh

boolean

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

Media.Height

Medya yüksekliği

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

Öneri

Zengin kartta veya öneri çipi listesinde yer alan önerilen bir yanıt ya da önerilen işlem.

JSON gösterimi 
{

  // Union field option can be only one of the following:
  "reply": {
    object (SuggestedReply)
  },
  "action": {
    object (SuggestedAction)
  }
  // End of list of possible types for union field option.
}
Alanlar
Birleştirme alanı option. Önerilen yanıt veya önerilen işlem (option) aşağıdakilerden yalnızca biri olabilir:
reply

object (SuggestedReply)

Kullanıcılar, önerilen bir yanıta dokunarak kısa mesaj yanıtını temsilciye geri gönderebilir.
action

object (SuggestedAction)

Kullanıcılar cihazda ilgili yerel işlemi başlatmak için önerilen bir işleme dokunabilir.

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 geri gönderilen metin. En fazla 25 karakter.
postbackData

string

Kullanıcı önerilen yanıta dokunduğunda bir kullanıcı etkinliğinde aracının aldığı base64 kodlu yük.

SuggestedAction

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

JSON gösterimi 
{
  "text": string,
  "postbackData": string,
  "fallbackUrl": string,

  // Union field action can be only one of the following:
  "dialAction": {
    object (DialAction)
  },
  "viewLocationAction": {
    object (ViewLocationAction)
  },
  "createCalendarEventAction": {
    object (CreateCalendarEventAction)
  },
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "shareLocationAction": {
    object (ShareLocationAction)
  }
  // End of list of possible types for union field action.
}
Alanlar
text

string

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

string

Kullanıcı önerilen işleme dokunduğunda ortaya çıkan kullanıcı etkinliğindeki aracıya gönderilecek yük (base64 kodlu)
fallbackUrl

string

(İsteğe bağlı) Bir istemci önerilen bir işlemi desteklemiyorsa kullanılacak yedek URL. Yedek URL'ler yeni tarayıcı pencerelerinde açılır.
Birleştirme alanı action. Kullanıcı önerilen action işlemine dokunduğunda cihazda başlatılan yerel işlem yalnızca aşağıdakilerden biri olabilir:
dialAction

object (DialAction)

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

object (ViewLocationAction)

Kullanıcının varsayılan harita uygulamasını açar ve aracı tarafından belirtilen konumu seçer veya aracı tarafından belirtilen bir sorguyla kullanıcının bulunduğu yerde arama yapar.
createCalendarEventAction

object (CreateCalendarEventAction)

Kullanıcının varsayılan takvim uygulamasını açar ve temsilci tarafından belirlenen etkinlik verileri önceden doldurulmuş olarak yeni takvim etkinliği akışını başlatır.
openUrlAction

object (OpenUrlAction)

Kullanıcının varsayılan web tarayıcısı uygulamasını belirtilen URL'de açar. Kullanıcı, URL için varsayılan işleyici olarak kayıtlı bir uygulama yüklemişse uygulama açılır ve simgesi, önerilen işlem kullanıcı arayüzünde kullanılır.
shareLocationAction

object (ShareLocationAction)

Kullanıcının temsilciye göndermek üzere bir konum seçebilmesi için RCS uygulamasının konum seçiciyi açar.

DialAction

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

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

string

E.164 biçimindeki telefon numarası (ör. +12223334444).

ViewLocationAction

Kullanıcının varsayılan harita uygulamasını açar ve aracı tarafından belirtilen konumu seçer veya aracı tarafından belirtilen bir sorguyla kullanıcının bulunduğu yerde arama yapar.

JSON gösterimi 
{
  "latLong": {
    object (LatLng)
  },
  "label": string,
  "query": string
}
Alanlar
latLong

object (LatLng)

(İsteğe bağlı) Belirtilen konumun enlem ve boylamı.
label

string

(İsteğe bağlı) LatLong'a bırakılan raptiyenin etiketi.
query

string

(İsteğe bağlı, yalnızca Android Mesajlar istemcilerinde desteklenir) Aracı latLong (ve isteğe bağlı olarak etiket) belirtmek yerine bir sorgu dizesi belirtebilir. Arama işlevini destekleyen varsayılan harita uygulamaları için (Google Haritalar dahil), bu önerilen işleme dokunmak, kullanıcının geçerli konumunun merkeze alınmış bir konum aramasıyla sonuçlanır. Sorgu yeterince spesifikse, aracılar dünyadaki herhangi bir konumu seçmek için bu sorguyu kullanabilir.

Örneğin, sorgu dizesi "Çiçek Ağacı Bankası" olarak ayarlanırsa kullanıcının yakınındaki tüm Bitki Bankası konumları gösterilir. Sorgu dizesi "1600 Amphitheater Parkway, Mountain View, CA 94043" olarak ayarlanırsa kullanıcının konumundan bağımsız olarak o adres seçilir.

LatLng

Enlem/boylam çiftini temsil eden bir nesne. Bu değer, enlem ve boylam derece ve boylam derecelerini temsil eden bir çift çiftle ifade edilir. Aksi belirtilmedikçe bu nesne WGS84 standardına uygun olmalıdır. Değerler normalleştirilmiş aralıklar içinde olmalıdır.

JSON gösterimi 
{
  "latitude": number,
  "longitude": number
}
Alanlar
latitude

number

Derece cinsinden enlem. [-90.0, +90.0] aralığında olmalıdır.
longitude

number

Derece cinsinden boylam. [-180.0, +180.0] aralığında olmalıdır.

CreateCalendarEventAction

Kullanıcının varsayılan takvim uygulamasını açar ve temsilci tarafından belirlenen etkinlik verileri önceden doldurulmuş olarak yeni takvim etkinliği akışını başlatır.

JSON gösterimi 
{
  "startTime": string,
  "endTime": string,
  "title": string,
  "description": string
}
Alanlar
startTime

string (Timestamp format)

Etkinlik başlangıç saati.

Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Etkinlik bitiş saati.

Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
title

string

Etkinlik başlığı.
description

string

Etkinlik açıklaması.

OpenUrlAction

Kullanıcının varsayılan web tarayıcısı uygulamasını belirtilen URL'de açar. Kullanıcı, URL için varsayılan işleyici olarak kayıtlı bir uygulama yüklemişse uygulama açılır ve simgesi, önerilen işlem kullanıcı arayüzünde kullanılır.

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

string

URL

ShareLocationAction

Bu türde alan yok.

Kullanıcının temsilciye geri göndermek üzere bir konum seçebilmesi için RCS uygulamasının konum seçiciyi açar.

StandaloneCard

Bağımsız kart

JSON gösterimi 
{
  "cardOrientation": enum (StandaloneCard.CardOrientation),
  "thumbnailImageAlignment": enum (StandaloneCard.ThumbnailImageAlignment),
  "cardContent": {
    object (CardContent)
  }
}
Alanlar
cardOrientation

enum (StandaloneCard.CardOrientation)

Kartın yönü.
thumbnailImageAlignment

enum (StandaloneCard.ThumbnailImageAlignment)

Yatay düzene sahip bağımsız kartlar için resim önizleme hizalaması.
cardContent

object (CardContent)

Kart içeriği.

StandaloneCard.CardOrientation

Kartın yönü.

Sıralamalar
CARD_ORIENTATION_UNSPECIFIED Belirtilmedi.
HORIZONTAL

Yatay düzen.

Yatay zengin kartın object(CardContent) kısmında media alanı varsa ayrıca en az bir title, description veya suggestions[] alanı da içermelidir.
VERTICAL Dikey düzen.

StandaloneCard.ThumbnailImageAlignment

Yatay düzene sahip bağımsız kartlar için resim önizleme hizalaması.

Sıralamalar
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED Belirtilmedi.
LEFT Dosya önizlemesi sola hizalandı.
RIGHT Dosya önizlemesi sağa hizalandı.

Yöntemler

create

 Temsilciden kullanıcıya mesaj gönderir.

delete

 Gönderilen ancak henüz teslim edilmeyen bir aracı mesajını iptal eder.