This task sends a Broadcast IM to a large number of recipients on behalf of a user.
- This API is authorized if psconnector service attribute ‘force application authorization rule’ is disabled, or if the sender has this calling app in its service profile. If authorization fails, an UnAuthorizedException is thrown.
This is an asynchronous task.
Message (mandatory) – Message to be sent via Presence Services Connector, it should be a non-empty string.
Header (mandatory) – Header to be added to the top of the message. For example: "Please do not reply. The following message was generated by the system:" is a good generic header to use.
senderUri (mandatory) – URI of the message sender - any name can be used as long as it is formatted with user@domain - for example: "broadcast@presence.system." However, if the PSConnector is configured to "Force Application Subscription Authorization Rules", then the sendUri must be a user in System Manager with the PSConnector service in it's Breeze Service Profile. In this case, the senderUri is the System Manager "Login Name" - no other configuration is required. Caution: if the senderUri is assigned a Presence Profile with the Presence/IM handle matching the System Manager Login Name, then any replies to the broadcast message will be delivered to the senderUri.
Recipient Type (mandatory)
All Users – Message is sent to all users in the Presence Services cluster
Presence Domains – Message is sent to all users matching any of the presence domains provided - domains must be separated by commas.
PResence Handles – Message is sent to all users listed in the comma separated lists of handles. Any handles that do not exist in SMGR are ignored.
Recipients (mandatory for PRESENCE_DOMAINS and PRESENCE_HANDLES) – a comma separated list with no spaces.
All mandatory fields should either be mapped using the Input Mapping window or entered in the Properties window for validation to succeed.
All of the properties above are also input schema. Please refer to the properties above for details.
status – request status code. It can be one of the following: 200 - request was successful; 403 - not authorized; 404 - invalid sender or recipient; 500 - other error, please check logs.
reason – detailed reason in case get presence request had failed. This field is empty if request was successful.
Not applicable.
Presence Services must be configured and running.
Presence Services Connector must be configured and running.
Not applicable.
Not applicable