dpsoft/asiasms

There is no license information available for the latest version (v1.1.0) of this package.

Asiasms restful web service

v1.1.0 2018-10-16 06:45 UTC

Requires

• ext-json: *
• ext-simplexml: *
• guzzlehttp/guzzle: 6.3.3
• respect/validation: 1.1.22

Requires (Dev)

• phpunit/phpunit: ^6.5.6

Unknown License

• DaneshPajouhan

README

Asiasms is a SMS service provider system.

Is right for me?

If you need integration your website(send and received SMS) with Asiasms, you are in the right place.

Requirements

• For take username and password contarct with http://asiasms.ir
• The allowed IP must define in asiasms panel

Installation

$ composer require dpsoft/asiasms

Methods

GetCredit

Get credit of Asiasms panel.

<?php use Dpsoft\Asiasms\Asiasms;

try{
    /**
      *@param string $username (required) Asiasms panel username 
      * 
      *@param string $password (required) webservice password set in Asiasms panel.
      */
    $asiasms = new Asiasms($username, $password);
    echo $asiasms->getCredit();
}catch (\Throwable $exception){
    echo $exception->getMessage();
}

bulkSend

Send message to list of numbers

<?php use Dpsoft\Asiasms\Asiasms;

try{
    /**
      *@param string $username (required) Asiasms panel username 
      * 
      *@param string $password (required) webservice password set in Asiasms panel.
      */
    $asiasms = new Asiasms($username, $password);
    
    /**
      *@param string $message (required) message text
      *@param array $receivers (required) example: ['09100000000', '09111111111'] should be in 09xxxxxxx mask
      *@param string $senderId = null (optional) the number sms send with it(must exist in panel) default panel default number 
      *@param string $udh = null (optional)
      *@param bool $isFlash = null (optional) if send bool true or false the webservice not work
      */
    $batchId = $asiasms->bulkSend($message, $receivers, $senderId, $udh, $isFlash);
}catch (\Throwable $exception){
    echo $exception->getMessage();
}

Send

Send message to one number.

<?php use Dpsoft\Asiasms\Asiasms;

try{
    /**
      *@param string $username (required) Asiasms panel username 
      * 
      *@param string $password (required) webservice password set in Asiasms panel.
      */
    $asiasms = new Asiasms($username, $password);
    
    /**
      *@param string $message (required) message text
      *@param string $number (required) example: '09100000000' the receiver number
      *@param string $senderId = null (optional) the number sms send with it(must exist in panel)
      *@param string $udh = null (optional)
      *@param bool $isFlash = null (optional) if send bool true or false the webservice not work
      */
    $batchId = $asiasms->send($message, $number, $senderId, $udh, $isFlash);
}catch (\Throwable $exception){
    echo $exception->getMessage();
}

GetMessage

Get list of sms received to panel in date (messages just return one time. the limitation from Asiasms)

<?php use Dpsoft\Asiasms\Asiasms;

try{
    /**
      *@param string $username (required) asiasms panel username 
      * 
      *@param string $password (required) webservice password set in Asiasms panel.
      */
    $asiasms = new Asiasms($username, $password);
    
    /**
      *@param string $date (required) date for get report in any valid date format
      *@param string $receiver = '' (optional) panel number
      *
      *return array of messages
      */
    $messages = $asiasms->getMessages($date, $receiver);
    
    print_r($messages);
}catch (\Throwable $exception){
    echo $exception->getMessage();
}

GetMessagesBetweenDate

Get list of sms received to panel between two dates.(range of dates) For get messages in one date set same start and end date .

<?php use Dpsoft\Asiasms\Asiasms;

try{
    /**
      *@param string $username (required) asiasms panel username 
      * 
      *@param string $password (required) webservice password set in Asiasms panel.
      */
    $asiasms = new Asiasms($username, $password);
    
    /**
      *@param string $startDate (required) in any valid date format
      *@param string $endDate (required) in any valid date format
      *@param string $receiver = '' (optional) panel number
      *
      *return array of messages
      */
    $messages = $asiasms->getMessagesBetweenDate($startDate, $endDate, $receiver);
    
    print_r($messages);
}catch (\Throwable $exception){
    echo $exception->getMessage();
}

Example for return array of messages from Asiasms panel:

Array
(
    [0] => Array
        (
            [From] => 98913xxxxxxx
            [To] => 3000xxxxxx
            [Text] => Message text
            [ReceiveDateTime] => 2018-10-14T17:46:29
        )

    [1] => Array
        (
            [From] => 98913xxxxxxx
            [To] => 3000xxxxxx
            [Text] => Message text for test
            [ReceiveDateTime] => 2018-10-14T18:10:40
        )
)

License

Copyright (c) 2018 dpsoft.ir