Actualizar propiedades de la conversación

Actualizar (upsert), mediante el parámetro conversation_id, los valores de las propiedades de la conversación a nivel de sesión. Solo se guardan las propiedades de conversación definidas por el Agente (los nombres de propiedades no definidos se ignoran) y los valores se normalizan según el tipo definido de cada propiedad. Solo se actualizan las propiedades enviadas en esta solicitud; el resto de propiedades no se ve afectado.

Método de solicitud

POST

Endpoint

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

Autenticación

Para obtener instrucciones de autenticación, consúltese Visión general de la API (API Overview).

Solicitud

Ejemplo de solicitud

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

Este bloque de código en una ventana flotante

Cabeceras de la solicitud

Campo	Tipo	Descripción
Authorization	Bearer ${API Key}	Se utiliza `Authorization: Bearer ${API Key}` para la autenticación. La clave de la API se obtiene en la página «API Key».
Content-Type	application/json	Valor fijo `application/json`.

Parámetros de la solicitud

Campo	Tipo	Obligatorio	Descripción
conversation_id	string	Sí	Identificador de la conversación.
properties	JSON Array	Sí	Lista de propiedades de la conversación que se van a actualizar.
name	string	Sí	Nombre de la propiedad de la conversación; debe ser una propiedad de conversación ya definida por el Agente. Las no definidas se ignoran.
value	string	No	Valor de la propiedad de la conversación; se envía siempre como cadena: `DATETIME` como cadena de milisegundos epoch, `BOOLEAN` como "true"/"false", `NUMBER`/`INTEGER` como cadena numérica y `STRING` tal cual. El backend normaliza automáticamente el valor según el tipo definido de la propiedad.

Respuesta

Ejemplo de respuesta

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

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

Este bloque de código en una ventana flotante

Respuesta correcta

Campo	Tipo	Descripción
code	int	Código de retorno; 0 indica éxito.
message	string	Información descriptiva.

Respuesta de error

Campo	Tipo	Descripción
code	int	Código de error.
message	string	Detalles del error.

Códigos de error

Code	Message
40000	Parámetros no válidos
40127	Error de autenticación del desarrollador
40356	La conversación no existe
20059	El agente ha sido eliminado