Endnutzerendpunkte

Die API-Endpunkte für Endnutzer bieten Zugriff auf die Endnutzerobjekte. Für jeden Endnutzer der Contact Center AI Platform (CCAI Platform) wird ein Endnutzerobjekt erstellt.

Die API-Endpunkte für Anrufe sind:

• Endnutzer aktualisieren

• Endnutzer abrufen

Endnutzer aktualisieren

Mit diesem Endpunkt können Sie die Details eines Endnutzers aktualisieren, darunter:

• E-Mail-Adresse

• Name

• Telefonnummer

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

Endpunkt

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

Header:

Schlüssel	Wert	Beschreibung
Content-Type	application/json
Akzeptieren	application/json

Text:

{
    "identifier": "abc123",
    "email": "[e-mail]",
    "name": "Joe Smith",
    "phone": "[phone]"
}

Beispielanfrage und ‑antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Endnutzer-ID und ‑Kennung

In diesem Beispiel wird gezeigt, wie Sie einen Endnutzer aktualisieren, indem Sie die ID angeben.

Anfrage

Header:

Schlüssel	Wert	Beschreibung
Content-Type	application/json

Text:

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

Antwort

{
    "id": "integer",
    "identifier": "string"
}

Statuscode:200

Endnutzer abrufen

Mit diesem Endpunkt können Sie einen Endnutzer entweder mit der id oder der identifier abrufen.

Endpunkt

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

Header:

Schlüssel	Wert	Beschreibung
Content-Type	application/json

Suchanfrage

Schlüssel	Wert	Beschreibung
id	integer	Interne ID für den Endnutzer
identifier	String	Externe Kennung für den Endnutzer

Beispielanfrage und ‑antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Nach ID abrufen

In diesem Beispiel wird gezeigt, wie Sie einen Endnutzer anhand der ID abrufen.

Anfrage

Header:

Schlüssel	Wert	Beschreibung
Content-Type	application/json

Suchanfrage

Schlüssel	Wert	Beschreibung
id	integer	Interne ID für den Endnutzer

Antwort

{
    "id": "integer",
    "identifier": "string"
}

Statuscode:200

Nach ID abrufen

In diesem Beispiel wird gezeigt, wie Sie einen Endnutzer abrufen, indem Sie die Kennung angeben.

Anfrage

Header:

Schlüssel	Wert	Beschreibung
Content-Type	application/json

Suchanfrage

Schlüssel	Wert	Beschreibung
identifier	String	Externe Kennung für den Endnutzer

Antwort

{
    "id": "integer",
    "identifier": "string"
}

Statuscode:200