Point de terminaison d'assistance personnalisé

Présentation

Cet article explique comment connecter un point de terminaison d'assistance personnalisé à Ferndesk. Cette fonctionnalité vous permet d'intégrer votre propre système de tickets ou d'assistance, même s'il n'est pas nativement supporté par Ferndesk.

Prérequis

• Vous devez disposer d'une URL accessible publiquement qui renvoie une réponse JSON.

• Vous devez avoir les autorisations pour gérer les intégrations dans Ferndesk.

Étapes

1. Accédez à la page Intégrations dans vos paramètres Ferndesk.

2. Cliquez sur le bouton « Ajouter une intégration ». Cela vous mènera à la page de Connexion d'une intégration.

3. Sélectionnez « Support Endpoint » dans la liste des intégrations disponibles.

4. Dans la boîte de dialogue de configuration, vous verrez un champ intitulé « URL source ».

5. Saisissez l'URL de votre point de terminaison d'assistance personnalisé. Le texte de remplacement pour ce champ est https://company.com/support-endpoint.json?startDate=2025-01-01.

6. Cliquez sur le bouton « Enregistrer » pour connecter le point de terminaison.

Vérifier la configuration

Une fois que vous avez connecté votre point de terminaison d'assistance personnalisé, vous pouvez vérifier qu'il fonctionne correctement en créant un audit. Si la connexion est réussie, vous devriez voir les conversations de votre système d'assistance personnalisé incluses dans l'audit.

Format JSON

Le point de terminaison d'assistance personnalisé doit renvoyer une réponse JSON avec un format spécifique. L'objet racine doit contenir une clé conversations, qui contient un tableau d'objets de conversation. Chaque objet de conversation doit avoir un id, un horodatage lastMessageAt et un tableau de messages. Chaque objet de message au sein du tableau doit inclure un id, un role (soit user, soit agent), un content et un horodatage createdAt.

Voici un exemple du format JSON attendu :

{
  "conversations": [
    {
      "id": "conv_12345",
      "url": "https://support.mycompany.com/conversations/12345",
      "lastMessageAt": "2023-10-27T14:30:00Z",
      "messages": [
        {
          "id": "msg_67890",
          "role": "user",
          "content": "Hello, I'm having trouble with...",
          "createdAt": "2023-10-27T14:25:00Z"
        },
        {
          "id": "msg_67891",
          "role": "support_agent",
          "content": "Hi there, I can help with that. Could you please provide...",
          "createdAt": "2023-10-27T14:30:00Z"
        }
      ]
    }
  ]
}

Dépannage

• Format JSON incorrect : Assurez-vous que la réponse JSON de votre point de terminaison correspond au format spécifié dans cet article.

• URL invalide : Assurez-vous que l'URL que vous fournissez est un point de terminaison accessible publiquement.

• Authentification : Cette fonctionnalité ne prend pas actuellement en charge les points de terminaison authentifiés.