API-Endpunkte der Chatplattform

Die API-Endpunkte der Chatplattform bieten Zugriff auf die Chatobjekte. Für jeden Chat, der an und von der Contact Center AI Platform (CCAI Platform) gesendet wird, wird ein Chat-Objekt erstellt.

Im Folgenden finden Sie die API-Endpunkte der Chat-Plattform:

Chatobjekt

Für jede mobile und Web-Chat-Sitzung auf der CCAI-Plattform wird ein Chat-Objekt erstellt. Das Chat-Objekt sieht so aus:

{
    "id": "integer",
    "status": "string",
    "status_text": "string",
    "features": [
        "string",
        "string"
    ],
    "created_at": "string",
    "ends_at": "string",
    "timeout_at": "string",
    "agent": {
        "id": "integer",
        "name": "string",
        "first_name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "virtual_agent": {
        "id": "integer",
        "name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "all_agents": [
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "all_virtual_agents": [
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "lang": "string",
    "menus": [
        {
            "id": "integer",
            "name": "string"
        },
        {
            "id": "integer",
            "name": "string"
        }
    ],
    "end_user": {
        "id": "integer",
        "identifier": "string"
    }
}

Chat aktualisieren

Parameter Erforderlich Datentyp Definition
id TRUE Ganzzahl Die Chat-ID, die aktualisiert werden soll

Endpunkt

Method: PATCH
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:id

Header:

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

Text:

{
    "finished_by_user_id": "integer",
    "chat": {
        "deflection_channel": "string",
        "status": "string",
        "escalation_id": "integer"
    }
}

Beispielanfrage und ‑antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Chat aktualisieren

In diesem Beispiel wird gezeigt, wie ein vorhandener Chat erfolgreich aktualisiert wird.

Anfrage

Header:

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

Suchanfrage

Schlüssel Wert Beschreibung
id Ganzzahl (Erforderlich)

Text:

{
    "finished_by_user_id": "integer",
    "chat": {
        "deflection_channel": "string",
        "status": "finished",
        "escalation_id": "integer"
    }
}
Antwort
{
    "id": "integer",
    "status": "string",
    "status_text": "string",
    "features": [
        "string",
        "string"
    ],
    "created_at": "string",
    "ends_at": "string",
    "timeout_at": "string",
    "agent": {
        "id": "integer",
        "name": "string",
        "first_name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "virtual_agent": {
        "id": "integer",
        "name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "all_agents": [
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "all_virtual_agents": [
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "lang": "string",
    "menus": [
        {
            "id": "integer",
            "name": "string"
        },
        {
            "id": "integer",
            "name": "string"
        }
    ],
    "end_user": {
        "id": "integer",
        "identifier": "string"
    }
}

Statuscode:200

Nachricht in einem Chat senden

Mit dieser Methode können Sie eine Nachricht in einer bestehenden Chatsitzung senden.

Parameter Erforderlich Datentyp Definition
id TRUE Ganzzahl Die Chat-ID, in der die Nachricht gesendet werden soll.

Endpunkt

Method: POST
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:id/message

Header:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "from_user_id": integer,
    "message": {
            "type": "string",
            "content": "string"
            }
    }
}

Beispielanfrage und ‑antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Nachricht erfolgreich gesendet

Dieses Beispiel zeigt eine erfolgreiche Übermittlung einer Nachricht an eine bestehende Chatsitzung.

Anfrage

Header:

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

Suchanfrage

Schlüssel Wert Beschreibung
id Ganzzahl (Erforderlich)

Text:

{
    "from_user_id": integer,
    "message": {
            "type": "string",
            "content": : "string"
            }
    }
}
Antwort
{
}

Statuscode:200

Chat mit virtuellem Kundenservicemitarbeiter eskalieren

Einen Chat von einem virtuellen Kundenservicemitarbeiter an einen menschlichen Kundenservicemitarbeiter eskalieren

Parameter Erforderlich Datentyp Definition
chat_id TRUE Ganzzahl Die erforderliche Chat-ID für die Eskalierung.

Endpunkt

Method: POST
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/escalations

Header:

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

Text:

{
    "reason": "string",
    "force_escalate": "boolean"
}

Beispielanfrage und ‑antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Erfolgreiche Eskalation eines Chats

In diesem Beispiel wird gezeigt, wie ein vorhandener Chat an einen Kundenservicemitarbeiter eskaliert wird.

Anfrage

Header:

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

Suchanfrage

Schlüssel Wert Beschreibung
chat_id Ganzzahl (Erforderlich)

Text:

{
    "reason": "by_end_user_ask",
    "force_escalate": true
}
Antwort
{
    "id": "integer",
    "chat_id": "integer",
    "status": "string"
}

Statuscode:200

Eskalierung aktualisieren

Wird nur zum Auswählen des Ablenkkanals verwendet.

Parameter Erforderlich Datentyp Definition
chat_id TRUE Ganzzahl Die erforderliche Chat-ID zum Aktualisieren der ID des Menüs für die Weiterleitung.
id TRUE Ganzzahl Die erforderliche Menü-ID.

Endpunkt

Method: PATCH
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/escalations/:id

Header:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "deflection_channel": "string"
}

Beispielanfrage und ‑antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Eskalierung erfolgreich aktualisiert

In diesem Beispiel wird gezeigt, wie der Eskalierungskanal erfolgreich aktualisiert wird.

Anfrage

Header:

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

Suchanfrage

Schlüssel Wert Beschreibung
chat_id Ganzzahl (Erforderlich)
id Ganzzahl (Erforderlich)

Text:

{
    "deflection_channel": "string"
}
Antwort
{
    "id": "integer",
    "chat_id": "integer",
    "status": "string"
}

Statuscode:200

Hochgeladenes Foto dem Chat hinzufügen

Ein Foto, das in einem Medienspeicher hochgeladen wurde, einem Chat hinzufügen

Parameter Erforderlich Datentyp Definition
chat_id TRUE Ganzzahl Die erforderliche Chat-ID, um das Foto hinzuzufügen.

Endpunkt

Method: POST
Type: RAW
URL: https://{subdomain}.​{domain}/apps/api/v1/chats/:chat_id/photos

Header:

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

Text:

{
    "photo": [
        {
            "s3_path": "string",
            "photo_type": "string"
        },
        {
            "s3_path": "string",
            "photo_type": "string"
        }
    ]
}

Beispielanfrage und ‑antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Foto wurde erfolgreich zum Chat hinzugefügt

Im folgenden Beispiel wird einer vorhandenen Chatunterhaltung ein Foto hinzugefügt, das in einem Medienspeicher hochgeladen wurde.

Anfrage

Header:

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

Suchanfrage

Schlüssel Wert Beschreibung
chat_id Ganzzahl (Erforderlich)

Text:

{
    "photo": [
        {
            "s3_path": "string",
            "photo_type": "string"
        },
        {
            "s3_path": "string",
            "photo_type": "string"
        }
    ]
}
Antwort
{
    "url": "string",
    "media_id": "integer"
}

Statuscode:200

Alle Fotos aus dem Chat abrufen

Ruft die Media-ID und die Speicher-URL für alle Fotos ab, die an den Chat angehängt sind.

Parameter Erforderlich Datentyp Definition
chat_id TRUE Ganzzahl Die erforderliche Chat-ID zum Abrufen der Medieninformationen.

Endpunkt

Method: GET
Type:
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/photos

Header:

Schlüssel Wert Beschreibung
Akzeptieren application/json

Beispielanfrage und ‑antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Chatfotoinformationen für einen Chat erfolgreich abgerufen

Dieses Beispiel zeigt einen erfolgreichen API-Aufruf zum Abrufen der Fotoinformationen für eine bestehende Chatsitzung.

Anfrage

Header:

Schlüssel Wert Beschreibung
Akzeptieren application/json

Suchanfrage

Schlüssel Wert Beschreibung
chat_id Ganzzahl (Erforderlich)
Antwort
[
    {
        "url": "string",
        "media_id": "integer"
    },
    {
        "url": "string",
        "media_id": "integer"
    }
]

Statuscode:200

Vorab signierte Foto-Upload-URL abrufen

Wird verwendet, um eine vorab signierte Upload-URL für Fotos abzurufen.

Parameter Erforderlich Datentyp Definition
chat_id TRUE Ganzzahl Die erforderliche Chat-ID, die der vorab signierten Foto-URL zugeordnet wird.

Endpunkt

Method: POST
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/photos/upload

Header:

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

Beispielanfrage und ‑antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Signierte URL für den Upload wurde abgerufen.

Das folgende Beispiel zeigt eine erfolgreiche Anfrage mit Abruf einer signierten URL für den Foto-Upload.

Anfrage

Header:

Schlüssel Wert Beschreibung
Akzeptieren application/json

Suchanfrage

Schlüssel Wert Beschreibung
chat_id Ganzzahl (Erforderlich)
Antwort
{
    "url": "string",
    "fields": {
        "key": "string",
        "success_action_status": "string",
        "Content-Type": "string",
        "Cache-Control": "string",
        "acl": "string",
        "policy": "string",
        "x-amz-credential": "string",
        "x-amz-algorithm": "string",
        "x-amz-date": "string",
        "x-amz-security-token": "string",
        "x-amz-signature": "string",
        "x-goog-algorithm": "string",
        "x-goog-credential": "string",
        "x-goog-date": "string",
        "x-goog-signature": "string"
    }
}

Statuscode:200

Hochgeladenes Video zum Chat hinzufügen

Ein Video, das in den Medienspeicher hochgeladen wurde, in einen Chat einfügen

Parameter Erforderlich Datentyp Definition
chat_id TRUE Ganzzahl Die erforderliche Chat-ID, der das Video zugeordnet werden soll.

Endpunkt

Method: POST
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/videos

Header:

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

Text:

{
    "video": {
        "s3_path": "string",
        "gcs_path": "string"
    }
}

Beispielanfrage und ‑antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Video wurde erfolgreich in eine Chatsitzung hochgeladen

In diesem Beispiel wird gezeigt, wie ein Video in eine Chatsitzung hochgeladen wird.

Anfrage

Header:

Schlüssel Wert Beschreibung
Akzeptieren application/json

Suchanfrage

Schlüssel Wert Beschreibung
chat_id Ganzzahl (Erforderlich)

Text:

{
    "photo": [
        {
            "s3_path": "string",
            "photo_type": "string"
        },
        {
            "s3_path": "string",
            "photo_type": "string"
        }
    ]
}
Antwort
Body
{
    "url": "string",
    "media_id": "integer"
}

Statuscode:200

Alle Videos aus dem Chat abrufen

Ruft die Media-ID und die Speicher-URL für alle Videos ab, die an den Chat angehängt sind.

Parameter Erforderlich Datentyp Definition
chat_id TRUE Ganzzahl Die erforderliche Chat-ID, für die die Video-URLs abgerufen werden.

Endpunkt

Method: GET
Type:
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/videos

Header:

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

Beispielanfrage und ‑antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Alle Video-URLs für einen Chat abrufen

In diesem Beispiel wird gezeigt, wie alle Video-URLs für einen vorhandenen Chat abgerufen werden.

Anfrage

Header:

Schlüssel Wert Beschreibung
Akzeptieren application/json

Suchanfrage

Schlüssel Wert Beschreibung
chat_id Ganzzahl (Erforderlich)
Antwort
[
    {
        "url": "string",
        "media_id": "integer"
    },
    {
        "url": "string",
        "media_id": "integer"
    }
]

Statuscode:200

Vorab signierte Video-Upload-URL abrufen

Wird verwendet, um eine vorab signierte Upload-URL für Videos abzurufen.

Parameter Erforderlich Datentyp Definition
chat_id TRUE Ganzzahl Die erforderliche Chat-ID, die der vorab signierten Video-URL zugeordnet wird.

Endpunkt

Method: POST
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/videos/upload

Header:

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

Beispielanfrage und ‑antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Signierte URL für den Video-Upload wurde abgerufen

Das folgende Beispiel zeigt eine erfolgreiche Anfrage mit Abruf einer signierten URL für den Video-Upload.

Anfrage

Header:

Schlüssel Wert Beschreibung
Akzeptieren application/json

Suchanfrage

Schlüssel Wert Beschreibung
chat_id Ganzzahl (Erforderlich)
Antwort
{
    "url": "string",
    "fields": {
        "key": "string",
        "success_action_status": "string",
        "Content-Type": "string",
        "Cache-Control": "string",
        "acl": "string",
        "policy": "string",
        "x-amz-credential": "string",
        "x-amz-algorithm": "string",
        "x-amz-date": "string",
        "x-amz-security-token": "string",
        "x-amz-signature": "string",
        "x-goog-algorithm": "string",
        "x-goog-credential": "string",
        "x-goog-date": "string",
        "x-goog-signature": "string"
    }
}

Statuscode:200

Chat erstellen

Starten Sie eine neue Chatsitzung.

Beispielanfrage

Methode: POST

URL: https://{subdomain}.{domain}/apps/api/v1/chats

Header

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

Text

{
    "chat": {
        "menu_id": "integer",
        "end_user_id": "integer",
        "lang": "string",
        "email": "string",
        "context": "object",
        "transcript": "object"
    },
    "end_user": {
        "phone": "string"
    }
}

Kontext:

Das context-Objekt enthält das value-Objekt, das Metadaten an die Chatunterhaltung übergibt. Sie können das context-Objekt als nicht signierten Datenparameter an virtuelle Kundenservicemitarbeiter übergeben. Sehen Sie sich folgendes Beispiel an:

{
    "context": {
        {"value":
            {"foo": "bar",
             "key": "value"}
        }
    }
}

In diesem Beispiel ist der Parameterwert für die nicht signierten Daten für das eingehende Feld context und das Zielfeld könnte auf context festgelegt werden. So können Sie $session.params.context.foo oder $session.params.context.key verwenden.

Beispielantwort

{
    "id": "integer",
    "status": "string",
    "status_text": "string",
    "features": [
        "string",
        "string"
    ],
    "created_at": "string",
    "ends_at": "string",
    "timeout_at": "string",
    "agent": {
        "id": "integer",
        "name": "string",
        "first_name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "virtual_agent": {
        "id": "integer",
        "name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "all_agents": [
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "all_virtual_agents": [
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "lang": "string",
    "menus": [
        {
            "id": "integer",
            "name": "string"
        },
        {
            "id": "integer",
            "name": "string"
        }
    ],
    "end_user": {
        "id": "integer",
        "identifier": "string"
    }
}

Gibt einen Chat nach ID zurück

Diese Methode gibt das Chatobjekt für eine bestimmte Chat-ID zurück.

Endpunkt

Method: GET
Type:
URL: https://{subdomain}.​{domain}/apps/api/v1/chats/:id

Header:

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

Suchanfrage

Schlüssel Wert Beschreibung
chat_id Ganzzahl (Erforderlich)

Beispielanfrage und ‑antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Chat erfolgreich abrufen

Das folgende Beispiel zeigt die erfolgreiche Anfrage für eine vorhandene Chat-ID.

Anfrage

Header:

Schlüssel Wert Beschreibung
Inhaltstyp application/json
Akzeptieren application/json

Suchanfrage

Schlüssel Wert Beschreibung
chat_id Ganzzahl (Erforderlich)
Antwort
{
    "id": "integer",
    "status": "string",
    "status_text": "string",
    "features": [
        "string",
        "string"
    ],
    "created_at": "string",
    "ends_at": "string",
    "timeout_at": "string",
    "agent": {
        "id": "integer",
        "name": "string",
        "first_name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "virtual_agent": {
        "id": "integer",
        "name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "all_agents": [
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "all_virtual_agents": [
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "lang": "string",
    "menus": [
        {
            "id": "integer",
            "name": "string"
        },
        {
            "id": "integer",
            "name": "string"
        }
    ],
    "end_user": {
        "id": "integer",
        "identifier": "string"
    }
}

Statuscode:200

Chat fortsetzen

Setzt einen Chat fort, der aufgrund von Inaktivität geschlossen wurde. Der Chatstatus muss dismissed oder va_dismissed sein.

Beispielanfrage

Methode: POST

URL: https://{subdomain}.{domain}/apps/api/v1/chats/:id/resume

Header

Schlüssel Wert Beschreibung
Akzeptieren application/json

URL-Variablen

Schlüssel Wert Beschreibung
id integer (Erforderlich)

Beispielantwort

{
    "id": "integer",
    "status": "string",
    "status_text": "string",
    "features": [
        "string",
        "string"
    ],
    "created_at": "string",
    "ends_at": "string",
    "timeout_at": "string",
    "agent": {
        "id": "integer",
        "name": "string",
        "first_name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "virtual_agent": {
        "id": "integer",
        "name": "string",
        "va_alias": "string",
        "avatar_url": "string"
    },
    "all_agents": [
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string"
        }
    ],
    "all_virtual_agents": [
        {
            "id": "integer",
            "name": "string",
            "va_alias": "string",
            "avatar_url": "string"
        }
    ],
    "lang": "string",
    "menus": [
        {
            "id": "integer",
            "name": "string"
        }
    ],
    "end_user": {
        "id": "integer",
        "identifier": "string"
    }
}

Reservierte Datenattribute während eines Chats abrufen

Endpunkt

Method: GET
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/chats/:id/customer_flag

Beispielanfrage und ‑antworten

Dieser Abschnitt enthält ein Beispiel für eine Anfrage und eine Antwort für den Endpunkt.

Erfolg

Dieses Beispiel zeigt einen erfolgreichen Aufruf.

Anfrage

Header

Schlüssel Wert Beschreibung
Akzeptieren application/json

URL-Variablen

Schlüssel Wert Beschreibung
id integer (Erforderlich)
Antwort
{
    "verified_customer": "boolean",
    "bad_actor": "boolean",
    "repeat_customer": "boolean"
}

Reservierte Datenattribute während eines Chats aktualisieren

Endpunkt

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

URL-Variablen

Schlüssel Wert Beschreibung
id integer (Erforderlich)

Body

{
    "verified_customer": "boolean",
    "bad_actor": "boolean",
    "repeat_customers": "boolean"
}

Benutzerdefinierte Daten im Chat senden

Benutzerdefinierte Daten in einem Chat senden

Beispielanfrage

Methode: POST

URL: https://{subdomain}.{domain}/apps/api/v1/chats/:id/custom_data

Header

Schlüssel Wert Beschreibung
Content-Type application/json

URL-Variablen

Schlüssel Wert Beschreibung
id integer (Erforderlich)

Beispielantwort

// Use unsecured parameter
{
"signed": false,
"data": {
// Start customer_flag fields
"reserved_verified_customer": {
"label": "LABEL 1",
"value": true
},
"reserved_bad_actor": {
"label": "LABEL 2",
"value": false
},
"reserved_repeat_customer": {
"label": "LABEL 3",
"value": true
},
// End customer_flag fields
"field1": {
"label": "LABEL 4",
"value": "dummy1"
},
"field2": {
"label": "LABEL 5",
"value": "dummy2"
}
}
}
// Use secured parameter
// {
// "signed": true,
// "signed_data": "eyJhbGciOiJIUzI1NiJ9.eyJjdXN0b21fZGF0YSI6eyJyZXNlcnZlZF92ZXJpZmllZF9jdXN0b21lciI6eyJ2YWx1ZSI6ZmFsc2V9LCJyZXNlcnZlZF9iYWRfYWN0b3IiOnsidmFsdWUiOnRydWV9LCJyZXNlcnZlZF9yZXBlYXRfY3VzdG9tZXIiOnsidmFsdWUiOmZhbHNlfSwiZmllbGQxIjp7InZhbHVlIjoiZHVtbXkxMTEifSwiZmllbGQyIjp7InZhbHVlIjoiZHVtbXkyMjIifX0sImV4cCI6MTcyOTY4MzU5MywiaWF0IjoxNzI5Njc5OTkzfQ.BMskgKTM3DbgrMLWjI46ZJ1K73H25JRd16SgHK0A1Ts"
// }
// ======================= How to create <signed_data> =======================
// payload = {
// "custom_data": {
// // Start customer_flag fields
// "reserved_verified_customer": {
// "label": "LABEL 1",
// "value": true
// },
// "reserved_bad_actor": {
// "label": "LABEL 2",
// "value": false
// },
// "reserved_repeat_customer": {
// "label": "LABEL 3",
// "value": true
// },
// // End customer_flag fields
// "field1": {
// "label": "LABEL 4",
// "value": "dummy1"
// },
// "field2": {
// "label": "LABEL 5",
// "value": "dummy2"
// }
// },
// "exp": 1734567890, // expiration timestamp
// "iat": 1734560000 // issue timestamp
// }
// signed_data = JWT.encode(payload, 'Company secret', 'HS256')
// ======================= End how to create <signed_data> =======================

Endnutzer während einer laufenden Chatsitzung informieren

Aktualisieren Sie den Endnutzer, der der aktuellen aktiven Chatsitzung zugeordnet ist. Außerdem werden die mit dem CRM-Ticket verknüpften Kontaktdaten aktualisiert. _Identifier ist erforderlich, während name, email und phone optional sind.

Beispielanfrage

Methode: POST

URL: https://{subdomain}.{domain}/apps/api/v1/chats/:chat_id/end-user

Header

Schlüssel Wert Beschreibung
Content-Type application/json

URL-Variablen

Schlüssel Wert Beschreibung
chat_id integer

Text

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

Beispielantwort

{
    "message": "accepted"
}