Service Manuel

Lorsque vous choisissez Webhook comme méthode d'accès au service manuel, vous devez d'abord mettre en place un service Webhook dans votre environnement serveur. Vous devez fournir les trois interfaces suivantes conformément aux spécifications afin de recevoir les demandes de service manuel, les messages utilisateur et les réponses du service client manuel. GPTBots fournit également deux interfaces pour recevoir les réponses du service client et les instructions de clôture de conversation.

Remarques importantes :

1. Vous devez vous assurer que votre service Webhook fonctionne correctement, car il impacte directement le bon fonctionnement du service d'assistance humaine.

• Si "Occupé" s'affiche après le lancement de l'assistance humaine, cela signifie que votre service Webhook dysfonctionne.
• Si "Connexion en cours" s'affiche après le lancement de l'assistance humaine, cela signifie que votre service Webhook fonctionne normalement.

2. Après avoir initié avec succès une demande de service d'assistance humaine :

• Vous devez appeler l'interface Répondre au message utilisateur (https://api.gptbots.ai/v1/human/message/receive) pour répondre à l'utilisateur avec au moins un message afin d'établir la connexion de la conversation.
• Si vous ne répondez pas au message de l'utilisateur dans le délai d'attente configuré (timeout par défaut 60 secondes), la conversation d'assistance humaine sera automatiquement terminée.

Recevoir la notification de demande de conversation avec un agent humain

Lorsqu'un utilisateur final initie une demande de service humain, GPTBots transmet cette demande à votre service Webhook. Un code de statut de réponse 200 de votre service d'interface indique la création réussie de la conversation de service humain.

Méthode de requête

POST

Endpoint

https://your_domain/conversation/establish

Exemple de requête

                      
                      curl -X POST 'https://YOUR_DOMAIN/human/service/conversation/establish' \
-H 'Content-Type: application/json' \
-d '{
  "body": [
    {
      "text": "human service",
      "message_type": "QUESTION"
    },
    {
      "text": "",
      "message_type": "ANSWER"
    }
  ],
  "timestamp": 1742265090895,
  "email": "bob@gmail.com",
  "conversation_id": "67d8db020fa31d1ef64f53dg",
  "bot_id": "665d88b03ce2b13cf2d573454",
  "user_info": {
    "phone": null,
    "email": "bob@gmail.com",
    "user_id": "KDslas",
    "anonymous_id": "652face5184b30540a6ea7fe"
  }
}'

                    

Remarque : Le conversation_id dans ce corps de requête sert uniquement à identifier l'ID unique pour les scénarios de conversation de service humain, ce qui est différent de l'ID unique généré par Créer un ID de conversation pour les scénarios de conversation Agent.

Paramètres de la requête

Remarques sur le champ email :

• Lors de l'initiation d'un service manuel via iframe/Share/Bubble Widget, l'utilisateur doit renseigner son e-mail. Vous pouvez également personnaliser l'e-mail utilisateur pour éviter de demander à l'utilisateur de saisir un e-mail.
• Lors de la demande de service manuel via des plateformes tierces telles que WhatsApp/Telegram/livechat, l'e-mail par défaut utilisé est support@gptbots.ai. Pour livechat, vous pouvez personnaliser l'e-mail utilisateur.
• Lors de la demande de service manuel via API, le champ email peut être vide. S'il est vide, l'e-mail par défaut utilisé est support@gptbots.ai.

Réponse

Interface de chat

En utilisant le conversation_id créé, envoyez le message de l'utilisateur au service client manuel.

Méthode de requête

POST

Endpoint

https://your_domain/chat

Exemple de requête

                      
                      {
  "conversation_id": "conv_xxx",
  "message_id": "msg_abc124",
  "create_time": 1750000005000,
  "agent_id": "bot_xxx",
  "body": "Ceci est la capture d'écran de ma commande",
  "timestamp": 1750000005200,
  "files": [
    {
      "content_type": "Image",
      "url": "https://files.gptbots.ai/xxx/order.png",
      "name": "order.png",
      "format": "png"
    }
  ]
}

                    

Paramètres de la requête

Réponse

Interface de clôture de conversation

Lorsqu'une conversation utilisateur expire ou que l'utilisateur Agent ferme activement la conversation, cette interface est appelée pour clôturer la conversation.

Méthode de requête

POST

Endpoint

https://your_domain/conversation/close

En-tête de la requête

Paramètres de la requête

Réponse

Répondre aux messages utilisateur

Lorsque vous choisissez webhook comme méthode d'intégration du service humain, GPTBots fournit une interface pour répondre aux messages utilisateur. Cette interface permet aux agents du service client humain d'envoyer du contenu de message aux utilisateurs.

Méthode de requête

POST

Endpoint

https://api-${endpoint}.gptbots.ai/v1/human/message/receive

En-tête de la requête

Exemple de requête

                      
                      {
  "conversation_id": "conv_xxx",
  "timestamp": 1750000000000,
  "body": "Voici la facture que vous avez demandée",
  "files": [
    { "content_type": "Document", "url": "https://your-cdn.com/files/invoice.pdf", "name": "invoice.pdf", "format": "pdf" },
    { "content_type": "Image", "url": "https://your-cdn.com/files/screenshot.png", "name": "screenshot.png", "format": "png" }
  ]
}

                    

Paramètres de la requête

Réponse

Le service client manuel clôture la conversation

Lorsque vous choisissez webhook comme méthode d'accès au service manuel, le service client manuel fourni par GPTBots peut clôturer activement la conversation si nécessaire. Après la clôture, l'utilisateur ne recevra plus de messages du service client, sauf s'il initie à nouveau une conversation de service client manuel.

Méthode de requête

POST

Endpoint

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

En-tête de la requête

Paramètres de la requête

Réponse

Détection de l'état du service GPTBots

GPTBots fournit une interface de vérification de l'état (health-check) permettant de détecter l'état de son propre service humain. Les développeurs peuvent l'appeler pour vérifier si le service humain GPTBots est disponible. Si elle retourne le code de statut HTTP 200 et que le corps de la réponse correspond à l'indicateur de service normal en texte brut (par exemple service is normal), le service humain GPTBots est disponible. Cette interface ne nécessite aucune authentification et retourne du texte brut.

Méthode de requête

GET

Endpoint

https://api.gptbots.ai/v1/human/health

Exemple de requête

                      
                      curl -X GET 'https://api.gptbots.ai/v1/human/health'

                    

Réponse

Lorsque le service GPTBots est disponible, il retourne le code de statut HTTP 200 et un indicateur de service normal en texte brut.

                      
                      service is normal

                    

Recommandation d'évaluation de la disponibilité

L'appelant n'a besoin que du code de statut HTTP comme critère :

Définissez un délai de requête raisonnable (par exemple 3 à 5 secondes) et interrogez à une fréquence fixe (QPM : 3). Cette interface ne nécessite aucune authentification ; aucune clé API n'est requise.