REST Resource: brands.agents

Zasób: Agent

Element konwersacyjny reprezentujący markę.

Zapis JSON 
{
  "name": string,
  "displayName": string,

  // Union field detail_info can be only one of the following:
  "businessMessagesAgent": {
    object (BusinessMessagesAgent)
  },
  "rcsBusinessMessagingAgent": {
    object (RcsBusinessMessagingAgent)
  }
  // End of list of possible types for union field detail_info.
}
Pola
name

string

Unikalny identyfikator agenta.

Tylko do odczytu. Zdefiniowane przez platformę.
displayName

string

To pole jest wymagane. Nazwa, którą agent wyświetla użytkownikom. Maksymalnie 100 znaków.

Nie można tego zmienić po weryfikacji agenta.

Pole sumy detail_info. Zawiera pola wymagane dla określonej usługi.

To pole jest wymagane. detail_info może być tylko jedną z tych wartości:
businessMessagesAgent

object (BusinessMessagesAgent)

Szczegółowe informacje o agencie Business Messages.
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

Szczegółowe informacje o agencie w usłudze RCS Business Messaging.

BusinessMessagesAgent

Informacje o agencie dotyczące Business Messages.

Zapis JSON 
{
  "logoUrl": string,
  "entryPointConfigs": [
    {
      object (BusinessMessagesEntryPointConfig)
    }
  ],
  "conversationalSettings": {
    string: {
      object (ConversationalSetting)
    },
    ...
  },
  "defaultLocale": string,
  "primaryAgentInteraction": {
    object (SupportedAgentInteraction)
  },
  "additionalAgentInteractions": [
    {
      object (SupportedAgentInteraction)
    }
  ],
  "customAgentId": string,
  "agentTestUrl": string,
  "testUrls": [
    {
      object (TestUrl)
    }
  ],
  "phone": {
    object (Phone)
  },
  "authorizationConfig": {
    object (AuthorizationConfig)
  },
  "nonLocalConfig": {
    object (NonLocalConfig)
  },
  "surveyConfig": {
    object (SurveyConfig)
  }
}
Pola
logoUrl

string

Opcjonalnie. Publicznie dostępny adres URL logo agenta. Maksymalnie 50 KB.

Nie można tego zmienić po weryfikacji agenta.
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

Opcjonalnie. Lista konfiguracji punktu wejścia.

Nie można tego zmienić po weryfikacji agenta.
conversationalSettings

map (key: string, value: object (ConversationalSetting))

To pole jest wymagane. Ustawienia rozmów agenta zmapowane na język. Język jest reprezentowany przez poprawnie sformatowany tag języka IETF BCP 47.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
defaultLocale

string

To pole jest wymagane. Domyślne ustawienie regionalne agenta. Musi być zgodny z językiem określonym w conversationalSettings.
primaryAgentInteraction

object (SupportedAgentInteraction)

To pole jest wymagane. Informacje o interakcji z głównym agentem. Używana, gdy użytkownik inicjuje rozmowę.
additionalAgentInteractions[]

object (SupportedAgentInteraction)

Opcjonalnie. Dodatkowe informacje o interakcji z pracownikiem obsługi klienta. Umożliwia agentowi obsługę wielu typów interakcji.
customAgentId

string

Opcjonalnie. Określony przez partnera identyfikator agenta. Identyfikator jest przekazywany do wszystkich wiadomości wysyłanych do agenta.
agentTestUrl
(deprecated)

string

Tylko dane wyjściowe. Adres URL do testowania trybu konwersacyjnego agenta.

Zdefiniowane przez platformę.
testUrls[]

object (TestUrl)

Tylko dane wyjściowe. Adresy URL używane do testowania trybu konwersacyjnego agenta.

Zdefiniowane przez platformę.
phone

object (Phone)

Opcjonalnie. Numer telefonu, który będzie wyświetlany pracownikowi obsługi klienta. Jeśli go nie podasz, pracownik obsługi klienta wyświetli numer telefonu marki znaleziony w Grafie wiedzy Google (jeśli taki istnieje).
authorizationConfig

object (AuthorizationConfig)

Opcjonalnie. Konfiguracja autoryzacji na potrzeby obsługi protokołu OAuth.
nonLocalConfig

object (NonLocalConfig)

Opcjonalnie. Konfiguracja nielokalnych punktów wejścia.
surveyConfig

object (SurveyConfig)

Opcjonalnie. Konfiguracja umożliwiająca włączenie ankiet niestandardowych.

BusinessMessagesEntryPointConfig

Konfiguracja punktu wejścia agenta.

Zapis JSON 
{
  "allowedEntryPoint": enum (EntryPoint)
}
Pola
allowedEntryPoint

enum (EntryPoint)

To pole jest wymagane. Usługi Google, na których agent może się wyświetlać.

EntryPoint

Usługi Google, na których agent może się wyświetlać.

Wartości w polu enum
ENTRY_POINT_UNSPECIFIED Nieokreślony punkt wejścia.
LOCATION Włącz lokalizacje dla tego agenta.
NON_LOCAL Włącz Business Messages w przypadku nielokalnych punktów wejścia.

SupportedAgentInteraction

Interakcje obsługiwane przez agenta.

Zapis JSON 
{
  "interactionType": enum (InteractionType),

  // Union field representative can be only one of the following:
  "botRepresentative": {
    object (BotRepresentative)
  },
  "humanRepresentative": {
    object (HumanRepresentative)
  }
  // End of list of possible types for union field representative.
}
Pola
interactionType

enum (InteractionType)

To pole jest wymagane. Typ interakcji obsługiwanej przez agenta.
Pole sumy representative. Szczegółowe informacje o typie konfiguracji. To pole jest wymagane. representative może być tylko jedną z tych wartości:
botRepresentative

object (BotRepresentative)

Szczegóły dotyczące przedstawiciela bota.
humanRepresentative

object (HumanRepresentative)

Szczegóły dotyczące przedstawiciela człowieka.

InteractionType

Typ interakcji obsługiwanej przez agenta.

Wartości w polu enum
INTERACTION_TYPE_UNSPECIFIED Nieokreślona interakcja.
BOT Interakcja z botem.
HUMAN Interakcja między ludźmi.

BotRepresentative

Szczegóły dotyczące przedstawiciela bota.

Zapis JSON 
{
  "botMessagingAvailability": {
    object (MessagingAvailability)
  }
}
Pola
botMessagingAvailability

object (MessagingAvailability)

To pole jest wymagane. Dostępność wiadomości od botów.

MessagingAvailability

W poszczególnych dniach tygodnia, w których są dostępne wiadomości. Możesz zgrupować godziny na wiele dni. Na przykład: * 8:00–16:00 czasu PDT od poniedziałku do środy * 10:00–14:00 czasu PDT czwartek–piątek * 15:00–18:00 czasu PDT od poniedziałku do piątku * 10:00–14:00 czasu PDT sobota–14:00

W przypadku luk w dostępności, np. braku określonej dostępności w niedzielę, w tych okresach wiadomości będą niedostępne.

Godziny pracy bota nie mają wpływu na dostępność. Pracownicy obsługi klienta korzystający tylko z botów zawsze wyświetlają wiadomość powitalną, a w przypadku przedstawicieli obejmujących ludzi i boty biorą pod uwagę tylko ludzi podczas definiowania dostępności.

Zapis JSON 
{
  "hours": [
    {
      object (Hours)
    }
  ]
}
Pola
hours[]

object (Hours)

To pole jest wymagane. Godziny, w których dostępna jest funkcja przesyłania wiadomości.

Godziny

W jakich godzinach dostępna jest usługa wiadomości.

Zapis JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "endTime": {
    object (TimeOfDay)
  },
  "timeZone": string,
  "startDay": enum (DayOfWeek),
  "endDay": enum (DayOfWeek)
}
Pola
startTime

object (TimeOfDay)

To pole jest wymagane. Godzina rozpoczęcia każdego dnia w zakresie dni tygodnia.
endTime

object (TimeOfDay)

To pole jest wymagane. Godzina zakończenia dla każdego dnia w zakresie dni tygodnia.
timeZone

string

To pole jest wymagane. Strefa czasowa IANA dla godzin. Na przykład „Ameryka/Los_Angeles”.
startDay

enum (DayOfWeek)

To pole jest wymagane. Rozpocznij dzień.
endDay

enum (DayOfWeek)

To pole jest wymagane. Dzień zakończenia. Obejmuje określony dzień.

TimeOfDay

Reprezentuje porę dnia. Data i strefa czasowa są nieistotne lub zostały określone w innym miejscu. Interfejs API może zezwolić na sekundy przestępne. Powiązane typy: google.type.Date i google.protobuf.Timestamp.

Zapis JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Pola
hours

integer

Godziny dnia w formacie 24-godzinnym. Wartość powinna mieścić się w zakresie od 0 do 23. Interfejs API może zezwolić na wartość „24:00:00” w sytuacjach takich jak godzina zamknięcia firmy.
minutes

integer

Minuty w ciągu dnia. Wartość musi mieścić się w przedziale od 0 do 59.
seconds

integer

Sekundy minut czasu. Wartość musi mieścić się w przedziale od 0 do 59. Interfejs API może zezwolić na wartość 60, jeśli zezwala na sekundy przestępne.
nanos

integer

Ułamki sekund w nanosekundach. Wartość musi mieścić się w przedziale od 0 do 999 999 999.

DayOfWeek

Reprezentuje dzień tygodnia.

Wartości w polu enum
DAY_OF_WEEK_UNSPECIFIED Dzień tygodnia nie jest określony.
MONDAY Poniedziałek
TUESDAY Wtorek
WEDNESDAY Środa
THURSDAY czwartek
FRIDAY Piątek
SATURDAY Saturday (sobota)
SUNDAY niedziela

HumanRepresentative

Szczegółowe informacje dotyczące przedstawiciela.

Zapis JSON 
{
  "humanMessagingAvailability": {
    object (MessagingAvailability)
  }
}
Pola
humanMessagingAvailability

object (MessagingAvailability)

To pole jest wymagane. Dostępność wiadomości z ludziami.

AuthorizationConfig

Szczegóły konfiguracji obsługi protokołu OAuth w Business Messages.

Zapis JSON 
{
  "endpointUrl": string
}
Pola
endpointUrl

string

Adres URL punktu końcowego, w którym loguje się użytkownik.

NonLocalConfig

Konfiguracja umożliwiająca włączenie nielokalnych punktów wejścia.

Zapis JSON 
{
  "contactOption": {
    object (ContactOption)
  },
  "enabledDomains": [
    string
  ],
  "phoneNumber": {
    object (Phone)
  },
  "callDeflectionPhoneNumbers": [
    {
      object (Phone)
    }
  ],
  "regionCodes": [
    string
  ]
}
Pola
contactOption

object (ContactOption)

To pole jest wymagane. Informacje kontaktowe dotyczące agenta wyświetlane przy przycisku do wysyłania wiadomości.
enabledDomains[]

string

To pole jest wymagane. Domeny, które mają być włączone w punkcie wejścia linków do podstron.
phoneNumber

object (Phone)

To pole jest wymagane. Numer telefonu agenta. Zastępuje pole phone w przypadku rozmów rozpoczętych z nielokalnych punktów wejścia. Ten numer telefonu będzie używany we wszystkich skonfigurowanych regionach.
callDeflectionPhoneNumbers[]

object (Phone)

To pole jest wymagane. Lista numerów telefonów, które powodują odrzucanie połączeń.
regionCodes[]

string

To pole jest wymagane. Lista kodów regionów CLDR dla krajów, w których agent może uruchamiać punkty wejścia NON_LOCAL. Wymagane w przypadku NON_LOCAL punktów wejścia.

ContactOption

Oprócz przycisku przesyłania wiadomości wyświetlane są szczegóły kontaktu.

Zapis JSON 
{
  "url": string,
  "options": [
    enum (Option)
  ]
}
Pola
url

string

To pole jest wymagane. Adres URL, dla którego są dostępne opcje kontaktu.
options[]

enum (Option)

To pole jest wymagane. Lista opcji kontaktu dostępnych pod określonym adresem URL.

Opcja

Opcje kontaktu.

Wartości w polu enum
OPTION_UNSPECIFIED Brak informacji
WEB_CHAT Czat internetowy.
PHONE Opcja telefonu.
EMAIL Opcja e-mail.
FAQS Najczęstsze pytania.
TWITTER Opcja Twittera.
WHATSAPP WhatsApp.

SurveyConfig

Szczegóły konfiguracji obsługi niestandardowych pytań ankietowych.

Zapis JSON 
{
  "templateQuestionIds": [
    string
  ],
  "customSurveys": {
    string: {
      object (CustomSurveyConfig)
    },
    ...
  }
}
Pola
templateQuestionIds[]

string

Lista identyfikatorów pytań szablonów w ankiecie.
customSurveys

map (key: string, value: object (CustomSurveyConfig))

Niestandardowe pytania ankiety dla agenta przypisane do określonego języka. Język jest reprezentowany przez poprawnie sformatowany tag języka IETF BCP 47.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CustomSurveyConfig

Niestandardowa konfiguracja ankiety dla agenta.

Zapis JSON 
{
  "customQuestions": [
    {
      object (SurveyQuestion)
    }
  ]
}
Pola
customQuestions[]

object (SurveyQuestion)

Lista pytań niestandardowych.

SurveyQuestion

Szczegółowa treść każdego pytania w ankiecie.

Zapis JSON 
{
  "name": string,
  "questionType": enum (Type),
  "questionContent": string,
  "responseOptions": [
    {
      object (SurveyResponse)
    }
  ]
}
Pola
name

string

To pole jest wymagane. Unikalny identyfikator pytania.
questionType

enum (Type)

Tylko dane wyjściowe. Typ pytania.
questionContent

string

To pole jest wymagane. Treść pytania. Pytania są ograniczone do 200 znaków.
responseOptions[]

object (SurveyResponse)

To pole jest wymagane. Lista odpowiedzi wyświetlanych z pytaniem. Maksymalnie 12.

Typ

Typ pytania ankiety.

Wartości w polu enum
TYPE_UNSPECIFIED Nieznany typ pytania w ankiecie.
GOOGLE_STANDARD_QUESTION Standardowe pytanie ankiety Google.
GOOGLE_TEMPLATE_QUESTION Udostępniliśmy szablon pytania w ankiecie.
PARTNER_CUSTOM_QUESTION Pytanie niestandardowe partnera.

SurveyResponse

Treść odpowiedzi na pytanie w ankiecie.

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

string

To pole jest wymagane. Tekst, który wyświetla się w ankiecie i jest odsyłany do agenta, gdy użytkownik go kliknie. Maksymalnie 35 znaków.
postbackData

string

Ciąg tekstowy, który agent otrzymuje, gdy użytkownik kliknie odpowiedź na pytanie.

RcsBusinessMessagingAgent

Informacje o agencie obsługi klienta związane konkretnie z RCS Business Messaging.

Zapis JSON 
{
  "description": string,
  "logoUri": string,
  "heroUri": string,
  "phoneNumbers": [
    {
      object (PhoneEntry)
    }
  ],
  "emails": [
    {
      object (EmailEntry)
    }
  ],
  "websites": [
    {
      object (WebEntry)
    }
  ],
  "privacy": {
    object (WebEntry)
  },
  "termsConditions": {
    object (WebEntry)
  },
  "color": string,
  "billingConfig": {
    object (RcsBusinessMessagingAgentBillingConfig)
  },
  "agentUseCase": enum (AgentUseCase),
  "hostingRegion": enum (HostingRegion)
}
Pola
description

string

To pole jest wymagane. Opis agenta, który jest widoczny dla użytkowników. Maksymalnie 100 znaków.
logoUri

string

To pole jest wymagane. Publicznie dostępny adres URL logo agenta. Maksymalnie 50 KB.

Nie można tego zmienić po weryfikacji agenta.
heroUri

string

To pole jest wymagane. Publicznie dostępny adres URL banera powitalnego agenta. Maksymalnie 200 KB.

Nie można tego zmienić po weryfikacji agenta.
phoneNumbers[]

object (PhoneEntry)

To pole jest wymagane. Numery telefonów powiązane z agentem.
emails[]

object (EmailEntry)

Opcjonalnie. Adresy e-mail powiązane z agentem.
websites[]

object (WebEntry)

Opcjonalnie. Witryny powiązane z agentem. Maksymalnie 3.
privacy

object (WebEntry)

To pole jest wymagane. Polityka prywatności powiązana z agentem.
termsConditions

object (WebEntry)

To pole jest wymagane. Warunki korzystania z usług agenta.
color

string

To pole jest wymagane. Kolor motywu agenta, który jest widoczny dla użytkowników w formacie szesnastkowym. Na przykład #FF6347.
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

To pole jest wymagane. Konfiguracja płatności agenta.
agentUseCase

enum (AgentUseCase)

Opcjonalnie. Przypadek użycia bota.
hostingRegion

enum (HostingRegion)

To pole jest wymagane. Region hostowania agenta.

PhoneEntry

Numer telefonu powiązany z agentem.

Zapis JSON 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
Pola
phoneNumber

object (Phone)

To pole jest wymagane. Numer telefonu w formacie E.164. Na przykład: +12223334444.
label

string

To pole jest wymagane. Etykieta numeru telefonu.

EmailEntry

Adres e-mail powiązany z agentem.

Zapis JSON 
{
  "address": string,
  "label": string
}
Pola
address

string

To pole jest wymagane. Adres e-mail.
label

string

To pole jest wymagane. Etykieta adresu e-mail.

WebEntry

Zasób internetowy powiązany z agentem.

Zapis JSON 
{
  "uri": string,
  "label": string
}
Pola
uri

string

To pole jest wymagane. Publicznie dostępny identyfikator URI powiązany z agentem. Musi używać protokołu HTTP lub HTTPS.
label

string

Opcjonalnie. Etykieta identyfikatora URI.

RcsBusinessMessagingAgentBillingConfig

Konfiguracja płatności agenta.

Zapis JSON 
{
  "billingCategory": enum (BillingCategory)
}
Pola
billingCategory

enum (BillingCategory)

Kategoria fakturowania agenta.

BillingCategory

Obsługiwane kategorie rozliczeń.

Wartości w polu enum
BILLING_CATEGORY_UNSPECIFIED Nie określono kategorii.
CONVERSATIONAL_LEGACY Starsza kategoria do obsługi konfiguracji płatności istniejących agentów.
CONVERSATIONAL Zaprojektowany z myślą o dłuższych, bardziej złożonych sesjach, w których użytkownik i marka wymieniają się różnymi wiadomościami.
SINGLE_MESSAGE Zastępuje SMS-y bogatszymi funkcjami wiadomości. Nigdy nie rozliczono jako CONVERSATIONAL.
BASIC_MESSAGE Model płatności jest podobny do SMS-ów. Nigdy nie rozliczono jako CONVERSATIONAL.

AgentUseCase

Typy przypadków użycia agentów używanych w pamięci masowej.

Wartości w polu enum
AGENT_USE_CASE_UNSPECIFIED Nie określono przypadku użycia.
TRANSACTIONAL Agenty, które wysyłają tylko niezbędne, niezbędne i pilne wiadomości.
PROMOTIONAL przedstawiciele, którzy wysyłają wiadomości sprzedażowe, marketingowe i promocyjne; Typ domyślny.
OTP Agenty, które wysyłają tylko jednorazowe hasła.
MULTI_USE Agenty, które mają wiele przypadków użycia.

HostingRegion

Możliwe regiony hostingu dla agenta, używane do prawidłowego kierowania wiadomości P2A do regionalnego serwera.

Wartości w polu enum
HOSTING_REGION_UNSPECIFIED Nieokreślony region hostingu.
NORTH_AMERICA Ameryka Północna.
EUROPE Europa.
ASIA_PACIFIC w regionie Azji i Pacyfiku.

Metody

create

 Tworzy nowego agenta reprezentującego markę.

delete
(deprecated)

 Wycofano: usuwanie agenta zostało wycofane.

get

 Uzyskaj informacje o agencie.

getLaunch

 Pobiera informacje o uruchamianiu agenta.

getVerification

 Pobiera informacje weryfikacyjne pracownika obsługi klienta.

list

 Zawiera listę wszystkich agentów powiązanych z marką.

patch

 Aktualizuje informacje o agencie.

requestLaunch

 Rozpoczyna proces uruchamiania agenta.

requestVerification

 Rozpoczyna weryfikację informacji o firmie pracownika obsługi klienta.

updateLaunch

 Aktualizuje informacje o uruchomieniu agenta.

updateVerification

 Aktualizuje stan weryfikacji agenta.