Fournisseur et scripts entrants/sortants

Un fournisseur, tel que Twilio, fournit l’aptitude de messagerie instantanée. Les scripts d’action utilisateur effectuent des actions de fournisseur ainsi que la configuration d’intégration conversationnelle de la messagerie instantanée personnalisée pour les actions de transformateur entrantes et sortantes de votre chatbot ou de vos conversations personnalisées. Des exemples de chaque script sont fournis. Elles comprennent une description de l’action de chaque script, ainsi que l’entrée et la sortie d’action. Vous verrez également des exemples de script JSON.

Vous utilisez ces Studio de workflow scripts pour transformer les messages serveur et client. Les scripts du fournisseur, de l’expéditeur et du transformateur entrant/sortant sont requis. Vous pouvez utiliser les scripts supplémentaires pour ajouter plus de fonctionnalités à votre messagerie instantanée.

Script d’action attributs du fournisseur

Exemple : script d’action attributs du fournisseur.

(function execute(inputs, outputs) {
    var headers = (inputs.headers);
    var payload = (inputs.payload);

    // check if an authentication token was included. this is optional.
    var smsUtil = new VASMSTwilioUtil();
    outputs.token = JSON.stringify(smsUtil.getToken(headers, payload));

    var data = payload.data;
    var request_context = {}; 
    // inspect the actual message. it could be an MMS (attachment) or raw text
    if (data['MediaUrl0']) {
        var attachment_value = {};
        attachment_value.url = data['MediaUrl0'];
        attachment_value.content_type = data['MediaContentType0'];
        attachment_value.name = smsUtil.getFileName(attachment_value.url , attachment_value.content_type);
        request_context.attachment_value = attachment_value;
    } else {
       request_context.typed_value = data['Body'];
    }

    // set the mandatory outputs
    outputs.request_context = request_context;
    outputs.provider_user_id = data.From;
})(inputs, outputs);

Script d’action de l’expéditeur (mis hors service au Québec, voir le flux secondaire de l’expéditeur)

Le script d’action de l’expéditeur sait comment envoyer un message au fournisseur. Le script doit invoquer de façon asynchrone un flux secondaire OU Studio de workflowCentre d'intégration . Le Agent virtuel est libéré pour continuer à traiter les messages plutôt que d’essayer d’envoyer des demandes externes.

Exemple : script d’action de l’expéditeur.

(function execute(inputs, outputs) {
    var results = inputs.results;
    // transform the inputs to something this custom subflow knows about
    var sendInputs = {
        app_inbound_id : inputs["app_inbound_id"],
        channel_user_id: inputs["channel_user_id"],
        messages: JSON.stringify(results)
    };

    // invoke an asynchronous subflow which will send the external request. so this sender script will immediately return,
    // freeing up the chat server thread to do further message processing while putting the external request work on the
    // Workflow Studio/Integration Hub
    sn_fd.FlowAPI.startSubflowQuick('sn_va_sms_twilio.va_sms_twilio_adapter_send_sms', sendInputs);
})(inputs, outputs);

Flux secondaire de l'expéditeur

Au lieu d’être un script, le flux secondaire de l’expéditeur gère le processus d’envoi d’un message à un fournisseur. Le message est contenu dans une payload chaîne dans le cadre du flux secondaire. L’expéditeur a un service_url et origin_service_url, tandis que l’URL sortante varie selon le fournisseur. Par exemple, un message envoyé via MS Teams utilise la valeur tenant_id. Lorsque l’Agent virtuel envoie le message contenant des options, le destinataire sélectionne une option. Le flux secondaire met à jour l’affichage du message en fonction de son choix et supprime les options. La conversation se poursuit en fonction de l’option sélectionnée par l’utilisateur. Le Agent virtuel est libéré pour continuer à traiter les messages plutôt que d’essayer d’envoyer des demandes externes. Lors de la création d’un flux secondaire, n’avez pas d’action pour appeler une action dans le flux secondaire. Pour en savoir plus sur les flux secondaires, reportez-vous à la section .

Script d’action contextuelle

Le script d’action contextuelle effectue des actions de mot clé spéciales, telles que saisir un agent à l’intérieur d’une Agent virtuel rubrique, pour les transmettre immédiatement à un agent actif.

Exemple : script d’action contextuelle.

(function execute(inputs, outputs) {
  var contextual_action = inputs.request_context.contextual_action;
  if (contextual_action === "END_CONVERSATION") {
    sn_cs.VASystemObject.endConversation(inputs.conversation_id);
  } else if (contextual_action === "AGENT") {
    sn_cs.VASystemObject.switchToLiveAgent(inputs.conversation_id);
  } else if (contextual_action === "START_CONVERSATION") {
    sn_cs.VASystemObject.startConversation(inputs.conversation_id);
  }
})(inputs, outputs);

Script d’action du compte de lien

Le script d’action du compte de liaison contient des identificateurs pour l’utilisateur qui effectue la liaison. Le script contient également le compte auquel il est lié.

Exemple : script d’action du compte de liaison.

(function execute(inputs, outputs) {
  
  var richControl = (inputs.rich_control);
  var value = richControl.value;
  outputs.result = richControl.header + ': ' + value.action;
  
})(inputs, outputs);

Script d’action du processeur de réponses

Le script d’action du processeur de réponses effectue des actions spécialisées qui sont basées sur la réponse à une demande d’envoi de message. Le framework effectue déjà le suivi de base de l’état des messages.

Exemple : script d’action de processeur de réponses.

(function execute(inputs, outputs) {
    gs.debug("Response from provider: message_id = " + inputs.message_id + ", status_code = " +
      inputs.status_code + ", headers = " + JSON.stringify(inputs.headers) + ", body = " + inputs.body);
})(inputs, outputs);

Scripts de transformateur sortants

Les scripts de transformateur sortants convertissent les messages sortants Agent virtuel en protocole lié à l’intégration conversationnelle de la messagerie instantanée personnalisée.

Entrée.

Sortie.

résultat (chaîne) : message du composant approprié au fournisseur à envoyer.

(function execute(inputs, outputs) {
  var rich_control = inputs.rich_control;
  outputs.result = rich_control['label'];
})(inputs, outputs);

(function execute(inputs, outputs) {
  var richControl = (inputs.rich_control);
  var value = richControl.value;
  outputs.result = richControl.header + ': ' + value.action;
})(inputs, outputs);

(function execute(inputs, outputs) {
  var rich_control = inputs.rich_control;
  var options = rich_control['options'];
  if (options && options.length > 0) {
      var optionsLength = options.length;
      var picker = rich_control['label'] || "";
      for (var x = 0; x < optionsLength; x++) {
          picker += "\n" + (x+1) +  ": " + options[x].label;
      }
  }
  outputs.text_message = picker;
})(inputs, outputs);

(function execute(inputs, outputs) {
  var rich_control = inputs.rich_control;
  var linkResult = rich_control['header'];
  var totalValues = rich_control['values'].length;
  for (var i = 0; i < totalValues; i++) {
    linkResult = linkResult + '\n';
    var linkValue = rich_control['values'][i];
    linkResult = linkResult + '\n' + linkValue['description'] + ': ' + linkValue['action'];
  }
  outputs.result  = linkResult;
})(inputs, outputs);

(function execute(inputs, outputs) {
  var richControl = (inputs.rich_control);
  var data = JSON.parse(richControl.data);    
  var tableTitle = data.title;
  var fields = data.fields;
  var subtitle = data.subtitle;
  var url = data.url;    
  var message = subtitle ? getCardLine(tableTitle, subtitle) : tableTitle + "\n";
  for (var i= 0; i<fields.length; i++) {
     message += getCardLine(fields[i].fieldLabel, fields[i].fieldValue);
  }
  message += url;
  outputs.result = message;

  function getCardLine(key, value) {
      if (value == '' || value == null || key == '' || key == null)
          return;
      return key + ": " + value + "\n";
  }
})(inputs, outputs);

Scripts de transformateur entrant

Les scripts de transformateur entrants convertissent les messages entrants d’intégration conversationnelle personnalisée en un protocole que l’reconnaît Agent virtuel . Il détermine la valeur requise à injecter dans le contrôle enrichi présenté à l’utilisateur.

Entrée.

Sortie.

(function execute(inputs, outputs) {
  var requestContext = inputs.request_context;
  var richControl = inputs.rich_control;
  var typedValue = requestContext['typed_value'];
  var attachmentValue = requestContext['attachment_value'];
  var smsUtil = new VASMSTwilioUtil();
  var result = {};
  if(richControl['itemType'] == 'image' || richControl['itemType'] == 'file')	{
    if (attachmentValue && attachmentValue.content_type.includes('image')) {
      result.url = attachmentValue.url;
      result.content_type = attachmentValue.content_type;
      result.name = attachmentValue.name;
      result.headers = attachmentValue.headers;
    } else if (typedValue) {
      result.url = typedValue;
      var contentType = smsUtil.getContentType(typedValue);
      if (typeof contentType === 'undefined')
        gs.error('Please enter a valid image link. Inbound image link: {0}', typedValue);
      else
        result.content_type = contentType;
    } else {
      gs.error('Please upload an image or enter a valid image link.');
    }
  }
  result['value'] = typedValue;
  result['search_text'] = '';
  outputs.result = result;
})(inputs, outputs);

(function execute(inputs, outputs) {
  var request_context = inputs.request_context;
  var rich_control = inputs.rich_control;
  var selectedValue = request_context["typed_value"];
  var result = {};
  result["value"] = "";
  result["search_text"] = "";
  if (rich_control['options']) {
    var options = rich_control['options'];
    var optionsLength = options.length;
    selectedValue === Number(selectedValue)
    if (selectedValue > 0 && selectedValue <= optionsLength) {
        var selectedOption = options[selectedValue - 1];
        result["value"] = selectedOption.value;
    } else {
        result["search_text"] = request_context["typed_value"];
    }
  }
  outputs.result = result;
})(inputs, outputs);