REST Resource: brands.agents

Risorsa: Agente

Un'entità conversazionale che rappresenta un brand.

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "brandName": string,

  // 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.
}
Campi
name

string

L'identificatore univoco dell'agente.

Sola lettura. Definito dalla piattaforma.
displayName

string

Obbligatorio. Il nome che l'agente mostra agli utenti. Massimo 40 caratteri.

Non modificabile dopo la verifica dell'agente.
brandName

string

Solo output. Il nome del brand associato all'agente.

Campo unione detail_info. Contiene i campi obbligatori per il prodotto specifico.

Obbligatorio. detail_info può essere solo uno dei seguenti tipi:
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

Informazioni dettagliate sull'agente per RCS for Business.

RcsBusinessMessagingAgent

Informazioni sull'agente specificamente correlate a RCS for Business. Per la creazione di agenti, è consigliabile fornire almeno un recapito (telefono, email o sito web) con un'etichetta corrispondente. Per il lancio dell'agente, è necessario almeno un recapito (telefono, email o sito web) con un'etichetta corrispondente.

Rappresentazione 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
}
Campi
description

string

Obbligatorio. Descrizione dell'agente visibile agli utenti. Massimo 100 caratteri. Per i requisiti dettagliati, consulta Modificare le informazioni dell'agente.
logoUri

string

Obbligatorio. URL disponibile pubblicamente del logo dell'agente. Massimo 50 kB.

Non modificabile dopo la verifica dell'agente.
heroUri

string

Obbligatorio. URL disponibile pubblicamente dell'immagine accattivante per l'agente. Massimo 200 kB.

Non modificabile dopo la verifica dell'agente.
phoneNumbers[]

object (PhoneEntry)

Facoltativo. I numeri di telefono associati all'agente. Obbligatorio se non vengono forniti email e sito web.
emails[]

object (EmailEntry)

Facoltativo. Indirizzi email associati all'agente. Obbligatorio se non vengono forniti numero di telefono e sito web.
websites[]

object (WebEntry)

Facoltativo. Siti web associati all'agente. Massimo 3. Obbligatorio se non vengono forniti numero di telefono ed email.
privacy

object (WebEntry)

Obbligatorio. Norme sulla privacy associate all'agente.
termsConditions

object (WebEntry)

Obbligatorio. Termini e condizioni associati all'agente.
color

string

Obbligatorio. Il colore del tema dell'agente visibile agli utenti in formato esadecimale. Ad esempio, #FF6347.
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

Obbligatorio. Configurazione della fatturazione per l'agente.
agentUseCase

enum (AgentUseCase)

Facoltativo. Caso d'uso del bot.
hostingRegion

enum (HostingRegion)

Obbligatorio. Regione di hosting per un agente.
partner

object (PartnerEntry)

Solo output. Partner associato all'agente.
launchDetails

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

Solo output. Dettagli di lancio dell'agente. Compilato solo per gli operatori e solo con i dettagli di lancio relativi all'operatore che effettua la chiamata.
indiaPrincipalEntityId

string

Facoltativo. Identificatore dell'entità principale dell'attività (ID PE) dell'attività associata all'agente in India. Obbligatorio se prevedi di lanciare l'agente in India.

PhoneEntry

Un numero di telefono associato all'agente.

Rappresentazione JSON 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
Campi
phoneNumber

object (Phone)

Obbligatorio. Numero di telefono in due possibili formati: il formato E.164 completo (ad esempio "+12223334444") o un numero di telefono locale/senza costi non formattato senza "+", prefisso o codice paese (ad esempio "6502530000"). Nota: i numeri di emergenza non sono consentiti.
label

string

Obbligatorio. Etichetta per il numero di telefono.

EmailEntry

Un indirizzo email associato all'agente.

Rappresentazione JSON 
{
  "address": string,
  "label": string
}
Campi
address

string

Obbligatorio. Un indirizzo email.
label

string

Obbligatorio. Etichetta per l'indirizzo email.

WebEntry

Una risorsa basata sul web associata all'agente.

Rappresentazione JSON 
{
  "uri": string,
  "label": string
}
Campi
uri

string

Obbligatorio. Un URI accessibile pubblicamente associato all'agente. Deve utilizzare il protocollo HTTP o HTTPS.
label

string

Obbligatorio per websites, facoltativo altrimenti. Etichetta per l'URI.

RcsBusinessMessagingAgentBillingConfig

Configurazione della fatturazione per l'agente.

Rappresentazione JSON 
{
  "billingCategory": enum (BillingCategory)
}
Campi
billingCategory

enum (BillingCategory)

Categoria di fatturazione per l'agente.

BillingCategory

Categorie di fatturazione supportate.

Enum
BILLING_CATEGORY_UNSPECIFIED Categoria non specificata.
CONVERSATIONAL_LEGACY

Categoria legacy per supportare la configurazione di fatturazione degli agenti esistenti. Utilizza invece CONVERSATIONAL.
CONVERSATIONAL Progettato per sessioni più lunghe e complesse in cui l'utente e il brand si scambiano una serie di messaggi.
SINGLE_MESSAGE

Sostituisce gli SMS con un'esperienza di messaggistica più ricca. Non viene mai fatturato come CONVERSAZIONALE.
BASIC_MESSAGE

Il modello di fatturazione è simile a quello degli SMS. Non viene mai fatturato come CONVERSAZIONALE.
NON_CONVERSATIONAL Rappresenta una categoria di fatturazione non conversazionale, che sostituisce le categorie precedenti SINGLE_MESSAGE e BASIC_MESSAGE. Questo è per gli agenti che si occupano principalmente di comunicazione unidirezionale (A2P).

AgentUseCase

Tipi di casi d'uso dell'agente utilizzati nello spazio di archiviazione.

Enum
AGENT_USE_CASE_UNSPECIFIED Caso d'uso non specificato.
TRANSACTIONAL Agenti che inviano solo messaggi essenziali, necessari e urgenti.
PROMOTIONAL Agenti che inviano messaggi di vendita, marketing e promozionali. Tipo predefinito.
OTP Agenti che inviano solo password monouso.
MULTI_USE Agenti con più casi d'uso. Sono inclusi gli agenti in cui un caso d'uso viene lanciato immediatamente, mentre il secondo è pianificato per una release futura. Per saperne di più, consulta la documentazione relativa all'utilizzo multiplo.

HostingRegion

Possibili regioni di hosting per un agente, utilizzate per instradare correttamente i messaggi P2A al server regionalizzato.

Enum
HOSTING_REGION_UNSPECIFIED Regione di hosting non specificata.
NORTH_AMERICA Nord America.
EUROPE Europa.
ASIA_PACIFIC Asia Pacifico.

PartnerEntry

Partner associato all'agente.

Rappresentazione JSON 
{
  "partnerId": string,
  "displayName": string,
  "company": string
}
Campi
partnerId

string

Solo output. Identificatore univoco del partner.
displayName

string

Solo output. Il nome che verrà visualizzato dalle attività per associare i partner ai prodotti. Deve essere univoco tra i partner.
company

string

Solo output. Il nome pubblico dell'azienda per il partner specificato. Ad esempio, Twilio o Cisco.

RcsBusinessMessagingRegionLaunch

Dettagli sul lancio dell'agente RCS for Business per ogni regione.

Rappresentazione JSON 
{
  "launchState": enum (LaunchState),
  "comment": string,
  "updateTime": string
}
Campi
launchState

enum (LaunchState)

Lo stato di lancio per una regione.
comment

string

Commento dell'operatore.
updateTime

string (Timestamp format)

Data/ora ultimo aggiornamento.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

LaunchState

Lo stato di lancio di un'entità. Per informazioni sulle transizioni di stato di lancio consentite per operatori e partner, consulta Ricevere eventi.

Enum
LAUNCH_STATE_UNSPECIFIED Stato non specificato.
LAUNCH_STATE_UNLAUNCHED L'entità non è stata lanciata.
LAUNCH_STATE_PENDING Lancio in revisione.
LAUNCH_STATE_LAUNCHED Lancio completato.
LAUNCH_STATE_REJECTED Il lancio è stato rifiutato.
LAUNCH_STATE_SUSPENDED Il lancio è sospeso.
LAUNCH_STATE_PENDING_UNLAUNCH

Deprecato: questo stato non è più utilizzato.

Annullamento del lancio in fase di revisione.
LAUNCH_STATE_INVALID_IN_GMB

Deprecato: questo stato non è più utilizzato.

Il lancio non è valido perché la scheda Google My Business associata non supporta la messaggistica. La nuova verifica in Google My Business viene riavviata automaticamente qui. Applicabile solo alle località.

Metodi

create

 Crea un nuovo agente per rappresentare un brand.

delete
(deprecated)

 Ritirato: l'eliminazione dell'agente è stata ritirata.

get

 Recuperare informazioni su un agente.

getLaunch

 Recupera le informazioni di lancio di un agente.

getVerification

 Recupera le informazioni di verifica per un agente.

list

 Elenca tutti gli agenti associati a un brand.

patch

 Aggiorna le informazioni su un agente.

requestLaunch

 Avvia il processo di lancio di un agente.

requestVerification

 Invia le informazioni per la verifica dell'attività commerciale per un agente.

updateLaunch

 Aggiorna le informazioni di lancio per un agente.

updateVerification

 Aggiorna lo stato di verifica di un agente.