Contrôles dans API Agent virtuel

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

    • API Agent virtuel vous fournit divers contrôles pour gérer les réponses dans votre conversation.

    Les contrôles disponibles dans API Agent virtuel sont les suivants :

    Texte de sortie

    {
  "uiType": "OutputText",
  "group": "DefaultText",
  "value": "**bold**\n*italic*\n***bold italic***\n[Google](https://empcygiraffe6.service-now.com/va_link.do?token=77ee77ef77eSZGFlMTc3OWU5NzY2MTExMDUyNjFiMzQ3MTE1M2FmYjTvt6zvt5Qx77es77etWE1nS0ZLOElhU1FQYzhIajh2dmNmZz09WHdPTDYzV3ZpUWF1MGJwRlB0ZktUY29wVWt1UGVueUNIS1FkRHRyUW9idHlmVFZlRWJOODZyRjZYN0VQamxnWUV5WkhZSDRJaWFGWmJRZU1CaXZLYWhudnkwbDdvNFZsMlMzUUw4Q3VRTUJWMHhvTWlRLXZOQnh5M0hveVBuellNVmJCbGlka0RqNTAzVFVUQml0MTZzSnlUTVJoakdZektldXdoYXlM77eu77ev&target_url=https%3A%2F%2Fwww.google.co.in)\n\n- ***ul1***\n- ***ul2***\n\n\n1. ol1\n2. ol2\n\n",
  "maskType": "NONE | SECURE"
}
    Champ Description
    valide Contient la valeur du texte de sortie.
    maskType « NONE » indique un texte normal et « SECURE » indique un texte de sortie sécurisé.

    HTML de sortie

    {
  "uiType": "OutputHtml",
  "group": "DefaultOutputHtml",
  "style": "inline",
  "height": 0,
  "width": 0,
  "value": "<html>     <body>     <table>   <tr>     <th>Company</th>     <th>Contact</th>     <th>Country</th>   </tr>   <tr>     <td><a href=\"https://www.google.co.in\">Alfreds Futterkiste</a></td>     <td>Maria Anders</td>     <td>Germany</td>   </tr>   <tr>     <td>Centro comercial Moctezuma</td>     <td>Francisco Chang</td>     <td>Mexico</td>   </tr>   <tr>     <td><a href=\"https://www.google.co.in\">Ernest Handel</a></td>     <td>Roland Mendel</td>     <td>Austria</td>   </tr>   <tr>     <td>Island Trading</td>     <td>Helen Bennett</td>     <td>UK</td>   </tr>   <tr>     <td>Laughing Bacchus Winecellars</td>     <td>Yoshi Tannamuri</td>     <td><a href=\"https://www.google.co.in\">Canada</a></td>   </tr>   <tr>     <td>Magazzini Alimentari Riuniti</td>     <td>Giovanni Rovelli</td>     <td>Italy</td>   </tr> </table>     </body> </html> ",
  "imageUrl": "https://empcygiraffe6.service-now.com//api/now/v1/cs/media/zKFqUx0NJyVaFRJqzeRhFgeMsMo9211mCvrMgKzrRpTWqFJDrXLOadoYGC5CQnwr",
  "imageHeight": 217,
  "imageWidth": 501,
  "links": [
    {
      "link": "https://www.google.co.in",
      "label": "Alfreds Futterkiste"
    },
    {
       "link": "https://www.google.co.in",
       "label": "Ernest Handel"
    },
    {
       "link": "https://www.google.co.in",
       "label": "Canada"
    }
  ]
}
    Champ Description
    valide Contient la valeur html.
    imageUrl Contient l’image HTML si l’option « Conversion HTML en image requise » est activée sur sys_cs_provider.
    Hauteur de l’image Contient la hauteur de l’image si l’option « Conversion HTML en image requise » est activée sur sys_cs_provider.
    largeur d’image Contient la largeur de l’image si l’option « Conversion HTML en image requise » est activée sur sys_cs_provider.
    liens Contient des liens dans le code HTML donné si l’option « Conversion HTML en image requise » est activée sur sys_cs_provider.

    Image de sortie

    {
  "uiType": "OutputImage",
  "group": "DefaultOutputImage",
  "value": "https://adaptivecards.io/content/cats/1.png",
  "altText": "Image alt text"
 }
    Champ Description
    valide Contient l’URL de l’image.
    Texte alternatif Contient le texte alternatif de l’image (non obligatoire).

    Lien de sortie

    {
  "uiType": "OutputLink",
  "group": "DefaultOutputLink",
  "label": "ServiceNow",
  "header": "The world works with ServiceNow",
  "type": "link",
  "value": {
    "action": "https://empcygiraffe6.service-now.com/va_link.do?token=<token>&target_url=https%3A%2F%2Fwww.servicenow.com",
    "target": "_blank"
  }
}
    Champ Description
    header En-tête de lien
    étiquette Étiquette du lien
    valeur->action URL de lien

    Lien multiple

    {
  "uiType": "GroupedPartsOutputControl",
  "group": "DefaultGroupedPartsOutputControl",
  "groupPartType": "Link",
  "header": "Multilink Header",
  "values": [
    {
      "action": "https://empcygiraffe6.service-now.com/va_link.do?token=<token>&target_url=https%3A%2F%2Fwww.link1.com",
      "description": "a short desc",
      "label": "link 1 label",
      "context": "KB",
      "target": "_blank"
    },
    {
      "action": "https://empcygiraffe6.service-now.com/va_link.do?token=<token>&target_url=https%3A%2F%2Fwww.link2.com",
      "description": "a short desc",
      "label": "link 2 label",
      "context": "ITSM",
      "target": "_blank"
    }
  ]
}
    Champ Description
    header En-tête de contrôle MultiLink
    valeurs Tableau de liens
    Structure des liens dans le tableau de liens :
    Champ Description
    étiquette Étiquette du lien
    action URL de lien
    description Description de lien
    contexte Contexte ou taxonomie

    Carte de sortie

    {
  "uiType": "OutputCard",
  "group": "DefaultOutputCard",
  "templateName": "<card-template>",
  "data": "<card-data-json>",
}
    Champ Description
    Nom du modèle Type de carte ou nom de carte
    données JSON représentant les données de la carte.
    Remarque :
    Le champ de données sera de type chaîne. Vous devez les analyser pour utiliser les données.
    Grande image avec du texte
    {
  "uiType": "OutputCard",
  "group": "DefaultOutputCard",
  "templateName": "Large image with text",
  "data": "{\"image\":\"https://adaptivecards.io/content/cats/1.png\",\"description\":\"Large image description\", \"dataNowSmartLink\":\"W9F4Ld8z\",\"title\":\"Large image\",\"imageAlt\":\"large image alt text\",\"url\":\"\",\"target\":\"_blank\"}",
  "smartLinksMetadata": {
    "W9F4Ld8z": {
      "type": "standard",
      "source": "",
      "target": "_blank"
    }
  }
}
    Petite image avec du texte
    {
  "uiType": "OutputCard",
  "group": "DefaultOutputCard",
  "templateName": "Small image with text",
  "data": "{\"image\":\"https://adaptivecards.io/content/cats/1.png\",\"description\":\"Small image with text description\",\"dataNowSmartLink\":\"i6CL61tN\",\"title\":\"Small image with text\",\"imageAlt\":\"small image alt text\",\"url\":\"\",\"target\":\"_blank\"}",
  "smartLinksMetadata": {
     "i6CL61tN": {
       "type": "standard",
       "source": "",
       "target": "_blank"
     }
  }
}
    Youtube
    {
  "uiType": "OutputCard",
  "group": "DefaultOutputCard",
  "templateName": "Youtube Video Card",
  "data": "{\"link\":\"https://empcygiraffe6.service-now.com/va_link.do?token=<token>&target_url=servicenow.com\",\"description\":\"The world works with ServiceNow\",\"id\":\"IWsGk-Kh5ko\",\"title\":\"ServiceNow\",\"url\":\"\",\"target\":\"_blank\"}"
}
    Enregistrement
    {
  "uiType": "OutputCard",
  "group": "DefaultOutputCard",
  "templateName": "Card",
  "data": "{\"sys_id\":\"0c5f3cece1b12010f877971dea0b1449\",\"subtitle\":\"INC0008001\",\"dataNowSmartLink\":\"VLzQTN88\",\"title\":\"Incident\",\"fields\":[{\"fieldLabel\":\"Number\",\"fieldValue\":\"INC0008001\"},{\"fieldLabel\":\"Short description\",\"fieldValue\":\"ATF:TEST2\"},{\"fieldLabel\":\"Caller\",\"fieldValue\":\"survey user\"}],\"table_name\":\"incident\",\"url\":\"https://empcygiraffe6.service-now.com/va_link.do?token=<token>target_url=https%3A%2F%2Fempcygiraffe6.service-now.com%2Fsp%3Fsys_id%3D0c5f3cece1b12010f877971dea0b1449%26id%3Dticket%26table%3Dincident\",\"target\":\"_blank\"}",
  "smartLinksMetadata": {
    "VLzQTN88": {
      "type": "standard",
      "source": "https://empcygiraffe6.service-now.com/sp?sys_id=0c5f3cece1b12010f877971dea0b1449&id=ticket&table=incident",
      "target": "_blank"
    }
  }
}

    Sortie en plusieurs parties

    {
  "uiType": "MultiPartOutput",
  "group": "DefaultMultiPartOutput",
  "navigationBtnLabel": "Click for more",
  "content": {
    "uiType": "OutputText",
    "value": "multipart text output",
    "maskType": "NONE"
  }
}
    Champ Description
    navigationBtnLabel Étiquette du bouton de navigation
    contenu Représente le contrôle défini avec plusieurs parties.
    Remarque :
    • Le contenu peut être OutputText, OutputImage, OutputHTML, OutputLink ou OutputCard.
    • Vous devez envoyer « click_for_more » en réponse pour passer à la partie suivante.

    Texte d’entrée

    {
  "uiType": "InputText",
  "group": "DefaultText",
  "required": true,
  "nluTextEnabled": false,
  "entityType": "Text",
  "label": "enter something",
  "maskType": "NONE"
}
    Champ Description
    étiquette Étiquette de texte d’entrée
    obligatoire Vrai ou faux indiquant si le contrôle peut être ignoré ou non.
    maskType AUCUN ou SÉCURISÉ.
    • NONE indique une entrée normale.
    • SECURE indique une entrée sécurisée.
    entityType L’entrée est un texte, un e-mail ou une adresse IP.
    nluTextEnabled Indique si NLU est activé sur ce nœud ou non.

    Booléen

    {
  "uiType": "Boolean",
  "group": "DefaultPicker",
  "required": true,
  "nluTextEnabled": false,
  "entityType": "Boolean",
  "label": "select yes/no",
  "options": [
    {
       "label": "Yes",
       "value": "yes",
       "renderStyle": "data"
    },
    {
       "label": "No",
       "value": "no",
       "renderStyle": "data"
    }
  ]
}
    Champ Description
    étiquette Invite de contrôle booléen
    obligatoire Vrai ou faux indiquant si le contrôle peut être ignoré ou non.
    maskType AUCUN ou SÉCURISÉ.
    • NONE indique une entrée normale.
    • SECURE indique une entrée sécurisée.
    entityType Booléen
    nluTextEnabled Indique si la NLU est activée à ce nœud ou non.
    options Options booléennes
    Structure des options dans le tableau des options :
    Champ Description
    étiquette Étiquette d’option
    valide Valeur de l’option
    renderStyle Données ou bouton

    Sélecteur

    {
  "uiType": "Picker",
  "group": "DefaultPicker",
  "required": true,
  "nluTextEnabled": false,
  "label": "Select an option",
  "itemType": "List",
  "style": "list",
  "multiSelect": false,
  "options": [
    {
      "label": "option 1",
      "value": "option 1",
      "renderStyle": "data",
      "enabled": false
    },
    {
      "label": "option 2",
      "value": "option 2",
      "renderStyle": "data",
      "enabled": false
    },
    {
      "label": "option 3",
      "value": "option 3",
      "renderStyle": "data",
      "enabled": false
    }
  ],
  "scriptedData": {
    "cardData": "{\"title\":\"Choice - Large image with text\",\"description\":\"Choice - Large image with text description\",\"image\":\"https://adaptivecards.io/content/cats/1.png\",\"imageAlt\":\"alt text\"}",
    "cardName": "Large image with text",
    "cardTemplate": "",
    "renderStyle": "card"
  }
}
    Champ Description
    étiquette Invite de contrôle du sélecteur
    Le style Liste ou carrousel. Le carrousel indique le contrôle du carrousel.
    obligatoire Vrai ou faux indiquant si le contrôle peut être ignoré ou non.
    maskType AUCUN ou SÉCURISÉ.
    • NONE indique une entrée normale.
    • SECURE indique une entrée sécurisée.
    entityType Booléen
    nluTextEnabled Indique si la NLU est activée à ce nœud ou non.
    options Options booléennes
    données scriptées Représente une carte à afficher avec le sélecteur.
    Structure des options dans le tableau des options :
    Champ Description
    étiquette Étiquette d’option
    valide Valeur de l’option
    renderStyle données ou bouton
    Structure scriptedData :
    Champ Description
    cardName Nom du modèle
    cardData Données de la carte sous forme de chaîne JSON.

    Carrousel

    {
  "uiType": "Picker",
  "group": "DefaultPicker",
  "required": true,
  "nluTextEnabled": false,
  "label": "select an image",
  "itemType": "Picture",
  "style": "carousel",
  "multiSelect": false,
  "options": [
    {
       "label": "name1",
       "description": "a description of value_1 item",
       "attachment": "https://adaptivecards.io/content/cats/1.png",
       "value": "value_1",
       "renderStyle": "data",
       "enabled": false
    },
    {
       "label": "name2",
       "description": "a description of value_2 item",
       "attachment": "https://adaptivecards.io/content/cats/1.png",
       "value": "value_2",
       "renderStyle": "data",
       "enabled": false
    },
    {
       "label": "name3",
       "description": "a description of value_3 item",
       "attachment": "https://adaptivecards.io/content/cats/1.png",
       "value": "value_3",
       "renderStyle": "data",
       "enabled": false
    }
  ],
  "scriptedData": null
}
    Champ Description
    étiquette Invite de contrôle du sélecteur
    Le style Liste ou carrousel. Le carrousel indique le contrôle du carrousel.
    obligatoire Vrai ou faux indiquant si le contrôle peut être ignoré ou non.
    maskType AUCUN ou SÉCURISÉ.
    • NONE indique une entrée normale.
    • SECURE indique une entrée sécurisée.
    entityType Booléen
    nluTextEnabled Indique si la NLU est activée à ce nœud ou non.
    options Options booléennes
    Structure des options dans le tableau des options :
    Champ Description
    étiquette Étiquette d’option
    valide Valeur de l’option
    description Description de l’option
    attachment Image ou image pour l’option

    Date

    {
  "uiType": "Date",
  "group": "DefaultDate",
  "required": true,
  "nluTextEnabled": false,
  "entityType": "Date",
  "label": "test date"
}
    Champ Description
    étiquette Invite de contrôle de la date
    obligatoire Vrai ou faux indiquant si le contrôle peut être ignoré ou non.
    entityType Date
    nluTextEnabled Indique si la NLU est activée à ce nœud ou non.

    Heure

    {
  "uiType": "Time",
  "group": "DefaultDate",
  "required": true,
  "nluTextEnabled": false,
  "entityType": "Time",
  "label": "Select time"
}
    Champ Description
    étiquette Invite de contrôle de l’heure
    obligatoire Vrai ou faux indiquant si le contrôle peut être ignoré ou non.
    entityType Heure
    nluTextEnabled Indique si la NLU est activée à ce nœud ou non.

    Date/Heure

    {
  "uiType": "DateTime",
  "group": "DefaultDate",
  "required": true,
  "nluTextEnabled": false,
  "entityType": "Time",
  "label": "Select time"
}
    Champ Description
    étiquette Invite de contrôle de la date et de l’heure
    obligatoire Vrai ou faux indiquant si le contrôle peut être ignoré ou non.
    entityType Heure
    nluTextEnabled Indique si la NLU est activée à ce nœud ou non.

    Démarrer la conversation

    {
  "uiType": "ActionMsg",
  "actionType": "StartConversation",
  "conversationId": "e0494b2187332550326d0d05dabb350d"
}
    Champ Description
    uiType Message d’action
    actionType Démarrer la conversation

    Indique que la conversation a commencé dans API Agent virtuel.