Skip to main content

ClickSend SMS Provider Configuration

FS PBX supports two-way SMS messaging via ClickSend. This guide explains how to:

  • Add ClickSend credentials to your .env

  • Retrieve the Subaccount ID used to authenticate inbound messages

  • Enable ClickSend on phone numbers in Message Settings

1. Required Environment Variables​

Add the following variables to your .env file:

CLICKSEND_USERNAME=
CLICKSEND_SUBACCOUNT_ID=
CLICKSEND_API_KEY=
CLICKSEND_BASE_URL=https://rest.clicksend.com

What Each Value Does​

VariablePurpose
CLICKSEND_USERNAMEAPI username used for outbound API calls to ClickSend.
CLICKSEND_SUBACCOUNT_IDThe ID of a ClickSend subaccount used by FS PBX to validate inbound webhook requests (not used for outbound).
CLICKSEND_API_KEYAPI key paired with CLICKSEND_USERNAME for outbound authentication.
CLICKSEND_BASE_URLBase URL for ClickSend's REST API. Default: https://rest.clicksend.com.

Important:
Outbound SMS authentication uses CLICKSEND_USERNAME + CLICKSEND_API_KEY.
The CLICKSEND_SUBACCOUNT_ID is only used when FS PBX verifies inbound webhook payloads from ClickSend.

2. Getting Your ClickSend API Username & API Key​

  1. Log in to your ClickSend dashboard.

  2. From the left-hand menu, go to:
    Developers → API Credentials

    ClickSend API Credentials

  3. Here you can:

    • See or regenerate your API Username and API Key

Copy:

  • The API Username → CLICKSEND_USERNAME

  • The API Key → CLICKSEND_API_KEY

These will be used for outbound SMS requests from FS PBX.

3. Finding the subaccount_id (for inbound auth)​

FS PBX uses the ClickSend Subaccount ID to authenticate inbound messages received via webhook. This helps ensure that only messages from the expected ClickSend subaccount are processed.

Step 1 -- Open API Documentation​

  1. In the left menu, go to:
    Developers → API Documentation

This opens ClickSend's interactive API docs.

ClickSend API Documentation

Step 2 -- Use the "View Subaccounts" Endpoint​

  1. In the API docs, navigate to:
    Account → Subaccounts → View Subaccounts (GET /v3/subaccounts)

  2. Use Basic Auth with:

    • Username = your ClickSend API username

    • Password = your ClickSend API key

  3. Click Send.

You'll see a JSON response listing subaccounts, e.g.:

{ "subaccount_id": 123456, "api_username": "your_subaccount_username", "api_key": "xxxxxxxx", ... }

ClickSend View Subaccounts

  1. Choose the subaccount you want to use for inbound SMS and copy its subaccount_id, then set:

CLICKSEND_SUBACCOUNT_ID=123456

FS PBX will compare this ID against incoming webhook data to ensure inbound messages are coming from the correct ClickSend subaccount. It does not affect outbound authentication.

4. Apply Configuration Changes​

After updating .env, reload Laravel's configuration cache:

php artisan config:cache

If you skip this, FS PBX will continue using old values and ClickSend may not work correctly.

To enable inbound SMS via ClickSend, configure a webhook to send messages to FS PBX.

In ClickSend:

  1. Go to SMS → inbound configuration (or equivalent section).

  2. Set the Inbound SMS Webhook URL to:

https://your-domain/webhook/clicksend/sms

When ClickSend posts an inbound message:

  • FS PBX receives the payload at /webhook/clicksend/sms

  • FS PBX checks the subaccount information in the payload against CLICKSEND_SUBACCOUNT_ID

  • If it matches, the message is accepted and routed to the correct extension

6. Enable ClickSend on a Phone Number in FS PBX​

Once credentials and (optionally) webhooks are configured:

  1. Go to Advanced → Message Settings in FS PBX.

  2. Add or edit a phone number.

  3. Select ClickSend as the SMS provider.

  4. Assign:

    • An extension → inbound SMS will appear in the FS PBX mobile app for that user.

    • Optionally an email address → for read-only email notifications.

Then:

  • Inbound SMS → ClickSend → FS PBX → Extension's Mobile App

  • Replies from the app → FS PBX (using CLICKSEND_USERNAME + CLICKSEND_API_KEY) → ClickSend → Original sender

Summary​

To integrate ClickSend with FS PBX:

  1. Set CLICKSEND_USERNAME, CLICKSEND_API_KEY, CLICKSEND_SUBACCOUNT_ID, and CLICKSEND_BASE_URL in .env.

  2. Remember:

    • Outbound = CLICKSEND_USERNAME + CLICKSEND_API_KEY

    • Inbound auth = CLICKSEND_SUBACCOUNT_ID

  3. Run php artisan config:cache.

  4. (Optional) Configure inbound SMS webhooks to /webhook/clicksend/sms.

  5. Assign ClickSend as the provider for numbers in Message Settings.

If you want, next we can put together a short "SMS Providers Index" page that links to all five provider articles with a one-line summary for each.