REST Resource: brands.agents

Recurso: agente

Uma entidade conversacional que representa uma marca.

Representação 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.
}
Campos
name

string

O identificador exclusivo do agente.

Somente leitura. Definido pela plataforma.
displayName

string

Obrigatório. O nome que o agente mostra aos usuários. Máximo de 40 caracteres.

Não pode ser modificado após a verificação do agente.
brandName

string

Apenas saída. O nome da marca associada ao agente.
isArchived

boolean

Opcional. Se true, o agente será arquivado e não incluído nos resultados da lista por padrão.

Campo de união detail_info. Contém os campos necessários para o produto específico.

Obrigatório. detail_info pode ser apenas de um dos tipos a seguir:
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

Informações detalhadas do agente para o RCS for Business.

RcsBusinessMessagingAgent

Informações do agente especificamente relacionadas ao RCS for Business. Para a criação de agentes, é recomendável fornecer pelo menos uma forma de contato (telefone, e-mail ou site) com um rótulo correspondente. Para o lançamento do agente, é necessário pelo menos uma forma de contato (telefone, e-mail ou site) com um rótulo correspondente.

Representação 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
}
Campos
description

string

Obrigatório. Descrição do agente visível para os usuários. Máximo de 100 caracteres. Consulte Editar informações do agente para ver os requisitos detalhados.
logoUri

string

Obrigatório. URL disponível publicamente do logotipo do agente. Máximo de 50 KB.

Não pode ser modificado após a verificação do agente.
heroUri

string

Obrigatório. URL disponível publicamente da imagem principal do agente. Máximo de 200 KB.

Não pode ser modificado após a verificação do agente.
phoneNumbers[]

object (PhoneEntry)

Opcional. Números de telefone associados ao agente. Obrigatório se o e-mail e o site não forem fornecidos.
emails[]

object (EmailEntry)

Opcional. Endereços de e-mail associados ao agente. Obrigatório se o número de telefone e o site não forem fornecidos.
websites[]

object (WebEntry)

Opcional. Sites associados ao agente. Máximo de 3. Obrigatório se o número de telefone e o e-mail não forem fornecidos.
privacy

object (WebEntry)

Obrigatório. Política de Privacidade associada ao agente.
termsConditions

object (WebEntry)

Obrigatório. Termos e condições associados ao agente.
color

string

Obrigatório. Cor do tema do agente visível para os usuários em formato hexadecimal. Por exemplo, #FF6347.
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

Obrigatório. Configuração de faturamento do agente.
agentUseCase

enum (AgentUseCase)

Opcional. Caso de uso do bot.
hostingRegion

enum (HostingRegion)

Obrigatório. Região de hospedagem de um agente.
partner

object (PartnerEntry)

Apenas saída. Parceiro associado ao agente.
launchDetails

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

Apenas saída. Detalhes do lançamento do agente. Só é preenchido para operadoras e apenas com os detalhes de lançamento relacionados à operadora que está fazendo a chamada.
indiaPrincipalEntityId

string

Opcional. Identificador da entidade principal da empresa na Índia (ID da PE) associada ao agente. Obrigatório se você planeja lançar o agente na Índia.

PhoneEntry

Um número de telefone associado ao agente.

Representação JSON 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
Campos
phoneNumber

object (Phone)

Obrigatório. Número de telefone em dois formatos possíveis: o formato E.164 completo (por exemplo, "+12223334444") ou um número de telefone local/sem custo financeiro sem formatação, sem "+", prefixo ou código do país (por exemplo, "6502530000"). Observação: números de emergência não são permitidos.
label

string

Obrigatório. Rótulo do número de telefone.

EmailEntry

Um e-mail associado ao agente.

Representação JSON 
{
  "address": string,
  "label": string
}
Campos
address

string

Obrigatório. Um endereço de e-mail.
label

string

Obrigatório. Rótulo do endereço de e-mail.

WebEntry

Um recurso baseado na Web associado ao agente.

Representação JSON 
{
  "uri": string,
  "label": string
}
Campos
uri

string

Obrigatório. Um URI de acesso público associado ao agente. É necessário usar o protocolo HTTP ou HTTPS.
label

string

Obrigatório para websites, opcional caso contrário. Rótulo do URI.

RcsBusinessMessagingAgentBillingConfig

Configuração de faturamento do agente.

Representação JSON 
{
  "billingCategory": enum (BillingCategory)
}
Campos
billingCategory

enum (BillingCategory)

Categoria de faturamento do agente.

BillingCategory

Categorias de faturamento aceitas.

Tipos enumerados
BILLING_CATEGORY_UNSPECIFIED Categoria não especificada.
CONVERSATIONAL_LEGACY

Categoria legada para oferecer suporte à configuração de faturamento de agentes atuais. Use CONVERSATIONAL.
CONVERSATIONAL Projetado para sessões mais longas e complexas, em que o usuário e a marca trocam uma série de mensagens.
SINGLE_MESSAGE

Substitui o SMS por uma experiência de mensagens mais completa. Nunca é cobrado como CONVERSATIONAL.
BASIC_MESSAGE

O modelo de faturamento é semelhante ao de SMS. Nunca é cobrado como CONVERSATIONAL.
NON_CONVERSATIONAL Representa uma categoria de faturamento não conversacional, que substitui as categorias legadas SINGLE_MESSAGE e BASIC_MESSAGE. Isso é para agentes que se envolvem principalmente em comunicação unidirecional (A2P).

AgentUseCase

Tipos de casos de uso de agentes usados no armazenamento.

Tipos enumerados
AGENT_USE_CASE_UNSPECIFIED Caso de uso não especificado.
TRANSACTIONAL Agentes que enviam apenas mensagens essenciais, necessárias e urgentes.
PROMOTIONAL Agentes que enviam mensagens de vendas, marketing e promocionais. Tipo padrão.
OTP Agentes que enviam apenas senhas únicas.
MULTI_USE Agentes com vários casos de uso. Isso inclui agentes em que um caso de uso é lançado imediatamente, enquanto o segundo está planejado para uma versão futura. Para mais informações, consulte a documentação sobre uso múltiplo.

HostingRegion

Possíveis regiões de hospedagem para um agente, usadas para encaminhar mensagens P2A ao servidor regionalizado corretamente.

Tipos enumerados
HOSTING_REGION_UNSPECIFIED Região de hospedagem não especificada.
NORTH_AMERICA América do Norte.
EUROPE Europa.
ASIA_PACIFIC Ásia-Pacífico.

PartnerEntry

Parceiro associado ao agente.

Representação JSON 
{
  "partnerId": string,
  "displayName": string,
  "company": string
}
Campos
partnerId

string

Apenas saída. Identificador exclusivo do parceiro.
displayName

string

Apenas saída. O nome que será exibido para as empresas associarem parceiros aos produtos. Precisa ser exclusivo entre os parceiros.
company

string

Apenas saída. O nome público da empresa para o parceiro especificado.

RcsBusinessMessagingRegionLaunch

Detalhes sobre o lançamento do agente comercial do RCS for Business em cada região.

Representação JSON 
{
  "launchState": enum (LaunchState),
  "comment": string,
  "updateTime": string,
  "isHidden": boolean
}
Campos
launchState

enum (LaunchState)

O estado de lançamento de uma região.
comment

string

Comentário da transportadora.
updateTime

string (Timestamp format)

Horário da última atualização.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
isHidden

boolean

Opcional. Especifica se o agente está marcado como oculto para a operadora, o que afeta a visibilidade das visualizações do console e da API.

LaunchState

O estado de lançamento de uma entidade. Para saber mais sobre as transições de estado de lançamento permitidas para operadoras e parceiros, consulte Receber eventos.

Tipos enumerados
LAUNCH_STATE_UNSPECIFIED Estado não especificado.
LAUNCH_STATE_UNLAUNCHED A entidade não foi lançada.
LAUNCH_STATE_PENDING Lançamento em análise.
LAUNCH_STATE_LAUNCHED Lançada.
LAUNCH_STATE_REJECTED O lançamento foi rejeitado.
LAUNCH_STATE_SUSPENDED O lançamento está suspenso.
LAUNCH_STATE_PENDING_UNLAUNCH

Descontinuado: este estado não é mais usado.

Cancelamento do lançamento em análise.
LAUNCH_STATE_INVALID_IN_GMB

Descontinuado: este estado não é mais usado.

O lançamento é inválido porque a ficha do Google Meu Negócio associada não aceita mensagens. A nova verificação no Google Meu Negócio é reiniciada automaticamente aqui. Aplicável apenas a locais.

Métodos

create

 Cria um novo agente para representar uma marca.

delete
(deprecated)

 Descontinuado: a exclusão de agentes foi descontinuada.

get

 Receber informações sobre um agente.

getLaunch

 Recebe as informações de lançamento de um agente.

getVerification

 Recebe as informações de verificação de um agente.

list

 Lista todos os agentes associados a uma marca.

patch

 Atualiza informações sobre um agente.

requestLaunch

 Inicia o processo de lançamento de um agente.

requestVerification

 Envia informações de verificação da empresa para um agente.

updateLaunch

 Atualiza as informações de lançamento de um agente.

updateVerification

 Atualiza o estado de verificação de um agente.