mobpushcli
Use the mobpushcli program to send push notifications to mobile devices for users that have the Bravura One app registered on their devices.
The requests are sent to the Bravura One mobile proxy push notification server which will then send them to the Apple and Google notification servers. The notification messages are placed in a queue and will then be pushed out to the registered mobile devices. They will appear as a notification message on a user’s mobile device.
Usage
mobpushcli.exe -u <profile ID> -t <message title> -m <message body> [-b <number>] [-n] [-q] [-s <sound clip>] [-w] [-l <seconds>]
Argument | Description |
|---|---|
-h — --help | Print out the help usage. |
-v — --version | Print out the version. |
-u <profile ID> — --users <profile ID> | Specifies the profile ID for a user to send the push notification to. Multiple users may be specified individually with "-u profileid1 -u profileid2 ...". |
-t <message title> — --title <message title> | The title of the notification message. |
-m <message body> — --body <message body> | The message body of the notification message. |
-b <number> — --badge <number> | Specifies a positive numeric value for the badge. Specifying "-b 1" will add a "1" to the top right-hand corner of the app icon. Applicable to iOS devices only. |
-n — --nourgent | This will determine how fast the notifications will reach an Android device. Messages submitted from the notification queue from Google will be sent faster and will be marked as urgent and as a high-priority message when this option is not specified. They are marked as non-urgent when -n has been specified. |
-q — --quiet | This option will suppress most of the command line output and only show the value for "errmsg" for the success or error message. |
-s <sound clip> — --sound <sound clip> | Specifies a sound clip on mobile devices. The default sound clip is currently available. User-specified sounds are not currently supported. |
-w — --sync | When this option is not specified, notifications are sent to the push notification server and put into the queue. mobpushcli will only return a message indicating that the notification has been queued, regardless of whether or not the notification was sent successfully. When -w has been specified, mobpushcli will wait for the result to be returned from the push notification server and will immediately return the status of the notification, for example, if it was successful or if an exception has occurred. |
-l <seconds> — --ttl <seconds> | Determines how long the notification will last in the queue for the Apple or Google push notification server when the message cannot be delivered. The default value if this option is not specified is 86400 seconds (24 hours). |
Examples
To send a push notification to the mobile device for a user that has a registered device, type:
mobpushcli -u msmith -t "message title" -m "message body"
To send a push notification and set the badge icon to show a 1 in the top right hand corner of the Bravura One app on iOS mobile devices:
mobpushcli.exe -u msmith -t "message title" -m "message body" -b 1
To send a push notification and wait for the result to be returned by mobpushcli so that it can be immediately shown:
mobpushcli.exe -u msmith -t "message title" -m "message body" -w
To send a notification to multiple users at the same time:
mobpushcli.exe -u jjackson -u cbrown -u msmith -t "message title" -m "message body" -w