Versions Compared

Version Old Version 4 New Version Current
Changes made by

Ryan Clifton

Andy Brook [Plugin People]

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For each provider the requirement parameters are different.  Below is a table of the supported providers and the required parameters for successful configuration.  More information on these parameters can be found in the respective providers documentation.

SMS Provider

Required Parameters

Documentation Reference

Twilio

  • to

  • from

  • accountsid

  • authToken

https://www.twilio.com/docs/api/rest/sending-messages

BulkSMS

  • username

  • password

  • msisdn

http://developer.bulksms.com/eapi/submission/send_sms/

Nexmo

  • api_key

  • api_secret

  • from

  • to

https://docs.nexmo.com/messaging/sms-api/api-reference

Clockwork

  • key

  • to

https://www.clockworksms.com/doc/easy-stuff/http-interface/send-sms/

Info

Each provider charge differently, please refer to their FAQ and pricing policies.

Example (Twillio)

Once you have signed up, the necessary info for the Transport will be found on the post-login screen:

...

Configuring the SMS transport

...

  1. Go to JEMH Cloud > Notifications > SMS > Create

  2. Complete the form, select the nominated projects, select the SMS transport you want to use and the phone numbers (CSV) that will receive SMS message. Enter a velocity script if you want to modify the notification behaviour at runtime (more below).

  3. On Submit, you should see the new SMS mapping

  4. To test the mapping, create an issue in the nominated project and go to Auditing → Events

  5. You should see the issue created event in the queue. When event has been processed, the configured phone numbers in the mapping should have received an SMS message.

  6. The report of the event should confirm the message sent 

    Image RemovedImage Added

  7. In Auditing → Outbound Messages, the table should show the SMS messages sent and the cog icon should show their contents.

    Image RemovedImage Added

Send SMS Notifications from Post Functions

...

Change to phone number when Critical

Code Block
#if ($context.issue.fields.priority.name.textValue() != 'Critical') ## if issue priority is critical
  $smsNotificationUtils.resetToPhoneNumbers() ## remove existing phone numbers for current notification
  $smsNotificationUtils.addToPhoneNumber("+1234567") ## add phone number to current notification
#end

Restrict notifications to specific time ranges

Notify only after hours

Code Block
#if (!$dateTimeUtils.betweenHours("18:00", "06:00")) ## during specific hours
   $smsNotificationUtils.inhibitNotification() ## prevent current SMS notification
#end

Restrict by priority

Code Block
#if ($context.issue.fields.priority.name.textValue() != 'Blocker') ## if issue priority is not a blocker
   $smsNotificationUtils.inhibitNotification() ## prevent current SMS notification
#end

...