SmsApi.php
22.3 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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
<?php
namespace Yunpian\Sdk\Api;
use Yunpian\Sdk\Model\Result;
use Yunpian\Sdk\YunpianClient;
/**
* https://www.yunpian.com/api2.0/sms.html
*
* @author dzh
* @since 1.0
*/
class SmsApi extends YunpianApi {
const NAME = "sms";
function init(YunpianClient $clnt) {
parent::init($clnt);
$this->host($clnt->conf(self::YP_SMS_HOST, 'https://sms.yunpian.com'));
}
function name() {
return self::NAME;
}
/**
* <h1>智能匹配模板发送 only v1</h1>
*
* <p>
* 参数名 类型 是否必须 描述 示例
* </p>
* <p>
* apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526
* </p>
* <p>
* mobile String 是 接收的手机号;发送多个手机号请以逗号分隔，一次不要超过1000个
* 国际短信仅支持单号码发送，国际号码需包含国际地区前缀号码，格式必须是"+"号开头("+"号需要urlencode处理，否则会出现格式错误)，国际号码不以"+"开头将被认为是中国地区的号码
* （针对国际短信，mobile参数会自动格式化到E.164格式，可能会造成传入mobile参数跟后续的状态报告中的号码不一致。E.164格式说明，参见：
* https://en.wikipedia.org/wiki/E.164） 单号码：15205201314
* 多号码：15205201314,15205201315 国际短信：+93701234567
* </p>
* <p>
* text String 是 短信内容 【云片网】您的验证码是1234
* </p>
* <p>
* extend String 否 扩展号。默认不开放，如有需要请联系客服申请 001
* </p>
* <p>
* uid String 否 该条短信在您业务系统内的ID，比如订单号或者短信发送记录的流水号。填写后发送状态返回值内将包含这个ID
* 默认不开放，如有需要请联系客服申请 10001
* </p>
* <p>
* callback_url String 否
* 本条短信状态报告推送地址。短信发送后将向这个地址推送短信发送报告。"后台-系统设置-数据推送与获取”可以做批量设置。如果后台已经设置地址的情况下，单次请求内也包含此参数，将以请求内的推送地址为准。
* </p>
*
* @deprecated
*
* @param array $param
* @return Result
*/
function send(array $param) {
static $must = [self::APIKEY,self::MOBILE,self::TEXT];
$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_V1:
return $rsp[self::RESULT];
}
return null;
});
return $this->path('send.json')->post($param, $h, $r);
}
/**
* <h1>单条发送</h1>
*
* <p>
* 参数名 类型 是否必须 描述 示例
* </p>
* <p>
* apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526
* </p>
* <p>
* mobile String 是
* 接收的手机号；仅支持单号码发送；国际号码需包含国际地区前缀号码，格式必须是"+"号开头("+"号需要urlencode处理，否则会出现格式错误)，国际号码不以"+"开头将被认为是中国地区的号码
* （针对国际短信，mobile参数会自动格式化到E.164格式，可能会造成传入mobile参数跟后续的状态报告中的号码不一致。E.164格式说明，参见：
* https://en.wikipedia.org/wiki/E.164） 国内号码：15205201314
* 国际号码：urlencode("+93701234567");
* </p>
* <p>
* text String 是 短信内容 【云片网】您的验证码是1234
* </p>
* <p>
* extend String 否 扩展号。默认不开放，如有需要请联系客服申请 001
* </p>
* <p>
* uid String 否 该条短信在您业务系统内的ID，比如订单号或者短信发送记录的流水号。填写后发送状态返回值内将包含这个ID
* 默认不开放，如有需要请联系客服申请 10001
* </p>
* <p>
* callback_url String 否
* 本条短信状态报告推送地址。短信发送后将向这个地址推送短信发送报告。"后台-系统设置-数据推送与获取”可以做批量设置。如果后台已经设置地址的情况下，单次请求内也包含此参数，将以请求内的推送地址为准。
* http://your_receive_url_address
* </p>
*
* @param array $param
* @return Result
*/
function single_send(array $param) {
static $must = [self::APIKEY,self::MOBILE,self::TEXT];
$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;
}
return null;
});
return $this->path('single_send.json')->post($param, $h, $r);
}
/**
* <h1>批量发送</h1>
*
* <p>
* 参数名 类型 是否必须 描述 示例
* </p>
* <p>
* apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526
* </p>
* <p>
* mobile String 是 接收的手机号；发送多个手机号请以逗号分隔，一次不要超过1000个。 单号码：15205201314
* 多号码：15205201314,15205201315
* </p>
* <p>
* text String 是 短信内容 【云片网】您的验证码是1234
* </p>
* <p>
* extend String 否 扩展号。默认不开放，如有需要请联系客服申请 001
* </p>
* <p>
* uid String 否 该条短信在您业务系统内的ID，比如订单号或者短信发送记录的流水号。填写后发送状态返回值内将包含这个ID
* 默认不开放，如有需要请联系客服申请 10001
* </p>
* <p>
* callback_url String 否
* 本条短信状态报告推送地址。短信发送后将向这个地址推送短信发送报告。"后台-系统设置-数据推送与获取”可以做批量设置。如果后台已经设置地址的情况下，单次请求内也包含此参数，将以请求内的推送地址为准。
* http://your_receive_url_address
* </p>
*
* @param array $param
* @return Result
*/
function batch_send(array $param) {
static $must = [self::APIKEY,self::MOBILE,self::TEXT];
$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;
}
return null;
});
return $this->path('batch_send.json')->post($param, $h, $r);
}
/**
* <h1>个性化发送</h1>
*
* <p>
* 参数名 类型 是否必须 描述 示例
* </p>
* <p>
* apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526
* </p>
* <p>
* mobile String 是
* 接收的手机号；多个手机号请以逗号分隔，一次不要超过1000个且手机号个数必须与短信内容条数相等；不支持国际号码发送；
* 多号码：15205201314,15205201315
* </p>
* <p>
* text String 是
* 短信内容，多个短信内容请使用UTF-8做urlencode后，使用逗号分隔，一次不要超过1000条且短信内容条数必须与手机号个数相等
* 内容示意：UrlEncode("【云片网】您的验证码是1234", "UTF-8") + "," +
* UrlEncode("【云片网】您的验证码是5678", "UTF-8")
* </p>
* <p>
* extend String 否 扩展号。默认不开放，如有需要请联系客服申请 001
* </p>
* <p>
* uid String 否 该条短信在您业务系统内的ID，比如订单号或者短信发送记录的流水号。填写后发送状态返回值内将包含这个ID
* 默认不开放，如有需要请联系客服申请 10001
* </p>
* <p>
* callback_url String 否
* 本条短信状态报告推送地址。短信发送后将向这个地址推送短信发送报告。"后台-系统设置-数据推送与获取”可以做批量设置。如果后台已经设置地址的情况下，单次请求内也包含此参数，将以请求内的推送地址为准。
* http://your_receive_url_address
* </p>
*
* @param array $param
* @return Result
*/
function multi_send(array $param) {
static $must = [self::APIKEY,self::MOBILE,self::TEXT];
$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_V1:
return $rsp;
case self::VERSION_V2:
return $rsp;
}
return null;
});
return $this->path('multi_send.json')->post($param, $h, $r);
}
/**
* <h1>获取状态报告</h1>
*
* <p>
* 参数名 类型 是否必须 描述 示例
* </p>
* <p>
* apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526
* </p>
* <p>
* page_size Integer 否 每页个数，最大100个，默认20个 20
* </p>
*
* @param array $param
* @return Result
*/
function pull_status(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_V1:
return $rsp[self::SMS_STATUS];
case self::VERSION_V2:
return $rsp;
}
return null;
});
return $this->path('pull_status.json')->post($param, $h, $r);
}
/**
* <h1>获取回复短信</h1>
*
* <p>
* 参数名 类型 是否必须 描述 示例
* </p>
* <p>
* apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526
* </p>
* <p>
* page_size Integer 否 每页个数，最大100个，默认20个 20
* </p>
*
* @param array $param
* @return Result
*/
function pull_reply(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_V1:
return $rsp[self::SMS_REPLY];
case self::VERSION_V2:
return $rsp;
}
return null;
});
return $this->path('pull_reply.json')->post($param, $h, $r);
}
/**
* <h1>查回复的短信</h1>
*
* <p>
* 参数名 类型 是否必须 描述 示例
* </p>
* <p>
* apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526
* </p>
* <p>
* start_time String 是 短信回复开始时间 2013-08-11 00:00:00
* </p>
* <p>
* end_time String 是 短信回复结束时间 2013-08-12 00:00:00
* </p>
* <p>
* page_num Integer 是 页码，默认值为1 1
* </p>
* <p>
* page_size Integer 是 每页个数，最大100个 20
* </p>
* <p>
* mobile String 否 填写时只查该手机号的回复，不填时查所有的回复 15205201314
* </p>
* <p>
* return_fields 否 返回字段（暂未开放
* </p>
* <p>
* sort_fields 否 排序字段（暂未开放） 默认按提交时间降序
* </p>
*
* @param array $param
* @return Result
*/
function get_reply(array $param) {
static $must = [self::APIKEY,self::START_TIME,self::END_TIME,self::PAGE_NUM,self::PAGE_SIZE];
$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_V1:
return $rsp[self::SMS_REPLY];
case self::VERSION_V2:
return $rsp;
}
return null;
});
return $this->path('get_reply.json')->post($param, $h, $r);
}
/**
* <h1>查屏蔽词</h1>
*
* <p>
* 参数名 类型 是否必须 描述 示例
* </p>
* <p>
* apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526
* </p>
* <p>
* text String 是 要检查的短信模板或者内容 这是一条测试短信
* </p>
*
* @param array $param
* @return Result
*/
function get_black_word(array $param) {
static $must = [self::APIKEY,self::TEXT];
$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_V1:
return $rsp[self::RESULT];
case self::VERSION_V2:
return $rsp;
}
return null;
});
return $this->path('get_black_word.json')->post($param, $h, $r);
}
/**
* <h1>查短信发送记录</h1>
*
* <p>
* 参数名 类型 是否必须 描述 示例
* </p>
* <p>
* apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526
* </p>
* <p>
* mobile String 否 需要查询的手机号 15205201314
* </p>
* <p>
* start_time String 是 短信发送开始时间 2013-08-11 00:00:00
* </p>
* <p>
* end_time String 是 短信发送结束时间 2013-08-12 00:00:00
* </p>
* <p>
* page_num Integer 否 页码，默认值为1 1
* </p>
* <p>
* page_size Integer 否 每页个数，最大100个 20
* </p>
*
* @param array $param
* @return Result
*/
function get_record(array $param) {
static $must = [self::APIKEY,self::START_TIME,self::END_TIME];
$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_V1:
return $rsp[self::SMS];
case self::VERSION_V2:
return $rsp;
}
return null;
});
return $this->path('get_record.json')->post($param, $h, $r);
}
/**
* <h1>统计短信条数</h1>
*
* <p>
* 参数名 类型 是否必须 描述 示例
* </p>
* <p>
* apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526
* </p>
* <p>
* start_time String 是 短信发送开始时间 2013-08-11 00:00:00
* </p>
* <p>
* end_time String 是 短信发送结束时间 2013-08-12 00:00:00
* </p>
* <p>
* mobile String 否 需要查询的手机号 15205201314
* </p>
* <p>
* page_num Integer 否 页码，默认值为1 1
* </p>
* <p>
* page_size Integer 否 每页个数，最大100个 20
* </p>
*
* @param array $param
* @return Result
*/
function count(array $param) {
static $must = [self::APIKEY,self::START_TIME,self::END_TIME];
$r = $this->verifyParam($param, $must);
if (!$r->isSucc()) return $r;
$v = $this->version();
$h = new CommonResultHandler(function ($rsp) use ($v) {
$total = $rsp[self::TOTAL];
return is_null($total) ? 0 : $total;
});
return $this->path('count.json')->post($param, $h, $r);
}
/**
* <h1>指定模板发送 only v1</h1>
*
* <p>
* 参数名 类型 是否必须 描述 示例
* </p>
* <p>
* apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526
* </p>
* <p>
* mobile String 是 接收的手机号 15205201314
* </p>
* <p>
* tpl_id Long 是 模板id 1
* </p>
* <p>
* tpl_value String 是 变量名和变量值对。请先对您的变量名和变量值分别进行urlencode再传递。使用参考：代码示例。
* 注：变量名和变量值都不能为空 模板： 【#company#】您的验证码是#code#。 最终发送结果： 【云片网】您的验证码是1234。
* tplvalue=urlencode("#code#") + "=" + urlencode("1234") + "&" +
* urlencode("#company#") + "=" + urlencode("云片网"); 若您直接发送报文请求则使用下面这种形式
* tplvalue=urlencode(urlencode("#code#") + "=" + urlencode("1234") + "&" +
* urlencode("#company#") + "=" + urlencode("云片网"));
* </p>
* <p>
* extend String 否 扩展号。默认不开放，如有需要请联系客服申请 001
* </p>
* <p>
* uid String 否 用户自定义唯一id。最大长度不超过256的字符串。 默认不开放，如有需要请联系客服申请 10001
* </p>
*
* @deprecated
*
* @param array $param
* @return Result
*/
function tpl_send(array $param) {
static $must = [self::APIKEY,self::MOBILE,self::TPL_ID,self::TPL_VALUE];
$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_V1:
return $rsp[self::RESULT];
}
return null;
});
return $this->path('tpl_send.json')->post($param, $h, $r);
}
/**
* <h1>指定模板单发 only v2</h1>
*
* <p>
* 参数名 类型 是否必须 描述 示例
* </p>
* <p>
* apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526
* </p>
* <p>
* mobile String 是
* 接收的手机号（针对国际短信，mobile参数会自动格式化到E.164格式，可能会造成传入mobile参数跟后续的状态报告中的号码不一致。E.164格式说明，参见：
* https://en.wikipedia.org/wiki/E.164） 15205201314
* </p>
* <p>
* tpl_id Long 是 模板id 1
* </p>
* <p>
* tpl_value String 是 变量名和变量值对。请先对您的变量名和变量值分别进行urlencode再传递。使用参考：代码示例。
* 注：变量名和变量值都不能为空 模板： 【#company#】您的验证码是#code#。 最终发送结果： 【云片网】您的验证码是1234。
* tplvalue=urlencode("#code#") + "=" + urlencode("1234") + "&" +
* urlencode("#company#") + "=" + urlencode("云片网"); 若您直接发送报文请求则使用下面这种形式
* tplvalue=urlencode(urlencode("#code#") + "=" + urlencode("1234") + "&" +
* urlencode("#company#") + "=" + urlencode("云片网"));
* </p>
* <p>
* extend String 否 扩展号。默认不开放，如有需要请联系客服申请 001
* </p>
* <p>
* uid String 否 用户自定义唯一id。最大长度不超过256的字符串。 默认不开放，如有需要请联系客服申请 10001
* </p>
*
* @deprecated
*
* @param array $param
* @return Result
*/
function tpl_single_send(array $param) {
static $must = [self::APIKEY,self::MOBILE,self::TPL_ID,self::TPL_VALUE];
$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;
}
return null;
});
return $this->path('tpl_single_send.json')->post($param, $h, $r);
}
/**
* <h1>指定模板群发 only v2</h1>
*
* <p>
* 参数名 类型 是否必须 描述 示例
* </p>
* <p>
* apikey String 是 用户唯一标识 9b11127a9701975c734b8aee81ee3526
* </p>
* <p>
* mobile String 是
* 接收的手机号（针对国际短信，mobile参数会自动格式化到E.164格式，可能会造成传入mobile参数跟后续的状态报告中的号码不一致。E.164格式说明，参见：
* https://en.wikipedia.org/wiki/E.164） 15205201314
* </p>
* <p>
* tpl_id Long 是 模板id 1
* </p>
* <p>
* tpl_value String 是 变量名和变量值对。请先对您的变量名和变量值分别进行urlencode再传递。使用参考：代码示例。
* 注：变量名和变量值都不能为空 模板： 【#company#】您的验证码是#code#。 最终发送结果： 【云片网】您的验证码是1234。
* tplvalue=urlencode("#code#") + "=" + urlencode("1234") + "&" +
* urlencode("#company#") + "=" + urlencode("云片网"); 若您直接发送报文请求则使用下面这种形式
* tplvalue=urlencode(urlencode("#code#") + "=" + urlencode("1234") + "&" +
* urlencode("#company#") + "=" + urlencode("云片网"));
* </p>
* <p>
* extend String 否 扩展号。默认不开放，如有需要请联系客服申请 001
* </p>
* <p>
* uid String 否 用户自定义唯一id。最大长度不超过256的字符串。 默认不开放，如有需要请联系客服申请 10001
* </p>
*
* @deprecated
*
* @param array $param
* @return Result
*/
function tpl_batch_send(array $param) {
static $must = [self::APIKEY,self::MOBILE,self::TPL_ID,self::TPL_VALUE];
$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;
}
return null;
});
return $this->path('tpl_batch_send.json')->post($param, $h, $r);
}
}