Obtener propiedades de la conversación

Obtener, mediante el parámetro conversation_id, la lista de propiedades de la conversación a nivel de sesión, incluidos el nombre de la propiedad, el tipo y el valor en la sesión actual. Se devuelven todas las propiedades de conversación definidas por el Agente; si una propiedad no tiene valor asignado en la sesión actual, value recurre al valor predeterminado definido para esa propiedad.

Método de solicitud

GET

Endpoint

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

Autenticación

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

Solicitud

Ejemplo de solicitud

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

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».

Parámetros de la solicitud

Campo	Tipo	Obligatorio	Descripción
conversation_id	string	Sí	Identificador de la conversación.

Respuesta

Ejemplo de respuesta

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

Este bloque de código en una ventana flotante

Respuesta correcta

Campo	Tipo	Descripción
id	string	Identificador único de la definición de la propiedad de la conversación.
name	string	Nombre de la propiedad de la conversación.
type	string	Tipo de la propiedad de la conversación; valores: `STRING`, `INTEGER`, `NUMBER`, `BOOLEAN`, `DATETIME`.
value	string	Valor de la propiedad de la conversación, devuelto siempre como cadena (`DATETIME` como cadena de milisegundos epoch y `BOOLEAN` como "true"/"false"). Si la sesión actual tiene un valor asignado, se toma ese valor; en caso contrario, se toma el valor predeterminado definido para la propiedad.

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