REST Resource: brands.agents

Recurso: Agente

Es una entidad de conversación que representa una marca.

Representación 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.
}
Campos
name

string

El identificador único del agente.

Solo lectura. Lo define la plataforma.
displayName

string

Obligatorio. El nombre que el agente mostrará a los usuarios. Se admiten 100 caracteres como máximo.

No se puede modificar después de la verificación del agente.

Campo de unión detail_info. Contiene los campos obligatorios para el producto en particular.

Obligatorio. detail_info puede ser una de las siguientes opciones:
businessMessagesAgent

object (BusinessMessagesAgent)

Información detallada del agente para Business Messages.
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

Información detallada del agente para RCS Business Messaging

BusinessMessagesAgent

Información del agente específica de Business Messages.

Representación 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)
  }
}
Campos
logoUrl

string

Opcional. Es la URL del logotipo disponible públicamente para el agente. 50 KB como máximo

No se puede modificar después de la verificación del agente.
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

Opcional. Lista de configuraciones de puntos de entrada.

No se puede modificar después de la verificación del agente.
conversationalSettings

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

Obligatorio. Configuración de conversación de un agente, asignada a una configuración regional. La configuración regional se representa con una etiqueta de idioma IETF BCP 47 con el formato correcto.

Es un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
defaultLocale

string

Obligatorio. La configuración regional predeterminada del agente. Debe coincidir con una configuración regional definida en conversationalSettings.
primaryAgentInteraction

object (SupportedAgentInteraction)

Obligatorio. Información sobre la interacción con el agente principal. Se usa cuando el usuario inicia una conversación.
additionalAgentInteractions[]

object (SupportedAgentInteraction)

Opcional. Información adicional sobre la interacción con el agente. Permite que el agente admita varios tipos de interacción.
customAgentId

string

Opcional. Un identificador especificado por el socio para el agente. El identificador se pasa junto con todos los mensajes enviados al agente.
agentTestUrl
(deprecated)

string

Solo salida. La URL para probar la experiencia de conversación del agente.

Lo define la plataforma.
testUrls[]

object (TestUrl)

Solo salida. URLs para probar la experiencia de conversación del agente.

Lo define la plataforma.
phone

object (Phone)

Opcional. El número de teléfono que mostrará el agente. Si no se especifica, el agente muestra el número de teléfono de la marca que se encuentra en el Gráfico de conocimiento de Google, si corresponde.
authorizationConfig

object (AuthorizationConfig)

Opcional. Configuración de autorización para la compatibilidad con OAuth.
nonLocalConfig

object (NonLocalConfig)

Opcional. Configuración para puntos de entrada no locales.
surveyConfig

object (SurveyConfig)

Opcional. Configuración para habilitar encuestas personalizadas.

BusinessMessagesEntryPointConfig

La configuración del punto de entrada para un agente.

Representación JSON 
{
  "allowedEntryPoint": enum (EntryPoint)
}
Campos
allowedEntryPoint

enum (EntryPoint)

Obligatorio. La plataforma de Google en la que el agente está habilitado para aparecer

EntryPoint

La plataforma de Google en la que el agente está habilitado para aparecer

Enumeradores
ENTRY_POINT_UNSPECIFIED Punto de entrada no especificado.
LOCATION Habilita ubicaciones para este agente.
NON_LOCAL Habilita Business Messages para puntos de entrada no locales.

SupportedAgentInteraction

Interacciones compatibles con un agente.

Representación 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.
}
Campos
interactionType

enum (InteractionType)

Obligatorio. El tipo de interacción que admite el agente.
Campo de unión representative. La información detallada del tipo de configuración. Obligatorio. Las direcciones (representative) solo pueden ser una de las siguientes opciones:
botRepresentative

object (BotRepresentative)

Detalles del representante del bot.
humanRepresentative

object (HumanRepresentative)

Detalles del representante humano.

InteractionType

Tipo de interacción admitida para el agente.

Enumeradores
INTERACTION_TYPE_UNSPECIFIED Interacción no especificada.
BOT Interacción con el bot.
HUMAN Interacción humana.

BotRepresentative

Detalles del representante del bot.

Representación JSON 
{
  "botMessagingAvailability": {
    object (MessagingAvailability)
  }
}
Campos
botMessagingAvailability

object (MessagingAvailability)

Obligatorio. Disponibilidad de mensajes de bots.

MessagingAvailability

Las horas de cada día de la semana en que está disponible la mensajería. Puedes agrupar horarios para varios días. Por ejemplo, * de 8:00 a 16:00 h PDT de lunes a miércoles * 10:00 a 14:00 h PDT de jueves a viernes * 15:00 a 6:00 h PDT de jueves a viernes * 10:00–14:00 h PDT sábado y sábado

Si hay brechas en la disponibilidad (por ejemplo, si no se especifica una disponibilidad los domingos), no se podrá enviar mensajes durante esas brechas.

Las horas del bot no tienen efecto en la disponibilidad. Los agentes solo para bots siempre muestran un mensaje de bienvenida, mientras que los agentes con parámetros de configuración tanto humanos como representativos de bots solo tienen en cuenta los representantes humanos cuando definen la disponibilidad.

Representación JSON 
{
  "hours": [
    {
      object (Hours)
    }
  ]
}
Campos
hours[]

object (Hours)

Obligatorio. Horarios de disponibilidad de mensajería

Horas

Un rango de horas durante los cuales está disponible la mensajería.

Representación JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "endTime": {
    object (TimeOfDay)
  },
  "timeZone": string,
  "startDay": enum (DayOfWeek),
  "endDay": enum (DayOfWeek)
}
Campos
startTime

object (TimeOfDay)

Obligatorio. Hora de inicio de cada día dentro del rango de días de la semana
endTime

object (TimeOfDay)

Obligatorio. Hora de finalización de cada día dentro del rango de días de la semana
timeZone

string

Obligatorio. La zona horaria de IANA para las horas. Por ejemplo, “America/Los_Ángeles”.
startDay

enum (DayOfWeek)

Obligatorio. Día de inicio.
endDay

enum (DayOfWeek)

Obligatorio. Día de finalización. Incluye el día especificado.

TimeOfDay

Representa una hora del día. La fecha y la zona horaria no son significativas o se especifican en otro lugar. Una API puede optar por permitir segundos bisiestos. Los tipos relacionados son google.type.Date y google.protobuf.Timestamp.

Representación JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Campos
hours

integer

Horas del día en formato de 24 horas. Debe ser del 0 al 23. Una API puede permitir el valor “24:00:00” para casos como el horario de cierre de empresas.
minutes

integer

Minutos de horas del día. Debe ser un valor entre 0 y 59.
seconds

integer

Segundos de minutos de la hora. Por lo general, debe ser un valor entre 0 y 59. Una API puede permitir el valor 60 si permite segundos bisiestos.
nanos

integer

Fracciones de segundos en nanosegundos. Debe ser un valor entre 0 y 999,999,999.

DayOfWeek

Representa un día de la semana.

Enumeradores
DAY_OF_WEEK_UNSPECIFIED No se especifica el día de la semana.
MONDAY Lunes
TUESDAY Martes
WEDNESDAY Miércoles
THURSDAY Jueves
FRIDAY Viernes
SATURDAY Sábado
SUNDAY Domingo

HumanRepresentative

Detalles para el representante humano.

Representación JSON 
{
  "humanMessagingAvailability": {
    object (MessagingAvailability)
  }
}
Campos
humanMessagingAvailability

object (MessagingAvailability)

Obligatorio. Disponibilidad de mensajería humana

AuthorizationConfig

Detalles de configuración para admitir OAuth en Business Messages.

Representación JSON 
{
  "endpointUrl": string
}
Campos
endpointUrl

string

La URL de extremo a la que accede el usuario.

NonLocalConfig

Configuración para habilitar puntos de entrada no locales.

Representación JSON 
{
  "contactOption": {
    object (ContactOption)
  },
  "enabledDomains": [
    string
  ],
  "phoneNumber": {
    object (Phone)
  },
  "callDeflectionPhoneNumbers": [
    {
      object (Phone)
    }
  ],
  "regionCodes": [
    string
  ]
}
Campos
contactOption

object (ContactOption)

Obligatorio. Información de contacto del agente que se muestra con el botón de mensajería.
enabledDomains[]

string

Obligatorio. Dominios que se habilitarán para el punto de entrada de vínculos a sitios.
phoneNumber

object (Phone)

Obligatorio. Número de teléfono del agente Anula el campo phone para las conversaciones iniciadas desde puntos de entrada no locales. Este número de teléfono se usará en todas las regiones configuradas.
callDeflectionPhoneNumbers[]

object (Phone)

Obligatorio. Lista de números de teléfono para desviación de llamadas.
regionCodes[]

string

Obligatorio. Lista de códigos regionales de CLDR para los países en los que el agente puede iniciar puntos de entrada NON_LOCAL. Obligatorio para NON_LOCAL puntos de entrada.

ContactOption

Detalles de contacto que se muestran, además del botón de mensajes

Representación JSON 
{
  "url": string,
  "options": [
    enum (Option)
  ]
}
Campos
url

string

Obligatorio. La URL para la que están disponibles las opciones de contacto.
options[]

enum (Option)

Obligatorio. Es la lista de opciones de contacto disponibles para la URL especificada.

Opción

Opciones de contacto.

Enumeradores
OPTION_UNSPECIFIED Sin especificar
WEB_CHAT Chat web.
PHONE Opción de teléfono.
EMAIL Opción de correo electrónico.
FAQS Opción de preguntas frecuentes.
TWITTER opción de Twitter.
WHATSAPP Opción de WhatsApp.

SurveyConfig

Detalles de configuración para respaldar las preguntas de encuesta personalizadas.

Representación JSON 
{
  "templateQuestionIds": [
    string
  ],
  "customSurveys": {
    string: {
      object (CustomSurveyConfig)
    },
    ...
  }
}
Campos
templateQuestionIds[]

string

Lista de ID de preguntas de plantilla para las preguntas de plantilla incluidas en una encuesta.
customSurveys

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

Preguntas de encuestas personalizadas para un agente, asignadas a una configuración regional. La configuración regional se representa con una etiqueta de idioma IETF BCP 47 con el formato correcto.

Es un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CustomSurveyConfig

Configuración de encuestas personalizada para un agente.

Representación JSON 
{
  "customQuestions": [
    {
      object (SurveyQuestion)
    }
  ]
}
Campos
customQuestions[]

object (SurveyQuestion)

Lista de preguntas personalizadas.

SurveyQuestion

El contenido detallado de cada pregunta de la encuesta.

Representación JSON 
{
  "name": string,
  "questionType": enum (Type),
  "questionContent": string,
  "responseOptions": [
    {
      object (SurveyResponse)
    }
  ]
}
Campos
name

string

Obligatorio. Es el identificador único de la pregunta.
questionType

enum (Type)

Solo salida. Tipo de la pregunta.
questionContent

string

Obligatorio. Contenido de la pregunta Las preguntas personalizadas tienen un límite de 200 caracteres.
responseOptions[]

object (SurveyResponse)

Obligatorio. Es la lista de respuestas que se muestran con la pregunta. Máximo 12.

Tipo

Es el tipo de pregunta de encuesta.

Enumeradores
TYPE_UNSPECIFIED El tipo de pregunta de la encuesta es desconocido.
GOOGLE_STANDARD_QUESTION Pregunta de encuesta estándar de Google.
GOOGLE_TEMPLATE_QUESTION Plantilla de pregunta de encuesta que proporcionó Google.
PARTNER_CUSTOM_QUESTION Pregunta de la encuesta personalizada del socio.

SurveyResponse

El contenido de una respuesta a una pregunta de encuesta.

Representación JSON 
{
  "content": string,
  "postbackData": string
}
Campos
content

string

Obligatorio. Texto que se muestra en la encuesta y se envía al agente cuando el usuario lo presiona. Se admiten hasta 35 caracteres.
postbackData

string

La cadena que recibe el agente cuando el usuario presiona la respuesta a la pregunta.

RcsBusinessMessagingAgent

Información del agente relacionada específicamente con RCS Business Messaging

Representación 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)
}
Campos
description

string

Obligatorio. Descripción del agente visible para los usuarios. Se admiten 100 caracteres como máximo.
logoUri

string

Obligatorio. Es la URL del logotipo disponible públicamente para el agente. 50 KB como máximo

No se puede modificar después de la verificación del agente.
heroUri

string

Obligatorio. Es la URL disponible de forma pública de la hero image del agente. El máximo es 200 KB.

No se puede modificar después de la verificación del agente.
phoneNumbers[]

object (PhoneEntry)

Obligatorio. Números de teléfono asociados con el agente.
emails[]

object (EmailEntry)

Opcional. Direcciones de correo electrónico asociadas con el agente.
websites[]

object (WebEntry)

Opcional. Los sitios web asociados con el agente. Máximo 3.
privacy

object (WebEntry)

Obligatorio. Política de privacidad asociada con el agente.
termsConditions

object (WebEntry)

Obligatorio. Términos y condiciones asociados con el agente.
color

string

Obligatorio. El color del tema del agente que es visible para los usuarios en formato hexadecimal. Por ejemplo, #FF6347.
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

Obligatorio. Configuración de facturación para el agente.
agentUseCase

enum (AgentUseCase)

Opcional. Caso de uso de un bot
hostingRegion

enum (HostingRegion)

Obligatorio. Región de hosting para un agente.

PhoneEntry

Un número de teléfono asociado con el agente.

Representación JSON 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
Campos
phoneNumber

object (Phone)

Obligatorio. Es el número de teléfono en formato E.164. Por ejemplo, +12223334444.
label

string

Obligatorio. Etiqueta del número de teléfono.

EmailEntry

Un correo electrónico asociado con el agente.

Representación JSON 
{
  "address": string,
  "label": string
}
Campos
address

string

Obligatorio. Una dirección de correo electrónico.
label

string

Obligatorio. Etiqueta de la dirección de correo electrónico.

WebEntry

Un recurso basado en la Web asociado con el agente.

Representación JSON 
{
  "uri": string,
  "label": string
}
Campos
uri

string

Obligatorio. Un URI de acceso público asociado con el agente. Se debe usar el protocolo HTTP o HTTPS.
label

string

Opcional. Etiqueta del URI.

RcsBusinessMessagingAgentBillingConfig

Configuración de facturación para el agente.

Representación JSON 
{
  "billingCategory": enum (BillingCategory)
}
Campos
billingCategory

enum (BillingCategory)

Categoría de facturación del agente.

BillingCategory

Categorías de facturación admitidas.

Enumeradores
BILLING_CATEGORY_UNSPECIFIED Categoría no especificada.
CONVERSATIONAL_LEGACY Categoría heredada para respaldar la configuración de facturación de los agentes existentes.
CONVERSATIONAL Diseñada para sesiones más largas y complejas en las que el usuario y la marca intercambian una serie de mensajes.
SINGLE_MESSAGE Reemplaza SMS con una experiencia de mensajería enriquecida. Nunca se facturó como CONVERSATIONAL.
BASIC_MESSAGE El modelo de facturación es similar al de SMS. Nunca se facturó como CONVERSATIONAL.

AgentUseCase

Tipos de casos de uso del agente que se usan en el almacenamiento.

Enumeradores
AGENT_USE_CASE_UNSPECIFIED No se especificó el caso de uso.
TRANSACTIONAL Agentes que envían solo mensajes esenciales, necesarios y urgentes
PROMOTIONAL Agentes que envían mensajes de ventas, de marketing y promocionales. Tipo predeterminado.
OTP Agentes que solo envían contraseñas de un solo uso
MULTI_USE Agentes que tienen varios casos de uso.

HostingRegion

Posibles regiones de hosting para un agente, que se usan a fin de enrutar correctamente mensajes P2A al servidor regionalizado.

Enumeradores
HOSTING_REGION_UNSPECIFIED Región de hosting no especificada.
NORTH_AMERICA Norteamérica.
EUROPE Europa.
ASIA_PACIFIC Asia-Pacífico.

Métodos

create

 Crea un agente nuevo para representar una marca.

delete
(deprecated)

 Obsoleto: la eliminación del agente dejó de estar disponible.

get

 Obtén información sobre un agente.

getLaunch

 Obtiene la información de lanzamiento de un agente.

getVerification

 Obtiene la información de verificación de un agente.

list

 Enumera todos los agentes asociados con una marca.

patch

 Actualiza la información sobre un agente.

requestLaunch

 Inicia el proceso de lanzamiento de un agente.

requestVerification

 Comienza la verificación de la información de la empresa de un agente.

updateLaunch

 Actualiza la información de lanzamiento de un agente.

updateVerification

 Actualiza el estado de verificación de un agente.