README

使用 PHP 编写的应用程序通过 中国-东盟信息港 SMS API 发送短信消息的非官方库。

• 安装
  • 安装包
  • 设置令牌
  • 设置渠道密钥
• 用法
  • 发送短信消息
  • 检查短信消息状态
  • 批量发送短信消息
  • 批量检查短信消息
• 贡献

安装

安装包

使用以下命令通过 composer 安装 caih-sms-php

composer require yusufthedragon/caih-sms-php

或者在你的 composer.json 文件中手动添加。

设置令牌

使用从 CAIH 获得的令牌配置包

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

设置渠道密钥

使用从 CAIH 获得的渠道密钥配置包

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

用法

发送短信消息

向特定号码发送单个短信请求。

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

用法示例

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

检查短信消息状态

检查短信消息的发送状态。

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

用法示例

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

批量发送短信消息

批量发送短信消息。

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

用法示例

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

批量检查短信消息

批量检查短信消息的发送状态。

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

用法示例

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

贡献

对于任何请求、错误或评论，请打开一个 问题 或 提交拉取请求。