REST Resource: phones.agentMessages

Zasób: AgentMessage

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

Zapis JSON 
{
  "name": string,
  "sendTime": string,
  "contentMessage": {
    object (AgentContentMessage)
  },

  // 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 ma postać „phones/{E.164}/agentMessages/{messageId}”, gdzie {E.164} to numer telefonu użytkownika w formacie E.164, a {messageId} to przypisany przez agenta identyfikator wiadomości 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.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
contentMessage

object (AgentContentMessage)

Treść wiadomości agenta.

Pole sumy expiration.

expiration może być 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 na danych wyjściowych, jeśli jest ustawiona lub pole TTL jest ustawione.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
ttl

string (Duration format)

Opcjonalnie. Tylko wejście. Czas życia wiadomości, po którym zostanie automatycznie unieważniona.

Czas trwania w sekundach z maksymalnie 9 cyframi po przecinku, kończącym się cyframi „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 działań, które pojawiają się jako lista elementów z sugestiami po powiązanej wiadomości agenta. Maksymalnie 11 sugestii.

Elementy wyświetlają się tylko wtedy, gdy powiązana wiadomość agenta jest najnowszą wiadomością w wątku (zawierającą zarówno wiadomości do agenta, jak i użytkownika). Użytkownik może kliknąć sugerowaną odpowiedź, aby odesłać odpowiedź tekstową do pracownika obsługi klienta, lub kliknąć sugerowane działanie, aby zainicjować natywne działanie na urządzeniu.
Pole sumy content. Komunikat content agenta może mieć tylko jedną z tych wartości:
text

string

Tekst zakodowany w formacie UTF-8.
fileName
(deprecated)

string

Unikalna nazwa pliku. Gdy agent przesyła plik, platforma RBM zwraca nazwę pliku. Wycofano i zastąpiono polecenie UploadRbmFile poniżej
uploadedRbmFile

object (UploadedRbmFile)

Zawiera identyfikatory pliku i miniatury, które zostały przesłane na serwer RBM i przez niego wyświetlone
richCard

object (RichCard)

Samodzielna karta informacyjna.
contentInfo

object (ContentInfo)

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

Platforma RBM wyświetla treść 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 wyświetlana przez platformę RBM podczas przesyłania miniatury.

RichCard

Samodzielna karta informacyjna lub karuzela z kartami rozszerzonymi wysłanymi 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 sumy card. Samodzielna karta lub karuzela kart. card może być 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)

listę treści na każdej karcie 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. 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) Multimedia (zdjęcie, GIF, film) 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 (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ść multimediów na karcie informacyjnej w układzie pionowym. W przypadku samodzielnej karty z układem poziomym nie można dostosować wysokości, a pole jest ignorowane.
Pole sumy content. content może zawierać tylko jedną z tych treści multimedialnych:
fileName
(deprecated)

string

Unikalna nazwa pliku zwrócona przez platformę RBM podczas przesyłania pliku. Wycofano i zastąpiono polecenie UploadRbmFile poniżej
uploadedRbmFile

object (UploadedRbmFile)

Zawiera identyfikatory pliku i miniatury, które zostały przesłane na serwer RBM i przez niego wyświetlone
contentInfo

object (ContentInfo)

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

Platforma RBM wyświetla treść 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. Gdy platforma pobiera plik, platforma RBM określa typ MIME pliku z pola content-type w nagłówkach HTTP. Pole content-type musi być obecne i dokładne w odpowiedzi HTTP z adresu URL. Zalecany maksymalny rozmiar pliku to 100 MB.
thumbnailUrl

string

(Opcjonalnie, tylko w przypadku plików graficznych i wideo) Publicznie dostępny adres URL miniatury. Maksymalny rozmiar: 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 zostać pobrany automatycznie i może wymagać kliknięcia przycisku pobierania.
forceRefresh

boolean

Jeśli zasada jest skonfigurowana, platforma RBM pobiera plik i miniaturę z określonych adresów URL, nawet jeśli kopia pliku (i/lub miniatura) jest w pamięci podręcznej.

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 karuzeli kart rozszerzonych, gdy szerokość karty jest ustawiona na małą.

Sugestia

sugerowana odpowiedź lub sugerowane działanie na karcie informacyjnej lub na liście elementów 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 sumy option. Sugerowana odpowiedź lub sugerowane działanie (option) może być tylko jedną z tych opcji:
reply

object (SuggestedReply)

Użytkownicy mogą kliknąć sugerowaną odpowiedź, aby wysłać odpowiedź tekstową do pracownika obsługi klienta.
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ą z powrotem do agenta.

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

string

Tekst widoczny w sugerowanej odpowiedzi i odsyłany do agenta, gdy użytkownik go kliknie. Maksymalnie 25 znaków.
postbackData

string

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

SuggestedAction

Po kliknięciu inicjuje 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 widoczny w sugerowanym działaniu. Maksymalnie 25 znaków.
postbackData

string

Ładunek (zakodowany w base64), który zostanie wysłany do agenta w zdarzeniu użytkownika, które nastąpi po kliknięciu sugerowanego działania
fallbackUrl

string

(Opcjonalnie) Zastępczy adres URL do użycia, jeśli klient nie obsługuje sugerowanego działania. Zastępcze adresy URL otwierają się w nowych oknach przeglądarki.
Pole sumy action. Działanie natywne inicjowane na urządzeniu, gdy użytkownik kliknie sugerowane działanie action, może być tylko jedną z tych czynności:
dialAction

object (DialAction)

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

object (ViewLocationAction)

Otwiera domyślną aplikację z mapami użytkownika i wybiera lokalizację określoną przez agenta lub wyszukuje w jej okolicy na podstawie zapytania określonego przez agenta.
createCalendarEventAction

object (CreateCalendarEventAction)

Otwiera domyślną aplikację kalendarza użytkownika i rozpoczyna nowy przepływ wydarzeń w kalendarzu ze wstępnie wypełnionymi danymi wydarzeń określonymi przez agenta.
openUrlAction

object (OpenUrlAction)

Otwiera domyślną przeglądarkę użytkownika pod podanym adresem URL. Jeśli użytkownik ma zainstalowaną aplikację, która jest zarejestrowana jako domyślny moduł obsługi adresu URL, zostanie ona otwarta, a jej ikona będzie używana w interfejsie sugerowanych działań.
shareLocationAction

object (ShareLocationAction)

Otwiera selektor lokalizacji aplikacji RCS, aby użytkownik mógł wybrać lokalizację, którą chce wysłać pracownikowi obsługi klienta.

DialAction

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

Zapis JSON 
{
  "phoneNumber": string
}
Pola
phoneNumber

string

Numer telefonu w formacie E.164, na przykład +12223334444.

ViewLocationAction

Otwiera domyślną aplikację z mapami użytkownika i wybiera lokalizację określoną przez agenta lub wyszukuje w jej okolicy na podstawie zapytania określonego przez agenta.

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

object (LatLng)

(Opcjonalnie) Długość i szerokość geograficzna określonej lokalizacji.
label

string

(Opcjonalnie) Etykieta pinezki ustawiona w pozycji SzerokośćLong.
query

string

(Opcjonalnie; funkcja obsługiwana tylko w klientach Wiadomości na Androida) Zamiast określać szerokość geograficzną (i opcjonalnie etykietę), agent może zamiast tego określić ciąg zapytania. W przypadku domyślnych aplikacji z mapami, które obsługują funkcję wyszukiwania (w tym Map Google), kliknięcie tego sugerowanego działania spowoduje wyświetlenie lokalizacji na środku wokół bieżącej lokalizacji użytkownika. Jeśli zapytanie jest wystarczająco szczegółowe, pracownicy obsługi klienta mogą go użyć, aby wybrać dowolną lokalizację na świecie.

Na przykład ustawienie ciągu zapytania na „Bank drzewek” spowoduje wyświetlenie wszystkich lokalizacji banków drzew w pobliżu użytkownika. Ustawienie ciągu zapytania na „1600 Amphitheatre Parkway, Mountain View, CA 94043, USA” spowoduje wybranie tego konkretnego adresu niezależnie od lokalizacji użytkownika.

LatLng

Obiekt reprezentujący parę szerokości/długości geograficznej. Wartość ta jest wyrażona jako para podwójnej wartości oznaczająca stopnie szerokości i długości geograficznej w stopniach. O ile nie wskazano inaczej, ten obiekt musi być zgodny ze standardem WGS84. Wartości muszą się mieścić w znormalizowanych zakresach.

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

number

Szerokość geograficzna w stopniach. Musi mieścić się w zakresie [-90,0; +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 nowy przepływ wydarzeń w kalendarzu ze wstępnie wypełnionymi danymi wydarzeń określonymi przez agenta.

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

string (Timestamp format)

Godzina rozpoczęcia wydarzenia.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Godzina zakończenia wydarzenia.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
title

string

Nazwa wydarzenia.
description

string

Opis zdarzenia.

OpenUrlAction

Otwiera domyślną przeglądarkę internetową użytkownika pod określonym adresem URL. Jeśli użytkownik ma zainstalowaną aplikację, która jest zarejestrowana jako domyślny moduł obsługi adresu URL, zostanie ona otwarta, a jej ikona będzie używana w interfejsie sugerowanych działań.

Zapis JSON 
{
  "url": string
}
Pola
url

string

URL

ShareLocationAction

Ten typ nie ma żadnych pól.

Otwiera selektor lokalizacji aplikacji RCS, aby użytkownik mógł wybrać lokalizację, którą chce odesłać pracownikowi obsługi klienta.

StandaloneCard

Karta samodzielna

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

enum (StandaloneCard.CardOrientation)

Ułożenie karty.
thumbnailImageAlignment

enum (StandaloneCard.ThumbnailImageAlignment)

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

object (CardContent)

Treść karty.

StandaloneCard.CardOrientation

Ułożenie karty.

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

Układ poziomy.

Jeśli pozioma karta informacyjna object(CardContent) zawiera pole media, musi zawierać też co najmniej pole title, description lub suggestions[].
VERTICAL Układ pionowy.

StandaloneCard.ThumbnailImageAlignment

Wyrównanie podglądu obrazu w przypadku samodzielnych kart 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.

Metody

create

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

delete

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