Uso de metadatos de mensajería con el Web Widget y los SDK de Zendesk

¿Qué plan tengo?

Suite

Cualquier plan

Los metadatos de mensajería usan los campos de conversación y las etiquetas de conversación (que también se conocen como campos de ticket personalizados y etiquetas de ticket personalizadas) para obtener más información acerca del problema de soporte o del producto o servicio. Los metadatos también se pueden usar para un mejor desvío de los tickets en el espacio de trabajo de agente creando disparadores en el Centro de administración. Los metadatos de mensajería se pueden agregar a los tickets y también al formulario "Enviar una solicitud" del centro de ayuda para que los usuarios finales puedan ver los campos personalizados.

También se pueden usar campos y etiquetas de conversación para enviar metadatos de mensajería a los agentes desde el Web Widget y los SDK de Zendesk a través de las API del lado del cliente. Esto permite transferir automáticamente al agente la información relevante, como el SKU del producto, el número de confirmación o la ID del pedido. Estos metadatos adicionales ayudan a proporcionar un contexto completo y mejorar la calidad del soporte que se ofrece.

Estas son las ventajas de los metadatos de mensajería:

• Mejor contexto para los agentes. Los agentes confían en que la información contextual que aparece en la vista del espacio de trabajo de agente es correcta. Si faltan datos o si la información proporcionada por los usuarios tiene errores se pueden producir problemas. Si la información relevante se proporciona mediante programación, se reducen los errores y el tiempo necesario para solicitar información.
• Desvío mejorado. Los negocios dependen de la información de los campos y las etiquetas del ticket para desviar el ticket al grupo de agentes correcto rápidamente. Si se proporcionan datos más completos, el desvío de tickets al grupo de agentes correcto es más eficiente.
• Experiencia óptima para los usuarios finales. Los usuarios finales no tendrán que volver a ingresar datos que ya existen en el lado del cliente.
• Flujos de automatización mejorados. Los generadores de bots pueden aprovechar los datos adicionales para ofrecer una mejor experiencia a los usuarios finales.
• Paridad de funciones con los SDK de Support del Web Widget clásico, que son compatibles con los campos y etiquetas de ticket.

Este artículo contiene los siguientes temas:

• Información general de los metadatos de mensajería
• Configurar para los metadatos de mensajería
• Agregar un campo de conversación
• Usar las API de metadatos
• Generador de bots (agentes IA heredados)

Información general de los metadatos de mensajería

Supongamos que tiene una tienda en Internet y que un usuario final está mirando unos zapatos específicos. En esta página se encuentran el SKU del producto y las opciones de tamaño y color. Si el usuario final tiene preguntas acerca de los zapatos, es necesario contar con la información anterior para que el agente sepa cuál es el zapato exacto en el que está interesado el usuario final. Sin campos de ticket personalizados, el agente real o el agente IA tendrá que solicitar toda esa información al usuario final antes de responder la pregunta.

Con los metadatos de mensajería, puede obtener esos datos mediante programación desde la página, pedirle al usuario final que rellene un formulario, o bien hacer una combinación de las dos cosas. Por ejemplo, a través de un campo de ticket personalizado, puede utilizar una API para obtener el SKU del producto desde la página del producto. Como el usuario final puede haber seleccionado o no un color y un tamaño, un agente IA (por ejemplo) puede solicitar esos datos usando campos de ticket personalizados y mostrar los valores predeterminados. El usuario final puede actualizar los valores o dejar los valores predeterminados.

Esto no es igual que usar variables y campos personalizados en las respuestas de agente IA estándar o en el generador de bots (heredado). Con los metadatos de mensajería:

• Los usuarios finales no tienen que ingresar manualmente los datos que ya existen en la página que están visitando. Por ejemplo, si el nombre de un usuario final está en un formulario de devolución y la ID del pedido ya existe en esa página, puede obtener ese número mediante programación en lugar de hacer que el usuario final lo escriba.
• Se puede agregar contexto adicional de manera automática para asistir al agente. Por ejemplo, si un usuario final tiene abierto su carrito de compras, se puede establecer un campo de conversación “Carrito de compras activo” en verdadero.
• Se puede controlar la ruta que sigue un agente IA. Por ejemplo, si un usuario final se encuentra en una página para Marca A, se puede establecer eso en un campo para que el bot atraviese la ruta de Marca A.

Configurar para los metadatos de mensajería

Los campos de conversación se tienen que configurar en el Centro de administración, para que los usuarios finales puedan establecer sus valores cuando se creen los campos. Las etiquetas de conversación no requieren ningún paso anterior para poder usar las API de metadatos.

El primer paso para usar los metadatos de mensajería es determinar qué datos desea recopilar y cómo desea usarlos. Ambas cosas dependen completamente de su caso de uso en particular. Es necesario que tenga clara la experiencia del usuario final cuando el desarrollador configura los valores del campo de ticket y la etiqueta mediante programación en el Web Widget y los SDK de Zendesk.

Una vez que comprenda los datos, se llevarán a cabo estos pasos:

1. Un administrador de Zendesk crea un campo de ticket personalizado y pasa el nombre del campo y la ID a un desarrollador, junto con los datos de uso y los demás datos que se desean recopilar.
2. Un desarrollador codifica la llamada a la API de metadatos usando la ID del campo para conectar el valor con ese campo.
3. Los datos se configuran mediante programación en la API de metadatos en tiempo de ejecución y están disponibles en la siguiente sesión.
4. Los datos del campo y las etiquetas del ticket se agregan al ticket de soporte cuando se crea el ticket.

Nota: Los metadatos de mensajería se aplican a un solo ticket. Si se crea un ticket posterior relacionado con la misma conversación, los metadatos de mensajería se aplican al primer ticket únicamente.

Los metadatos de los campos y las etiquetas del ticket se aplican al ticket durante su creación. Por ejemplo, si configura su widget de forma que se establezca instantáneamente un chat con un agente real (en lugar de con un agente IA), al abrir el widget se creará al instante un ticket y solo se le agregarán los campos y etiquetas de ticket que se hayan configurado antes de crearlo.

Una vez que el ticket está cerrado, los metadatos de mensajería en el backend (como los tickets) se restablecen en un estado null vacío. Actualmente, los metadatos de mensajería persisten en el lado del cliente; esto se tratará en una versión futura.

Agregar un campo de conversación

Los clientes de cualquier plan de Support pueden crear campos de conversación, pero deben tener la mensajería configurada y estar usando el Web Widget de mensajería o los SDK para mensajería.

No se admiten los campos de ticket del sistema, como el campo Prioridad. Aparecen en el formulario de contacto predeterminado (y en cualquier otro formulario de ticket), cuando se abren a través del centro de ayuda, pero no aparecen en el Web Widget.

Nota: Los campos predeterminados Expresión regular, Fecha y Multiselección pueden establecerse a través de las API de metadatos, pero no se muestran en la conversación.

Puede confirmar si se ha establecido un campo de conversación examinando la información del ticket en el espacio de trabajo de agente de Zendesk o con las API de Zendesk. Consulte Using messaging metadata (Uso de los metadatos de mensajería) para ver un ejemplo.

Para agregar un campo de conversación

1. En el Centro de administración, haga clic en Objetos y reglas en la barra lateral y luego seleccione Tickets > Campos.
2. Haga clic en Agregar campo.
3. Seleccione un tipo de campo y luego ingrese un Nombre mostrado.
4. (Opcional) Ingrese una Descripción para el campo personalizado. Esto solo lo pueden ver los administradores.
5. Bajo Permisos, seleccione Los clientes pueden editar.
   Nota: Debido a que los valores se pueden establecer a través de una llamada de API pública del lado del cliente, los datos siempre deben tratarse como si los hubiese proporcionado un usuario final. No se recomienda utilizar estas API para datos confidenciales.
6. Ingrese un Título mostrado a los clientes.
7. Si el agente tiene que completar el campo para resolver el ticket, seleccione Se requiere para resolver un ticket. Esta opción no está disponible en todos los tipos de campos.
   Nota: Cuando los agentes fusionan un ticket, no es necesario que llenen los campos obligatorios porque los tickets fusionados omiten el estado Resuelto y pasan directamente a Cerrado. Este ajuste también se omite si una regla de negocios cambia el ticket a Resuelto porque el ticket lo resuelve un proceso del sistema en lugar de un agente.
8. Si el usuario final tiene que completar este campo para enviar el ticket, seleccione Se requiere para enviar una solicitud.
9. Configure las opciones adicionales necesarias según el tipo de campo.
10. (Opcional) Especifique un Valor predeterminado para el campo personalizado.
    Nota: El valor predeterminado en una lista desplegable solo se aplica a los tickets nuevos creados por agentes a través de la interfaz de Support o creados por los usuarios en cualquier parte donde se muestre el formulario de ticket. Si se cambia de un formulario de ticket existente a uno con una lista desplegable y una opción predeterminada, la opción predeterminada no se muestra y el espacio aparece en blanco.
11. Haga clic en Guardar, o bien para crear otro campo personalizado, haga clic en el icono desplegable, seleccione Guardar y agregue el campo adicional.
12. Guarde la ID de campo del campo que acaba de crear, ya que la necesitará cuando use la API de metadatos.

Una vez creado el campo de conversación, los desarrolladores pueden usar la API /api/v2/ticket_fields para ver sus datos. Este es un ejemplo de una respuesta:

[
 {
   url: "https://z3n-lhills.zendesk.com/api/v2/ticket_fields/10093547287955.json",
   id: 10093547287955,
   type: "integer",
   title: "Bike Order id",
   raw_title: "Bike Order id",
   description:
     "An API will populate this bike order id value",
   raw_description:
     "An API will populate this bike order id value",
   position: 9999,
   active: true,
   required: false,
   collapsed_for_agents: false,
   regexp_for_validation: "\A[-+]?\d+\z",
   title_in_portal: "Bike Order Id",
   raw_title_in_portal: "Bike Order Id",
   visible_in_portal: true,
   editable_in_portal: true,
   required_in_portal: false,
   tag: null,
   created_at: "2022-10-04T04:48:05Z",
   updated_at: "2022-10-04T04:48:05Z",
   removable: true,
   agent_description: "Order id from our bikes catalog",
 },
]

Borrar el campo de conversación

Hay ocasiones en las que es necesario borrar los valores del campo de conversación. Esta decisión depende del caso de uso y se toma cuando los datos recuperados ya no son válidos. Por ejemplo, supongamos que está usando campos de conversación para recopilar datos del carrito de compras de un usuario final en Internet. Si el usuario final borra todos los artículos de su carrito, los datos recopilados ya no serán válidos y se podrán borrar esos valores del campo de conversación.

Los campos de conversación se borran mediante la API clearConversationFields( ).

Agregar una etiqueta de conversación

Las etiquetas son palabras o combinaciones de palabras que se pueden usar para agregar más contexto a los tickets y temas. Se pueden aplicar etiquetas a tickets, usuarios y organizaciones. Por ejemplo, etiquete todas las solicitudes que sean en realidad consultas de ventas con una etiqueta "ventas" o "sobre_ventas". A continuación, puede crear una vista o un informe para hacer el seguimiento de esas solicitudes.

Si desea más información, consulte Acerca de las etiquetas.

Usar las API de metadatos

Consulte Using messaging metadata (Uso de los metadatos de mensajería) en la documentación para desarrolladores si desea ver un ejemplo de cómo usar las API de metadatos.

Establecer etiquetas y campos de conversación

Los valores del campo de conversación se establecen usando la API setConversationFields. Por ejemplo, si la ID del campo de ticket personalizado es 10093547287955 y desea establecer su valor en la cadena '548832222', llamaría a:

zE('messenger:set', 'conversationFields', [{ id: '10093547287955', value: '548832222'}]);

Si utiliza un campo desplegable personalizado o cualquier campo que asocie un valor de campo con una etiqueta, al establecer el valor del campo personalizado también se establecerá el valor de la etiqueta personalizada en el ticket resultante.

	API del lado del cliente para establecer los campos de conversación
Web Widget	zE('messenger:set', 'conversationFields', [{ id: '{field ID}', value: '{value}'}])
iOS	Zendesk.instance.setConversationFields(["{field ID}” : “{field ID}"])
Android	Zendesk.instance.setConversationFields(listOf( TicketField(id="{field ID}", value="{value}" )))
Unity	ZendeskSdk.Instance.Messaging.SetConversationFieldsAsync(Dictionary<string, object> ticketFields)

Este es un ejemplo de una respuesta para setConversationFields:

conversation: {
  ...
  metadata: {
        "zen:ticket_field": "30289064739483",
        ...
  },
}

Nota: {field ID} tiene que ser una cadena. De lo contrario, se convertirá en una cadena. {value} debe ser una cadena, un número o un valor booleano.

Los valores de la etiqueta de conversación se establecen mediante la API setConversationTags. De manera similar a lo que sucede con la API setConversationFields, si se establece una etiqueta personalizada asociada con un campo personalizado que se puede editar, también se establecerá el campo personalizado. Si la etiqueta personalizada está asociada con un campo personalizado privado (que no se puede editar), el campo personalizado no se establece.

	API del lado del cliente para establecer las etiquetas de conversación
Web Widget	zE('messenger:set', 'conversationTags', ['{tag value}', '{tag value}'])
iOS	Zendesk.instance.setConversationTags(["{tag value}", "{tag value}"])
Android	Zendesk.instance.setConversationTags(listOf("{tag value}", "{tag value}"))
Unity	ZendeskSdk.Instance.Messaging.SetConversationTags(List<string> tags)

Este es un ejemplo de respuesta que usa setConversationTags:

conversation: {
  ...
  metadata: {
    "zen:ticket:tags": "likes-nike-trainers, frequent-shopper",
  },
}

Borrar etiquetas y campos de conversación

Las etiquetas y los valores del campo de conversación se pueden borrar cuando cambia el contexto del lado del cliente. Por ejemplo, el usuario final abandona la página de un producto y va a la página de su tienda principal. Los datos recopilados en la página del producto ya no serán válidos.

Para ello, utilice las API ClearConversationFields y ClearConversationTags, que borran todas las etiquetas y campos de conversación. No es posible borrar un campo o una etiqueta individual.

	API del lado del cliente para borrar las etiquetas y los campos de conversación
Android	Zendesk.instance.clearConversationFields() Zendesk.instance.removeConversationTags()
Unity	ZendeskSdk.Instance.Messaging.ClearConversationFields() ZendeskSdk.Instance.Messaging.ClearConversationTags()

Generador de bots (agentes IA heredados)

Los campos actualizados con las API de metadatos se rellenarán con datos existentes y los usuarios finales podrán editarlos en este paso. Si desea más información, consulte Comprender los tipos de pasos del flujo de respuesta y Crear campos de ticket personalizados.