Skip to content

v2.2.1

Choose a tag to compare

@github-actions github-actions released this 09 Nov 20:00

What's new

Outbound SMS and MMS API

FS PBX 2.2.1 lets your applications send messages through your existing messaging numbers and providers, using Telnyx-style requests and responses.

Highlights

  • Send SMS and MMS, including messages with attachments only, with up to 1,600 characters of text.
  • Start shared group conversations with at least two recipients: up to 20 with Sinch or 10 with supported Bandwidth local numbers. Duplicate recipients count once, the sender is excluded, and text-only groups are sent as MMS.
  • Use existing API keys and account access with the new messages_send permission, assigned by default to administrators and superadmins. Sending numbers must be enabled in Message Settings, but do not need assigned members.
  • Keep API messages in Status → Logs → Messages, outside member conversations. API replies do not clear members' unread messages.
  • Attach files from public HTTPS URLs and apply the account's photo conversion and compression settings. The default limits are 10 attachments and 50 MiB total downloaded input; ClickSend, Commio, and Fibernetics allow one attachment, and VoIP.ms allows three.
  • Prevent duplicate submissions with an optional Idempotency-Key. For 24 hours, identical retries by the same API user, account, and endpoint return the original message ID and acceptance response. Reusing the key with different message details returns HTTP 409.

Use POST /api/v1/domains/{domain_uuid}/messages for an individual recipient and POST /api/v1/domains/{domain_uuid}/messages/group_mms for groups. Both from and every to number must use E.164 format, such as +12025550100; national numbers are not accepted. HTTP 200 confirms that FS PBX accepted the request, not that the recipient received it.

Run the database migrations separately from app:update before using the new endpoints.

Outbound Delivery Webhooks

Receive delivery updates at the sending number's saved account or custom webhook, using the same signing secret as inbound message webhooks.

Highlights

  • Receive message.sent when the provider accepts a message and message.finalized when a final result is available. Results distinguish confirmed delivery, sending failures, delivery failures, and provider-reported unconfirmed delivery.
  • Track each group recipient separately, with a final group result once all recipients have a final outcome or the provider reports a result for the whole group.
  • Verify the Signature header with the account's shared signing secret.
  • Automatically retry failed webhook deliveries using the same event ID. Callback retries do not resend the SMS or MMS.
  • Download attachments linked in delivery events for 24 hours.
  • Check message delivery in Status → Logs → Messages and callback delivery in Status → Logs → Outbound Webhooks.

Numbers set to Members, or without an account webhook configured, can still send through the API. Delivery destinations are saved when a message is submitted, so later settings changes apply to subsequent messages. After provider acceptance, messages without a final receipt remain sent; FS PBX does not invent delivery confirmation.

Outbound Webhook History

The new Status → Logs → Outbound Webhooks view makes it easier to troubleshoot notifications sent from FS PBX to other applications.

Highlights

  • View pending, retrying, delivered, and failed notifications with their destination, attempt count, and HTTP response status.
  • Open Details to inspect individual attempts, timestamps, errors, and event IDs.
  • Filter by date, account, or delivery status, and search by event, ID, or destination URL. Account access follows your existing permissions.
  • Keep signing secrets, message payloads, and destination URL credentials out of this log; URL query values are redacted.

Automatic Message and Webhook Cleanup

Control how long FS PBX keeps SMS/MMS history, stored attachments, and messaging integration records.

Highlights

  • Optionally remove old SMS/MMS history and stored attachments, including original uploads retained after photo compression and message groups that become empty.
  • Preserve pending messages, messages with pending outbound delivery callbacks, and attachments still used by another message. Storage deletion failures leave the message available for a later cleanup attempt.
  • Clean up expired API request records and completed or failed outbound webhook history separately. These daily cleanup jobs are enabled by default with a 30-day retention period and preserve pending deliveries and retries.
  • Run cleanup on the selected Scheduled job server in redundant installations, with large backlogs processed in batches.

SMS/MMS history cleanup is disabled by default, with a 90-day retention period when enabled. Configure delete_old_messages and days_keep_messages under Advanced → Default Settings → scheduled_jobs. Enabling cleanup permanently removes older history and stored attachments across all accounts, including history that already exceeds the retention period on the first run. API and webhook history have separate enable and retention settings; their cleanup does not remove SMS/MMS history or attachments.

Improvements and fixes

  • Improved automatic certificate renewal on redundant servers using failover CNAMEs, including Azure Traffic Manager. Renewal follows the authoritative DNS chain and skips ambiguous or conflicting destinations.
  • Improved certificate renewal server detection behind NAT by discovering the server's outgoing public IP. That address must match its direct hostname.
  • Fixed voicemail waiting indicators after a voicemail is deleted following email notification. Phones receive the remaining unread and saved counts for the correct account and mailbox, including zero when the mailbox is empty.
  • Simplified the Messages log status summary to show the provider's message status without mixing in Ringotel, email, or webhook notification results.
  • Fixed newly added group permissions continuing to produce Forbidden (missing permission) responses because an earlier denial was cached.
  • Improved matching of carrier delivery reports to the correct outbound message when different providers reuse a reference ID. API delivery tracking also ignores repeated or outdated receipt updates.
  • Carrier submission errors and exceptions report sending failures. An attachment download failure does not silently send an incomplete MMS or turn it into an SMS.
  • Tightened public-address validation for webhook destinations and API attachment links. Attachment downloads reject redirects and enforce size and timeout limits.
  • Corrected the Users and Message Settings API list documentation so filters appear as query parameters instead of request-body fields.
  • Stabilized generated API examples for device creation, Message Settings, and Users so unchanged endpoints no longer produce random example changes.
  • Added outbound messaging and message retention guides, expanded the inbound webhook guide, and clarified certificate renewal setup for failover DNS and NAT.