REST Resource: conversations.messages

Resource: Pesan

Pesan dalam percakapan antara agen dan pengguna.

Representasi JSON 
{
  "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.
}
Kolom
name

string

Nama pesan, seperti yang ditetapkan oleh Business Messages. Diselesaikan ke "conversations/{conversationId}/messages/{messageId}", dengan {conversationId} adalah ID unik untuk percakapan dan {messageId} merupakan ID unik pesannya.
messageId

string

Wajib. ID unik pesan, yang ditetapkan oleh agen. Jika pesan mencoba menggunakan messageId yang sama seperti pesan sebelumnya, pengiriman pesan yang benar dapat terpengaruh.
representative

object (Representative)

Detail tentang perwakilan (manusia atau chatbot) yang mengirim pesan.
suggestions[]

object (Suggestion)

Daftar balasan yang disarankan yang muncul sebagai daftar chip saran setelah pesan terkait. Maksimum 13 saran.

Chip hanya ditampilkan jika pesan terkait adalah pesan terbaru dalam percakapan (termasuk pesan pengguna dan agen). Pengguna dapat mengetuk balasan yang disarankan untuk mengirim balasan teks ke agen.
fallback

string

Opsional. Teks penggantian yang ditampilkan jika perangkat pengguna tidak mendukung jenis atau konten pesan. Maksimum 3.072 karakter.
containsRichText

boolean

Opsional. Jika true, menunjukkan bahwa pesan berisi rich text. Jika pesan berisi format yang tidak valid, Business Messages akan menampilkan error.
Kolom union content. Konten pesan. content hanya dapat berupa salah satu dari berikut:
text

string

Pesan teks. Maksimum 3.072 karakter.
image

object (Image)

Pesan gambar.
richCard

object (RichCard)

Pesan Kartu Multimedia.

Gambar

Gambar.

Representasi JSON 
{

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
Kolom
Kolom union content. Konten gambar. content hanya dapat berupa salah satu dari berikut:
contentInfo

object (ContentInfo)

Informasi tentang gambar, termasuk URL gambar dan URL thumbnail gambar.

ContentInfo

Pesan yang berisi informasi konten.

Representasi JSON 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "forceRefresh": boolean,
  "altText": string
}
Kolom
fileUrl

string

URL file yang dapat dijangkau secara publik. Platform menentukan jenis MIME file dari kolom content-type di header HTTP saat platform mengambil file. Kolom content-type harus ada dan akurat dalam respons HTTP dari URL.

Maksimum 5 MB.

Jenis konten yang didukung: image/jpeg, image/jpg, image/png, image/webp
thumbnailUrl

string

Opsional. URL thumbnail yang dapat dijangkau secara publik.

Jika Anda tidak memberikan URL thumbnail, platform akan menampilkan thumbnail placeholder kosong hingga perangkat pengguna mendownload file.

Maksimum 25 KB.

Jenis konten yang didukung: image/jpeg, image/jpg, image/png, image/webp
forceRefresh

boolean

Jika disetel, platform akan mengambil file dan thumbnail dari URL yang ditentukan, meskipun platform telah menyimpan salinan file tersebut (dan/atau thumbnail).
altText

string

Teks yang menjelaskan detail tentang media untuk tujuan aksesibilitas.

RichCard

Kartu informasi mandiri atau carousel kartu informasi yang dikirim dari agen kepada pengguna.

Representasi JSON 
{

  // 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.
}
Kolom
Kolom union card. Kemungkinan jenis kartu informasi. card hanya dapat berupa salah satu dari berikut:
standaloneCard

object (StandaloneCard)

Kartu mandiri.
carouselCard

object (CarouselCard)

Carousel kartu.

StandaloneCard

Kartu mandiri.

Representasi JSON 
{
  "cardContent": {
    object (CardContent)
  }
}
Kolom
cardContent

object (CardContent)

Konten kartu.

CardContent

Konten kartu.

Representasi JSON 
{
  "title": string,
  "description": string,
  "media": {
    object (Media)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ]
}
Kolom
title

string

Opsional. Judul kartu. Maksimum 200 karakter.
description

string

Opsional. Deskripsi kartu. Maksimum 2.000 karakter.
media

object (Media)

Opsional. Media yang akan disertakan dalam kartu.
suggestions[]

object (Suggestion)

Opsional. Daftar saran untuk disertakan dalam kartu. Maksimum 4 saran.

Media

File media dalam kartu informasi.

Representasi JSON 
{
  "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.
}
Kolom
height

enum (Height)

Tinggi media dalam kartu informasi.
Kolom union content. Konten media content hanya dapat berupa salah satu dari berikut:
contentInfo

object (ContentInfo)

Informasi tentang file, termasuk URL file dan URL thumbnail file.

Tinggi

Tinggi media

Enum
HEIGHT_UNSPECIFIED Tidak ditentukan.
SHORT 112 DP.
MEDIUM 168 DP.
TALL 264 DP. Tidak tersedia untuk carousel kartu informasi jika lebar kartu disetel ke SMALL.

Saran

Saran dalam daftar chip.

Representasi JSON 
{

  // 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.
}
Kolom
Kolom union option. Balasan yang disarankan. option hanya dapat berupa salah satu dari berikut:
reply

object (SuggestedReply)

Saran bagi pengguna untuk membalas dengan teks tertentu.
action

object (SuggestedAction)

Tindakan yang disarankan untuk memulai tindakan native di perangkat.
liveAgentRequest

object (LiveAgentRequest)

Permintaan agar agen langsung bergabung ke percakapan.
authenticationRequest

object (AuthenticationRequest)

Permintaan untuk memulai alur autentikasi.

SuggestedReply

Saat diketuk, balasan teks akan dikirim kembali ke agen.

Representasi JSON 
{
  "text": string,
  "postbackData": string
}
Kolom
text

string

Teks yang ditampilkan dalam balasan yang disarankan dan dikirim ke agen saat pengguna mengetuknya. Maksimum 25 karakter.
postbackData

string

String yang diterima agen saat pengguna mengetuk balasan yang disarankan. Maksimum 2.048 karakter.

SuggestedAction

Saat diketuk, tindakan native yang sesuai akan dimulai di perangkat.

Representasi JSON 
{
  "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.
}
Kolom
text

string

Teks yang ditampilkan dalam tindakan yang disarankan. Maksimum 25 karakter.
postbackData

string

String yang diterima agen saat pengguna mengetuk tindakan yang disarankan. Maksimum 2.048 karakter.
Kolom union action. Tindakan native yang dimulai di perangkat saat pengguna mengetuk tindakan yang disarankan. action hanya dapat berupa salah satu dari berikut:
openUrlAction

object (OpenUrlAction)

Membuka URL yang ditentukan.
dialAction

object (DialAction)

Membuka aplikasi pemanggil default pengguna.

OpenUrlAction

Membuka URL yang ditentukan.

Representasi JSON 
{
  "url": string
}
Kolom
url

string

URL

DialAction

Membuka aplikasi telepon default pengguna dengan isian nomor telepon yang ditentukan.

Representasi JSON 
{
  "phoneNumber": string
}
Kolom
phoneNumber

string

Wajib. Nomor telepon yang ditentukan, dalam format RFC 3966. Misalnya, "+62-201-555-0123".

LiveAgentRequest

Jenis ini tidak memiliki kolom.

Saat diketuk, permintaan akan dikirimkan kepada agen langsung untuk bergabung ke percakapan.

AuthenticationRequest

Permintaan untuk mengautentikasi percakapan.

Representasi JSON 
{

  // 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.
}
Kolom
Kolom union authentication_type. Jenis autentikasi. authentication_type hanya dapat berupa salah satu dari berikut:
oauth

object (Oauth)

Detail untuk autentikasi melalui OAuth.

OAuth

Detail untuk autentikasi melalui OAuth.

Representasi JSON 
{
  "clientId": string,
  "codeChallenge": string,
  "scopes": [
    string
  ],
  "codeChallengeMethod": string
}
Kolom
clientId

string

Wajib. ID aplikasi yang meminta otorisasi.
codeChallenge

string

Wajib. Tantangan kode yang digunakan untuk menukar token akses.
scopes[]

string

Wajib. Array yang menentukan cakupan permintaan.
codeChallengeMethod

string

Opsional. Metode tantangan kode yang digunakan untuk membuat tantangan kode. Jika parameter ini dihilangkan, server mengasumsikan plain.

CarouselCard

Carousel kartu.

Representasi JSON 
{
  "cardWidth": enum (CardWidth),
  "cardContents": [
    {
      object (CardContent)
    }
  ]
}
Kolom
cardWidth

enum (CardWidth)

Lebar kartu di carousel.
cardContents[]

object (CardContent)

Daftar konten untuk setiap kartu dalam carousel. Carousel dapat memiliki minimal 2 kartu dan maksimal 10 kartu.

CardWidth

Lebar kartu di carousel.

Enum
CARD_WIDTH_UNSPECIFIED Tidak ditentukan
SMALL 136 DP. Tidak dapat menyertakan media tinggi.
MEDIUM 280 DP.

Metode

create

 Mengirim pesan dari agen ke pengguna.

updateReceipt

 Mengirim tanda terima pesan dari agen ke pengguna.