How to Send Customized SMS

You can send Customized SMSes to one or many recipients by making a HTTP POST request with the following:

Endpoint


https://api.smsleopard.com/v1/sms/send

Authorization


Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

Sample Request Body


{
	"source": "sms_leopard",
	"multi": true,
	"message": "Dear {name}, Hello from the smsleopard api",
	"destination": [
		{
			"number": "+254700000001",
			"message": "Dear Mary, Hello from the smsleopard api"
		},
		{
			"number": "+254700000002",
			"message": "Dear Nick, Hello from the smsleopard api"
		},
		{
			"number": "+254700000003",
			"message": "Dear Orz, Hello from the smsleopard api"
		}
	],
	"status_url": "",
	"status_secret": ""
}

Code Examples

Curl


curl -i -u API_KEY:API_SECRET -H "Content-Type: application/json" -X POST https://api.smsleopard.com/v1/sms/send -d '{"source": "SMSLeopard", "multi": true, "message": "Hello {name}", "destination": [{"number": "+254710000001", "message": "Hello Bri"}, {"number": "+254710000002", "message": "Hello Joan"}], "status_url": "https://your-status.url", "status_secret": "supersecret"}'

Python


import requests
import json
 
username = "api_key"
password = "api_secret"
body = {
    "message": "Hi {name}",
    "source": "smsleopard",
    "multi": True,
    "destination": [
        {"number": "254700000001", "message": "Hi Joseph"},
        {"number": "254700000002", "message": "Hi Kelly"}
    ]
}
url = "https://api.smsleopard.com/v1/sms/send"
r = requests.post(url, data=json.dumps(body),
                auth=requests.auth.HTTPBasicAuth(username, password))
data = r.json()
print(data)

Go


package main
 
import (
    "bytes"
    "fmt"
    "io/ioutil"
    "net/http"
)
 
func main() {
    client := http.DefaultClient
    username := "api_key"
    password := "api_secret"
    sendMessageURL := "https://api.smsleopard.com/v1/sms/send"
    payload := map[string]interface{}{
        "source":  "smsleopard",
        "multi":   true,
        "message": "Hello {name}",
        "destination": []map[string]string{
            {"number": "+254710000001", "message": "Hello Bri"},
            {"number": "+254710000002", "message": "Hello Joan"},
        },
        "status_url":    "https://your-status.url",
        "status_secret": "supersecret",
    }
 
    body, err := json.Marshal(payload)
 
    if err != nil {
        fmt.Println("error marshalling body: ", err)
    }
 
    req, err := http.NewRequest(http.MethodPost, sendMessageURL, bytes.NewBuffer(body))
    if err != nil {
        fmt.Println("error preparing request: ", err)
    }
 
    req.SetBasicAuth(username, password)
    res, err := client.Do(req)
    if err != nil {
        fmt.Println("error making request: ", err)
    }
 
    defer res.Body.Close()
 
    data, err := ioutil.ReadAll(res.Body)
    if err != nil {
        fmt.Println("error reading response: ", err)
    }
 
    fmt.Printf("%+v", string(data))
}

PHP


<?php
    $api_key = "api_key";
    $api_secret = "api_secret";
    $auth = base64_encode($api_key . ":" . $api_secret);
    $msg = "Test message";
    $postData = array(
        "source" => "SMSLEOPARD",
        "message" => $msg,
        "multi" => true,
        "destination" => array(
            array(
                "number" => "07960000001",
                "message" => "Test message Albert",
            ),
            array(
                "number" => "07960000002",
                "message" => "Test message Brenda",
            ),
        ),
    );
    $ch = curl_init('https://api.smsleopard.com/v1/sms/send');
    curl_setopt_array($ch, array(
        CURLOPT_POST => TRUE,
        CURLOPT_RETURNTRANSFER => TRUE,
        CURLOPT_HTTPHEADER => array(
            'Authorization: Basic ' . $auth,
            'Content-Type: application/json',
        ),
        CURLOPT_POSTFIELDS => json_encode($postData),
    ));
    $response = curl_exec($ch);
    echo $response;
    if (curl_errno($ch)) {
        echo "<br>errorno==>" . curl_errno($ch);
        echo "<br>error==>" . curl_error($ch);
    }
    curl_close($ch);
?>

Payload

source - A Sender ID of your smsleopard business account. If you have not yet been assigned any, use SMS_Leopard for testing purposes. Click here to learn more.
multi - A boolean value (true/false) for whether to Allow sending specific messages to multiple recipients.
message - The message template to be customized for each recipient.
destination - An array of recipient objects with the number you intend to send the message to.
destination → number - The specific recipient number you intend to send to.
destination → message - The customized message to send to the recipient.
status_url - A callback URL to receive delivery reports on (optional).
status_secret - A secret value that you provide, only to be shared between you and us that you will use to verify updates sent from us (required when status_url is provided).

Example of a Successful Response

Status code: 201


{
	"success": true,
	"message": "Sent to 1/1. Cost KES 0.90",
	"recipients": [
		{
			"id": "eb4647b2-2695-4aba-958e-0b39d965f6d0",
			"cost": 0.9,
			"number": "+254700000001",
			"status": "queued"
		}
	]
}