Skip to content

Commit 622d7f8

Browse files
timhbwtimhbw
committed
feat: add sms demo
1 parent 275e35d commit 622d7f8

12 files changed

+382
-0
lines changed

‎examples/sms/sms_create_signature.php‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<?php
2+
require_once __DIR__ . '/../../autoload.php';
3+
4+
use Qiniu\Auth;
5+
use Qiniu\Sms\Sms;
6+
7+
// 控制台获取密钥：https://portal.qiniu.com/user/key
8+
$accessKey = getenv('QINIU_ACCESS_KEY');
9+
$secretKey = getenv('QINIU_SECRET_KEY');
10+
11+
$auth = new Auth($accessKey, $secretKey);
12+
$client = new Sms($auth);
13+
14+
// 创建签名
15+
// 参考文档：https://developer.qiniu.com/sms/api/5844/sms-api-create-signature
16+
// 签名审核标准：https://developer.qiniu.com/sms/manual/5816/signature-specification
17+
18+
$signature = 'xxxx'; // 签名
19+
$source = 'website'; // 签名来源，申请签名时必须指定签名来源
20+
$pics = '../php-logo.png'; // 签名对应的资质证明图片
21+
22+
list($ret, $err) = $client->createSignature($signature, $source, $pics);
23+
24+
echo "\n====> create signature result: \n";
25+
if ($err !== null) {
26+
var_dump($err);
27+
} else {
28+
var_dump($ret);
29+
}
30+
31+
32+
33+

‎examples/sms/sms_create_template.php‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<?php
2+
require_once __DIR__ . '/../../autoload.php';
3+
4+
use Qiniu\Auth;
5+
use Qiniu\Sms\Sms;
6+
7+
// 控制台获取密钥：https://portal.qiniu.com/user/key
8+
$accessKey = getenv('QINIU_ACCESS_KEY');
9+
$secretKey = getenv('QINIU_SECRET_KEY');
10+
11+
$auth = new Auth($accessKey, $secretKey);
12+
$client = new Sms($auth);
13+
14+
// 创建模板
15+
// 参考文档：https://developer.qiniu.com/sms/api/5893/sms-api-create-template
16+
// 模板审核标准：https://developer.qiniu.com/sms/manual/5814/template-specification
17+
18+
$name = 'xxxxxx'; // 模板名称
19+
$template = '您的验证码为: ${code}，如非本人操作，请忽略本短信'; // 模板内容 可设置自定义变量，发送短信时候使用
20+
21+
// 模板类型，取值范围为: notification (通知类短信), verification (验证码短信), marketing (营销类短信), voice(语音类短信)
22+
$type = 'verification';
23+
$description = '发送验证码使用'; // 申请理由简述
24+
$signature_id = 'xxxxxx'; // 已经审核通过的签名
25+
26+
list($ret, $err) = $client->createTemplate($name, $template, $type, $description, $signature_id);
27+
28+
echo "\n====> create signature result: \n";
29+
if ($err !== null) {
30+
var_dump($err);
31+
} else {
32+
var_dump($ret);
33+
}
34+
35+

‎examples/sms/sms_delete_signature.php‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?php
2+
require_once __DIR__ . '/../../autoload.php';
3+
4+
use Qiniu\Auth;
5+
use Qiniu\Sms\Sms;
6+
7+
// 控制台获取密钥：https://portal.qiniu.com/user/key
8+
$accessKey = getenv('QINIU_ACCESS_KEY');
9+
$secretKey = getenv('QINIU_SECRET_KEY');
10+
11+
$auth = new Auth($accessKey, $secretKey);
12+
$client = new Sms($auth);
13+
14+
// 删除签名
15+
// 参考文档：https://developer.qiniu.com/sms/api/5891/sms-api-delete-signature
16+
17+
// 签名 ID
18+
$signature_id = 'xxxxxx';
19+
20+
list($ret, $err) = $client->deleteSignature($signature_id);
21+
if ($err !== null) {
22+
var_dump($err);
23+
} else {
24+
echo "\n====> Delete Signature $signature_id Successfully\n";
25+
}
26+

‎examples/sms/sms_delete_template.php‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?php
2+
require_once __DIR__ . '/../../autoload.php';
3+
4+
use Qiniu\Auth;
5+
use Qiniu\Sms\Sms;
6+
7+
// 控制台获取密钥：https://portal.qiniu.com/user/key
8+
$accessKey = getenv('QINIU_ACCESS_KEY');
9+
$secretKey = getenv('QINIU_SECRET_KEY');
10+
11+
$auth = new Auth($accessKey, $secretKey);
12+
$client = new Sms($auth);
13+
14+
// 删除模板
15+
// 参考文档：https://developer.qiniu.com/sms/api/5896/sms-api-delete-template
16+
17+
// 模板 ID
18+
$template_id = 'xxxxxx';
19+
20+
list($ret, $err) = $client->deleteTemplate($template_id);
21+
if ($err !== null) {
22+
var_dump($err);
23+
} else {
24+
echo "\n====> Delete Template $template_id Successfully\n";
25+
}
26+

‎examples/sms/sms_edit_signature.php‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<?php
2+
require_once __DIR__ . '/../../autoload.php';
3+
4+
use Qiniu\Auth;
5+
use Qiniu\Sms\Sms;
6+
7+
// 控制台获取密钥：https://portal.qiniu.com/user/key
8+
$accessKey = getenv('QINIU_ACCESS_KEY');
9+
$secretKey = getenv('QINIU_SECRET_KEY');
10+
11+
$auth = new Auth($accessKey, $secretKey);
12+
$client = new Sms($auth);
13+
14+
// 编辑签名
15+
// 参考文档：https://developer.qiniu.com/sms/api/5890/sms-api-edit-signature
16+
// 签名审核标准：https://developer.qiniu.com/sms/manual/5816/signature-specification
17+
18+
$id = 'xxxxxx'; // 签名 ID
19+
$signature = 'xxxx'; // 签名
20+
$source = 'website'; // 签名来源，申请签名时必须指定签名来源
21+
$pics = '../php-logo.png'; // 签名对应的资质证明图片
22+
23+
list($ret, $err) = $client->updateSignature($id, $signature, $source, $pics);
24+
25+
echo "\n====> edit signature result: \n";
26+
if ($err !== null) {
27+
var_dump($err);
28+
} else {
29+
echo "\n====> Update Signature Successfully\n";
30+
}
31+
32+

‎examples/sms/sms_edit_template.php‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<?php
2+
require_once __DIR__ . '/../../autoload.php';
3+
4+
use Qiniu\Auth;
5+
use Qiniu\Sms\Sms;
6+
7+
// 控制台获取密钥：https://portal.qiniu.com/user/key
8+
$accessKey = getenv('QINIU_ACCESS_KEY');
9+
$secretKey = getenv('QINIU_SECRET_KEY');
10+
11+
$auth = new Auth($accessKey, $secretKey);
12+
$client = new Sms($auth);
13+
14+
// 编辑模板
15+
// 参考文档：https://developer.qiniu.com/sms/api/5895/sms-api-edit-template
16+
// 模板审核标准：https://developer.qiniu.com/sms/manual/5814/template-specification
17+
18+
$template_id = 'xxxxxx'; // 模板 ID
19+
$name = '验证码'; // 模板名称
20+
$template = '验证码为: ${code}，如非本人操作，请忽略本短信'; // 模板内容 可设置自定义变量，发送短信时候使用
21+
$description = '发送验证码'; // 申请理由简述
22+
$signature_id = 'xxxxxx'; // 已经审核通过的签名
23+
24+
list($ret, $err) = $client->updateTemplate($template_id, $name, $template, $description, $signature_id);
25+
26+
echo "\n====> edit template result: \n";
27+
if ($err !== null) {
28+
var_dump($err);
29+
} else {
30+
echo "\n====> Update Template Successfully\n";
31+
}
32+
33+

‎examples/sms/sms_query_send_sms.php‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<?php
2+
require_once __DIR__ . '/../../autoload.php';
3+
4+
use Qiniu\Auth;
5+
use Qiniu\Sms\Sms;
6+
7+
// 控制台获取密钥：https://portal.qiniu.com/user/key
8+
$accessKey = getenv('QINIU_ACCESS_KEY');
9+
$secretKey = getenv('QINIU_SECRET_KEY');
10+
11+
$auth = new Auth($accessKey, $secretKey);
12+
$client = new Sms($auth);
13+
14+
// 查询发送记录
15+
// 参考文档：https://developer.qiniu.com/sms/api/5852/query-send-sms
16+
17+
$job_id = 'xxxx'; // 发送任务返回的 id
18+
$message_id = 'xxxx'; // 单条短信发送接口返回的 id
19+
$mobile = 'xxxx'; // 接收短信的手机号码
20+
21+
// 短信的状态，sending: 发送中，success: 发送成功，failed: 发送失败，waiting: 等待发送
22+
$status = 'success';
23+
$template_id = 'xxxx'; // 模版 id
24+
25+
// 短信类型，marketing: 营销短信，notification: 通知短信，verification: 验证码类短信，voice: 语音短信
26+
$type = 'notification';
27+
28+
$start = 1599976580; // 开始时间
29+
$end = 1599977229; // 结束时间
30+
$page = 1; // 页码，默认为 1
31+
$page_size = 20; // 每页返回的数据条数，默认20，最大200
32+
33+
list($ret, $err) = $client->querySendSms(
34+
$job_id,
35+
$message_id,
36+
$mobile,
37+
$status,
38+
$template_id,
39+
$type,
40+
$start,
41+
$end,
42+
$page,
43+
$page_size);
44+
echo "\n====> query send sms result: \n";
45+
if ($err !== null) {
46+
var_dump($err);
47+
} else {
48+
var_dump($ret);
49+
}
50+
51+

‎examples/sms/sms_query_signature.php‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<?php
2+
require_once __DIR__ . '/../../autoload.php';
3+
4+
use Qiniu\Auth;
5+
use Qiniu\Sms\Sms;
6+
7+
// 控制台获取密钥：https://portal.qiniu.com/user/key
8+
$accessKey = getenv('QINIU_ACCESS_KEY');
9+
$secretKey = getenv('QINIU_SECRET_KEY');
10+
11+
$auth = new Auth($accessKey, $secretKey);
12+
$client = new Sms($auth);
13+
14+
// 列出签名
15+
// 参考文档：https://developer.qiniu.com/sms/api/5889/sms-api-query-signature
16+
17+
// 审核状态, 取值范围为: "passed"(通过), "rejected"(未通过), "reviewing"(审核中)
18+
$audit_status = 'passed';
19+
$page = 1; // 页码，默认为 1
20+
$page_size = 30; // 分页大小，默认为 20
21+
22+
list($ret, $err) = $client->querySignature($audit_status, $page, $page_size);
23+
echo "\n====> query signature result: \n";
24+
if ($err !== null) {
25+
var_dump($err);
26+
} else {
27+
var_dump($ret);
28+
}
29+
30+

‎examples/sms/sms_query_single_signature.php‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?php
2+
require_once __DIR__ . '/../../autoload.php';
3+
4+
use Qiniu\Auth;
5+
use Qiniu\Sms\Sms;
6+
7+
// 控制台获取密钥：https://portal.qiniu.com/user/key
8+
$accessKey = getenv('QINIU_ACCESS_KEY');
9+
$secretKey = getenv('QINIU_SECRET_KEY');
10+
11+
$auth = new Auth($accessKey, $secretKey);
12+
$client = new Sms($auth);
13+
14+
// 查询单个签名
15+
// 参考文档：https://developer.qiniu.com/sms/api/5970/query-a-single-signature
16+
17+
// 签名 ID
18+
$signature_id = 'xxxxxx';
19+
20+
list($ret, $err) = $client->checkSingleSignature($signature_id);
21+
echo "\n====> query single signature result: \n";
22+
if ($err !== null) {
23+
var_dump($err);
24+
} else {
25+
var_dump($ret);
26+
}
27+

‎examples/sms/sms_query_single_template.php‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?php
2+
require_once __DIR__ . '/../../autoload.php';
3+
4+
use Qiniu\Auth;
5+
use Qiniu\Sms\Sms;
6+
7+
// 控制台获取密钥：https://portal.qiniu.com/user/key
8+
$accessKey = getenv('QINIU_ACCESS_KEY');
9+
$secretKey = getenv('QINIU_SECRET_KEY');
10+
11+
$auth = new Auth($accessKey, $secretKey);
12+
$client = new Sms($auth);
13+
14+
// 查询单个模板
15+
// 参考文档：https://developer.qiniu.com/sms/api/5969/query-a-single-template
16+
17+
// 模板 ID
18+
$template_id = 'xxxxxx';
19+
20+
list($ret, $err) = $client->querySingleTemplate($template_id);
21+
echo "\n====> query single template result： \n";
22+
if ($err !== null) {
23+
var_dump($err);
24+
} else {
25+
var_dump($ret);
26+
}
27+

0 commit comments

Comments
 (0)