Obtener lista de conversaciones

Se recupera información sobre todas las conversaciones de un agente dentro de los criterios de filtro especificados, incluidos conversation_id, user_id, hora del chat reciente, asunto de la conversación, tipo de conversación, recuento total de mensajes y consumo de créditos.

Método de la solicitud

GET

URL de la solicitud

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

Autenticación de la solicitud

Para obtener instrucciones de autenticación, se recomienda consultar Visión general de la API.

Solicitud

Ejemplo de solicitud

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/conversation/page?page=1&conversation_type=ALL&start_time=1691942400000&end_time=1699868066999&page_size=50&user_id=1234567890' \ -H 'Authorization: Bearer ${API Key}' \

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/conversation/page?page=1&conversation_type=ALL&start_time=1691942400000&end_time=1699868066999&page_size=50&user_id=1234567890'  \
-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_type	string	Sí	Tipo de origen del ID de la conversación. Puede tomar los valores: `ALL`, `API`, `EMBED` y otros tipos de origen.
user_id	string	No	ID de usuario. Si no se indica, se considera sin restricciones.
start_time	long	Sí	Hora de inicio de la conversación reciente, en formato de marca de tiempo.
end_time	long	Sí	Hora de fin de la conversación reciente, en formato de marca de tiempo.
page	int	Sí	Número de página; indica qué página se solicita, a partir de 1.
page_size	int	Sí	Número de entradas de datos por página; intervalo 10-100.

Nota: Para conocer los posibles valores de conversation_type, se recomienda consultar la lista de valores del campo de origen del ID de conversación (conversation_id) en la tabla de Visión general del usuario.

Respuesta

Ejemplo de respuesta

{ "list": [ { "conversation_id": "AaACmo05Yrqb6bOSTbsg", "user_id": "3", "anonymous_id": "202607000198150", "recent_chat_time": 1694572952383, "subject": "2+3=?", "conversation_type": "API", "source_page": null, "message_count": 2, "cost_credit": 0.01, "bot_id": "64b902a84f1ff25d1c60c10b", "quality_score": null }, { "conversation_id": "64ec1508c9c1ed5605e6ff28", "user_id": "33", "anonymous_id": "202607000198151", "recent_chat_time": 1693194862160, "subject": "Hello!", "conversation_type": "LIVECHAT", "source_page": "https://www.livechat.com/", "message_count": 20, "cost_credit": 0.59, "bot_id": "64b902a84f1ff25d1c60c10b", "quality_score": null } ], "total": 2 }

                      
                      {
  "list": [
    {
      "conversation_id": "AaACmo05Yrqb6bOSTbsg",
      "user_id": "3",
      "anonymous_id": "202607000198150",
      "recent_chat_time": 1694572952383,
      "subject": "2+3=?",
      "conversation_type": "API",
      "source_page": null,
      "message_count": 2,
      "cost_credit": 0.01,
      "bot_id": "64b902a84f1ff25d1c60c10b",
      "quality_score": null
    },
    {
      "conversation_id": "64ec1508c9c1ed5605e6ff28",
      "user_id": "33",
      "anonymous_id": "202607000198151",
      "recent_chat_time": 1693194862160,
      "subject": "Hello!",
      "conversation_type": "LIVECHAT",
      "source_page": "https://www.livechat.com/",
      "message_count": 20,
      "cost_credit": 0.59,
      "bot_id": "64b902a84f1ff25d1c60c10b",
      "quality_score": null
    }
  ],
  "total": 2
}

Este bloque de código en una ventana flotante

Respuesta correcta

Campo	Tipo	Descripción
list	JSON Array	Lista de conversaciones.
conversation_id	string	ID de conversación.
user_id	string	ID de usuario. Puede ser null en conversaciones procedentes de canales de terceros como LINE o Telegram; en ese caso, utilice `anonymous_id` para identificar al usuario.
anonymous_id	string	ID anónimo, generado automáticamente por GPTBots según la plataforma de origen del usuario.
recent_chat_time	long	Hora de la conversación reciente.
subject	string	Asunto de la conversación.
conversation_type	string	Tipo de conversación.
source_page	string	Página de origen del primer mensaje del usuario. Actualmente, solo el canal LIVECHAT admite este campo; el valor es null cuando `conversation_type` no es `LIVECHAT`.
message_count	int	Número total de mensajes en la conversación.
cost_credit	float	Número de créditos consumidos por la conversación.
bot_id	string	ID del agente.
quality_score	float	Puntuación de calidad de la conversación. null si la conversación aún no se ha evaluado.
total	int	Número total de conversaciones que cumplen los criterios de filtrado (no el número devuelto en la página actual).

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
20059	El agente ha sido eliminado
40127	Error de autenticación del desarrollador