REST Resource: conversations.messages

Zasób: wiadomość

Wiadomość w rozmowie między agentem a użytkownikiem.

Zapis 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.
}
Pola
name

string

Nazwa wiadomości ustawiona przez Business Messages. Przekształca on w „konwersacje/{confersationId}/messages/{messageId}”, gdzie {confersationId} to unikalny identyfikator rozmowy, a {messageId} to unikalny identyfikator wiadomości.
messageId

string

Wymagane. Unikalny identyfikator wiadomości przypisany przez agenta. Jeśli wiadomość spróbuje użyć tego samego elementu messageId co w poprzedniej wiadomości, może to wpłynąć na jej prawidłowe dostarczenie.
representative

object (Representative)

Dane przedstawiciela (człowieka lub czatbota), który wysłał wiadomość.
suggestions[]

object (Suggestion)

Lista sugerowanych odpowiedzi wyświetlana jako lista elementów z sugestią po powiązanej wiadomości. Maksymalnie 13 sugestii.

Elementy wyświetlają się tylko wtedy, gdy powiązana wiadomość jest najnowsza w wątku (obejmująca zarówno wiadomości agenta, jak i wiadomości użytkownika). Użytkownik może kliknąć sugerowaną odpowiedź, aby wysłać ją pracownikowi obsługi klienta.
fallback

string

Opcjonalnie: Tekst zastępczy wyświetlany, gdy urządzenie użytkownika nie obsługuje typu lub treści wiadomości. Maksymalnie 3072 znaki.
containsRichText

boolean

Opcjonalnie: Jeśli true, oznacza to, że wiadomość zawiera tekst sformatowany. Jeśli wiadomość ma nieprawidłowe formatowanie, Business Messages zwraca błąd.
Pole sumy content. Treść wiadomości. content może mieć tylko jedną z tych wartości:
text

string

SMS. Maksymalnie 3072 znaki.
image

object (Image)

Wiadomość o obrazie.
richCard

object (RichCard)

Wiadomość dotycząca karty informacyjnej.

Obraz

Obraz.

Zapis JSON 
{

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
Pola
Pole sumy content. Zawartość obrazu. content może mieć tylko jedną z tych wartości:
contentInfo

object (ContentInfo)

Informacje o obrazie, w tym jego adres URL i adres URL miniatury obrazu.

ContentInfo

Wiadomość zawierająca informacje o treści.

Zapis JSON 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "forceRefresh": boolean,
  "altText": string
}
Pola
fileUrl

string

Publicznie dostępny adres URL pliku. Podczas pobierania pliku przez platformę platforma określa typ MIME pliku na podstawie pola content-type w nagłówkach HTTP. Pole content-type musi być obecne i dokładne w odpowiedzi HTTP z adresu URL.

Maksymalnie 5 MB.

Obsługiwane typy treści: obraz/jpeg, obraz/jpg, obraz/png, obraz/webp
thumbnailUrl

string

Opcjonalnie: Publicznie dostępny adres URL miniatury.

Jeśli nie podasz adresu URL miniatury, platforma będzie wyświetlać pustą miniaturę zastępczą, dopóki urządzenie użytkownika nie pobierze pliku.

Maksymalnie 25 KB.

Obsługiwane typy treści: obraz/jpeg, obraz/jpg, obraz/png, obraz/webp
forceRefresh

boolean

Jeśli jest ustawione, platforma pobiera plik i miniaturę z określonych adresów URL, nawet jeśli ma w pamięci podręcznej kopie pliku (lub miniatury).
altText

string

Tekst opisujący szczegóły dotyczące multimediów w celach ułatwień dostępu.

RichCard

Samodzielna karta informacyjna lub karuzela kart informacyjnych wysłanych przez agenta do użytkownika.

Zapis 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.
}
Pola
Pole sumy card. Możliwe typy kart informacyjnych. card może mieć tylko jedną z tych wartości:
standaloneCard

object (StandaloneCard)

Samodzielna karta.
carouselCard

object (CarouselCard)

Karuzela kart.

StandaloneCard

Samodzielna karta.

Zapis JSON 
{
  "cardContent": {
    object (CardContent)
  }
}
Pola
cardContent

object (CardContent)

Treść karty.

CardContent

Treść karty.

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

string

Opcjonalnie: Tytuł karty. Maksymalnie 200 znaków.
description

string

Opcjonalnie: Opis karty. Maksymalnie 2000 znaków.
media

object (Media)

Opcjonalnie: Multimedia do uwzględnienia na karcie.
suggestions[]

object (Suggestion)

Opcjonalnie: Lista sugestii do uwzględnienia na karcie. Maksymalnie 4 sugestie.

Multimedia

Plik multimedialny na karcie informacyjnej.

Zapis 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.
}
Pola
height

enum (Height)

Wysokość multimediów na karcie informacyjnej.
Pole sumy content. Treści multimedialne. content może mieć tylko jedną z tych wartości:
contentInfo

object (ContentInfo)

Informacje o pliku, w tym adres URL pliku oraz adres URL jego miniatury.

Wysokość

Wysokość multimediów

Wartości w polu enum
HEIGHT_UNSPECIFIED Nie określono.
SHORT 112 DP.
MEDIUM 168 DP.
TALL 264 DP. Niedostępne w przypadku karuzel kart informacyjnych, gdy szerokość karty jest ustawiona na SMALL.

Sugestia

Sugestia na liście elementów.

Zapis 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.
}
Pola
Pole sumy option. Sugerowana odpowiedź. option może mieć tylko jedną z tych wartości:
reply

object (SuggestedReply)

Sugestia użytkownika z określonym tekstem odpowiedzi.
action

object (SuggestedAction)

Sugerowane działanie, które inicjuje natywne działanie na urządzeniu.
liveAgentRequest

object (LiveAgentRequest)

Prośba o dołączenie do rozmowy pracownika obsługi klienta.
authenticationRequest

object (AuthenticationRequest)

Żądanie rozpoczęcia procesu uwierzytelniania.

SuggestedReply

Po kliknięciu wysyła odpowiedź tekstową do pracownika obsługi klienta.

Zapis JSON 
{
  "text": string,
  "postbackData": string
}
Pola
text

string

Tekst, który wyświetla się w sugerowanej odpowiedzi i jest wysyłany do agenta, gdy użytkownik go kliknie. Maksymalnie 25 znaków.
postbackData

string

Ciąg znaków, który agent otrzymuje, gdy użytkownik kliknie sugerowaną odpowiedź. Maksymalnie 2048 znaków.

SuggestedAction

Po kliknięciu uruchamia odpowiednie działanie natywne na urządzeniu.

Zapis 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.
}
Pola
text

string

Tekst widoczny w sugerowanym działaniu. Maksymalnie 25 znaków.
postbackData

string

Ciąg znaków, który agent otrzymuje, gdy użytkownik kliknie sugerowane działanie. Maksymalnie 2048 znaków.
Pole sumy action. Działanie natywne inicjowane na urządzeniu, gdy użytkownik kliknie sugerowane działanie. action może mieć tylko jedną z tych wartości:
openUrlAction

object (OpenUrlAction)

Otwiera określony adres URL.
dialAction

object (DialAction)

Otwiera domyślną aplikację telefonu użytkownika.

OpenUrlAction

Otwiera określony adres URL.

Zapis JSON 
{
  "url": string
}
Pola
url

string

URL

DialAction

Otwiera domyślną aplikację telefonu użytkownika z wpisanym numerem telefonu.

Zapis JSON 
{
  "phoneNumber": string
}
Pola
phoneNumber

string

Wymagane. Podany numer telefonu w formacie RFC 3966. Przykład: „+1-201-555-0123”.

LiveAgentRequest

Ten typ nie zawiera pól.

Po kliknięciu wysyła prośbę o dołączenie do rozmowy pracownika obsługi klienta.

AuthenticationRequest

Żądanie uwierzytelnienia rozmowy.

Zapis 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.
}
Pola
Pole sumy authentication_type. Typ uwierzytelniania. authentication_type może mieć tylko jedną z tych wartości:
oauth

object (Oauth)

Szczegóły uwierzytelniania przez OAuth.

protokół OAuth

Szczegóły uwierzytelniania przez OAuth.

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

string

Wymagane. Identyfikator aplikacji, która prosi o autoryzację.
codeChallenge

string

Wymagane. Kod zabezpieczający używany do wymiany tokenów dostępu.
scopes[]

string

Wymagane. Tablica określająca zakresy żądania.
codeChallengeMethod

string

Opcjonalnie: Metoda weryfikacji kodu używana do generowania kodu zabezpieczającego. W przypadku pominięcia tego parametru serwer przyjmuje, że chodzi o plain.

CarouselCard

Karuzela kart.

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

enum (CardWidth)

Szerokość kart w karuzeli.
cardContents[]

object (CardContent)

Lista zawartości każdej karty w karuzeli. Karuzela może zawierać od 2 do 10 kart.

CardWidth

Szerokość kart w karuzeli.

Wartości w polu enum
CARD_WIDTH_UNSPECIFIED Nie określono
SMALL 136 DP. Nie można uwzględnić wysokich plików multimedialnych.
MEDIUM 280 dp.

Metody

create

 Wysyła wiadomość do użytkownika od agenta.

updateReceipt

 Wysyła do użytkownika potwierdzenie otrzymania wiadomości od agenta.