Send guest receipts by e-mail and SMS
A receipt is the message that gives a guest their Wi-Fi user name, password and expiry. Airgate sends receipts by e-mail and by SMS when a guest registers on a portal, when an operator creates an account, and when an operator re-sends a receipt. This guide sets up both channels and the templates.
Before you begin
Section titled “Before you begin”- E-mail: the Airgate platform has an SMTP relay configured (Airowire
operates it for the cloud service). If it is not, every e-mail is logged
as
skippedwithSMTP is not configured. - SMS: an account with Twilio, or with an SMS provider that offers an HTTP API (URL, method, optional body and authentication).
- An administrator role with
guest:write(the tenant settings page also acceptsadmin:write).
Step 1: Configure e-mail delivery
Section titled “Step 1: Configure e-mail delivery”- Open Settings › General and find Guest e-mail delivery.
- Send e-mail: on. When off, e-mail receipts are logged as
skipped. - Reply-to address: the address replies should go to, for example
helpdesk@contoso.com. - From address (optional): used as the reply-to address when Reply-to address is empty.
- Subject prefix (optional): put in front of every subject, for example
[Contoso Wi-Fi]. - Select Save.
To test, enter an address under Send a test e-mail in the same section and select Send. The test uses the saved settings.
Step 2: Configure the SMS gateway
Section titled “Step 2: Configure the SMS gateway”In Settings › General › SMS gateway, turn on Send SMS and choose the Provider.
Twilio
Section titled “Twilio”| Field | Value |
|---|---|
| Provider | Twilio |
| Account SID | your Twilio account SID (AC…) |
| Auth token | the Twilio auth token (stored encrypted) |
| Sender | a Twilio number in E.164 form (+15551234567) or an alphanumeric sender ID |
Airgate posts to the Twilio Messages API with the account SID and auth token.
Generic HTTP API
Section titled “Generic HTTP API”| Field | Value |
|---|---|
| Provider | Generic HTTP API |
| Request URL | the provider’s endpoint. May contain {{to}}, {{message}} and {{from}} (URL-escaped), for example https://sms.example.com/send?to={{to}}&text={{message}} |
| HTTP method | POST or GET |
| Content type | for POST, for example application/json |
| Request body template | for POST, for example {"to":"{{to}}","text":"{{message}}","from":"{{from}}"}. Values are escaped for the content type (JSON, form or XML). |
| Authentication | None, HTTP Basic (Username, Password) or Bearer token (Auth token) |
| Sender | the sender number or ID, available as {{from}} |
| Success pattern | optional regular expression the response body must match |
Any answer outside HTTP 2xx is a failure. Extra request headers (for
example an API key header) can be set through the API
(PUT /api/v1/t/{tenant}/guest-settings, sms.headers); header names
containing auth, key, token, secret or pass are stored encrypted.
Limits for both providers
Section titled “Limits for both providers”- Timeout: 1 to 30 seconds (default 10).
- Rate limit: messages to one phone number per hour (default 5). This
protects self-registration portals against SMS abuse. Over the limit, the
message is logged as
failedwithSMS rate limit reached for this number. - Phone numbers are normalised: spaces, dashes, dots, slashes and brackets
are removed and
00becomes+. A number needs 6 to 15 digits.
Select Save, then use Send a test SMS with your mobile number.
Step 3: Edit the receipt templates
Section titled “Step 3: Edit the receipt templates”Templates are plain text with {{variable}} placeholders. Unknown
placeholders become empty.
| Variable | Value |
|---|---|
{{username}}, {{password}} |
Credentials. {{password}} shows (not shown) when Airgate does not know it, and (none) for password-less accounts. |
{{name}}, {{email}}, {{phone}}, {{company}} |
Visitor details |
{{sponsor_name}}, {{sponsor_email}} |
Sponsor |
{{role}}, {{start_time}}, {{expire_time}} |
Role, activation and expiry (never for no expiry), in the tenant time zone |
{{portal}}, {{mac}} |
Portal name, registered device MAC |
| any custom field name | The account’s custom field |
Where the templates live:
- Per portal: Guests › Guest portal › your portal › Receipts. E-mail receipt (Subject, Body) and SMS receipt (Message), each with Send automatically. Used for guests who register on that portal, and for accounts an operator links to the portal with Portal (receipt templates).
- Tenant default: Guests › Guest accounts › Defaults › Receipts for accounts without a portal.
Default e-mail subject: Your guest network account. Default SMS:
Wi-Fi login {{username}} / {{password}} valid until {{expire_time}}.
Step 4: Send receipts
Section titled “Step 4: Send receipts”- Self-registration: with Send automatically on, the receipt goes out right after registration to the e-mail address and phone number the visitor entered. With sponsors on, no receipt is sent to the visitor.
- Create account: in Guests › Guest accounts › Create account, tick E-mail and/or SMS under Send receipt to the guest.
- Re-send: on an account row, select Send receipt. Choose the Channels, optionally another Send e-mail to / Send SMS to address, and whether to Include the password in the receipt.
- Bulk: select accounts and choose Send receipts. Bulk receipts go to each guest’s own e-mail and phone.
Verify
Section titled “Verify”Open Guests › Guest accounts › Delivery log. Each message has a row with
Kind (Receipt, Test), Channel, Recipient, Status
(sent, failed, skipped) and the error in Detail. Message bodies are
never stored. Rows are kept 180 days.
Troubleshooting
Section titled “Troubleshooting”| Detail in the Delivery log | Cause | Fix |
|---|---|---|
SMTP is not configured |
The platform has no SMTP relay. | Contact Airowire support. |
e-mail delivery is disabled for this tenant |
Send e-mail is off. | Turn it on in Guest e-mail delivery. |
no valid e-mail address |
The account has no usable e-mail. | Add the e-mail to the account, or enter Send e-mail to. |
SMS gateway is not configured |
Send SMS is off. | Turn it on and save. |
no valid phone number |
The number has fewer than 6 or more than 15 digits. | Correct the account’s phone number. |
gateway answered HTTP 401 (or another code) |
The provider refused the request. | Check the credentials, URL and body against the provider’s documentation. |
gateway response did not match success_regex |
The provider answered 2xx but the body did not match Success pattern. | Fix the pattern or clear it. |
SMS rate limit reached for this number |
More than Rate limit messages to one number in an hour. | Wait, or raise the limit. |
gateway request failed: egress to … is not allowed |
The gateway URL resolves to a loopback or link-local address. | Use the provider’s public URL. |