ClickSend SMS (Wappler Server Connect)

Send SMS via ClickSend from Wappler Server Connect (Node): single messages, bulk send from a database query, price preview, and SMS campaigns to a ClickSend contact list.

Built by Mr Cheese.

Requirements

• Wappler Server Connect (Node)
• ClickSend account with API access
• Environment variables configured in the project (see below)
• axios npm package in the project (see Dependencies below)

Credentials (required)

Do not put API keys in extension step options (they are saved in API JSON and may be committed to Git).

Add to Wappler Project Settings → Environment (app/config/config.json under env):

| Variable | Description | |----------|-------------| | CLICKSEND_USERNAME | Your ClickSend API username (often your account email) | | CLICKSEND_API_KEY | Your ClickSend API key |

Restart the Node server after changing env values.

Installation

Official Wappler guide: How To Install Custom Wappler Extensions.

| Path | | |------|--| | npm | Wappler Project Settings → Extensions (wappler-clicksend-sms) | | Git | Extension Installer or manual copy below |

Git manual copy installs into extensions/ and lib/modules/.

Git install — Extension Installer (recommended)

This repo ships wappler-install.json at the root. Use the Mr Cheese Extension Installer — select ClickSend SMS, enable Use wappler-install.json from the repository, enter your Wappler project path, and run the generated copy script locally.

Manual install

Run from your Wappler project root (the folder that contains package.json). Skip git clone if you already have this repo cloned alongside your project.

git clone https://github.com/MrCheeseGit/Wappler-ClickSend-SMS-Extension.git ../Wappler-ClickSend-SMS-Extension

cp ../Wappler-ClickSend-SMS-Extension/server_connect/modules/clicksend.js lib/modules/
cp ../Wappler-ClickSend-SMS-Extension/server_connect/modules/clicksend.js extensions/server_connect/modules/
cp ../Wappler-ClickSend-SMS-Extension/server_connect/modules/clicksend_sendsms.hjson extensions/server_connect/modules/
cp ../Wappler-ClickSend-SMS-Extension/server_connect/modules/clicksend_calculateprice.hjson extensions/server_connect/modules/
cp ../Wappler-ClickSend-SMS-Extension/server_connect/modules/clicksend_sendcampaign.hjson extensions/server_connect/modules/

Quit Wappler completely and restart.

Upgrading: copy the same files again (especially clicksend.js), then restart Wappler and the Node server.

Actions appear under Mr Cheese:

• ClickSend Send SMS
• ClickSend Calculate SMS Price
• ClickSend SMS Campaign

npm install (Wappler Project Settings)

1. Wappler → Project Settings → Extensions → Add → wappler-clicksend-sms
2. From your project root: npm install
3. Quit Wappler completely and reopen your project.

Local file: development (optional)

"devDependencies": {
  "wappler-clicksend-sms": "file:../path/to/this-extension"
}

After you change extension source, run npm install again, then Project Updater if needed, and restart Wappler.

Dependencies (axios)

clicksend.js uses axios to call the ClickSend REST API. Each action HJSON declares it under usedModules so Wappler can add it to your project — but you must ensure it is actually installed before deploy.

In your Wappler project root:

npm install axios

Then commit both package.json and package-lock.json.

| Symptom | Cause | |---------|--------| | 500 · MODULE_NOT_FOUND · Cannot find module 'axios' | axios missing from node_modules on the server | | Works locally, fails on Docker/production | package-lock.json out of sync — npm ci installs only what the lockfile lists | | axios in package.json but still fails after deploy | Lockfile never updated — run npm install locally, commit lockfile, rebuild image |

Docker / WDP deploys almost always run npm ci --omit=dev. If axios is not in the lockfile, it will not be in the container even when it appears in package.json.

After npm install, restart the Node server (or redeploy).

Actions

Send SMS

| Mode | Use | |------|-----| | Single recipient | One number via data picker ({{$_GET.phone}}, etc.) | | Send to query results | Bind a prior Database Query step; pick the phone column (query-first pattern) |

Uses POST /v3/sms/send. Sends up to 1000 messages per API call; larger lists are split into batches automatically.

Calculate SMS Price

Same recipient options as Send SMS, but calls POST /v3/sms/price (no messages sent).

Send SMS Campaign

Sends to a ClickSend contact list by list_id (from your ClickSend dashboard). Uses POST /v3/sms-campaigns/send.

This does not read phone numbers from a Wappler query. For query-based bulk SMS, use Send to query results.

Typical workflows

Single SMS

API: ClickSend Send SMS
  Mode: Single recipient
  To: {{$_GET.phone}}
  Body: Your message
  From: +447... or YourBrand

Bulk from query

1. Database Query (SELECT)     ← phones + any filters
2. ClickSend Send SMS
     Mode: Send to query results
     Query results: {{contactsQuery}}
     Phone column: {{contactsQuery[0].mobile}}
     Body: Hello from our app

Campaign (ClickSend list)

1. Create list in ClickSend dashboard → note list_id
2. ClickSend SMS Campaign
     list_id: 428
     name: March promo
     body: Your message (include opt-out for marketing)
     from: Your sender ID

Response shape

All actions return an object suitable for App Connect:

{
  "success": true,
  "http_code": 200,
  "data": { },
  "error": null
}

Bulk send data includes total_sent, batch_count, and per-batch ClickSend responses.

Troubleshooting: API says success but no SMS arrives

ClickSend can return HTTP 200 and response_code: SUCCESS while queuing zero messages. Check the step output data.messages[].status (v1.0.1+ also sets success: false and a clear error).

| Symptom | Cause | Fix | |---------|--------|-----| | INVALID_SENDER_ID | From is not registered in your ClickSend account | Leave From empty (shared number, like a plain API connector step), or register the alpha tag / number in ClickSend first | | queued_count: 0 | Same as above, or invalid numbers | Fix From or To (E.164, e.g. +351...) |

Minimal working payload (no from):

{
  "messages": [
    { "source": "myapp", "to": "+351...", "body": "Your text" }
  ]
}

Notes

• Use E.164 phone format where possible (+447700900123).
• From (Sender ID): optional. If set, it must be an approved dedicated number or alpha tag in ClickSend; otherwise messages are not queued.
• ClickSend may restrict messages containing URLs for new accounts.
• Marketing SMS often requires an opt-out (e.g. “Reply STOP” or ClickSend StopMsg.me placeholder).
• Invalid or empty numbers in query mode are skipped; see skipped_invalid_numbers in the response.

v1.1 ideas

• Import query rows into a ClickSend list, then campaign send
• List picker (fetch contact lists from API)
• Cancel SMS, templates, delivery receipts

Works well with Generate Auth Code

Pair this extension with Generate Auth Code for Wappler for SMS verification flows:

Generate Auth Code  →  ClickSend Send SMS

1. Generate Auth Code — e.g. numeric, length 6
2. ClickSend Send SMS — bind body to include {{authCode.code}} and to to the user’s number

Typical uses: registration PIN, login OTP, password-reset codes sent by text. Both extensions appear under Mr Cheese in Server Connect.

Compatibility

Pairs with Generate Auth Code for SMS OTP. For shared patterns across Mr Cheese extensions, see Mr Cheese extension docs.

Links

• Generate Auth Code extension (GitHub)
• ClickSend SMS API
• Send SMS Campaign

License

Mr Cheese Extension License v1.0 — see LICENSE. © Mr Cheese