Obtenir le détail d'une conversation

Récupérez l'historique détaillé des messages d'une conversation à partir de l'identifiant conversation_id fourni. La réponse inclut les détails des messages tels que message_id, les questions de l'utilisateur, le type de message, le contenu du message et l'horodatage de création du message.

Méthode de requête

GET

URL de la requête

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

Authentification

Consultez la vue d'ensemble de l'API pour les détails d'authentification.

Requête

Exemple de requête

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

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és API.

Paramètres de la requête

Champ	Type	Obligatoire	Description
conversation_id	string	Oui	Identifiant de la conversation.
page	int	Oui	Numéro de page à récupérer.
page_size	int	Oui	Nombre de résultats par page, maximum 100.

Réponse

Exemple de réponse

{ "total": 100, "messages": [ { "message_id": "645dd86906931c4a9e0ffb1f", "parent_message_id": "", "message_type": "ANSWER", "text": "Bonjour, je suis un agent du service client, posez-moi vos questions.", "create_time": 1683871849906 }, { "message_id": "745dd86906931c4a9e0ffb1f", "parent_message_id": "645dd86906931c4a9e0ffb1f", "message_type": "QUESTION", "text": "Quelles sont les fonctionnalités de JPush ?", "create_time": 1683871849906 }, { "message_id": "845dd86906931c4a9e0ffb1f", "parent_message_id": "745dd86906931c4a9e0ffb1f", "message_type": "ANSWER", "text": "JPush est une plateforme puissante...", "create_time": 1683871849906 } ] }

                      
                      {
  "total": 100,
  "messages": [
    {
      "message_id": "645dd86906931c4a9e0ffb1f",
      "parent_message_id": "",
      "message_type": "ANSWER", 
      "text": "Bonjour, je suis un agent du service client, posez-moi vos questions.",
      "create_time": 1683871849906
    },
    {  
      "message_id": "745dd86906931c4a9e0ffb1f",
      "parent_message_id": "645dd86906931c4a9e0ffb1f",
      "message_type": "QUESTION",
      "text": "Quelles sont les fonctionnalités de JPush ?",
      "create_time": 1683871849906
    },
    {
      "message_id": "845dd86906931c4a9e0ffb1f",
      "parent_message_id": "745dd86906931c4a9e0ffb1f",
      "message_type": "ANSWER",
      "text": "JPush est une plateforme puissante...",
      "create_time": 1683871849906
    }
  ] 
}

Ce bloc de code dans la fenêtre flottante

Réponse réussie

Champ	Type	Description
total	string	Nombre total de messages dans la conversation.
messages	Tableau JSON	Détails des messages.
message_id	string	ID unique du message.
parent_message_id	string	ID du message parent.
message_type	string	Type de message, ANSWER ou QUESTION.
text	string	Texte du message.
create_time	long	Horodatage de création du message.

Réponse en cas d'échec

Champ	Type	Description
code	int	Code d'erreur.
message	string	Détails de l'erreur.

Codes d'erreur

Code	Message
40000	Paramètre invalide.
40005	Le numéro de page dépasse le total.
40127	Échec de l'authentification.
40356	La conversation n'existe pas.
20059	Agent supprimé