symfony / sweego-notifier
Symfony Sweego Notifier Bridge
Fund package maintenance!
fabpot
Tidelift
symfony.com/sponsor
Installs: 1
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 2
Forks: 0
Type:symfony-notifier-bridge
Requires
- php: >=8.2
- symfony/http-client: ^6.4|^7.0
- symfony/notifier: ^7.2
Requires (Dev)
- symfony/webhook: ^6.4|^7.0
This package is auto-updated.
Last update: 2024-10-27 15:25:26 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 keyREGION
(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);