Developer API

Overview

The SMS API allows developers to send SMS messages, retrieve delivery reports, and check account balances via RESTful endpoints. Integrate messaging into your app using secure and scalable endpoints.

1. Send Bulk SMS

Endpoint: POST https://sms.imarabiz.com/api/services/sendbulk/

{
    "count": 1,
    "smslist": [{
        "partnerID": "{{ partnerID }}",
        "apikey": "{{ apikey }}",
        "pass_type": "plain",
        "clientsmsid": 1234,
        "mobile": "{{ mobile }}",
        "message": "This is a test message",
        "shortcode": "{{ shortcode }}"
    }]
}

2. Send Single SMS (POST)

Endpoint: POST https://sms.imarabiz.com/api/services/sendsms/

{
    "apikey": "{{ apikey }}",
    "partnerID": "{{ partnerID }}",
    "mobile": "{{ mobile }}",
    "message": "Testing SMS",
    "shortcode": "{{ shortcode }}",
    "pass_type": "plain"
}

3. Send SMS (GET)

GET https://sms.imarabiz.com/api/services/sendsms/?apikey={{ apikey }}&partnerID={{ partnerID }}&message=Hello&shortcode=XYZ&mobile=2547xxxxxxx

4. Get Delivery Report (DLR)

POST: https://sms.imarabiz.com/api/services/getdlr/

{
    "apikey": "{{ apikey }}",
    "partnerID": "{{ partnerID }}",
    "messageID": "{{ messageID }}"
}

GET: https://sms.imarabiz.com/api/services/getdlr/?apikey=...&messageID=...

5. Check Account Balance

POST: https://sms.imarabiz.com/api/services/getbalance/

{
    "apikey": "{{ apikey }}",
    "partnerID": "{{ partnerID }}"
}

GET: https://sms.imarabiz.com/api/services/getbalance/index.php?apikey=...&partnerID=...

"Build, send, and monitor your SMS communications with just a few lines of code."