REST Resource: phones.agentMessages

Kaynak: AgentMessage

Temsilciden kullanıcıya gönderilen mesaj.

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

  // 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. Aracı mesajı oluştururken bu bilgiyi eklemeyin. Alan, "phones/{E.164}/agentMessages/{messageId}" ifadesini çözümler. Burada {E.164}, kullanıcının E.164 biçimindeki telefon numarası, {messageId} ise temsilci mesajının temsilci tarafından atanmış kimliğidir.
sendTime

string (Timestamp format)

Bu alan, RBM platformu tarafından ayarlanır. Aracı mesajı oluştururken bu bilgiyi eklemeyin. Bu alan, iletinin kullanıcıya gönderildiği zamanı gösterir.

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanır. "Z" dışındaki saat farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".
contentMessage

object (AgentContentMessage)

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

enum (MessageTrafficType)

İleti trafiği türü.

Birleştirme alanı expiration.

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

string (Timestamp format)

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

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanır. "Z" dışındaki saat farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".
ttl

string (Duration format)

İsteğe bağlıdır. Yalnızca giriş. İletinin otomatik olarak iptal edilmeden önce ne kadar süre boyunca geçerli olacağı.

En fazla dokuz kesirli basamak içeren ve "s" ile biten, 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 temsilci mesajının ardından öneri çipleri listesi olarak görünen, önerilen yanıtlar ve önerilen işlemler 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 yanıtlardan birine dokunabilir veya cihazda yerel bir işlem başlatmak için önerilen işlemlerden birine dokunabilir. En fazla 11 öneri.
Birleştirme alanı content. Aracı mesajının içeriği content yalnızca aşağıdakilerden biri olabilir:
text

string

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

string

Dosyanın benzersiz adı. Bir aracı dosya yüklediğinde RBM platformu bir dosya adı döndürür. Aşağıdaki uploadedRbmFile yerine kullanımdan kaldırıldı
uploadedRbmFile

object (UploadedRbmFile)

RBM sunucusuna yüklenen ve bu sunucu tarafından sunulan bir dosya ile 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 de dahil olmak üzere dosya hakkında bilgiler.

RBM platformu, içeriği önbellekten sunar ancak bir temsilci, 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 resmin adı. Küçük resim yüklendiğinde RBM platformu tarafından döndürülür.

RichCard

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
Birleştirme 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)

Seçmeli listedeki her kartın içerik listesi. Bir bantta 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. Uzun medya öğelerinin kullanılamadığını unutmayın.
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ığı. 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 eklenecek medya (resim, GIF, video, PDF).
suggestions[]

object (Suggestion)

(İsteğe bağlı) Karta eklenecek öneri listesi. En fazla 10 ö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üzene sahip bir zengin karttaki medyanın yüksekliği. Yatay düzene sahip bağımsız bir kartta 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

Dosyanın, RBM platformu tarafından dosya yüklendiğinde döndürülen benzersiz adı. Aşağıdaki uploadedRbmFile yerine kullanımdan kaldırıldı
uploadedRbmFile

object (UploadedRbmFile)

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

object (ContentInfo)

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

RBM platformu, içeriği önbellekten sunar ancak bir temsilci, 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 olarak erişilebilen URL'si. RBM platformu, dosyayı getirdiğinde HTTP üstbilgilerindeki content-type 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.

Not: Dosya URL'lerindeki yönlendirmeler desteklenmez. Yönlendirme gerekiyorsa lütfen CreateFileRequest'i kullanın.
thumbnailUrl

string

(İsteğe bağlı, yalnızca resim, ses ve video dosyaları için) Küçük resmin herkese açık olarak erişilebilen URL'si. Maksimum boyut 100 KB.

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. Kullanıcının ayarlarına bağlı olarak dosya otomatik olarak indirilmeyebilir ve kullanıcının bir indirme düğmesine dokunması gerekebilir.

Not: Dosya URL'lerindeki yönlendirmeler desteklenmez. Yönlendirme gerekiyorsa lütfen CreateFileRequest'i kullanın.
forceRefresh

boolean

Ayarlanırsa RBM platformu, dosyanın (ve/veya küçük resmin) önbelleğe alınmış kopyaları olsa bile dosyayı ve küçük resmi belirtilen URL'lerden 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 karusellerinde kullanılamaz.

Öneri

Zengin kartta veya öneri çipi listesinde yer alan önerilen 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 yalnızca aşağıdakilerden biri olabilir:
reply

object (SuggestedReply)

Kullanıcılar, metin yanıtını temsilciye geri göndermek için önerilen yanıtlardan birine dokunabilir.
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ı tekrar aracıya 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 aracının 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)
  }
  // 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ğinde aracıya gönderilecek yük (base64 kodlu). En fazla 2.048 karakter.
fallbackUrl

string

(İsteğe bağlı) Bir istemci önerilen 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ı doldurulmuş olarak açar.
viewLocationAction

object (ViewLocationAction)

Kullanıcının varsayılan harita uygulamasını açar ve temsilci tarafından belirtilen konumu seçer veya temsilci tarafından belirtilen bir sorguyla kullanıcının konumunun çevresinde arama yapar.
createCalendarEventAction

object (CreateCalendarEventAction)

Kullanıcının varsayılan takvim uygulamasını açar ve yeni takvim etkinliği akışını, aracı tarafından belirtilen etkinlik verileri önceden doldurulmuş şekilde 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ının, URL için varsayılan işleyici olarak kaydedilmiş bir uygulaması yüklüyse bunun yerine bu uygulama açılır ve önerilen işlem kullanıcı arayüzünde bu uygulamanın simgesi kullanılır.
shareLocationAction

object (ShareLocationAction)

Kullanıcının temsilciye göndereceği konumu seçebilmesi için RCS uygulamasının konum seçicisini 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 temsilci tarafından belirtilen konumu seçer veya temsilci tarafından belirtilen bir sorguyla kullanıcının konumunun çevresinde arama yapar.

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

object (LatLng)

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

string

(İsteğe bağlı) latLong'da bırakılan iğnenin etiketi.
query

string

(İsteğe bağlıdır ve yalnızca Android Mesajlar istemcilerinde desteklenir) Temsilci, latLong (ve isteğe bağlı olarak bir etiket) belirtmek yerine bir 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 konumunun merkezinde bir konum araması yapılır. Sorgu yeterince spesifikse temsilciler, dünyadaki herhangi bir konumu seçmek için bu sorguyu kullanabilir.

Ö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 Amphitheater Parkway, Mountain View, CA 94043" olarak ayarlamak, kullanıcının konumundan bağımsız olarak söz konusu adresi seçer.

LatLng

Bir enlem/boylam çiftini temsil eden nesne. Bu değer, enlem derecelerini ve boylam derecelerini temsil eden bir çift çift sayı 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

Enlem (derece cinsinden). [-90.0, +90.0] aralığında olmalıdır.
longitude

number

Boylam (derece cinsinden). [-180.0, +180.0] aralığında olmalıdır.

CreateCalendarEventAction

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

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

string (Timestamp format)

Etkinliğin başlangıç saati.

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanır. "Z" dışındaki saat farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Etkinlik bitiş zamanı.

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanır. "Z" dışındaki saat farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".
title

string

Etkinlik adı. 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ının, URL için varsayılan işleyici olarak kaydedilmiş bir uygulaması yüklüyse bunun yerine bu uygulama açılır ve önerilen işlem kullanıcı arayüzünde bu uygulamanın simgesi 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 açma uygulaması, tarayıcı veya web görünümü. Kullanıcının cihazının web görünümü modunu destekleyip desteklemediğini kontrol etmek için önce bir özellik kontrolü yapı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)

WebView için görüntüleme modu
description

string

WebView için erişilebilirlik açıklaması.

OpenUrlApplication

URL açma uygulamasının türü

Sıralamalar
OPEN_URL_APPLICATION_UNSPECIFIED Belirtilmedi, açmak için tarayıcı kullanılacak.
BROWSER URL'yi açmak için tarayıcıyı kullanın.
WEBVIEW URL'yi entegre web görünümü penceresinde açma

WebviewViewMode

WebView'ın görünüm modunun türü.

Sıralamalar
WEBVIEW_VIEW_MODE_UNSPECIFIED Belirtilmedi. WebView'ı kullanmak için bir görünüm modu belirtilmelidir.
FULL Durum çubuğunda Chatbot görüşmesi etiketli tam ekran yer paylaşımı gerektirir.
HALF Yarım ekran yerleşimi gerektirir.
TALL Ekranın dörtte üçünü kaplayan bir yer paylaşımı gerektirir.

ShareLocationAction

Bu türde alan yok.

Kullanıcının temsilciye geri göndereceği konumu seçebilmesi için RCS uygulamasının konum seçicisini 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) bölümü media alanını içeriyorsa 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 hizalanır.
RIGHT Dosya önizlemesi sağa hizalanmış.

MessageTrafficType

Desteklenen mesaj trafiği türleri. Enum, ek trafik türlerini destekleyecek şekilde genişletilecek.

Sıralamalar
MESSAGE_TRAFFIC_TYPE_UNSPECIFIED Varsayılan davranış: Mesaj trafiği türü, temsilcinin kullanım alanına göre belirlenir. İleti içeriğine göre trafik türünü gerektiği şekilde güncelleyin. Çok kullanımlı aracıların varsayılan değeri yoktur. Trafik türü manuel olarak ayarlanmalıdır (ör. TRANSACTION, PROMOTION).
AUTHENTICATION OTP aracısı kullanım alanındaki kimlik doğrulama mesajları için.
TRANSACTION İşlem veya çok kullanımlı aracı kullanım alanlarındaki işlem mesajları için.
PROMOTION Tanıtım veya çok amaçlı aracı kullanım alanlarındaki tanıtım amaçlı mesajlar için.
SERVICEREQUEST Kullanıcının almayı kabul ettiği hizmetlerle ilgili mesajlar için. OTP, İşlem, Tanıtım veya Çok Kullanımlı aracı kullanım alanlarında kullanılır.
ACKNOWLEDGEMENT Kullanıcının e-posta listesinden çıkma isteğini onaylayan iletiler için. OTP, İşlem, Tanıtım veya Çok Kullanımlı aracı kullanım alanlarında kullanılır.

Yöntemler

create

 Temsilciden kullanıcıya mesaj gönderir.

delete

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