Triggering API Campaigns¶

An API Campaign is a reusable messaging configuration created and managed in the Abelo CMS. It defines how a message should be sent, including the channel, sender, message template, category, and optional fallback settings.

Once an API Campaign is active, your application can trigger individual message dispatches programmatically through the Abelo REST API. Messages can be delivered through Viber Business Messages (with optional SMS fallback) or directly through SMS.

This guide explains how to configure an API Campaign and use it to send personalized, on-demand messages from backend applications, authentication services, e-commerce platforms, and other integrated systems.

1. Create and Activate an API Campaign in the CMS¶

Before triggering messages through the API, create and configure an API Campaign in the Abelo CMS:

1. Navigate to Campaigns > API Campaigns > New Campaign in the Abelo CMS.
2. Select the primary messaging channel: Viber Business Messages ( If Viber is selected, you can optionally enable SMS Fallback) or SMS
3. Select the campaign category: OTP, Transactional, or Promotional
4. Select a template & configure the delivery options
5. Set the campaign status to Active.
6. Copy the campaign's Public ID (e.g. c-8Fa...).

2. API Request Specification¶

Endpoint: POST /v1/messages/send
Authentication: Authorization: Bearer <key_id>:<key_secret> (requires messages:send scope)
Content-Type: application/json

Request Body Fields¶

3. Recipient Resolution & Consent Rules¶

4. Code Examples¶

Example A: Send an OTP Verification Code¶

curl -X POST https://api.abelo.ai/v1/messages/send \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ak_01J8K92M4:as_9f8a7b6c5d4e3f2a1b0c" \
  -d '{
    "campaign_id": "cmp_01J8K92M4_OTP",
    "recipient": {
      "type": "phone_number",
      "value": "+306912345678"
    },
    "params": {
      "code": "582914"
    },
    "client_reference": "auth_req_8921"
  }'

import httpx

AUTH_TOKEN = "ak_01J8K92M4:as_9f8a7b6c5d4e3f2a1b0c"
API_URL = "https://api.abelo.ai/v1/messages/send"

payload = {
    "campaign_id": "cmp_01J8K92M4_OTP",
    "recipient": {
        "type": "phone_number",
        "value": "+306912345678"
    },
    "params": {
        "code": "582914"
    },
    "client_reference": "auth_req_8921"
}

response = httpx.post(
    API_URL,
    headers={
        "Authorization": f"Bearer {AUTH_TOKEN}",
        "Content-Type": "application/json"
    },
    json=payload
)

data = response.json()
print(f"Message Status: {data['status']}, ID: {data['message_id']}")

const AUTH_TOKEN = "ak_01J8K92M4:as_9f8a7b6c5d4e3f2a1b0c";
const API_URL = "https://api.abelo.ai/v1/messages/send";

async function sendOtp() {
  const response = await fetch(API_URL, {
    method: "POST",
    headers: {
      "Authorization": `Bearer ${AUTH_TOKEN}`,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      campaign_id: "cmp_01J8K92M4_OTP",
      recipient: {
        type: "phone_number",
        value: "+306912345678"
      },
      params: {
        code: "582914"
      },
      client_reference: "auth_req_8921"
    })
  });

  const data = await response.json();
  console.log("OTP Dispatch Response:", data);
}

sendOtp();

Example B: Send a Transactional Order Confirmation with Per-Message Webhook¶

curl -X POST https://api.abelo.ai/v1/messages/send \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ak_01J8K92M4:as_9f8a7b6c5d4e3f2a1b0c" \
  -d '{
    "campaign_id": "cmp_01J8K92M4_ORDER",
    "recipient": {
      "type": "phone_number",
      "value": "+306912345678"
    },
    "params": {
      "first_name": "Maria",
      "order_number": "ORD-4921",
      "tracking_url": "https://carrier.com/track/4921"
    },
    "client_reference": "order_4921",
    "webhook_url": "https://api.myshop.com/webhooks/delivery"
  }'

import httpx

AUTH_TOKEN = "ak_01J8K92M4:as_9f8a7b6c5d4e3f2a1b0c"
API_URL = "https://api.abelo.ai/v1/messages/send"

payload = {
    "campaign_id": "cmp_01J8K92M4_ORDER",
    "recipient": {
        "type": "phone_number",
        "value": "+306912345678"
    },
    "params": {
        "first_name": "Maria",
        "order_number": "ORD-4921",
        "tracking_url": "https://carrier.com/track/4921"
    },
    "client_reference": "order_4921",
    "webhook_url": "https://api.myshop.com/webhooks/delivery"
}

response = httpx.post(
    API_URL,
    headers={
        "Authorization": f"Bearer {AUTH_TOKEN}",
        "Content-Type": "application/json"
    },
    json=payload
)

print(response.status_code, response.json())

5. Response Structure & Status Codes¶

Successful Dispatch (200 OK)¶

{
  "message_id": "0191636f-bcf0-7813-9f89-8d7681728271",
  "status": "sent",
  "client_reference": "auth_req_8921",
  "error": null
}

Response Attributes¶

HTTP Status Code Catalog¶