Using it

Configuration

Everything on this page lives on the addon's Settings tab, inside WHMCS. Open the addon from the Addons menu; Settings is the tab you land on.

API Key

Required. This is what lets the addon send through your platform account.

  1. In your dashboard, go to Tools → API Keys and create a key.
  2. Give it the sms_send and wa_send permissions. Both are selected by default when you add a key — leave them selected.
  3. Paste the key into API Key and save.

The field's help text links straight to that page on your own install, so you do not have to go looking for it.

The saved key is never shown back to you. After the first save the field is blank and reads “A key is already saved — leave blank to keep it”. Leaving it blank keeps the stored key; typing a new one replaces it. It is not displayed even as dots, because a masked field still carries the key in the page itself — and that key can send across your whole platform account.

Give the addon its own key rather than reusing one. If it is ever misused you can delete that one key without breaking anything else you have connected.

Sending Service

Choose SMS or WhatsApp. This is the single switch that decides which of the fields below matter — the rest are ignored.

ServiceFields that applyFields ignored
SMS Device Unique ID, Gateway Unique ID, SIM Slot WhatsApp Account ID
WhatsApp WhatsApp Account ID Device Unique ID, Gateway Unique ID, SIM Slot

The form groups them under SMS delivery and WhatsApp delivery headings for exactly this reason. Fields outside the group you chose are still editable — they are simply not used.

One service is in force at a time. There is no per-template choice and no automatic fallback from one to the other.

WhatsApp Account ID

WhatsApp service only, and required for it. This is the unique ID of one of your linked WhatsApp accounts. Find it in your dashboard on the WhatsApp accounts list — there is a Copy Unique ID action on each account.

Leave it empty with WhatsApp selected and nothing will send; the failure comes back as a rejection from your platform, recorded in the WHMCS module log.

The two SMS routes

With SMS selected, which route is used depends only on whether Device Unique ID is filled in:

Device Unique IDWhat happens
Filled in Sent from your own Android device, on the SIM you chose. Nothing is deducted from your credit balance.
Left blank Sent using credits, through the Gateway Unique ID you supplied.

So a Device Unique ID always wins. If you meant to send with credits and messages keep going out from a handset, that field is why.

Device Unique ID

Your own Android device, from the devices list in your dashboard — each row has a Copy Device Unique ID action. Leave it blank to send with credits instead.

Gateway Unique ID

Used only when Device Unique ID is blank. It identifies the gateway — or the shared partner device — that the message is sent through, and the send is deducted from your credit balance.

SIM Slot

SIM 1 or SIM 2. Applies only when a Device Unique ID is set; on a single-SIM handset leave it on SIM 1. It has no effect at all on the credits route or on WhatsApp.

Date Format

How dates are written in messages that contain {duedate} or {expirydate}. Three placeholders, and only these three:

PlaceholderMeans
%dDay
%mMonth
%yYear, in full

The default is %d.%m.%y, which renders 2026-03-09 as 09.03.2026. %m/%d/%y gives 03/09/2026. Anything you put between them — dots, slashes, dashes, spaces — is kept as typed. Leave the field empty and dates are sent exactly as WHMCS stores them, i.e. 2026-03-09.

Saving

Save Configuration writes the whole form. Two things to expect:

  • If a value is rejected, nothing is saved and the form comes back with what you typed still in it — you do not have to retype the page.
  • If you left a form open for a long time and the save reports that your session expired, sign in again and re-save. Nothing was written.