Obtenir les propriétés de la conversation

Récupérez, à partir du paramètre conversation_id, la liste des propriétés de conversation au niveau de la session, incluant le nom, le type et la valeur pour la session en cours. Toutes les propriétés de conversation définies par l'Agent sont retournées ; si une propriété n'a pas encore de valeur dans la session en cours, value revient à la valeur par défaut définie pour cette propriété.

Méthode de requête

GET

Endpoint

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

Authentification

Consultez la Présentation de l'API pour les instructions d'authentification.

Requête

Exemple de requête

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}'

Ce bloc de code dans la fenêtre flottante

En-têtes de la requête

Champ	Type	Description
Authorization	Bearer ${API Key}	Utilisez Authorization: Bearer ${API Key} pour l'authentification. Obtenez votre clé API depuis la page de clé API.

Paramètres de la requête

Champ	Type	Obligatoire	Description
conversation_id	string	Oui	Identifiant de la conversation.

Réponse

Exemple de réponse

[ { "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"
  }
]

Ce bloc de code dans la fenêtre flottante

Réponse réussie

Champ	Type	Description
id	string	Identifiant unique de la définition de la propriété de conversation.
name	string	Nom de la propriété de conversation.
type	string	Type de la propriété de conversation, valeurs : STRING, INTEGER, NUMBER, BOOLEAN, DATETIME.
value	string	Valeur de la propriété de conversation, toujours retournée sous forme de chaîne (DATETIME en millisecondes epoch, BOOLEAN en "true"/"false"). Si la propriété a été renseignée dans la session en cours, la valeur de la session est retournée ; sinon, la valeur par défaut définie pour cette propriété.

Réponse d'erreur

Champ	Type	Description
code	int	Code d'erreur.
message	string	Détails de l'erreur.

Codes d'erreur

Code	Message
40000	Paramètres invalides
40127	Échec de l'authentification du développeur
40356	La conversation n'existe pas
20059	L'Agent a été supprimé