Endpoint degli utenti finali

Gli endpoint API per gli utenti finali forniscono l'accesso agli oggetti utente finale. Viene creato un oggetto utente finale per ogni utente finale di Contact Center AI Platform (CCAI Platform).

Di seguito sono riportati gli endpoint API di chiamata:

Aggiorna utente finale

Questo endpoint consente di aggiornare i dettagli di un utente finale, tra cui:

  • indirizzo email

  • nome

  • numero di telefono

{
    "identifier": "string",
    "email": "string",
    "name": "string",
    "phone": "string"
}

Endpoint:

Method: POST
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/end_users

Intestazioni:

Chiave Valore Descrizione
Content-Type application/json
Accetta application/json

Corpo:

{
    "identifier": "abc123",
    "email": "joe@mydomain.com",
    "name": "Joe Smith",
    "phone": "+16171231234"
}

Esempio di richiesta e risposte

Le sezioni seguenti forniscono richieste di esempio all'endpoint.

ID e identificatore dell'utente finale

Questo esempio mostra come aggiornare un utente finale fornendo l'ID.

Richiesta

Intestazioni:

Chiave Valore Descrizione
Content-Type application/json

Corpo:

{
    "identifier": "string",
    "email": "string",
    "name": "string",
    "phone": "string"
}
Risposta
{
    "id": "integer",
    "identifier": "string"
}

Codice di stato: 200

Ottieni utente finale

Questo endpoint consente di recuperare un utente finale utilizzando id o identifier.

Endpoint:

Method: GET
Type:
URL: https://{subdomain}.{domain}/apps/api/v1/end_users

Intestazioni:

Chiave Valore Descrizione
Content-Type application/json

Query:

Chiave Valore Descrizione
id integer ID interno dell'utente finale
identificatore string Identificatore esterno per l'utente finale

Esempio di richiesta e risposte

Le sezioni seguenti forniscono richieste di esempio all'endpoint.

Ottieni per ID

Questo esempio mostra come recuperare un utente finale fornendo l'ID.

Richiesta

Intestazioni:

Chiave Valore Descrizione
Content-Type application/json

Query:

Chiave Valore Descrizione
id integer ID interno dell'utente finale
Risposta
{
    "id": "integer",
    "identifier": "string"
}

Codice di stato: 200

Ottieni per identificatore

Questo esempio mostra come recuperare un utente finale fornendo l'identificatore.

Richiesta

Intestazioni:

Chiave Valore Descrizione
Content-Type application/json

Query:

Chiave Valore Descrizione
identificatore string Identificatore esterno per l'utente finale
Risposta
{
    "id": "integer",
    "identifier": "string"
}

Codice di stato: 200