NotifyNow (hérité) - Global

L’API NotifyNow héritée fournit des fonctionnalités pour l’envoi d’e-mails, l’envoi de messages SMS et la configuration de téléconférences.

Utilisez cette option lorsque vous souhaitez utiliser la fonctionnalité de notification avec des applications de votre système.

Remarque :

Cette API est incluse dans la fonctionnalité Notify héritée. Pour les API incluses dans la fonctionnalité Notify actuelle, consultez les API Notify, NotifyAction, NotifyPhoneNumber et NotifyClient .

NotifyNow : addConferenceCallParticipant(String conferenceCall, String participant)

Ajoute des utilisateurs ad hoc à une téléconférence continue.

Lorsque la méthode est appelée avec un numéro de téléphone pour le paramètre participant et qu’il existe exactement un enregistrement de sys_user qui correspond au numéro de téléphone, cet enregistrement sys_user sera associé au participant. Le champ du numéro de téléphone du participant est laissé vide, car le numéro de téléphone se trouve dans l’enregistrement sys_user. S’il existe plusieurs enregistrements de sys_user qui correspondent au numéro de téléphone, ou s’il n’y a pas de résultats, le champ du numéro de téléphone du participant sera renseigné et aucune référence à sys_user n’est stockée, car l’utilisateur n’est pas connu.

Tableau 1. Paramètres

Nom	Type	Description
conferenceCall	Chaîne ou GlideRecord	sys_id ou GlideRecord d’une téléconférence active.
participant	Chaîne ou GlideRecord	sys_id ou GlideRecord d’un utilisateur avec un numéro de téléphone conforme E.164 ou un numéro de téléphone compatible E.164.

Tableau 2. Renvoie

Type	Description
GlideRecord	Enregistrement du nouveau participant qui a été ajouté à la téléconférence.

// add a new participant by conference call sys_id (string) and phone number (string) 
var nn = new SNC.NotifyNow();
gs.log(nn.addConferenceCallParticipant('d193b242eb020100a04d4910f206fe39', '[phone]'));

// add a new participant by conference call sys_id (string) and user record (GlideRecord)
var user = new GlideRecord('sys_user');
user.query('user_name', 'myUserName');
if (user.hasNext() && user.next()) {
    var nn = new SNC.NotifyNow();
    gs.log(nn.addConferenceCallParticipant('d193b242eb020100a04d4910f206fe39', user));
 
    // you could have added the user by sys_id as well:
    // nn.addConferenceCallParticipant('d193b242eb020100a04d4910f206fe39', user.getValue('sys_id'));
} else {
    gs.log('no such user');
}

// add a new participant by conference call record (GlideRecord) and phone number (string)
var conferenceCall = new GlideRecord('notifynow_conference_call');
conferenceCall.query('title', 'IA0001001');
if (conferenceCall.hasNext() && conferenceCall.next()) {
    var nn = new SNC.NotifyNow();
    gs.log(nn.addConferenceCallParticipant(conferenceCall, '[phone]'));
} else {
    gs.log('no such conference call');
}

NotifyNow : getReadyState()

Indique si Notification est configurée correctement ou non.

Seuls les administrateurs ou les utilisateurs disposant du rôle notifynow_admin peuvent accéder à cette méthode. Les utilisateurs disposant de tous les autres rôles reçoivent le message False lorsqu’ils essaient d’exécuter la fonction dans un script.

Tableau 3. Paramètres

Nom	Type	Description
Aucun

Tableau 4. Renvoie

Type	Description
Booléen	Vrai si Notification est configuré correctement, sinon faux.

var nn = new SNC.NotifyNow();
gs.log(((nn.getReadyState()) ? "OK" :  "NOT OK"));

NotifyNow : getStatus()

Renvoie l’état actuel de la configuration de Notify.

Seuls les administrateurs ou les utilisateurs disposant du rôle notifynow_admin peuvent accéder à cette méthode. Les utilisateurs disposant de tous les autres rôles reçoivent le message Non autorisé lorsqu’ils essaient d’exécuter la fonction dans un script.

Tableau 5. Paramètres

Nom	Type	Description
Aucun

Tableau 6. Renvoie

Type

Description

Chaîne

Un des messages d’état possibles. Statut Description NO_NUMBER_MESSAGE Le compte n’a pas de numéro de téléphone configuré. Assurez-vous d’avoir configuré le numéro de téléphone du compte. NO_ENDPOINTS_MESSAGE Les points de terminaison du compte ne sont pas configurés correctement. Assurez-vous de configurer les points de terminaison pour le compte. ACCOUNT_OK_MESSAGE Le compte est actif et prêt à l’emploi. ACCOUNT_NO_AUTH Le Twilio AuthToken n’est pas valide. ACCOUNT_NOT_CONFIGURED Le compteSID Twilio ou l’AuthToken n’est pas valide.

var nn = new SNC.NotifyNow();
gs.log(nn.getStatus());

NotifyNow : initiateConferenceCall(String[] conferenceCallParticipants, String conferenceCallTitle)

Lancez une nouvelle téléconférence.

Tableau 7. Paramètres

Nom	Type	Description
conferenceCallParticipants	Chaîne	Un ou plusieurs utilisateurs, participants à la téléconférence, identifiés par l’sys_ids de la table sys_user ou des numéros de téléphone compatibles E.164.
conferenceCallTitle	Chaîne	Titre de la téléconférence. Ce paramètre a une longueur maximale de 40 caractères.

Tableau 8. Renvoie

Type	Description
GlideRecord	Enregistrement de la téléconférence, ou null en cas d’erreur.

Cette opération lance une téléconférence avec des numéros de téléphone conformes E.164 pour les participants, sans le paramètre d’enregistrement source facultatif et n’envoie aucun détail de téléconférence par SMS ou par e-mail.

var participants = ['[phone]', '[phone]', '[phone]'];
// set up conference call
var nn = new SNC.NotifyNow();
var conferenceCall = nn.initiateConferenceCall(participants, "testing12");
gs.log('started conference call: ' + conferenceCall.getUniqueValue());

NotifyNow : initiateConferenceCall(String[] conferenceCallParticipants, String conferenceCallTitle, GlideRecord sourceRecord, booléen privé)

Lancez une nouvelle téléconférence.

Tableau 9. Paramètres

Nom	Type	Description
conferenceCallParticipants	Chaîne	Un ou plusieurs utilisateurs, participants à la téléconférence, identifiés par l’sys_ids de la table sys_user ou des numéros de téléphone compatibles E.164.
conferenceCallTitle	Chaîne	Titre de la téléconférence. Ce paramètre a une longueur maximale de 40 caractères.
sourceRecord	GlideRecord	Enregistrement source à associer à la téléconférence, tel qu’un numéro d’incident ou de problème.
privé	Booléen	Valeur permettant de contrôler si une téléconférence est privée. Cette valeur est définie par défaut sur false.

Tableau 10. Renvoie

Type	Description
GlideRecord	Enregistrement de la téléconférence, ou null en cas d’erreur.

Cela lance une téléconférence avec des participants qui disposent d’un numéro de téléphone conforme E.164 et des participants de la table sys_user et envoie les détails de la téléconférence par SMS et par e-mail à tous les participants.

// define phone number participants
var participants = ['[phone]', '[phone]', '[phone]'];
 
// we also want to add two Dutch sys_user participants
var user = new GlideRecord('sys_user');
user.addNotNullQuery('mobile_phone');
user.addQuery('mobile_phone', 'STARTSWITH', '+316');
user.setLimit(2);
user.query();
 
// add users to the participant array
while (user.hasNext() && user.next()) {
	gs.log('adding user ' + user.getValue('name') + ' with phone number ' + 
             user.getValue('mobile_phone') + ' to the participant array');
	participants.push(user.getUniqueValue());
}
 
// define a source record to associate with the conference call
var source = new GlideRecord("cmdb_ci");
source.query("asset_tag", "P1000167");
if (source.hasNext() && source.next()) {
	// set up conference call
	var nn = new SNC.NotifyNow();
	var conferenceCall = nn.initiateConferenceCall(participants, "testing 1 2", source);
 
	// check if the conference call was successfully created
	if (conferenceCall != null) {
		gs.log('started conference call: ' + conferenceCall.getUniqueValue());
	} else {
		gs.log('could not start the conference call :(');
	}
}

NotifyNow : isCallable(String participant)

Détermine si un utilisateur peut être appelé ou non.

Un utilisateur doit avoir un numéro de téléphone valide pour être appelable. Un utilisateur qui est déjà dans une session active n’est pas appelable.

Tableau 11. Paramètres

Nom	Type	Description
participant	Chaîne ou GlideRecord	Un enregistrement sys_user ou notifynow_participant, ou un numéro de téléphone conforme E.164.

Tableau 12. Renvoie

Type	Description
booléen	Indique si ce participant peut être appelé ou non.

var nn = new SNC.NotifyNow();
gs.log('by number: ' + nn.isCallable('[phone]'));
 
var user = GlideRecord('sys_user');
user.query('sys_id', '13d39544eb5201003cf587b9d106fea9');
if (user.hasNext() && user.next())
  gs.log('by user: ' + nn.isCallable(user));
 
var participant = GlideRecord('notifynow_participant');
participant.query('sys_id', '33b11430eb1201003cf587b9d106feb9');
if (participant.hasNext() && participant.next())
  gs.log('by participant: ' + nn.isCallable(participant));

NotifyNow : isSMSCapable()

Vérifie si le numéro de téléphone associé au compte Twilio est capable d’envoyer des messages SMS.

Tableau 13. Paramètres

Nom	Type	Description
Aucun

Tableau 14. Renvoie

Type	Description
Booléen	Si le numéro de téléphone associé au compte Twilio est capable d’envoyer des messages SMS.

gs.log('The twilio number is SMS capable: ' + ((new SNC.NotifyNow().isSMSCapable()) ? 'yes' : 'no'));

NotifyNow : isSMSCapable(String userID)

Vérifie si un utilisateur est en mesure d’envoyer des messages SMS.

Tableau 15. Paramètres

Nom	Type	Description
userID	Chaîne	La sys_id de l’utilisateur que vous souhaitez vérifier pour un numéro de téléphone compatible avec les SMS.

Tableau 16. Renvoie

Type	Description
Booléen	Si l’utilisateur peut envoyer des messages SMS.

gs.log('the user is able to send SMS messages (e.g. has a SMS device): ' + ((new SNC.NotifyNow().isSMSCapable('<user sys_id>')) ? 
     'yes' : 'no'));

NotifyNow : isVoiceCapable()

Vérifie si le numéro de téléphone associé au compte Twilio est capable de configurer des appels téléphoniques.

Tableau 17. Paramètres

Nom	Type	Description
Aucun

Tableau 18. Renvoie

Type	Description
Booléen	Indique si le numéro de téléphone associé au compte Twilio est compatible avec les appels téléphoniques.

gs.log('the Twilio number is Voice capable: ' + ((new SNC.NotifyNow().isVoiceCapable()) ? 'yes' : 'no'));

NotifyNow : isVoiceCapable(String userID)

Vérifie si un utilisateur est en mesure d’effectuer des appels vocaux.

Tableau 19. Paramètres

Nom	Type	Description
userID	Chaîne	La sys_id de l’utilisateur que vous souhaitez vérifier pour un numéro de téléphone compatible avec les appels vocaux.

Tableau 20. Renvoie

Type	Description
booléen	Si l’utilisateur dispose d’un numéro de téléphone compatible avec les appels vocaux.

gs.log('the user is able to send SMS messages (e.g. has a SMS device): ' + 
     ((new SNC.NotifyNow().isVoiceCapable('someuserid')) ? 'yes' : 'no'));

NotifyNow : kick (participant GlideRecord)

Supprime un participant d’une téléconférence.

Tableau 21. Paramètres

Nom	Type	Description
participant	GlideRecord	Le participant à la téléconférence à supprimer de l’appel.

Tableau 22. Renvoie

Type	Description
Booléen	Vrai si le participant a été supprimé, sinon faux.

var participantId = "<participant sys_id>";
var participant = new GlideRecord('notifynow_participant');
participant.get(participantId);
if (participant.isValid()) {
     // kick participant
     result = new SNC.NotifyNow().kick(participant);
     gs.log('participant kicked: ' + result);
}

NotifyNow : muet (participant GlideRecord)

Désactive le son d’un participant à une téléconférence.

Tableau 23. Paramètres

Nom	Type	Description
participant	GlideRecord	Désactiver le son du participant à la téléconférence.

Tableau 24. Renvoie

Type	Description
Booléen	Vrai si le micro du participant a été coupé, sinon faux.

var participantId = "<participant sys_id>";
var participant = new GlideRecord('notifynow_participant');
participant.get(participantId);
if (participant.isValid()) {
     // mute participant
     result = new SNC.NotifyNow().mute(participant);
     gs.log('participant muted: ' + result);
}

NotifyNow : umute(participant GlideRecord)

Active le micro d’un participant à une téléconférence.

Tableau 25. Paramètres

Nom	Type	Description
participant	GlideRecord	Participant à la téléconférence désactivé dont le micro doit être rétabli.

Tableau 26. Renvoie

Type	Description
Booléen	Vrai si le micro du participant a été rétabli, sinon faux.

var participantId = "<participant sys_id>";
var participant = new GlideRecord('notifynow_participant');
participant.get(participantId);
if (participant.isValid()) {
     // unmute participant
     result = new SNC.NotifyNow().unmute(participant);
     gs.log('participant unmuted: ' + result);
}

NotifyNow : sendEmailQuestion(String emailAddress, String question, GlideRecord sourceRecord, String emailSubject)

Envoyez une question par e-mail à une adresse e-mail.

La méthode sendEmailQuestion génère un corps de question et demande aux utilisateurs de cliquer sur un lien pour indiquer leur choix.

Tableau 27. Paramètres

Nom	Type	Description
emailAddress	Chaîne	Adresse e-mail à laquelle envoyer la question.
question	Chaîne ou GlideRecord	Enregistrement de question à envoyer ou sys_id d’un enregistrement de question.
sourceRecord	GlideRecord	Un enregistrement source facultatif à associer à la question SMS, tel qu’un incident.
Objet d’e-mail	Chaîne	Texte facultatif pour remplacer l’objet de l’e-mail par défaut.

Tableau 28. Renvoie

Type	Description
Chaîne	La conversation sys_id.

Cet exemple montre l’utilisation de l’objet d’e-mail par défaut.

var user = GlideRecord("sys_user");
user.get("email", "[e-mail]");
 
new SNC.NotifyNow().sendEmailQuestion(user.getValue('email'), "b6b34500bf3111003cf585ce2c0739ce", user);

Cet exemple utilise une remontée pas à pas et spécifie un enregistrement source et un objet d’e-mail.

new SNC.NotifyNow().sendEmailQuestion("[e-mail]", "b6071733bf1111003cf585ce2c07390f", current, 
        "Please answer this question");

Cet exemple utilise la remontée pas à pas et spécifie un objet d’e-mail, mais pas d’enregistrement source.

new SNC.NotifyNow().sendEmailQuestion("[e-mail]", "b6071733bf1111003cf585ce2c07390f", 
        "Please answer this question");

NotifyNow : sendSMS(String phoneNumber, String smsBody)

Envoie un SMS à un numéro de téléphone mobile compatible E.164.

Notify prend en charge les numéros internationaux. L’utilisation de cette méthode avec un numéro qui ne prend pas en charge l’envoi de messages SMS entraîne la journalisation d’une erreur.

Tableau 29. Paramètres

Nom	Type	Description
phoneNumber	Chaîne	Numéro de téléphone conforme E.164 auquel envoyer le message.
corps sms	Chaîne	Message à envoyer, 1 600 caractères maximum.

Tableau 30. Renvoie

Type	Description
nul

new SNC.NotifyNow().sendSMS("[phone]", "This is a message without source record");

NotifyNow : sendSMS (chaîne phoneNumber, chaîne smsBody, source GlideRecord)

Envoie un SMS à un numéro de téléphone mobile compatible E.164.

Notify prend en charge les numéros internationaux. L’utilisation de cette méthode avec un numéro qui ne prend pas en charge l’envoi de messages SMS entraîne la journalisation d’une erreur.

Voir aussi : Configuration avancée pour SMS.

Tableau 31. Paramètres

Nom	Type	Description
phoneNumber	Chaîne	Numéro de téléphone conforme E.164 auquel envoyer le message.
corps sms	Chaîne	Message à envoyer, 1 600 caractères maximum.
source	GlideRecord	Enregistrement source à associer à ce message SMS.

Tableau 32. Renvoie

Type	Description
nul

var source = new GlideRecord("my_table");
source.query("my_field", "my_value");

if (source.hasNext() && source.next()) {
    // send a text message
    var nn = new SNC.NotifyNow();
    var message = "this is just a test";
    var number = "[phone]";
    nn.sendSMS(number, message, source);
}

Cet exemple utilise la remontée pas à pas et l’enregistrement actuel comme enregistrement source.

new SNC.NotifyNow().sendSMS("[phone]", "this is a test", current);

NotifyNow : sendSMSQuestion(String phoneNumber, String question, GlideRecord sourceRecord)

Envoie une question par SMS.

Tableau 33. Paramètres

Nom	Type	Description
phoneNumber		Numéro de téléphone conforme E.164 auquel envoyer le message.
question	Chaîne ou GlideRecord	Enregistrement de question à envoyer ou sys_id d’un enregistrement de question.
sourceRecord		Un enregistrement source facultatif à associer à la question SMS, tel qu’un incident.

Tableau 34. Renvoie

Type	Description
Chaîne	La conversation sys_id ou nulle si le SMS n’a pas été envoyé avec succès.

var question = new GlideRecord("notifynow_question");
question.query();
 
// get the first question
if (question.hasNext() && question.next()) {
	// send the sms question
        var number = "[phone]";
	var nn = new SNC.NotifyNow();
	nn.sendSMSQuestion(number, question.getUniqueValue(), current);
}

NotifyNow : convertLocalPhoneNumberToE164(String userID, String phoneNumber)

Convertit un numéro de téléphone local en numéro de téléphone conforme E.164 en fonction de l’emplacement de l’utilisateur.

Tableau 35. Paramètres

Nom	Type	Description
userID	Chaîne	sys_id d’un enregistrement de sys_user à partir duquel obtenir des informations sur l’emplacement.
phoneNumber	Chaîne	Numéro de téléphone.

Tableau 36. Renvoie

Type	Description
Chaîne	Numéro de téléphone conforme E.164.

var localPhoneNumber = '01784 221600';
var userName = 'Heath Vanalphen';
 
var user = new GlideRecord('sys_user');
user.get('name',userName);
var E164Number = new SNC.NotifyNow().convertLocalPhoneNumberToE164(user.getUniqueValue(), localPhoneNumber);
gs.log('converted: ' + localPhoneNumber + ' to ' + E164Number + ' based on ' + user.getValue('name') + 
     '\'s location (' + user.getValue('location') + ')');

NotifyNow : getConferenceCallParticipants(String conferenceCallId, Boolean isCallable)

Renvoie tous les participants pour une téléconférence.

Tableau 37. Paramètres

Nom	Type	Description
ID d’appel de conférence	Chaîne	ID de la téléconférence.
isCallable	Booléen	Marqueur facultatif permettant de renvoyer uniquement les utilisateurs que vous pouvez appeler (vrai) ou ceux que vous ne pouvez pas appeler (faux).

Tableau 38. Renvoie

Type	Description
GlideRecord	Les participants

var nn = new SNC.NotifyNow();
var user = nn.getConferenceCallParticipants('c2e91710eb120100f34087b9d106fe37');
 
while (user.hasNext() && user.next()) {
    if (user.getValue('participant')) {
        gs.log('user: ' + user.getValue('sys_id'));
    } else {
        gs.log('phone number: ' + user.getValue('phone_number'));
    }
}

var nn = new SNC.NotifyNow();
var user = nn.getConferenceCallParticipants('c2e91710eb120100f34087b9d106fe37', true);
 
while (user.hasNext() && user.next()) {
    if (user.getValue('participant')) {
        gs.log('user: ' + user.getValue('sys_id'));
    } else {
        gs.log('phone number: ' + user.getValue('phone_number'));
    }
}

var conferenceCallId = '32b11430eb1201003cf587b9d106feb8';
 
// get all participants
gs.log('all conference call participants:');
var nn = new SNC.NotifyNow();
var user = nn.getConferenceCallParticipants(conferenceCallId);
gs.log(user);
 
// get all callable participants
gs.log('all conference call participants we can call:');
user = nn.getConferenceCallParticipants(conferenceCallId, true);
gs.log(user);
 
// get all un callable participants
gs.log('all conference call participants that are already in an active session and whom we cannot call:');
user = nn.getConferenceCallParticipants(conferenceCallId, false);
gs.log(user);

NotifyNow : getFrequentlyCalledUsers (limite du nombre)

Renvoie un nombre d’utilisateurs fréquemment appelés, jusqu’au paramètre limite, par ordre alphabétique.

Tableau 39. Paramètres

Nom	Type	Description
limite	Numéro	Nombre maximal de résultats.

Tableau 40. Renvoie

Type	Description
GlideRecord	Les utilisateurs fréquemment appelés par ordre alphabétique.

var nn = new SNC.NotifyNow();
var fc = nn.getFrequentlyCalledUsers(10);
 
while (fc.hasNext() && fc.next()) {
    gs.log("got user " + fc.getValue('name') + ' - ' + fc.getValue('sys_id'));
}

NotifyNow : getPreferredE164SMSNumber(utilisateur GlideRecord)

Renvoie le numéro de téléphone conforme E.164 préféré de l’utilisateur pour les messages SMS.

Tableau 41. Paramètres

Nom	Type	Description
utilisateur	GlideRecord ou chaîne	L’enregistrement utilisateur ou l’sys_id d’un utilisateur à partir duquel obtenir le numéro de téléphone conforme E.164.

Tableau 42. Renvoie

Type	Description
Chaîne	Numéro de téléphone conforme E.164 ou null.

var userID = "<user sys_id>";
var E164Number = new SNC.NotifyNow().getPreferredE164SMSNumber(userID);
gs.log('the preferred phone number for sending SMS notifications is ' + E164Number + ' for user with id: ' + userID);

NotifyNow : getPreferredE164VoiceNumber (utilisateur GlideRecord)

Renvoie le numéro de téléphone conforme E.164 préféré de l’utilisateur pour les appels vocaux.

Tableau 43. Paramètres

Nom	Type	Description
utilisateur	GlideRecord ou chaîne	L’enregistrement utilisateur ou l’sys_id d’un utilisateur à partir duquel obtenir le numéro de téléphone conforme E.164.

Tableau 44. Renvoie

Type	Description
Chaîne	Numéro de téléphone conforme E.164 ou null.

var userID = "<user sys_id>";
var E164Number = new SNC.NotifyNow().getPreferredE164VoiceNumber(userID);
gs.log('the preferred phone number for setting up voice calls is ' + E164Number + ' for user with id: ' + userID);

NotifyNow : getPreferredEmailAddress (utilisateur GlideRecord)

Renvoie l’adresse e-mail préférée d’un utilisateur

Tableau 45. Paramètres

Nom	Type	Description
utilisateur	GlideRecord ou chaîne	L’enregistrement utilisateur ou l’sys_id d’un utilisateur à partir duquel obtenir l’adresse e-mail.

Tableau 46. Renvoie

Type	Description
Chaîne	L’adresse e-mail ou null.

var userID = "some user sys id";
var email = new SNC.NotifyNow().getPreferredEmailAddress(userID);
gs.log('the preferred email address for sending email notifications is ' + email + ' for user with id: ' + userID);