NotifyOnTaskClient : client

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 17 minutes de lecture
  • L’API NotifyOnTaskClient fournit des méthodes d’envoi de messages SMS ou de démarrage/gestion d’une téléconférence pour divers fournisseurs de services de téléphonie, tels que Zoom et Webex.

    Toute interface utilisateur peut utiliser l’API NotifyOnTaskClient en incluant explicitement le script d’interface utilisateur NotifyOnTaskClient.

    À l’aide de l’API NotifyOnTaskClient, vous pouvez :

    • Commencer une téléconférence
    • Terminer une téléconférence
    • Ajouter des participants
    • Effectuez des actions disponibles via le pilote de téléphonie, telles que :
      • Activer ou désactiver le micro des participants
      • Supprimer des participants d’une téléconférence
      • Ajouter des participants à une téléconférence
      • Commencer une téléconférence
      • Terminer une téléconférence

    Le module d’extension Notification (com.snc.notify) nécessite un abonnement distinct. Pour plus d’informations sur l’activation du module d’extension Notify, consultez Activer Notify.

    NotifyOnTaskClient : addParticipants(données de l’objet)

    Ajoute les participants spécifiés à une téléconférence spécifiée.

    Tableau 1. Paramètres
    Nom Type Description
    données Objet Objet qui décrit la téléconférence.
    data.addToWorkNotes Booléen Marqueur indiquant s’il faut ajouter des informations sur les participants qui ont été inclus dans la téléconférence dans le champ Notes de travail de l’enregistrement associé.

    Pour que cette fonctionnalité fonctionne, vous devez également spécifier des valeurs dans les data.table paramètres and data.sysId . Ces paramètres identifient l’enregistrement dans lequel ajouter les notes de travail.

    Valeur par défaut : false

    données.confId Chaîne Requis. ID système de la téléconférence. L’ID système de la conférence se trouve dans la table Téléconférence de Notification [notify_conference_call].
    données.éléments Tableau Requis. Informations que chaque participant doit inclure dans la téléconférence.

    Valeurs de tableau valides :

    • id: ID système de l’utilisateur ; dans la table Utilisateur [sys_User].
    • notifyParticipantId: ID système du participant ; situé dans la table Notifier le participant [notify_participant].
    • phoneNumber: numéro de téléphone du participant. Si cette valeur est transmise en conjonction avec le ou notifyParticipantId, id cette valeur remplace les numéros de téléphone dans l’enregistrement utilisateur/participant et est utilisée pour passer l’appel.
    • email: adresse e-mail du participant.
    data.message Chaîne Message lu à haute voix lorsqu’un utilisateur répond à l’appel, par exemple « Un incident P1 a été créé, veuillez vous connecter à l’instance ».
    données.serviceProvider Chaîne Requis. Nom du fournisseur de services de conférence, tel que Zoom ou Webex.
    données.sysId Chaîne ID système de l’enregistrement source à associer à la téléconférence.

    Par exemple, si une téléconférence est organisée pour discuter d’un incident ou d’un problème spécifique, définissez l’ID système de l’enregistrement d’incident ou de problème dans cette valeur. Cet ID système est stocké dans la colonne Source de la table Notification Téléconférence [notify_conference_call] et peut être suivi ultérieurement.

    Ce paramètre est utilisé en conjonction avec les data.Tableparamètres , data.addToWorkNotes, et allowMulticonference

    Vous devez configurer cette valeur lorsque la téléconférence est initialement créée via une action « démarrer ». Si nécessaire, vous pouvez également définir cette valeur via cette méthode.

    données.table Chaîne Table contenant l’enregistrement source à associer à la téléconférence. Un enregistrement source peut être n’importe quel enregistrement, tel qu’un « incident » ou un « problème », qui est le sujet de discussion de la téléconférence.

    Ce nom de table est stocké dans la colonne Table de la table Téléconférence de notification [notify_conference_call] et peut faire l’objet d’un suivi.

    Ce paramètre est utilisé en conjonction avec les data.sysIdparamètres , data.addToWorkNotes, et allowMulticonference

    Vous devez configurer cette valeur lorsque la téléconférence est initialement créée via une action « démarrer ». Si nécessaire, vous pouvez également définir cette valeur via cette méthode.

    Tableau 2. Renvoie
    Type Description
    Objet Résultats de l’action de la conférence.

    <action>.status : état de l’action de la conférence.

    • Type de données : booléennes
    • Valeurs valides :
      • true : action de la conférence réussie
      • false : échec de l’action de la conférence

    <action>.successMessages : si l’état est vrai, message(s) de réussite, sinon, vide(s).

    • Type de données : tableau de chaînes

    <action>.warnMessages : si l’état est faux, tous les messages d’avertissement sont levés pendant le traitement.

    • Type de données : tableau de chaînes

    <action>.errorMessages : si l’état est faux, tous les messages d’erreur sont levés pendant le traitement.

    • Type de données : tableau de chaînes
    function addToConferenceCall() {
        var data = NotifyOnTaskClient.getNotifyActionTemplate();
        data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'
        data.confId = 'Active conference sysId';
        data.items.push({ id: 'userSysId' });
        data.items.push({ phoneNumber: '+917799555331' });
        data.items.push({ email: 'yln99518@gmail.com' });
    
        NotifyOnTaskClient.addParticipants(data).then(function (result) {
            var joinActionResult = result[0];
            if(joinActionResult.status) {
                joinActionResult.successMessages.forEach(function(msg) {
                    console.log(msg);
                });
                return;
            }
    
            joinActionResult.warnMessages.forEach(function(msg) {
                console.warn(msg);
            });
            joinActionResult.errorMessages.forEach(function(msg) {
                console.error(msg);
            });
        }, function (errMsg) {
            console.log(errMsg);
        });
    }

    NotifyOnTaskClient : doConferenceAction(action de chaîne, données d’objet)

    Effectue l’action spécifiée de téléconférence, telle que démarrer/mettre fin à une téléconférence ou rejoindre, supprimer, désactiver ou rétablir le son de participants à une téléconférence.

    Vous pouvez démarrer une nouvelle téléconférence et ajouter des participants en un seul appel à cette méthode, ou appeler la méthode plusieurs fois pour démarrer l’appel, puis gérer les participants séparément. En outre, via l’objet de données transmis, vous pouvez configurer la méthode pour :
    • Enregistrez les pointeurs de l’enregistrement de la téléconférence vers l’enregistrement spécifique (enregistrement source), tel qu’un incident ou un problème, qui est le sujet de discussion de la téléconférence.
    • Autoriser/interdire plusieurs téléconférences pour un enregistrement source.
    • Enregistrez automatiquement les participants qui ont participé à la téléconférence dans le champ Notes de travail de l’enregistrement source.
    • Faites lire un message à haute voix lorsqu’un participant répond à un appel sortant de la conférence.
    Tableau 3. Paramètres
    Nom Type Description
    action Chaîne Définit l’action de téléconférence à effectuer.
    Les actions de téléconférence disponibles sont les suivantes :
    • start : démarre la téléconférence identifiée dans data.confId
    • fin : met fin à la téléconférence identifiée dans data.confId
    • rejoindre : ajoute le participant spécifié dans le data.items tableau à la téléconférence identifiée dans data.confId
    • multiJoin : ajoute les participants spécifiés dans le data.items tableau à la téléconférence identifiée dans data.confId
    • selfJoin : ajoute l’utilisateur actuellement connecté à la téléconférence (aucune entrée requise data.items .)
    • kick : supprime le participant spécifié dans le data.items tableau de la téléconférence identifiée dans data.confId
    • multiKick : supprime les participants spécifiés dans le data.items tableau de la téléconférence identifiée dans data.confId
    • muet : désactive le son du participant spécifié dans le tableau lors de data.items la téléconférence identifiée dans data.confId
    • multiMute : Désactive le son des participants spécifiés dans le data.items tableau lors de la téléconférence identifiée dans data.confId
    • activer le micro : active le micro du participant spécifié dans le data.items tableau à partir de la téléconférence identifiée dans data.confId
    • multiUnmute : active le micro des participants spécifiés dans le data.items tableau à partir de la téléconférence identifiée dans data.confId
    données Objet Objet qui décrit la téléconférence.
    data.addToWorkNotes Booléen Marqueur indiquant s’il faut ajouter des informations sur les participants qui ont été inclus dans la téléconférence dans le champ Notes de travail de l’enregistrement associé.

    Pour que cette fonctionnalité fonctionne, vous devez également spécifier des valeurs dans les data.table paramètres and data.sysId . Ces paramètres identifient l’enregistrement dans lequel ajouter les notes de travail.

    Valeur par défaut : false

    Actions pour lesquelles ce paramètre est valide :

    • début
    • rejoindre
    • Jointure multiple
    • selfJoin (Joindre soi-même)
    data.allowMulticonference Booléen Marqueur indiquant s’il faut autoriser plusieurs téléconférences pour un enregistrement spécifique à la fois.

    Pour que cette fonctionnalité fonctionne, vous devez également spécifier des valeurs dans les data.table paramètres and data.sysId . Ces paramètres identifient l’enregistrement qui est autorisé à avoir plusieurs téléconférences.

    Valeur par défaut : false

    Actions pour lesquelles ce paramètre est valide :

    • début
    données.confId Chaîne ID système de la téléconférence.

    L’ID système de la conférence se trouve dans la table Téléconférence de Notification [notify_conference_call].

    Actions pour lesquelles ce paramètre est obligatoire :

    • fin
    • rejoindre
    • Jointure multiple
    • selfJoin (Joindre soi-même)
    Remarque :
    Les actions des participants telles que désactiver le micro, réactiver le micro et expulser ne nécessitent pas la définition de ce paramètre, car la méthode obtient ces informations à partir de la table Participant à la téléconférence de Notification [notify_participant].
    data.fromNumber Chaîne Numéro du fournisseur de service à appeler pour la téléconférence.

    Localisez cette valeur dans la colonne Numéro ou numéro de téléphone de la table Numéro de téléphone de Notification [notify_number].

    Actions pour lesquelles ce paramètre est obligatoire :

    • début
    data.isNewConference Booléen Marqueur indiquant s’il s’agit d’une nouvelle téléconférence ou d’une téléconférence existante.

    Valeurs valides :

    • true : Nouvelle téléconférence
    • false : téléconférence existante

    Valeur par défaut : false

    Actions pour lesquelles ce paramètre est valide :

    • début
    data.message Chaîne Message lu à haute voix lorsqu’un utilisateur répond à l’appel, par exemple « Un incident P1 a été créé, veuillez vous connecter à l’instance ».

    Actions pour lesquelles ce paramètre est valide :

    • début
    • rejoindre
    • Jointure multiple
    données.éléments Tableau Informations que chaque participant doit inclure dans la téléconférence.

    Valeurs de tableau valides :

    • id : ID système de l’utilisateur ; dans la table Utilisateur [sys_User].

      Actions valides : joindre, multijoindre, démarrer

    • notifyParticipantId : ID système du participant à Notify ; situé dans la table Notifier le participant [notify_participant].

      Actions valides : joindre, kick, multiJoin, mute, démarrer, rétablir le son

    • phoneNumber : numéro de téléphone du participant. Si cette valeur est transmise en conjonction avec le id ou notifyParticipantId, elle remplace les numéros de téléphone dans l’enregistrement utilisateur/participant et est utilisée pour passer l’appel.

      Actions valides : joindre, multijoindre, démarrer

    • email : adresse e-mail du participant.

      Actions valides : joindre, multijoindre, démarrer

    données.serviceProvider Chaîne Requis. Nom du fournisseur de services de conférence, tel que Zoom ou Webex.

    Actions pour lesquelles ce paramètre est obligatoire :

    • tous
    données.sysId Chaîne ID système de l’enregistrement source à associer à la téléconférence.

    Par exemple, si une téléconférence est organisée pour discuter d’un incident ou d’un problème spécifique, définissez l’ID système de l’enregistrement d’incident ou de problème dans cette valeur. Cet ID système est stocké dans la colonne Source de la table Notification Téléconférence [notify_conference_call] et peut être suivi ultérieurement.

    Ce paramètre est utilisé en conjonction avec les data.Tableparamètres , data.addToWorkNotes, et allowMulticonference

    Actions pour lesquelles ce paramètre est valide :

    • début
    données.table Chaîne Table contenant l’enregistrement source à associer à la téléconférence. Un enregistrement source peut être n’importe quel enregistrement, tel qu’un « incident » ou un « problème », qui est le sujet de discussion de la téléconférence.

    Ce nom de table est stocké dans la colonne Table de la table Téléconférence de notification [notify_conference_call] et peut faire l’objet d’un suivi.

    Ce paramètre est utilisé en conjonction avec les data.sysIdparamètres , data.addToWorkNotes, et allowMulticonference

    Actions pour lesquelles ce paramètre est valide :

    • début
    Tableau 4. Renvoie
    Type Description
    Objet Résultats de l’action de la conférence.

    <action>.status : état de l’action de la conférence.

    • Type de données : booléennes
    • Valeurs valides :
      • true : action de la conférence réussie
      • false : échec de l’action de la conférence

    <action>.successMessages : si l’état est vrai, message(s) de réussite, sinon, vide(s).

    • Type de données : tableau de chaînes

    <action>.warnMessages : si l’état est faux, tous les messages d’avertissement sont levés pendant le traitement.

    • Type de données : tableau de chaînes

    <action>.errorMessages : si l’état est faux, tous les messages d’erreur sont levés pendant le traitement.

    • Type de données : tableau de chaînes

    L’exemple suivant montre comment créer une fonction pour appeler doConferenceAction() afin de manipuler les participants d’une téléconférence en transmettant l’action et les participants.

    
    /**
     * 
     * @param {string} action - action to perform on the conference object or participant object
     * @param {Array} participants;
     */
    function doConferenceAction(action, participants) {
        var data = NotifyOnTaskClient.getNotifyActionTemplate();
        data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'
        data.confId = 'Active conference sysId';
        data.items = participants;
    
        NotifyOnTaskClient.doConferenceAction(action, data).then(function (result) {
            var kickActionResult = result[0];
            if (kickActionResult.status)
                console.log(action + ' succeeded');
            else {
                kickActionResult.warnMessages.forEach(function (msg) {
                    console.warn(msg);
                });
                kickActionResult.errorMessages.forEach(function (msg) {
                    console.error(msg);
                });
            }
        }, function (errMsg) {
                console.log(errMsg)
        });
    }
    
    // kick participants
    
    doConferenceAction('kick', [{notifyParticipantId: 'notifyParticipantSysId'}]);
    
    // kick multiple participants
    
    doConferenceAction('multiKick',
        [{notifyParticipantId: 'notifyParticipantSysId'},
        {notifyParticipantId: 'notifyParticipantSysId'}]);
    
    // Mute participants
    doConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);
    doConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);
    
    doConferenceAction('multiMute',
        [{notifyParticipantId: 'notifyParticipantSysId'},
        {notifyParticipantId: 'notifyParticipantSysId'}]);
    
    // self join to any confernece. 
    doConferenceAction('selfJoin', [{id: 'logged in userId'}]);
    

    NotifyOnTaskClient : endConference(données de l’objet)

    Met fin à la téléconférence spécifiée.

    Tableau 5. Paramètres
    Nom Type Description
    données Objet Objet qui décrit la téléconférence.
    données.confId Chaîne ID système de la téléconférence.
    données.serviceProvider Chaîne Requis. Nom du fournisseur de services de conférence, tel que Zoom ou Webex.
    Tableau 6. Renvoie
    Type Description
    Objet Résultats de l’action de la conférence.

    <action>.status : état de l’action de la conférence.

    • Type de données : booléennes
    • Valeurs valides :
      • true : action de la conférence réussie
      • false : échec de l’action de la conférence

    <action>.successMessages : si l’état est vrai, message(s) de réussite, sinon, vide(s).

    • Type de données : tableau de chaînes

    <action>.warnMessages : si l’état est faux, tous les messages d’avertissement sont levés pendant le traitement.

    • Type de données : tableau de chaînes

    <action>.errorMessages : si l’état est faux, tous les messages d’erreur sont levés pendant le traitement.

    • Type de données : tableau de chaînes
    function endConferenceCall() {
        var data = NotifyOnTaskClient.getNotifyActionTemplate();
        data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'
        data.confId = 'Active conference sysId';
    
        NotifyOnTaskClient.endConference(data).then(function (result) {
            var endActionResult = result[0];
            if (endActionResult.status)
                console.log('Conference has been ended');
            else {
                endActionResult.warnMessages.forEach(function (msg) {
                    console.warn(msg);
                });
                endActionResult.errorMessages.forEach(function (msg) {
                    console.error(msg);
                });
            }
        }, function (errMsg) {
            console.log(errMsg);
        });
    }

    NotifyOnTaskClient : getNotifyActionTemplate()

    Renvoie un modèle de données JSON à utiliser avec la méthode doConferenceAction(). L’utilisation de ce modèle structure automatiquement l’objet de données afin que vous n’ayez pas à le créer manuellement.

    Appelez cette méthode avant d’appeler la méthode doConferenceAction(). Pour l’action de téléconférence souhaitée, définissez les paramètres souhaités dans le modèle, puis transmettez le modèle dans l’appel doConferenceAction(). Pour plus d’informations sur les paramètres valides pour chaque action, consultez doConferenceAction().

    Remarque :
    Il s’agit d’une méthode d’assistance. Vous pouvez également construire manuellement cet objet et le passer dans la méthode doConferenceAction() et obtenir le même résultat.
    Tableau 7. Paramètres
    Nom Type Description
    Aucun
    Tableau 8. Renvoie
    Type Description
    données Objet qui décrit la téléconférence.
    data.addToWorkNotes Marqueur indiquant s’il faut ajouter des informations sur les participants qui ont été inclus dans la téléconférence dans le champ Notes de travail de l’enregistrement associé.

    Pour que cette fonctionnalité fonctionne, vous devez également spécifier des valeurs dans les data.table paramètres and data.sysId . Ces paramètres identifient l’enregistrement dans lequel ajouter les notes de travail.

    Valeur par défaut : false

    Actions pour lesquelles ce paramètre est valide :

    • début
    • rejoindre
    • Jointure multiple
    • selfJoin (Joindre soi-même)
    data.allowMultconference Marqueur indiquant s’il faut autoriser plusieurs téléconférences pour un enregistrement spécifique à la fois.

    Pour que cette fonctionnalité fonctionne, vous devez également spécifier des valeurs dans les data.table paramètres and data.sysId . Ces paramètres identifient l’enregistrement qui est autorisé à avoir plusieurs téléconférences.

    Valeur par défaut : false

    Actions pour lesquelles ce paramètre est valide :

    • début
    données.confId ID système de la téléconférence.

    L’ID système de la conférence se trouve dans la table Téléconférence de Notification [notify_conference_call].

    Actions pour lesquelles ce paramètre est obligatoire :

    • fin
    • rejoindre
    • Jointure multiple
    • selfJoin (Joindre soi-même)
    Remarque :
    Les actions des participants telles que désactiver le micro, réactiver le micro et expulser ne nécessitent pas la définition de ce paramètre, car la méthode obtient ces informations à partir de la table Participant à la téléconférence de Notification [notify_participant].
    data.fromNumber Numéro du fournisseur de service à appeler pour la téléconférence.

    Localisez cette valeur dans la colonne Numéro ou numéro de téléphone de la table Numéro de téléphone de Notification [notify_number].

    Actions pour lesquelles ce paramètre est obligatoire :

    • début
    data.isNewConference Marqueur indiquant s’il s’agit d’une nouvelle téléconférence ou d’une téléconférence existante.

    Valeurs valides :

    • true : Nouvelle téléconférence
    • false : téléconférence existante

    Valeur par défaut : false

    Actions pour lesquelles ce paramètre est valide :

    • début
    données.éléments Informations que chaque participant doit inclure dans la téléconférence.

    Valeurs de tableau valides :

    • id : ID système de l’utilisateur ; dans la table Utilisateur [sys_User].

      Actions valides : joindre, multijoindre, démarrer

    • notifyParticipantId : ID système du participant à Notify ; situé dans la table Notifier le participant [notify_participant].

      Actions valides : joindre, kick, multiJoin, mute, démarrer, rétablir le son

    • phoneNumber : numéro de téléphone du participant. Si cette valeur est transmise en conjonction avec le id ou notifyParticipantId, elle remplace les numéros de téléphone dans l’enregistrement utilisateur/participant et est utilisée pour passer l’appel.

      Actions valides : joindre, multijoindre, démarrer

    • email : adresse e-mail du participant.

      Actions valides : joindre, multijoindre, démarrer

    data.message Message lu à haute voix lorsqu’un utilisateur répond à l’appel, par exemple « Un incident P1 a été créé, veuillez vous connecter à l’instance ».

    Actions pour lesquelles ce paramètre est valide :

    • début
    • rejoindre
    • Jointure multiple
    données.serviceProvider Requis. Nom du fournisseur de services de conférence, tel que Zoom ou Webex.

    Actions pour lesquelles ce paramètre est obligatoire :

    • tous
    données.sysId ID système de l’enregistrement source à associer à la téléconférence.

    Par exemple, si une téléconférence est organisée pour discuter d’un incident ou d’un problème spécifique, définissez l’ID système de l’enregistrement d’incident ou de problème dans cette valeur. Cet ID système est stocké dans la colonne Source de la table Notification Téléconférence [notify_conference_call] et peut être suivi ultérieurement.

    Ce paramètre est utilisé en conjonction avec les data.Tableparamètres , data.addToWorkNotes, et allowMulticonference

    Actions pour lesquelles ce paramètre est valide :

    • début
    données.table Table contenant l’enregistrement source à associer à la téléconférence. Un enregistrement source peut être n’importe quel enregistrement, tel qu’un « incident » ou un « problème », qui est le sujet de discussion de la téléconférence.

    Ce nom de table est stocké dans la colonne Table de la table Téléconférence de notification [notify_conference_call] et peut faire l’objet d’un suivi.

    Ce paramètre est utilisé en conjonction avec les data.sysIdparamètres , data.addToWorkNotes, et allowMulticonference

    Actions pour lesquelles ce paramètre est valide :

    • début

    L’exemple suivant montre comment appeler getNotifyActionTemplate() pour obtenir le modèle de données nécessaire pour définir les actions de doConferenceAction().

    
    /**
     * 
     * @param {string} action - action to perform on the conference object or participant object
     * @param {Array} participants;
     */
    function doConferenceAction(action, participants) {
        var data = NotifyOnTaskClient.getNotifyActionTemplate();
        data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'
        data.confId = 'Active conference sysId';
        data.items = participants;
    
        NotifyOnTaskClient.doConferenceAction(action, data).then(function (result) {
            var kickActionResult = result[0];
            if (kickActionResult.status)
                console.log(action + ' succeeded');
            else {
                kickActionResult.warnMessages.forEach(function (msg) {
                    console.warn(msg);
                });
                kickActionResult.errorMessages.forEach(function (msg) {
                    console.error(msg);
                });
            }
        }, function (errMsg) {
                console.log(errMsg)
        });
    }
    
    // kick participants
    
    doConferenceAction('kick', [{notifyParticipantId: 'notifyParticipantSysId'}]);
    
    // kick multiple participants
    
    doConferenceAction('multiKick',
        [{notifyParticipantId: 'notifyParticipantSysId'},
        {notifyParticipantId: 'notifyParticipantSysId'}]);
    
    // Mute participants
    doConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);
    doConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);
    
    doConferenceAction('multiMute',
        [{notifyParticipantId: 'notifyParticipantSysId'},
        {notifyParticipantId: 'notifyParticipantSysId'}]);
    
    // self join to any confernece. 
    doConferenceAction('selfJoin', [{id: 'logged in userId'}]);
    

    NotifyOnTaskClient : start (données de l’objet)

    Démarre une nouvelle téléconférence.

    Tableau 9. Paramètres
    Nom Type Description
    données Objet Objet qui décrit la téléconférence.
    data.addToWorkNotes Booléen Facultatif.Marqueur indiquant s’il faut ajouter des informations sur les participants qui ont été inclus dans la téléconférence dans le champ Notes de travail de l’enregistrement associé.

    Pour que cette fonctionnalité fonctionne, vous devez également spécifier des valeurs pour les data.table paramètres et data.sysId afin d’identifier l’enregistrement dans lequel ajouter les notes de travail.

    Valeur par défaut : false

    data.allowMulticonference Booléen Facultatif. Marqueur indiquant s’il faut autoriser plusieurs téléconférences pour un enregistrement spécifique à la fois.

    Pour que cette fonctionnalité fonctionne, vous devez également spécifier des valeurs dans les data.table paramètres and data.sysId . Ces paramètres identifient l’enregistrement qui est autorisé à avoir plusieurs téléconférences.

    Valeur par défaut : false

    data.fromNumber Chaîne Requis. Numéro du fournisseur de service à appeler pour la téléconférence.

    Localisez cette valeur dans la colonne Numéro ou numéro de téléphone de la table Numéro de téléphone de Notification [notify_number].

    données.éléments Tableau Facultatif. Informations que chaque participant doit inclure dans la téléconférence.

    Valeurs de tableau valides :

    • id: ID système de l’utilisateur ; dans la table Utilisateur [sys_User].
    • notifyParticipantId: ID système du participant ; situé dans la table Notifier le participant [notify_participant].
    • phoneNumber: numéro de téléphone du participant. Si cette valeur est transmise en conjonction avec le id ou notifyParticipantId, elle remplace les numéros de téléphone dans l’enregistrement utilisateur/participant et est utilisée pour passer l’appel.
    • email: adresse e-mail du participant.
    data.message Chaîne Facultatif. Message lu à haute voix lorsqu’un utilisateur répond à l’appel, par exemple « Un incident P1 a été créé, veuillez vous connecter à l’instance ».
    données.serviceProvider Chaîne Requis. Nom du fournisseur de services de conférence, tel que Zoom ou Webex.
    données.sysId Chaîne Facultatif. ID système de l’enregistrement source à associer à la téléconférence.

    Par exemple, si une téléconférence est organisée pour discuter d’un incident ou d’un problème spécifique, définissez l’ID système de l’enregistrement d’incident ou de problème dans cette valeur. Cet ID système est stocké dans la colonne Source de la table Notification Téléconférence [notify_conference_call] et peut être suivi ultérieurement.

    Ce paramètre est utilisé en conjonction avec les data.Tableparamètres , data.addToWorkNotes, et allowMulticonference

    données.table Chaîne Facultatif. Table contenant l’enregistrement source à associer à la téléconférence. Un enregistrement source peut être n’importe quel enregistrement, tel qu’un « incident » ou un « problème », qui est le sujet de discussion de la téléconférence.

    Ce nom de table est stocké dans la colonne Table de la table Téléconférence de notification [notify_conference_call] et peut faire l’objet d’un suivi.

    Ce paramètre est utilisé en conjonction avec les data.sysIdparamètres , data.addToWorkNotes, et allowMulticonference

    Tableau 10. Renvoie
    Type Description
    Objet Résultats de l’action de la conférence.

    <action>.status : état de l’action de la conférence.

    • Type de données : booléennes
    • Valeurs valides :
      • true : action de la conférence réussie
      • false : échec de l’action de la conférence

    <action>.successMessages : si l’état est vrai, message(s) de réussite, sinon, vide(s).

    • Type de données : tableau de chaînes

    <action>.warnMessages : si l’état est faux, tous les messages d’avertissement sont levés pendant le traitement.

    • Type de données : tableau de chaînes

    <action>.errorMessages : si l’état est faux, tous les messages d’erreur sont levés pendant le traitement.

    • Type de données : tableau de chaînes
    function startConferenceCall() {
        var data = NotifyOnTaskClient.getNotifyActionTemplate();
        data.table = 'incident';
        data.sysId = '1234';
        data.serviceProvider = serviceProvider;
        data.addToWorkNotes = true;
        data.fromNumber = 'Telephony Number';
        data.items.push({ id: 'userSysId' });
        data.items.push({ phoneNumber: '+917799555332' });
        data.items.push({ email: 'yln99517@gmail.com' });
    
        NotifyOnTaskClient.start(data).then(function (result) {
            var startActionResult = result[0];
            if(startActionResult.status) {
                startActionResult.successMessages.forEach(function(msg) {
                    console.log(msg);
                });
                return;
            }
    
            startActionResult.warnMessages.forEach(function(msg) {
                console.warn(msg);
            });
            startActionResult.errorMessages.forEach(function(msg) {
                console.error(msg);
            });
        }, function (errMsg) {
            console.log(errMsg);
        });
    }