SplitSMS platform documentation

SplitSMS is an enterprise-grade bulk and transactional SMS platform operated by Tecunit. Businesses use it for marketing campaigns, OTP verification, order notifications, and API-driven messaging across Ghana, Nigeria, and 190+ countries — with transparent pay-as-you-go pricing and no annual contracts.

1. Go to splitsms.com/signup and enter your name, email, and phone number.
2. Verify your phone with the 6-digit OTP sent by SMS.
3. Set a password and log in to the dashboard.
4. Your wallet starts with 5 free SMS credits for testing.

SplitSMS bills per SMS segment based on destination country and encoding (GSM-7 vs Unicode). Ghana rates start around GHS 0.029 per segment. View live rates on the Pricing page or Dashboard → Pricing.

• Wallet holds funds in your account currency (typically GHS)
• SMS credits are purchased from wallet balance at country-specific rates
• Each send deducts credits before the message is queued
• New accounts receive 5 free SMS credits for testing delivery

1. Open Dashboard → Send SMS.
2. Enter one or more phone numbers (international format, e.g. 233201234567).
3. Choose an approved Sender ID or request a new one under Sender IDs.
4. Write your message — GSM-7 is 160 characters per segment; Unicode uses 70.
5. Review the cost preview and click Send.

Delivery status appears in Dashboard → Message results and Transactions. Failed messages show the provider reason so you can fix balance, sender ID, or number format issues.

1. Download or install the plugin from the WordPress.org directory (search SplitSMS).
2. In wp-admin, click **Create free account** if you signed up from the website already, skip to API key.
3. Developers → API Keys — create key with **sms.send** and copy the full secret.
4. SplitSMS → Settings — paste key, select Sender ID, Test connection → Save.
5. SplitSMS → Forms or Integrations — enable the events you need.
6. Monitor sends on splitsms.com Dashboard → Integrations → WordPress.

Full step-by-step instructions are in the WordPress plugin chapter of this documentation.

• Home — overview, wallet balance, recent activity, onboarding checklist
• Send SMS — quick single or multi-recipient send
• Campaigns — scheduled bulk sends to contact groups
• Contacts — import CSV, tags, groups, and segmentation
• Sender IDs — register alphanumeric sender names (carrier approval)
• Wallet — top up credits, view transactions and invoices
• Reports — delivery stats, filters, and export
• API Keys — create live and sandbox keys with permissions
• Integrations — WordPress connected sites, plugin/WP/PHP versions, skip logs, delivery sync
• Settings — profile, password, phone verification
• Support — tickets for logged-in users

SplitSMS uses a prepaid wallet. Every sent SMS deducts credits based on destination country and message segments. Top up from Dashboard → Wallet using Paystack, Flutterwave, or MTN MoMo when enabled on your account.

• Pending payments complete after the provider webhook confirms funds.
• Transaction history lists top-ups and SMS debits.
• Invoices are available for accounting and reseller accounts.
• Insufficient balance blocks sends until you top up.

Recipients see your Sender ID as the message origin (e.g. MYBRAND). Each ID is submitted for approval and may be pending, approved, or rejected depending on carrier rules in Ghana and other routes.

1. Request a Sender ID from Dashboard → Sender IDs.
2. Wait for admin approval (typically 1–2 business days).
3. Use only approved IDs in the dashboard, API, and WordPress plugin.

When a WordPress site saves a valid API key, it registers under **Dashboard → Integrations → WordPress**. You see each connected site URL, plugin version, WordPress and PHP versions, and recent SMS activity synced from the plugin.

• Outdated plugin versions are flagged — update from wp-admin when a new release is available
• Skip logs explain why an SMS was not sent (no phone, disabled event, insufficient balance)
• Delivery status updates when the carrier confirms DLR (Sent → Delivered)
• Create API keys under Developers → API Keys — one key per site or environment is recommended

Contacts store phone numbers with optional name, email, country, and tags. Import a CSV with columns for phone, name, and email — invalid rows are reported before import.

• Search and filter by name, phone, or tag
• Bulk tag, delete, or add to groups
• Export contacts as CSV for backup
• API: GET/POST /api/v1/contacts for programmatic sync

1. Create a contact group and add members (or import first).
2. Go to Campaigns → New campaign.
3. Select the group, message, sender ID, and optional schedule time.
4. Confirm segment count and estimated cost.
5. Launch — messages queue and process in the background worker.

Campaign detail pages show sent, delivered, failed, and pending counts. You can retry failed recipients where the platform supports it.

In campaigns, use {name} and {phone} in the message body to personalize each recipient. Preview shows a sample substitution before send.

Always use international format without the plus sign. Ghana numbers start with 233 followed by 9 digits (e.g. 233201234567). Nigeria uses 234. The platform validates and normalizes numbers before routing.

Long messages are split into multiple billable segments. The Send SMS screen and API responses show segment count before you confirm. Unicode in a single word switches the entire message to UCS-2.

• Queued — accepted by SplitSMS, awaiting worker dispatch
• Sent — handed to upstream carrier
• Delivered — handset or carrier confirmed delivery (where supported)
• Failed — rejected or expired; reason shown in reports
• Pending — in transit; may update via webhook or polling

All requests use HTTPS and JSON. Authenticate with Authorization: Bearer YOUR_API_KEY. Production API base: https://www.splitsms.com/api/v1. See the full API reference for every endpoint, schema, and cURL example.

curl -X POST 'https://www.splitsms.com/api/v1/sms/send' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "sender": "MYBRAND",
    "recipients": ["233201234567"],
    "message": "Hello from SplitSMS"
  }'

Successful responses include message IDs and initial status. Poll GET /api/v1/messages or configure webhooks for delivery updates.

1. POST /api/v1/otp/send — sends a one-time code to the recipient
2. Store the returned reference server-side
3. POST /api/v1/otp/verify — submit the code the user entered
4. Use sk_test_ keys in development to validate without billing

Register HTTPS endpoints under Developers → Webhooks. Payloads include event type, message ID, status, and timestamp. Each request is signed with HMAC-SHA256 using your webhook secret.

// Verify X-SplitSMS-Signature (pseudocode)
const crypto = require("crypto");
const expected = crypto
  .createHmac("sha256", WEBHOOK_SECRET)
  .update(rawBody)
  .digest("hex");
if (expected !== signature) throw new Error("Invalid signature");

SplitSMS is a cloud SMS platform at splitsms.com. The WordPress plugin connects your site to your SplitSMS account using an API key. When an event happens (order placed, form submitted, user registered), the plugin builds a message from your template, sends it through the SplitSMS API, and logs the result in wp-admin and your SplitSMS dashboard.

1. Create a free account on splitsms.com — starter SMS credits included.
2. Generate an API key (Developers → API Keys) with **sms.send** permission.
3. Install the plugin on WordPress and paste the key under SplitSMS → Settings.
4. Enable integrations (WooCommerce, WordPress core, Crocoblock) or configure per-form SMS.
5. Messages debit your SplitSMS wallet; delivery status syncs back to SplitSMS → Logs and Dashboard → WordPress.

1. **WordPress.org:** Plugins → Add New → search “SplitSMS” → Install → Activate.
2. **Manual:** Download [SplitSMS-v1.7.2.zip](https://www.splitsms.com/wordpress-plugin/SplitSMS-v1.7.2.zip) from [Integrations → WordPress](/integrations/wordpress).
3. Plugins → Add New → Upload Plugin → choose the zip → Activate.
4. If upgrading from an old manual install, deactivate and remove any splitsms* folders under wp-content/plugins/ first.
5. Open **SplitSMS** in wp-admin. If you do not have an account yet, click **Create free account**.
6. Paste your API key under **Settings** → Test connection → Save → send a test SMS on **Dashboard**.

WordPress.org installs show **Create free account** links in the plugin sidebar, Settings page, Dashboard banner, and Plugins list. These open splitsms.com/signup with UTM tracking so you can return and paste your API key.

1. Sign up at splitsms.com — verify email and log in.
2. Dashboard → Wallet — add credits or use starter balance.
3. Dashboard → Sender IDs — register or select your sender name (required for most routes).
4. Developers → API Keys → Create key — enable **sms.send** (and **sender_ids.read** for the sender picker).
5. Copy the **full** key at creation (~56 characters). The dashboard only shows a prefix afterward.
6. WordPress → SplitSMS → Settings — paste key, pick Sender ID, set admin phone → Test connection → Save.

When connected, the top banner shows your SplitSMS account status, plugin version vs splitsms.com, WordPress version, and PHP version. Outdated plugin versions show an update notice.

The plugin stores your API key in WordPress options. On save, it validates against splitsms.com/account/status. Connected sites register with Dashboard → WordPress integration so you can monitor version and activity from the cloud.

• Test connection before save — invalid keys are rejected
• Settings merge on plugin update — keys and templates are preserved
• Skip reasons (no phone, disabled event) sync to your SplitSMS dashboard
• Delivery status polls splitsms.com/messages/{id} — logs update from Sent to Delivered
• Local dev: API base URL auto-suggests http://127.0.0.1:3000 on .local sites when WP_DEBUG is on

**SplitSMS → Forms** scans your site for Contact Form 7, WPForms, Elementor Pro forms, JetFormBuilder, and JetEngine legacy forms. Each row shows the form title, plugin source, and controls to enable SMS without touching form builder code.

1. Open SplitSMS → Forms → **Refresh list** after adding new forms.
2. Toggle **Send SMS** on for the form you want.
3. Select the **phone field** from the dropdown (tel fields are auto-detected).
4. Edit the **message template** — use {name}, {phone}, {form_title}, {site_name}, and field_* placeholders.
5. Optional: enable **Admin copy** to SMS your admin phone on every submission.
6. Save. Submit a test entry and check SplitSMS → Logs.

When a native action is configured on a form, the plugin skips duplicate global hooks for that submission. Macros: **%phone%** (submitted phone), **%post_id%** (current post), **%user_id%** (logged-in user). Message templates also support {field_name} placeholders from form data.

1. Connect API key first — actions show a connect notice until configured.
2. Add the action in your form builder (not in SplitSMS admin).
3. Pick the phone field from the dropdown populated from your form fields.
4. Write your SMS template; test with a real submission.
5. Check Logs — skip reasons explain missing phone or validation failures.

Under **SplitSMS → Integrations → WordPress core**, enable welcome SMS on user registration and optional password reset via SMS.

• Phone is read from user meta **billing_phone** or **splitsms_phone**
• Password reset SMS replaces the email when a phone exists; otherwise WordPress email is kept
• Templates support {site_name}, {customer_name}, {reset_link}

Enable events under SplitSMS → Integrations. SMS is sent to billing phone, then shipping phone, custom order meta, or user meta if billing is empty. HPOS (custom order tables) and block checkout are supported.

• Events: order placed, payment complete, paid → processing, processing, completed, cancelled, failed, refunded, shipped (tracking)
• Paystack / Flutterwave / Stripe — SMS fires when WooCommerce marks the order paid (no direct gateway API)
• COD/BACS payment SMS only when the order is marked paid

JetEngine, JetFormBuilder, JetBooking, and JetAppointment modules live under **SplitSMS → Crocoblock**. Map phone fields, edit every event template, and use optional conditional rules (JSON) for status-based SMS.

• JetFormBuilder — native **Send SMS** in Post Submit Actions (recommended per-form control)
• JetEngine legacy forms — **Send SMS** notification type in form builder
• JetBooking / JetAppointment — reminder SMS via WP-Cron before check-in or appointment
• Per-module toggles work independently of the master Crocoblock switch
• Activity tagged by source in WordPress logs and your SplitSMS dashboard

When your API key is saved, the plugin registers your site with splitsms.com. Open **Dashboard → Integrations → WordPress** to see connected sites, plugin version, WordPress/PHP versions, recent activity, and skip logs.

• Outdated plugin versions are flagged so you know when to update
• Cloud log sync sends send/skip/fail events to your SplitSMS account
• Delivery status updates appear in both WordPress Logs and the dashboard
• Disconnect by removing the API key in WordPress Settings

1. **WordPress.org:** Dashboard → Updates → Update SplitSMS when available.
2. **Manual:** Download latest zip from [Integrations → WordPress](/integrations/wordpress) → Plugins → Add New → Upload.
3. Settings → **Replace from splitsms.com** — reinstall in place when upload says folder exists.
4. API keys, templates, and toggles are preserved when you update.

See Changelog for release notes. Plugin Help page in wp-admin mirrors this guide.

• Rotate API keys immediately if exposed — revoke old keys in App connections
• Use separate keys per environment (production vs staging)
• Restrict key permissions to the minimum required scope
• Enable webhook signature verification on every endpoint

Obtain consent before promotional SMS. Include opt-out instructions where required by local law. Transactional messages (OTP, order updates) should clearly identify your brand via an approved Sender ID.

Read our Privacy Policy, Terms, and Data Protection pages for how Tecunit processes account and message metadata.

• PHP: composer config repositories.splitsms composer https://www.splitsms.com/sdk/php/ then composer require splitsms/sdk
• Flutter: download https://www.splitsms.com/sdk/flutter/splitsms-flutter.zip — path dependency (see [SDK page](/sdk))
• Postman: import the collection from Developers → Postman
• Install manifest: /sdk/manifest.json — all packages hosted on SplitSMS

• not_configured — paste full API key (~56 chars), not prefix only
• no_billing_phone — add phone to checkout or custom meta key
• wc_*_skipped / cf7_*_skipped — event disabled or phone missing; synced to dashboard
• JetFormBuilder action missing — add Send SMS (SplitSMS) under Post Submit Actions
• Connection test fails — check SSL, firewall, and splitsms.com reachability

Report bugs, billing issues, or integration problems at Support. Logged-in users can open tickets under Dashboard → Help & support. Include message IDs, API request IDs, and WordPress log entries when possible.