Aller au contenu principal

Accès aux APIS

Pour accéder aux APIS, dirigez-vous sur la page Préférences > Api > Accès aux APIs.

L'identifiant correspond au botUUID.

Notez que vous aurez également besoin d'une Authorization que vous pourrez obtenir en suivant la procédure décrite sur cette page.

Cliquez sur le lien affiché si vous souhaitez accéder au servlet.

Vous pouvez dès lors consulter les différents accès API et procéder aux modifications souhaitées pour chaque élément auquel vous pouvez accéder.

Servlet

  • Account : vous permet d'obtenir l'intégralité des bots auxquels a accès un utilisateur.
  • Account preferences : vous permet d'obtenir des informations sur les préférences d'un compte utilisateur. Vous pouvez également en ajouter ou en supprimer.
  • Authentication : vous permet de générer un token valable pendant 24 heures.
  • BO users : vous permet d'ajouter un utilisateur.
  • Bot preferences : vous permet d'obtenir des informations sur les préférences de votre bot. Vous pouvez également en ajouter ou en supprimer. Voir section suivante pour plus d'informations à partir de cas d'utilisation concrets.
  • Callback : vous permet de gérer diverses opérations Twilio.
  • Chat : vous permet de gérer diverses opérations liées aux conversations.
  • Competencies : vous permet de gérer diverses opérations liées aux compétences (ajout d'une compétence pour un compte utilisateur, suppression d'une compétence, etc.).
  • Dialogs : vous permet notamment de réaliser des exports de conversations de masse.
  • External matchers : vous permet de gérer diverses opérations liées aux matchers externes (vérifier le statut du miroir Luis, export de la base de données au format Luis, etc.).
  • Knowledge base : vous permet d'importer ou d'exporter une base de connaissances.
  • Log Explicit : vous permet de gérer diverses opérations liées aux logs.
  • Matching groups : vous permet d'obtenir tous les groupes de formulations de votre bot.
  • Operators availability : vous permet de connaître la disponibilité des opérateurs.
  • Saml2 service provider for chatboxes : vous permet de gérer diverses opérations liées au SAML.
  • Server status : vous permet d'obtenir des informations sur le status du serveur ainsi que les informations debug.
  • Surveys : permet de gérer diverses opérations sur les questionnaires (création de questionnaire, récupération des questionnaires, etc.).
  • Transfer Bot Data : vous permet de gérer l'import de données de votre bot. Vous pouvez notamment importer ou exporter une galerie d'images.
  • Who am I : vous permet de récupérer les informations reçues par le servlet.

Bot preferences

Cette partie vous permet d'activer certains paramètres au sein de la plateforme dydu.

Activer le service SAML

Afin d'activer le service SAML sur votre plateforme, il peut être nécessaire de devoir ajouter cette préférence dans les préférences de votre bot (si cela n'a pas encore été effectué). Pour cela, veuillez suivre la procédure suivante :

  1. Dirigez-vous sur la page Préférences > Api > Accès aux APIs puis cliquez sur le lien proposé.

  2. Cliquez sur Bot preferences.

  3. Cliquez sur PUT /preferences/bot/{botUUID}/{name}/{value}.

  4. Remplissez les champs :

    • botUUID : ID de votre bot ;
    • name : chatbox.auth.saml.menu.enabled ;
    • value : true ;
    • Authorization : token généré.
  5. Cliquez sur Execute.

    Le service SAML est désormais disponible.

Activer les conversations monitorées

Afin d'activer les conversations monitorées sur votre plateforme, il peut être nécessaire de devoir ajouter cette préférence dans les préférences de votre bot (si cela n'a pas encore été effectué). Pour cela, veuillez suivre la procédure suivante :

  1. Dirigez-vous sur la page Préférences > Api > Accès aux APIs puis cliquez sur le lien proposé.

  2. Cliquez sur Bot preferences.

  3. Cliquez sur PUT /preferences/bot/{botUUID}/{name}/{value}.

  4. Complétez les champs :

    • botUUID : ID de votre bot ;
    • name : livechat.createmonitoreddialogs ;
    • value : true ;
    • Authorization : token généré.
  5. Cliquez sur Execute.

    Les conversations monitorées sont désormais disponibles.

Personnaliser le nom du service dans le corps du mail RGPD

Afin de personnaliser le nom du service dans le corps de mail RGPD, vous devez modifier le paramètre bot.servicename dans les préférences de votre bot. Pour cela, veuillez suivre la procédure suivante :

  1. Dirigez-vous sur la page Préférences > Api > Accès aux APIs puis cliquez sur le lien proposé.

  2. Cliquez sur Bot preferences.

  3. Cliquez sur PUT /preferences/bot/{botUUID}/{name}/{value}.

  4. Complétez les champs :

    • botUUID : ID de votre bot ;
    • name : bot.servicename ;
    • value : nom de votre service ;
    • Authorization : token généré.
  5. Cliquez sur Execute.

    Le mail RGPD comportant le nom du service est désormais personnalisé.

Activer le groupe de formulations Non associé au bot social

Pour un très grand nombre de cas, cette configuration n'est pas nécessaire (configuration pré-existante).

Afin de pouvoir gérer de manière optimale la confirmation lorsque l'utilisateur souhaite ou non quitter une connaissance Slot, vous avez besoin que votre bot puisse gérer le groupe de formulations Non du bot social. À défaut, votre bot peut déclencher l'abandon de la connaissance Slot alors que l'utilisateur ne le souhaitait pas. Afin de mener à bien cette configuration, veuillez suivre les étapes suivantes :

  1. Dirigez-vous sur la page Contenus > Groupes de formulations.

  2. Cliquez sur le groupe Social pour faire défiler les groupes puis cliquez sur le groupe Non.

  3. Cliquez sur Dépendances.

  4. Récupérez l'UUID depuis l'URL qui correspond à l'enchaînement de chiffres et lettres après l'élément group=. Ainsi, si l'URL est : https://app1.earth.doyoudreamup.com/website/knowledges/groupgraph?group=07881a62-cc44-45c3-9aea-fc53727931f0, l'information récupérée est : 07881a62-cc44-45c3-9aea-fc53727931f0

  5. Dirigez-vous sur la page Préférences > Api > Accès aux APIs puis cliquez sur le lien proposé.

  6. Cliquez sur Bot preferences.

  7. Cliquez sur PUT /preferences/bot/{botUUID}/{name}/{value}.

  8. Remplissez les champs :

    • botUUID : ID de votre bot ;
    • name : bot.no.group.uuid ;
    • value : inscrivez la valeur récupérée lors de l'étape 4 ;
    • Authorization : token généré.
  9. Cliquez sur Execute.

Votre bot est désormais capable de gérer le groupe de formulations Non associé au bot social de votre serveur.