Konversationseigenschaften aktualisieren

Aktualisiert (upsert) anhand der übergebenen conversation_id die Werte der Konversationseigenschaften auf Gesprächsebene. Gespeichert werden nur im Agent definierte Konversationseigenschaften (nicht definierte Eigenschaftsnamen werden ignoriert), und die Werte werden gemäß dem definierten Typ der Konversationseigenschaft normalisiert. Es werden nur die in dieser Anfrage übergebenen Eigenschaften aktualisiert; alle übrigen bleiben unverändert.

Anfragemethode

POST

Endpoint

https://api-${endpoint}.gptbots.ai/v1/conversation/property/update

Authentifizierung

Siehe API-Übersicht für Authentifizierungsanweisungen.

Anfrage

Beispielanfrage

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/conversation/property/update' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "conversation_id": "6a55ff78f847452309cae7d4", "properties": [ { "name": "vip_level", "value": "3" }, { "name": "user_city", "value": "Bangkok" }, { "name": "is_member", "value": "true" } ] }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/conversation/property/update' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
  "conversation_id": "6a55ff78f847452309cae7d4",
  "properties": [
    { "name": "vip_level", "value": "3" },
    { "name": "user_city", "value": "Bangkok" },
    { "name": "is_member", "value": "true" }
  ]
}'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Bearer ${API Key}	Verwenden Sie `Authorization: Bearer ${API Key}` zur Authentifizierung. Den API-Key erhalten Sie auf der API-Key-Seite.
Content-Type	application/json	Fester Wert `application/json`.

Anfrageparameter

Feld	Typ	Erforderlich	Beschreibung
conversation_id	string	Ja	Gesprächskennung.
properties	JSON Array	Ja	Liste der zu aktualisierenden Konversationseigenschaften.
name	string	Ja	Name der Konversationseigenschaft; muss eine im Agent definierte Konversationseigenschaft sein, nicht definierte werden ignoriert.
value	string	Nein	Wert der Konversationseigenschaft, einheitlich als String übergeben: DATETIME als Epoch-Millisekunden-String, BOOLEAN als "true"/"false", NUMBER/INTEGER als Zahlenstring, STRING unverändert. Das Backend normalisiert den Wert automatisch gemäß dem definierten Typ der Konversationseigenschaft.

Antwort

Beispielantwort

{ "code": 0, "message": "OK" }

                      
                      {
  "code": 0,
  "message": "OK"
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
code	int	Rückgabecode, 0 bedeutet Erfolg.
message	string	Beschreibungstext.

Fehlerantwort

Feld	Typ	Beschreibung
code	int	Fehlercode.
message	string	Fehlerdetails.

Fehlercodes

Code	Nachricht
40000	Ungültige Parameter
40127	Entwickler-Authentifizierung fehlgeschlagen
40356	Gespräch existiert nicht
20059	Agent wurde gelöscht