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

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.

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.

object (Representative)

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

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.

string

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

boolean

Opcjonalnie: Jeśli true, oznacza to, że wiadomość zawiera tekst sformatowany. Jeśli wiadomość ma nieprawidłowe formatowanie, Business Messages zwraca błąd.

string

SMS. Maksymalnie 3072 znaki.

object (Image)

Wiadomość o obrazie.

object (RichCard)

Wiadomość dotycząca karty informacyjnej.

{

  // 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)

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

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

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

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

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).

string

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

{

  // 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)

Samodzielna karta.

object (CarouselCard)

Karuzela kart.

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

object (CardContent)

Treść karty.

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

string

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

string

Opcjonalnie: Opis karty. Maksymalnie 2000 znaków.

object (Media)

Opcjonalnie: Multimedia do uwzględnienia na karcie.

object (Suggestion)

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

{
  "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)

Wysokość multimediów na karcie informacyjnej.

object (ContentInfo)

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

{

  // 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)

Sugestia użytkownika z określonym tekstem odpowiedzi.

object (SuggestedAction)

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

object (LiveAgentRequest)

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

object (AuthenticationRequest)

Żądanie rozpoczęcia procesu uwierzytelniania.

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

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.

string

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

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

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

string

Ciąg znaków, który agent otrzymuje, gdy użytkownik kliknie sugerowane działanie. Maksymalnie 2048 znaków.

object (OpenUrlAction)

Otwiera określony adres URL.

object (DialAction)

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

{
  "url": string
}

string

URL

{
  "phoneNumber": string
}

string

Wymagane. Podany numer telefonu w formacie RFC 3966. Przykład: „+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)

Szczegóły uwierzytelniania przez OAuth.

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

string

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

string

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

string

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

string

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

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

enum (CardWidth)

Szerokość kart w karuzeli.

object (CardContent)

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