symfony/sweego-notifier

Symfony Sweego Notifier Bridge

Maintainers

Details

github.com/symfony/sweego-notifier

Homepage

Source

Fund package maintenance!
fabpot
Tidelift
symfony.com/sponsor

Installs: 18

Dependents: 0

Suggesters: 0

Security: 0

Stars: 3

Watchers: 2

Forks: 0

Type:symfony-notifier-bridge

v7.2.0 2024-11-15 13:52 UTC

Requires

Requires (Dev)

MIT 67f512bc7e120f634a5ee261427503251d9ea2b1

smsnotifiersweego

This package is auto-updated.

Last update: 2024-12-06 13:33:14 UTC

README

Provides Sweego integration for Symfony Notifier.

DSN example

SWEEGO_DSN=sweego://API_KEY@default?region=REGION&campaign_type=CAMPAIGN_TYPE&bat=BAT&campaign_id=CAMPAIGN_ID&shorten_urls=SHORTEN_URLS&shorten_with_protocol=SHORTEN_WITH_PROTOCOL

where:

  • API_KEY (required) is your Sweego API key
  • REGION (required) is the region of the phone number (e.g. FR, ISO 3166-1 alpha-2 country code)
  • CAMPAIGN_TYPE (required) is the type of the campaign (e.g. transac)
  • BAT (optional) is the test mode (e.g. true)
  • CAMPAIGN_ID (optional) is the campaign id (e.g. string)
  • SHORTEN_URLS (optional) is the shorten urls option (e.g. true)
  • SHORTEN_WITH_PROTOCOL (optional) is the shorten with protocol option (e.g. true)

Advanced Message options

use Symfony\Component\Notifier\Message\SmsMessage;
use Symfony\Component\Notifier\Bridge\Sweego\SweegoOptions;

$sms = new SmsMessage('+1411111111', 'My message');

$options = (new SweegoOptions())
    // False by default, set 'bat' to true enable test mode (no sms sent, only for testing purpose)
    ->bat(true)
    // Optional, used for tracking / filtering purpose on our platform; identity an SMS campaign and allow to see logs / stats only for this campaign
    ->campaignId('string')
    // True by default, we replace all url in the SMS content by a shortened url version (reduce the characters of the sms)
    ->shortenUrls(true)
    // True by default, add scheme to shortened url version
    ->shortenWithProtocol(true);

// Add the custom options to the sms message and send the message
$sms->options($options);

$texter->send($sms);

Sponsor

This bridge for Symfony 7.2 is backed by Sweego itself!

Sweego is a European email and SMS sending platform for developers and product builders. Easily create, deliver, and monitor your emails and notifications.

Help Symfony by sponsoring its development!

Resources