SignApi.php
5.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
<?php
namespace Yunpian\Sdk\Api;
use Yunpian\Sdk\Model\Result;
use Yunpian\Sdk\YunpianClient;
/**
* https://www.yunpian.com/api2.0/sign.html
*
* @author dzh
* @since 1.0
*/
class SignApi extends YunpianApi {
const NAME = "sign";
function init(YunpianClient $clnt) {
parent::init($clnt);
$this->host($clnt->conf(self::YP_SIGN_HOST, 'https://sms.yunpian.com'));
}
function name() {
return self::NAME;
}
/**
* <h1>添加签名API</h1>
*
* <p>
* 参数名 类型 是否必须 描述 示例
* </p>
* <p>
* apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526
* </p>
* <p>
* sign String 是 签名内容 云片网
* </p>
* <p>
* notify Boolean 否 是否短信通知结果，默认true true
* </p>
* <p>
* apply_vip Boolean 否 是否申请专用通道，默认false false
* </p>
* <p>
* is_only_global Boolean 否 是否仅发国际短信，默认false false
* </p>
* <p>
* industry_type String 否 所属行业，默认“其它” 物联网 其他值例如:1. 游戏 2. 移动应用 3. 视频 4. 教育 5.
* IT/通信/电子服务 6. 电子商务 7. 金融 8. 网站 9. 商业服务 10. 房地产/建筑 11. 零售/租赁/贸易 12.
* 生产/加工/制造 13. 交通/物流 14. 文化传媒 15. 能源/电气 16. 政府企业 17. 农业 18. 物联网 19. 其它
* </p>
*
* @param array $param
* sign notify apply_vip is_only_global industry_type
* @return Result
*/
function add(array $param = []) {
static $must = [self::APIKEY,self::SIGN];
$r = $this->verifyParam($param, $must);
if (!$r->isSucc()) return $r;
$v = $this->version();
$h = new CommonResultHandler(function ($rsp) use ($v) {
switch ($v) {
case self::VERSION_V2:
return $rsp[self::SIGN];
}
return null;
});
return $this->path('add.json')->post($param, $h, $r);
}
/**
* <h1>修改签名API</h1>
* <p>
* 仅“审核中”或者“审核失败”的签名可以进行修改，修改后会重新提交给客服审核。
* </p>
* <p>
* 参数notify，apply_vip，is_only_global如果没有将会修改为默认值
* </p>
*
* <p>
* <p>
* 参数名 类型 是否必须 描述 示例
* </p>
* <p>
* apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526
* </p>
* <p>
* old_sign String 是 完整签名内容，用于指定修改哪个签名，可以加【】也可不加 云片网
* </p>
* <p>
* sign String 否 修改后的签名内容（如果要改签名内容） 云片网
* </p>
* <p>
* notify Boolean 否 是否短信通知结果，无此参数默认true true
* </p>
* <p>
* apply_vip Boolean 否 是否申请专用通道，无此参数默认false false
* </p>
* <p>
* is_only_global Boolean 否 是否仅发国际短信，无此参数默认false false
* </p>
* <p>
* industry_type String 否 所属行业，默认“其它” 物联网 其他值例如:1. 游戏 2. 移动应用 3. 视频 4. 教育 5.
* IT/通信/电子服务 6. 电子商务 7. 金融 8. 网站 9. 商业服务 10. 房地产/建筑 11. 零售/租赁/贸易 12.
* 生产/加工/制造 13. 交通/物流 14. 文化传媒 15. 能源/电气 16. 政府企业 17. 农业 18. 物联网 19. 其它
* </p>
*
* @param array $param
* old_sign sign notify apply_vip is_only_global industry_type
* @return Result
*/
function update(array $param) {
static $must = [self::APIKEY,self::OLD_SIGN];
$r = $this->verifyParam($param, $must);
if (!$r->isSucc()) return $r;
$v = $this->version();
$h = new CommonResultHandler(function ($rsp) use ($v) {
switch ($v) {
case self::VERSION_V2:
return $rsp[self::SIGN];
}
return null;
});
return $this->path('update.json')->post($param, $h, $r);
}
/**
* <h1>获取签名API</h1>
*
* <p>
* 参数名 类型 是否必须 描述 示例
* </p>
* <p>
* apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526
* </p>
* <p>
* id Long 否 签名id，暂未开放，如果传入此参数将会指定获取某个签名 9527
* </p>
* <p>
* sign String 否 签名内容 云片网
* </p>
* <p>
* page_num Integer 否 页码，1开始，不带或者格式错误返回全部 1
* </p>
* <p>
* page_size Integer 否 返回条数，必须大于0，不带或者格式错误返回全部 20
* </p>
*
* @param array $param
* sign notify page_num page_size
* @return Result
*/
function get(array $param) {
static $must = [self::APIKEY];
$r = $this->verifyParam($param, $must);
if (!$r->isSucc()) return $r;
$v = $this->version();
$h = new CommonResultHandler(function ($rsp) use ($v) {
switch ($v) {
case self::VERSION_V2:
return $rsp[self::SIGN];
}
return null;
});
return $this->path('get.json')->post($param, $h, $r);
}
}