Autenticazione a metà sessione tramite API

Questa pagina spiega come utilizzare gli endpoint API di chiamata e chat per l'autenticazione a metà sessione nei canali SDK.

Gli utenti possono avviare una sessione di assistenza, ad esempio una chat di assistenza, senza autenticarsi. Quando l'autenticazione dell'utente finale diventa necessaria, puoi avviare un flusso di autenticazione. Una volta eseguita l'autenticazione, puoi aggiornare l'identificatore end_user per collegare la sessione all'utente finale verificato.

URI e autenticazione

L'URI di base per questo nuovo endpoint varia a seconda di comm_type.

Per comm_type call:

POST https://<subdomain>.<domain>//apps/api/v1/calls/:call_id/end_user

Per comm_type chat:

POST https://<subdomain>.<domain>//apps/api/v1/chats/:chat_id/end_user

Operazioni API

Parametri

Il corpo della richiesta API deve contenere i seguenti campi:

ID Nome campo Tipo Obbligatorio? Descrizione Valori di esempio
0 identifier Stringa Sì Identificatore esterno univoco fornito.
1 name Stringa No Il nome generico o l'identificatore associato all'interazione. Aiuta a cercare i clienti. John Doe
2 email Stringa No L'indirizzo email generico associato all'interazione. Aiuta a cercare i clienti. john@doe.com
3 phone Stringa No Il numero di telefono generico associato all'interazione. Aiuta a cercare i clienti. 123-456-7890

Esempi di API

Risposta API di esempio

Esempio di risposta di esito positivo:

202 Accepted

{
 "message": "accepted"
}

Esempi di risposte di errore

Parametri mancanti
400 {"message": "param is missing or the value is empty: comm_type"}
400 {"message": "param is missing or the value is empty: identifier"}
Riferimento a un tipo di comunicazione diverso da chiamata o chat
404 {"message": "Not Found"}
Sessione non attiva
400 {"message": "Call is already ended"}
400 {"message": "Chat is already ended"}
Richiesta CRM non supportata
400 {"message": "Unsupported CRM request"}
Richiesta duplicata
400 {"message": "Duplicate request: Please wait for the interval to expire"}

Esempio di richiesta API

Tipo di comunicazione chiamata

POST https://<subdomain>.<domain>/apps/api/v1/calls/:call_id/end_user
Content-Type: application/json
Authorization: Bearer <your_access_token>

{
    "identifier": "unique_external_id",
    "name": "John Doe",
    "email": "johndoe@example.com",
    "phone": "123-456-7890"
}

Chat Comm Type

POST https://<subdomain>.<domain>/apps/api/v1/chats/:chat_id/end_user
Content-Type: application/json
Authorization: Bearer <your_access_token>

{
    "identifier": "unique_external_id",
    "name": "Jane Smith",
    "email": "janesmith@example.com",
    "phone": "098-765-4321"
}

Documentazione dell'API Apps

Per ulteriori endpoint API delle app, consulta Pubblicazione dell'API Apps.