SplitSMS Connect — embed SMS in your product

SplitSMS Connect turns your SplitSMS partner account into an embedded SMS platform. Your application creates sub-accounts for end customers, funds their wallets, registers branded sender IDs, and sends transactional or marketing SMS — while SplitSMS handles delivery, compliance routing, billing meters, and dashboard tooling.

Connect is designed for partners who resell or bundle SMS: CRMs, ecommerce platforms, WordPress agencies, fintech apps, and internal tools that need per-tenant SMS without operating a telco stack.

• SaaS onboarding — create a Connect customer when a tenant signs up; grant starter SMS credits.
• Agency model — one partner wallet, many client sender IDs and WordPress sites under Connect.
• Marketplace billing — map external_ref to your seller ID; top up credits from your billing system.
• Mobile or web apps — send OTP and notifications via REST without exposing your master API key to each user.
• WooCommerce networks — install the SplitSMS plugin on client stores; events sync to your dashboard.

1. You apply for or enable Connect on your SplitSMS partner account and create an API key with connect.customers permission.
2. Your backend calls POST /connect/customers when a user or tenant should receive SMS capabilities.
3. SplitSMS creates a member account, wallet, and optional starter credits — linked to your partner via ConnectCustomer.
4. You register sender IDs (partner-wide or per customer) and send SMS through /sms/send.
5. Customers may use the SplitSMS dashboard, API keys, or WordPress plugin under your commercial terms.

1. Sign in to SplitSMS and open App connections → API keys.
2. Create a live key with connect.customers, sender_ids.read, sender_ids.write, and sms.send.
3. Store the full key securely — it is shown only once at creation.
4. Call GET /balance to verify authentication, then provision your first test customer.
5. Open Connect hub to monitor wallets, keys, and provisioned customers.

POST /connect/customers creates (or returns) a customer linked to your partner account. Required fields: full_name, phone, country_code. Use external_ref to store your primary key from CRM, Stripe, or WordPress user ID.

POST https://www.splitsms.com/api/v1/connect/customers
Authorization: Bearer YOUR_PARTNER_API_KEY
Content-Type: application/json

{
  "full_name": "Acme Shop",
  "phone": "233201234567",
  "country_code": "GH",
  "email": "owner@acme.example",
  "external_ref": "your_crm_id_123",
  "label": "Acme Shop (WooCommerce)",
  "initial_sms_credits": 100,
  "initial_wallet_balance": 0,
  "currency": "GHS"
}

List customers with GET /connect/customers?limit=50 or fetch one with GET /connect/customers/{id} using Connect link id, customer user id, or external_ref.

Sender IDs identify your brand on outbound SMS. Register through the API or dashboard; approval times depend on destination country regulations. Connect partners pass customer_id to register on behalf of a provisioned customer.

POST https://www.splitsms.com/api/v1/sender-ids
Authorization: Bearer YOUR_PARTNER_API_KEY

{
  "value": "ACMEGH",
  "country_code": "GH",
  "purpose": "Transactional",
  "customer_id": "your_crm_id_123",
  "set_default": true
}

customer_id accepts the Connect link id, the customer’s SplitSMS user id, or your external_ref. List IDs with GET /sender-ids?customer_id=…

SplitSMS routes each message through carrier paths chosen for the recipient’s country. When smart routing is enabled on your account, the platform picks the active route automatically and fails over if a path is temporarily unavailable — you do not configure upstream carriers in Connect.

• Destination-aware routing for 190+ countries
• Automatic failover between registered routes
• Per-country pricing visible in the dashboard and on the public pricing page
• Delivery status and logs via API and webhooks

The Connect hub gives partners a single view of wallet balance, active API keys, provisioned customer count, routing mode, WordPress sites, and sender IDs. Use it alongside your own admin UI — the API remains the source of truth for automation.

POST https://www.splitsms.com/api/v1/sms/send
Authorization: Bearer CUSTOMER_OR_PARTNER_KEY

{
  "sender": "ACMEGH",
  "recipients": ["233201234567"],
  "message": "Your order is confirmed. Thank you for shopping with Acme.",
  "countryCode": "GH"
}

The official WordPress plugin connects WooCommerce, forms, and Crocoblock to SplitSMS using your API key. For agencies, each client site registers via POST /wordpress/connect and syncs logs to your account — ideal when Connect customers run their own stores.

• Order and payment SMS for WooCommerce
• Form plugins: Contact Form 7, WPForms, Elementor Pro, JetFormBuilder
• Per-event toggles and cloud log sync
• Auto-updates from SplitSMS — no manual zip installs after setup