Ottenere Tutti i Contatti

Ottenere Inbox Utente

Questo endpoint API ti permette di recuperare i dati utente dalla inbox. Fornisce varie opzioni di filtraggio per personalizzare la query.

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

Metodo HTTP: POST

Intestazioni della Richiesta

Authorization: È richiesto un token bearer per l'autenticazione. Sostituisci [MASKED_TOKEN] con il tuo token API valido. Questo token viene utilizzato per autenticare e autorizzare la richiesta.

Corpo della Richiesta

Il corpo della richiesta deve essere un oggetto JSON contenente vari criteri di filtraggio per personalizzare la query. Ecco una descrizione dei campi del corpo della richiesta:

searchText (stringa): Testo di ricerca per filtrare gli utenti.
tags (array): Un array di tag per filtrare gli utenti.
status (array): Un array di valori di stato per filtrare gli utenti.
isOnline (booleano): Indica se gli utenti sono online.
_botWebsite (array): Filtra gli utenti in base alle interazioni sul sito web.
_botWhatsapp (array): Filtra gli utenti in base alle interazioni su WhatsApp.
_botTelegram (array): Filtra gli utenti in base alle interazioni su Telegram.
_botFacebook (array): Filtra gli utenti in base alle interazioni su Facebook.
_agentAssigned (array): Filtra gli utenti assegnati a specifici agenti.
segments (array): Un array di segmenti per filtrare gli utenti.
applicableFilters (array): Un array di filtri applicabili.
lastSeenAt (oggetto): Filtro per intervallo di date per il timestamp dell'ultima visualizzazione.
createdAt (oggetto): Filtro per intervallo di date per il timestamp di creazione.
userInteracted (booleano): Indica se gli utenti hanno interagito.
lastMessageBy (array): Filtra gli utenti in base al mittente dell'ultimo messaggio.
isLiveChatActive (booleano): Indica se la chat dal vivo è attiva per gli utenti.
hasOrdered (oggetto): Filtra gli utenti in base alla loro cronologia ordini.

Esempio di Richiesta

curl 'https://api-v7.express.com/inbox/users' \
  -X 'POST' \
  -H 'Authorization: Bearer [MASKED_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

Sostituisci [MASKED_TOKEN] nella richiesta con il tuo token API effettivo e personalizza i filtri del corpo della richiesta secondo necessità per il tuo caso d'uso.

Risposta

L'API risponderà con un oggetto JSON contenente i dati utente in base ai filtri applicati. Il formato della risposta può variare a seconda dei dati disponibili e dei filtri applicati.

Sostituisci [MASKED_TOKEN] nella richiesta con il tuo token API effettivo per l'utilizzo reale.

❓ Hai domande?

Se hai domande, puoi consultare il nostro repository di FAQ, molto probabilmente troverai la tua risposta qui. In caso contrario, scrivici su https://acconsentobot.click/contatti/.

📒 Centro Risorse Acconsentobot

📖 Guide Prodotto e Formazione

🛠️ Riferimenti API