Obtenir la liste des conversations

Récupérez les informations sur toutes les conversations d'un Agent selon les critères de filtrage spécifiés, incluant conversation_id, user_id, l'heure du dernier échange, le sujet de la conversation, le type de conversation, le nombre total de messages et la consommation de crédits.

Méthode de requête

GET

URL de la requête

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

Authentification de la requête

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

Requête

Exemple de requête

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

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 la clé API depuis la page Clé API.

Paramètres de la requête

Champ	Type	Obligatoire	Description
conversation_type	string	Oui	Type de source de l'ID de conversation. Peut être défini sur : `ALL`, `API`, `EMBED` et d'autres types de sources.
user_id	string	Non	ID utilisateur. Si non renseigné, aucune restriction n'est appliquée.
start_time	long	Oui	Heure de début de la conversation récente, au format timestamp.
end_time	long	Oui	Heure de fin de la conversation récente, au format timestamp.
page	int	Oui	Numéro de page, indique la page à demander, à partir de 1.
page_size	int	Oui	Nombre d'entrées par page, plage de 1 à 100.

Remarque : Pour les valeurs possibles de conversation_type, consultez la Liste des valeurs du champ source de l'ID de conversation (conversation_id) dans le tableau de la section Présentation de l'utilisateur.

Réponse

Exemple de réponse

{ "list": [ { "conversation_id": "AaACmo05Yrqb6bOSTbsg", "user_id": "3", "recent_chat_time": 1694572952383, "subject": "2+3=?", "conversation_type": "API", "message_count": 2, "cost_credit": 0.01, "bot_id": "64b902a84f1ff25d1c60c10b" }, { "conversation_id": "64ec1508c9c1ed5605e6ff28", "user_id": "33", "recent_chat_time": 1693194862160, "subject": "Hello!", "conversation_type": "API", "message_count": 20, "cost_credit": 0.59, "bot_id": "64b902a84f1ff25d1c60c10b" } ], "total": 2 }

                      
                      {
  "list": [
    {
      "conversation_id": "AaACmo05Yrqb6bOSTbsg",
      "user_id": "3",
      "recent_chat_time": 1694572952383,
      "subject": "2+3=?",
      "conversation_type": "API",
      "message_count": 2,
      "cost_credit": 0.01,
      "bot_id": "64b902a84f1ff25d1c60c10b"
    },
    {
      "conversation_id": "64ec1508c9c1ed5605e6ff28",
      "user_id": "33",
      "recent_chat_time": 1693194862160,
      "subject": "Hello!",
      "conversation_type": "API",
      "message_count": 20,
      "cost_credit": 0.59,
      "bot_id": "64b902a84f1ff25d1c60c10b"
    }
  ],
  "total": 2
}

Ce bloc de code dans la fenêtre flottante

Réponse réussie

Champ	Type	Description
list	Tableau JSON	Liste des conversations.
conversation_id	string	ID de la conversation.
user_id	string	ID utilisateur.
recent_chat_time	long	Heure de la conversation la plus récente.
subject	string	Sujet de la conversation.
conversation_type	string	Type de conversation.
message_count	int	Nombre total de messages dans la conversation.
cost_credit	float	Nombre de crédits consommés par la conversation.
bot_id	string	ID de l'agent.
total	int	Nombre de conversations retournées.

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ètre invalide
20059	Agent supprimé