savannabits / advantasms

src/Advantasms.php

<?php

namespace Savannabits\Advantasms;

class Advantasms
{
    private $apikey, $partnerId, $shortcode;
    private $message, $to;
    private $baseUrl = "https://quicksms.advantasms.com";
    private $sendsms = "/api/services/sendsms/";
    /**
     * Advantasms constructor.
     * @param string $apiKey |The advanta sms API Key. See documentation for more details
     * @param string $partnerId | The Partner ID. See advantaSMS documentation for more details
     * @param string $shortCode | The Shortcode of used to send sms. See documentation for more details
     * @param string|null $domain | The base domain in case it is different from https://quicksms.advantasms.com
     * @return Advantasms

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct($apiKey, $partnerId, $shortCode, $baseUrl="https://quicksms.advantasms.com")
    {
        $this->apikey = $apiKey;
        $this->partnerId = $partnerId;
        $this->shortcode = $shortCode;
        $this->baseUrl  = $baseUrl;
        return $this;
    }

    /**
     * Instantiate the Advantasms class.
     * @param string $apiKey |The advanta sms API Key. See documentation for more details
     * @param string $partnerId | The Partner ID. See advantaSMS documentation for more details
     * @param string $shortCode | The Shortcode of used to send sms. See documentation for more details
     * @param string|null $domain | The base domain in case it is different from quicksms.advantasms.com
     * @return Advantasms
     */
    public static function init($apiKey,$partnerId, $shortCode, $baseUrl="https://quicksms.advantasms.com") {
        $instance = new self($apiKey,$partnerId,$shortCode,$baseUrl);
        return $instance;
    }

    /**
     * @param $mobileNumber
     * @return Advantasms
     */
    public function to($mobileNumber) {
        $this->to = $mobileNumber;
        return $this;
    }

    /**
     * @param string $message
     * @return Advantasms
     */
    public function message(string $message="") {
        $this->message = $message;
        return $this;
    }

    /**
     * Execute sms sending action
     * @return array|mixed
     *
     * 200;Successful Request Call
     * 1001;Invalid sender id
     * 1002;Network not allowed
     * 1003;Invalid mobile number
     * 1004;Low bulk credits
     * 1005;Failed. System error
     * 1006;Invalid credentials
     * 1007;Failed. System error
     * 1008;No Delivery Report
     * 1009;unsupported data type
     * 1010;unsupported request type
     * 4090;Internal Error. Try again after 5 minutes
     * 4091;No Partner ID is Set
     * 4092;No API KEY Provided
     * 4093;Details Not Found
     * */
    public function send() {
        $data = [
            "apikey"=>$this->apikey,
            "partnerID"=>trim($this->partnerId),
            "message"=>trim($this->message),
            "shortcode"=>$this->shortcode,
            "mobile"=>trim($this->to),
            'pass_type' => 'plain',
        ];
        $response = $this->curlPost($this->sendsms,$data);
        $return = [
            "success" => false,
            "message" => "",
            "payload" => []
        ];
        if (!$response) {
            $return["success"] = false;
            $return["message"] = "No response from the server.";
            return $return;
        } else {
            if (isset($response['responses'])) {
                $first = $response["responses"][0];
                $return["success"] = $first["response-code"] ===200;
                $return["code"] = $first["response-code"];
                $return["message"] = $first["response-description"];
                $return["payload"] = $response["responses"];
                return $return;
            }
            if (isset($response["response-code"])) {
                $first = $response;
                $return["success"] = $first["response-code"] ===200;
                $return["code"] = $first["response-code"];
                $return["message"] = $first["response-description"];
                $return["payload"] = $response;
                return $return;
            }
            //Temporal fix for the mis-spelled api response code to 'respose-code'
            if (isset($response["respose-code"])) {
                $first = $response;
                $return["success"] = $first["respose-code"] ===200;
                $return["code"] = $first["respose-code"];
                $return["message"] = $first["response-description"];
                $return["payload"] = $response;
                return $return;
            }

            $return["success"] = false;
            $return["message"] = "Unknown Error";
            $return["payload"] = $response;
            return $return;
        }
    }

    /**
     * Schedule sms sending action
     * @param string $time | Time to send in Y-m-d H:i format
     * @return array|mixed
     *
     * 200;Successful Request Call
     * 1001;Invalid sender id
     * 1002;Network not allowed
     * 1003;Invalid mobile number
     * 1004;Low bulk credits
     * 1005;Failed. System error
     * 1006;Invalid credentials
     * 1007;Failed. System error
     * 1008;No Delivery Report
     * 1009;unsupported data type
     * 1010;unsupported request type
     * 4090;Internal Error. Try again after 5 minutes
     * 4091;No Partner ID is Set
     * 4092;No API KEY Provided
     * 4093;Details Not Found
     * */
    public function schedule($time) {
        $data = [
            "apikey"=>$this->apikey,
            "partnerID"=>trim($this->partnerId),
            "message"=>trim($this->message),
            "shortcode"=>$this->shortcode,
            "mobile"=>trim($this->to),
            "timeToSend" => trim($time),
            'pass_type' => 'plain',
        ];
        $response = $this->curlPost($this->sendsms,$data);
        $return = [
            "success" => false,
            "message" => "",
            "payload" => []
        ];
        if (!$response) {
            $return["success"] = false;
            $return["message"] = "No response from the server.";
            return $return;
        } else {
            if (isset($response['responses'])) {
                $first = $response["responses"][0];
                $return["success"] = $first["response-code"] ===200;
                $return["code"] = $first["response-code"];
                $return["message"] = $first["response-description"];
                $return["payload"] = $response["responses"];
                return $return;
            }
            if (isset($response["response-code"])) {
                $first = $response;
                $return["success"] = $first["response-code"] ===200;
                $return["code"] = $first["response-code"];
                $return["message"] = $first["response-description"];
                $return["payload"] = $response;
                return $return;
            }
            //Temporal fix for the mis-spelled api response code to 'respose-code'
            if (isset($response["respose-code"])) {
                $first = $response;
                $return["success"] = $first["respose-code"] ===200;
                $return["code"] = $first["respose-code"];
                $return["message"] = $first["response-description"];
                $return["payload"] = $response;
                return $return;
            }

            $return["success"] = false;
            $return["message"] = "Unknown Error";
            $return["payload"] = $response;
            return $return;
        }
    }
    /**
     * @param string $endpoint
     * @param array $data
     * @param array $headers
     * @return array|mixed
     */
    private function curlPost(string $endpoint, array $data, array $headers=[]) {
        $url = $this->baseUrl.$endpoint;
        $curl = curl_init();
        curl_setopt($curl, CURLOPT_URL, $url);
        curl_setopt($curl, CURLOPT_HTTPHEADER, array_merge(array('Content-Type:application/json'),$headers));

        $data_string = json_encode($data);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_POST, true);
        curl_setopt($curl, CURLOPT_POSTFIELDS, $data_string);
        curl_setopt($curl, CURLOPT_HEADER, false);
        $curl_response = curl_exec($curl);
        return json_decode($curl_response,true);
    }

}