REST Resource: phones.agentMessages

Kaynak: AgentMessage

Temsilciden kullanıcıya gönderilen bir 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 belirlenir. Temsilci mesajı oluştururken bu mesajı eklemeyin. Alan, "phones/{E.164}/agentMessages/{messageId}" değerini çözer. Burada {E.164}, kullanıcının E.164 biçimindeki telefon numarasıdır ve {messageId}, müşteri temsilcisi mesajının müşteri temsilcisi tarafından atanan kimliğidir.
sendTime

string (Timestamp format)

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

Nanosaniye çözünürlüğüne sahip ve en fazla dokuz kesirli basamak içeren 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.

Birlik alanı expiration.

expiration yalnızca aşağıdakilerden biri olabilir:
expireTime

string (Timestamp format)

İsteğe bağlı. Bu kaynağın geçerliliğinin sona erdiği kabul edilen zamanın UTC zaman damgası. Bu değer, ayarlanmışsa veya TTL alanı ayarlanmışsa çıkışta sağlanır.

Nanosaniye çözünürlüğüne sahip ve en fazla dokuz kesirli basamak içeren 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ş. Mesajın otomatik olarak iptal edilmeden önce ne kadar süreyle yayınlanacağı.

"s" ile biten, en fazla dokuz kesir basamağı içeren, saniye cinsinden 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)

İlgili müşteri temsilcisi mesajının ardından öneri çipleri listesi olarak görünen önerilen yanıtlar 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 geri göndermek için önerilen bir yanıta veya cihazda yerel bir işlem başlatmak için önerilen bir işleme dokunabilir. En fazla 11 öneri.
Birlik alanı content. Temsilci mesajının content içeriği aşağıdakilerden yalnızca biri olabilir:
text

string

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

string

Dosyanın benzersiz adı. RBM platformu, bir müşteri temsilcisi dosya yüklediğinde dosya adını döndürür. Aşağıdaki uploadedRbmFile için desteği sonlandırıldı
uploadedRbmFile

object (UploadedRbmFile)

RBM sunucusuna yüklenen ve sunucu tarafından sunulan bir dosyanın ve küçük resmin tanımlayıcılarını içerir
richCard

object (RichCard)

Bağımsız bir zengin kart.
contentInfo

object (ContentInfo)

Dosyanın URL'si ve küçük resminin URL'si dahil olmak üzere dosyayla ilgili bilgiler.

RBM platformu ö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 mesaj

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

string

Dosya yüklendiğinde RBM platformu tarafından döndürülen dosyanın adı.
thumbnailName

string

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

Zengin Kart

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

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
Birlik alanı card. Bağımsız kart veya kart bandı. card yalnızca aşağıdakilerden 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ın içeriğinin listesi. Ruloda en az 2, en fazla 10 kart olabilir.

CarouselCard.CardWidth

Banttaki kartların genişliği.

Sıralamalar
CARD_WIDTH_UNSPECIFIED Belirtilmedi.
SMALL 120 DP. Yüksek medya kullanılamaz.
MEDIUM 232 DP.

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ı. En fazla 2.000 karakter.
media

object (Media)

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

object (Suggestion)

(İsteğe bağlı) Karta eklenecek önerilerin listesi. En fazla 10 öneri.

Medya

Zengin karttaki 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üzene sahip zengin kart içindeki medyanın yüksekliği. Yatay düzene sahip bağımsız kartlarda yükseklik özelleştirilemez ve bu alan yoksayılır.
Birleştirme alanı content. Medya içeriği content yalnızca aşağıdakilerden biri olabilir:
fileName
(deprecated)

string

Dosya yüklendiğinde RBM platformu tarafından döndürülen, dosyanın benzersiz adı. Aşağıdaki uploadedRbmFile için desteği sonlandırıldı
uploadedRbmFile

object (UploadedRbmFile)

RBM sunucusuna yüklenen ve sunucu tarafından sunulan bir dosyanın ve küçük resmin tanımlayıcılarını içerir
contentInfo

object (ContentInfo)

Dosyanın URL'si ve küçük resminin URL'si dahil olmak üzere dosyayla ilgili bilgiler.

RBM platformu ö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 mesaj.

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

string

Dosyanın herkese açık URL'si. RBM platformu, dosyayı getirirken HTTP üstbilgilerindeki content-type 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. Önerilen maksimum dosya boyutu 100 MB'tır.
thumbnailUrl

string

(İsteğe bağlı, yalnızca resim, ses 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 RBM platformu, kullanıcının cihazı dosyayı indirene kadar boş bir yer tutucu küçük resim gösterir. Dosya, kullanıcının ayarına bağlı olarak otomatik olarak indirilmeyebilir ve kullanıcının bir indirme düğmesine dokunmasını gerektirebilir.
forceRefresh

boolean

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

Media.Height

Medya yüksekliği

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

Öneri

Zengin kartta veya öneri çipi listesinde yer alan önerilen bir yanıt veya ö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
Birlik 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, metin yanıtını 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. Maksimum 25 karakter.
postbackData

string

Kullanıcı önerilen yanıta dokunduğunda aracının bir kullanıcı etkinliğinde 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)
  },
  "composeAction": {
    object (ComposeAction)
  }
  // End of list of possible types for union field action.
}
Alanlar
text

string

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

string

Kullanıcı önerilen işleme dokunduğunda gerçekleşen kullanıcı etkinliğinde temsilciye gönderilecek yük (base64 kodlu). En fazla 2.048 karakter.
fallbackUrl

string

(İsteğe bağlı) İstemci önerilen bir işlemi desteklemiyorsa kullanılacak yedek URL. Yedek URL'ler yeni tarayıcı pencerelerinde açılır. RFC 3986'da tanımlandığı şekilde geçerli bir URI olmalıdır. En fazla 2.048 karakter.
Birleştirme alanı action. Kullanıcı önerilen işleme action 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ının doldurulduğu şekilde açar.
viewLocationAction

object (ViewLocationAction)

Kullanıcının varsayılan harita uygulamasını açar ve müşteri temsilcisi tarafından belirtilen konumu seçer veya müşteri temsilcisi tarafından belirtilen bir sorgu verildiğinde kullanıcının konumunun çevresinde arama yapar.
createCalendarEventAction

object (CreateCalendarEventAction)

Kullanıcının varsayılan takvim uygulamasını açar ve temsilci tarafından belirtilen 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'ye açar. Kullanıcı, URL için varsayılan işleyici olarak kayıtlı bir uygulama yüklemişse onun yerine bu 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çicisini açar.
composeAction

object (ComposeAction)

Chatbot ile önceden tanımlanmış bir hedefe mesaj oluşturup gönderme

DialAction

Kullanıcının varsayılan numara çevirici uygulamasını, temsilci tarafından belirtilen telefon numarasının doldurulduğu şekilde 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 sorguya göre kullanıcının bulunduğu konumda 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 noktasına bırakılan raptiyenin etiketi.
query

string

(İsteğe bağlı, yalnızca Android Mesajlar istemcilerinde desteklenir) Temsilci, latLong (ve isteğe bağlı olarak bir etiket) belirtmek yerine sorgu dizesi belirtebilir. Arama işlevini destekleyen varsayılan harita uygulamalarında (Google Haritalar dahil) bu önerilen işleme dokunulduğunda, kullanıcının mevcut konumu merkeze alınarak bir konum araması yapılır. Sorgu yeterince spesifikse temsilciler bu sorguyu kullanarak dünyadaki herhangi bir konumu seçebilir.

Örneğin, sorgu dizesini "Altın Akçe Bankası" olarak ayarladığınızda kullanıcının yakınındaki tüm Altın Akçe Bankası konumları gösterilir. Sorgu dizesini "1600 Amphitheatre Parkway, Mountain View, CA 94043" olarak ayarladığınızda kullanıcının konumundan bağımsız olarak bu adres seçilir.

LatLng

Bir enlem/boylam çiftini temsil eden nesne. Bu değer, enlem derecelerini ve boylam derecelerini temsil eden bir çift çift olarak ifade edilir. Aksi belirtilmediği sürece 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 belirtilen 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)

Etkinliğin başlangıç zamanı.

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

string (Timestamp format)

Etkinlik bitiş zamanı.

Nanosaniye çözünürlüğüne sahip ve en fazla dokuz kesirli basamak içeren 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ığı. En fazla 100 karakter.
description

string

Etkinlik açıklaması. Maksimum 500 karakter.

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 onun yerine bu uygulama açılır ve simgesi, önerilen işlem kullanıcı arayüzünde kullanılır.

JSON gösterimi 
{
  "url": string,
  "application": enum (OpenUrlApplication),
  "webviewViewMode": enum (WebviewViewMode),
  "description": string
}
Alanlar
url

string

aşağıdaki URL’yi ziyaret edebilirsiniz. RFC 3986'da tanımlandığı şekilde geçerli bir URI olmalıdır. En fazla 2.048 karakter.
application

enum (OpenUrlApplication)

URL'yi uygulama, tarayıcı veya web görünümünde açma. Kullanıcının cihazının web görünümü modunu destekleyip desteklemediğini kontrol etmek için önce bir özellik kontrolü çalıştırın. Ayrıntılar için dokümanlara bakın: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities.
webviewViewMode

enum (WebviewViewMode)

Web Görünümü için görüntüleme modu
description

string

Web Görünümü için erişilebilirlik açıklaması.

OpenUrlApplication

URL açık başvurusunun türü

Sıralamalar
OPEN_URL_APPLICATION_UNSPECIFIED Belirtilmemişse tarayıcıyı kullanarak açılır.
BROWSER URL'yi açmak için tarayıcıyı kullanın.
WEBVIEW URL'yi entegre web görünümü penceresinde aç

WebviewViewMode

Web görünümünün görünüm modunun türü.

Sıralamalar
WEBVIEW_VIEW_MODE_UNSPECIFIED Belirtilmedi. Web Görünümü'nü kullanmak için bir görüntüleme modu belirtilmelidir.
FULL Chatbot görüşmesinin durum çubuğunda etiketlendiği tam ekran yer paylaşımı gerektirir.
HALF Yarım ekran yer paylaşımı gerekir.
TALL Üç çeyrek ekran yer paylaşımı gerekir.

ShareLocationAction

Bu türde alan yoktur.

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

ComposeAction

Chatbot tarafından önceden tanımlanmış bir hedefe mesaj oluşturup gönderme. Kullanıcının cihazının bu işlemi destekleyip desteklemediğini kontrol etmek için önce bir özellik kontrolü çalıştırın. Ayrıntılar için dokümanlara bakın: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities.

JSON gösterimi 
{

  // Union field action can be only one of the following:
  "composeTextMessage": {
    object (ComposeAction.ComposeTextMessage)
  },
  "composeRecordingMessage": {
    object (ComposeAction.ComposeRecordingMessage)
  }
  // End of list of possible types for union field action.
}
Alanlar

Birlik alanı action.

action şunlardan yalnızca biri olabilir:
composeTextMessage

object (ComposeAction.ComposeTextMessage)

Kısa mesaj oluşturup gönderme.
composeRecordingMessage

object (ComposeAction.ComposeRecordingMessage)

Sesli veya görüntülü mesaj kaydını başlatın ve gönderin.

ComposeAction.ComposeTextMessage

Bir kısa mesaj oluşturun ve gönderin.

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

string

Hedef telefon numarası, sohbet botu tarafından önceden doldurulur.
text

string

Taslak, mesaj gönderme metin alanına gider.

ComposeAction.ComposeRecordingMessage

Sesli veya görüntülü mesaj kaydetme ve gönderme işlemlerini başlatma.

JSON gösterimi 
{
  "phoneNumber": string,
  "type": enum (ComposeRecordingActionType)
}
Alanlar
phoneNumber

string

Chatbot tarafından önceden doldurulmuş hedef telefon numarası.
type

enum (ComposeRecordingActionType)

Kayıt işleminin türü.

ComposeRecordingActionType

Kayıt oluşturma işleminin türü.

Sıralamalar
COMPOSE_RECORDING_ACTION_TYPE_UNSPECIFIED Belirtilmedi.
ACTION_TYPE_AUDIO Ses türü.
ACTION_TYPE_VIDEO Video türü.

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üzenle 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) alanında media alanı varsa 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 hizası.

Sıralamalar
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED Belirtilmedi.
LEFT Dosya önizlemesi solda hizalanır.
RIGHT Dosya önizlemesi sağa hizalandı.

Yöntemler

create

 Temsilciden bir kullanıcıya mesaj gönderir.

delete

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