Contatti del Sito Web e Meta Dati

Ottieni prima gli elementi essenziali!

Per utilizzare le API di Acconsentobot, devi assicurarti di avere con te i seguenti dettagli.

A. UUID - Puoi ottenere l'UUID dallo storage di sessione web locale come mostrato nell'immagine qui sotto:

B. Bot ID & User ID: Si può ottenere il Bot ID e l'User ID dallo Script del Bot o dall'URL della pagina del Bot. Ecco un esempio.

Per l'URL della pagina Chatbot:

// Struttura URL Pagina Chatbot

https://page.Acconsentobot.online/BotId/CustomerId

// Il primo valore dopo .com è il BotId e il secondo valore è il CustomerId.

Per lo Script Chatbot:

// Struttura Script Chatbot

<script id="Acconsentobot-messenger-widget" src="https://cdn.Acconsentobot.online/Acconsentobot.js" defer>BotId,CustomerId</script>

// Il primo valore dopo defer> è il BotId e il secondo valore è il CustomerId.

C. Auth Token: Non abbiamo ancora automatizzato tutto. Contatta il nostro team di supporto per ottenerlo.

Ora sei pronto per eseguire il POC

Riferimenti API

Utilizza le API qui sotto per lavorare con i tuoi dati di lead e chat.

Creare un lead in Acconsentobot

Non appena un utente apre il Bot, viene creato un UUID; passalo insieme agli altri dettagli richiesti per creare e aggiornare i dettagli del lead.

API per aggiornare i dati di una chat/lead

PUT https://api.v7.express-chat.ai/inbox/direct/lead

Non appena un utente apre il Bot, viene creato un UUID; passalo insieme agli altri dettagli richiesti per creare e aggiornare i dettagli del lead.

Intestazioni

Nome	Tipo	Descrizione
x-bp-token*	String	Token API

Corpo della Richiesta

Nome	Tipo	Descrizione
uuid*	String	ID univoco di un utente chat
botId*	String	ID univoco del bot
customerId*	String	ID univoco dell'account cliente
agentId	Boolean	ID univoco dell'agente assegnato
status	String	Stato valido per la chat. Valori disponibili: 'OPEN', 'INPROGRESS', 'REVIEW', 'ONHOLD', 'DEPENDANCY', 'CLOSED'
picture	String	Un URL HTTP valido di un'immagine
name	String	Nome del lead
email	String	Email del lead
phone	String	Numero di telefono del lead
dialCode	String	Prefisso incluso il segno "+"
notes	Array<{title: string, description: string}>	Note aggiuntive per la chat
tags	Array<String>	Tag aggiuntivi per la chat
attributes	Array<{key: string, value: string}>	Attributi personalizzati per la chat

Esempi di Risposta

200: OK (API elaborata con successo)

{
    "success": true,
    "message": "ok",
    "code": 200
}

400: Bad Request (Richiesta/parametri errati)

{
    // Response
}

401: Unauthorized (Richiesta non autorizzata)

{
    // Response
}

API per ottenere l'elenco di chat/lead

GET https://api.v7.express-chat.ai/inbox/direct/chats

Per ottenere l'elenco dei lead e i suoi meta dati, effettua la chiamata all'API qui sotto con i dettagli obbligatori.

Parametri Query

Nome	Tipo	Descrizione
botId*	String	ID univoco del bot
customerId*	String	ID univoco dell'account cliente
page*	String	Numero di pagina
type*	String	"lead" per recuperare solo i lead "non-lead" per recuperare chat non lead

Intestazioni

Nome	Tipo	Descrizione
x-bot-token*	String	Token API

Esempi di Risposta

200: OK (API elaborata con successo)

{
    "success": true,
    "message": "ok",
    "data": [
        {
            "_id": "63d9ffa77a8d152facbe2f2f",
            "uuid": "7e88d192-9b20-4035-9b68-d4ac3d58a34f",
            "createdAt": "2023-02-01T05:59:03.533Z",
            "isOnline": false,
            "lastMessage": {
                "at": "2023-02-01T06:00:20.000Z",
                "by": "bot",
                "text": "Benvenuto in Acconsentobot. Sono qui per aiutarti."
            },
            "lastSeenAt": "2023-02-01T06:00:21.000Z",
            "profile": {
                "notes": [
                    {
                        "title": "Titolo di esempio",
                        "description": "Descrizione di esempio",
                        "_id": "63db5c4abcbc3be2e95b20ae"
                    }
                ],
                "userDetails": {
                    "name": "Nome di esempio",
                    "picture": "my-picture",
                    "contact": {
                        "email": "Email di esempio",
                        "phone": {
                            "number": "Numero di esempio",
                            "prefix": "91"
                        }
                    },
                    "city": "Città di esempio",
                    "country": "Paese di esempio",
                    "gender": "MALE",
                    "tags": [
                        "Tag di esempio"
                    ],
                    "attributes": [
                        {
                            "key": "ID",
                            "value": "BP001"
                        }
                    ]
                }
            },
            "status": "INPROGRESS",
            "updatedAt": "2023-02-02T06:46:34.119Z",
            "websiteVisits": 1,
            "_agentAssigned": "631aa793bcfa100487d13d0d"
        }
    ],
    "code": 200
}

400: Bad Request (Richieste/Parametri Errati)

{
    // Response
}

401: Unauthorized (Richiesta non autorizzata)

{
    // Response
}

❓ 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/