添加网站文件

This commit is contained in:
2025-12-22 13:59:40 +08:00
commit 117aaf83d1
19468 changed files with 2111999 additions and 0 deletions

View File

@@ -0,0 +1,45 @@
# SMS Server-Side Library For PHP
## Features
- 签名管理
- [x] 创建签名: client->createSignature()
- [x] 列出签名: client->checkSignature()
- [x] 查询单个签名: client->checkSingleSignature()
- [x] 编辑签名: client->updateSignature()
- [x] 删除签名: client->deleteSignature()
- 模板管理
- [x] 创建模板: client->createTemplate()
- [x] 列出模板: client->queryTemplate()
- [x] 查询单个模板: client->querySingleTemplate()
- [x] 编辑模板: client->updateTemplate()
- [x] 删除模板: client->deleteTemplate()
- 发送短信
- [x] 发送短信: client->sendMessage()
- 查询发送记录
- [x] 查询发送记录: client->querySendSms()
## Demo
- 签名管理
- [创建签名](https://github.com/qiniu/php-sdk/tree/master/examples/sms/sms_create_signature.php)
- [列出签名](https://github.com/qiniu/php-sdk/tree/master/examples/sms/sms_query_signature.php)
- [查询单个签名](https://github.com/qiniu/php-sdk/tree/master/examples/sms/sms_query_single_signature.php)
- [编辑签名](https://github.com/qiniu/php-sdk/tree/master/examples/sms/sms_edit_signature.php)
- [删除签名](https://github.com/qiniu/php-sdk/tree/master/examples/sms/sms_delete_signature.php)
- 模板管理
- [创建模板](https://github.com/qiniu/php-sdk/tree/master/examples/sms/sms_create_template.php)
- [列出模板](https://github.com/qiniu/php-sdk/tree/master/examples/sms/sms_query_template.php)
- [查询单个模板](https://github.com/qiniu/php-sdk/tree/master/examples/sms/sms_query_single_template.php)
- [编辑模板](https://github.com/qiniu/php-sdk/tree/master/examples/sms/sms_edit_template.php)
- [删除模板](https://github.com/qiniu/php-sdk/tree/master/examples/sms/sms_delete_template.php)
- 发送短信
- [发送短信](https://github.com/qiniu/php-sdk/tree/master/examples/sms/sms_send_message.php)
- 查询发送记录
- [查询发送记录](https://github.com/qiniu/php-sdk/tree/master/examples/sms/sms_query_send_sms.php)

View File

@@ -0,0 +1,29 @@
<?php
require_once __DIR__ . '/../../autoload.php';
use Qiniu\Auth;
use Qiniu\Sms\Sms;
// 控制台获取密钥https://portal.qiniu.com/user/key
$accessKey = getenv('QINIU_ACCESS_KEY');
$secretKey = getenv('QINIU_SECRET_KEY');
$auth = new Auth($accessKey, $secretKey);
$client = new Sms($auth);
// 创建签名
// 参考文档https://developer.qiniu.com/sms/api/5844/sms-api-create-signature
// 签名审核标准https://developer.qiniu.com/sms/manual/5816/signature-specification
$signature = 'xxxx'; // 签名
$source = 'website'; // 签名来源,申请签名时必须指定签名来源
$pics = '../php-logo.png'; // 签名对应的资质证明图片
list($ret, $err) = $client->createSignature($signature, $source, $pics);
echo "\n====> create signature result: \n";
if ($err !== null) {
var_dump($err);
} else {
var_dump($ret);
}

View File

@@ -0,0 +1,33 @@
<?php
require_once __DIR__ . '/../../autoload.php';
use Qiniu\Auth;
use Qiniu\Sms\Sms;
// 控制台获取密钥https://portal.qiniu.com/user/key
$accessKey = getenv('QINIU_ACCESS_KEY');
$secretKey = getenv('QINIU_SECRET_KEY');
$auth = new Auth($accessKey, $secretKey);
$client = new Sms($auth);
// 创建模板
// 参考文档https://developer.qiniu.com/sms/api/5893/sms-api-create-template
// 模板审核标准https://developer.qiniu.com/sms/manual/5814/template-specification
$name = 'xxxxxx'; // 模板名称
$template = '您的验证码为: ${code},如非本人操作,请忽略本短信'; // 模板内容 可设置自定义变量,发送短信时候使用
// notification (通知类短信), verification (验证码短信), marketing (营销类短信), voice(语音类短信)
$type = 'verification';
$description = '发送验证码使用'; // 申请理由简述
$signature_id = 'xxxxxx'; // 已经审核通过的签名
list($ret, $err) = $client->createTemplate($name, $template, $type, $description, $signature_id);
echo "\n====> create signature result: \n";
if ($err !== null) {
var_dump($err);
} else {
var_dump($ret);
}

View File

@@ -0,0 +1,25 @@
<?php
require_once __DIR__ . '/../../autoload.php';
use Qiniu\Auth;
use Qiniu\Sms\Sms;
// 控制台获取密钥https://portal.qiniu.com/user/key
$accessKey = getenv('QINIU_ACCESS_KEY');
$secretKey = getenv('QINIU_SECRET_KEY');
$auth = new Auth($accessKey, $secretKey);
$client = new Sms($auth);
// 删除签名
// 参考文档https://developer.qiniu.com/sms/api/5891/sms-api-delete-signature
// 签名 ID
$signature_id = 'xxxxxx';
list($ret, $err) = $client->deleteSignature($signature_id);
if ($err !== null) {
var_dump($err);
} else {
echo "\n====> Delete Signature $signature_id Successfully\n";
}

View File

@@ -0,0 +1,25 @@
<?php
require_once __DIR__ . '/../../autoload.php';
use Qiniu\Auth;
use Qiniu\Sms\Sms;
// 控制台获取密钥https://portal.qiniu.com/user/key
$accessKey = getenv('QINIU_ACCESS_KEY');
$secretKey = getenv('QINIU_SECRET_KEY');
$auth = new Auth($accessKey, $secretKey);
$client = new Sms($auth);
// 删除模板
// 参考文档https://developer.qiniu.com/sms/api/5896/sms-api-delete-template
// 模板 ID
$template_id = 'xxxxxx';
list($ret, $err) = $client->deleteTemplate($template_id);
if ($err !== null) {
var_dump($err);
} else {
echo "\n====> Delete Template $template_id Successfully\n";
}

View File

@@ -0,0 +1,30 @@
<?php
require_once __DIR__ . '/../../autoload.php';
use Qiniu\Auth;
use Qiniu\Sms\Sms;
// 控制台获取密钥https://portal.qiniu.com/user/key
$accessKey = getenv('QINIU_ACCESS_KEY');
$secretKey = getenv('QINIU_SECRET_KEY');
$auth = new Auth($accessKey, $secretKey);
$client = new Sms($auth);
// 编辑签名
// 参考文档https://developer.qiniu.com/sms/api/5890/sms-api-edit-signature
// 签名审核标准https://developer.qiniu.com/sms/manual/5816/signature-specification
$id = 'xxxxxx'; // 签名 ID
$signature = 'xxxx'; // 签名
$source = 'website'; // 签名来源,申请签名时必须指定签名来源
$pics = '../php-logo.png'; // 签名对应的资质证明图片
list($ret, $err) = $client->updateSignature($id, $signature, $source, $pics);
echo "\n====> edit signature result: \n";
if ($err !== null) {
var_dump($err);
} else {
echo "\n====> Update Signature Successfully\n";
}

View File

@@ -0,0 +1,31 @@
<?php
require_once __DIR__ . '/../../autoload.php';
use Qiniu\Auth;
use Qiniu\Sms\Sms;
// 控制台获取密钥https://portal.qiniu.com/user/key
$accessKey = getenv('QINIU_ACCESS_KEY');
$secretKey = getenv('QINIU_SECRET_KEY');
$auth = new Auth($accessKey, $secretKey);
$client = new Sms($auth);
// 编辑模板
// 参考文档https://developer.qiniu.com/sms/api/5895/sms-api-edit-template
// 模板审核标准https://developer.qiniu.com/sms/manual/5814/template-specification
$template_id = 'xxxxxx'; // 模板 ID
$name = '验证码'; // 模板名称
$template = '验证码为: ${code},如非本人操作,请忽略本短信'; // 模板内容 可设置自定义变量,发送短信时候使用
$description = '发送验证码'; // 申请理由简述
$signature_id = 'xxxxxx'; // 已经审核通过的签名
list($ret, $err) = $client->updateTemplate($template_id, $name, $template, $description, $signature_id);
echo "\n====> edit template result: \n";
if ($err !== null) {
var_dump($err);
} else {
echo "\n====> Update Template Successfully\n";
}

View File

@@ -0,0 +1,50 @@
<?php
require_once __DIR__ . '/../../autoload.php';
use Qiniu\Auth;
use Qiniu\Sms\Sms;
// 控制台获取密钥https://portal.qiniu.com/user/key
$accessKey = getenv('QINIU_ACCESS_KEY');
$secretKey = getenv('QINIU_SECRET_KEY');
$auth = new Auth($accessKey, $secretKey);
$client = new Sms($auth);
// 查询发送记录
// 参考文档https://developer.qiniu.com/sms/api/5852/query-send-sms
$job_id = 'xxxx'; // 发送任务返回的 id
$message_id = 'xxxx'; // 单条短信发送接口返回的 id
$mobile = 'xxxx'; // 接收短信的手机号码
// 短信的状态sending: 发送中success: 发送成功failed: 发送失败waiting: 等待发送
$status = 'success';
$template_id = 'xxxx'; // 模版 id
// marketing: 营销短信notification: 通知短信verification: 验证码类短信voice: 语音短信
$type = 'notification';
$start = 1599976580; // 开始时间
$end = 1599977229; // 结束时间
$page = 1; // 页码,默认为 1
$page_size = 20; // 每页返回的数据条数默认20最大200
list($ret, $err) = $client->querySendSms(
$job_id,
$message_id,
$mobile,
$status,
$template_id,
$type,
$start,
$end,
$page,
$page_size
);
echo "\n====> query send sms result: \n";
if ($err !== null) {
var_dump($err);
} else {
var_dump($ret);
}

View File

@@ -0,0 +1,28 @@
<?php
require_once __DIR__ . '/../../autoload.php';
use Qiniu\Auth;
use Qiniu\Sms\Sms;
// 控制台获取密钥https://portal.qiniu.com/user/key
$accessKey = getenv('QINIU_ACCESS_KEY');
$secretKey = getenv('QINIU_SECRET_KEY');
$auth = new Auth($accessKey, $secretKey);
$client = new Sms($auth);
// 列出签名
// 参考文档https://developer.qiniu.com/sms/api/5889/sms-api-query-signature
// 审核状态, 取值范围为: "passed"(通过), "rejected"(未通过), "reviewing"(审核中)
$audit_status = 'passed';
$page = 1; // 页码,默认为 1
$page_size = 30; // 分页大小,默认为 20
list($ret, $err) = $client->querySignature($audit_status, $page, $page_size);
echo "\n====> query signature result: \n";
if ($err !== null) {
var_dump($err);
} else {
var_dump($ret);
}

View File

@@ -0,0 +1,26 @@
<?php
require_once __DIR__ . '/../../autoload.php';
use Qiniu\Auth;
use Qiniu\Sms\Sms;
// 控制台获取密钥https://portal.qiniu.com/user/key
$accessKey = getenv('QINIU_ACCESS_KEY');
$secretKey = getenv('QINIU_SECRET_KEY');
$auth = new Auth($accessKey, $secretKey);
$client = new Sms($auth);
// 查询单个签名
// 参考文档https://developer.qiniu.com/sms/api/5970/query-a-single-signature
// 签名 ID
$signature_id = 'xxxxxx';
list($ret, $err) = $client->checkSingleSignature($signature_id);
echo "\n====> query single signature result: \n";
if ($err !== null) {
var_dump($err);
} else {
var_dump($ret);
}

View File

@@ -0,0 +1,26 @@
<?php
require_once __DIR__ . '/../../autoload.php';
use Qiniu\Auth;
use Qiniu\Sms\Sms;
// 控制台获取密钥https://portal.qiniu.com/user/key
$accessKey = getenv('QINIU_ACCESS_KEY');
$secretKey = getenv('QINIU_SECRET_KEY');
$auth = new Auth($accessKey, $secretKey);
$client = new Sms($auth);
// 查询单个模板
// 参考文档https://developer.qiniu.com/sms/api/5969/query-a-single-template
// 模板 ID
$template_id = 'xxxxxx';
list($ret, $err) = $client->querySingleTemplate($template_id);
echo "\n====> query single template result \n";
if ($err !== null) {
var_dump($err);
} else {
var_dump($ret);
}

View File

@@ -0,0 +1,28 @@
<?php
require_once __DIR__ . '/../../autoload.php';
use Qiniu\Auth;
use Qiniu\Sms\Sms;
// 控制台获取密钥https://portal.qiniu.com/user/key
$accessKey = getenv('QINIU_ACCESS_KEY');
$secretKey = getenv('QINIU_SECRET_KEY');
$auth = new Auth($accessKey, $secretKey);
$client = new Sms($auth);
// 列出摸板
// 参考文档https://developer.qiniu.com/sms/api/5894/sms-api-query-template
// 审核状态, 取值范围为: passed (通过), rejected (未通过), reviewing (审核中)
$audit_status = 'rejected';
$page = 1; // 页码,默认为 1
$page_size = 30; // 分页大小,默认为 20
list($ret, $err) = $client->queryTemplate($audit_status, $page, $page_size);
echo "\n====> query template result \n";
if ($err !== null) {
var_dump($err);
} else {
var_dump($ret);
}

View File

@@ -0,0 +1,32 @@
<?php
require_once __DIR__ . '/../../autoload.php';
use Qiniu\Auth;
use Qiniu\Sms\Sms;
// 控制台获取密钥https://portal.qiniu.com/user/key
$accessKey = getenv('QINIU_ACCESS_KEY');
$secretKey = getenv('QINIU_SECRET_KEY');
$auth = new Auth($accessKey, $secretKey);
$client = new Sms($auth);
// 发送短信
// 参考文档https://developer.qiniu.com/sms/api/5897/sms-api-send-message
// 模板 ID
$template_id = 'xxxxxx';
// 接收短信的手机号码
$mobiles = array("15012345678", "15012345679");
// 自定义模板变量
$code = array('code' => 'xxxx');
list($ret, $err) = $client->sendMessage($template_id, $mobiles, $code);
if ($err !== null) {
var_dump($err);
} else {
echo "\n====> Send Message Successfully \n";
var_dump($ret);
}