API de usuario del bot

Acceder a la información del usuario del bot o usar la API de OneChat mediante código puede ser difícil para muchos usuarios. Pero con nuestro método sencillo, puedes usar endpoints de API sin esfuerzo, sin necesidad de programar.

none

Acceso a endpoints de API

Ve a Flow Builder. Selecciona un bloque de acción y elige "Advanced actions". Explora las opciones de "Bot User API".

Tutoriales en video

TODO_VIDEO[0ed34dc9a8]: reemplazar este video con un recurso oficial de OneChat.

SqU

Acciones disponibles

1. Listar todas las etiquetas

2. Verificar si el usuario tiene una etiqueta determinada

3. Agregar o quitar etiquetas

4. Listar secuencias suscritas

5. Obtener detalles del carrito de compras

6. Listar pedidos de la tienda

7. Listar mensajes de texto del chat

Listar etiquetas

Con fines de prueba, puedes obtener la lista de todas las etiquetas usando el User_NS. Para almacenamiento permanente, puedes utilizar los campos del sistema Username, First Name y Last Name.

Verificar si tiene etiqueta

Puedes verificar si un usuario tiene una etiqueta o no ingresando el User NS y el Tag Ns. Dónde encontrar el Tag Ns:

Ve a Contents -> Tag -> mueve el cursor sobre la etiqueta y verás el Tag Ns.

Agregar etiqueta

Para agregar una etiqueta al usuario, simplemente selecciona el Tag NS.

Quitar etiquetas

El proceso para quitar etiquetas es similar al de agregarlas. Simplemente ingresa el Tag NS para quitar las etiquetas.

Quitar todas las etiquetas

También es igual. No necesitas ingresar ningún valor; eliminará automáticamente todas las etiquetas del usuario.

Listar secuencias suscritas

Al ingresar el username o el nombre del usuario, puedes obtener la lista de secuencias suscritas con fines de prueba.

Lista de artículos del carrito

Recibirás una lista de todos los artículos que están actualmente en el carrito.

Listar pedidos de la tienda

Recibirás una lista de todos los pedidos realizados por el usuario.

Listar mensajes del chat

Puedes acceder al historial de chat de los últimos 50 mensajes. Tienes la opción de incluir mensajes del agente y del bot, y elegir el formato (predeterminado, texto o texto con hora) según tu preferencia.

Quitar todos los Smart Delays

#### Descripción

La acción Remove All Smart Delays elimina todas las acciones de smart delay asociadas con un usuario específico del bot. Esta función es útil para eliminar al instante cualquier retraso en cola, permitiendo respuestas inmediatas del bot.

#### Cómo quitar todos los Smart Delays

Ve al flujo, selecciona un Action Node y elige Advance Action. Luego selecciona la opción Bot User API.

Ahora selecciona la acción Remove All Smart Delays.

Ahora debes agregar el User NS del usuario al que deseas quitar todos los smart delays o puedes usar un campo del sistema que contenga el User Ns.

En Sample Data verás status: "ok" y delete: "0", lo que significa que todos los smart delays se eliminaron correctamente.

#### Casos de uso

• Reinicio instantáneo: elimina de inmediato todos los retrasos pendientes de un usuario para mejorar los tiempos de respuesta.

#### Respuesta

• Éxito: devuelve un estado 200 OK con un mensaje que confirma que se eliminaron todos los smart delays.

Error: devuelve un código de error apropiado si no se encuentra el user Ns o si la solicitud falla.

Quitar todos los mensajes programados

#### Descripción

La acción Remove All Scheduled Messages permite eliminar todos los mensajes programados en cola para un usuario específico del bot. Esta acción garantiza que no se envíen más mensajes programados al usuario, lo que permite realizar cambios rápidos en los planes de interacción con el usuario.

#### Cómo quitar todos los mensajes programados

Ve al flujo, selecciona un Action Node y elige Advance Action. Luego selecciona la opción Bot User API.

Ahora selecciona la acción Remove All Scheduled Messages.

Ahora debes agregar el UserNS del usuario al que deseas quitar todos los Scheduled Messages.

En Sample Data verás status: "ok" y delete: "0", lo que significa que todos los Scheduled Messages se eliminaron correctamente.

#### Casos de uso

• Eliminación masiva de mensajes: limpia rápidamente todos los mensajes pendientes para evitar que se envíe información redundante o desactualizada.

• Ajuste preciso del flujo: modifica los planes de mensajería programada eliminando todos los mensajes en cola para actualizaciones inmediatas en la interacción con el usuario.

#### Respuesta

• Éxito: devuelve un estado 200 OK con un mensaje que confirma que se eliminaron todos los mensajes programados.

• Error: devuelve un código de error apropiado si no se encuentra el user Ns o si la solicitud falla.

Buscar usuarios del bot por teléfono

Busca usuarios mediante el bot o el espacio de trabajo. Ingresa el número de teléfono del usuario para localizar su perfil.

Buscar usuarios del bot por correo electrónico

Busca usuarios mediante el bot o el espacio de trabajo usando su dirección de correo electrónico.

Buscar usuarios del bot por ID de usuario

Ubica a un usuario en el bot o en el espacio de trabajo usando su ID de usuario único.

Fusionar usuario del bot

Fusiona un usuario secundario del bot en un usuario principal (actual) del bot.

• Todos los datos relevantes del usuario secundario se transferirán al usuario principal.

• Puedes eliminar el usuario secundario después de la fusión o conservar su perfil.

Listar etiquetas

Obtén todas las labels asignadas a un usuario específico.

Verificar si tiene label

Verifica si una label específica está asignada a un usuario. Ingresa el nombre de la label para comprobar si está asociada con el usuario.

Agregar label

Proporciona el nombre de la label y asígnala al usuario objetivo.

Quitar label

Quita una label específica de un usuario. Ingresa el nombre de la label para desvincularla del usuario.

Quitar todas las labels

Quita todas las labels asignadas a un usuario.

Obtener mensaje del chat

Obtén un mensaje específico del chat usando su ID de mensaje (MID).

Listar notas de cierre

Obtén todas las notas de cierre asociadas con un usuario.

Agregar mensaje del asistente a los mensajes del agente de AI

Siempre que se genera una respuesta de AI fuera del agente de AI, esta no se almacena automáticamente en el historial de mensajes del agente de AI. Para resolver esto, se agregó una nueva acción en la sección Bot User API, que permite a los desarrolladores insertar manualmente estas respuestas en el historial de mensajes de AI. Usa la nueva acción Append Assistant Message to AI Agent Messages para agregarla al historial de chat correspondiente.

Nota: Esta acción almacenará mensajes en modo en vivo, no en pruebas.

Aquí puedes ver un ejemplo de cómo se ve: