REST Resource: phones.agentMessages

Zasób: AgentMessage

Wiadomość wysłana przez agenta do użytkownika.

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

string

To pole jest ustawiane przez platformę RBM. Nie uwzględniaj go podczas tworzenia wiadomości agenta. Pole przyjmuje wartość „phones/{E.164}/agentMessages/{messageId}”, gdzie {E.164} to numer telefonu użytkownika w formacie E.164, a {messageId} to identyfikator wiadomości od agenta przypisany przez agenta.
sendTime

string (Timestamp format)

To pole jest ustawiane przez platformę RBM. Nie uwzględniaj go podczas tworzenia wiadomości agenta. To pole określa czas wysłania wiadomości do użytkownika.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
contentMessage

object (AgentContentMessage)

Treść wiadomości agenta.
messageTrafficType

enum (MessageTrafficType)

Typ ruchu wiadomości.

Pole zbiorcze expiration.

Pole expiration może mieć tylko jedną z tych wartości:
expireTime

string (Timestamp format)

Opcjonalnie. Sygnatura czasowa UTC wskazująca, kiedy zasób jest uznawany za nieaktualny. Ta wartość jest podawana w danych wyjściowych, jeśli jest ustawiona lub jeśli ustawione jest pole TTL.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
ttl

string (Duration format)

Opcjonalnie. Tylko dane wejściowe. Jak długo wiadomość będzie dostępna, zanim zostanie automatycznie wycofana.

Czas trwania w sekundach z maksymalnie 9 miejscami po przecinku, zakończony znakiem „s”. Przykład: "3.5s".

AgentContentMessage

Treść wiadomości wysłanej przez agenta do użytkownika.

Zapis JSON 
{
  "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.
}
Pola
suggestions[]

object (Suggestion)

Lista sugerowanych odpowiedzi i sugerowanych działań, które pojawiają się jako lista sugestii po powiązanej wiadomości od agenta. Maksymalnie 11 sugestii.

Karty są wyświetlane tylko wtedy, gdy powiązana z nimi wiadomość agenta jest najnowszą wiadomością w rozmowie (obejmuje to zarówno wiadomości agenta, jak i użytkownika). Użytkownik może kliknąć sugerowaną odpowiedź, aby wysłać tekstową odpowiedź do agenta, lub kliknąć sugerowane działanie, aby zainicjować natywne działanie na urządzeniu. Maksymalnie 11 sugestii.
Pole zbiorcze content. Treść wiadomości agenta content może być tylko jedną z tych wartości:
text

string

Tekst zakodowany w UTF-8. Maksymalnie 3072 znaki.
fileName
(deprecated)

string

Unikalna nazwa pliku. Gdy agent przesyła plik, platforma RBM zwraca jego nazwę. Wycofane na rzecz przesłanego pliku RBM poniżej
uploadedRbmFile

object (UploadedRbmFile)

Zawiera identyfikatory pliku i miniatury przesłanych na serwer RBM i przez niego wyświetlanych.
richCard

object (RichCard)

Samodzielna karta informacyjna.
contentInfo

object (ContentInfo)

Informacje o pliku, w tym adres URL pliku i adres URL miniatury pliku.

Platforma RBM wyświetla treści z pamięci podręcznej, ale agent może wymusić pobranie nowej wersji treści i odświeżenie pamięci podręcznej.

UploadedRbmFile

Wiadomość zawierająca informacje o pliku i miniaturze

Zapis JSON 
{
  "fileName": string,
  "thumbnailName": string
}
Pola
fileName

string

Nazwa pliku zwrócona przez platformę RBM podczas przesyłania pliku.
thumbnailName

string

Nazwa miniatury zwracana przez platformę RBM po przesłaniu miniatury.

RichCard

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

Zapis JSON 
{

  // 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.
}
Pola
Pole zbiorcze card. pojedyncza karta lub karuzela kart. card może mieć tylko jedną z tych wartości:
carouselCard

object (CarouselCard)

Karuzela kart.
standaloneCard

object (StandaloneCard)

Samodzielna karta.

CarouselCard

Karuzela kart.

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

enum (CarouselCard.CardWidth)

Szerokość kart w karuzeli.
cardContents[]

object (CardContent)

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

CarouselCard.CardWidth

Szerokość kart w karuzeli.

Wartości w polu enum
CARD_WIDTH_UNSPECIFIED Nie określono.
SMALL 120 DP. Pamiętaj, że nie można używać wysokich multimediów.
MEDIUM 232 DP.

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) Media (obraz, GIF, film, PDF), które mają być uwzględnione na karcie.
suggestions[]

object (Suggestion)

(Opcjonalnie) Lista sugestii do umieszczenia na karcie. Maksymalnie 4 sugestie.

Multimedia

Plik multimedialny na karcie informacyjnej.

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

enum (Media.Height)

Wysokość elementu multimedialnego na karcie informacyjnej z układem pionowym. W przypadku samodzielnej karty z układem poziomym wysokość nie jest konfigurowalna, a to pole jest ignorowane.
Pole zbiorcze content. Treści multimedialne content mogą mieć tylko jedną z tych wartości:
fileName
(deprecated)

string

Unikalna nazwa pliku zwrócona przez platformę RBM podczas przesyłania pliku. Wycofane na rzecz przesłanego pliku RBM poniżej
uploadedRbmFile

object (UploadedRbmFile)

Zawiera identyfikatory pliku i miniatury przesłanych na serwer RBM i przez niego wyświetlanych.
contentInfo

object (ContentInfo)

Informacje o pliku, w tym adres URL pliku i adres URL miniatury pliku.

Platforma RBM wyświetla treści z pamięci podręcznej, ale agent może wymusić pobranie nowej wersji treści i odświeżenie pamięci podręcznej.

ContentInfo

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

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

string

Publicznie dostępny adres URL pliku. Platforma RBM określa typ MIME pliku na podstawie pola content-type w nagłówkach HTTP, gdy pobiera plik. Pole content-type musi być obecne i prawidłowe w odpowiedzi HTTP z adresu URL. Zalecany maksymalny rozmiar pliku to 100 MB.

Uwaga: przekierowania w adresach URL plików nie są obsługiwane. Jeśli potrzebne jest przekierowanie, użyj CreateFileRequest.
thumbnailUrl

string

(Opcjonalnie, tylko w przypadku plików graficznych, audio i wideo) Publicznie dostępny adres URL miniatury. Maksymalny rozmiar to 100 KB.

Jeśli nie podasz adresu URL miniatury, platforma RBM będzie wyświetlać pustą miniaturę zastępczą, dopóki urządzenie użytkownika nie pobierze pliku. W zależności od ustawień użytkownika plik może nie pobierać się automatycznie i może wymagać kliknięcia przycisku pobierania.

Uwaga: przekierowania w adresach URL plików nie są obsługiwane. Jeśli potrzebne jest przekierowanie, użyj CreateFileRequest.
forceRefresh

boolean

Jeśli ten parametr jest ustawiony, platforma RBM pobiera plik i miniaturę z określonych adresów URL, nawet jeśli ma w pamięci podręcznej kopie pliku lub miniatury.

Media.Height

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 z kartami rozszerzonymi, gdy szerokość karty jest ustawiona na małą.

Sugestia

Sugerowana odpowiedź lub sugerowane działanie zawarte w karcie z elementami multimedialnymi lub na liście z sugestiami.

Zapis JSON 
{

  // 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.
}
Pola
Pole zbiorcze option. Sugerowana odpowiedź lub sugerowane działanie option może mieć tylko jedną z tych wartości:
reply

object (SuggestedReply)

Użytkownicy mogą kliknąć sugerowaną odpowiedź, aby wysłać ją do agenta.
action

object (SuggestedAction)

Użytkownicy mogą kliknąć sugerowane działanie, aby zainicjować odpowiednie działanie natywne na urządzeniu.

SuggestedReply

Po kliknięciu wysyła odpowiedź tekstową do agenta.

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

string

Tekst wyświetlany w sugerowanej odpowiedzi, który jest odsyłany do agenta, gdy użytkownik go kliknie. Maksymalnie 25 znaków.
postbackData

string

Ładunek zakodowany w formacie base64, który agent otrzymuje w zdarzeniu użytkownika, gdy użytkownik kliknie sugerowaną odpowiedź.

SuggestedAction

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

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

string

Tekst wyświetlany w sugerowanym działaniu. Maksymalnie 25 znaków.
postbackData

string

Ładunek (zakodowany w formacie base64), który zostanie wysłany do agenta w zdarzeniu użytkownika, które nastąpi, gdy użytkownik kliknie sugerowane działanie. Maksymalnie 2048 znaków.
fallbackUrl

string

(Opcjonalnie) Adres URL rezerwowy, który ma być używany, jeśli klient nie obsługuje sugerowanego działania. Adresy URL rezerwowe otwierają się w nowych oknach przeglądarki. Musi być prawidłowym identyfikatorem URI zdefiniowanym w dokumencie RFC 3986. Maksymalnie 2048 znaków.
Pole zbiorcze action. Działanie natywne zainicjowane na urządzeniu, gdy użytkownik kliknie sugerowane działanie action, może być tylko jednym z tych:
dialAction

object (DialAction)

Otwiera domyślną aplikację telefonu użytkownika z wypełnionym numerem telefonu podanym przez agenta.
viewLocationAction

object (ViewLocationAction)

Otwiera domyślną aplikację do obsługi map użytkownika i wybiera lokalizację określoną przez agenta lub wyszukuje w pobliżu lokalizacji użytkownika na podstawie zapytania określonego przez agenta.
createCalendarEventAction

object (CreateCalendarEventAction)

Otwiera domyślną aplikację kalendarza użytkownika i rozpoczyna proces tworzenia nowego wydarzenia w kalendarzu z wstępnie wypełnionymi danymi wydarzenia określonymi przez agenta.
openUrlAction

object (OpenUrlAction)

Otwiera domyślną aplikację przeglądarki internetowej użytkownika pod podanym adresem URL. Jeśli użytkownik ma zainstalowaną aplikację zarejestrowaną jako domyślny moduł obsługi adresu URL, zostanie ona otwarta, a jej ikona będzie używana w interfejsie sugerowanej czynności.
shareLocationAction

object (ShareLocationAction)

Otwiera selektor lokalizacji aplikacji RCS, aby użytkownik mógł wybrać lokalizację do wysłania do agenta.

DialAction

Otwiera domyślną aplikację telefonu użytkownika z wypełnionym numerem telefonu podanym przez agenta.

Zapis JSON 
{
  "phoneNumber": string
}
Pola
phoneNumber

string

Numer telefonu w formacie E.164, np. +12223334444.

ViewLocationAction

Otwiera domyślną aplikację do obsługi map użytkownika i wybiera lokalizację określoną przez agenta lub wyszukuje w pobliżu lokalizacji użytkownika na podstawie zapytania określonego przez agenta.

Zapis JSON 
{
  "latLong": {
    object (LatLng)
  },
  "label": string,
  "query": string
}
Pola
latLong

object (LatLng)

(Opcjonalnie) Szerokość i długość geograficzna określonej lokalizacji.
label

string

(Opcjonalnie) Etykieta pinezki umieszczonej na współrzędnych latLong.
query

string

(Opcjonalnie, obsługiwane tylko w przypadku klientów Wiadomości Google) Zamiast określać współrzędne geograficzne (i opcjonalnie etykietę), agent może określić ciąg zapytania. W przypadku domyślnych aplikacji do map, które obsługują funkcję wyszukiwania (w tym Map Google), kliknięcie tej sugerowanej czynności powoduje wyszukanie lokalizacji w pobliżu bieżącej lokalizacji użytkownika. Jeśli zapytanie jest wystarczająco szczegółowe, agenci mogą go użyć do wybrania dowolnej lokalizacji na świecie.

Na przykład ustawienie ciągu zapytania na „Bank Pod Dębem” spowoduje wyświetlenie wszystkich lokalizacji Banku Pod Dębem w pobliżu użytkownika. Ustawienie ciągu zapytania na „1600 Amphitheater Parkway, Mountain View, CA 94043” spowoduje wybranie tego konkretnego adresu niezależnie od lokalizacji użytkownika.

LatLng

Obiekt reprezentujący parę szerokości i długości geograficznej. Jest to para liczb zmiennoprzecinkowych podwójnej precyzji, które reprezentują stopnie szerokości i długości geograficznej. O ile nie określono inaczej, ten obiekt musi być zgodny ze standardem WGS84. Wartości muszą mieścić się w znormalizowanych zakresach.

Zapis JSON 
{
  "latitude": number,
  "longitude": number
}
Pola
latitude

number

Szerokość geograficzna w stopniach. Musi mieścić się w zakresie od –90,0 do +90,0.
longitude

number

Długość geograficzna w stopniach. Musi mieścić się w zakresie [–180,0, +180,0].

CreateCalendarEventAction

Otwiera domyślną aplikację kalendarza użytkownika i rozpoczyna proces tworzenia nowego wydarzenia w kalendarzu z wstępnie wypełnionymi danymi wydarzenia określonymi przez agenta.

Zapis JSON 
{
  "startTime": string,
  "endTime": string,
  "title": string,
  "description": string
}
Pola
startTime

string (Timestamp format)

Godzina rozpoczęcia wydarzenia.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Czas zakończenia wydarzenia.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
title

string

Nazwa wydarzenia. Maksymalnie 100 znaków.
description

string

Opis wydarzenia. Maksymalnie 500 znaków.

OpenUrlAction

Otwiera domyślną aplikację przeglądarki internetowej użytkownika pod określonym adresem URL. Jeśli użytkownik ma zainstalowaną aplikację zarejestrowaną jako domyślny moduł obsługi adresu URL, zostanie ona otwarta, a jej ikona będzie używana w interfejsie sugerowanej czynności.

Zapis JSON 
{
  "url": string,
  "application": enum (OpenUrlApplication),
  "webviewViewMode": enum (WebviewViewMode),
  "description": string
}
Pola
url

string

Adres URL do otwarcia. Od 1 listopada 2025 r. schemat adresu URL musi być https:// lub http://. Żądania API korzystające z innych schematów (np. tel:, mailto:, sms:) będą po tej dacie odrzucane z błędem 400 Bad Request. Adres URL musi być prawidłowym identyfikatorem URI zdefiniowanym w dokumencie RFC 3986. Maksymalnie 2048 znaków.
application

enum (OpenUrlApplication)

Adres URL otwierający aplikację, przeglądarkę lub widok internetowy. Aby sprawdzić, czy urządzenie użytkownika obsługuje tryb widoku internetowego, najpierw przeprowadź test możliwości. Szczegółowe informacje znajdziesz w dokumentacji: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities.
webviewViewMode

enum (WebviewViewMode)

Tryb widoku w WebView
description

string

Opis ułatwień dostępu dla widoku WebView.

OpenUrlApplication

Typ aplikacji otwieranej przez URL

Wartości w polu enum
OPEN_URL_APPLICATION_UNSPECIFIED Nie określono, zostanie otwarta w przeglądarce.
BROWSER Otwórz adres URL w przeglądarce.
WEBVIEW Otwieranie adresu URL w zintegrowanym oknie widoku internetowego

WebviewViewMode

Typ trybu wyświetlania widoku WebView.

Wartości w polu enum
WEBVIEW_VIEW_MODE_UNSPECIFIED Nie określono. Aby użyć widoku WebView, musisz określić tryb wyświetlania.
FULL Wymaga pełnoekranowej nakładki z rozmową z czatbotem oznaczoną na pasku stanu.
HALF Wymaga nakładki na połowę ekranu.
TALL Wymaga nakładki na 3/4 ekranu.

ShareLocationAction

Ten typ nie ma pól.

Otwiera selektor lokalizacji aplikacji RCS, aby użytkownik mógł wybrać lokalizację do wysłania do agenta.

StandaloneCard

Karta samodzielna

Zapis JSON 
{
  "cardOrientation": enum (StandaloneCard.CardOrientation),
  "thumbnailImageAlignment": enum (StandaloneCard.ThumbnailImageAlignment),
  "cardContent": {
    object (CardContent)
  }
}
Pola
cardOrientation

enum (StandaloneCard.CardOrientation)

Orientacja karty.
thumbnailImageAlignment

enum (StandaloneCard.ThumbnailImageAlignment)

Wyrównanie podglądu obrazu w przypadku kart samodzielnych w układzie poziomym.
cardContent

object (CardContent)

treść karty,

StandaloneCard.CardOrientation

Orientacja karty.

Wartości w polu enum
CARD_ORIENTATION_UNSPECIFIED Nie określono.
HORIZONTAL

Układ poziomy.

Jeśli element object(CardContent) poziomej karty z elementami multimedialnymi zawiera pole media, musi też zawierać co najmniej pole title, description lub suggestions[].
VERTICAL Układ pionowy.

StandaloneCard.ThumbnailImageAlignment

Wyrównanie podglądu obrazu w przypadku kart samodzielnych w układzie poziomym.

Wartości w polu enum
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED Nie określono.
LEFT Podgląd pliku jest wyrównany do lewej.
RIGHT Podgląd pliku jest wyrównany do prawej strony.

MessageTrafficType

Obsługiwane typy ruchu wiadomości. Wyliczenie zostanie rozszerzone o obsługę dodatkowych typów ruchu.

Wartości w polu enum
MESSAGE_TRAFFIC_TYPE_UNSPECIFIED Domyślne działanie: typ ruchu wiadomości jest określany przez przypadek użycia agenta. W razie potrzeby zaktualizuj typ ruchu na podstawie treści wiadomości. W przypadku agentów wielofunkcyjnych nie podano wartości domyślnej. Typ ruchu musi być ustawiony ręcznie (np. TRANSACTION, PROMOTION).
AUTHENTICATION W przypadku wiadomości uwierzytelniających w przypadku użycia agenta OTP.
TRANSACTION W przypadku wiadomości transakcyjnych w scenariuszach użycia agenta transakcyjnego lub wielofunkcyjnego.
PROMOTION W przypadku wiadomości promocyjnych w przypadkach użycia agenta promocyjnego lub wielofunkcyjnego.
SERVICEREQUEST Wiadomości dotyczące usług, na których otrzymywanie użytkownik wyraził zgodę. Używane w przypadkach użycia agentów OTP, transakcyjnych, promocyjnych lub wielokrotnego użytku.
ACKNOWLEDGEMENT Wiadomości potwierdzające prośbę użytkownika o rezygnację z subskrypcji. Używane w przypadkach użycia agentów OTP, transakcyjnych, promocyjnych lub wielokrotnego użytku.

Metody

create

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

delete

 Cofa wiadomość agenta, która została wysłana, ale nie została jeszcze dostarczona.