📇Obtener Todos los Contactos

Esta sección proporciona la documentación del API para obtener todos los contactos de la plataforma Demandu.

🔍 Obtener la Bandeja de Entrada de Usuarios

Este endpoint permite recuperar datos de usuarios desde la bandeja de entrada, ofreciendo diversas opciones de filtrado para personalizar la consulta.​

• 🛠️ URL del Endpoint:

https://api.v7.express-chat.com/inbox/users

• 📨 Método HTTP: POST​

🛡️ Encabezados de la Solicitud

Se requiere un token Bearer válido para la autenticación.​

• Authorization: Bearer [TU_TOKEN]​

Nota: Reemplaza [TU_TOKEN] con tu token de API válido.​

📝 Cuerpo de la Solicitud

El cuerpo de la solicitud debe ser un objeto JSON que contenga diversos criterios de filtrado para personalizar la consulta. A continuación, se detallan los campos disponibles:​

• searchText (string): Texto de búsqueda para filtrar usuarios.​

• tags (array): Un array de etiquetas para filtrar usuarios.​

• status (array): Un array de valores de estado para filtrar usuarios.​

• isOnline (boolean): Indica si los usuarios están en línea.​

• _botWebsite (array): Filtra usuarios basados en interacciones en el sitio web.​

• _botWhatsapp (array): Filtra usuarios basados en interacciones en WhatsApp.​

• _botTelegram (array): Filtra usuarios basados en interacciones en Telegram.​

• _botFacebook (array): Filtra usuarios basados en interacciones en Facebook.​

• _agentAssigned (array): Filtra usuarios asignados a agentes específicos.​

• segments (array): Un array de segmentos para filtrar usuarios.​

• applicableFilters (array): Un array de filtros aplicables.​

• lastSeenAt (objeto): Filtro de rango de fechas para la última vez que se vio al usuario.​

• createdAt (objeto): Filtro de rango de fechas para la fecha de creación.​

• userInteracted (boolean): Indica si los usuarios han interactuado.​

• lastMessageBy (array): Filtra usuarios basados en el remitente del último mensaje.​

• isLiveChatActive (boolean): Indica si el chat en vivo está activo para los usuarios.​

• hasOrdered (objeto): Filtra usuarios basados en su historial de pedidos.​

🧪 Ejemplo de Solicitud

bashCopiarEditarcurl 'https://api.v7.express-chat.com/inbox/usersinbox/users' \
  -X 'POST' \
  -H 'Authorization: Bearer [TU_TOKEN]' \
  -H 'Content-Type: application/json' \
  -d '{
    "searchText": "",
    "tags": [],
    "status": [],
    "isOnline": false,
    "_botWebsite": [],
    "_botWhatsapp": [],
    "_botTelegram": [],
    "_botFacebook": [],
    "_agentAssigned": [],
    "segments": [],
    "applicableFilters": ["userInteracted"],
    "lastSeenAt": {
      "startAt": "",
      "endsAt": ""
    },
    "createdAt": {
      "startAt": "",
      "endsAt": ""
    },
    "userInteracted": true,
    "lastMessageBy": [],
    "isLiveChatActive": false,
    "hasOrdered": {
      "status": false,
      "lastAt": ""
    },
    "page": 1,
    "isExport": "none",
    "isContact": true
  }' \
  --compressed

Nota: Reemplaza [TU_TOKEN] en la solicitud con tu token de API real y personaliza los filtros del cuerpo de la solicitud según tus necesidades específicas.​

📬 Respuesta

La API responderá con un objeto JSON que contiene los datos de los usuarios basados en los filtros aplicados. El formato de la respuesta puede variar dependiendo de los datos disponibles y los filtros aplicados.​

Nota: Asegúrate de manejar adecuadamente la respuesta y considerar posibles paginaciones si el número de resultados es grande.