Konversationseigenschaften abrufen

Ruft anhand der übergebenen conversation_id die Liste der Konversationseigenschaften auf Gesprächsebene ab, einschließlich Name, Typ und Wert der Eigenschaft im aktuellen Gespräch. Zurückgegeben werden alle im Agent definierten Konversationseigenschaften; wurde einer Eigenschaft im aktuellen Gespräch kein Wert zugewiesen, fällt value auf den in der Definition festgelegten Standardwert zurück.

Anfragemethode

GET

Endpoint

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

Authentifizierung

Siehe API-Übersicht für Authentifizierungsanweisungen.

Anfrage

Beispielanfrage

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/conversation/property?conversation_id=6a55ff78f847452309cae7d4' \ -H 'Authorization: Bearer ${API Key}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/conversation/property?conversation_id=6a55ff78f847452309cae7d4' \
-H 'Authorization: Bearer ${API Key}'

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.

Anfrageparameter

Feld	Typ	Erforderlich	Beschreibung
conversation_id	string	Ja	Gesprächskennung.

Antwort

Beispielantwort

[ { "id": "66aa1b2c3d4e5f60718293a4", "name": "vip_level", "type": "INTEGER", "value": "3" }, { "id": "66aa1b2c3d4e5f60718293a5", "name": "user_city", "type": "STRING", "value": "Bangkok" }, { "id": "66aa1b2c3d4e5f60718293a6", "name": "is_member", "type": "BOOLEAN", "value": "true" } ]

                      
                      [
  {
    "id": "66aa1b2c3d4e5f60718293a4",
    "name": "vip_level",
    "type": "INTEGER",
    "value": "3"
  },
  {
    "id": "66aa1b2c3d4e5f60718293a5",
    "name": "user_city",
    "type": "STRING",
    "value": "Bangkok"
  },
  {
    "id": "66aa1b2c3d4e5f60718293a6",
    "name": "is_member",
    "type": "BOOLEAN",
    "value": "true"
  }
]

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
id	string	Eindeutige Kennung der Definition der Konversationseigenschaft.
name	string	Name der Konversationseigenschaft.
type	string	Typ der Konversationseigenschaft, Werte: STRING, INTEGER, NUMBER, BOOLEAN, DATETIME.
value	string	Wert der Konversationseigenschaft, einheitlich als String zurückgegeben (DATETIME als Epoch-Millisekunden-String, BOOLEAN als "true"/"false"). Wurde im aktuellen Gespräch ein Wert zugewiesen, wird dieser verwendet, andernfalls der in der Definition festgelegte Standardwert.

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