Twilio SMS for GoCommerce

What it does

Configuration

The account SID and auth token are required, and so is one way to address a message: a from number or a messaging service. Set them in Config from your own main(), or leave Config empty and fill them in under Notifications › Setup SMS.

The module reads its Config struct, not the environment. The variable names are the ones the package’s own example or the reference binary uses; in your own main() you choose where each value comes from. Where a setting has a panel label, the admin’s settings drawer can hold it too, and a value typed there wins over Config.

Setting it up

1. Get the credentialsFrom the Twilio console: the account SID, the auth token, and either a number the store owns or a messaging service.
2. Install the moduleImport it and pass twilio.New to gocommerce.New, as below — or run the reference binary with -twilio, which reads the four TWILIO_ variables shown.
3. Fill in the settingsIn Config — a SID and token there start it switched on — or under Notifications › Setup SMS. A value typed into the panel counts on the next message, with no restart.
4. Edit the wordingThe texts for order placed, shipped, delivered and cancelled are the engine’s templates, edited on the Setup SMS screen.

import (
	"os"

	"github.com/itswadesh/gocommerce/core"
	twilio "github.com/itswadesh/gocommerce/ext/notify-twilio"
)

app, err := gocommerce.New(cfg,
	twilio.New(twilio.Config{
		AccountSID:          os.Getenv("TWILIO_ACCOUNT_SID"),
		AuthToken:           os.Getenv("TWILIO_AUTH_TOKEN"),
		From:                os.Getenv("TWILIO_FROM"),
		MessagingServiceSID: os.Getenv("TWILIO_MESSAGING_SERVICE_SID"),
	}),
)

How it works

• The engine’s words

  The body is the engine’s SMS template for the event — the panel’s edit if there is one, the default otherwise — rendered with Go’s text/template. There are no wording overrides in Config.

• Number or service, never both

  When a messaging service is set, the request carries MessagingServiceSid and no From; otherwise it carries the from number. Twilio refuses a request with both.

• Configured means it can send

  An account with no from number and no messaging service does not count as configured, so the Notifications screen cannot show a working channel that silently drops every text.

• Refusals settle, outages retry

  A 429 or 5xx is returned as an error and the engine retries the notification with backoff. Any other refusal is logged with Twilio’s code and more_info link, and settled.

• Every text written down

  Sent, with Twilio’s message SID and status; or not attempted because the module is not configured, with the event and the recipient.

• Empty texts are skipped

  An event with no SMS template, or a template that renders to nothing, sends nothing and is not an error.

What it does not do

Read these before an order depends on it. No store is known to run GoCommerce in production yet, so these come from the code, not from anyone’s experience.

• Four eventsThe engine has SMS wording for order placed, shipped, delivered and cancelled. Payment received and refunds have no SMS template, so they send no text.
• Numbers go as enteredThe shopper’s phone is sent to Twilio exactly as the order holds it. Twilio expects international form, so collect numbers with their country code.
• Refusals count as sentA text Twilio refuses returns no error, so the engine’s notification log records it as sent. The refusal is only in the application log.
• No delivery receiptsNo status callback is registered, so a text Twilio accepts and later fails to deliver is not reported back.
• Not the India moduleThe package’s own comparison: India requires SMS wording to be registered first, which is what the MSG91 module sends. This one sends free text.