arckinteractive/notifications_sms

SMS Notification API for Elgg

1.1.0 2019-08-09 10:33 UTC

This package is auto-updated.

Last update: 2020-07-09 12:32:12 UTC


README

Elgg 2.1

Features

  • API to integrate Elgg notifications with an SMS provider

Notes

Sending

The plugin does not send actual SMS messages. The provider plugin must register for 'send', 'sms' hook and use provider API to dispatch messages. The hook will receive to phone number and text as parameters.

To send an SMS, use notifications_sms_send().

Instant notifications

To provide a custom SMS text for instant notifications, pass sms with parameters:

notify_user($user->guid, elgg_get_site_entity()->guid, 'Really long notification subject', 'Really long notification body', array(
	'sms' => 'Send this sms',
), 'email');

Subscriptions notifications

To provide a custom SMS text for subscription notifications that differs from the summary, set sms property on the \Elgg\Notifications\Notification instance in the prepare hook.