README

Installation

Install the package using Composer:

composer require bitmoro/bitmorophp

Include the autoloader in your project:

require __DIR__ . '/vendor/autoload.php';

Usage

Initialization

$bitmoro = new Bitmoro("api_token", "defaultSenderId");

Get the API token and sender ID from the Bitmoro developer dashboard.

OTP Message

Send a one-time password (OTP) message:

$number = "1234567890";
$message = "Test Message";
$response = $bitmoro->sendOTP($number, $message);

If you want to change the sender ID:

$response = $bitmoro->sendOTP($number, $message, $newSenderId);

Example of Success Response:

{
    "numberOfFailed": 0,
    "messageId": "tqtkIYTQpSAneKYMLJEC"
}

Example of Error Response:

{
    "message": "Cannot send message until the number is verified",
    "errorCode": "01"
}

Bulk SMS

Send bulk SMS messages:

$numbers = ["1234567890"];
$message = "Test Message";
$scheduleDate = time(); // Must be in timestamp
$callbackUrl = "call_back_url";
$response = $bitmoro->sendBulkSms($numbers, $message, $scheduleDate, $callbackUrl);

If you want to change the sender ID:

$response = $bitmoro->sendBulkSms($numbers, $message, $scheduleDate, $callbackUrl, $newSenderId);

Request Body

Example Success Response:

{
    "status": "QUEUED",
    "report": [
        {
            "number": "9801234567",
            "message": "Hello",
            "type": 1,
            "credit": 1
        },
        {
            "number": "9823456780",
            "message": "Hello",
            "type": 1,
            "credit": 1
        }
    ],
    "creditSpent": 2,
    "messageId": "s6atNQj8nTuAIxOrEv7w",
    "senderId": "bit_alert"
}

Example of Error Response:

{
    "message": "Cannot send message until the number is verified",
    "errorCode": "01"
}

Dynamic Message

Send dynamic messages:

$contacts = [
    [
        "number" => "9842882495",
        "message" => "Hello, this is a test message",
        "city" => "Kathmandu",
        "country" => "Nepal",
        "to" => "9842882495"
    ],
    [
        "number" => "9869352017",
        "message" => "Hello, this is a test message",
        "city" => "Kathmandu",
        "country" => "Nepal",
        "to" => "9869352017"
    ]
];

$message = "${message} from ${country} to ${number} in ${city} ${to}";
$response = $bitmoro->sendDynamicSms($contacts, $message, $scheduleDate, $callbackUrl, $newSenderId);

Request Body

Example Success Response:

{
    "status": "SCHEDULED",
    "report": [
        {
            "number": "9809876543",
            "message": "Hello joe. I am from Biratnagar",
            "type": 1,
            "credit": 1
        },
        {
            "number": "9800000000",
            "message": "Hello ramu. I am from Biratnagar",
            "type": 1,
            "credit": 1
        },
        {
            "number": "9876543210",
            "message": "Hello ramu. I am from kathmandu",
            "type": 1,
            "credit": 1
        }
    ],
    "creditSpent": 3,
    "messageId": "Fx2z80UJIm3BdlUrtb7I",
    "senderId": "bit_alert"
}

Example of Error Response:

{
    "message": "Cannot send message until the number is verified",
    "errorCode": "01"
}

Future Updates - ReadMe

Overview

This document outlines the future updates planned for the project. The updates include features related to Reporting and Callback URL integration. These enhancements aim to improve functionality, security, and user experience.

Features

1. Reporting

• Goal: Provide comprehensive reporting tools.
• Details:
  • Develop detailed reporting features for better insights.
  • Include data visualization options such as charts and graphs.
  • Add functionality to export reports in various formats (PDF, Excel).
• Priority: High

2. Callback URL

• Goal: Enhance system communication via callback URLs.
• Details:
  • Design and test callback URL integration to ensure seamless data exchange.
  • Implement secure communication mechanisms, such as OAuth or token-based authentication.
  • Include logging and error handling to manage callback responses effectively.
• Priority: Medium

Contribution Guidelines

• Fork the repository and create a feature branch for any new additions.
• Submit a pull request with a detailed description of the updates.
• Ensure all tests pass before submission.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Feel free to update this file as new features or changes are introduced.