MSG91 order SMS for GoCommerce

What it does

Configuration

One setting is required: the auth key. Template ids decide which events are texted at all. Set them in Config from your own main(), or under Notifications › Setup SMS in the admin, where each order event has its own field.

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. Register the templatesIn MSG91, get a DLT-approved flow template for each message you want to send — most stores start with shipping — and note each id, and the auth key.
2. Install the moduleImport it and pass msg91.New to gocommerce.New, as below — or run the reference binary with -msg91, which reads MSG91_AUTH_KEY.
3. Map events to templatesUnder Notifications › Setup SMS, or in Config’s Templates map, give each event its template id. An event left empty sends nothing.
4. Name the variablesEach message carries the order’s values — order_number, customer_name, tracking, items_summary and more — as template variables. Use those names in the template.

import (
	"os"

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

app, err := gocommerce.New(cfg,
	msg91.New(msg91.Config{
		AuthKey: os.Getenv("MSG91_AUTH_KEY"),
		Templates: map[string]string{
			gocommerce.EventOrderShipped: "65a1b2c3d4e5f6",
		},
	}),
)

How it works

• One flow call per message

  Each SMS is one POST to MSG91’s /api/v5/flow/ with the template id and one recipient, whose fields are the number plus every value the engine sent with the event.

• Values, not wording

  The engine sends flat data — order number, status, totals in minor units, tracking, a one-line items summary — never rendered copy. The words are the DLT template’s.

• Only what has a template

  An event with no template id is skipped, not failed. So is every message while the module is switched off or has no key.

• The number, normalised

  Everything but digits is stripped. A ten-digit number without the country code gets it prefixed; one that already starts with it is left alone.

• Rejections are not retried

  MSG91 can answer 200 with type error. That, and any 4xx other than 429, is logged and dropped — a rejected message would only be rejected again.

• Every message on record

  The engine logs each notification and whether the module reported it sent. Keys and template ids are read on every message, so a change in the panel counts for the next one.

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.

• Order events onlyThe engine texts about order events and nothing else, and the cart-recovery module sends its reminders by email — so an abandoned basket is never texted.
• Config’s country code is shadowedThe panel’s country code defaults to 91 and is read before Config, so Config.DefaultCountryCode never takes effect. A store outside India changes it under Setup SMS.
• A retry can resend the emailA 429 or server error from MSG91 goes back to the engine, whose outbox redelivers the whole event — every subscriber runs again, the order’s email included.
• One testA single test covers idle, panel set-up, one send, the number and a skipped event. MSG91’s error answers — type error, 4xx, 429 — are not exercised by it.
• A refusal is logged as sentThe module cannot register or check a DLT template. When MSG91 refuses a message, the refusal goes to the process log, but the engine’s notification log records the message as sent.
• SMS onlyIt registers on the SMS channel. MSG91’s email, WhatsApp and voice products are not used.