REST Resource: brands.agents

Zasób: Agent

Konwersacyjny element reprezentujący markę.

Zapis JSON 
{
  "name": string,
  "displayName": string,
  "brandName": string,
  "isArchived": boolean,

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

string

Unikalny identyfikator agenta.

Tylko do odczytu. Określone przez platformę.
displayName

string

Wymagane. Nazwa, którą agent wyświetla użytkownikom. Maksymalnie 40 znaków

Po weryfikacji agenta nie można go zmienić.
brandName

string

Tylko dane wyjściowe. Nazwa marki powiązanej z agentem.
isArchived

boolean

Opcjonalnie. Jeśli true, agent jest zarchiwizowany i domyślnie nie jest uwzględniany w wynikach listy.

Pole zbiorcze detail_info. Zawiera pola wymagane w przypadku danego produktu.

Wymagane. Pole detail_info może mieć tylko jedną z tych wartości:
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

Szczegółowe informacje o agencie w RCS dla firm.

RcsBusinessMessagingAgent

Informacje o agencie związane konkretnie z RCS dla firm. W przypadku tworzenia agenta zalecamy podanie co najmniej 1 formy kontaktu (telefon, e-mail lub strona internetowa) z odpowiednią etykietą. Aby uruchomić agenta, musisz podać co najmniej 1 formę kontaktu (telefon, e-mail lub strona internetowa) z odpowiednią etykietą.

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),
  "partner": {
    object (PartnerEntry)
  },
  "launchDetails": {
    string: {
      object (RcsBusinessMessagingRegionLaunch)
    },
    ...
  },
  "indiaPrincipalEntityId": string
}
Pola
description

string

Wymagane. Opis agenta widoczny dla użytkowników. Maksymalnie 100 znaków. Szczegółowe wymagania znajdziesz w artykule Edytowanie informacji o agencie.
logoUri

string

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

Po weryfikacji agenta nie można go zmienić.
heroUri

string

Wymagane. Publicznie dostępny adres URL banera powitalnego agenta. Maksymalnie 200 KB.

Po weryfikacji agenta nie można go zmienić.
phoneNumbers[]

object (PhoneEntry)

Opcjonalnie. Numery telefonów powiązane z agentem. Wymagany, jeśli nie podano adresu e-mail ani strony internetowej.
emails[]

object (EmailEntry)

Opcjonalnie. Adresy e-mail powiązane z agentem. Wymagane, jeśli nie podano numeru telefonu ani adresu strony internetowej.
websites[]

object (WebEntry)

Opcjonalnie. Witryny powiązane z agentem. Maksymalnie 3. Wymagane, jeśli nie podano numeru telefonu ani adresu e-mail.
privacy

object (WebEntry)

Wymagane. Polityka prywatności powiązana z agentem.
termsConditions

object (WebEntry)

Wymagane. Warunki korzystania z usługi powiązane z agentem.
color

string

Wymagane. Kolor motywu agenta widoczny dla użytkowników w formacie szesnastkowym. Na przykład #FF6347.
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

Wymagane. Konfiguracja płatności za agenta.
agentUseCase

enum (AgentUseCase)

Opcjonalnie. Przypadek użycia bota.
hostingRegion

enum (HostingRegion)

Wymagane. Region hostowania agenta.
partner

object (PartnerEntry)

Tylko dane wyjściowe. Partner powiązany z agentem.
launchDetails

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

Tylko dane wyjściowe. Szczegóły uruchomienia agenta. Informacja podawana tylko w przypadku operatorów i tylko ze szczegółami dotyczącymi wprowadzenia usługi przez operatora, który wykonuje połączenie.
indiaPrincipalEntityId

string

Opcjonalnie. Identyfikator podmiotu głównego firmy w Indiach (PE ID) powiązanej z agentem. Wymagane, jeśli planujesz uruchomić agenta w Indiach.

PhoneEntry

numer telefonu powiązany z agentem,

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

object (Phone)

Wymagane. Numer telefonu w 2 możliwych formatach: pełny format E.164 (np. „+12223334444”) lub nieformatowany lokalny/bezpłatny numer telefonu bez znaku „+”, prefiksu ani kodu kraju (np. „6502530000”). Uwaga: numery alarmowe są niedozwolone.
label

string

Wymagane. Etykieta numeru telefonu.

EmailEntry

adres e-mail powiązany z agentem,

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

string

Wymagane. adres e-mail,
label

string

Wymagane. Etykieta adresu e-mail.

WebEntry

Zasób internetowy powiązany z agentem.

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

string

Wymagane. Publicznie dostępny URI powiązany z agentem. Musi używać protokołu HTTP lub HTTPS.
label

string

Wymagane w przypadku websites, w pozostałych przypadkach opcjonalne. Etykieta identyfikatora URI.

RcsBusinessMessagingAgentBillingConfig

Konfiguracja płatności za agenta.

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

enum (BillingCategory)

Kategoria fakturowania agenta.

BillingCategory

Obsługiwane kategorie fakturowania.

Wartości w polu enum
BILLING_CATEGORY_UNSPECIFIED Nie określono kategorii.
CONVERSATIONAL_LEGACY

Starsza kategoria obsługująca konfigurację płatności w przypadku dotychczasowych agentów. Użyj w zamian zasady CONVERSATIONAL.
CONVERSATIONAL Zaprojektowane z myślą o dłuższych i bardziej złożonych sesjach, w których użytkownik i marka wymieniają serię wiadomości.
SINGLE_MESSAGE

Zastępuje SMS-y bardziej rozbudowanymi wiadomościami. Nigdy nie jest rozliczany jako CONVERSATIONAL.
BASIC_MESSAGE

Model rozliczeniowy jest podobny do SMS-ów. Nigdy nie jest rozliczany jako CONVERSATIONAL.
NON_CONVERSATIONAL Reprezentuje kategorię fakturowania Niekonwersacyjny, która zastępuje starsze kategorie SINGLE_MESSAGE i BASIC_MESSAGE. Dotyczy to podmiotów, które prowadzą głównie komunikację jednokierunkową (A2P).

AgentUseCase

Typy przypadków użycia agenta używane w pamięci masowej.

Wartości w polu enum
AGENT_USE_CASE_UNSPECIFIED Nie określono przypadku użycia.
TRANSACTIONAL Agenci, którzy wysyłają tylko najważniejsze, niezbędne i pilne wiadomości.
PROMOTIONAL Agenci, którzy wysyłają wiadomości dotyczące sprzedaży, marketingu i promocji. Typ domyślny.
OTP Agenty, które wysyłają tylko hasła jednorazowe.
MULTI_USE Agenty, które mają wiele zastosowań. Obejmuje to agentów, w przypadku których jeden przypadek użycia jest uruchamiany od razu, a drugi jest planowany na przyszłość. Więcej informacji znajdziesz w dokumentacji dotyczącej wielokrotnego użycia.

HostingRegion

Możliwe regiony hostingu agenta, używane do prawidłowego kierowania wiadomości P2A na serwer regionalny.

Wartości w polu enum
HOSTING_REGION_UNSPECIFIED Nieokreślony region hostowania.
NORTH_AMERICA Ameryce Północnej.
EUROPE Europie.
ASIA_PACIFIC Azja i Pacyfik.

PartnerEntry

Partner powiązany z agentem.

Zapis JSON 
{
  "partnerId": string,
  "displayName": string,
  "company": string
}
Pola
partnerId

string

Tylko dane wyjściowe. Unikalny identyfikator partnera.
displayName

string

Tylko dane wyjściowe. Nazwa, która będzie wyświetlana firmom w celu powiązania partnerów z produktami. Powinien być unikalny wśród partnerów.
company

string

Tylko dane wyjściowe. Publiczna nazwa firmy danego partnera.

RcsBusinessMessagingRegionLaunch

Szczegóły uruchomienia agenta RCS dla firm w poszczególnych regionach.

Zapis JSON 
{
  "launchState": enum (LaunchState),
  "comment": string,
  "updateTime": string,
  "isHidden": boolean
}
Pola
launchState

enum (LaunchState)

Stan uruchomienia w regionie.
comment

string

Komentarz przewoźnika.
updateTime

string (Timestamp format)

Czas ostatniej aktualizacji.

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".
isHidden

boolean

Opcjonalnie. Określa, czy agent jest oznaczony jako ukryty dla przewoźnika, co wpływa na widoczność widoków konsoli i interfejsu API.

LaunchState

Stan uruchomienia elementu. Informacje o dozwolonych przejściach stanu uruchomienia w przypadku operatorów i partnerów znajdziesz w artykule Otrzymywanie zdarzeń.

Wartości w polu enum
LAUNCH_STATE_UNSPECIFIED Stan nieokreślony.
LAUNCH_STATE_UNLAUNCHED Element nie został jeszcze wprowadzony.
LAUNCH_STATE_PENDING Wersja w trakcie sprawdzania.
LAUNCH_STATE_LAUNCHED Wdrożone.
LAUNCH_STATE_REJECTED Uruchomienie zostało odrzucone.
LAUNCH_STATE_SUSPENDED Uruchomienie zostało wstrzymane.
LAUNCH_STATE_PENDING_UNLAUNCH

Wycofano: ten stan nie jest już używany.

Wycofanie z publikacji w trakcie sprawdzania.
LAUNCH_STATE_INVALID_IN_GMB

Wycofano: ten stan nie jest już używany.

Uruchomienie jest nieprawidłowe, ponieważ powiązana wizytówka Google Moja Firma nie obsługuje wiadomości. Ponowna weryfikacja w Google Moja Firma automatycznie uruchamia się ponownie w tym miejscu. Dotyczy tylko lokalizacji.

Metody

create

 Tworzy nowego agenta reprezentującego markę.

delete
(deprecated)

 Wycofano: usuwanie agentów zostało wycofane.

get

 Uzyskiwanie informacji o agencie.

getLaunch

 Pobiera informacje o uruchomieniu agenta.

getVerification

 Pobiera informacje weryfikacyjne agenta.

list

 Wyświetla listę wszystkich agentów powiązanych z marką.

patch

 Aktualizuje informacje o agencie.

requestLaunch

 Rozpoczyna proces uruchamiania agenta.

requestVerification

 Przesyła informacje do weryfikacji firmy w przypadku agenta.

updateLaunch

 Aktualizuje informacje o uruchomieniu agenta.

updateVerification

 Aktualizuje stan weryfikacji agenta.