Skip to main content
Version: 2.0.0

Settings

Open Settings -> Plugins -> SMS Brana.

The settings page is split into tabs, plus a details panel on the right for enabling/disabling the plugin.

General​

  • Admin Notification Number — one or more phone numbers (comma-separated) that receive a copy of every outgoing SMS, regardless of source. Leave empty to disable admin copies.

Use this field for operational oversight, not as a customer support inbox. The same SMS text is sent to the original recipient and to the admin number(s), and all recipients are included in the provider request and stored in the same log entry.

Sales​

  • Send SMS on order status change — toggles automatic SMS sending when an order's status changes. Requires the store checkout/orders plugin to support the order status change event.
  • When enabled, a message textarea appears for each order status, per site (so you can have different wording per language/store). Each textarea has a live character counter (max 1000 characters) matching the SMS provider limit. Leave a status message empty to skip sending for that status.

Order-status SMS uses the order's shipping phone number. The initial checkout purchase event sends the configured pending status message, and later status changes send the message configured for the new status handle. If a multi-site project has no text for the order's site, SMS Brana skips that status instead of falling back to unrelated wording.

Testing​

Use this tab to verify configuration before enabling live sending:

  • Phone Number / Message — send an arbitrary test SMS to one or more numbers (comma-separated), optionally scheduled for a specific date/time.
  • Order status testing — only shown when Send SMS on order status change is enabled. Pick a configured order status and send its exact message text to a test number.
  • Booking reminder testing — only shown when Send SMS on reservation reminder is enabled. Pick a configured booking/reservation type and send its message text to a test number. Links directly to the Booking Hub reminder message settings.

All test sends are logged with source manual-test.

If Send At is filled, the selected date/time is passed to SmsConnect as a scheduled send option. The provider response still determines whether SMS Brana records the attempt as sent or failed.

API Credentials​

  • Username — the SmsConnect login received from smsbrana.cz.
  • API Password — the SmsConnect API password received from smsbrana.cz.

Both fields are required when the plugin is enabled. These fields can be overridden per Craft site via multi-site environment overrides (username, password, and sandboxMode are site-overridable).

  • Balance — read-only field showing the SmsBrana account's remaining credit. The Settings page fetches this from the SmsConnect API (action=info) each time the page loads. It shows 0 when the plugin is disabled, sandbox mode is on, credentials are missing, or the API request fails — it does not indicate an error in that case, just that no live balance could be retrieved.

Details panel (top right)​

  • Enabled — turns the plugin's sending behavior on/off. Credentials are only required while enabled.
  • Global SMS Pause — pauses all outgoing SMS (order status, reminders, manual test, and MCP-triggered sends) without disabling the plugin or clearing its configuration. Use this as an emergency kill switch; sends are silently skipped and logged as an activity note while paused.
  • Show in CP Section — shows/hides the SMS Brana entry in the main Craft CP navigation sidebar. The Settings page itself remains reachable either way.

Sandbox mode​

When sandboxMode is enabled, the plugin ignores the configured username/password and connects to SmsConnect with fixed sandbox test credentials (user / passwd), so messages can be sent through the provider's test environment without risking a real credit balance. The setting is site-overridable, just like username and password.

Use sandbox mode on development and staging environments when you want to verify integration flow without spending live SMS credit. Turn it off on production once the real SmsConnect credentials and billing are ready.

Reservation reminders​

sendOnReservationReminder and its per-reservation-type message list are used by the reminder-sending logic, but they are not edited in the main SMS Brana settings tabs. When SMS Brana is enabled and Booking Hub is installed, SMS Brana adds its own SMS Brana panel to Booking Hub -> Settings -> Reminders. That panel lets you:

  • enable/disable SMS sending for reservation reminders;
  • write separate SMS text for the supported reminder types (event and appointment);
  • use the placeholders {event}, {start_date}, {time_range}, and {address}.

Those placeholders are replaced with the reservation reminder event details when the reminder is sent. If you manage settings through project config, the same values live under sendOnReservationReminder and sendOnReservationReminderList.

Logs and exports​

The plugin stores one log row for each provider response. The row includes the creation date, recipient number list, message text, numeric status (1 for sent, 0 for failed), and source. The Logs page can filter by message text or phone number, exact/partial number, status, source, and date range. CSV export uses the active filters and includes dateCreated, number, message, status, and source.

If a send is skipped before the SmsConnect request is made, such as when Global SMS Pause is enabled, no SMS log row is created. In that case, check Craft activity/error logs for the plugin activity note.

See Developer API for sending SMS programmatically or via MCP tools.