SMS

Send a single sms

Send Sms

POST /notifications/sms/send

This service allows you to send SMS to telecommunication mobile numbers (R) - Required Fields

Available Providers

Provider Name	Code
BulkSms Nigeria	bulksmsnigeria

Transformer URL

/v1/transformers/{provider}/notifications/sms/send

Standard Payload

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
client_ref	string	The body of the sms (R)
message	string	Request unique identifier (R)
sender	string	Description of sender (R)
phonenumber	string	Mobile number (R)

Response

Request

{
    "client_ref": "000000006704",
    "message": "This is a final testing message",
    "sender": "Redundancy"
    "phonenumber": "07035361770",
}

Response

{
    "status": true,
    "response_code": "00",
    "response_message": "Sms successfully sent",
    "data": {
        "client_reference": "000000006704",
        "debited": true,
        "transaction_status": "SUCCESS",
        "payment_status": "PAID",
        "currency": "NGN",
        "amount": 4,
        "action": "PURCHASE",
        "provider": "Bulksmsnigeria",
        "value_number": "07035361770",
        "narration": "SMS Purchase/000000006704/07035361770",
        "category": "Notifications::SMS",
        "adapter_reference": "OYS_NOT_SMS_1713463674_IMIQ8",
        "provider_reference": "bb1db189-1257-4dcb-bf0a-b0394234aa57",
        "created_at": "2024-04-18T18:07:54.000000Z",
        "service_data": {
            "name": "SUCCESSFUL"
        },
        "provider_response": {
            "data": {
                "status": "success",
                "message": "Message Sent",
                "message_id": "bb1db189-1257-4dcb-bf0a-b0394234aa57",
                "cost": 2.49,
                "currency": "NGN",
                "gateway_used": "direct-refund"
            }
        }
    }
}