📡 API Documentation

Copy$result = api('login', 'POST', [
    'email'    => '[email protected]',
    'password' => 'yourpassword',
]);
$token = $result['api_token'];

{"status":"success","api_token":"3b03e0a3...","user":{"id":1,"name":"John Dlamini","email":"[email protected]"}}

Copy$balance = api('balance');
echo "Balance: " . $balance['currency'] . $balance['balance'];

{"status":"success","balance":231.98,"currency":"E"}

Copy$stats = api('stats');
echo "Sent: " . $stats['stats']['sent'];
echo "Balance: E" . $stats['balance'];

{"status":"success","balance":231.98,"stats":{"sent":1420,"failed":3,"scheduled":2,"contacts":98},"chart":[{"date":"19 Apr","count":42},{"date":"20 Apr","count":87}]}

Copy$result = api('send', 'POST', [
    'to'      => '26876123456,26878654321',
    'message' => 'Hi {name}, your order is ready!',
]);
// Send to entire group
$result = api('send', 'POST', [
    'to'      => 'group:3',
    'message' => 'Special offer for VIP members!',
]);

{"status":"success","message":"SMS sent to 3 recipient(s)","msg_id":42}

Copy$messages = api('messages', 'GET', ['page' => 1, 'status' => 'sent']);
foreach ($messages['data'] as $msg) {
    echo $msg['id'] . " → " . $msg['status'];
}

{"status":"success","total":142,"data":[{"id":42,"recipients":"26876123456","message":"Hello!","status":"sent","credits_used":0.40,"sent_at":"2026-04-25 10:30:00"}]}

Copy$contacts = api('contacts', 'GET', ['group_id' => 2]);
foreach ($contacts['data'] as $c) {
    echo $c['name'] . " — " . $c['mobile'];
}

{"status":"success","data":[{"id":1,"name":"Jane Dlamini","mobile":"26876123456","group_id":2}]}

Copy$result = api('contacts', 'POST', [
    'mobile'   => '26876123456',
    'name'     => 'Jane Dlamini',
    'group_id' => 2,
]);

{"status":"success","message":"Contact added","id":15}

Copy$result = api('contacts', 'DELETE', ['id' => 15]);

{"status":"success","message":"Contact deleted"}

Copy$groups = api('groups');
foreach ($groups['data'] as $g) {
    echo $g['name'] . " (" . $g['contact_count'] . " contacts)";
}

{"status":"success","data":[{"id":2,"name":"VIP Customers","contact_count":45}]}

Copy$result = api('groups', 'POST', [
    'name'        => 'VIP Customers',
    'description' => 'Top tier clients',
]);

{"status":"success","message":"Group created","id":3}

Copy$senderIds = api('sender_ids');
foreach ($senderIds['data'] as $s) {
    echo $s['sender_id'] . " — " . $s['status'];
}

{"status":"success","data":[{"id":1,"sender_id":"MyBrand","status":"approved"}]}

Copy$result = api('sender_ids', 'POST', [
    'sender_id'   => 'MyBrand',
    'description' => 'Customer notifications for MyBrand eCommerce',
]);

{"status":"success","message":"Application submitted. Pending review."}

Copy$profile = api('profile');
echo $profile['data']['name'] . " — E" . $profile['data']['credits'];

{"status":"success","data":{"name":"John Dlamini","email":"[email protected]","phone":"26876123456","credits":231.98}}

Copy$result = api('profile', 'POST', [
    'name'  => 'John Dlamini',
    'phone' => '26876123456',
]);

{"status":"success","message":"Profile updated"}

Copy$txns = api('transactions', 'GET', ['page' => 1]);
foreach ($txns['data'] as $t) {
    $sign = $t['type'] === 'credit' ? '+' : '-';
    echo $sign . "E" . $t['amount'] . " — " . $t['description'];
}

{"status":"success","data":[{"id":10,"type":"credit","amount":50.00,"description":"Top up via MoMo","created_at":"2026-04-20 14:00:00"}]}

Returns per-recipient delivery status for a message.

Response

Copy{
  "status": "success",
  "message_id": 1234,
  "overall_status": "delivered",
  "recipients": [
    {
      "number": "26876123456",
      "status": "delivered",
      "updated_at": "2026-04-30T12:05:00"
    },
    {
      "number": "26878654321",
      "status": "pending",
      "updated_at": null
    }
  ]
}

Delivery statuses: pending — not yet confirmed · delivered — confirmed delivered · failed — delivery failed · rejected — rejected by carrier · expired — TTL expired