Obtener detalles de la conversación

Se recupera el historial detallado de mensajes de una conversación en función del conversation_id proporcionado. La respuesta incluye detalles del mensaje, como message_id, preguntas del usuario, tipo de mensaje, contenido del mensaje y marca de tiempo de creación.

Método de solicitud

GET

URL de solicitud

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

Autenticación

Consulte Visión general de la API (API Overview) para conocer los detalles de autenticación.

Solicitud

Ejemplo de solicitud

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/messages?conversation_id=xxxxxx&user_id=123456&page=1&page_size=100' \ -H 'Authorization: Bearer ${API Key}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/messages?conversation_id=xxxxxx&user_id=123456&page=1&page_size=100' \
-H 'Authorization: Bearer ${API Key}'

Este bloque de código en una ventana flotante

Encabezados de solicitud

Campo	Tipo	Descripción
Authorization	Bearer ${API Key}	Para la autenticación, se utiliza `Authorization: Bearer ${API Key}`. La clave de API (API Key) se obtiene en la página API Key.

Parámetros de solicitud

Campo	Tipo	Obligatorio	Descripción
conversation_id	string	Sí	Identificador de la conversación.
page	int	Sí	Número de página que se va a recuperar.
page_size	int	Sí	Número de resultados por página; máximo 100.

Respuesta

Ejemplo de respuesta

{ "total": 100, "messages": [ { "message_id": "645dd86906931c4a9e0ffb1f", "parent_message_id": "", "message_type": "ANSWER", "text": "Hello, I'm a customer service agent, please ask me anything.", "create_time": 1683871849906 }, { "message_id": "745dd86906931c4a9e0ffb1f", "parent_message_id": "645dd86906931c4a9e0ffb1f", "message_type": "QUESTION", "text": "What are the features of JPush?", "create_time": 1683871849906 }, { "message_id": "845dd86906931c4a9e0ffb1f", "parent_message_id": "745dd86906931c4a9e0ffb1f", "message_type": "ANSWER", "text": "JPush is a powerful platform...", "create_time": 1683871849906 } ] }

                      
                      {
  "total": 100,
  "messages": [
    {
      "message_id": "645dd86906931c4a9e0ffb1f",
      "parent_message_id": "",
      "message_type": "ANSWER", 
      "text": "Hello, I'm a customer service agent, please ask me anything.",
      "create_time": 1683871849906
    },
    {  
      "message_id": "745dd86906931c4a9e0ffb1f",
      "parent_message_id": "645dd86906931c4a9e0ffb1f",
      "message_type": "QUESTION",
      "text": "What are the features of JPush?",
      "create_time": 1683871849906
    },
    {
      "message_id": "845dd86906931c4a9e0ffb1f",
      "parent_message_id": "745dd86906931c4a9e0ffb1f",
      "message_type": "ANSWER",
      "text": "JPush is a powerful platform...",
      "create_time": 1683871849906
    }
  ] 
}

Este bloque de código en una ventana flotante

Respuesta correcta

Campo	Tipo	Descripción
total	int	Número total de mensajes en la conversación.
messages	array JSON	Detalles del mensaje.
messages[].message_id	string	ID único del mensaje.
messages[].parent_message_id	string	ID del mensaje principal.
messages[].message_type	string	Tipo de mensaje: ANSWER o QUESTION.
messages[].text	string	Texto del mensaje.
messages[].create_time	long	Marca de tiempo de creación.

Respuesta de error

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

Códigos de error

Código	Mensaje
40000	Parámetro no válido.
40005	El número de página supera el total.
40127	Error de autenticación.
40356	La conversación no existe.
20059	Agente eliminado