Partner Program & App Referral Tracking

SMSBAT offers a dedicated referral infrastructure that allows developers, agency partners, and software vendors to monetize their integrations, CRM apps, and SaaS solutions.

---

1. Overview of Partner Monetization

When your application (such as a Shopify plugin, WooCommerce module, Bitrix24 app, Planfix extension, or custom software) sends messages through SMSBAT, the platform tracks and records all message volume dispatch linked to your unique referralGuid.

How Partner Earnings Work:

1. Unique Referral Endpoint: Every partner application receives a unique referralGuid.
2. Automated Volume Tracking: All outbound messages (SMS, Viber, RCS) sent through /bat/{referralGuid}/messagelist are credited to your partner account.
3. Revenue Share / Commission: You earn a percentage commission on every message sent by clients using your integration.

---

2. Technical Integration (API Endpoint)

Partner applications dispatch messages by passing their referralGuid in the API URL path. The endpoint supports both HTTP Basic Authentication and API Key Authentication (X-Authorization-Key).

Endpoint

POST https://restapi.smsbat.com/bat/{referralGuid}/messagelist

Option 1: HTTP Basic Authentication Example

curl -i -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic base64(login:password)" \
  -d '{
    "messages": [
      {
        "from": "Shopillect",
        "to": "380936670003",
        "type": "sms",
        "text": "Your order confirmation from Shopillect",
        "ttl": "120"
      }
    ]
  }' \
  "https://restapi.smsbat.com/bat/34e19d34-abef-4acd-8c94-bd38c0a543fd/messagelist"

Option 2: API Key Header Example

curl -i -X POST \
  -H "Content-Type: application/json" \
  -H "X-Authorization-Key: your-api-key" \
  -d '{
    "messages": [
      {
        "from": "Shopillect",
        "to": "380936670003",
        "type": "sms",
        "text": "Your order confirmation from Shopillect",
        "ttl": "120"
      }
    ]
  }' \
  "https://restapi.smsbat.com/bat/34e19d34-abef-4acd-8c94-bd38c0a543fd/messagelist"

---

## 3. Request Parameters

| Parameter | Type | Description |
|---|---|---|
| `{referralGuid}` | `string (guid)` | Path parameter holding your partner application referral GUID |
| `messages` | `array` | List of message payloads |
| `from` | `string` | Sender Alpha Name |
| `to` | `string` | Recipient phone number in E.164 format |
| `type` | `string` | Message type (`sms`, `viber_promo`, `viber_trans`, `rcs`, `flashcall`) |
| `text` | `string` | Message body text |
| `ttl` | `string/int` | Time-to-live in seconds |

---

## 4. How to Join the Partner Program

1. Register a partner account at SMSBAT.
2. Generate or request your unique **`referralGuid`** for your integration.
3. Configure your application's API requests to use `https://restapi.smsbat.com/bat/{referralGuid}/messagelist`.
4. Monitor message traffic, volume analytics, and your referral commission payouts inside the SMSBAT Partner Dashboard.