API d’intégration de bot de l’Agent virtuel

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 35 minutes de lecture

    • L’API d’intégration de bot Agent virtuel fournit des points de terminaison qui permettent aux utilisateurs d’intégrer n’importe quelle interface de messagerie instantanée ou un écosystème de bot au et/ou Agent actif.ServiceNow Agent virtuel

    Cette API repose sur le cadre de travail d’intégration conversationnelle de la messagerie instantanée personnalisée fourni avec Agent virtuel l’espace de noms sn_va_as_service et fonctionne dans ce système.

    Pour en savoir plus sur l’installation et la configuration de l’API d’intégration de Agent virtuel bot, reportez-vous à la section Using Virtual Agent with a live agent.

    Intégration de bot VA : POST /sn_va_as_service/bot/integration

    Envoie un message, une pièce jointe ou une URL spécifié à un bot secondaire ServiceNow Agent virtuel (VA) spécifié.

    Le site d’un client peut avoir un ou plusieurs bots secondaires ServiceNow . En plus de transmettre des messages à un ServiceNow bot secondaire VA, le bot principal ou le client de messagerie instantanée peut utiliser ce point de terminaison pour transmettre des messages à un agent via Agent actif la messagerie instantanée. Utilisez le action paramètre transmis dans le corps de la demande pour spécifier comment le contenu spécifié doit être traité.

    Remarque :
    Ce point de terminaison peut être synchrone ou asynchrone selon la configuration. En cas d’asynchrone, lorsque la demande est reçue par le point de terminaison, celui-ci valide la demande et répond avec un état d’appel de réussite ou d’échec et le code d’état HTTP approprié. L’agent virtuel traite ensuite la demande et envoie une deuxième réponse au point de terminaison de réponse configuré. Par exemple, pour une intégration de bot à bot, la deuxième réponse serait à l’URL de votre bot principal. Ces deux réponses sont définies ci-dessous. Pour plus d’informations sur ce point de terminaison de réponse configuré, consultez Configurer le point de terminaison REST de réponse de sortie et l’authentification sortante pour l’API Agent virtuel.
    Remarque :
    Les réponses dans les exemples de code pour ce point de terminaison montrent ce qui est envoyé par le VA au point de terminaison de réponse configuré. Ils n’affichent pas la réponse réelle à ce point de terminaison, qui est une simple réponse de réussite ou d’échec.

    Format d'URL

    URL par défaut : /api/sn_va_as_service/bot/integration

    Paramètres de demande pris en charge

    Tableau 1. Paramètres de chemin d'accès
    Nom Description
    Néant
    Tableau 2. Paramètres de requête
    Nom Description
    Néant
    Tableau 3. Paramètres du corps de la demande
    Nom Description
    action Action que l’agent virtuel devrait entreprendre.
    Valeurs valides :
    • AGENT : bascule la conversation de VA à Agent actif.
    • CREATE_CONVERSATION : crée une interaction de messagerie instantanée.
    • END_CONVERSATION : met fin à la conversation de messagerie instantanée. Le message.text paramètre doit être vide lors de l’utilisation de cette action.
    • FAULT_CONVERSATION : Faille une conversation. Lors de la définition d’une action FAULT_CONVERSATION, fournissez une description pour le cause paramètre.
    • SEND_HISTORY : met à jour uniquement l’historique de messagerie instantanée. L’historique des discussions peut également être envoyé à l’aide du traitement standard des messages avec le history paramètre.
    • SET_USER_TIMEZONE : définit le fuseau horaire de l’utilisateur sur le fuseau horaire spécifié dans le timezone paramètre. Ce fuseau horaire reste en vigueur jusqu’à ce que vous le réinitialisiez à l’aide de ce même paramètre.
    • START_CONVERSATION : démarre une conversation de messagerie instantanée.
    • START_CREATED_CONVERSATION : démarre une conversation de messagerie instantanée initiée à l’aide de CREATE_CONVERSATION.
    • SWITCH : basculez la conversation vers une rubrique qui correspond à ce qui est spécifié dans les intent.id paramètres OR topic.name .
      Remarque :
      Utilisez uniquement l’action SWITCH pour le changement de rubrique lorsque la découverte d’intention se produit dans le bot principal. Si la détection d’intention se produit dans l’Agent ServiceNow® virtuel, utilisez le message.text paramètre.
    • TAPING/VIEWING : Affiche l’indicateur de saisie dans Agent actif. Envoyez d’abord TAPING , puis une fois que l’utilisateur a fini de taper, envoyez VIEWING.
    • UPDATE_MESSAGES : cette action est utilisée pendant les conversations avec un agent actif et fournit deux fonctions de mise à jour des messages pour les intégrations de messagerie instantanée tierce pour les messages reçus de l’agent actif qui sont reflétés sur le panneau de messagerie instantanée d’agent :
      • Dernier état de remise de message après l’envoi d’un message à partir d’un tiers.
      • Texte mis à jour dans le panneau de messagerie instantanée d’agent.

      L’intégration de messagerie instantanée tierce peut mettre à jour la partie texte du message avant de l’envoyer à l’utilisateur final. Cette action peut être appelée pour mettre à jour le texte dans le panneau de messagerie instantanée d’agent afin que l’agent puisse voir le texte mis à jour avec une balise « Mise à jour ».

      Cette action est utilisée avec les message.status paramètres and message.id .

      Cette option n’est valide que si la propriété de l’adaptateur personnalisé portant le nom third_party_chat liée à l’application du fournisseur est définie sur vrai. Il s’agit d’une action synchrone, quelle que soit la nature synchrone/asynchrone du canal.

    • Nul ou paramètre non transmis : envoie le message à l’agent ServiceNow virtuel.
    L’intégration de messagerie instantanée tierce peut mettre à jour le message texte déclenché par l’agent actif avant de l’envoyer à l’utilisateur final. Cette action peut être appelée pour mettre à jour le texte dans le panneau de messagerie instantanée d’agent afin que l’agent puisse voir le texte mis à jour avec une balise « Mise à jour ».

    Type de données : chaîne

    Valeur par défaut : nul
    botToBot Marqueur indiquant si la conversation est entre bots, par exemple entre un bot primaire et un bot secondaire.
    Valeurs possibles :
    • vrai : conversation de bot à bot.
    • faux : conversation de bot autonome ServiceNow .

    Type de données : booléennes

    Par défaut : true
    cause Cause d’une erreur de conversation de messagerie instantanée, par exemple, EXTERNAL_FAILURE. Cette propriété n’est utilisée que lorsqu’elle action est définie sur FAULT_CONVERSATION.

    Type de données : chaîne
    clientSessionId Identificateur de session client unique de l’application/du service que l’utilisateur final utilise pour communiquer avec le ServiceNow bot ou les applications de messagerie instantanée tierces prises en charge.
    • Cet ID permet d’identifier l’ensemble de demandes/réponses pour une conversation utilisateur spécifique.
    • Le format de ce paramètre est déterminé par l’implémenteur.
    • Cette valeur n’est mise à jour que si la third_party_chat valeur du champ est vraie dans le formulaire Propriété de l’adaptateur personnalisé .

    Table : Interaction [interaction]

    Type de données : chaîne

    Valeur par défaut : nul
    Variables clientVariables Paires nom-valeur au format JSON qui sont renvoyées dans la réponse. Ces valeurs ne sont pas traitées par le point de terminaison, mais peuvent être utilisées pour conserver des informations client spécifiques jointes à la conversation.

    Type de données : objet

    Valeur par défaut : nul
    Variables contextuelles Paires nom-valeur au format JSON qui fournissent des informations supplémentaires sur l’utilisateur. Fournissez ces informations pour personnaliser l’expérience de la conversation. Pour en savoir plus sur les variables de contexte, consultez Définir et publier des variables de contexte de messagerie instantanée.
    Par exemple :
    "contextVariables": {
  "requester_session_language": "es", 
  "deviceTimeZone": "America/Los_Angeles"
  "live_agent_only": "true",
  "liveagent_deviceType": "test_device_type"
  "topic": "7c3c819073a3101066c7e9344ef6a7e4" 
}

    Type de données : objet

    Valeur par défaut : nul
    ID d’e-mail Requis lors de l’activation de la liaison de compte, sinon tous les utilisateurs sont considérés comme des utilisateurs invités. Adresse e-mail de l’utilisateur final du client de messagerie instantanée, la personne avec laquelle le bot interagit. Pour en savoir plus sur la liaison de comptes, consultez Lier votre compte d’utilisateur ServiceNow à une application de messagerie pour les conversations d’Agent virtuel.

    Type de données : chaîne
    Histoire Historique de la conversation du bot primaire avec l’utilisateur, en commençant par la demande initiale de l’utilisateur.

    Type de données : objet

    "history": {
  "displayName": "String",
  "isBotMessage": Boolean,
  "timestamp": "String",
  "type": "String",
  "value": "String"
}
    history.displayName Nom de l’utilisateur à qui le message a été envoyé. S’il s’agit du bot principal, transmettez le bot.

    Type de données : chaîne
    history.isBotMessage Marqueur indiquant si le message a été envoyé par le bot primaire.
    Valeurs valides :
    • vrai : le message a été envoyé par le bot principal.
    • faux : le message a été envoyé par l’utilisateur.

    Type de données : booléennes
    history.timestamp Horodatage indiquant l’heure à laquelle le message a été envoyé, en millisecondes.

    Valeurs valides : horodatage Unix à 13 chiffres

    Type de données : chaîne
    histoire.type Type de message envoyé.

    Valeurs valides : texte

    Type de données : chaîne
    historique.valeur Contenu des informations. Par exemple, le texte du message.

    Type de données : chaîne
    intention Décrit l’intention de la conversation. Fournissez ces informations lorsque le action paramètre est défini sur SWITCH.

    Type de données : objet

    "intent": {
  "id": "String"
}
    intent.id NLU ID d’intention de la rubrique système vers laquelle basculer la conversation. La intent.id résolution est fonction de la langue transmise dans la session de messagerie instantanée. Si aucune langue n’est transmise au début d’une conversation, la langue est obtenue à partir de la session/du profil de l’utilisateur.

    Type de données : chaîne

    Table : Langue de la rubrique CS [sys_cs_topic_language]
    message Requis. Détails du message à envoyer au ServiceNow bot.

    Type de données : objet

    "message": {
  "attachment": [Array of Objects],
  "clientMessageId": "String",
  "status": "String",
  "text": "String",
  "typed": Boolean
}
    message.pièce jointe Requis si vous envoyez des pièces jointes. Détails de chaque pièce jointe à envoyer.

    Vous ne pouvez transmettre des pièces jointes qu’en tant qu’URL. Une analyse antivirus est déclenchée sur toutes les pièces jointes. Il n’y a pas de restriction sur la taille d’une pièce jointe, cependant, le transfert de fichiers volumineux peut prendre beaucoup de temps.

    Type de données : tableau d’objets

    "attachment": [
  {
    "clientAttachmentId": "String",
    "contentType": "String",
    "fileName": "String",
    "headers":{Object},
    "id": "String",
    "url": "String"
  }
]
    message.attachment.clientAttachmentId Identificateur unique de la pièce jointe à envoyer au ServiceNow bot. Le format de cet identificateur est déterminé par l’implémenteur.

    Type de données : chaîne

    Valeur par défaut : nul
    message.pièce jointe.contentType Requis si la pièce jointe est spécifiée. Type MIME standard de la pièce jointe.
    Valeurs valides (insensibles à la casse) :
    • Application/PDF
    • application/msword
    • image/png
    • image/jpeg
    • texte/brut
    • vidéo/mpeg

    Type de données : chaîne
    nom_fichier.pièce-jointe.message. Requis si la pièce jointe est spécifiée. Nom de fichier de la pièce jointe.

    Type de données : chaîne
    Message.Pièce jointe.En-têtes Informations supplémentaires nécessaires si le fichier en pièce jointe est privé et protégé.
    Type de données : objet
    "headers":{
  "Authorization":"String"	
}
    message.pièces jointes.en-têtes.Autorisation Informations nécessaires pour obtenir l’autorisation d’accéder à la pièce jointe, telles qu’un nom d’utilisateur et un mot de passe.

    Type de données : chaîne
    message.pièce jointe.url Requis si la pièce jointe est spécifiée. URL où se trouve la pièce jointe. L’agent virtuel obtient la pièce jointe à partir de cette URL, exécute une analyse antivirus, puis traite le fichier. Si la pièce jointe n’est pas un fichier public, vous devez transmettre un message.attachment.header objet contenant les informations d’autorisation afin que la pièce jointe soit accessible. Vous devez également vous assurer que le domaine URL est présent dans les domaines de confiance classés dans sys_cs_provider.

    Type de données : chaîne
    message.clientMessageId Identificateur alphanumérique unique du message. Le format de cet identificateur est déterminé par l’implémenteur.

    Type de données : chaîne

    Valeur par défaut : nul
    message.id Utilisé uniquement avec l’action UPDATE_MESSAGES . ID unique du message de messagerie instantanée à mettre à jour.

    Type de données : chaîne
    message.status État du message.
    Valeurs valides (insensibles à la casse) :
    • external_error : utilisé lorsque la livraison d’un message échoue de l’intégration de messagerie instantanée tierce à l’utilisateur final. Le panneau de chat d’agent est représenté par une balise « Échoué ».
    • sent_to_user : initialement, une seule coche s’affiche pour les messages remis de l’agent actif à l’intégration de messagerie instantanée tierce. Cet état doit être utilisé lorsque le message est remis avec succès depuis l’intégration de messagerie instantanée tierce à l’utilisateur final. En cas de réussite, la double coche s’affiche dans le panneau de messagerie instantanée d’agent.

    Type de données : chaîne
    message.texte Requis si attachment le paramètre n’est pas spécifié. Texte du message.
    • La langue du message doit être transmise dans le contextVariables paramètre.
    • Doit être vide si la valeur de la propriété action est END_CONVERSATION.
    • Doit être le texte mis à jour à refléter sur le panneau de messagerie instantanée d’agent si la valeur de la propriété action est UPDATE_MESSAGES.

    Type de données : chaîne

    Longueur maximale : Illimitée
    message.typed Requis. Marqueur indiquant si le message a été saisi ou s’il s’agit d’une sélection d’option (sélectionnée).
    Valeurs valides :
    • vrai : le message a été saisi par l’utilisateur.
    • faux : le message était une sélection d’option.

    Type de données : booléennes
    requestId Requis. Identificateur alphanumérique unique de cette demande. Le format de cet identificateur est déterminé par l’implémenteur.

    Type de données : chaîne
    silentMessage Marqueur indiquant s’il s’agit d’un message silencieux. Un message silencieux est un message qui ne nécessite pas de réponse.
    Valeurs valides :
    • vrai : message silencieux, aucun message de réponse attendu.
    • faux : message normal, message de réponse attendu.
    Remarque :
    Si une demande avec silentMessage = true est envoyée, tous les messages de bot suivants restent supprimés jusqu’à ce qu’une demande de désactivation du mode silencieux soit envoyée en passant silentMessage = false.

    Type de données : booléennes

    Valeur par défaut : false
    horodatage Epoch Unix Heure à laquelle le message a été envoyé par l’utilisateur final du client de messagerie instantanée.

    Type de données : nombre

    Unité : millisecondes

    Par défaut : heure actuelle
    fuseau horaire Fuseau horaire GMT de l’utilisateur final du client de messagerie instantanée.
    Par exemple :
    "timezone":"Asia/Kolkata"

    Pour obtenir la liste des valeurs de fuseau horaire disponibles, reportez-vous à la section https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

    Type de données : chaîne

    Par défaut : fuseau horaire GMT de l’instance ServiceNow .
    sujet Requis si l’utilisateur souhaite basculer vers une rubrique particulière en spécifiant un nom de rubrique. Paire nom-valeur de la rubrique vers laquelle basculer. Vous pouvez spécifier le nom de la rubrique ou le sys_id de la rubrique.
    Remarque :
    Vous ne pouvez spécifier qu’un seul nom de rubrique ou ID dans l’objet.

    Type de données : objet

    "topic": {
  "name": "String",
  "id": "String"
}

    Par exemple :

    {​ 
  "requestId": "xxxx-xxxx-xxxx-xxxx",​
  "clientSessionId": "xxx-xxx-xxx-xxx",​
  "action":"SWITCH",​
  "topic":{​ 
    "name": "Topic Name"​
  },​ 
  "userId": "beth"​ 
}​
    topic.name Nom de la rubrique vers laquelle basculer.

    Type de données : chaîne

    Table : dans le champ Nom de la table des rubriques Agent virtuel [sys_cs_topic].
    topic.id Sys_id de la rubrique vers laquelle basculer.

    Type de données : chaîne

    Table : Rubriques Agent virtuel [sys_cs_topic]
    userId Requis. Identificateur unique d’utilisateur. Il s’agit de l’identificateur de l’utilisateur final qui interagit avec le bot.

    Type de données : chaîne

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 4. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Type de contenu Format des données du corps de la demande. Prend uniquement en charge application/json.
    jeton Requis si vous utilisez une authentification basée sur un jeton ; facultative pour l’authentification de base ou OAuth. Jeton d’authentification à utiliser si l’authentification par jeton a été configurée pour ce point de terminaison.

    Type de données : chaîne
    Tableau 5. En-têtes de réponses
    En-tête Description
    Néant

    Codes d'état

    Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 6. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès.
    Si vous recevez un code de statut 200, mais que vous ne recevez pas de réponse, vérifiez les points suivants :
    • Indique si la demande échoue lors de la validation statique, JWT ou de jeton basé sur le hachage, ce qui se produit généralement dans le thread de travail de Agent virtuel.
    • Indique si le format du corps de la demande est correct. Si ce n’est pas le cas, la conversion ne se produit pas correctement.
    • Indique si certains paramètres requis sont manquants dans le corps de la demande. Vous pouvez suivre les exceptions et les erreurs dans les journaux système de l’instance ServiceNow .
    • Si le site défini dans le message REST pour recevoir la réponse est opérationnel ; capable de détecter dans les journaux.
    • Assurez-vous que le message REST qui définit l’emplacement de publication de la réponse est correctement défini.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    401 Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
    405 Méthode non valide. La fonctionnalité est désactivée.
    500 Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur.

    Paramètres du corps de réponse

    État de l’appel du point de terminaison. Celui-ci est envoyé en réponse lorsque la demande d’appel initial est reçue. La demande n’a pas encore été traitée.

    Nom Description
    erreur Description de l’erreur détectée. Uniquement renvoyé si une erreur se produit.

    Type de données : objet

    "error": {
  "detail": "String",
  "message": "String"
}
    erreur.détail Détails sur l’erreur rencontrée.

    Type de données : chaîne
    message.erreur Message d’erreur affiché.

    Type de données : chaîne
    statut État de l’appel du point de terminaison.
    Valeurs valides :
    • échec
    • réussite

    Type de données : chaîne

    Paramètres du corps de réponse d’Agent virtuel

    Corps de réponse envoyé depuis le VA au point de terminaison de réponse configuré.

    Nom Description
    Messagerie instantanée d’agent Marqueur indiquant si la conversation est connectée au ServiceNow Agent actif.
    Valeurs possibles :
    • vrai : les messages de messagerie instantanée proviennent d’un agent actif.
    • faux : les messages de messagerie instantanée proviennent d’un bot et ce paramètre n’est pas renvoyé dans la réponse.

    Type de données : booléennes
    body Liste des objets qui décrivent les éléments du corps du message de réponse.

    Type de données : tableau d’objets

    "body": [
  {
    "actionType": "String",
    "agentInfo": {Object},
    "data": "String",
    "group": "String",
    "header": "String",
    "height": Number,
    "itemType": "String",
    "label": "String",
    "maskType": "String",
    "maxCount": Number,
    "maxSize": Number,
    "message": "String",
    "messageId": "String",
    "multiSelect": Boolean,
    "nluTextEnabled": Boolean,
    "options": {Object},
    "promptMsg": "String",
    "required": Boolean,
    "style": "String",
    "templateName": "String",
    "type": "String",
    "uiType": "String",
    "value": "String/{Object}",
    "width": Number
  }
]
    corps.actionType Type de message d’action envoyé par le bot secondaire au bot primaire. Par exemple, l’indicateur de saisie ou le temps d’attente de l’agent.
    Valeurs possibles :
    • EndTypingIndicator
    • StartSpinner
    • Indicateur de typage de démarrage

    Par exemple :

    Envoi de StartTypeIndicator au bot primaire lorsque l’indicateur de saisie est activé.

    "body": {​ 
  "uiType":"ActionMsg",​ 
  "actionType":"StartTypingIndicator"​ 
} 

    Envoi de StartSpinner lors du transfert vers Agent actif pour afficher le temps d’attente à l’utilisateur final.

    "body": { 
  "uiType":"ActionMsg", 
  "actionType":"StartSpinner", 
  "spinnerType":"wait_time",  
  "message":"Routing you to a live agent...", 
  "waitTime":"8 Seconds" 
}

    Type de données : chaîne
    Info corps.agent Si activés dans la configuration de Messagerie instantanée d’agent, le nom et l’avatar de l’agent associé sont activés.
    Type de données : objet 
    "agentInfo":{   
  "agentAvatar":"String",
  "agentId":"String",
  "agentName": "String", 
  "sentFromAgent": Boolean
}

    Par exemple :

    "agentInfo":{ 
  "sentFromAgent": true,
  "agentName":"Beth Anglin", 
  "agentAvatar":"https://instance.servicenow.com/ee4eebf30a0004d963b5c5ac0d734dc4.iix?t=small" 
}
    body.agentInfo.agentAvatar URL du fichier d’avatar associé à l’agent.

    Par exemple : « https://instance.servicenow.com/ee4eebf30a0004d963b5c5ac0d734dc4.iix?t=small »

    Type de données : chaîne
    body.agentInfo.agentId Le sys_id de l’agent actif.

    Table : Profil actif [live_profile]

    Type de données : chaîne
    body.agentInfo.agentName Nom d’affichage de l’agent.

    Type de données : chaîne
    body.agentInfo.sentFromAgent Marqueur indiquant si le message a été envoyé par un agent actif.
    Valeurs possibles :
    • vrai : envoyé par un agent actif.
    • faux : envoyé par un agent virtuel.

    Type de données : booléennes
    corps.données Chaîne JSON qui définit les données dans la carte.

    Type de données : chaîne
    Corps.groupe Groupe de contrôle enrichi auquel l’élément corps appartient. Vous pouvez transformer davantage ces contrôles par défaut en écrivant des scripts de transformation sortants. Pour en savoir plus sur ces scripts, consultez Scripts d’action d’Agent virtuel.
    Valeurs possibles :
    • DefaultOutputCard
    • Date par défaut
    • DefaultGroupedPartsOutputControl
    • HTML par défaut
    • DefaultOutputImage
    • Lien de sortie par défaut
    • Texte par défaut
    • DefaultPicker

    Type de données : chaîne
    corps.en-tête En-tête du lien.

    Type de données : chaîne
    Taille.Corps Hauteur de l’élément HTML.

    Type de données : nombre

    Unité : Pixels
    corps.itemType Type d’élément de corps.
    Valeurs possibles : (sensible à la casse)
    • Texte par défaut
      • Fichier
      • Image
      • Texte d’entrée
      • texte de sortie
    • DefaultPicker
      • Image : Des objets apparaissent dans un carrousel.
      • Liste : les éléments apparaissent dans une liste de style liste déroulante.

    Type de données : chaîne
    Étiquette.Corps Étiquette à afficher pour l’élément associé.

    Type de données : chaîne
    corps.maskType Sensibilité des données associées.
    Valeurs possibles :
    • AUCUN : Les données associées sont de nature générale et n’ont pas besoin d’être sécurisées.
    • SÉCURISÉ : les données associées sont de nature sensible et doivent être traitées en toute sécurité.

    Type de données : chaîne
    corps.maxCount Uniquement renvoyé lorsque uiType est FileUpload. Nombre maximal de pièces jointes pouvant être téléchargées simultanément.

    Type de données : nombre (entier)
    body.maxSize Uniquement renvoyé lorsque uiType est FileUpload. Taille maximale de la pièce jointe pouvant être téléchargée.

    Type de données : nombre (entier)

    Unité : mégaoctets
    Corps.Message Uniquement renvoyé lorsque actionType est StartSpinner. Message à afficher à l’utilisateur.

    Type de données : chaîne
    corps.messageId Identificateur unique pour le message envoyé aux applications de messagerie instantanée tierces prises en charge à partir du ServiceNow Agent virtuel.

    Table : Message de conversation [sys_cs_message]

    Type de données : chaîne
    Sélection.multiple.corps Marqueur indiquant si l’utilisateur peut sélectionner plusieurs options.
    Valeurs possibles :
    • vrai : sélections multiples.
    • faux : sélection unique.

    Type de données : booléennes
    body.nluTextEnabled Marqueur indiquant si le client de messagerie instantanée de l’utilisateur peut recevoir des messages texte de Compréhension du langage naturel (NLU).
    Valeurs possibles :
    • true : peut recevoir des messages NLU.
    • false : impossible de recevoir des messages NLU.

    Type de données : booléennes
    corps.options Liste qui décrit les options disponibles pour un contrôle de sélecteur.
    Type de données : tableau d’objets
    "options": [
  {
    "attachment": "String",
    "description": "String",
    "enabled": Boolean,
    "label": "String",
    "renderStyle": "String",
    "value": "String"
  }
]
    Corps.Options.Pièce jointe URL de l’image dans le carrousel à récupérer.

    Type de données : chaîne
    Corps.Options.Description Description de l’élément de carrousel.

    Type de données : chaîne
    body.options.enabled Marqueur indiquant si le contrôle du sélecteur est activé sur le client de messagerie instantanée de l’utilisateur final. Dans les implémentations bot-to-bot, le bot principal est chargé de s’assurer que le contrôle du sélecteur est désactivé.
    Valeurs possibles :
    • vrai : activé
    • faux : désactivé

    Type de données : booléennes
    Étiquette.Options.Corps Étiquette à afficher pour le paramètre associé body.options.value .

    Type de données : chaîne
    body.options.renderStyle Style à utiliser lors du rendu de l’élément associé.

    Valeur possible : données

    Type de données : chaîne
    Corps.Options.Valeur Valeur à afficher pour le paramètre associé body.options.label .

    Type de données : chaîne
    body.promptMsg Message d’invite à afficher avec le contrôle du sélecteur.

    Type de données : chaîne
    body.required Marqueur indiquant si l’utilisateur final doit répondre à la requête dans l’élément corps.
    Valeurs possibles :
    • vrai : obligatoire
    • false : facultatif

    Type de données : booléennes
    body.spinnerType Uniquement renvoyé lorsque actionType est StartSpinner. Type de spinner affiché à l’utilisateur de messagerie instantanée.

    Valeurs possibles :

    wait_time : Message indiquant le délai avant d’être transféré à un agent actif.

    Type de données : chaîne
    corps.style Style de l’élément de corps.
    Valeurs possibles :
    • bouton
    • Manège
    • liste
    • null

    Type de données : chaîne
    Nom.modèle.corps Nom du modèle à utiliser pour afficher la carte associée.

    Type de données : chaîne
    Type.Corps Uniquement renvoyé pour DefaultOutputLink. Type de données de retour.

    Valeurs possibles : lien

    Type de données : chaîne
    body.uiType Type d’élément de corps. Les valeurs possibles dépendent de la valeur du body.group paramètre. Ces valeurs sont mappées aux contrôles définis dans Concepteur d’agent virtuel. Pour plus d’informations, voir Mise en route du Concepteur d’agent virtuel.
    Valeurs possibles :
    • Message d’action
    • DefaultOutputCard

      Carte de sortie

    • Date par défaut
      • Date
      • Date/Heure
      • Heure
    • DefaultGroupedPartsOutputControl

      GroupedPartsOutputControl

    • HTML par défaut

      HTML de sortie

    • DefaultOutputImage

      Image de sortie

    • Lien de sortie par défaut

      Lien de sortie

    • Texte par défaut
      • Texte d’entrée
      • Texte de sortie
      • Chargement de fichier
    • DefaultPicker
      • Sélecteur
      • TopicPickerControl
      • Booléen

    Type de données : chaîne
    corps.valeur Données à utiliser pour traiter l’élément corps. Le type d’information qui est renvoyé dépend du type d’élément corporel.
    OutputLink : objet.
    "value": {
  "action": "String"
}

    Image de sortie : chaîne. URL de l’image.

    OutputHTML : chaîne. HTML que le client doit rendre.

    Type de données : chaîne ou objet
    Action.Valeur.Corps Uniquement renvoyé pour DefaultOutputLink. URL du lien retourné.

    Type de données : chaîne
    corps.délai d’attente Durée que l’utilisateur doit attendre avant d’être connecté à un agent actif.

    Type de données : chaîne
    corps.largeur Largeur de l’élément HTML associé.

    Type de données : nombre

    Unité : Pixels
    clientSessionId Identificateur de session client unique de l’application/du service de messagerie instantanée que l’utilisateur final utilise pour communiquer avec le ServiceNow bot.

    Type de données : chaîne
    Variables clientVariables Paires nom-valeur au format JSON copiées à partir de ce qui est transmis dans le clientVariables paramètre dans le corps de la demande. Ces valeurs ne sont pas traitées par le point de terminaison, mais peuvent être utilisées pour conserver des informations client spécifiques jointes à la conversation.

    Type de données : objet
    Terminé Marqueur indiquant si la ServiceNow Agent virtuel conversation a été terminée avec succès.
    Valeurs possibles :
    • vrai : la conversation s’est terminée avec succès.
    • faux : la conversation n’est pas terminée et ce paramètre n’est pas renvoyé dans la réponse.

    Type de données : booléennes
    ID entreprise Actuellement inutilisé.
    interactionId Identificateur unique pour chaque conversation entre l’application de ServiceNow Agent virtuel messagerie instantanée et l’application de messagerie instantanée tierce prise en charge.

    Type de données : chaîne
    message Détails du message envoyé à l’agent ServiceNow virtuel. C’est la même chose que l’objet de message transmis.

    Type de données : objet

    "message": {
  "attachment": {Object},
  "clientMessageId": "String",
  "text": "String",
  "typed": Boolean
}
    message.pièce jointe Détails de la pièce jointe. Les pièces jointes peuvent être un fichier ou une URL.

    Type de données : objet

    "attachment": {
  "clientAttachmentId": "String",
  "contentType": "String",
  "fileName": "String",
  "url": "String"
    message.attachment.clientAttachmentId Identificateur unique de la pièce jointe envoyée au ServiceNow VA. Le format de cet identificateur est déterminé par l’implémenteur.

    Type de données : chaîne
    message.pièce jointe.contentType Type MIME standard de la pièce jointe.
    Valeurs possibles (insensibles à la casse) :
    • application/msword
    • Application/PDF
    • image/jpeg
    • image/png
    • texte/brut
    • vidéo/mpeg

    Type de données : chaîne
    nom_fichier.pièce-jointe.message. Nom de fichier de la pièce jointe.

    Type de données : chaîne
    message.pièce jointe.url URL où se trouve la pièce jointe.

    Type de données : chaîne
    message.clientMessageId Identificateur alphanumérique unique du message.

    Type de données : chaîne
    message.texte Texte du message.

    Type de données : chaîne

    Longueur maximale : Illimitée
    message.typed Marqueur indiquant si le message a été saisi ou s’il s’agit d’une sélection d’option (sélectionnée).
    Valeurs possibles :
    • vrai : le message a été saisi par l’utilisateur.
    • faux : le message était une sélection d’option.

    Type de données : booléennes
    nowBotId Actuellement inutilisé.
    nowSessionId Actuellement inutilisé.
    requestId Identificateur unique de cette demande.

    Type de données : chaîne
    score Score de confiance d’intention ServiceNow NLU du modèle, spécifié en pourcentage, par exemple 87,3 %. Ce score permet au bot primaire de décider s’il faut faire apparaître l’intention associée en fonction du seuil de confiance du modèle du NLU bot primaire. Le ServiceNow NLU seuil de confiance du modèle est ignoré sur l’instance ServiceNow afin que le seuil de confiance du modèle du bot primaire puisse être appliqué de manière cohérente à tous les bots NLU secondaires.

    Type de données : nombre
    takeControl Marqueur indiquant que l’utilisateur ServiceNow Agent virtuel souhaite redonner le contrôle au bot principal.
    Valeurs possibles :
    • vrai : renvoyer le contrôle au bot principal.
    • false : Gardez le contrôle.

    Type de données : booléennes

    Valeur par défaut : false
    userId Identificateur de l’utilisateur final qui interagit avec le bot.

    Type de données : chaîne

    Démarrez une conversation à l’aide de l’action START_CONVERSATION pour démarrer une conversation

    L’exemple suivant montre comment utiliser l’action START_CONVERSATION pour démarrer une conversation avec Agent virtuel. Cet appel dirige l’utilisateur vers la rubrique du message d’accueil.

    curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{ 
  "requestId": "asd2423-sda23-qwe23-we23", 
  "action": "START_CONVERSATION", 
  "enterpriseId": "ServiceNow", 
  "nowBotId": "A85PWLERF", 
  "clientSessionId": "", 
  "nowSessionId": "",
  "message":{ 
    "text": "", 
    "typed": true, 
    "clientMessageId": "ABC-123" 
  }, 
  "userId": "beth.anglin", 
  "emailId": "beth.anglin@example.com", 
  "timestamp": 1588824102, 
  "timezone": "America/New_York" 
}"
--user "username":"password"

    Voici le corps de la réponse envoyé par l’Agent virtuel au point de terminaison de réponse configuré.

    { 
  "requestId":"asd2423-sda23-qwe23-we23", 
  "clientSessionId":"", 
  "nowSessionId":"", 
  "message":{ 
    "text":"", 
    "typed":true, 
    "clientMessageId":"ABC-123" 
  },
  "userId":"beth.anglin", 
  "body":[ 
    { 
      "uiType":"OutputText", 
      "group":"DefaultText", 
      "value":"Hi, I'm your Virtual Agent. Let me know how I can help you today.", 
      "maskType":"NONE" 
    },
    { 
      "uiType":"TopicPickerControl", 
      "group":"DefaultPicker", 
      "nluTextEnabled":false, 
      "promptMsg":"Hi guest, please enter your request or make a selection of what I can help with. You can type help any time when you need help.", 
      "label":"Show me everything", 
      "options":[ 
        { 
          "label":"b2b topic", 
          "value":"2bb7bd7670de6010f877c7f188266fc7", 
          "enabled":true 
        }, 
        { 
           "label":"Live Agent Support.", 
           "value":"ce2ee85053130010cf8cddeeff7b12bf", 
           "enabled":true 
        } 
      ] 
    }
  ],
  "score":1 
}

    Créer une interaction de messagerie instantanée

    L’exemple suivant montre comment utiliser l’action CREATE_CONVERSATION pour créer une interaction de messagerie instantanée.

    curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  "requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
  "clientSessionId": "",
  "action": "CREATE_CONVERSATION",
  "message": {
    "text": "hi",
    "typed": false
  },
  "userId": "abel.tuter",
  "emailId": "abel.tuter@example.com"
}"
--user "username":"password"

    Voici le corps de la réponse envoyé par l’Agent virtuel au point de terminaison de réponse configuré.

    {
  "requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
  "clientSessionId": "",
  "message": {
    "text": "hi",
    "typed": false
  },
  "userId": "abel.tuter",
  "interactionId": "240c91c8fd9f2e50f877c29ac5fbe8ed",
  "body": [
    {
      "uiType": "ActionMsg",
      "actionType": "CreateConversation",
      "conversationId": "a40c91c8fd9f2e50f877c29ac5fbe8eb",
      "interactionId": "240c91c8fd9f2e50f877c29ac5fbe8ed",
      "messageId": "b80c91c8fd9f2e50f877c29ac5fbe8f8"
    }
  ],
  "score": 1
}

    Démarrer une conversation initiée à l’aide de l’action START_CREATED_CONVERSATION

    L’exemple suivant montre comment démarrer une conversation de messagerie instantanée qui a été initiée à l’aide de l’action CREATE_CONVERSATION .

    curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  "requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
  "clientSessionId": "",
  "action": "START_CREATED_CONVERSATION",
  "userId": "abel.tuter",
  "emailId": "abel.tuter@example.com"
}"
--user "username":"password"

    Voici le corps de la réponse envoyé par l’Agent virtuel au point de terminaison de réponse configuré.

    { 
  "requestId":"302bas2be70-sadsa-we32-3eq2-1231ra9", 
  "clientSessionId":"",
  "message":{ 
    "text":"hola", 
    "typed":true
  }, 
  "userId”:”abel.tuter", 
  "body":[
    { 
      "uiType":"OutputText", 
      "group":"DefaultText",
      "value":"Hi, I'm your Virtual Agent. Let me know how I can help you today.",
      "maskType":"NONE"
    },
    { 
      "uiType":"TopicPickerControl", 
      "group":"DefaultPicker",
      "nluTextEnabled":false,
      "promptMsg":"Hi guest, please enter your request or make a selection of what I can help with. You can type hellllp! any time when you need help.", 
      "label":"Show me everything",
      "options":[
        {
          "label":"boolean check",
          "value":"1b5257a1db712010d3d6d9595e9619f3",
          "enabled":true
        },
        { 
          "label":"Test_table_datepicker",
          "value":"6515f0cadb4220108249f7541d961980",
          "enabled":true
        }, 
        { 
          "label":"Test File upload",
          "value":"76c1f4b2db7520108249f7541d9619a7",
          "enabled":true
        },
        { 
          "label":"Test B2B 2",
          "value":"8373e55cdb8120108249f7541d96196d",
          "enabled":true
        },
        {
          "label":"FAQ Conversation Builder_Global",
          "value":"9f3114a3dbc520108249f7541d961981",
          "enabled":true
        },
        {
          "label":"Get to know you",
          "value":"a443dd6adb812010d3d6d9595e961954", 
          "enabled":true
        }, 
        { 
          "label":"Get to know you_Global", 
          "value":"b1a56b87db8120108249f7541d9619b2", 
          "enabled":true 
        },
        {
          "label":"Live Agent Support.",
          "value":"ce2ee85053130010cf8cddeeff7b12bf",
          "enabled":true
        },
        {
          "label":"Apply for PTO_B2B NLU",
          "value":"d948c94cdb052010d3d6d9595e961969",
          "enabled":true 
        }
      ]
    } 
   ], 
   "score":1 
}

    Échec d’une conversation à l’aide de

    L’exemple suivant montre comment utiliser l’action FAULT_CONVERSATION et définir la valeur du cause paramètre.

    curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  "requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
  "clientSessionId": "",
  "action": "FAULT_CONVERSATION",
  "cause": "EXTERNAL_FAILURE",
  "userId": "abel.tuter",
  "emailId": "abel.tuter@example.com"
}"
--user "username":"password"

    Voici le corps de la réponse envoyé par l’Agent virtuel au point de terminaison de réponse configuré.

    {
  "requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
  "clientSessionId": "",
  "userId": "abel.tuter",
  "body": [],
  "takeControl": true,
  "score": 0
}

    Mettre à jour le message sur le panneau de messagerie instantanée d’agent

    L’action UPDATE_MESSAGES est utilisée pendant les conversations avec l’agent actif et est utilisée pour refléter les mises à jour des messages sur le panneau de messagerie instantanée d’agent à partir d’intégrations de messagerie instantanée tierces. Cette action peut accepter une liste de messages et les mises à jour de tous les messages peuvent être effectuées en une seule exécution.

    curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  "requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
  "clientSessionId": "",
  "message": [
    {
      "status": "external_error",
      "id": "54623afeff762210efa1ffffffffff77"
    }
  ],
  "userId": "abel.tuter",
  "emailId": "abel.tuter@example.com",
  "action": "UPDATE_MESSAGES"
}"
--user "username":"password"

    Voici le message de réponse envoyé par l’Agent virtuel au point de terminaison de réponse configuré.

    Message Processed Successfully

    Mettre à jour uniquement l’historique de messagerie instantanée

    L’exemple suivant montre comment utiliser l’action SEND_HISTORY pour mettre à jour uniquement l’historique de messagerie instantanée.

    curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  "requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
"clientSessionId": "",
  "userId": "abel.tuter",
  "emailId": abel.tuter@example.com,
  "action": "SEND_HISTORY",
  "history": [
    {
      "isBotMessage": true,
      "value": "How can I help you?",
      "displayName": "Genesys Bot",
      "type": "text",
      "timestamp": "1739866290393"
    },
    {
      "isBotMessage": false,
      "value": "I am facing an issue while creating an incident.",
      "displayName": "User",
      "type": "text",
      "timestamp": "1739877357223"
    },
    {
      "isBotMessage": true,
      "value": "Okay. i am routing you to an agent",
      "displayName": "Genesys Bot",
      "type": "text",
      "timestamp": "1739877409746"
    },
    {
      "isBotMessage": false,
      "value": "Thanks.",
      "displayName": "User",
      "type": "text",
      "timestamp": "1739877453201"
    }
  ]
}"
--user "username":"password"

    Voici la réponse de réussite envoyée par le VA au point de terminaison de réponse configuré.

    {"status": "success"}

    Transférer une conversation à Agent actif l’aide de l’énoncé

    L’exemple suivant illustre comment transférer une conversation vers Agent actif, en contournant la rubrique d’accueil, en transmettant l’agent comme énoncé dans le message.text paramètre. Les valeurs d’énoncés possibles sont définies dans la table sys_cs_contextual_action. Pour plus d’informations sur les actions contextuelles, consultez Actions contextuelles pour les intégrations de messagerie instantanée personnalisées.

    curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--header "token: ORANGE" \
--data " {
  "requestId": "322bas2be70-sadsa-we32-3eq2-1231ra9",
  "botToBot": true,
  "clientSessionId": "",
  "silentMessage": false,
  "message":{
    "text": "agent",
    "typed": true
  },
  "userId": "abel.tuter",
  "emailId": "abel.tuter@servicenow.com",
  "timestamp": 1588824102,
  "timezone": "America/New_York"
}"

    Voici le corps de la réponse envoyé par l’Agent virtuel au point de terminaison de réponse configuré.

    {
  "requestId":"322bas2be70-sadsa-we32-3eq2-1231ra9",
  "clientSessionId":"",
  "message":{
    "text":"agent",
    "typed":true
  },
  "userId":"abel.tuter",
  "body":[
    {
      "uiType":"Picker",
      "group":"DefaultPicker",
      "required":true,
      "nluTextEnabled":false,
      "label":"I want to be sure I got this right. What item best describes what you want to do?",
      "itemType":"List",
      "style":"list",
      "multiSelect":false,
      "options":[
        {
          "label":"Live Agent Support.",
          "value":"Live Agent Support.",
          "renderStyle":"data",
          "enabled":false
        },
        {
          "label":"Virtual Agent Capabilities.",
          "value":"Virtual Agent Capabilities.",
          "renderStyle":"data",
          "enabled":false
        },
        {
          "label":"I want something else",
          "value":"-1",
          "renderStyle":"data",
          "enabled":false
        }
      ],
      "scriptedData":null
    }
  ],
  "score":1
}

    Transférer une conversation vers l’assistance d’agent actif en fonction de la sélection de l’utilisateur

    L’exemple suivant montre le transfert de la conversation à l’assistance d’agent actif en fonction de la sélection de l’utilisateur lors de l’interaction précédente.

    curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--header "token: ORANGE" \
--data "{
  "requestId": "322bas2be70-sadsa-we32-3eq2-1231ra9",
  "botToBot": true,
  "clientSessionId": "",
  "silentMessage": false,
  "message":{
    "text": "Live Agent Support.",
    "typed": true
  },
  "userId": "abel.tuter",
  "emailId": "abel.tuter@servicenow.com",
  "timestamp": 1588824102,
  "timezone": "America/New_York"
} "

    Voici le corps de la réponse envoyé par l’Agent virtuel au point de terminaison de réponse configuré.

    {
  "requestId":"322bas2be70-sadsa-we32-3eq2-1231ra9",
  "clientSessionId":"",
  "message":{
    "text":"Live Agent Support.",
    "typed":true
  },
  "userId":"abel.tuter",
  "body":[
    {
      "uiType":"OutputText",
      "group":"DefaultText",
      "value":"Please stand by while I connect you to a live agent."
    }
  ],
  "agentChat":true,
  "score":1
}

    Terminer une Agent virtuel conversation en définissant le paramètre d’action

    L’exemple suivant montre comment mettre fin à une Agent virtuel conversation en définissant le action paramètre sur END_CONVERSATION.

    curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  "requestId": "s345ew-sjg554-qwe23-we23",
  "action": "END_CONVERSATION",
  "enterpriseId": "ServiceNow",
  "nowBotId": "A85PWLERF",
  "clientSessionId": "",
  "nowSessionId": "",
  "message":{
    "text": "b2b topic",
    "typed": true,
    "clientMessageId": "ABC-123"
  },
  "userId": "beth.anglin",
  "emailId": beth.anglin@example.com,
  "timestamp": 1588824102,
  "timezone": "America/New_York"
}"
--user "username":"password"

    Voici le corps de la réponse envoyé par l’agent virtuel au point de terminaison de réponse configuré indiquant que la conversation est terminée.

    {
  "requestId":"s345ew-sjg554-qwe23-we23",
  "clientSessionId":"",
  "nowSessionId":"",
  "message":{
    "text":"",
    "typed":true,
    "clientMessageId":"ABC-123"
  },
  "userId":"beth.anglin",
  "body":[
    {
      "uiType":"OutputText",
      "group":"DefaultText",
      "value":"The conversation has ended. If you need help again, type hi.",
      "maskType":"NONE"
    }
  ],
  "score":1
}

    Terminer une Agent actif conversation en définissant le paramètre d’action

    L’exemple suivant montre comment mettre fin à une Agent actif conversation en définissant le action paramètre sur END_CONVERSATION.

    curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  "requestId": "sad-sjg554-qwe23-we23",
  "action": "END_CONVERSATION",
  "enterpriseId": "ServiceNow",
  "nowBotId": "A85PWLERF",
  "clientSessionId": "",
  "nowSessionId": "",
  "message":{
    "text": "",
    "typed": true,
    "clientMessageId": "ABC-123"
  },
  "userId": "beth.anglin",
  "emailId": "beth.anglin@example.com",
  "timestamp": 1588824102,
  "timezone": "America/New_York"
}"
--user "username":"password"

    Voici le corps de la réponse envoyé par l’agent virtuel au point de terminaison de réponse configuré indiquant que la conversation est terminée.

    {
  "requestId":"sad-sjg554-qwe23-we23",
  "clientSessionId":"",
  "nowSessionId":"",
  "message":{
    "text":"",
    "typed":true,
    "clientMessageId":"ABC-123"
  },
  "userId":"beth.anglin",
  "body":[
    {
      "uiType":"OutputText",
      "group":"DefaultText",
      "value":"The conversation has ended. If you need help again, type hi.",
      "maskType":"NONE"
    }
  ],
  "completed":true,
  "score":1
}

    Utilisez les commandes définies dans la table sys_cs_contextual_action comme énoncé pour démarrer une conversation Agent virtuel

    L’exemple suivant montre comment utiliser la Hi commande définie dans la table sys_cs_contextual_action comme énoncé pour démarrer une conversation au Agent virtuel lieu de définir le action paramètre sur START_CONVERSATION comme indiqué dans les exemples précédents. Cet exemple montre l’utilisation de l’une des variantes linguistiques de la Hi commande, « hola ».

    curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--header "token: ORANGE" \
--data "{
  "requestId": "302bas2be70-sadsa-we32-3eq2-1231ra9",
  "botToBot": true,
  "clientSessionId": "",
  "silentMessage": false,
  "message":{
    "text": "hola",
    "typed": true
  },
  "userId": "fred.ludy",
  "emailId": "abel.tuter@servicenow.com",
  "timestamp": 1588824102,
  "timezone": "America/New_York"
}"

    Voici le corps de la réponse envoyé par l’Agent virtuel au point de terminaison de réponse configuré.

    { 
  "requestId":"302bas2be70-sadsa-we32-3eq2-1231ra9", 
  "clientSessionId":"",
  "message":{ 
    "text":"hola", 
    "typed":true
  }, 
  "userId":"fred.ludy", 
  "body":[
    { 
      "uiType":"OutputText", 
      "group":"DefaultText",
      "value":"Hi, I'm your Virtual Agent. Let me know how I can help you today.",
      "maskType":"NONE"
    },
    { 
      "uiType":"TopicPickerControl", 
      "group":"DefaultPicker",
      "nluTextEnabled":false,
      "promptMsg":"Hi guest, please enter your request or make a selection of what I can help with. You can type hellllp! any time when you need help.", 
      "label":"Show me everything",
      "options":[
        {
          "label":"boolean check",
          "value":"1b5257a1db712010d3d6d9595e9619f3",
          "enabled":true
        },
        { 
          "label":"Test_table_datepicker",
          "value":"6515f0cadb4220108249f7541d961980",
          "enabled":true
        }, 
        { 
          "label":"Test File upload",
          "value":"76c1f4b2db7520108249f7541d9619a7",
          "enabled":true
        },
        { 
          "label":"Test B2B 2",
          "value":"8373e55cdb8120108249f7541d96196d",
          "enabled":true
        },
        {
          "label":"FAQ Conversation Builder_Global",
          "value":"9f3114a3dbc520108249f7541d961981",
          "enabled":true
        },
        {
          "label":"Get to know you",
          "value":"a443dd6adb812010d3d6d9595e961954", 
          "enabled":true
        }, 
        { 
          "label":"Get to know you_Global", 
          "value":"b1a56b87db8120108249f7541d9619b2", 
          "enabled":true 
        },
        {
          "label":"Live Agent Support.",
          "value":"ce2ee85053130010cf8cddeeff7b12bf",
          "enabled":true
        },
        {
          "label":"Apply for PTO_B2B NLU",
          "value":"d948c94cdb052010d3d6d9595e961969",
          "enabled":true 
        }
      ]
    } 
   ], 
   "score":1 
}

    Utilisez les commandes définies dans la table sys_cs_contextual_action comme énoncé pour mettre fin à une conversation

    L’exemple suivant montre comment utiliser la Bye commande définie dans la table sys_cs_contextual_action comme énoncé pour terminer une conversation Agent virtuel au lieu de la définir action sur END_CONVERSATION comme indiqué dans les exemples précédents. Cet exemple montre l’utilisation de l’une des variantes linguistiques de la Bye commande, « choa ».

    curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--header "token: ORANGE" \
--data "{
  "requestId": "302bas2be70-sadsa-we32-3eq2-1231ra9",
  "botToBot": true,
  "clientSessionId": "",
  "silentMessage": false,
  "message":{
    "text": "choa",
    "typed": true
  },
  "userId": "fred.ludy",
  "emailId": "abel.tuter@servicenow.com",
  "timestamp": 1588824102,
  "timezone": "America/New_York"
}"

    Voici le corps de la réponse envoyé par l’Agent virtuel au point de terminaison de réponse configuré.

    {
  "requestId":"302bas2be70-sadsa-we32-3eq2-1231ra9",
  "clientSessionId":"",
  "message":{ 
    "text":"chao",
    "typed":true
  }, 
  "userId":"fred.ludy",
  "body":[ 
    {
      "uiType":"Picker",
      "group":"DefaultPicker",
      "required":true,
      "nluTextEnabled":false,
      "label":"Please make a selection.",
      "itemType":"List",
      "style":"list",
      "multiSelect":false,
      "options":[
        {
          "label":"End conversation",
          "value":"1",
          "renderStyle":"data",
          "enabled":false
        }, 
        {
          "label":"Cancel",
          "value":"0",
          "renderStyle":"data",
          "enabled":false
        } 
      ],
      "scriptedData":null 
    }
  ],
  "score":1 
}

    Modifier une conversation en cours à l’aide du paramètre d’action SWITCH

    L’exemple suivant montre comment utiliser le paramètre SWITCH action pour remplacer une conversation en cours par une rubrique qui correspond à ce qui est spécifié dans le intent.id paramètre.

    curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  "requestId": "sdfsfs-hgfhg-34fssd-zxcz-sd43",
  "enterpriseId": "ServiceNow",
  "nowBotId": "A85PWLERF",
  "clientSessionId": "",
  "nowSessionId": "",
  "action": "SWITCH",
  "intent" : {
    "id": "Saloon Vehicle"
  },
  "message":{
    "typed": true,
    "clientMessageId": "ABC-123"
  },
  "userId": "Guest",
  "timestamp": 1588824102,
  "timezone": "America/New_York"
}"
--user "username":"password"

    Voici le corps de la réponse envoyé par le VA au point de terminaison de réponse configuré montrant que le VA a basculé vers la nouvelle rubrique.

    {
   "requestId":"sdfsfs-hgfhg-34fssd-zxcz-sd43",
   "clientSessionId":"",
   "nowSessionId":"",
   "message":{
      "typed":true,
      "clientMessageId":"ABC-123"
   },
   "userId":"Guest",
   "body":[
      {
         "uiType":"InputText",
         "group":"DefaultText",
         "required":true,
         "nluTextEnabled":false,
         "label":"limo input:",
         "maskType":"NONE"
      }
   ],
   "score":1
}

    Obtenir un score de Compréhension du langage naturel confiance (NLU) pour un énoncé

    L’exemple suivant montre comment obtenir un NLU score de confiance pour un énoncé si NLU est activé dans VA.

    curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  "requestId": "sdfsfs-hgfhg-34fssd-zxcz-sd43", 
  "enterpriseId": "ServiceNow", 
  "nowBotId": "A85PWLERF", 
  "clientSessionId": "", 
  "nowSessionId": "", 
  "message":{ 
    "text": "most popular choice", 
    "typed": true, 
    "clientMessageId": "ABC-123" 
  }, 
  "userId": "Guest", 
  "timestamp": 1588824102, 
  "timezone": "America/New_York" 
}"
--user "username":"password"

    Voici le corps de la réponse envoyé par le VA au point de terminaison de réponse configuré, affichant le score de confiance NLU.

    { 
  "requestId":"sdfsfs-hgfhg-34fssd-zxcz-sd43", 
  "clientSessionId":"", 
  "nowSessionId":"", 
  "message":{ 
    "text":"most popular choice", 
    "typed":true, 
    "clientMessageId":"ABC-123" 
  }, 
  "userId":"Guest", 
  "body":[ 
    { 
      "uiType":"InputText", 
      "group":"DefaultText", 
      "required":true, 
      "nluTextEnabled":false, 
      "label":"model input:", 
      "maskType":"NONE" 
    }
  ], 
  "score":"0.92" 
}

    Transférer une conversation à un agent actif dans une file d’attente spécifique

    L’exemple suivant montre comment transférer une conversation à un agent actif dans une file d’attente spécifique. Vous devez d’abord configurer vos files d’attente avec des conditions spécifiques. Vous transmettez ensuite ces conditions comme contextVariables dans le corps de la demande. Cet exemple utilise le paramètre d’action AGENT . Pour plus d’informations sur la création d’une file d’attente d’éléments de travail, consultez Créer une file d’attente d’éléments de travail.

    curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  "requestId": "34re-dasd-qwe23-dsds", // Unique value for a message (hash)
  "enterpriseId": "ServiceNow", // ServiceNow (Optional
  "nowBotId": "A85PWLERF", // In case of multiple ServiceNow secondary bots (one for HR, one for ITSM)
  "action":"AGENT", // Actions to close conversation. Other possible value is END_CONVERSATION
  "clientSessionId": "", // Client conversation id
  "nowSessionId": "", // ServiceNow conversation id
  "message":{
    "text": "How are you?", // User passed message
    "typed": true, // typed or clicked
    "clientMessageId": "ABC-123"
  },
  "userId": "abraham.lincoln", // User’s id in their system
  "emailId": "abraham.lincoln@example.com",
  "timestamp": 1588824102,
  "timezone": "America/New_York",
  "contextVariables":{
    "b2b_category":"humanresource"
  } 
}"
--user "username":"password"

    Voici le corps de la réponse envoyé par l’Agent virtuel au point de terminaison de réponse configuré.

    {
  "requestId":"34re-dasd-qwe23-dsds",
  "clientSessionId":"",
  "nowSessionId":"",
  "message":{
    "text":"How are you?",
    "typed":true,
    "clientMessageId":"ABC-123"
   },
   "userId":"abraham.lincoln",
   "body":[
     {
       "uiType":"OutputText",
       "group":"DefaultText",
       "value":"I am sorry but I didn't understand your request.",
       "maskType":"NONE"
    },
    {
      "uiType":"OutputText",
      "group":"DefaultText",
      "value":"Please try giving me your request in a different way. I'm currently better at understanding short sentences.",
      "maskType":"NONE"
    },
    {
      "uiType":"TopicPickerControl",
      "group":"DefaultPicker",
      "nluTextEnabled":false,
      "promptMsg":"Hi guest, please enter your request or make a selection of what I can help with. You can type help any time when you need help.",
      "label":"Show me everything",
      "options":[
        {
          "label":"Live Agent Support.",
          "value":"ce2ee85053130010cf8cddeeff7b12bf",
          "enabled":true
        }
      ]
    }
  ],
  "score":0
}

    Transférer une application publique/un fichier de pièce jointe PDF

    Cet exemple montre comment transférer une application publique/une pièce jointe PDF.

    curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--header "token: BOT_Token" \
--data "{
  "requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
  "clientSessionId": "U94CSJLEN",
  "message": {
    "attachment": {
    "clientAttachmentId": "my-unique-identifier",
    "contentType": "application/pdf",
    "fileName": "MY PDF TEST",
    "url": "http://www.africau.edu/images/default/sample.pdf"
    }
  },
  "userId": "U94CSJLEN",
  "emailId": "admin@example.com"
}"
--user "username":"password"

    Voici le corps de la réponse envoyé par l’Agent virtuel au point de terminaison de réponse configuré.

    {
  "requestId":"f42f3550-5b44-4cde-aa52-9b6756b3131c",
  "clientSessionId":"U94CSJLEN",
  "message":{
    "attachment":{
      "clientAttachmentId":"my-unique-identifier",
      "contentType":"application/pdf",
      "fileName":"MY PDF TEST",
      "url":"http://www.africau.edu/images/default/sample.pdf"}
    },
    "userId":"U94CSJLEN",
    "body":[
      {
        "uiType":"OutputText",
        "group":"DefaultText",
        "required":false,
        "nluTextEnabled":false,
        "label":"File got",
        "maskType":"NONE",
        "itemType":"outputtext"
      },
      {
        "uiType":"OutputText",
        "group":"DefaultText",
        "required":false,
        "nluTextEnabled":false,
        "label":"The conversation has ended. If you need help again, type hi.",
        "maskType":"NONE",
        "itemType":"outputtext"
       }
    ],
  "completed":true,
  "score":1
}

    Transférer une pièce jointe vidéo/mpeg

    Cet exemple montre la demande/réponse pour le chargement d’une pièce jointe vidéo/mpeg.

    curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--header "token: BOT_TOKEN" \
--data "{
  "requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
  "clientSessionId": "U94CSJLEN",
  "message": {
    "attachment": {
    "clientAttachmentId": "my-unique-identifier10",
    "contentType": "video/mpeg",
    "fileName": "MY TEST10.mp4",
    "url": "https://sample-videos.com/video123/mp4/720/big_buck_bunny_720p_1mb.mp4"
    }
  },
  "userId": "U94CSJLEN",
  "emailId": "admin@example.com"
}"
--user "username":"password"

    Voici le corps de la réponse envoyé par l’Agent virtuel au point de terminaison de réponse configuré.

    {
  "requestId":"f42f3550-5b44-4cde-aa52-9b6756b3131c",
  "clientSessionId":"U94CSJLEN",
  "message":{
    "attachment":{
      "headers":{
        "Authorization":"Basic amFzbWluZS53YWRod2FuaWE6VGVzdGluZ0AxMjM="
      },
      "clientAttachmentId":"my-unique-identifier10",
      "contentType":"video/mpeg",
      "fileName":"MY TEST10.mp4",
      "url":"https://sample-videos.com/video123/mp4/720/big_buck_bunny_720p_1mb.mp4"
    }
  },
  "userId":"U94CSJLEN",
  "body":[
    {
      "uiType":"OutputText",
      "group":"DefaultText",
      "required":false,
      "nluTextEnabled":false,
      "label":"File got",
      "maskType":"NONE",
      "itemType":"outputtext"
    },
    {
      "uiType":"OutputText",
      "group":"DefaultText",
      "required":false,
      "nluTextEnabled":false,
      "label":"The conversation has ended. If you need help again, type hi.",
      "maskType":"NONE","itemType":"outputtext"
    }
  ],
  "completed":true,
  "score":1
}

    Transférer une pièce jointe image/jpeg

    Cet exemple montre la demande/réponse pour le chargement d’une pièce jointe image/jpeg.

    curl "https://instance.servicenow.com/api/sn_va_as_service/bot/integration" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--header "token: BOT_TOKEN" \
--data "{
  "requestId": "f42f3550-5b44-4cde-aa52-9b6756b3131c",
  "clientSessionId": "U94CSJLEN",
  "message": {
    "attachment": {
      "clientAttachmentId": "my-unique-identifier10",
      "contentType": "image/jpeg",
      "fileName": "MY TEST10.jpg",
      "url": "https://image.imagestock.com/image-photo/pink-butterfly-isolated-on-white-260nw-1218104047.jpg"
    }
  },
  "userId": "U94CSJLEN",
  "emailId": "admin@example.com"
}"
--user "username":"password"

    Voici le corps de la réponse envoyé par l’Agent virtuel au point de terminaison de réponse configuré.

    {
  "requestId":"f42f3550-5b44-4cde-aa52-9b6756b3131c",
  "clientSessionId":"U94CSJLEN",
  "message":{
    "attachment":{
      "headers":{
        "Authorization":"Basic amFzbWluZS53YWRod2FuaWE6VGVzdGluZ0AxMjM="
      },
      "clientAttachmentId":"my-unique-identifier10",
      "contentType":"image/jpeg",
      "fileName":"MY TEST10.jpg",
      "url":"https://image.imagestock.com/image-photo/pink-butterfly-isolated-on-white-260nw-1218104047.jpg"
    }
  },
  "userId":"U94CSJLEN",
  "body":[
    {
      "uiType":"OutputText",
      "group":"DefaultText",
      "required":false,
      "nluTextEnabled":false,
      "label":"File got",
      "maskType":"NONE",
      "itemType":"outputtext"
    },
    {
      "uiType":"OutputText",
      "group":"DefaultText",
      "required":false,
      "nluTextEnabled":false,
      "label":"The conversation has ended. If you need help again, type hi.",
      "maskType":"NONE",
      "itemType":"outputtext"
    }
  ],
  "completed":true,
  "score":1
}