Mettre à jour les propriétés de la conversation

Mettez à jour (upsert), à partir du paramètre conversation_id, les valeurs des propriétés de conversation au niveau de la session. Seules les propriétés de conversation définies par l'Agent sont enregistrées (les noms de propriétés non définis sont ignorés), et les valeurs sont normalisées selon le type défini de la propriété. Seules les propriétés transmises dans cette requête sont mises à jour ; les autres propriétés ne sont pas affectées.

Méthode de requête

POST

Endpoint

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

Authentification

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

Requête

Exemple de requête

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

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.
Content-Type	application/json	Type de données, à définir sur application/json.

Paramètres de la requête

Champ	Type	Obligatoire	Description
conversation_id	string	Oui	Identifiant de la conversation.
properties	JSON Array	Oui	Liste des propriétés de conversation à mettre à jour.
name	string	Oui	Nom de la propriété de conversation ; doit être une propriété de conversation définie par l'Agent, sinon elle sera ignorée.
value	string	Non	Valeur de la propriété de conversation, toujours transmise sous forme de chaîne : millisecondes epoch pour DATETIME, "true"/"false" pour BOOLEAN, chaîne numérique pour NUMBER/INTEGER, telle quelle pour STRING. Le backend normalise automatiquement la valeur selon le type défini de la propriété.

Réponse

Exemple de réponse

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

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

Ce bloc de code dans la fenêtre flottante

Réponse réussie

Champ	Type	Description
code	int	Code de retour, 0 indique le succès.
message	string	Message descriptif.

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é