REST Resource: conversations.messages

{
  "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.
}

string

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

string

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

object (Representative)

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

object (Suggestion)

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

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

string

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

boolean

Opsional. Jika true, menunjukkan bahwa pesan berisi rich text. Jika pesan berisi format yang tidak valid, Business Messages akan menampilkan error.

string

Pesan teks. Maksimum 3.072 karakter.

object (Image)

Pesan gambar.

object (RichCard)

Pesan Kartu Informasi.

{

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}

object (ContentInfo)

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

{
  "fileUrl": string,
  "thumbnailUrl": string,
  "forceRefresh": boolean,
  "altText": string
}

string

URL file yang dapat dijangkau secara publik. Platform menentukan jenis MIME file dari kolom tipe konten 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: gambar/jpeg, gambar/jpg, gambar/png, gambar/webp

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: gambar/jpeg, gambar/jpg, gambar/png, gambar/webp

boolean

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

string

Teks yang menjelaskan detail tentang media untuk tujuan aksesibilitas.

{

  // 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.
}

object (StandaloneCard)

Kartu mandiri.

object (CarouselCard)

Carousel kartu.

{
  "cardContent": {
    object (CardContent)
  }
}

object (CardContent)

Konten kartu.

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

string

Opsional. Judul kartu. Maksimum 200 karakter.

string

Opsional. Deskripsi kartu. Maksimum 2.000 karakter.

object (Media)

Opsional. Media yang akan disertakan dalam kartu.

object (Suggestion)

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

{
  "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.
}

enum (Height)

Tinggi media dalam kartu multimedia.

object (ContentInfo)

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

{

  // 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.
}

object (SuggestedReply)

Saran bagi pengguna untuk membalas dengan teks tertentu.

object (SuggestedAction)

Tindakan yang disarankan yang memulai tindakan native pada perangkat.

object (LiveAgentRequest)

Permintaan untuk mengundang agen langsung bergabung dalam percakapan.

object (AuthenticationRequest)

Permintaan untuk memulai alur autentikasi.

{
  "text": string,
  "postbackData": string
}

string

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

string

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

{
  "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.
}

string

Teks yang ditampilkan di tindakan yang disarankan. Maksimum 25 karakter.

string

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

object (OpenUrlAction)

Membuka URL yang ditentukan.

object (DialAction)

Membuka aplikasi telepon default pengguna.

{
  "url": string
}

string

URL

{
  "phoneNumber": string
}

string

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

{

  // 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.
}

object (Oauth)

Detail untuk autentikasi melalui OAuth.

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

string

Wajib. ID aplikasi yang meminta otorisasi.

string

Wajib. Tantangan kode yang digunakan untuk bertukar token akses.

string

Wajib. Array yang menentukan cakupan permintaan.

string

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

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

enum (CardWidth)

Lebar kartu di carousel.

object (CardContent)

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