Creación de un recorrido

Un recorrido se define utilizando el tipo de respuesta user_defined, que sólo está disponible en el editor JSON. (Para más información, consulte Definición de respuestas mediante el editor JSON ) Para crear un viaje, siga estos pasos:

1. En el editor de acciones, cree o edite el paso desde el que desea iniciar el viaje.

2. Pulse el icono Cambiar a editor JSON para abrir el editor JSON.

3. En la matriz generic, cree una respuesta user_defined. (Para más información, consulte Definición de respuestas mediante el editor JSON )

   Un viaje se define utilizando la estructura siguiente:

   "user_defined": {
     "user_defined_type": "IBM_BETA_JOURNEYS_TOUR",
     "skip_card": true|false,
     "card_title": "{title}",
     "card_description": "{description}",
     "steps": [
       ...
     ]
   }
   

   donde:

   user_defined_type

   El tipo específico de respuesta definida por el usuario que está definiendo. Para definir un recorrido, establezca siempre esta propiedad en IBM_BETA_JOURNEYS_TOUR.

   skip_card

   Una propiedad opcional que especifica si el chat web debe iniciar el viaje inmediatamente sin esperar a que el cliente pulse la tarjeta introductoria en la ventana de chat web. (El valor por defecto es false.)

   You can use this option to start a journey directly from your website, even if the web chat is not open. For more information, see Starting a journey without opening the web chat.

   card_title

   El título que se muestra en la tarjeta introductoria que aparece en la conversación web cuando hay un viaje disponible (por ejemplo, Website tour o Disputing a charge).

   card_description

   La descripción que se mostrará en la tarjeta de presentación. Describa el viaje para que sus clientes puedan decidir si desean abrirlo.

   steps

   Una matriz de respuestas que definen los pasos del recorrido.

Ejemplo

El ejemplo siguiente define un recorrido que muestra a los usuarios cómo disputar un cargo, utilizando una combinación de respuestas de texto, imagen y vídeo.

{
  "generic": [
    {
      "response_type": "user_defined",
      "user_defined": {
        "card_title": "Let’s dispute a charge!",
        "card_description": "Follow along with this guided journey to learn how to find and dispute charges.",
        "user_defined_type": "IBM_BETA_JOURNEYS_TOUR",
        "steps": [
          {
            "response_type": "text",
            "text": "Charges are listed on the Transactions page. **Click your profile photo** in the top right corner of your screen, and then **click Transactions** from the menu."
          },
          {
            "response_type": "text",
            "text": "Here you can view your charges.\n **Scroll through the Transactions page and review your charges.** Each charge contains a merchant name, transaction date, and amount charged."
          },
          {
            "response_type": "image",
            "source": "https://example.com/image.png",
            "alt_text": "Image showing location of Dispute option",
            "description": "The option to Dispute is marked in red on the right hand side of each row in the Transactions table. Just click here to file a dispute."
          },
          {
            "response_type": "video",
            "source": "https://vimeo.com/769580398",
            "description": "Watch this short video to learn what to expect now that you’ve filed a dispute."
          }
        ]
      }
    }
  ]
}

Iniciar un viaje sin abrir el chat web

Aunque los viajes forman parte de la integración de chat web, puede hacer posible que sus clientes inicien un viaje directamente desde su sitio web sin abrir la ventana de chat web en absoluto. Por ejemplo, es posible que desee incluir un botón Mostrarme en el sitio web que los clientes pueden pulsar para iniciar una visita interactiva de la página.

Para iniciar un viaje sin abrir el chat web:

1. En la acción que envía la respuesta de recorrido, edite el JSON que define el recorrido. Incluya "skip_card": true para eludir la tarjeta introductoria.

2. En el sitio web, utilice el método de instancia send() para enviar un mensaje al asistente que desencadena la acción que inicia el recorrido (por ejemplo, Give me a tour). Envíe el mensaje en respuesta a cualquier suceso que desee utilizar para desencadenar el viaje (por ejemplo, un clic de botón o una carga de página).

Sus clientes ahora pueden iniciar el viaje interactivo directamente desde su sitio web sin tener que abrir primero el chat web. (Si la ventana de chat web se abre más tarde, la tarjeta introductoria para el viaje aparece en el historial de chat.)

Limitaciones

Esta característica beta tiene actualmente las limitaciones siguientes:

• El panel de vista previa no admite recorridos. Si desea obtener una vista previa de un viaje, utilice el enlace de vista previa compartible. Para obtener más información sobre el enlace de vista previa, consulte Copia de un enlace para compartir.

• Los trayectos utilizan el suceso view:change o el método changeView y no funcionan con los sucesos window:open o window:close o los métodos de instancia openWindow, closeWindow y toggleOpen.

• Cuando el cliente inicia un viaje, se cierra la ventana de conversación web. Si está utilizando el evento view:change para desencadenar la visualización de un formulario posterior a la conversación, el código debe comprobar el valor del nuevo parámetro event.reason o event.newViewState.tour para decidir si mostrar el formulario es adecuado.