mihaiomg / webalert

src/WebAlert.php

<?php
namespace mihaiomg\WebAlert;

class WebAlert
{

    private $baseUrl = 'https://www.app.webalert.ro/';
    function __construct()
    {
        $this->apikey = config('webalert.apikey');
        $this->USE_SPECIFIED = config('webalert.USE_SPECIFIED');
        $this->USE_ALL_DEVICES = config('webalert.USE_ALL_DEVICES');
        $this->USE_ALL_SIMS = config('webalert.USE_ALL_SIMS');
    }

/**
 * @param string     $number      The mobile number where you want to send message.
 * @param string     $message     The message you want to send.
 * @param int|string $device      The ID of a device you want to use to send this message.
 * @param int        $schedule    Set it to timestamp when you want to send this message.
 * @param bool       $isMMS       Set it to true if you want to send MMS message instead of SMS.
 * @param string     $attachments Comma separated list of image links you want to attach to the message. Only works for MMS messages.
 * @param bool       $prioritize  Set it to true if you want to prioritize this message.
 *
 * @return array     Returns The array containing information about the message.
 * @throws Exception If there is an error while sending a message.
 */
function sendSingleMessage($number, $message, $device = 0, $schedule = null, $isMMS = false, $attachments = null, $prioritize = false)

It is generally recommended to explicitly declare the visibility for methods.

{

    $url = $this->baseUrl."/services/send.php";
    $postData = array(
        'number' => $number,
        'message' => $message,
        'schedule' => $schedule,
        'key' => $this->apikey,
        'devices' => $device,
        'type' => $isMMS ? "mms" : "sms",
        'attachments' => $attachments,
        'prioritize' => $prioritize ? 1 : 0
    );
    return $this->sendRequest($url, $postData)["messages"][0];
}

/**
 * @param array  $messages        The array containing numbers and messages.
 * @param int    $option          Set this to USE_SPECIFIED if you want to use devices and SIMs specified in devices argument.
 *                                Set this to USE_ALL_DEVICES if you want to use all available devices and their default SIM to send messages.
 *                                Set this to USE_ALL_SIMS if you want to use all available devices and all their SIMs to send messages.
 * @param array  $devices         The array of ID of devices you want to use to send these messages.
 * @param int    $schedule        Set it to timestamp when you want to send these messages.
 * @param bool   $useRandomDevice Set it to true if you want to send messages using only one random device from selected devices.
 *
 * @return array     Returns The array containing messages.
 *                   For example :-
 *                   [
 *                      0 => [
 *                              "ID" => "1",
 *                              "number" => "+11234567890",
 *                              "message" => "This is a test message.",
 *                              "deviceID" => "1",
 *                              "simSlot" => "0",
 *                              "userID" => "1",
 *                              "status" => "Pending",
 *                              "type" => "sms",
 *                              "attachments" => null,
 *                              "sentDate" => "2018-10-20T00:00:00+02:00",
 *                              "deliveredDate" => null
 *                              "groupID" => ")V5LxqyBMEbQrl9*J$5bb4c03e8a07b7.62193871"
 *                           ]
 *                   ]
 * @throws Exception If there is an error while sending messages.
 */
function sendMessages($messages, $devices = [], $schedule = null, $useRandomDevice = false)

It is generally recommended to explicitly declare the visibility for methods.

{
    $url = $this->baseUrl."/services/send.php";
    $postData = [
        'messages' => json_encode($messages),
        'schedule' => $schedule,
        'key' => $this->apikey,
        'devices' => json_encode($devices),
        'option' => $this->USE_SPECIFIED,
        'useRandomDevice' => $useRandomDevice
    ];
    return $this->sendRequest($url, $postData)["messages"];
}

/**
 * @param int    $listID      The ID of the contacts list where you want to send this message.
 * @param string $message     The message you want to send.
 * @param int    $option      Set this to USE_SPECIFIED if you want to use devices and SIMs specified in devices argument.
 *                            Set this to USE_ALL_DEVICES if you want to use all available devices and their default SIM to send messages.
 *                            Set this to USE_ALL_SIMS if you want to use all available devices and all their SIMs to send messages.
 * @param array  $devices     The array of ID of devices you want to use to send the message.
 * @param int    $schedule    Set it to timestamp when you want to send this message.
 * @param bool   $isMMS       Set it to true if you want to send MMS message instead of SMS.
 * @param string $attachments Comma separated list of image links you want to attach to the message. Only works for MMS messages.
 *
 * @return array     Returns The array containing messages.
 * @throws Exception If there is an error while sending messages.
 */
function sendMessageToContactsList($listID, $message, $devices = [], $schedule = null, $isMMS = false, $attachments = null)

It is generally recommended to explicitly declare the visibility for methods.

{
    $url = $this->baseUrl."/services/send.php";
    $postData = [
        'listID' => $listID,
        'message' => $message,
        'schedule' => $schedule,
        'key' => $this->apikey,
        'devices' => json_encode($devices),
        'option' => $$this->USE_SPECIFIED,
        'type' => $isMMS ? "mms" : "sms",
        'attachments' => $attachments
    ];
    return $this->sendRequest($url, $postData)["messages"];
}

/**
 * @param int $id The ID of a message you want to retrieve.
 *
 * @return array     The array containing a message.
 * @throws Exception If there is an error while getting a message.
 */
function getMessageByID($id)

It is generally recommended to explicitly declare the visibility for methods.

{
    $url = $this->baseUrl."/services/read-messages.php";
    $postData = [
        'key' => $this->apikey,
        'id' => $id
    ];
    return $this->sendRequest($url, $postData)["messages"][0];
}

/**
 * @param string $groupID The group ID of messages you want to retrieve.
 *
 * @return array     The array containing messages.
 * @throws Exception If there is an error while getting messages.
 */
function getMessagesByGroupID($groupID)

It is generally recommended to explicitly declare the visibility for methods.

{
    $url = $this->baseUrl."/services/read-messages.php";
    $postData = [
        'key' => $this->apikey,
        'groupId' => $groupID
    ];
    return $this->sendRequest($url, $postData)["messages"];
}

/**
 * @param string $status         The status of messages you want to retrieve.
 * @param int    $deviceID       The deviceID of the device which messages you want to retrieve.
 * @param int    $simSlot        Sim slot of the device which messages you want to retrieve. Similar to array index. 1st slot is 0 and 2nd is 1.
 * @param int    $startTimestamp Search for messages sent or received after this time.
 * @param int    $endTimestamp   Search for messages sent or received before this time.
 *
 * @return array     The array containing messages.
 * @throws Exception If there is an error while getting messages.
 */
function getMessagesByStatus($status, $deviceID = null, $simSlot = null, $startTimestamp = null, $endTimestamp = null)

It is generally recommended to explicitly declare the visibility for methods.

{
    $url = $this->baseUrl."/services/read-messages.php";
    $postData = [
        'key' => $this->apikey,
        'status' => $status,
        'deviceID' => $deviceID,
        'simSlot' => $simSlot,
        'startTimestamp' => $startTimestamp,
        'endTimestamp' => $endTimestamp
    ];
    return $this->sendRequest($url, $postData)["messages"];
}

/**
 * @param int $id The ID of a message you want to resend.
 *
 * @return array     The array containing a message.
 * @throws Exception If there is an error while resending a message.
 */
function resendMessageByID($id)

It is generally recommended to explicitly declare the visibility for methods.

{
    $url = $this->baseUrl."/services/resend.php";
    $postData = [
        'key' => $this->apikey,
        'id' => $id
    ];
    return $this->sendRequest($url, $postData)["messages"][0];
}

/**
 * @param string $groupID The group ID of messages you want to resend.
 * @param string $status  The status of messages you want to resend.
 *
 * @return array     The array containing messages.
 * @throws Exception If there is an error while resending messages.
 */
function resendMessagesByGroupID($groupID, $status = null)

It is generally recommended to explicitly declare the visibility for methods.

{
    $url = $this->baseUrl."/services/resend.php";
    $postData = [
        'key' => $this->apikey,
        'groupId' => $groupID,
        'status' => $status
    ];
    return $this->sendRequest($url, $postData)["messages"];
}

/**
 * @param string $status         The status of messages you want to resend.
 * @param int    $deviceID       The deviceID of the device which messages you want to resend.
 * @param int    $simSlot        Sim slot of the device which messages you want to resend. Similar to array index. 1st slot is 0 and 2nd is 1.
 * @param int    $startTimestamp Resend messages sent or received after this time.
 * @param int    $endTimestamp   Resend messages sent or received before this time.
 *
 * @return array     The array containing messages.
 * @throws Exception If there is an error while resending messages.
 */
function resendMessagesByStatus($status, $deviceID = null, $simSlot = null, $startTimestamp = null, $endTimestamp = null)

It is generally recommended to explicitly declare the visibility for methods.

{
    $url = $this->baseUrl."/services/resend.php";
    $postData = [
        'key' => $this->apikey,
        'status' => $status,
        'deviceID' => $deviceID,
        'simSlot' => $simSlot,
        'startTimestamp' => $startTimestamp,
        'endTimestamp' => $endTimestamp
    ];
    return $this->sendRequest($url, $postData)["messages"];
}

/**
 * @param int    $listID      The ID of the contacts list where you want to add this contact.
 * @param string $number      The mobile number of the contact.
 * @param string $name        The name of the contact.
 * @param bool   $resubscribe Set it to true if you want to resubscribe this contact if it already exists.
 *
 * @return array     The array containing a newly added contact.
 * @throws Exception If there is an error while adding a new contact.
 */
function addContact($listID, $number, $name = null, $resubscribe = false)

It is generally recommended to explicitly declare the visibility for methods.

{
    $url = $this->baseUrl."/services/manage-contacts.php";
    $postData = [
        'key' => $this->apikey,
        'listID' => $listID,
        'number' => $number,
        'name' => $name,
        'resubscribe' => $resubscribe
    ];
    return $this->sendRequest($url, $postData)["contact"];
}

/**
 * @param int    $listID The ID of the contacts list from which you want to unsubscribe this contact.
 * @param string $number The mobile number of the contact.
 *
 * @return array     The array containing the unsubscribed contact.
 * @throws Exception If there is an error while setting subscription to false.
 */
function unsubscribeContact($listID, $number)

It is generally recommended to explicitly declare the visibility for methods.

{
    $url = $this->baseUrl."/services/manage-contacts.php";
    $postData = [
        'key' => $this->apikey,
        'listID' => $listID,
        'number' => $number,
        'unsubscribe' => true
    ];
    return $this->sendRequest($url, $postData)["contact"];
}

/**
 * @return string    The amount of message credits left.
 * @throws Exception If there is an error while getting message credits.
 */
function getBalance()

It is generally recommended to explicitly declare the visibility for methods.

{
    $url = "https://www.webalert.ro/services/send.php";
    $postData = [
        'key' => $this->apikey,
    ];
    $credits = $this->sendRequest($url, $postData)["credits"];
    return is_null($credits) ? "Nelimitat" : $credits;
}

/**
 * @param string $request   USSD request you want to execute. e.g. *150#
 * @param int $device       The ID of a device you want to use to send this message.
 * @param int|null $simSlot Sim you want to use for this USSD request. Similar to array index. 1st slot is 0 and 2nd is 1.
 *
 * @return array     The array containing details about USSD request that was sent.
 * @throws Exception If there is an error while sending a USSD request.
 */
function sendUssdRequest($request, $device, $simSlot = null)

It is generally recommended to explicitly declare the visibility for methods.

{
    $url = $this->baseUrl."/services/send-ussd-request.php";
    $postData = [
        'key' => $this->apikey,
        'request' => $request,
        'device' => $device,
        'sim' => $simSlot
    ];
    return $this->sendRequest($url, $postData)["request"];
}

/**
 * @param int $id The ID of a USSD request you want to retrieve.
 *
 * @return array     The array containing details about USSD request you requested.
 * @throws Exception If there is an error while getting a USSD request.
 */
function getUssdRequestByID($id)

It is generally recommended to explicitly declare the visibility for methods.

{
    $url = $this->baseUrl."/services/read-ussd-requests.php";
    $postData = [
        'key' => $this->apikey,
        'id' => $id
    ];
    return $this->sendRequest($url, $postData)["requests"][0];
}

/**
 * @param string   $request        The request text you want to look for.
 * @param int      $deviceID       The deviceID of the device which USSD requests you want to retrieve.
 * @param int      $simSlot        Sim slot of the device which USSD requests you want to retrieve. Similar to array index. 1st slot is 0 and 2nd is 1.
 * @param int|null $startTimestamp Search for USSD requests sent after this time.
 * @param int|null $endTimestamp   Search for USSD requests sent before this time.
 *
 * @return array     The array containing USSD requests.
 * @throws Exception If there is an error while getting USSD requests.
 */
function getUssdRequests($request, $deviceID = null, $simSlot = null, $startTimestamp = null, $endTimestamp = null)

It is generally recommended to explicitly declare the visibility for methods.

{
    $url = $this->baseUrl."/services/read-ussd-requests.php";
    $postData = [
        'key' => $this->apikey,
        'request' => $request,
        'deviceID' => $deviceID,
        'simSlot' => $simSlot,
        'startTimestamp' => $startTimestamp,
        'endTimestamp' => $endTimestamp
    ];
    return $this->sendRequest($url, $postData)["requests"];
}

function sendRequest($url, $postData)

It is generally recommended to explicitly declare the visibility for methods.

{
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($postData));
    $response = curl_exec($ch);
    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    if (curl_errno($ch)) {
        throw new \Exception(curl_error($ch));
    }
    curl_close($ch);
    if ($httpCode == 200) {
        $json = json_decode($response, true);

It seems like $response can also be of type true; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check?

        if ($json == false) {
            if (empty($response)) {
                throw new \Exception("Missing data in request. Please provide all the required information to send messages.");
            } else {
                throw new \Exception($response);

It seems like $response can also be of type true; however, parameter $message of Exception::__construct() does only seem to accept string, maybe add an additional type check?

            }
        } else {
            if ($json["success"]) {
                return $json["data"];
            } else {
                throw new \Exception($json["error"]["message"]);
            }
        }
    } else {
        throw new \Exception("HTTP Error Code : {$httpCode}");
    }
}
}

?>

It is not recommended to use PHP's closing tag ?> in files other than templates.