yusufthedragon/caih-sms-php

PHP Client for CAIH SMS API

0.1.0 2020-11-22 10:37 UTC

Requires

• php: >=7.2.0

GPL-3.0-only

• Yusuf The Dragon

• sms
• caih

README

Unofficial library for send SMS messages with China-ASEAN Information Harbor SMS API from applications written with PHP.

• Installation
  • Install the Package
  • Set the Token
  • Set the Channel Key
• Usages
  • Send a SMS Message
  • Check the Status of SMS Message
  • Batch Send SMS Message
  • Batch Check SMS Message
• Contributing

Installation

Install the Package

Install caih-sms-php with composer by following command:

composer require yusufthedragon/caih-sms-php

or add it manually in your composer.json file.

Set the Token

Configure package with your token obtained from CAIH.

\YusufTheDragon\CAIH\SMS::setToken('token');

Set the Channel Key

Configure package with your channel key obtained from CAIH.

\YusufTheDragon\CAIH\SMS::setChannelKey('channelKey');
// or chain it with setToken method
\YusufTheDragon\CAIH\SMS::setToken('token')->setChannelKey('channelKey');

Usages

Send a SMS Message

Send a single SMS request to specific number.

\YusufTheDragon\CAIH\SMS::send(array $parameters);

Usage example:

$sendSMS = \YusufTheDragon\CAIH\SMS::send([
    'toNumber' => '6282147218942',
    'message' => 'Test Message',
    'requestId' => time()
]);
var_dump($sendSMS);

Check the Status of SMS Message

Check the sending status of SMS message.

\YusufTheDragon\CAIH\SMS::queryStatus(array $parameters);

Usage example:

$checkSMS = \YusufTheDragon\CAIH\SMS::queryStatus([
    'messageId' => '1329851774301548544',
    'toNumber' => '6282147218942'
]);
var_dump($checkSMS);

Batch Send SMS Messages

Send SMS messages in batches.

\YusufTheDragon\CAIH\SMS::batchSend(array $parameters);

Usage example:

$batchSendSMS = \YusufTheDragon\CAIH\SMS::batchSend([
    'requestId' => time(),
    'batchToNumber' => [
        '6282147218942',
        '6282147218943',
        '6282147218944'
    ],
    'batchMessage' => [
        'Test SMS 1',
        'Test SMS 2',
        'Test SMS 3'
    ]
]);
var_dump($batchSendSMS);

Batch Check SMS Messages

Check the sending status of SMS messages in batches.

\YusufTheDragon\CAIH\SMS::batchQueryStatus(array $parameters);

Usage example:

$batchQueryStatus = \YusufTheDragon\CAIH\SMS::batchQueryStatus([
    'requestId' => '160595797880071',
    'batchToNumber' => [
        '6282147218942',
        '6282147218943',
        '6282147218944'
    ],
    'batchMessageId' => [
        '910471603446566431',
        '910471603446566432',
        '910471603446566433'
    ]
]);
var_dump($batchQueryStatus);

Contributing

For any requests, bugs, or comments, please open an issue or submit a pull request.