userSendNotificationEx (Command)

Mis à jour le 21 Jan 2025
2 Minutes à lire

Partager
Sombre
Lumière
PDF

The content is currently unavailable in French. You are viewing the default English version.

Résumé de l’article

Avez-vous trouvé ce résumé utile ?

Merci pour vos commentaires

The userSendNotificationEx command sends a notification message created in the framework, i.e. outside of OneSpan Authentication Server, to a specified user via the Message Delivery Component (MDC). The notification can be scheduled to be sent at a later time.

Parameters

Table: userSendNotificationEx input parameters (SOAP administration)
Parameter name	Data type	Description
sessionID	String	Required. The session identifier of the current administrative session. The logon command returns this identifier after a successful logon (see logon (Command)).
user	UserInput	Required. Specifies the user to whom the message is sent (see UserInput (Data type)).
schedule	ScheduleInput	Optional. Defines the date and time the message will be sent.
profile	String	Optional. Defines which MDC profile is used to send the message.
email	EmailNotification	Required. (if this type of notification was selected) The type of notification used for sending the message.
sms	SmsNotification	Required. (if this type of notification was selected) The type of notification used for sending the message.
voice	VoiceNotification	Required. (if this type of notification was selected) The type of notification used for sending the message.
push	PushNotification	Required. (if this type of notification was selected) The type of notification used for sending the message.

Table: userSendNotificationEx output parameters (SOAP administration)
Parameter name	Data type	Description
status	CommandStatusResponse	Required. The error stack, if applicable, which indicates that the command has not completed successfully. This also includes the result and status codes returned by the command.
result	UserSendNotificationExResult	Required. The output field for this command.

UserInput (Data type)

Table: UserInput (Data type)
Element name	Data type	Description
userID	String	The user ID.
domain	String	Optional. The user domain.

ScheduleInput (Data type)

Table: ScheduleInput (Data type)
Element name	Data type	Description
time	DateTime	The date and time the message will be sent. Seconds are ignored by the scheduled task.

EmailNotification (Data type)

Table: EmailNotification (Data type)
Element name	Data type	Description
destinationEmail	String	The returned email address of the recipient.
subject	String	The subject of the message sent to the recipient.
message	String	The message text.

SmsNotification (Data type)

Table: SmsNotification(Data type)
Element name	Data type	Description
destinationPhoneNumber	String	The returned mobile phone number of the recipient.
message	String	The message text.

VoiceNotification (Data type)

Table: VoiceNotification(Data Type)
Element name	Data type	Description
destinationPhoneNumber	String	The returned (mobile) phone number of the recipient.
message	String	The message text.

PushNotification (Data type)

Table: PushNotification(Data Type)
Element name	Data type	Description
destinationSerialNumber	String	The returned serial number of the user's authenticator.
title	String	The title of the sent message.
subject	String	The subject of the message sent to the recipient.
message	String	The message text.
mobileAppName	String	The name of the mobile application.

UserSendNotificationExResult (Data type)

Table: UserSendNotificationExResult (Data type)
Element name	Data type	Description
user	UserOutput	The returned user information (see UserOutput (Data type)).
taskID	String	The returned task ID in case of scheduled notifications.
destination	String	The returned (mobile) phone number or email address of the recipient.

UserOutput (Data type)

Table: UserOutput (Data type)
Element name	Data type	Description
userID	String	The resolved user ID.
domain	String	The user domain.
orgUnit	String	Optional. The organizational unit of the user.

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Administration">
  <soapenv:Header/>
  <soapenv:Body>
    <adm:userSendNotificationEx>
      <sessionID>bbhDR7=mI90R+Q1Kr_??~9IesbmtnVyQ</sessionID>
      <user>
        <userID>Jane Doe</userID>
        <domain>Master</domain>
      </user>
      <push>
        <serialNumber>12345678</serialNumber>
        <title>Message title</title>
        <subject>Lorem ipsum</subject>
        <message>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</message>
      </push>
    </adm:userSendNotificationEx>
  </soapenv:Body>
</soapenv:Envelope>

Requirements

Required administrative privileges:

Send Notification

Cet article vous a-t-il été utile ?

What's Next

offlinedataExecute (Command)

Table des matières

Parameters
Example
Requirements