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
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
12396
12397
12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
|
<?php return [
'version' => '1.0',
'info' => [
'style' => 'RPC',
'product' => 'Dysmsapi',
'version' => '2017-05-25',
],
'directories' => [
[
'id' => 402523,
'title' => '资质管理',
'type' => 'directory',
'children' => [
'SubmitSmsQualification',
'QuerySmsQualificationRecord',
'QuerySingleSmsQualification',
'UpdateSmsQualification',
'DeleteSmsQualification',
'RequiredPhoneCode',
'ValidPhoneCode',
],
],
[
'id' => 402531,
'title' => '授权委托书',
'type' => 'directory',
'children' => [
'CreateSmsAuthorizationLetter',
'QuerySmsAuthorizationLetter',
],
],
[
'id' => 402534,
'title' => '签名管理',
'type' => 'directory',
'children' => [
'CreateSmsSign',
'GetSmsSign',
'QuerySmsSignList',
'UpdateSmsSign',
'DeleteSmsSign',
'ChangeSignatureQualification',
'AddSmsSign',
'ModifySmsSign',
'QuerySmsSign',
],
],
[
'id' => 402544,
'title' => '商标+ICP备案',
'type' => 'directory',
'children' => [
'CreateSmsTrademark',
'QuerySmsTrademark',
'CreateSmsAppIcpRecord',
'QuerySmsAppIcpRecord',
],
],
[
'id' => 402549,
'title' => '模板管理',
'type' => 'directory',
'children' => [
'CreateSmsTemplate',
'GetSmsTemplate',
'QuerySmsTemplateList',
'UpdateSmsTemplate',
'DeleteSmsTemplate',
'AddSmsTemplate',
'ModifySmsTemplate',
'QuerySmsTemplate',
],
],
[
'id' => 402558,
'title' => '短信发送',
'type' => 'directory',
'children' => [
'SendSms',
'SendBatchSms',
],
],
[
'id' => 402561,
'title' => '发送查询',
'type' => 'directory',
'children' => [
'QuerySendDetails',
'QuerySendStatistics',
],
],
[
'id' => 402564,
'title' => '数字短信',
'type' => 'directory',
'children' => [
'CreateDigitalSignOrder',
'QueryDigitalSignByName',
'CreateDigitalSmsTemplate',
],
],
[
'id' => 402568,
'title' => '卡片短信',
'type' => 'directory',
'children' => [
'GetOSSInfoForCardTemplate',
'GetMediaResourceId',
'CreateCardSmsTemplate',
'QueryCardSmsTemplate',
'CheckMobilesCardSupport',
'QueryMobilesCardSupport',
'GetCardSmsLink',
'GetCardSmsDetails',
'QueryCardSmsTemplateReport',
'SendCardSms',
'SendBatchCardSms',
],
],
[
'id' => 402580,
'title' => '获取OSS上传信息',
'type' => 'directory',
'children' => [
'GetQualificationOssInfo',
'GetOSSInfoForUploadFile',
'GetSmsOcrOssInfo',
],
],
[
'id' => 402584,
'title' => '国内发国际短信转化率',
'type' => 'directory',
'children' => [
'SmsConversionIntl',
'ConversionDataIntl',
],
],
[
'id' => 402587,
'title' => '短链管理',
'type' => 'directory',
'children' => [
'AddShortUrl',
'DeleteShortUrl',
'QueryShortUrl',
],
],
[
'id' => 402591,
'title' => '标签管理',
'type' => 'directory',
'children' => [
'ListTagResources',
'TagResources',
'UntagResources',
],
],
[
'id' => 0,
'title' => '其它',
'type' => 'directory',
'children' => [
'GetSmsTemplateList',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'SubmitSmsQualification' => [
'summary' => '根据工信部及运营商实名制发送短信的要求,国内短信需提供签名归属方的资质证件信息。请先申请短信资质,然后再申请签名和模板。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '264876',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'QualificationName',
'in' => 'query',
'schema' => [
'title' => '资质名称,名称不能重复',
'description' => '资质名称,用于管理、区分您申请的多个资质,不会出现在短信内容中。名称不可与已有资质名称重复,仅支持中文、英文或与数字组合,不支持任何符号或纯数字输入,长度不超过100字符。',
'type' => 'string',
'required' => true,
'example' => '阿里云云通信有限公司资质李华',
],
],
[
'name' => 'UseBySelf',
'in' => 'query',
'schema' => [
'title' => '资质是自用还是他用,true:自用,false:他用',
'description' => '资质申请用途,取值:'."\n"
."\n"
.'- **true**:**自用**,签名所属主体与本账号实名认证的主体一致。'."\n"
.'- **false**:**他用**,签名所属主体与本账号实名认证的主体不一致。',
'type' => 'boolean',
'required' => true,
'example' => 'true',
],
],
[
'name' => 'CompanyType',
'in' => 'query',
'schema' => [
'title' => '企业类型, COMPANY:公司;NON_PROFIT_ORGANIZATION:政府或者事业单位',
'description' => '企业类型,取值:'."\n"
."\n"
.'- COMPANY:企业。'."\n"
."\n"
.'- NON_PROFIT_ORGANIZATION:政府机关或事业单位。',
'type' => 'string',
'required' => true,
'example' => 'COMPANY',
],
],
[
'name' => 'BusinessLicensePics',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '企业营业证件信息,非大客户必填',
'description' => '企业营业证件信息。资质用途`UseBySelf`选择`false`他用时,此参数必填。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'title' => '营业证件类型,businessLicense:营业执照;organizationCodeLicense:组织机构代码证;taxRegistrationLicense:税务登记证;socialCreditLicense:社会信用代码证书;newStyleBusinessLicense:三证合一;signLegalLicense:签名归属方的事业单位法人证书;otherLicense:其他类型执照证书',
'description' => '营业证件类型。取值:'."\n"
."\n"
.'- socialCreditLicense:社会信用代码证书。'."\n"
.'- businessLicense:企业营业执照。'."\n"
.'- signLegalLicense:事业单位法人证书。'."\n"
.'- otherLicense:其他。'."\n"
."\n"
.'选择一种上传即可,证件上需含有:企业名称、统一社会信用代码、证件有效期。',
'type' => 'string',
'required' => false,
'example' => 'businessLicense',
],
'LicensePic' => [
'title' => '营业证件图片标识的osskey',
'description' => '营业证件图片,仅支持jpg、png、gif、jpeg格式的图片,图片不大于5MB。请填写上传到OSS的文件路径参数,待上传的文件命名不可包含中文和特殊字符,上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n"
."\n\n"
.'><notice>'."\n"
."\n"
.'证件的彩色原件无需盖章,若上传复印件/黑白照片,需要在复印件上加盖企业红章并拍照上传。'."\n"
.'></notice>',
'type' => 'string',
'required' => false,
'example' => '123456/111.png',
],
],
'required' => false,
],
'required' => false,
'example' => '',
],
],
[
'name' => 'CompanyName',
'in' => 'query',
'schema' => [
'title' => '公司名称',
'description' => '企业名称。符号仅支持中点`·`、中文`【】()`、英文`()`及`空格`,不可含其他符号或纯数字,长度不超过150字符。',
'type' => 'string',
'required' => true,
'example' => '阿里云云通信有限公司',
],
],
[
'name' => 'OrganizationCode',
'in' => 'query',
'schema' => [
'title' => '社会统一信用代码',
'description' => '社会统一信用代码,长度不超过150字符。',
'type' => 'string',
'required' => true,
'example' => '910X********0012',
],
],
[
'name' => 'BussinessLicenseExpDate',
'in' => 'query',
'schema' => [
'title' => '企业营业时间开始和结束字符串,格式示例2023-01-01~2033-01-01',
'description' => '营业证件有效期。有效期格式:YYYY-MM-DD~YYYY-MM-DD。'."\n"
.'> 证照有效期为长期时,截止日期可填:2099-12-31。',
'type' => 'string',
'required' => true,
'example' => '2023-01-01~2033-01-01',
],
],
[
'name' => 'LegalPersonIdCardFrontSide',
'in' => 'query',
'schema' => [
'title' => '法人身份证照片国徽面',
'description' => '法定代表人证件正面照片(身份证国徽面),仅支持jpg、png、gif、jpeg格式的图片,图片不大于5MB。请填写上传到OSS的文件路径参数,待上传的文件命名不可包含中文和特殊字符,上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n"
."\n\n"
.'> 系统会使用您填写的法人姓名、证件号码进行校验;若校验不通过,则需要上传法定代表人身份证件照片。',
'type' => 'string',
'required' => false,
'example' => '123456/111.png',
],
],
[
'name' => 'LegalPersonIdCardBackSide',
'in' => 'query',
'schema' => [
'title' => '法人身份证照片人像面',
'description' => '法定代表人证件反面照片(身份证人像面),仅支持jpg、png、gif、jpeg格式的图片,图片不大于5MB。请填写上传到OSS的文件路径参数,待上传的文件命名不可包含中文和特殊字符,上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n"
."\n"
.'> 系统会使用您填写的法人姓名、证件号码进行校验;若校验不通过,则需要上传法定代表人身份证件照片。',
'type' => 'string',
'required' => false,
'example' => '123456/111.png',
],
],
[
'name' => 'LegalPersonName',
'in' => 'query',
'schema' => [
'title' => '法人姓名',
'description' => '法定代表人姓名,长度不超过50字符。'."\n"
."\n"
.'> - 若组织证件中无法定代表人信息,但存在负责人/首席代表等相关信息,请准备证件中对应负责人或首席代表的身份证件照片。'."\n"
.'> - 若组织证件中无法定代表人信息,且无任何负责人信息,请准备业务主要负责人的姓名、身份证件照片。',
'type' => 'string',
'required' => true,
'example' => '李华',
],
],
[
'name' => 'LegalPersonIDCardNo',
'in' => 'query',
'schema' => [
'title' => '法人身份证号码',
'description' => '法定代表人证件号码。',
'type' => 'string',
'required' => true,
'example' => '511391********5123',
],
],
[
'name' => 'LegalPersonIdCardEffTime',
'in' => 'query',
'schema' => [
'title' => '法人身份证有效期',
'description' => '法定代表人证件有效期。有效期格式:YYYY-MM-DD~YYYY-MM-DD。'."\n"
.'> 证件有效期为长期时,截止日期可填:2099-12-31。',
'type' => 'string',
'required' => true,
'example' => '2023-01-01~2033-01-01',
],
],
[
'name' => 'LegalPersonIDCardType',
'in' => 'query',
'schema' => [
'title' => '法人身份证类型。identityCard:中国居民身份证;passport:护照;homeReturnPermit:港澳居民来往内地通行证;TaiwanCompatriotPermit:台湾居民来往大陆通行证;residencePermit:港澳台居民居住证";other:其他',
'description' => '法定代表人证件类型。取值:'."\n"
."\n"
.'- identityCard:身份证。'."\n"
.'- passport:护照。'."\n"
.'- homeReturnPermit:港澳居民来往内地通行证。'."\n"
.'- TaiwanCompatriotPermit:台湾居民来往大陆通行证。'."\n"
.'- residencePermit:港澳台居民居住证。'."\n"
.'- other:其他。',
'type' => 'string',
'required' => true,
'example' => 'identityCard',
],
],
[
'name' => 'AdminIDCardPic',
'in' => 'query',
'schema' => [
'title' => '经办人身份证照片人像面',
'description' => '管理员证件反面照片(身份证人像面),仅支持jpg、png、gif、jpeg格式的图片,图片不大于5MB。请填写上传到OSS的文件路径参数,待上传的文件命名不可包含中文和特殊字符,上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n"
."\n"
.'><notice>'."\n"
.'证件的彩色原件无需盖章,若上传复印件/黑白照片,需要在复印件上加盖企业红章并拍照上传。'."\n"
."\n"
.'></notice>',
'type' => 'string',
'required' => true,
'example' => '123456/111.png',
],
],
[
'name' => 'AdminIDCardFrontFace',
'in' => 'query',
'schema' => [
'title' => '经办人身份证照片国徽面',
'description' => '管理员证件正面照片(身份证国徽面),仅支持jpg、png、gif、jpeg格式的图片,图片不大于5MB。请填写上传到OSS的文件路径参数,待上传的文件命名不可包含中文和特殊字符上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n"
."\n"
.'><notice>'."\n"
.'证件的彩色原件无需盖章,若上传复印件/黑白照片,需要在复印件上加盖企业红章并拍照上传。'."\n"
."\n"
.'></notice>',
'type' => 'string',
'required' => true,
'example' => '123456/111.png',
],
],
[
'name' => 'AdminName',
'in' => 'query',
'schema' => [
'title' => '经办人姓名',
'description' => '管理员姓名,长度不超过50字符。**在当前的[短信签名实名制](~~2873145~~)要求下,同一个管理员若申请多个不同的企业资质会导致报备失败,请确认一管一企以提升报备成功率。**'."\n"
."\n"
.'> 管理员(又称经办人)指登录阿里云账号并管理短信业务的人员,一般是贵方管理此阿里云账号下资质、签名和模板,并进行短信发送的相关运营人员,且此人手机号可接收验证码。管理员不一定是此阿里云账号的管理员,管理员可以与企业法人为同一人。',
'type' => 'string',
'required' => true,
'example' => '李华',
],
],
[
'name' => 'AdminIDCardNo',
'in' => 'query',
'schema' => [
'title' => '经办人身份证号码',
'description' => '管理员证件号码。',
'type' => 'string',
'required' => true,
'example' => '511391********5123',
],
],
[
'name' => 'AdminIDCardType',
'in' => 'query',
'schema' => [
'title' => '管理员身份证类型。identityCard:中国居民身份证;passport:护照;homeReturnPermit:港澳居民来往内地通行证;TaiwanCompatriotPermit:台湾居民来往大陆通行证;residencePermit:港澳台居民居住证";other:其他',
'description' => '管理员证件类型。取值:'."\n"
."\n"
.'- identityCard:身份证。'."\n"
.'- passport:护照。'."\n"
.'- homeReturnPermit:港澳居民来往内地通行证。'."\n"
.'- TaiwanCompatriotPermit:台湾居民来往大陆通行证。'."\n"
.'- residencePermit:港澳台居民居住证。'."\n"
.'- other:其他。',
'type' => 'string',
'required' => true,
'example' => 'identityCard',
],
],
[
'name' => 'AdminIDCardExpDate',
'in' => 'query',
'schema' => [
'title' => '经办人身份证有效期,格式示例2023-01-01~2033-01-01',
'description' => '管理员证件有效期。有效期格式:YYYY-MM-DD~YYYY-MM-DD。'."\n"
.'> 证件有效期为长期时,截止日期可填:2099-12-31。',
'type' => 'string',
'required' => true,
'example' => '2023-01-01~2033-01-01',
],
],
[
'name' => 'AdminPhoneNo',
'in' => 'query',
'schema' => [
'title' => '经办人手机号码',
'description' => '管理员手机号码,格式:+/+86/0086/86 或无任何前缀的手机号码,例如1390000****。',
'type' => 'string',
'required' => true,
'example' => '137****1234',
],
],
[
'name' => 'CertifyCode',
'in' => 'query',
'schema' => [
'title' => '手机号验证码',
'description' => '手机号验证码。请调用[RequiredPhoneCode](~~RequiredPhoneCode~~)接口并传入**管理员手机号码**后,在此填入接收到的短信验证码。'."\n"
."\n"
.'> 您可以使用[ValidPhoneCode](~~ValidPhoneCode~~)自行校验短信验证码是否准确后再传入。',
'type' => 'string',
'required' => true,
'example' => '1234',
],
],
[
'name' => 'OtherFiles',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '更多资料',
'description' => '更多资料,如果您还有其他证明或备注材料、照片等,可在此上传。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LicensePic' => [
'title' => '',
'description' => '更多资料文件,仅支持png、jpg、jpeg、doc、docx、pdf格式,文件不大于5MB。请填写上传到OSS的文件路径参数,待上传的文件命名不可包含中文和特殊字符,上传操作请参见通过[OSS上传文件](~~2833114~~)。',
'type' => 'string',
'required' => false,
'example' => '123456/111.png',
],
],
'required' => false,
],
'required' => false,
'example' => '',
],
],
[
'name' => 'WhetherShare',
'in' => 'query',
'schema' => [
'title' => '是否同意与其他业务线共享',
'description' => '资质授权,是否同意与其他云通信产品(如国内语音、国内号码隐私保护)的资质共享。仅当您申请**自用资质**,且资质信息**与当前阿里云账号认证企业信息一致**时可被共享、复用;其他情况无效。取值:'."\n"
."\n"
.'- true:同意,您的资质信息可在其他云通信产品的“资质认证环节”调用,免除重复认证环节。'."\n"
.'- false:不同意。',
'type' => 'boolean',
'required' => true,
'enumValueTitles' => [
'true' => 'true',
'false' => 'false',
],
'example' => 'false',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'title' => '备注',
'description' => '备注。如果您还有其他信息需要说明,或者需要给资质审核人员备注说明,可在此添加描述。',
'type' => 'string',
'required' => false,
'example' => '无',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'title' => '',
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA'."\n",
],
'Message' => [
'title' => '',
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Data' => [
'title' => '',
'description' => '资质ID。',
'type' => 'string',
'example' => '1000****',
],
'Code' => [
'title' => '',
'description' => '请求状态码。'."\n"
."\n"
.'* 返回OK代表请求成功。'."\n"
.'* 其他错误码,请参见本章节的错误码列表或产品[API错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '',
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'enumValueTitles' => [
'true' => 'true',
'false' => 'false',
],
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AdminBackOssFileNotUploadError',
'errorMessage' => 'Administrator ID card portrait photo not uploaded.',
],
[
'errorCode' => 'AdminDateNotValid',
'errorMessage' => 'Current time is outside the administrator ID card validity period.',
],
[
'errorCode' => 'AdminIdcardExpdateNotMatchRegexError',
'errorMessage' => 'Invalid administrator ID card expiration time format.',
],
[
'errorCode' => 'AdminIdcardFrontFaceFileError',
'errorMessage' => 'Invalid format for administrator\'s ID card national emblem photo.',
],
[
'errorCode' => 'AdminIdcardFrontFaceNullError',
'errorMessage' => 'Administrator\'s ID card national emblem photo cannot be empty.',
],
[
'errorCode' => 'AdminIdcardNoNullError',
'errorMessage' => 'Administrator\'s ID number cannot be empty.',
],
[
'errorCode' => 'AdminIdcardNotMatchRegex',
'errorMessage' => 'Invalid administrator ID number format.',
],
[
'errorCode' => 'AdminIdcardPicsFileError',
'errorMessage' => 'Invalid format for administrator\'s ID card portrait photo.',
],
[
'errorCode' => 'AdminIdcardPicsNullError',
'errorMessage' => 'Administrator\'s ID card portrait photo cannot be empty.',
],
[
'errorCode' => 'AdminIdcardTypeError',
'errorMessage' => 'Invalid administrator ID card type.',
],
[
'errorCode' => 'AdminNameNullError',
'errorMessage' => 'Administrator\'s name cannot be empty.',
],
[
'errorCode' => 'BusinessLicenseDateNotMatchRegexError',
'errorMessage' => 'Invalid business license expiration time format.',
],
[
'errorCode' => 'BusinessLicenseDateNotValid',
'errorMessage' => 'Current time is outside the business license validity period.',
],
[
'errorCode' => 'BusinessLicenseOssFileNotUploadError',
'errorMessage' => 'Business license file not uploaded.',
],
[
'errorCode' => 'BusinessLicensePicsFileError',
'errorMessage' => 'Invalid business license file format.',
],
[
'errorCode' => 'BusinessLicensePicsNullError',
'errorMessage' => 'Business license documents cannot be empty.',
],
[
'errorCode' => 'BusinessLicenseTypeError',
'errorMessage' => 'Invalid business license type.',
],
[
'errorCode' => 'CertifyCodeError',
'errorMessage' => 'SMS verification code is incorrect.',
],
[
'errorCode' => 'CompanyNameNullError',
'errorMessage' => 'Company name cannot be empty.',
],
[
'errorCode' => 'CompanyTypeError',
'errorMessage' => 'Invalid company type.',
],
[
'errorCode' => 'QualificationNameNullError',
'errorMessage' => 'Qualification name cannot be empty.',
],
[
'errorCode' => 'QualificationNameNotMatchRegex',
'errorMessage' => 'Qualification names must be in Chinese, English, or alphanumeric combinations. Symbols or pure numbers are not supported.',
],
[
'errorCode' => 'QualificationNameAlreadyExist',
'errorMessage' => 'The qualification name already exists. Please modify and resubmit.',
],
[
'errorCode' => 'OtherFileTypeError',
'errorMessage' => 'Invalid file format for other documents.',
],
[
'errorCode' => 'LegalPersonIdcardTypeError',
'errorMessage' => 'Invalid legal person ID card type.',
],
[
'errorCode' => 'LegalIdCardNoNullError',
'errorMessage' => 'Legal person\'s ID number cannot be empty.',
],
[
'errorCode' => 'LegalIdCardNotMatchRegex',
'errorMessage' => 'Invalid legal person ID number format.',
],
[
'errorCode' => 'LegalPersonNameNullError',
'errorMessage' => 'Legal person\'s name cannot be empty.',
],
[
'errorCode' => 'OrganizationCodeNullError',
'errorMessage' => 'Unified Social Credit Code cannot be empty.',
],
[
'errorCode' => 'LegalPersonIdcardEfftimeNotMatchRegexError',
'errorMessage' => 'Invalid legal person ID card expiration time format.',
],
[
'errorCode' => 'LegalDateNotValid',
'errorMessage' => 'Current time is outside the legal person ID card validity period.',
],
[
'errorCode' => 'LegalFrontOssFileNotUploadError',
'errorMessage' => 'Legal person ID card national emblem photo not uploaded.',
],
[
'errorCode' => 'LegalBackOssFileNotUploadError',
'errorMessage' => 'Legal person ID card portrait photo not uploaded.',
],
[
'errorCode' => 'AdminFrontOssFileNotUploadError',
'errorMessage' => 'Administrator ID card national emblem photo not uploaded.',
],
[
'errorCode' => 'OtherOssFileNotUploadError',
'errorMessage' => 'Other files not uploaded.',
],
[
'errorCode' => 'GrayCustAccessError',
'errorMessage' => 'This customer is not authorized to use the OpenAPI. Please contact support for whitelisting.',
],
[
'errorCode' => 'CustNotExistError',
'errorMessage' => 'Customer\'s cloud communication information is invalid.',
],
[
'errorCode' => 'NotEnterpriseCertifyCustCheckError',
'errorMessage' => 'Non-enterprise certified customers are not allowed to access.',
],
[
'errorCode' => 'PhoneNoCertifyCodeNullError',
'errorMessage' => 'Phone number and verification code cannot be empty.',
],
[
'errorCode' => 'CompanyVerificationFailedCompanyStateInvalid',
'errorMessage' => 'Four Elements Verification Failed: Company is not in normal operation.',
],
[
'errorCode' => 'CompanyVerificationFailedFourElementsError',
'errorMessage' => 'Four Elements Verification Failed: Authentication Failed.',
],
[
'errorCode' => 'CompanyVerificationFailedMismatch',
'errorMessage' => 'Four Elements Verification Failed: Mismatch between Legal Representative and Company Information.',
],
[
'errorCode' => 'CompanyVerificationFailedNoCompany',
'errorMessage' => 'Four Elements Verification Failed: Company Not Found.',
],
[
'errorCode' => 'CompanyVerificationFailedNoLegalPerson',
'errorMessage' => 'Four Elements Verification Failed: Legal Representative Not Found.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"25D5AFDE-8EBC-132E-8909-1FDC071DA\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"1000****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '申请短信资质',
'description' => '- 在发起申请前,请您阅读[资质材料说明](~~2384377~~)并准备相关资质材料。'."\n"
.'- 目前仅**企业认证**用户可使用API申请短信资质。若您当前阿里云账号为个人认证,请通过短信服务[控制台](https://dysms.console.aliyun.com/domestic/text/qualification/add)申请资质,或[升级为企业认证](~~37178~~)。[查看我的帐户认证类型](https://myaccount.console.aliyun.com/cert-info)'."\n"
.'- 不支持批量申请短信资质,建议每次申请至少间隔5秒。',
'requestParamsDescription' => '><notice>'."\n"
."\n"
.'短信资质材料具体要求请参见[资质材料说明](~~2384377~~),要求可能随工信部与运营商要求实时调整,请以审核实际结果为准。'."\n"
."\n"
.'></notice>',
],
'QuerySmsQualificationRecord' => [
'summary' => '当您在申请短信资质后,可以通过此接口查询资质列表及其审核详情,支持条件筛选查询。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '264880',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
'FEATUREdysms2H0K7P',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'QualificationGroupName',
'in' => 'query',
'schema' => [
'title' => '资质组名称',
'description' => '资质名称。',
'type' => 'string',
'required' => false,
'example' => '阿里云云通信有限公司李华',
],
],
[
'name' => 'CompanyName',
'in' => 'query',
'schema' => [
'title' => '公司名',
'description' => '企业名称。',
'type' => 'string',
'required' => false,
'example' => '阿里云云通信有限公司',
],
],
[
'name' => 'State',
'in' => 'query',
'schema' => [
'title' => '审核状态。INT:审核中FAILED:审核失败,PASSED:审核通过,NOT_FINISH:资料待补充,CANCELED:已撤回',
'description' => '审核状态。取值:'."\n"
."\n"
.'- INIT:审核中。'."\n"
.'- NOT_PASS:审核不通过。 '."\n"
.'- PASS:审核通过。'."\n"
.'- NOT_FINISH:资料待补充。'."\n"
.'- CANCEL:已撤回。',
'type' => 'string',
'required' => false,
'example' => 'PASS',
],
],
[
'name' => 'WorkOrderId',
'in' => 'query',
'schema' => [
'title' => '工单ID',
'description' => '审核工单ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2001****',
],
],
[
'name' => 'LegalPersonName',
'in' => 'query',
'schema' => [
'title' => '法人姓名',
'description' => '法人姓名。',
'type' => 'string',
'required' => false,
'example' => '李华',
],
],
[
'name' => 'UseBySelf',
'in' => 'query',
'schema' => [
'title' => '是否自用',
'description' => '资质申请用途,取值:'."\n"
."\n"
.'- **true**:自用。'."\n"
.'- **false**:他用。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => [
'title' => '',
'description' => '当前页码。默认取值为 1。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'title' => '',
'description' => '每页显示的数据条数。取值范围:**1~50**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '20',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息。',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'title' => '',
'description' => '请求ID。',
'type' => 'string',
'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA'."\n",
],
'Message' => [
'title' => '',
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Data' => [
'description' => '资质审核列表',
'type' => 'object',
'properties' => [
'PageSize' => [
'title' => '',
'description' => '每页数据条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'Total' => [
'title' => '',
'description' => '总条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '25',
],
'PageNo' => [
'title' => '',
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'List' => [
'title' => '',
'description' => '满足过滤条件的数据列表。',
'type' => 'array',
'items' => [
'description' => '单个资质审核详情。',
'type' => 'object',
'properties' => [
'LegalPersonName' => [
'title' => '法人名称',
'description' => '法人姓名。',
'type' => 'string',
'example' => '李华',
],
'AuditRemark' => [
'title' => '审核备注',
'description' => '审核备注。',
'type' => 'string',
'example' => '无',
],
'CompanyName' => [
'title' => '公司名称或实人认证姓名',
'description' => '企业名称。',
'type' => 'string',
'example' => '阿里云云通信有限公司',
],
'WorkOrderId' => [
'title' => '工单ID',
'description' => '审核工单ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '2001****',
],
'StateName' => [
'title' => '审核状态名',
'description' => '审核状态。取值:'."\n"
."\n"
.'- INIT:审核中。'."\n"
.'- NOT_PASS:审核不通过。 '."\n"
.'- PASS:审核通过。'."\n"
.'- NOT_FINISH:资料待补充。'."\n"
.'- CANCEL:已撤回。',
'type' => 'string',
'example' => 'INIT',
],
'AuditTime' => [
'title' => '审核时间',
'description' => '审核时间。',
'type' => 'string',
'example' => '2024-12-26 17:29:04',
],
'CreateDate' => [
'title' => '创建时间',
'description' => '资质创建时间。',
'type' => 'string',
'example' => '2025-02-20 11:59:30',
],
'QualificationGroupName' => [
'title' => '资质组名称',
'description' => '资质名称。',
'type' => 'string',
'example' => '阿里云云通信有限公司李华',
],
'GroupId' => [
'title' => '资质组ID',
'description' => '资质ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '10000****',
],
'UseBySelf' => [
'title' => '是否自用',
'description' => '资质申请用途,取值:'."\n"
."\n"
.'- **true**:自用。'."\n"
.'- **false**:他用。',
'type' => 'string',
'example' => 'true',
],
],
],
'example' => '',
],
],
],
'Code' => [
'title' => '',
'description' => '请求状态码。'."\n"
."\n"
.'* 返回OK代表请求成功。'."\n"
.'* 其他错误码,请参见本章节的错误码列表或产品[API错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '',
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"25D5AFDE-8EBC-132E-8909-1FDC071DA\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"PageSize\\": 20,\\n \\"Total\\": 25,\\n \\"PageNo\\": 1,\\n \\"List\\": [\\n {\\n \\"LegalPersonName\\": \\"李华\\",\\n \\"AuditRemark\\": \\"无\\",\\n \\"CompanyName\\": \\"阿里云云通信有限公司\\",\\n \\"WorkOrderId\\": 0,\\n \\"StateName\\": \\"INIT\\",\\n \\"AuditTime\\": \\"2024-12-26 17:29:04\\",\\n \\"CreateDate\\": \\"2025-02-20 11:59:30\\",\\n \\"QualificationGroupName\\": \\"阿里云云通信有限公司李华\\",\\n \\"GroupId\\": 0,\\n \\"UseBySelf\\": \\"true\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '查询资质列表',
'description' => '- 支持全量查询或条件查询:'."\n"
.' - **全量查询**:查询您当前帐户下所有短信资质,无需传参。默认全量查询。'."\n"
.' - **条件查询**:支持根据资质名称、企业名称、法人姓名、审核状态、审核工单ID、资质用途进行查询,传入您希望筛选的参数即可。'."\n"
."\n"
.'- 本接口用于查询资质及其审核信息,如果需要查询单个资质的具体信息(企业信息、法人信息、管理员信息),请调用[查询单个资质详情](~~QuerySingleSmsQualification~~)接口。'."\n"
."\n"
.'- 受短信签名实名制报备要求影响,当前资质审核工单量增长快速,审核时间可能会延长,请耐心等待,预计2个工作日内完成(审核工作时间:周一至周日 9:00~21:00,法定节假日顺延)。特殊情况可能延长审核时间,请耐心等待。'."\n"
.'- 如果资质未通过审核,审核备注`AuditRemark`会返回审核失败的原因,请参考[审核失败的处理建议](~~2384377#a96cc318b94x1~~),调用[修改短信资质](~~UpdateSmsQualification~~)接口或在控制台[资质管理](https://dysms.console.aliyun.com/domestic/text/qualification)页面修改资质信息后,重新发起审核。',
],
'QuerySingleSmsQualification' => [
'summary' => '当您在申请短信资质后,可以通过此接口查询单个资质详情。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '264878',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'QualificationGroupId',
'in' => 'query',
'schema' => [
'title' => '资质id',
'description' => '资质ID,即您[申请资质](~~SubmitSmsQualification~~)返回的ID。您可以通过[查询资质列表](~~QuerySmsQualificationRecord~~)获取当前账号下的资质ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '10000****',
],
],
[
'name' => 'OrderId',
'in' => 'query',
'schema' => [
'title' => '工单id',
'description' => '审核工单ID,您可以通过[查询资质列表](~~QuerySmsQualificationRecord~~)获取当前账号下的资质及其对应审核工单ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2001****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'title' => '',
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA'."\n",
],
'Message' => [
'title' => '',
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Data' => [
'title' => '',
'description' => '单个资质详情。',
'type' => 'object',
'properties' => [
'AdminIDCardExpDate' => [
'title' => '经办人身份证有效期',
'description' => '管理员证件有效期。有效期格式:YYYY-MM-DD~YYYY-MM-DD。',
'type' => 'string',
'example' => '2023-01-01~2033-01-01',
],
'BusinessType' => [
'title' => '行业类型,在当前模式下是可以用产品线code来区分',
'description' => '行业类型。',
'type' => 'string',
'example' => 'dysms',
],
'AdminIDCardFrontFace' => [
'title' => '经办人身份证国徽面,产品需求,要求身份证可以分正反面上传',
'description' => '管理员证件正面(身份证国徽面)照片完整路径URL。',
'type' => 'string',
'example' => 'https://******.aliyuncs.com/******',
],
'Remark' => [
'title' => '备注',
'description' => '备注。',
'type' => 'string',
'example' => '无',
],
'LegalPersonName' => [
'title' => '法人姓名',
'description' => '法人姓名。',
'type' => 'string',
'example' => '李华',
],
'CompanyName' => [
'title' => '公司名称',
'description' => '企业名称。',
'type' => 'string',
'example' => '阿里云云通信有限公司',
],
'LegalPersonIDCardNo' => [
'title' => '法人身份证号码',
'description' => '法人证件号码。',
'type' => 'string',
'example' => '511391********5123'."\n",
],
'BusinessLicensePics' => [
'title' => '证件信息',
'description' => '企业营业证件信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'title' => '',
'description' => '营业证件类型。取值:'."\n"
."\n"
.'- socialCreditLicense:社会信用代码证书。'."\n"
.'- businessLicense:企业营业执照。'."\n"
.'- signLegalLicense:事业单位法人证书。'."\n"
.'- otherLicense:其他类型执照证书。',
'type' => 'string',
'example' => 'businessLicense',
],
'LicensePic' => [
'title' => '',
'description' => '营业证件文件路径参数。',
'type' => 'string',
'example' => '123456/111.png',
],
'PicUrl' => [
'title' => '文件的完整路径',
'description' => '营业证件文件完整路径URL。',
'type' => 'string',
'example' => 'https://******.aliyuncs.com/******'."\n",
],
],
],
'example' => '',
],
'AdminIDCardNo' => [
'title' => '经办人身份证号码',
'description' => '管理员证件号码。',
'type' => 'string',
'example' => '511391********5123',
],
'OrganizationCode' => [
'title' => '社会统一信用代码',
'description' => '社会统一信用代码。',
'type' => 'string',
'example' => '910X********0012'."\n",
],
'LegalPersonIdCardEffTime' => [
'title' => '法人身份证有效期',
'description' => '法人证件有效期。有效期格式:YYYY-MM-DD~YYYY-MM-DD。',
'type' => 'string',
'example' => '2023-01-01~2033-01-01',
],
'AdminPhoneNo' => [
'title' => '经办人手机号码',
'description' => '管理员手机号码。',
'type' => 'string',
'example' => '137*******',
],
'QualificationName' => [
'title' => '资质名称',
'description' => '资质名称。',
'type' => 'string',
'example' => '阿里云云通信有限公司资质李华'."\n",
],
'AdminName' => [
'title' => '经办人姓名',
'description' => '管理员姓名。',
'type' => 'string',
'example' => '李华',
],
'CompanyType' => [
'title' => '企业类型, COMPANY:公司,政府或者事业单位:NON_PROFIT_ORGANIZATION',
'description' => '企业类型,取值:'."\n"
."\n"
.'- COMPANY:企业。'."\n"
.'- NON_PROFIT_ORGANIZATION:政府机关或事业单位。',
'type' => 'string',
'example' => 'COMPANY',
],
'AdminIDCardType' => [
'title' => '管理员身份证类型',
'description' => '管理员证件类型。取值:'."\n"
."\n"
.'- identityCard:身份证。'."\n"
.'- passport:护照。'."\n"
.'- homeReturnPermit:港澳居民来往内地通行证。'."\n"
.'- TaiwanCompatriotPermit:台湾居民来往大陆通行证。'."\n"
.'- residencePermit:港澳台居民居住证。'."\n"
.'- other:其他。',
'type' => 'string',
'example' => 'identityCard',
],
'UseBySelf' => [
'title' => '是否自用',
'description' => '资质申请用途,取值:'."\n"
."\n"
.'- **true**:自用。'."\n"
.'- **false**:他用。',
'type' => 'boolean',
'example' => 'false',
],
'EffTimeStr' => [
'title' => '',
'description' => '营业证照有效期。有效期格式:YYYY-MM-DD~YYYY-MM-DD。',
'type' => 'string',
'example' => '2023-01-01~2033-01-01'."\n",
],
'QualificationGroupId' => [
'title' => '',
'description' => '资质ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '10000****',
],
'WhetherShare' => [
'title' => '',
'description' => '资质授权,是否同意与其他云通信产品(如国内语音、国内号码隐私保护)的资质共享。仅当您申请**自用资质**,且资质信息**与当前阿里云账号认证企业信息一致**时可被共享、复用;其他情况无效。取值:'."\n"
."\n"
.'- true:同意,您的资质信息可在其他云通信产品的“资质认证环节”调用,免除重复认证环节。'."\n"
.'- false:不同意。',
'type' => 'boolean',
'enumValueTitles' => [
'true' => 'true',
'false' => 'false',
],
'example' => 'false',
],
'WorkOrderId' => [
'title' => '乾坤袋工单ID',
'description' => '审核工单ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '2001****',
],
'State' => [
'title' => '当前审核状态',
'description' => '审核状态。取值:'."\n"
."\n"
.'- INT:审核中。'."\n"
.'- FAILED:审核不通过。'."\n"
.'- PASSED:审核通过。'."\n"
.'- NOT_FINISH:资料待补充。'."\n"
.'- CANCELED:已撤回。'."\n"
."\n"
.'> 本接口不会返回审核备注,如需要查询审核备注(`AuditRemark`)请使用[查询资质列表](~~QuerySmsQualificationRecord~~)。',
'type' => 'string',
'enumValueTitles' => [
'NOT_FINISH' => '资料待补充',
'FAILED' => '审核不通过',
'CANCELED' => '已撤回',
'INT' => '审核中',
'PASSED' => '审核通过',
],
'example' => 'PASSED',
],
'OtherFiles' => [
'title' => '更多资料',
'description' => '更多资料。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LicensePic' => [
'title' => '',
'description' => '更多资料文件路径参数。',
'type' => 'string',
'example' => '123456/111.png',
],
'PicUrl' => [
'title' => '文件的完整路径',
'description' => '更多资料文件完整路径URL。',
'type' => 'string',
'example' => 'https://******.aliyuncs.com/******',
],
],
],
'example' => '',
],
'LegalPersonIDCardType' => [
'title' => '法人身份证类型',
'description' => '法人证件类型。取值:'."\n"
."\n"
.'- identityCard:身份证。'."\n"
.'- passport:护照。'."\n"
.'- homeReturnPermit:港澳居民来往内地通行证。'."\n"
.'- TaiwanCompatriotPermit:台湾居民来往大陆通行证。'."\n"
.'- residencePermit:港澳台居民居住证。'."\n"
.'- other:其他。',
'type' => 'string',
'example' => 'identityCard',
],
'AdminIDCardPic' => [
'title' => '经办人身份证图片地址,正反面合一',
'description' => '管理员证件反面(身份证人像面)图片完整路径URL。',
'type' => 'string',
'example' => 'https://******.aliyuncs.com/******',
],
],
'example' => '',
],
'Code' => [
'title' => '',
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见本章节的错误码列表或产品[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '',
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'enumValueTitles' => [
'true' => 'true',
'false' => 'false',
],
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"25D5AFDE-8EBC-132E-8909-1FDC071DA\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"AdminIDCardExpDate\\": \\"2023-01-01~2033-01-01\\",\\n \\"BusinessType\\": \\"dysms\\",\\n \\"AdminIDCardFrontFace\\": \\"https://******.aliyuncs.com/******\\",\\n \\"Remark\\": \\"无\\",\\n \\"LegalPersonName\\": \\"李华\\",\\n \\"CompanyName\\": \\"阿里云云通信有限公司\\",\\n \\"LegalPersonIDCardNo\\": \\"511391********5123\\\\n\\",\\n \\"BusinessLicensePics\\": [\\n {\\n \\"Type\\": \\"businessLicense\\",\\n \\"LicensePic\\": \\"123456/111.png\\",\\n \\"PicUrl\\": \\"https://******.aliyuncs.com/******\\\\n\\"\\n }\\n ],\\n \\"AdminIDCardNo\\": \\"511391********5123\\",\\n \\"OrganizationCode\\": \\"910X********0012\\\\n\\",\\n \\"LegalPersonIdCardEffTime\\": \\"2023-01-01~2033-01-01\\",\\n \\"AdminPhoneNo\\": \\"137*******\\",\\n \\"QualificationName\\": \\"阿里云云通信有限公司资质李华\\\\n\\",\\n \\"AdminName\\": \\"李华\\",\\n \\"CompanyType\\": \\"COMPANY\\",\\n \\"AdminIDCardType\\": \\"identityCard\\",\\n \\"UseBySelf\\": false,\\n \\"EffTimeStr\\": \\"2023-01-01~2033-01-01\\\\n\\",\\n \\"QualificationGroupId\\": 0,\\n \\"WhetherShare\\": false,\\n \\"WorkOrderId\\": 0,\\n \\"State\\": \\"PASSED\\",\\n \\"OtherFiles\\": [\\n {\\n \\"LicensePic\\": \\"123456/111.png\\",\\n \\"PicUrl\\": \\"https://******.aliyuncs.com/******\\"\\n }\\n ],\\n \\"LegalPersonIDCardType\\": \\"identityCard\\",\\n \\"AdminIDCardPic\\": \\"https://******.aliyuncs.com/******\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '查询单个资质详情',
'description' => '- 本接口查询单个资质的详情(企业信息、法人信息、管理员信息)。'."\n"
.'- 如果需要查询您当前账号下所有资质信息,或需要查询审核详情,请调用[查询资质列表](~~QuerySmsQualificationRecord~~)。'."\n"
.'- 受短信签名实名制报备要求影响,当前资质审核工单量增长快速,审核时间可能会延长,请耐心等待,预计2个工作日内完成(审核工作时间:周一至周日 9:00~21:00,法定节假日顺延)。特殊情况可能延长审核时间,请耐心等待。',
],
'UpdateSmsQualification' => [
'summary' => '如果您需要更新短信资质信息,可通过本接口提交修改请求,提交后将重新进入审核流程。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '264875',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'QualificationGroupId',
'in' => 'query',
'schema' => [
'title' => '资质组ID',
'description' => '资质ID,即您[申请短信资质](~~SubmitSmsQualification~~)返回的ID。您可以通过[查询资质列表](~~QuerySmsQualificationRecord~~)获取当前账号下的资质ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '10000****',
],
],
[
'name' => 'OrderId',
'in' => 'query',
'schema' => [
'title' => '工单ID',
'description' => '审核工单ID。您可以通过[查询资质列表](~~QuerySmsQualificationRecord~~)获取当前账号下的资质及其对应审核工单ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '2001*****',
],
],
[
'name' => 'BusinessLicensePics',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '企业证件信息',
'description' => '企业营业证件信息。待修改的资质用途为他用时,此参数必填。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'title' => '企业证件类型,businessLicense:营业执照;organizationCodeLicense:组织机构代码证;taxRegistrationLicense:税务登记证;socialCreditLicense:社会信用代码证书;newStyleBusinessLicense:三证合一;signLegalLicense:签名归属方的事业单位法人证书;otherLicense:其他类型执照证书',
'description' => '营业证件类型。取值:'."\n"
."\n"
.'- socialCreditLicense:社会信用代码证书。'."\n"
.'- businessLicense:企业营业执照。'."\n"
.'- signLegalLicense:事业单位法人证书。'."\n"
.'- otherLicense:其他。'."\n"
."\n"
.'选择一种上传即可,证件上需含有:企业名称、统一社会信用代码、证件有效期。',
'type' => 'string',
'required' => false,
'example' => 'businessLicense',
],
'LicensePic' => [
'title' => '证件图片标识的osskey',
'description' => '营业证件图片,仅支持jpg、png、gif、jpeg格式的图片,图片不大于5MB。请填写上传到OSS的文件路径参数,待上传的文件命名不可包含中文和特殊字符,上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n"
."\n"
.'><notice>'."\n"
.'证件的彩色原件无需盖章,若上传复印件/黑白照片,需要在复印件上加盖企业红章并拍照上传。'."\n"
.'></notice>',
'type' => 'string',
'required' => false,
'example' => '123456/111.png',
],
],
'required' => false,
],
'required' => false,
'example' => '',
],
],
[
'name' => 'CompanyName',
'in' => 'query',
'schema' => [
'title' => '公司名称',
'description' => '企业名称。符号仅支持中点`·`、中文`【】()`、英文`()`及`空格`,不可含其他符号或纯数字,长度不超过150字符。',
'type' => 'string',
'required' => false,
'example' => '阿里云云通信有限公司',
],
],
[
'name' => 'BussinessLicenseExpDate',
'in' => 'query',
'schema' => [
'title' => '企业营业时间开始和结束字符串,格式示例2023-01-01~2033-01-01',
'description' => '营业证件有效期。有效期格式:YYYY-MM-DD~YYYY-MM-DD。'."\n"
.'> 证照有效期为长期时,截止日期可填:2099-12-31。',
'type' => 'string',
'required' => false,
'example' => '2023-01-01~2033-01-01',
],
],
[
'name' => 'LegalPersonIdCardFrontSide',
'in' => 'query',
'schema' => [
'title' => '法人身份照片证国徽面',
'description' => '法定代表人证件正面照片(身份证国徽面),仅支持jpg、png、gif、jpeg格式的图片,图片不大于5MB。请填写上传到OSS的文件路径参数,待上传的文件命名不可包含中文和特殊字符,上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n"
.'> 系统会使用您填写的法人姓名、证件号码进行校验;若校验不通过,则需要上传法定代表人身份证件照片。',
'type' => 'string',
'required' => false,
'example' => '123456/111.png'."\n",
],
],
[
'name' => 'LegalPersonIdCardBackSide',
'in' => 'query',
'schema' => [
'title' => '法人身份证照片人像面',
'description' => '法定代表人证件反面照片(身份证人像面),仅支持jpg、png、gif、jpeg格式的图片,图片不大于5MB。请填写上传到OSS的文件路径参数,待上传的文件命名不可包含中文和特殊字符,上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n"
.'> 系统会使用您填写的法人姓名、证件号码进行校验;若校验不通过,则需要上传法定代表人身份证件照片。',
'type' => 'string',
'required' => false,
'example' => '123456/111.png'."\n",
],
],
[
'name' => 'LegalPersonName',
'in' => 'query',
'schema' => [
'title' => '法人姓名',
'description' => '法定代表人姓名。'."\n"
."\n"
.'> - 若组织证件中无法定代表人信息,但存在负责人/首席代表等相关信息,请准备证件中对应负责人或首席代表的身份证件照片。'."\n"
.'> - 若组织证件中无法定代表人信息,且无任何负责人信息,请准备业务主要负责人的姓名、身份证件照片。',
'type' => 'string',
'required' => false,
'example' => '李华',
],
],
[
'name' => 'LegalPersonIDCardNo',
'in' => 'query',
'schema' => [
'title' => '法人身份证号码',
'description' => '法人证件号码。',
'type' => 'string',
'required' => false,
'example' => ' '."\n"
.'511391********5123'."\n",
],
],
[
'name' => 'LegalPersonIdCardEffTime',
'in' => 'query',
'schema' => [
'title' => '法人身份证有效期,格式示例2023-01-01~2033-01-01',
'description' => '法人证件有效期。有效期格式:YYYY-MM-DD~YYYY-MM-DD。'."\n"
.'> 证件有效期为长期时,截止日期可填:2099-12-31。',
'type' => 'string',
'required' => false,
'example' => '2023-01-01~2033-01-01',
],
],
[
'name' => 'LegalPersonIDCardType',
'in' => 'query',
'schema' => [
'title' => '法人身份证类型。identityCard:中国居民身份证;passport:护照;homeReturnPermit:港澳居民来往内地通行证;TaiwanCompatriotPermit:台湾居民来往大陆通行证;residencePermit:港澳台居民居住证";other:其他',
'description' => '法人证件类型。取值:'."\n"
."\n"
.'- identityCard:身份证。'."\n"
.'- passport:护照。'."\n"
.'- homeReturnPermit:港澳居民来往内地通行证。'."\n"
.'- TaiwanCompatriotPermit:台湾居民来往大陆通行证。'."\n"
.'- residencePermit:港澳台居民居住证。'."\n"
.'- other:其他。',
'type' => 'string',
'required' => false,
'example' => 'identityCard',
],
],
[
'name' => 'AdminIDCardPic',
'in' => 'query',
'schema' => [
'title' => '经办人身份证照片人像面',
'description' => '管理员证件反面照片(身份证人像面),仅支持jpg、png、gif、jpeg格式的图片,图片不大于5MB。请填写上传到OSS的文件路径参数,待上传的文件命名不可包含中文和特殊字符,上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n"
."\n"
.'><notice>'."\n"
.' 证件的彩色原件无需盖章,若上传复印件/黑白照片,需要在复印件上加盖企业红章并拍照上传。'."\n"
.'></notice>',
'type' => 'string',
'required' => false,
'example' => '123456/111.png'."\n",
],
],
[
'name' => 'AdminIDCardFrontFace',
'in' => 'query',
'schema' => [
'title' => '经办人身份证照片国徽面',
'description' => '管理员证件正面照片(身份证国徽面),仅支持jpg、png、gif、jpeg格式的图片,图片不大于5MB。请填写上传到OSS的文件路径参数,待上传的文件命名不可包含中文和特殊字符,上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n"
."\n"
.'><notice>'."\n"
.'证件的彩色原件无需盖章,若上传复印件/黑白照片,需要在复印件上加盖企业红章并拍照上传。'."\n"
.'></notice>',
'type' => 'string',
'required' => false,
'example' => '123456/111.png'."\n",
],
],
[
'name' => 'AdminName',
'in' => 'query',
'schema' => [
'title' => '经办人姓名',
'description' => '管理员姓名。'."\n"
."\n"
.'> 管理员(又称经办人)指登录阿里云账号并管理短信业务的人员,一般是贵方管理此阿里云账号下资质、签名和模板,并进行短信发送的相关运营人员,且此人手机号可接收验证码。管理员不一定是此阿里云账号的管理员,管理员可以与企业法人为同一人。',
'type' => 'string',
'required' => false,
'example' => '李华',
],
],
[
'name' => 'AdminIDCardNo',
'in' => 'query',
'schema' => [
'title' => '经办人身份证号码',
'description' => '管理员证件号码。',
'type' => 'string',
'required' => false,
'example' => '511391********5123'."\n",
],
],
[
'name' => 'AdminIDCardExpDate',
'in' => 'query',
'schema' => [
'title' => '经办人身份证有效期,格式示例2023-01-01~2033-01-01',
'description' => '管理员证件有效期。有效期格式:YYYY-MM-DD~YYYY-MM-DD。'."\n"
.'> 证件有效期为长期时,截止日期可填:2099-12-31。',
'type' => 'string',
'required' => false,
'example' => '2023-01-01~2033-01-01'."\n"
."\n",
],
],
[
'name' => 'AdminPhoneNo',
'in' => 'query',
'schema' => [
'title' => '经办人手机号码',
'description' => '管理员手机号码,格式:+/+86/0086/86 或无任何前缀的手机号码,例如1390000****。',
'type' => 'string',
'required' => true,
'example' => '137********',
],
],
[
'name' => 'CertifyCode',
'in' => 'query',
'schema' => [
'title' => '手机号验证码',
'description' => '手机号验证码。请调用[RequiredPhoneCode](~~RequiredPhoneCode~~)接口并传入**管理员手机号码**后,在此填入接收到的短信验证码。'."\n"
."\n"
.'> 您可以使用[ValidPhoneCode](~~ValidPhoneCode~~)自行校验短信验证码是否准确后再传入。',
'type' => 'string',
'required' => true,
'example' => '1234',
],
],
[
'name' => 'AdminIDCardType',
'in' => 'query',
'schema' => [
'title' => '管理员身份证类型。identityCard:中国居民身份证;passport:护照;homeReturnPermit:港澳居民来往内地通行证;TaiwanCompatriotPermit:台湾居民来往大陆通行证;residencePermit:港澳台居民居住证";other:其他',
'description' => '管理员证件类型。取值:'."\n"
."\n"
.'- identityCard:身份证。'."\n"
.'- passport:护照。'."\n"
.'- homeReturnPermit:港澳居民来往内地通行证。'."\n"
.'- TaiwanCompatriotPermit:台湾居民来往大陆通行证。'."\n"
.'- residencePermit:港澳台居民居住证。'."\n"
.'- other:其他。',
'type' => 'string',
'required' => false,
'example' => 'identityCard',
],
],
[
'name' => 'OtherFiles',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '更多资料',
'description' => '更多资料,如果您还有其他证明或备注材料、照片等,可在此上传。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LicensePic' => [
'title' => '',
'description' => '更多资料文件,仅支持png、jpg、jpeg、doc、docx、pdf格式,文件不大于5MB。请填写上传到OSS的文件路径参数,待上传的文件命名不可包含中文和特殊字符,上传操作请参见通过[OSS上传文件](~~2833114~~)。',
'type' => 'string',
'required' => false,
'example' => '123456/111.png'."\n",
],
],
'required' => false,
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'title' => '',
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA'."\n",
],
'Message' => [
'title' => '',
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Data' => [
'title' => '',
'description' => '资质ID。',
'type' => 'string',
'example' => '10000****',
],
'Code' => [
'title' => '',
'description' => '请求状态码。'."\n"
."\n"
.'* 返回OK代表请求成功。'."\n"
.'* 其他错误码,请参见本章节的错误码列表或产品[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '',
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'QualificationNameNullError',
'errorMessage' => 'Qualification name cannot be empty.',
],
[
'errorCode' => 'BusinessLicensePicsNullError',
'errorMessage' => 'Business license documents cannot be empty.',
],
[
'errorCode' => 'OtherFileTypeError',
'errorMessage' => 'Invalid file format for other documents.',
],
[
'errorCode' => 'QualificationNameAlreadyExist',
'errorMessage' => 'The qualification name already exists. Please modify and resubmit.',
],
[
'errorCode' => 'QualificationNameNotMatchRegex',
'errorMessage' => 'Qualification names must be in Chinese, English, or alphanumeric combinations. Symbols or pure numbers are not supported.',
],
[
'errorCode' => 'AdminIdcardTypeError',
'errorMessage' => 'Invalid administrator ID card type.',
],
[
'errorCode' => 'BusinessLicensePicsFileError',
'errorMessage' => 'Invalid business license file format.',
],
[
'errorCode' => 'BusinessLicenseTypeError',
'errorMessage' => 'Invalid business license type.',
],
[
'errorCode' => 'LegalIdCardNoNullError',
'errorMessage' => 'Legal person\'s ID number cannot be empty.',
],
[
'errorCode' => 'LegalPersonIdcardTypeError',
'errorMessage' => 'Invalid legal person ID card type.',
],
[
'errorCode' => 'CompanyNameNullError',
'errorMessage' => 'Company name cannot be empty.',
],
[
'errorCode' => 'CompanyTypeError',
'errorMessage' => 'Invalid company type.',
],
[
'errorCode' => 'LegalIdCardNotMatchRegex',
'errorMessage' => 'Invalid legal person ID number format.',
],
[
'errorCode' => 'LegalPersonNameNullError',
'errorMessage' => 'Legal person\'s name cannot be empty.',
],
[
'errorCode' => 'OrganizationCodeNullError',
'errorMessage' => 'Unified Social Credit Code cannot be empty.',
],
[
'errorCode' => 'AdminIdcardFrontFaceFileError',
'errorMessage' => 'Invalid format for administrator\'s ID card national emblem photo.',
],
[
'errorCode' => 'AdminIdcardFrontFaceNullError',
'errorMessage' => 'Administrator\'s ID card national emblem photo cannot be empty.',
],
[
'errorCode' => 'AdminIdcardPicsFileError',
'errorMessage' => 'Invalid format for administrator\'s ID card portrait photo.',
],
[
'errorCode' => 'AdminIdcardPicsNullError',
'errorMessage' => 'Administrator\'s ID card portrait photo cannot be empty.',
],
[
'errorCode' => 'AdminNameNullError',
'errorMessage' => 'Administrator\'s name cannot be empty.',
],
[
'errorCode' => 'AdminIdcardExpdateNotMatchRegexError',
'errorMessage' => 'Invalid administrator ID card expiration time format.',
],
[
'errorCode' => 'AdminIdcardNoNullError',
'errorMessage' => 'Administrator\'s ID number cannot be empty.',
],
[
'errorCode' => 'AdminIdcardNotMatchRegex',
'errorMessage' => 'Invalid administrator ID number format.',
],
[
'errorCode' => 'BusinessLicenseDateNotMatchRegexError',
'errorMessage' => 'Invalid business license expiration time format.',
],
[
'errorCode' => 'LegalPersonIdcardEfftimeNotMatchRegexError',
'errorMessage' => 'Invalid legal person ID card expiration time format.',
],
[
'errorCode' => 'AdminDateNotValid',
'errorMessage' => 'Current time is outside the administrator ID card validity period.',
],
[
'errorCode' => 'BusinessLicenseDateNotValid',
'errorMessage' => 'Current time is outside the business license validity period.',
],
[
'errorCode' => 'BusinessLicenseOssFileNotUploadError',
'errorMessage' => 'Business license file not uploaded.',
],
[
'errorCode' => 'LegalDateNotValid',
'errorMessage' => 'Current time is outside the legal person ID card validity period.',
],
[
'errorCode' => 'LegalFrontOssFileNotUploadError',
'errorMessage' => 'Legal person ID card national emblem photo not uploaded.',
],
[
'errorCode' => 'AdminBackOssFileNotUploadError',
'errorMessage' => 'Administrator ID card portrait photo not uploaded.',
],
[
'errorCode' => 'AdminFrontOssFileNotUploadError',
'errorMessage' => 'Administrator ID card national emblem photo not uploaded.',
],
[
'errorCode' => 'CustNotExistError',
'errorMessage' => 'Customer\'s cloud communication information is invalid.',
],
[
'errorCode' => 'GrayCustAccessError',
'errorMessage' => 'This customer is not authorized to use the OpenAPI. Please contact support for whitelisting.',
],
[
'errorCode' => 'LegalBackOssFileNotUploadError',
'errorMessage' => 'Legal person ID card portrait photo not uploaded.',
],
[
'errorCode' => 'OtherOssFileNotUploadError',
'errorMessage' => 'Other files not uploaded.',
],
[
'errorCode' => 'CertifyCodeError',
'errorMessage' => 'SMS verification code is incorrect.',
],
[
'errorCode' => 'NotEnterpriseCertifyCustCheckError',
'errorMessage' => 'Non-enterprise certified customers are not allowed to access.',
],
[
'errorCode' => 'PhoneNoCertifyCodeNullError',
'errorMessage' => 'Phone number and verification code cannot be empty.',
],
[
'errorCode' => 'SameQualificationGroupError',
'errorMessage' => 'A qualification with the same company and administrator information already exists.',
],
[
'errorCode' => 'WorkOrderIdExpired',
'errorMessage' => 'Qualification details have changed. Please re-query the qualification list and resubmit.',
],
[
'errorCode' => 'CompanyVerificationFailedCompanyStateInvalid',
'errorMessage' => 'Four Elements Verification Failed: Company is not in normal operation.',
],
[
'errorCode' => 'CompanyVerificationFailedFourElementsError',
'errorMessage' => 'Four Elements Verification Failed: Authentication Failed.',
],
[
'errorCode' => 'CompanyVerificationFailedMismatch',
'errorMessage' => 'Four Elements Verification Failed: Mismatch between Legal Representative and Company Information.',
],
[
'errorCode' => 'CompanyVerificationFailedNoCompany',
'errorMessage' => 'Four Elements Verification Failed: Company Not Found.',
],
[
'errorCode' => 'CompanyVerificationFailedNoLegalPerson',
'errorMessage' => 'Four Elements Verification Failed: Legal Representative Not Found.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"25D5AFDE-8EBC-132E-8909-1FDC071DA\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"10000****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '修改短信资质',
'description' => '- 审核中的资质不支持修改,请等待审核流程结束或在短信服务控制台[撤回申请](https://dysms.console.aliyun.com/domestic/text/qualification)后再修改。'."\n"
.'- 修改后的短信资质**需要重新审核**(包括已审核通过的资质),请根据[资质材料说明](~~2384377~~)上传符合规范的材料。'."\n"
.'- **不支持修改**资质命名、申请用途、统一社会信用代码。'."\n"
.'- 不支持批量修改短信资质,建议每次修改至少间隔5秒。',
'requestParamsDescription' => '><notice>'."\n"
."\n"
.'短信资质材料具体要求请参见[资质材料说明](~~2384377~~),要求可能随工信部与运营商要求实时调整,请以审核实际结果为准。'."\n"
."\n"
.'></notice>',
],
'DeleteSmsQualification' => [
'summary' => '若您不再使用某个短信资质或因其他原因需要删除时,调用此接口或在短信服务控制台删除短信资质。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '264874',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'QualificationGroupId',
'in' => 'query',
'schema' => [
'title' => '资质组ID',
'description' => '资质ID,即您[申请资质](~~SubmitSmsQualification~~)返回的ID。您可以通过调用[查询资质列表](~~QuerySmsQualificationRecord~~)接口,或通过控制台国内消息[资质管理](https://dysms.console.aliyun.com/domestic/text/qualification)页面获取当前账号下的资质ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '10000****',
],
],
[
'name' => 'OrderId',
'in' => 'query',
'schema' => [
'title' => '工单ID',
'description' => '审核工单ID。您可以通过调用[查询资质列表](~~QuerySmsQualificationRecord~~)接口,或通过控制台国内消息[资质管理](https://dysms.console.aliyun.com/domestic/text/qualification)页面获取当前账号下的资质及其对应审核工单ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '2001****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'title' => '',
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA'."\n",
],
'Message' => [
'title' => '',
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Data' => [
'title' => '',
'description' => '是否删除成功。取值:'."\n"
."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'boolean',
'enumValueTitles' => [
'true' => 'true',
'false' => 'false',
],
'example' => 'true',
],
'Code' => [
'title' => '',
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 请参见本章节的错误码列表或产品[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '',
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'enumValueTitles' => [
'true' => 'true',
'false' => 'false',
],
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'QualificationNotExist',
'errorMessage' => 'Qualification does not exist.',
],
[
'errorCode' => 'BindSignDeleteFailed',
'errorMessage' => 'The qualification is bound to a signature and cannot be deleted temporarily.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"25D5AFDE-8EBC-132E-8909-1FDC071DA\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除短信资质',
'description' => '><warning>资质删除后不能恢复,也无法在后续申请签名时选用,请谨慎操作。></warning>'."\n"
.'- 审核中的资质不支持修改或删除,您可以在短信服务[控制台](https://dysms.console.aliyun.com/domestic/text/qualification)撤回申请后操作。'."\n"
.'- 审核通过的资质若已被签名绑定则不支持删除。'."\n"
.'- 审核不通过的资质可通过[修改资质信息](~~UpdateSmsQualification~~)后直接重新发起审核。',
],
'RequiredPhoneCode' => [
'summary' => '申请短信资质时,需要验证管理员手机号,请通过本接口获取短信验证码。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '264879',
'abilityTreeNodes' => [
'FEATUREdysms59DLHO',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PhoneNo',
'in' => 'query',
'schema' => [
'title' => '',
'description' => '接收验证码的管理员手机号。'."\n"
.'- 调用本接口**发送验证码的账号和提交资质的账号必须是同一个**,否则调用失败。'."\n"
.'- 号码格式:+/+86/0086/86 或无任何前缀的手机号码,例如 1390000****。',
'type' => 'string',
'required' => true,
'example' => '137****1234',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息。',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'title' => '',
'description' => '请求ID。',
'type' => 'string',
'example' => '90E63D28-E31D-1EB2-8939-A9486641****',
],
'Message' => [
'title' => '',
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Data' => [
'description' => '本数据无返回,可忽略。',
'type' => 'string',
'example' => '-',
],
'Code' => [
'title' => '',
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '',
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'enumValueTitles' => [
'true' => 'true',
'false' => 'false',
],
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"-\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '获取手机验证码',
'description' => '- 接收到手机验证码后,请传入[申请短信资质](~~SubmitSmsQualification~~)/[修改短信资质](~~UpdateSmsQualification~~)接口的`CertifyCode`参数中。'."\n"
.'- 您可以通过[ValidPhoneCode](~~ValidPhoneCode~~)接口校验短信验证码是否准确。'."\n"
.'- 本接口获取短信验证码有[流控限制](~~44335#section-0wh-xn6-0t7~~),请勿频繁操作:针对同一个号码最多支持1条/分钟,5条/小时,10条/天。',
],
'ValidPhoneCode' => [
'summary' => '申请短信资质时,需要验证管理员手机号,本接口可对手机号及收到的验证码进行验证。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '264877',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PhoneNo',
'in' => 'query',
'schema' => [
'title' => '手机号',
'description' => '手机号。',
'type' => 'string',
'required' => true,
'example' => '137****1234',
],
],
[
'name' => 'CertifyCode',
'in' => 'query',
'schema' => [
'title' => '验证码',
'description' => '验证码。',
'type' => 'string',
'required' => true,
'example' => '1234',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'title' => '',
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => '90E63D28-E31D-1EB2-8939-A9486641****'."\n",
],
'Message' => [
'title' => '',
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Data' => [
'title' => '',
'description' => '是否验证成功。取值:'."\n"
."\n"
.'- **true**:验证成功。'."\n"
.'- **false**:验证失败。',
'type' => 'boolean',
'enumValueTitles' => [
'true' => 'true',
'false' => 'false',
],
'example' => 'true',
],
'Code' => [
'title' => '',
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见本章节的错误码列表或产品[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '',
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- true:调用成功。'."\n"
.'- false:调用失败。',
'type' => 'boolean',
'enumValueTitles' => [
'true' => 'true',
'false' => 'false',
],
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '验证手机验证码',
'description' => '- 请先调用[获取手机验证码](~~RequiredPhoneCode~~)接口,阿里云将发送短信验证码至您填写的手机号码。'."\n"
.'- 本接口不影响短信资质申请流程,仅供验证短信验证码使用。实际申请时,请在[申请短信资质](~~SubmitSmsQualification~~)接口中的`CertifyCode`参数传入验证码。',
],
'CreateSmsAuthorizationLetter' => [
'summary' => '若申请的资质用途为他用或申请的签名涉及第三方权益,则必须获取第三方授权,并在申请前提前创建授权委托书。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '264691',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'AuthorizationLetterPic',
'in' => 'query',
'schema' => [
'title' => '上传oss的委托授权书图片标识',
'description' => '委托授权书的fileKey。'."\n"
."\n"
.'1. 上传到OSS的授权委托书文件信息。请下载[授权委托书模板](https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20250414/bvpcmo/%E6%8E%88%E6%9D%83%E5%A7%94%E6%89%98%E4%B9%A6%E6%A8%A1%E7%89%88.doc)后,根据[规范](~~56741~~)完成填写并盖章后上传。文件上传要求:'."\n"
.'- 待上传的文件命名不可包含中文和特殊字符。'."\n"
.'- 仅支持jpg、png、gif、jpeg格式的图片,图片不大于5MB。'."\n"
."\n"
.'2. fileKey的获取方式如下:[通过OSS上传文件](~~2833114~~)。',
'type' => 'string',
'required' => true,
'example' => '123456/test1719383196031.jpg',
],
],
[
'name' => 'SignList',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '委托授权签名列表,签名数量限制100个以内',
'description' => '委托授权签名列表,签名数量不超过100个。'."\n"
."\n"
.'> 建议您在授权书内将可能需要用到的签名一次性全部授权,避免后续申请签名时不在授权书签名范围内,导致审核不通过且需重新补充委托授权书。',
'type' => 'array',
'items' => [
'title' => '签名内容,签名长度限2-12个字符,不支持包含“测试”“test”【】[] 、,。括号和空格等特殊字符',
'description' => '短信签名名称,请遵守[签名规范](~~108076~~)。长度限2~12字符,不支持包含“测试”、“test”等字样;不支持添加【】、()、[]等符号;不支持`、,。空格`等特殊字符。',
'type' => 'string',
'required' => false,
'example' => '菜鸟网络',
],
'required' => true,
'example' => '',
],
],
[
'name' => 'AuthorizationLetterExpDate',
'in' => 'query',
'schema' => [
'title' => '委托授权书有效期',
'description' => '授权委托书有效期。有效期格式:`YYYY-MM-DD~YYYY-MM-DD`。'."\n"
."\n"
.'> 有效期限建议为1~3年。请设定一个合理的时间周期,避免有效期过长或过短。',
'type' => 'string',
'required' => true,
'example' => '2023-01-01~2026-01-01',
],
],
[
'name' => 'Authorization',
'in' => 'query',
'schema' => [
'title' => '授权方,授权方命名长度不超过1000个字符,暂不支持包含除中点(·)、空格、中文括号【】、英文括号()外的任何符号或纯数字输入',
'description' => '委托授权方,即签名归属方。符号仅支持中点`·`、中文`【】()`、英文`()`及空格,不可含其他符号或纯数字,长度不超过150字符。',
'type' => 'string',
'required' => true,
'example' => '菜鸟网络科技有限公司',
],
],
[
'name' => 'OrganizationCode',
'in' => 'query',
'schema' => [
'title' => '授权方社会统一信用代码,长度不超过150个字符',
'description' => '委托授权方社会统一信用代码,长度不超过150字符。信用代码必须与签名绑定的资质信息中社会统一信用代码字段保持一致,否则创建签名失败。',
'type' => 'string',
'required' => true,
'example' => '9****************A',
],
],
[
'name' => 'ProxyAuthorization',
'in' => 'query',
'schema' => [
'title' => '被授权方,被授权方命名长度不超过1000个字符,暂不支持包含除中点(·)、空格、中文括号【】、英文括号()外的任何符号或纯数字输入',
'description' => '被委托授权方,即签名申请方。符号仅支持中点`·`、中文`【】()`、英文`()`及空格,不可含其他符号或纯数字,长度不超过150字符。',
'type' => 'string',
'required' => true,
'example' => '支付宝(中国)网络技术有限公司',
],
],
[
'name' => 'AuthorizationLetterName',
'in' => 'query',
'schema' => [
'title' => '委托授权书命名非空,不超过100个字符,支持中文、英文或与数字组合进行命名,暂不支持任何符号或纯数字输入',
'description' => '授权委托书命名。命名不可与您其他授权书重复,仅支持中文、英文或与数字组合,不可含符号或纯数字,长度不超过100字符。',
'type' => 'string',
'required' => true,
'example' => '菜鸟公司授权书',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'title' => '',
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'."\n",
],
'Message' => [
'title' => '',
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Data' => [
'title' => '',
'description' => '委托授权书ID。',
'type' => 'string',
'example' => '10000****',
],
'Code' => [
'title' => '',
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见本章节的错误码列表或产品[API 错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '',
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'enumValueTitles' => [
'true' => 'true',
'false' => 'false',
],
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AuthorizationLetterNameRepeat',
'errorMessage' => 'The authorization letter name is duplicated.',
],
[
'errorCode' => 'AuthorizationLetterDateNotMatchRegex',
'errorMessage' => 'The format of the authorization letter\'s effective and expiry date is incorrect.',
],
[
'errorCode' => 'AuthorizationLetterDateNotValid',
'errorMessage' => 'The current time is not within the validity period of the authorization letter.',
],
[
'errorCode' => 'AuthorizationLetterNameNotMatchRegex',
'errorMessage' => 'The authorization letter name cannot be empty and must consist of Chinese, English characters or a combination with numbers, symbols or purely numeric input are not supported.',
],
[
'errorCode' => 'AuthorizationLetterNameOverLimit',
'errorMessage' => 'The authorization letter name exceeds the 100-character length limit.',
],
[
'errorCode' => 'AuthorizationNotMatchRegex',
'errorMessage' => 'The authorizer name cannot be empty and currently does not support any symbols except middle dots, spaces, Chinese brackets, and English parentheses or purely numeric input.',
],
[
'errorCode' => 'AuthorizationOssFileNotUploadError',
'errorMessage' => 'The authorization letter file has not been uploaded.',
],
[
'errorCode' => 'AuthorizationOverLimit',
'errorMessage' => 'The authorizer exceeds the 1000-character length limit.',
],
[
'errorCode' => 'ProxyAuthorizationOverLimit',
'errorMessage' => 'The authorized party exceeds the 1000-character length limit.',
],
[
'errorCode' => 'ProxyAuthorizationNotMatchRegex',
'errorMessage' => 'The authorized party name currently does not support any symbols except middle dots, spaces, Chinese brackets, and English parentheses or purely numeric input.',
],
[
'errorCode' => 'SignNumOverLimit',
'errorMessage' => 'The signature exceeds the limit of 100 entries.',
],
[
'errorCode' => 'SignNotMatchRegex',
'errorMessage' => 'The signature length is limited to 2-12 characters and does not support some special characters.',
],
[
'errorCode' => 'OrganizationCodeOverLimit',
'errorMessage' => 'The organization code is limited to 150 characters.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"10000****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '创建授权委托书',
'description' => '- 请您在使用前阅读[授权书规范](~~56741~~),下载[授权委托书模板](https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20250414/bvpcmo/%E6%8E%88%E6%9D%83%E5%A7%94%E6%89%98%E4%B9%A6%E6%A8%A1%E7%89%88.doc)后,根据规范完成填写并盖章后上传。'."\n"
.'- 您创建的授权委托书可在后续申请短信资质/申请短信签名时使用,如果您的资质/签名涉及他用,则必须创建授权委托书并提交。'."\n"
.'- 创建授权委托书后,您可以通过[QuerySmsAuthorizationLetter](~~QuerySmsAuthorizationLetter~~)查询已创建的授权书详情;通过接口创建的授权书信息会同步在短信服务控制台。',
],
'QuerySmsAuthorizationLetter' => [
'summary' => '查询已创建的授权委托书,可查看授权书审核状态、授权签名范围。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '264690',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'AuthorizationLetterIdList',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '委托授权书id列表',
'description' => '委托授权书ID列表。',
'type' => 'array',
'items' => [
'description' => '委托授权书ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10000*****',
],
'required' => false,
'example' => '',
],
],
[
'name' => 'SignName',
'in' => 'query',
'schema' => [
'title' => '签名名称(支持命中签名范围查询)',
'description' => '签名名称。若您创建授权书时,授权范围包括多个签名,则会返回包含该签名的授权书。',
'type' => 'string',
'required' => false,
'example' => '菜鸟网络',
],
],
[
'name' => 'OrganizationCode',
'in' => 'query',
'schema' => [
'title' => '授权方社会统一信用代码',
'description' => '委托授权方社会统一信用代码,长度不超过150个字符。',
'type' => 'string',
'required' => false,
'example' => '9****************A',
],
],
[
'name' => 'State',
'in' => 'query',
'schema' => [
'title' => '授权书审核状态,INT:审核中,PASSED:审核通过',
'description' => '委托授权书审核状态,与签名审核状态相关,取值:'."\n"
.'- **INT**:待审核。委托授权书已创建,当您提交签名申请后进入审核流程。'."\n"
.'- **PASSED**:审核通过。当您的委托授权签名范围中有签名审核通过时,委托授权书状态变为PASSED。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'INT' => '待审核',
'PASSED' => '审核通过',
],
'example' => 'PASSED',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'title' => '授权书可用状态,VALID可用,INVALID不可用',
'description' => '委托授权书可用状态,与授权书有效期相关,取值:'."\n"
."\n"
.'- **VALID**:可用,授权书处于有效期内。'."\n"
.'- **INVALID**:不可用,授权书已过期。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'VALID' => '可用',
'INVALID' => '不可用',
],
'example' => 'VALID',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'title' => '',
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => '25D5AFDE-8EBC-132E-8909-1FDC071D',
],
'Message' => [
'title' => '',
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Data' => [
'title' => '',
'description' => '委托授权书信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Authorization' => [
'title' => '委托授权方',
'description' => '委托授权方。',
'type' => 'string',
'example' => '菜鸟网络科技有限公司',
],
'Status' => [
'title' => '委托授权书可用状态(可用VALID/不可用INVALID)',
'description' => '委托授权书可用状态,与授权书有效期相关,取值:'."\n"
."\n"
.'- **VALID**:可用,授权书处于有效期内。'."\n"
.'- **INVALID**:不可用,授权书已过期。',
'type' => 'string',
'example' => 'VALID',
],
'SignScope' => [
'title' => '委托授权签名范围',
'description' => '委托授权签名范围。若有多个签名,签名之间使用顿号`、`分隔。',
'type' => 'string',
'example' => '菜鸟网络、菜鸟驿站、菜鸟裹裹',
],
'State' => [
'title' => '委托授权书审核状态(初始化INT/审核通过PASSED)',
'description' => '委托授权书状态,与签名审核状态相关,取值:'."\n"
.'- **INT**:待审核。委托授权书已创建,当您提交签名申请后进入审核流程。'."\n"
.'- **PASSED**:审核通过。当您的委托授权签名范围中有签名审核通过时,委托授权书状态变为PASSED。',
'type' => 'string',
'example' => 'PASSED',
],
'AuthorizationLetterExpDate' => [
'title' => '委托授权书有效期',
'description' => '委托授权书有效期。有效期格式:YYYY-MM-DD~YYYY-MM-DD。',
'type' => 'string',
'example' => '2023-01-01~2026-01-01',
],
'AuthorizationLetterPic' => [
'title' => '委托授权书图片地址',
'description' => '委托授权书文件地址。',
'type' => 'string',
'example' => '1000045****/111.png',
],
'OrganizationCode' => [
'title' => '授权方统一社会信用代码',
'description' => '委托授权方社会统一信用代码。',
'type' => 'string',
'example' => '9****************A',
],
'ProxyAuthorization' => [
'title' => '被委托授权方',
'description' => '被委托授权方。',
'type' => 'string',
'example' => '支付宝(中国)网络技术有限公司',
],
'AuthorizationLetterId' => [
'title' => '委托授权书id',
'description' => '委托授权书ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '10000******',
],
'AuthorizationLetterName' => [
'title' => '委托授权书命名',
'description' => '委托授权书命名。',
'type' => 'string',
'example' => '菜鸟公司授权书',
],
],
],
'example' => '',
],
'Code' => [
'title' => '',
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见本章节的错误码列表或产品[API 错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '',
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'enumValueTitles' => [
'true' => 'true',
'false' => 'false',
],
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"25D5AFDE-8EBC-132E-8909-1FDC071D\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"Authorization\\": \\"菜鸟网络科技有限公司\\",\\n \\"Status\\": \\"VALID\\",\\n \\"SignScope\\": \\"菜鸟网络、菜鸟驿站、菜鸟裹裹\\",\\n \\"State\\": \\"PASSED\\",\\n \\"AuthorizationLetterExpDate\\": \\"2023-01-01~2026-01-01\\",\\n \\"AuthorizationLetterPic\\": \\"1000045****/111.png\\",\\n \\"OrganizationCode\\": \\"9****************A\\",\\n \\"ProxyAuthorization\\": \\"支付宝(中国)网络技术有限公司\\",\\n \\"AuthorizationLetterId\\": 0,\\n \\"AuthorizationLetterName\\": \\"菜鸟公司授权书\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '查询授权委托书',
'description' => '- 支持全量查询或条件查询:'."\n"
.' - **全量查询**:查询您当前帐户下所有授权委托书信息,无需传参。默认全量查询。'."\n"
.' - **条件查询**:支持根据授权委托书ID、签名名称、授权委托书审核状态进行查询,传入您希望筛选的参数即可。'."\n"
."\n"
.'- 审核时间:受短信签名实名制报备要求影响,当前资质审核工单量增长快速,审核时间可能会延长,请耐心等待,预计2个工作日内完成。短信签名及模板预计在审核提交后的2小时内完成审核,涉及政府企业相关,一般2个工作日内审核完成。如遇升级核验、审核任务较多、非工作时间,审核时间可能会延长,请耐心等待(审核工作时间:周一至周日 9:00~21:00,法定节假日顺延)。',
],
'CreateSmsSign' => [
'summary' => '短信签名作为短信发送方的一种标识,发送短信前,您需要先申请签名和模板,系统会将已审核通过的短信签名添加到短信内容的开头,并与短信内容一起发送给接收方。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '218492',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
],
'parameters' => [
[
'name' => 'SignName',
'in' => 'query',
'schema' => [
'description' => '签名名称,签名名称请遵守[签名规范](~~108076#section-0p8-qn8-mmy~~):'."\n"
."\n"
.'- 长度限2~12字符,不支持包含“测试”、“test”等字样。'."\n"
."\n"
.'- 不支持添加【】、()、[]等符号;不支持、,。空格等特殊字符。'."\n"
."\n"
.'> - 签名名称区分大小写字母,如【Aliyun通信】和【aliyun通信】视为两个不同的签名。'."\n"
.'> - 当您的验证码签名和通用签名名称相同时,系统默认使用通用签名发送短信。',
'type' => 'string',
'required' => true,
'example' => '阿里云验证码',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '短信签名场景说明,是签名审核的参考信息之一,长度不超过200个字符。'."\n"
.'> - 您可以提供已上线业务的使用场景,并提供实际业务的网站链接、应用市场下载链接等。'."\n"
.'> - 您可以提供短信完整示例,体现您的业务场景。'."\n"
.'> - 您可以提供变量的传参内容,详细描述业务使用场景和选择这个变量属性的原因。'."\n"
.'> - 若签名涉及政企机关单位,请备注政企机关单位的固定电话。'."\n"
."\n"
.'信息完善的申请说明会提高签名、模板的审核效率。如未按规范进行填写或不填写,可能会影响您签名审核的通过。',
'type' => 'string',
'required' => false,
'example' => '登录场景使用验证码',
'maxLength' => 500,
],
],
[
'name' => 'SignType',
'in' => 'query',
'schema' => [
'description' => '签名类型。取值:'."\n"
."\n"
.'- **0**:验证码。'."\n"
."\n"
.'- **1**:通用(默认值)。'."\n"
."\n"
.'建议使用默认值:**通用**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'MoreData',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '更多资料。补充上传业务证明文件或业务截图,有助于审核人员了解您的业务详情。请参见[签名申请材料](~~108076#section-xup-k46-yi4~~),上传相关材料。',
'type' => 'array',
'items' => [
'description' => '上传到OSS的文件信息。文件上传操作,请参见[OSS上传文件](~~2833114~~)。',
'type' => 'string',
'required' => false,
'example' => '10098689758*****/123qwe.png',
],
'required' => false,
],
],
[
'name' => 'QualificationId',
'in' => 'query',
'schema' => [
'description' => '已审核通过的资质ID。'."\n"
."\n"
.'> - 在申请短信签名前,请先[申请资质](~~2539801~~)。'."\n"
.'> - 您可在[资质管理](https://dysms.console.aliyun.com/domestic/text/qualification)页面查看资质ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '8563**',
],
],
[
'name' => 'ApplySceneContent',
'in' => 'query',
'schema' => [
'description' => 'App应用商店链接。若签名来源为“已上线APP”,即`SignSource`取值为2时,请填写http://或https://开头的应用商店链接,并确保App已经上线。',
'type' => 'string',
'required' => false,
'example' => 'http://www.aliyun.com/',
],
],
[
'name' => 'SignSource',
'in' => 'query',
'schema' => [
'description' => '签名来源。取值:'."\n"
."\n"
.'- **0**:企事业单位的全称或简称。**(优先推荐)**'."\n"
.'- **5**:商标名的全称或简称。'."\n"
.'- **2**:App应用的全称或简称。**(不推荐)**'."\n"
."\n"
.'签名来源的详细说明请参见[签名来源](~~108076#section-fow-bfu-wo9~~)。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'enumValueTitles' => [],
'example' => '0',
'enum' => [
'0',
'1',
'2',
'3',
'4',
'5',
],
],
],
[
'name' => 'ThirdParty',
'in' => 'query',
'schema' => [
'description' => '签名用途。取值:'."\n"
."\n"
.'- false:自用(默认值,签名为本账号实名认证的企业、网站、产品名等)。'."\n"
."\n"
.'- true:他用(签名为非本账号实名认证的企业、网站、产品名等)。'."\n"
.'><notice>签名为自用时,请选择自用资质ID;签名为他用时,请选择他用资质ID。></notice>',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'AuthorizationLetterId',
'in' => 'query',
'schema' => [
'description' => '委托授权书ID,当签名为他用时,委托授权书ID不可为空,否则签名审核不通过。委托授权书的社会统一信用代码必须与签名绑定的资质信息中社会统一信用代码字段保持一致,否则创建签名失败。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1000********1234',
],
],
[
'name' => 'TrademarkId',
'in' => 'query',
'schema' => [
'description' => '商标实体id。'."\n"
.'> - 当SignSource=5时,需要传商标实体id。'."\n"
.'> - 商标实体id可以通过调用[创建商标实体](~~CreateSmsTrademark~~)接口获取。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1000009081***',
],
],
[
'name' => 'AppIcpRecordId',
'in' => 'query',
'schema' => [
'description' => 'APP-ICP备案实体id。'."\n"
.'> - 当SignSource=2时,需要传备案实体id。'."\n"
.'> - 备案实体id可以通过调用[创建ICP备案实体](~~CreateSmsAppIcpRecord~~)接口获取。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10000****029',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => 'CCA2BCFF-2BA7-427C-90EE-AC6994748623',
],
'Code' => [
'description' => '请求状态码。取值:'."\n"
."\n"
.'- OK:代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'successful',
],
'SignName' => [
'description' => '签名名称。',
'type' => 'string',
'example' => '阿里云',
],
'OrderId' => [
'description' => '工单号。'."\n"
."\n"
.'审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。',
'type' => 'string',
'example' => '2004415****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
[
'errorCode' => 'ParameterMismatch.ThirdParty',
'errorMessage' => 'The type of signature, whether for personal use or for a third party, should be consistent with the qualifications.',
],
[
'errorCode' => 'SignName.Exists',
'errorMessage' => 'Sorry, this signature already exists and cannot be applied for again.',
],
[
'errorCode' => 'InvalidQualification',
'errorMessage' => 'The qualification should be approved.',
],
[
'errorCode' => 'InvalidSignName',
'errorMessage' => 'The signature cannot contain spaces, special '."\n"
.'symbols, or all numbers.',
],
[
'errorCode' => 'InvalidApplySceneContent',
'errorMessage' => 'For certain signature sources, the '."\n"
.'applySceneContent should be an HTTP or HTTPS link.',
],
[
'errorCode' => 'MissApplySceneContent',
'errorMessage' => 'In some signature sources, the applySceneContent is required.',
],
[
'errorCode' => 'MissingSignName',
'errorMessage' => 'The signature name cannot be empty.',
],
[
'errorCode' => 'SmsAuthorizationLetterNotMatch',
'errorMessage' => 'Please bind the available authorization letter whose the social credit code is same to the the social credit code of qualification.',
],
[
'errorCode' => 'SmsAuthorizationLetterNotExist',
'errorMessage' => 'Authorization does not belong to the customer.',
],
[
'errorCode' => 'SmsSignNotAuthorized',
'errorMessage' => 'the signature is not in the sign scope of the authorization letter.',
],
[
'errorCode' => 'TrademarkNotExist',
'errorMessage' => 'The trademark does not exist.',
],
[
'errorCode' => 'AppIcpRecordNotExist',
'errorMessage' => 'The APP-ICP record does not exist.',
],
],
404 => [
[
'errorCode' => 'QualificationNotFound',
'errorMessage' => 'Qualification does not exist.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CCA2BCFF-2BA7-427C-90EE-AC6994748623\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"SignName\\": \\"阿里云\\",\\n \\"OrderId\\": \\"2004415****\\"\\n}","type":"json"}]',
'title' => '申请短信签名(新接口)',
'description' => '- 新接口和原接口变更的公告详情请参见[关于短信服务更新签名&模板接口的公告](~~2806975~~)。'."\n"
."\n"
.'- 个人认证用户,同一个阿里云账号一个自然日支持申请一个正式签名;企业认证用户目前无限制。个人用户与企业用户权益区别详情请参见[使用须知](~~55324~~)。'."\n"
."\n"
.'- 请阅读[签名规范](~~108076~~),了解短信签名审核规范的具体内容。'."\n"
.'- 通过接口申请的签名信息会同步在短信服务控制台。控制台相关操作,请参见[短信签名](~~108073~~)。'."\n"
."\n"
.'- 提交签名申请后,您可以通过[GetSmsSign](~~2807429~~)接口查询签名审核状态和详情。也可以[配置回执消息](~~101508~~),通过[SignSmsReport](~~120998~~)获取签名的审核状态消息。',
],
'GetSmsSign' => [
'summary' => '申请签名后,通过此接口查询签名审核详情',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '218493',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
],
'parameters' => [
[
'name' => 'SignName',
'in' => 'query',
'schema' => [
'description' => '签名名称。必须是本账号已申请的短信签名。'."\n"
."\n"
.'- 调用[CreateSmsSign](~~2807427~~)接口后在返回参数中获取。'."\n"
.'- 在[签名管理](https://dysms.console.aliyun.com/domestic/text/sign)页面查看签名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '阿里云',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
],
'Code' => [
'description' => '请求状态码。取值:'."\n"
."\n"
.'- OK:代表请求成功。'."\n"
.'- 其他错误码,请参见[API错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'SignName' => [
'description' => '短信签名名称。',
'type' => 'string',
'example' => '登录验证',
],
'SignStatus' => [
'description' => '签名审核状态。取值:'."\n"
."\n"
.'- **0**:审核中。'."\n"
.'- **1**:审核通过。'."\n"
.'- **2**:审核失败,请在返回参数`AuditInfo.RejectInfo`中查看审核失败原因。'."\n"
.'- **10**:取消审核。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'CreateDate' => [
'description' => '短信签名的创建日期和时间。',
'type' => 'string',
'example' => '2024-06-03 10:02:34',
],
'OrderId' => [
'description' => '工单号。'."\n"
."\n"
.'审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。',
'type' => 'string',
'example' => '20044156924',
],
'QualificationId' => [
'description' => '资质ID。申请签名时关联的资质ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '2004393****',
],
'Remark' => [
'description' => '短信签名场景说明,长度不超过200个字符。',
'type' => 'string',
'example' => '登录场景验证码',
],
'AuditInfo' => [
'description' => '审核信息。',
'type' => 'object',
'properties' => [
'RejectInfo' => [
'description' => '审批未通过的原因。',
'type' => 'string',
'example' => '通过资质信息,不能判断是否可以申请此签名。',
],
'AuditDate' => [
'description' => '审核时间。',
'type' => 'string',
'example' => '2024-06-03 12:02:34'."\n",
],
],
],
'FileUrlList' => [
'description' => '更多资料信息,补充上传业务证明文件或业务截图文件列表。',
'type' => 'array',
'items' => [
'description' => '上传到OSS上的文件信息。',
'type' => 'string',
'example' => '10098689758*****/1234qwe.png'."\n",
],
],
'SignCode' => [
'description' => '短信签名Code。',
'type' => 'string',
'example' => 'SIGN_100000077042023_17174665*****_ZM2kG',
],
'SignTag' => [
'description' => '签名标识。取值:'."\n"
."\n"
.'- 2:用户自定义创建签名。'."\n"
.'- 3:系统赠送签名。'."\n"
.'- 4:测试签名。'."\n"
.'- 5:试用签名。',
'type' => 'string',
'example' => '2',
],
'ApplyScene' => [
'description' => '应用场景内容。',
'type' => 'string',
'example' => 'http://www.aliyun.com/'."\n",
],
'ThirdParty' => [
'description' => '签名为自用或他用。'."\n"
."\n"
.'- false:自用(默认值)。'."\n"
."\n"
.'- true:他用。',
'type' => 'boolean',
'example' => 'false',
],
'SignUsage' => [
'description' => '签名使用场景。',
'type' => 'string',
'example' => '已注册商标名称。',
],
'RegisterResult' => [
'description' => '**已废弃,请使用`SignIspRegisterDetailList`查看各运营商实名报备结果。**'."\n"
."\n"
.'签名实名制报备结果。取值:'."\n"
.'- 0:报备失败。'."\n"
.'- 1:报备成功。'."\n"
.'- 2:报备失效。'."\n"
.'- -1:无状态。'."\n"
."\n"
.'建议您单击查看[更多签名实名制报备内容及建议操作](~~2873145~~)。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'AuthorizationLetterId' => [
'description' => '委托授权书ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1000********1234',
],
'AuthorizationLetterAuditPass' => [
'description' => '委托授权书审核状态。取值:'."\n"
.'- true:审核通过。'."\n"
.'- false:审核未通过(包含审核通过外的其他所有状态)。',
'type' => 'boolean',
'enumValueTitles' => [
'true' => 'true',
'false' => 'false',
],
'example' => 'true',
],
'SignIspRegisterDetailList' => [
'description' => '运营商报备状态列表。获取此参数返回数据需要[更新SDK](https://api.aliyun.com/api-tools/sdk/Dysmsapi?version=2017-05-25&language=java-tea&tab=primer-doc)至4.1.2版本或以上。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RegisterStatus' => [
'description' => '报备状态。取值:'."\n"
."\n"
.'- **0**:报备失败,原因可能为资质信息与工信注册信息不一致或运营商侧无法支持等。建议您登录[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/sign)查看具体失败原因,并依据提示进行操作;'."\n"
.'- **1**:已报备待验证,当前至少有一个子端口号运营商已返回报备通过,建议您少量多次向不同运营商手机号发送验证码、通知短信进行验证;'."\n"
.'- **2**:报备失效,签名超过 6 个月无发送记录时,报备结果失效。如您需要重新启用该签名,请在[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/sign)重新发起报备;'."\n"
.'- **3**:报备成功,当前至少有一个子端口号运营商已返回报备通过,经验证短信发送成功率符合预期,建议您持续关注发送成功率;'."\n"
.'- **-1**:报备中,当前尚未收到运营商反馈的报备结果,建议您等待签名报备状态变更为“已报备待验证”后再批量发送,当前可少量多次尝试使用该签名发送,观察短信发送效果;'."\n"
.'- **-2**:未报备,原因可能为当前签名未关联实名资质或关联资质信息不全,建议您修改当前资质或编辑签名绑定其他资质以重新发起报备。'."\n"
."\n"
.'建议您单击查看[更多签名实名制报备内容及建议操作](~~2873145~~)。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'OperatorCode' => [
'description' => '运营商类型。取值:'."\n"
.'- **mobile**:中国移动;'."\n"
.'- **unicom**:中国联通;'."\n"
.'- **telecom**:中国电信。',
'type' => 'string',
'example' => 'telecom',
],
'OperatorCompleteTime' => [
'description' => '运营商反馈时间,格式为yyyy-MM-dd HH:mm:ss。',
'type' => 'string',
'example' => '2025-06-13 15:55:26',
],
'RegisterStatusReasons' => [
'description' => '报备状态原因列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ReasonCode' => [
'description' => '报备状态原因码。取值:'."\n"
.'- **UNBINDING_QUA**:签名未关联资质;'."\n"
.'- **BINDING_INCOMPLETE_QUA**:关联资质信息不全;'."\n"
.'- **NON_REGISTER**:未发起报备;'."\n"
.'- **REGISTERING**:签名报备中;'."\n"
.'- **DETECTING**:未发起探测或探测中;'."\n"
.'- **DETECT_SUCCESS**:报备成功;'."\n"
.'- **QUALIFICATION_ERROR**:资质原因;'."\n"
.'- **SIGNATURE_ERROR**:签名原因;'."\n"
.'- **SIGNATURE_QUALIFICATION_ERROR**:签名与资质关系不符;'."\n"
.'- **ONE_CODE_MULTIPLE_SIGN**:扩展码原因;'."\n"
.'- **OTHERS_ERROR**:其他原因;'."\n"
.'- **REGISTER_TIMEOUT**:报备超时;'."\n"
.'- **NO_SEND_RECORD**:签名超过6个月无发送记录;'."\n"
.'- **EXT_CODE_RECYCLE**:扩展码收回。'."\n"
.'- **SUBPORT_RECYCLE**:子端口被运营商治理。',
'type' => 'string',
'example' => 'REGISTER_TIMEOUT',
],
'ReasonDescList' => [
'description' => '原因说明列表。可能返回0个或者多个原因说明,返回原因码不一定会返回原因说明。',
'type' => 'array',
'items' => [
'description' => '原因说明。',
'type' => 'string',
'example' => '报备超时。',
],
],
],
],
],
],
],
],
'TrademarkId' => [
'description' => '商标实体id。',
'type' => 'integer',
'format' => 'int64',
'example' => '1000009081***',
],
'AppIcpRecordId' => [
'description' => 'APP-ICP备案实体id。',
'type' => 'integer',
'format' => 'int64',
'example' => '1000009***123',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
],
404 => [
[
'errorCode' => 'SignatureNotFound',
'errorMessage' => 'The signature does not exist.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"SignName\\": \\"登录验证\\",\\n \\"SignStatus\\": 2,\\n \\"CreateDate\\": \\"2024-06-03 10:02:34\\",\\n \\"OrderId\\": \\"20044156924\\",\\n \\"QualificationId\\": 0,\\n \\"Remark\\": \\"登录场景验证码\\",\\n \\"AuditInfo\\": {\\n \\"RejectInfo\\": \\"通过资质信息,不能判断是否可以申请此签名。\\",\\n \\"AuditDate\\": \\"2024-06-03 12:02:34\\\\n\\"\\n },\\n \\"FileUrlList\\": [\\n \\"10098689758*****/1234qwe.png\\\\n\\"\\n ],\\n \\"SignCode\\": \\"SIGN_100000077042023_17174665*****_ZM2kG\\",\\n \\"SignTag\\": \\"2\\",\\n \\"ApplyScene\\": \\"http://www.aliyun.com/\\\\n\\",\\n \\"ThirdParty\\": false,\\n \\"SignUsage\\": \\"已注册商标名称。\\",\\n \\"RegisterResult\\": 1,\\n \\"AuthorizationLetterId\\": 0,\\n \\"AuthorizationLetterAuditPass\\": true,\\n \\"SignIspRegisterDetailList\\": [\\n {\\n \\"RegisterStatus\\": 0,\\n \\"OperatorCode\\": \\"telecom\\",\\n \\"OperatorCompleteTime\\": \\"2025-06-13 15:55:26\\",\\n \\"RegisterStatusReasons\\": [\\n {\\n \\"ReasonCode\\": \\"REGISTER_TIMEOUT\\",\\n \\"ReasonDescList\\": [\\n \\"报备超时。\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"TrademarkId\\": 0,\\n \\"AppIcpRecordId\\": 0\\n}","type":"json"}]',
'title' => '查询签名详情(新接口)',
'description' => '- 仅可查询**首次创建**的签名资料或者**最新审核通过**的资料。'."\n"
."\n"
.'- 新接口和原接口变更的公告详情请参见[关于短信服务更新签名&模板接口的公告](~~2806975~~)。'."\n"
."\n"
.'- 审核时间:一般情况下,签名提交后,阿里云预计在 2 个小时内审核完成(审核工作时间:周一至周日 9:00~21:00,法定节假日顺延)。'."\n"
."\n"
.'- 如果签名未通过审核,会返回审核失败的原因,请参考[短信审核失败的处理建议](~~65990~~),调用[UpdateSmsSign](~~2807428~~)接口或在[签名管理](https://dysms.console.aliyun.com/domestic/text/sign)页面修改未审核通过的短信签名。'."\n"
."\n"
.'- [QuerySmsSignList](~~QuerySmsSignList~~)接口可以查询您账号下的所有签名,包括签名审核状态、签名类型、签名名称等。'."\n"
."\n"
.'- 本接口的单用户QPS限制为150次/秒。超过限制,API调用将会被限流,这可能会影响您的业务,请合理调用。',
],
'QuerySmsSignList' => [
'summary' => '可以通过此接口可以查询您账号下的所有签名,方便您查看签名详情,包括签名审核状态、签名类型、签名名称等。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '118916',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
],
'parameters' => [
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => [
'description' => '当前页码,默认取值为**1**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'minimum' => '1',
'example' => '1',
'minLength' => 1,
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示的签名个数。默认取值为**10**,取值范围:**1~50**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'."\n",
],
'Code' => [
'description' => '请求状态码。取值:'."\n"
.' '."\n"
.'- OK:代表请求成功。'."\n"
."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'SmsSignList' => [
'description' => '结果列表。',
'type' => 'array',
'items' => [
'description' => '结果列表。',
'type' => 'object',
'properties' => [
'SignName' => [
'description' => '签名名称。',
'type' => 'string',
'example' => '阿里云',
],
'AuditStatus' => [
'description' => '签名审批状态。取值:'."\n"
."\n"
.'- **AUDIT_STATE_INIT**:审核中。'."\n"
."\n"
.'- **AUDIT_STATE_PASS**:审核通过。'."\n"
."\n"
.'- **AUDIT_STATE_NOT_PASS**:审核未通过,请在返回参数Reason中查看审核未通过原因。'."\n"
."\n"
.'- **AUDIT_STATE_CANCEL**:取消审核。',
'type' => 'string',
'example' => 'AUDIT_STATE_NOT_PASS',
],
'CreateDate' => [
'description' => '短信签名的创建日期和时间,格式为yyyy-MM-dd HH:mm:ss。',
'type' => 'string',
'example' => '2020-06-04 11:42:17',
],
'Reason' => [
'description' => '审核备注。'."\n"
."\n"
.'- 如果审核状态为**审核通过**或**审核中**,参数Reason显示为“无审核备注”。'."\n"
."\n"
.'- 如果审核状态为**审核未通过**,参数Reason显示审核的具体原因。',
'type' => 'object',
'properties' => [
'RejectSubInfo' => [
'description' => '审批未通过的备注信息。',
'type' => 'string',
'example' => '文件不能证明信息真实性,请重新上传。',
],
'RejectDate' => [
'description' => '审批未通过的时间,格式为yyyy-MM-dd HH:mm:ss。',
'type' => 'string',
'example' => '2020-06-04 13:35:10',
],
'RejectInfo' => [
'description' => '审批未通过的原因。',
'type' => 'string',
'example' => '文件不能证明信息真实性,请重新上传。',
],
],
],
'BusinessType' => [
'description' => '签名场景类型。取值:'."\n"
."\n"
.'- 验证码类型。'."\n"
."\n"
.'- 通用类型。',
'type' => 'string',
'example' => '验证码类型',
],
'OrderId' => [
'description' => '工单号。'."\n"
."\n"
.'审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。',
'type' => 'string',
'example' => '2005098****',
],
'AuthorizationLetterId' => [
'description' => '委托授权书ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1000********1234',
],
'authorizationLetterAuditPass' => [
'description' => '委托授权书审核状态。取值:'."\n"
.'- true:审核通过。'."\n"
.'- false:审核未通过(包含审核通过外的其他所有状态)。',
'type' => 'boolean',
'enumValueTitles' => [
'true' => 'true',
'false' => 'false',
],
'example' => 'true',
],
'TrademarkId' => [
'description' => '商标实体id。',
'type' => 'integer',
'format' => 'int64',
'example' => '1000009081***',
],
'AppIcpRecordId' => [
'description' => 'APP-ICP备案实体id。',
'type' => 'integer',
'format' => 'int64',
'example' => '1000001***123',
],
],
],
],
'TotalCount' => [
'description' => '签名总数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'CurrentPage' => [
'description' => '当前页码。默认取值为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '每页显示的签名个数。默认取值为**10**,取值范围:**1~50**。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\\\n\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"SmsSignList\\": [\\n {\\n \\"SignName\\": \\"阿里云\\",\\n \\"AuditStatus\\": \\"AUDIT_STATE_NOT_PASS\\",\\n \\"CreateDate\\": \\"2020-06-04 11:42:17\\",\\n \\"Reason\\": {\\n \\"RejectSubInfo\\": \\"文件不能证明信息真实性,请重新上传。\\",\\n \\"RejectDate\\": \\"2020-06-04 13:35:10\\",\\n \\"RejectInfo\\": \\"文件不能证明信息真实性,请重新上传。\\"\\n },\\n \\"BusinessType\\": \\"验证码类型\\",\\n \\"OrderId\\": \\"2005098****\\",\\n \\"AuthorizationLetterId\\": 0,\\n \\"authorizationLetterAuditPass\\": true,\\n \\"TrademarkId\\": 0,\\n \\"AppIcpRecordId\\": 0\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10\\n}","errorExample":""},{"type":"xml","example":"<QuerySmsSignListResponse>\\n <RequestId>819BE656-D2E0-4858-8B21-B2E47708****</RequestId>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <SmsSignList>\\n <SignName>阿里云</SignName>\\n <AuditStatus>AUDIT_STATE_NOT_PASS</AuditStatus>\\n <CreateDate>2020-01-08 16:44:13</CreateDate>\\n <Reason>\\n <RejectSubInfo>文件不能证明信息真实性,请重新上传。</RejectSubInfo>\\n <RejectDate>2020-01-08 19:02:13</RejectDate>\\n <RejectInfo>文件不能证明信息真实性,请重新上传。</RejectInfo>\\n </Reason>\\n <BusinessType>验证码类型</BusinessType>\\n <OrderId>236****5</OrderId>\\n </SmsSignList>\\n</QuerySmsSignListResponse>","errorExample":""}]',
'title' => '查询签名列表详情',
'description' => '本接口可以查询您当前账号下**首次创建**的签名资料或者**最新审核通过**的签名详情。如果您需要查询应用场景内容、申请时上传的文件资料信息等更多内容,可以调用[GetSmsSign](~~GetSmsSign~~)接口通过签名名称查询单个签名审核详情。',
],
'UpdateSmsSign' => [
'summary' => '修改未通过审核和已经审核通过的签名,修改完成后自动提交审核,签名进入待审核状态。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '219280',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
],
'parameters' => [
[
'name' => 'SignName',
'in' => 'query',
'schema' => [
'description' => '未审核通过的短信签名。您可在控制台[国内消息>签名管理](https://dysms.console.aliyun.com/domestic/text/sign)页签进行查看未通过审核得短信签名。也可通过[QuerySmsSignList](~~QuerySmsSignList~~)接口查看未通过审核的短信签名。',
'type' => 'string',
'required' => true,
'example' => '阿里云验证码',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '短信签名场景说明,是签名审核的参考信息之一,长度不超过200个字符。'."\n"
.'> - 您可以提供已上线业务的使用场景,并提供实际业务的网站链接、应用市场下载链接等。'."\n"
.'> - 您可以提供短信完整示例,体现您的业务场景。'."\n"
.'> - 您可以提供变量的传参内容,详细描述业务使用场景和选择这个变量属性的原因。'."\n"
.'> - 若签名涉及政企机关单位,请备注政企机关单位的固定电话。'."\n"
."\n"
.'信息完善的申请说明会提高签名、模板的审核效率。如未按规范进行填写或不填写,可能会影响您签名审核的通过。',
'type' => 'string',
'required' => false,
'example' => '登录场景申请验证码',
'maxLength' => 500,
],
],
[
'name' => 'SignType',
'in' => 'query',
'schema' => [
'description' => '签名类型。取值:'."\n"
."\n"
.'- **0**:验证码。'."\n"
.'- **1**:通用(默认值)。'."\n"
."\n"
.'建议使用默认值:**通用**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'MoreData',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '更多资料。补充上传业务证明文件或业务截图,有助于审核人员了解您的业务详情。请参见[签名申请材料](~~108076#section-xup-k46-yi4~~),上传相关材料。',
'type' => 'array',
'items' => [
'description' => '上传到OSS的文件信息。待上传的**文件命名不可包含中文及特殊字符**。文件上传操作请参见[通过OSS上传文件](https://help.aliyun.com/zh/sms/upload-files-through-oss)。',
'type' => 'string',
'required' => false,
'example' => '10098689758*****/1234qwe.png'."\n",
],
'required' => false,
],
],
[
'name' => 'QualificationId',
'in' => 'query',
'schema' => [
'description' => '已审核通过的资质ID。'."\n"
."\n"
.'> - 在申请短信签名前,请先[申请资质](https://help.aliyun.com/zh/sms/user-guide/new-qualification?spm=a2c4g.11186623.0.0.718d187bbkpMRK)。'."\n"
.'> - 您可在[资质管理](https://dysms.console.aliyun.com/domestic/text/qualification)页面查看资质ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '8563**',
],
],
[
'name' => 'ApplySceneContent',
'in' => 'query',
'schema' => [
'description' => 'App应用商店链接,若签名来源为“已上线APP”,即`SignSource`取值为2时,请填写http://或https://开头的应用商店链接,并确保App已经上线。',
'type' => 'string',
'required' => false,
'example' => 'http://www.aliyun.com/'."\n",
],
],
[
'name' => 'SignSource',
'in' => 'query',
'schema' => [
'description' => '签名来源。取值:'."\n"
."\n"
.'- **0**:企事业单位的全称或简称。**(优先推荐)**'."\n"
.'- **5**:商标名的全称或简称。'."\n"
.'- **2**:App应用的全称或简称。**(不推荐)**'."\n"
."\n"
.'签名来源的详细说明请参见[签名来源](~~108076#section-fow-bfu-wo9~~)。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'enumValueTitles' => [],
'example' => '2',
'enum' => [
'0',
'1',
'2',
'3',
'4',
'5',
],
],
],
[
'name' => 'ThirdParty',
'in' => 'query',
'schema' => [
'description' => '签名用途。取值:'."\n"
."\n"
.'- false:自用(默认值,签名为本账号实名认证的企业、网站、产品名等)。'."\n"
."\n"
.'- true:他用(签名为非本账号实名认证的企业、网站、产品名等)。'."\n"
.'><notice>签名为自用时,请选择自用资质ID;签名为他用时,请选择他用资质ID。></notice>',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'AuthorizationLetterId',
'in' => 'query',
'schema' => [
'description' => '委托授权书ID,当签名为他用时,委托授权书ID不可为空,否则签名审核不通过。委托授权书的社会统一信用代码必须与签名绑定的资质信息中社会统一信用代码字段保持一致,否则创建签名失败。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1000********1234',
],
],
[
'name' => 'TrademarkId',
'in' => 'query',
'schema' => [
'description' => '商标实体id。'."\n"
.'> - 当SignSource=5时,需要传商标实体id。'."\n"
.'> - 商标实体id可以通过调用[创建商标实体](~~CreateSmsTrademark~~)接口获取。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1000009081***',
],
],
[
'name' => 'AppIcpRecordId',
'in' => 'query',
'schema' => [
'description' => 'APP-ICP备案实体id。'."\n"
.'> - 当SignSource=2时,需要传备案实体id。'."\n"
.'> - 备案实体id可以通过调用[创建ICP备案实体](~~CreateSmsAppIcpRecord~~)接口获取。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '100001***1234',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D1D',
],
'Code' => [
'description' => '请求状态码。取值:'."\n"
."\n"
.'* OK:代表请求成功。'."\n"
.'* 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'SignName' => [
'description' => '已修改的签名名称。',
'type' => 'string',
'example' => '登录验证',
],
'OrderId' => [
'description' => '工单号。'."\n"
."\n"
.'审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。',
'type' => 'string',
'example' => '2004417****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
[
'errorCode' => 'ParameterMismatch.ThirdParty',
'errorMessage' => 'The type of signature, whether for personal use or for a third party, should be consistent with the qualifications.',
],
[
'errorCode' => 'SignName.Exists',
'errorMessage' => 'Sorry, this signature already exists and cannot be applied for again.',
],
[
'errorCode' => 'InvalidQualification',
'errorMessage' => 'The qualification should be approved.',
],
[
'errorCode' => 'InvalidApplySceneContent',
'errorMessage' => 'For certain signature sources, the '."\n"
.'applySceneContent should be an HTTP or HTTPS link.',
],
[
'errorCode' => 'InvalidSignName',
'errorMessage' => 'The signature cannot contain spaces, special '."\n"
.'symbols, or all numbers.',
],
[
'errorCode' => 'MissApplySceneContent',
'errorMessage' => 'In some signature sources, the applySceneContent is required.',
],
[
'errorCode' => 'MissingSignName',
'errorMessage' => 'The signature name cannot be empty.',
],
[
'errorCode' => 'SmsAuthorizationLetterNotMatch',
'errorMessage' => 'Please bind the available authorization letter whose the social credit code is same to the the social credit code of qualification.',
],
[
'errorCode' => 'SmsAuthorizationLetterNotExist',
'errorMessage' => 'Authorization does not belong to the customer.',
],
[
'errorCode' => 'SmsSignNotAuthorized',
'errorMessage' => 'the signature is not in the sign scope of the authorization letter.',
],
[
'errorCode' => 'TrademarkNotExist',
'errorMessage' => 'The trademark does not exist.',
],
[
'errorCode' => 'AppIcpRecordNotExist',
'errorMessage' => 'The APP-ICP record does not exist.',
],
],
404 => [
[
'errorCode' => 'QualificationNotFound',
'errorMessage' => 'Qualification does not exist.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D1D\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"SignName\\": \\"登录验证\\",\\n \\"OrderId\\": \\"2004417****\\"\\n}","type":"json"}]',
'title' => '修改短信签名(新接口)',
'description' => '- 新接口和原接口变更的公告详情请参见[关于短信服务更新签名&模板接口的公告](~~2806975~~)。'."\n"
.'- 支持修改**未通过审核**和**已经审核通过**的签名,请参考[短信审核失败的处理建议](~~65990~~),调用此接口修改后重新提交审核。'."\n"
.'- **未通过审核**的签名如需编辑名称,该接口不支持,您可以访问控制台页面进行修改。[短信服务签名控制台入口](https://dysms.console.aliyun.com/domestic/text/sign)。'."\n"
.'- 通过接口申请的签名信息会同步在短信服务控制台,在控制台对签名的相关操作,请参见[短信签名](~~108073~~)。',
],
'DeleteSmsSign' => [
'summary' => '如果您不再使用某个短信签名,需要删除签名时,调用此接口或在短信服务控制台删除短信签名。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102444',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
],
'parameters' => [
[
'name' => 'SignName',
'in' => 'query',
'schema' => [
'description' => '短信签名。支持删除已撤回、审核失败或审核通过的签名,审核中的短信签名不支持删除。'."\n"
."\n"
.'您可以通过[QuerySmsSignList](~~419282~~)接口查询当前账号已申请的签名或在短信控制台[签名管理](https://dysms.console.aliyun.com/domestic/text/sign)页查看签名列表'."\n"
.'><notice>删除短信签名后不可恢复,且后续不可再使用该签名发送短信,请谨慎操作。></notice>',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '阿里云',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'* 返回OK代表请求成功。'."\n"
.'* 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D****',
],
'SignName' => [
'description' => '已删除的签名名称。',
'type' => 'string',
'example' => '阿里云',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D****\\",\\n \\"SignName\\": \\"阿里云\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<DeleteSmsSignResponse>\\r\\n <Message>OK</Message>\\r\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8D****</RequestId>\\r\\n <SignName>阿里云</SignName>\\r\\n <Code>OK</Code>\\r\\n</DeleteSmsSignResponse>","errorExample":""}]',
'title' => '删除短信签名',
'description' => '- 支持删除已撤回、审核失败或审核通过的签名,审核中的短信签名不支持删除。'."\n"
.'- 删除短信签名后不可恢复,且后续不可再使用该签名发送短信,请谨慎操作。'."\n"
.'- 通过接口删除签名的操作会在短信服务控制台同步,在控制台对模板的相关操作,请参见[短信签名](~~108073~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ChangeSignatureQualification' => [
'summary' => '更换签名的资质和授权书。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '268874',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SignatureName',
'in' => 'query',
'schema' => [
'title' => '签名',
'description' => '短信签名。',
'type' => 'string',
'required' => true,
'example' => '阿里云',
],
],
[
'name' => 'QualificationId',
'in' => 'query',
'schema' => [
'title' => '资质id',
'description' => '资质ID,即您申请资质返回的ID。您可以通过控制台国内消息[资质管理](https://dysms.console.aliyun.com/domestic/text/qualification)页面获取当前账号下的资质ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1*****2',
],
],
[
'name' => 'AuthorizationLetterId',
'in' => 'query',
'schema' => [
'title' => '授权委托书id',
'description' => '授权委托书ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1000********1234',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。',
'type' => 'string',
'example' => '无',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => '0A974B78-02BF-4C79-ADF3-90CFBA1B55B1',
],
'Data' => [
'description' => '返回数据结构。',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '本数据无返回,可忽略。',
'type' => 'object',
],
'ErrMessage' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '调用接口是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'ErrCode' => [
'description' => '请求状态码。',
'type' => 'string',
'example' => 'OK',
],
],
],
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见本章节的错误码列表或产品[API 错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'enumValueTitles' => [
'true' => 'true',
'false' => 'false',
],
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'QualificationNotExist',
'errorMessage' => 'Can\'t query qualification information.',
],
[
'errorCode' => 'SmsAuthorizationLetterNotExist',
'errorMessage' => 'Authorization does not belong to the customer.',
],
[
'errorCode' => 'SmsSignatureNotExist',
'errorMessage' => 'Signature does not exist.',
],
[
'errorCode' => 'SmsQualificationRegisterFailed',
'errorMessage' => 'The registration of the current qualification fails. Please modify the qualification and re-bind the qualification before completing the signature registration process again.',
],
[
'errorCode' => 'SmsQualificationNotPassed',
'errorMessage' => 'The qualification has not been approved and cannot be bound to the signature.',
],
[
'errorCode' => 'SmsPassedAuthorizationLetterNotMatch',
'errorMessage' => 'Please bind audited authorization letter whose the social credit code is same to the the social credit code of qualification.',
],
[
'errorCode' => 'QualificationNotComplete',
'errorMessage' => 'The qualification elements are incomplete.',
],
[
'errorCode' => 'SmsSignNotAuthorized',
'errorMessage' => 'the signature is not in the sign scope of the authorization letter.',
],
[
'errorCode' => 'SMS_STATUS_ILLEGAL',
'errorMessage' => 'When replacing the qualification and power of attorney of the signature, the signature status must be approved.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"0A974B78-02BF-4C79-ADF3-90CFBA1B55B1\\",\\n \\"Data\\": {\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ErrMessage\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"OK\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '更换签名的资质和授权书(待下线)',
],
'AddSmsSign' => [
'summary' => '该接口已下线。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102438',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
],
'parameters' => [
[
'name' => 'SignName',
'in' => 'query',
'schema' => [
'description' => '签名名称,签名名称请遵守[签名规范](~~108076#section-0p8-qn8-mmy~~)。'."\n"
."\n"
.'> - 签名名称不区分大小写字母,如【Aliyun通信】和【aliyun通信】视为名称相同。'."\n"
.'> - 当您的验证码签名和通用签名名称相同时,系统默认使用通用签名发送短信。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '阿里云',
],
],
[
'name' => 'SignSource',
'in' => 'query',
'schema' => [
'description' => '签名来源。取值:'."\n"
."\n"
.'- **0**:企事业单位的全称或简称。'."\n"
.'- **1**:工信部备案网站的全称或简称。'."\n"
.'- **2**:App应用的全称或简称。'."\n"
.'- **3**:公众号或小程序的全称或简称。'."\n"
.'- **4**:电商平台店铺名的全称或简称。'."\n"
.'- **5**:商标名的全称或简称。'."\n"
."\n"
.'签名来源的详细说明请参见[签名来源](https://help.aliyun.com/zh/sms/user-guide/signature-specifications-1?spm=a2c4g.11186623.0.0.4f9710fder2gR7#section-xup-k46-yi4)。'."\n"
."\n"
.'>此接口不支持申请签名来源是**测试或学习**和**线上试用**的签名,如果您需要申请这两种签名来源的签名,请前往[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/sign/add/qualification)申请。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '短信签名场景说明,长度不超过200个字符。'."\n"
."\n"
.'签名审核的参考信息,完善申请说明有助于审核人员理解您的业务场景,提高审核效率。填写指导:'."\n"
."\n"
.'- 您可以提供已上线业务的使用场景。'."\n"
."\n"
.'- 您可以提供真实场景的短信示例,体现您的业务场景。'."\n"
."\n"
.'- 您可以提供变量的传参内容,详细描述业务使用场景和选择这个变量属性的原因。'."\n"
."\n"
.'- 您可以提供实际业务的网站链接、已备案的域名地址、应用市场下载链接等。'."\n"
."\n"
.'- 登录场景,您可以提供测试账号和密码。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '当前的短信签名应用于双11大促推广营销',
],
],
[
'name' => 'SignFileList',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => '签名文件列表。',
'type' => 'array',
'items' => [
'description' => '签名数据。',
'type' => 'object',
'properties' => [
'FileContents' => [
'description' => '签名的资质证明文件经base64编码后的字符串。图片不超过2 MB。个别场景下,申请签名需要上传证明文件。'."\n"
."\n"
.'详细规范,请参见[上传文件规范](~~463316~~)。',
'type' => 'string',
'required' => true,
'example' => 'R0lGODlhHAAmAKIHAKqqqsvLy0hISObm5vf394uL****',
],
'FileSuffix' => [
'description' => '签名的证明文件格式,支持上传多张图片。当前支持JPG、PNG、GIF或JPEG格式的图片。个别场景下,申请签名需要上传证明文件。'."\n"
."\n"
.'> 如果签名用途为他用或个人认证用户的自用签名来源为企事业单位名时,还需上传证明文件和委托授权书,详情请参见[证明文件](~~108076~~)和[授权委托书](~~56741~~)。',
'type' => 'string',
'required' => true,
'example' => 'jpg',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 10,
],
],
[
'name' => 'SignType',
'in' => 'query',
'schema' => [
'description' => '签名类型。'."\n"
."\n"
.'- **0**:验证码'."\n"
.'- **1**:通用',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'* 返回OK代表请求成功。'."\n"
.'* 其他错误码,请参见[API错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
],
'SignName' => [
'description' => '签名名称。',
'type' => 'string',
'example' => '阿里云',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"SignName\\": \\"阿里云\\"\\n}","type":"json"}]',
'title' => '申请短信签名(已下线)',
'description' => '- 根据工信部规定与运营商[相关要求](~~2806975~~),阿里云进行了签名相关API的功能改造,为提升您签名的审核效率和审核通过率,请您使用新接口[CreateSmsSign-申请短信签名](~~2807427~~)。'."\n"
."\n"
.'- 个人用户同一个阿里云账号一个自然日支持申请一个签名;企业用户申请次数无限制。个人用户与企业用户权益区别详情请参见[使用须知](~~55324~~)。'."\n"
."\n"
.'- 通过接口申请的签名信息会同步在短信服务控制台,在控制台对签名的相关操作,请参见[短信签名](~~108073~~)。'."\n"
."\n"
.'- 提交签名申请后,您可以通过[QuerySmsSign](~~419283~~)接口查询签名审核状态和详情。也可以[配置回执消息](~~101508~~),通过[SignSmsReport](~~120998~~)获取签名的审核状态消息。'."\n"
."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为1次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifySmsSign' => [
'summary' => '该接口已下线。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102449',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
],
'parameters' => [
[
'name' => 'SignName',
'in' => 'query',
'schema' => [
'description' => '签名名称。'."\n"
."\n"
.'> 审核通过的签名支持修改,但不支持修改签名名称,修改后的签名需要重新通过审核后才能使用。签名审核未完成前,原签名也不能正常使用。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '阿里云',
],
],
[
'name' => 'SignSource',
'in' => 'query',
'schema' => [
'description' => '签名来源。取值:'."\n"
."\n"
.'- **0**:企事业单位的全称或简称。'."\n"
.'- **1**:工信部备案网站的全称或简称。'."\n"
.'- **2**:App应用的全称或简称。'."\n"
.'- **3**:公众号或小程序的全称或简称。'."\n"
.'- **4**:电商平台店铺名的全称或简称。'."\n"
.'- **5**:商标名的全称或简称。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '短信签名申请说明,长度不超过200个字符。'."\n"
."\n"
.'签名审核的参考信息,完善申请说明有助于审核人员理解您的业务场景,提高审核效率。填写指导:'."\n"
."\n"
.'- 您可以提供已上线业务的使用场景。'."\n"
.'- 您可以提供真实场景的短信示例,体现您的业务场景。'."\n"
.'- 您可以提供变量的传参内容,详细描述业务使用场景和选择这个变量属性的原因。'."\n"
.'- 您可以提供实际业务的网站链接、已备案的域名地址、应用市场下载链接等。'."\n"
.'- 登录场景,您可以提供测试账号和密码。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '当前的短信签名应用于双11大促推广营销',
],
],
[
'name' => 'SignFileList',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => '签名文件列表。',
'type' => 'array',
'items' => [
'description' => '签名文件列表。',
'type' => 'object',
'properties' => [
'FileContents' => [
'description' => '签名的纸质证明文件经base64编码后的字符串。图片不超过2 MB。'."\n"
."\n"
.'个别场景下,申请签名需要上传证明文件。详细说明,请参见[短信签名规范](~~108076~~)。',
'type' => 'string',
'required' => true,
'example' => 'R0lGODlhHAAmAKIHAKqqqsvLy0hISObm5vf394uLiwAA',
],
'FileSuffix' => [
'description' => '签名的证明文件格式,支持上传多张图片。当前支持JPG、PNG、GIF或JPEG格式的图片。'."\n"
."\n"
.'个别场景下,申请签名需要上传证明文件。详细说明,请参见[短信签名规范](~~108076~~)。'."\n"
.'> 如果签名用途为他用或个人认证用户的自用签名来源为企事业单位名时,还需上传证明文件和委托授权书,详情请参见[证明文件](~~108076~~)和[授权委托书](~~56741~~)。',
'type' => 'string',
'required' => true,
'example' => 'jpg',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 10,
],
],
[
'name' => 'SignType',
'in' => 'query',
'schema' => [
'description' => '签名类型。取值:'."\n"
."\n"
.'- **0**:验证码'."\n"
."\n"
.'- **1**:通用',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'* 返回OK代表请求成功。'."\n"
.'* 其他错误码,请参见[API错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
],
'SignName' => [
'description' => '签名名称。',
'type' => 'string',
'example' => '阿里云',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"SignName\\": \\"阿里云\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<ModifySmsSignResponse>\\r\\n <Message>OK</Message>\\r\\n <RequestId>44DF7A95-603F-4651-9298-BE1850BEB53F</RequestId>\\r\\n <Code>OK</Code>\\r\\n <SignName>阿里云</SignName>\\r\\n</ModifySmsSignResponse>","errorExample":""}]',
'title' => '修改短信签名(已下线)',
'description' => '- 根据工信部规定与运营商[相关要求](~~2806975~~),阿里云进行了签名相关API的功能改造。为提升您签名的审核效率和审核通过率,请您使用新接口[UpdateSmsSign-修改短信签名](~~2807428~~)。'."\n"
."\n"
.'- 仅支持修改未通过审核的签名,请参考[短信审核失败的处理建议](~~65990~~),调用此接口修改后自动提交审核,签名进入待审核状态。'."\n"
."\n"
.'- 通过接口修改签名的操作会在短信服务控制台同步,在控制台对签名的相关操作,请参见[短信签名](~~108073~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QuerySmsSign' => [
'summary' => '查询签名审核状态。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102459',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
],
'parameters' => [
[
'name' => 'SignName',
'in' => 'query',
'schema' => [
'description' => '签名名称。必须是本账号已申请的短信签名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '阿里云',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CC89A90C-978F-46AC-B80D-54738371E7CA',
],
'SignStatus' => [
'description' => '签名审核状态。取值:'."\n"
."\n"
.'- **0**:审核中。'."\n"
.'- **1**:审核通过。'."\n"
.'- **2**:审核失败,请在返回参数Reason中查看审核失败原因。'."\n"
.'- **10**:取消审核。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'* 返回OK代表请求成功。'."\n"
.'* 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码描述。',
'type' => 'string',
'example' => 'OK',
],
'CreateDate' => [
'description' => '短信签名的创建日期和时间。',
'type' => 'string',
'example' => ' 2019-01-08 16:44:13',
],
'Reason' => [
'description' => '审核备注。'."\n"
."\n"
.'- 如果审核状态为**审核通过**或**审核中**,参数Reason显示为“无审核备注”。'."\n"
.'- 如果审核状态为**审核未通过**,参数Reason显示审核的具体原因。',
'type' => 'string',
'example' => '文件不能证明信息真实性,请重新上传',
],
'SignName' => [
'description' => '短信签名。',
'type' => 'string',
'example' => '阿里云',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CC89A90C-978F-46AC-B80D-54738371E7CA\\",\\n \\"SignStatus\\": 1,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"CreateDate\\": \\" 2019-01-08 16:44:13\\",\\n \\"Reason\\": \\"文件不能证明信息真实性,请重新上传\\",\\n \\"SignName\\": \\"阿里云\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<QuerySmsSignResponse>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>CC89A90C-978F-46AC-B80D-54738371E7CA</RequestId>\\r\\n\\t<SignStatus>1</SignStatus>\\r\\n\\t<CreateDate>2019-01-08 16:44:13</CreateDate>\\r\\n\\t<Code>OK</Code>\\r\\n\\t<SignName>阿里云</SignName>\\r\\n\\t<Reason>文件不能证明信息真实性,请重新上传</Reason>\\r\\n</QuerySmsSignResponse>","errorExample":""}]',
'title' => '查询签名审核状态(待下线)',
'description' => '- 根据工信部规定与运营商[相关要求](~~2806975~~),阿里云进行了签名相关API的功能改造。请您使用新接口[GetSmsSign-查询签名详情](~~2807429~~),新接口查询结果返回参数中将比原有接口返回更多的签名详情信息。'."\n"
."\n"
.'- 审核时间:一般情况下,签名提交后,阿里云预计在2个小时内审核完成(审核工作时间:周一至周日9:00~21:00,法定节假日顺延),建议您尽量在18:00前提交申请。'."\n"
."\n"
.'- 如果签名未通过审核,会返回审核失败的原因,请参考[短信审核失败的处理建议](~~65990~~),调用[ModifySmsTemplate](~~419287~~)接口或在[签名管理](https://dysms.console.aliyun.com/domestic/text)页面修改短信签名。'."\n"
."\n"
.'- 当前接口是通过签名名称查询单个签名的审核详情。[QuerySmsSignList](~~419288~~)接口可以查询您当前账号下所有签名的签名详情。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateSmsTrademark' => [
'summary' => '创建商标实体。使用场景是签名来源=商标时,需要上传商标信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '289843',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'TrademarkPic',
'in' => 'query',
'schema' => [
'title' => '商标详情截图osskey',
'description' => '商标详情截图fileKey。'."\n"
."\n"
.'1. 商标查询方法:'."\n"
.'- 登录中国商标网点击“商标网上查询”商标详情截图。'."\n"
.'- 接受使用说明,填入“申请/注册号”查询。'."\n"
.'- 点击“申请/注册号”查询详情。'."\n"
."\n"
.'2. 上传到OSS的商标文件信息。文件上传要求:'."\n"
.'- 待上传的文件命名不可包含中文和特殊字符。'."\n"
.'- 仅支持jpg、png、gif、jpeg格式的图片,图片不大于5MB。'."\n"
.'- 截图中包含完整的网址;'."\n"
.'- 商标图片清晰,和“签名名称”完全一致;'."\n"
.'- “申请人名称”需和签名关联的企事业单位名称完全一致;'."\n"
.'- 商标状态为注册商标。'."\n"
."\n"
.'3. fileKey的获取方式如下:[通过OSS上传文件](~~2833114~~)。',
'type' => 'string',
'required' => true,
'example' => '123456/test1719383196031.jpg',
],
],
[
'name' => 'TrademarkRegistrationNumber',
'in' => 'query',
'schema' => [
'title' => '商标注册号',
'description' => '商标注册号,长度在15个字符内',
'type' => 'string',
'required' => true,
'example' => '766905',
],
],
[
'name' => 'TrademarkName',
'in' => 'query',
'schema' => [
'title' => '商标名称',
'description' => '商标名称,长度在15个字符内',
'type' => 'string',
'required' => true,
'example' => '阿里云',
],
],
[
'name' => 'TrademarkApplicantName',
'in' => 'query',
'schema' => [
'title' => '申请人名称',
'description' => '申请人名称,长度在50个字符内',
'type' => 'string',
'required' => true,
'example' => '阿里巴巴(中国)有限公司',
],
],
[
'name' => 'TrademarkEffExpDate',
'in' => 'query',
'schema' => [
'title' => '专用权生失效日期',
'description' => '专用权生失效日期。',
'type' => 'string',
'required' => true,
'example' => '2010-12-14~2030-12-13',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息。',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'title' => '',
'description' => '请求ID。'."\n",
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
],
'Message' => [
'title' => '',
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Data' => [
'title' => '',
'description' => '商标id',
'type' => 'string',
'example' => '10000*******',
],
'Code' => [
'title' => '',
'description' => '请求状态码。'."\n"
."\n"
.'* 返回OK代表请求成功。'."\n"
.'* 其他错误码,请参见本章节的错误码列表或产品[API错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '',
'description' => '接口调用是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'TrademarkOssFileNotUploadError',
'errorMessage' => 'The trademark screenshot file is not uploaded.',
],
[
'errorCode' => 'TrademarkLetterDateNotMatchRegex',
'errorMessage' => 'The format of the trademark\'s validity period is incorrect.',
],
[
'errorCode' => 'TrademarkNameNotMatchRegex',
'errorMessage' => 'The trademark name cannot be empty.',
],
[
'errorCode' => 'TrademarkNameOverLimit',
'errorMessage' => 'The trademark name exceeds the length limit.',
],
[
'errorCode' => 'TrademarkRegistrationNumberNotMatchRegex',
'errorMessage' => 'The trademark registration number cannot be empty.',
],
[
'errorCode' => 'TrademarkRegistrationNumberOverLimit',
'errorMessage' => 'The trademark registration number exceeds the length limit.',
],
[
'errorCode' => 'TrademarkApplicantNameNotMatchRegex',
'errorMessage' => 'The trademark applicant cannot be empty.',
],
[
'errorCode' => 'TrademarkApplicantNameOverLimit',
'errorMessage' => 'The trademark applicant exceeds the length limit.',
],
[
'errorCode' => 'TrademarkDateNotValid',
'errorMessage' => 'The trademark\'s validity period is not within the valid range.',
],
[
'errorCode' => 'TrademarkPicsFileError',
'errorMessage' => 'The format of the trademark screenshot file is incorrect.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"10000*******\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '创建商标实体',
'description' => '商标应在国家知识产权局商标局-中国商标网中可查,且商标所有方与企业名称一致。',
],
'QuerySmsTrademark' => [
'summary' => '查询商标实体详情信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '289842',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'TrademarkIdList',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '商标实体id列表',
'description' => '商标实体id列表',
'type' => 'array',
'items' => [
'description' => '商标实体id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '100000***',
],
'required' => true,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息。',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'title' => '',
'description' => '请求ID。',
'type' => 'string',
'example' => '569E9DBD-23FF-1785-99AD-E4B23608C104',
],
'Message' => [
'title' => '',
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Data' => [
'title' => '',
'description' => '商标详情列表。',
'type' => 'array',
'items' => [
'description' => '商标详情。',
'type' => 'object',
'properties' => [
'TrademarkPicUrl' => [
'title' => '商标截图url地址',
'description' => '商标截图URL地址',
'type' => 'string',
'example' => 'https://alicom-fc-media.oss-cn-zhangjiakou.aliyuncs.com/100000****50802/afde****-496d-46e4-899d-b43758****8_mhk9oz0p_176224****542.png?Expires=1762****6&OSSAccessKeyId=bypFN****73PsLI&Signature=BygI9X****h7%2FXmFIo****FB2c%3D',
],
'TrademarkRegistrationNumber' => [
'title' => '商标注册号',
'description' => '商标注册号',
'type' => 'string',
'example' => '1234',
],
'TrademarkName' => [
'title' => '商标名称',
'description' => '商标名称',
'type' => 'string',
'example' => '示例商标',
],
'TrademarkPic' => [
'title' => '商标截图Osskey(给签名传工单用)',
'description' => '商标截图OSS返回的图片fileKey',
'type' => 'string',
'example' => '100000*****802/afdebd46-****-46e4-899d-b4375826c898_mhk9oz0p_1762****31542.png',
],
'TrademarkEffExpDate' => [
'title' => '专用权生失效日期',
'description' => '专用权生失效日期',
'type' => 'string',
'example' => '2025-11-01~2025-12-19',
],
'TrademarkId' => [
'title' => '商标材料id',
'description' => '商标材料id',
'type' => 'integer',
'format' => 'int64',
'example' => '10000*******',
],
'TrademarkApplicantName' => [
'title' => '申请人名称',
'description' => '申请人名称',
'type' => 'string',
'example' => '阿里云',
],
],
],
'example' => '',
],
'Code' => [
'title' => '',
'description' => '请求状态码。'."\n"
."\n"
.'* 返回OK代表请求成功。'."\n"
.'* 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '',
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"569E9DBD-23FF-1785-99AD-E4B23608C104\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"TrademarkPicUrl\\": \\"https://alicom-fc-media.oss-cn-zhangjiakou.aliyuncs.com/100000****50802/afde****-496d-46e4-899d-b43758****8_mhk9oz0p_176224****542.png?Expires=1762****6&OSSAccessKeyId=bypFN****73PsLI&Signature=BygI9X****h7%2FXmFIo****FB2c%3D\\",\\n \\"TrademarkRegistrationNumber\\": \\"1234\\",\\n \\"TrademarkName\\": \\"示例商标\\",\\n \\"TrademarkPic\\": \\"100000*****802/afdebd46-****-46e4-899d-b4375826c898_mhk9oz0p_1762****31542.png\\",\\n \\"TrademarkEffExpDate\\": \\"2025-11-01~2025-12-19\\",\\n \\"TrademarkId\\": 0,\\n \\"TrademarkApplicantName\\": \\"阿里云\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '查询商标实体',
'description' => '传入商标id列表,返回商标详情。'."\n"
."\n"
.'如查签名接口(QuerySmsSignList/GetSmsSign)会查出商标id,然后使用此接口进一步查询详情。',
],
'CreateSmsAppIcpRecord' => [
'summary' => '创建APP-ICP备案实体。使用场景是签名来源=APP时,需要上传ICP备案信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '289841',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'AppIcpRecordPic',
'in' => 'query',
'schema' => [
'title' => 'app-icp备案详情截图osskey',
'description' => 'APP-ICP备案详情截图fileKey。'."\n"
."\n"
.'1. ICP备案查询方法:'."\n"
.'前往 [工信部服务平台](https://beian.miit.gov.cn/#/Integrated/recordQuery) 查询ICP备案 ,并进入详情页。'."\n"
."\n"
.'2. 上传到OSS的ICP 备案文件信息。文件上传要求:'."\n"
."\n"
.'- 待上传的文件命名不可包含中文和特殊字符。'."\n"
.'- 仅支持jpg、png、gif、jpeg格式的图片,图片不大于5MB。'."\n"
.'- 截图中包含完整的网址。'."\n"
.'- 搜索备案类型选择“APP”。'."\n"
.'- “主办单位名称”需和签名关联资质的企事业单位名称完全一致。'."\n"
.'- 有完整清晰的ICP备案/许可证号。'."\n"
.'- “服务名称”需和“签名名称”完全一致。'."\n"
."\n"
.'3. fileKey的获取方式如下:[通过OSS上传文件](~~2833114~~)。',
'type' => 'string',
'required' => true,
'example' => ' '."\n"
.'123456/test1719383196031.jpg'."\n",
],
],
[
'name' => 'AppServiceName',
'in' => 'query',
'schema' => [
'title' => 'app服务名称',
'description' => 'ICP备案:服务名称,长度在15个字符内',
'type' => 'string',
'required' => true,
'example' => '阿里云',
],
],
[
'name' => 'AppPrincipalUnitName',
'in' => 'query',
'schema' => [
'title' => '主办单位名称',
'description' => 'ICP备案:主办单位名称,长度在50个字符内',
'type' => 'string',
'required' => true,
'example' => '阿里云计算有限公司',
],
],
[
'name' => 'AppIcpLicenseNumber',
'in' => 'query',
'schema' => [
'title' => 'ICP备案/许可证号',
'description' => 'ICP备案/许可证号,长度在15个字符内',
'type' => 'string',
'required' => true,
'example' => '浙B2-20080101',
],
],
[
'name' => 'AppApprovalDate',
'in' => 'query',
'schema' => [
'title' => '审核通过日期,示例2025-09-01',
'description' => 'ICP备案审核通过日期',
'type' => 'string',
'required' => true,
'example' => '2025-05-22',
],
],
[
'name' => 'Domain',
'in' => 'query',
'schema' => [
'title' => 'APP应用商店链接',
'description' => 'APP应用商店链接。'."\n"
."\n"
.'> '."\n"
.'> - 必须以http://或https://开头。',
'type' => 'string',
'required' => true,
'example' => 'https://apps.apple.com/cn/app/阿里云/id981011420',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息。',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'title' => '',
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'."\n",
],
'Message' => [
'title' => '',
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Data' => [
'title' => '',
'description' => 'APP-ICP备案实体ID。',
'type' => 'string',
'example' => '10000*******',
],
'Code' => [
'title' => '',
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '',
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**'."\n"
."\n"
.'- **false**',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AppIcpRecordOssFileNotUploadError',
'errorMessage' => 'The APP-ICP record screenshot file is not uploaded.',
],
[
'errorCode' => 'AppIcpRecordDateNotMatchRegex',
'errorMessage' => 'The format of the APP-ICP record approval date is incorrect.',
],
[
'errorCode' => 'AppPrincipalUnitNameNotMatchRegex',
'errorMessage' => 'The principal unit name of the APP cannot be empty.',
],
[
'errorCode' => 'AppPrincipalUnitNameOverLimit',
'errorMessage' => 'The principal unit name of the APP exceeds the length limit.',
],
[
'errorCode' => 'AppIcpLicenseNumberNotMatchRegex',
'errorMessage' => 'The ICP record/license number cannot be empty.',
],
[
'errorCode' => 'AppIcpLicenseNumberOverLimit',
'errorMessage' => 'The ICP record/license number exceeds the length limit.',
],
[
'errorCode' => 'AppDomainNotMatchRegex',
'errorMessage' => 'The APP app store link cannot be empty and must start with http:// or https://.',
],
[
'errorCode' => 'AppDomainOverLimit',
'errorMessage' => 'The APP app store link exceeds the length limit.',
],
[
'errorCode' => 'AppApprovalDateNotValid',
'errorMessage' => 'The validity period of the APP-ICP record is not within the valid range.',
],
[
'errorCode' => 'AppIcpRecordPicsFileError',
'errorMessage' => 'The format of the APP-ICP record screenshot file is incorrect.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"10000*******\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '创建ICP备案实体',
'description' => '签名来源选择已上线APP,则需要上传ICP备案截图。',
],
'QuerySmsAppIcpRecord' => [
'summary' => '查询ICP备案详情信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '289840',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'AppIcpRecordIdList',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => 'app-icp备案实体id列表',
'description' => 'ICP备案实体id列表',
'type' => 'array',
'items' => [
'description' => 'ICP备案实体id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '100000***',
],
'required' => true,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息。',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'title' => '',
'description' => '请求ID。',
'type' => 'string',
'example' => 'C9955E63-8BFF-101D-80A1-E6998DFEFF1A',
],
'Message' => [
'title' => '',
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Data' => [
'title' => '',
'description' => 'APP-ICP备案实体详情列表。',
'type' => 'array',
'items' => [
'description' => 'APP-ICP备案实体详情。',
'type' => 'object',
'properties' => [
'AppIcpRecordId' => [
'title' => 'app-icp备案材料id',
'description' => 'APP-ICP备案材料id',
'type' => 'integer',
'format' => 'int64',
'example' => '51',
],
'AppIcpRecordPic' => [
'title' => 'app-icp备案截图图片Osskey(给签名传工单用)',
'description' => 'APP-ICP备案截图OSS返回的图片fileKey',
'type' => 'string',
'example' => '10000025*****02/ac181696-****-49c6-90dc-50689267aa00_mhsjd8b8_17*****662348.jpeg',
],
'AppIcpRecordPicUrl' => [
'title' => 'app-icp备案截图url地址',
'description' => 'APP-ICP备案截图URL地址',
'type' => 'string',
'example' => 'https://alicom-fc-media.oss-cn-zhangjiakou.aliyuncs.com/100000****50802/afde****-496d-46e4-899d-b43758****8_mhk9oz0p_176224****542.png?Expires=1762****6&OSSAccessKeyId=bypFN****73PsLI&Signature=BygI9X****h7%2FXmFIo****FB2c%3D',
],
'AppPrincipalUnitName' => [
'title' => '主办单位名称',
'description' => '主办单位名称',
'type' => 'string',
'example' => '阿里云',
],
'AppIcpLicenseNumber' => [
'title' => 'ICP备案/许可证号',
'description' => 'ICP备案/许可证号',
'type' => 'string',
'example' => '123',
],
'Domain' => [
'title' => 'APP应用商店链接',
'description' => 'APP应用商店链接',
'type' => 'string',
'example' => 'https://apps.apple.com/cn/app/阿里云/id981011420',
],
'AppApprovalDate' => [
'title' => '审核通过日期,示例2025-09-01',
'description' => '审核通过日期',
'type' => 'string',
'example' => '2020-01-01',
],
'AppServiceName' => [
'title' => 'app服务名称',
'description' => 'APP服务名称',
'type' => 'string',
'example' => '测试',
],
],
],
'example' => '',
],
'Code' => [
'title' => '',
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](https://help.aliyun.com/document_detail/101346.htm)。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '',
'description' => '接口调用是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"C9955E63-8BFF-101D-80A1-E6998DFEFF1A\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"AppIcpRecordId\\": 51,\\n \\"AppIcpRecordPic\\": \\"10000025*****02/ac181696-****-49c6-90dc-50689267aa00_mhsjd8b8_17*****662348.jpeg\\",\\n \\"AppIcpRecordPicUrl\\": \\"https://alicom-fc-media.oss-cn-zhangjiakou.aliyuncs.com/100000****50802/afde****-496d-46e4-899d-b43758****8_mhk9oz0p_176224****542.png?Expires=1762****6&OSSAccessKeyId=bypFN****73PsLI&Signature=BygI9X****h7%2FXmFIo****FB2c%3D\\",\\n \\"AppPrincipalUnitName\\": \\"阿里云\\",\\n \\"AppIcpLicenseNumber\\": \\"123\\",\\n \\"Domain\\": \\"https://apps.apple.com/cn/app/阿里云/id981011420\\",\\n \\"AppApprovalDate\\": \\"2020-01-01\\",\\n \\"AppServiceName\\": \\"测试\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '查询ICP备案实体',
'description' => '传入ICP备案id列表,返回ICP备案详情。'."\n"
."\n"
.'如查签名接口(QuerySmsSignList/GetSmsSign)会查出ICP备案id,然后使用此接口进一步查询详情。',
],
'CreateSmsTemplate' => [
'summary' => '短信模板即接收方收到短信的详细内容,包括变量和模板内容。您可以根据业务需要,申请验证码、通知短信或推广短信,模板审核通过后才可以发送短信。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '218485',
'abilityTreeNodes' => [
'FEATUREdysms2H0K7P',
],
],
'parameters' => [
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => [
'description' => '模板名称,长度不超过30个字符。',
'type' => 'string',
'required' => true,
'example' => '验证码',
'maxLength' => 30,
],
],
[
'name' => 'TemplateContent',
'in' => 'query',
'schema' => [
'description' => '模板内容,长度不超过500个字符。'."\n"
."\n"
.'模板内容和变量内容必须符合[短信模板规范](~~463161~~),否则模板会审核失败。您也可以在[申请模板](https://dysms.console.aliyun.com/domestic/text/template/add)页面,查看常用模板示例。使用示例模板可提高审核效率和成功率。变量规范请参见[TemplateContent参数变量规范](~~2806243~~)。',
'type' => 'string',
'required' => true,
'example' => '您正在申请手机注册,验证码为:${code},5分钟内有效!'."\n",
'maxLength' => 500,
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '请描述您使用短信的业务场景或提供业务场景的线上链接,并提供短信完整示例(填入变量内容),信息完整有助于提高模板审核通过率。如未按规范进行填写或不填写,可能会影响您模板审核的通过。',
'type' => 'string',
'required' => false,
'example' => '申请验证码短信',
'maxLength' => 500,
],
],
[
'name' => 'TemplateType',
'in' => 'query',
'schema' => [
'description' => '短信类型。取值:'."\n"
."\n"
.'- **0**:验证码。'."\n"
.'- **1**:短信通知。'."\n"
.'- **2**:推广短信。'."\n"
.'- **3**:国际/港澳台消息。'."\n"
."\n"
.'> 仅支持企业认证用户申请推广短信和国际/港澳台消息。个人用户与企业用户权益区别详情请参见[使用须知](https://help.aliyun.com/zh/sms/user-guide/usage-notes?spm=a2c4g.11186623.0.0.67447f576NJnE8)。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '0',
'enum' => [
'0',
'1',
'2',
'3',
],
],
],
[
'name' => 'RelatedSignName',
'in' => 'query',
'schema' => [
'description' => '模板需要关联的签名名称。关联的短信签名必须为审核通过的签名。'."\n"
."\n"
.'<notice>'."\n"
."\n"
.'- 当TemplateType参数为**0**、**1**、**2**时,此参数必填。'."\n"
."\n"
.'- 关联签名可以提升审核效率,此处关联的签名和短信发送时选择的签名无关。</notice>',
'type' => 'string',
'required' => false,
'example' => '验证码签名',
],
],
[
'name' => 'TemplateRule',
'in' => 'query',
'schema' => [
'description' => '模板变量规则。变量规则的填写,请参见[示例文档](~~2806243~~)。',
'type' => 'string',
'required' => false,
'example' => '{"code":"characterWithNumber2"}'."\n",
],
],
[
'name' => 'MoreData',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '更多资料,您可以补充上传业务证明文件或业务截图,有助于审核人员了解您的业务详情。如果您申请的短信模板为推广短信(即TemplateType为2),请上传用户授权证明材料,具体说明请参见[用户授权证明材料上传规范](~~312341~~)。',
'type' => 'array',
'items' => [
'description' => '上传到OSS的文件信息。文件上传操作,请参见[OSS上传文件](~~2833114~~)。',
'type' => 'string',
'required' => false,
'example' => '10098689758*****/1234qwe.png',
],
'required' => false,
],
],
[
'name' => 'ApplySceneContent',
'in' => 'query',
'schema' => [
'description' => '业务场景。'."\n"
.' - 模板关联的短信签名使用场景如果为“已上线APP”,`ApplySceneContent`必须为以`http://`开头或`https://`开头的App链接。'."\n"
.' - 模板关联的短信签名使用场景如果为“已注册商标名”、“企事业单位名称”,`ApplySceneContent`必填。',
'type' => 'string',
'required' => false,
'example' => 'http://www.aliyun.com/'."\n",
],
],
[
'name' => 'IntlType',
'in' => 'query',
'schema' => [
'description' => '国际/港澳台模板类型。当**TemplateType**参数为**3**时,国际/港澳台模板需要设置此参数,取值:'."\n"
.'- **0**:短信通知。'."\n"
.'- **1**:推广短信。'."\n"
.'- **2**:验证码。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'TrafficDriving',
'in' => 'query',
'schema' => [
'description' => '><warning>'."\n"
.'为管控短信内容安全,短信内容中包含“号码、链接”等引流信息,存在被运营商拦截导致发送失败的风险。建议尽可能在短信模板中避免包含相关信息,以降低短信发送失败风险。></warning>'."\n"
."\n"
.'引流信息列表JSON字符串。'."\n"
.'><notice>JSON格式,传入前请转为字符串。></notice>'."\n"
."\n"
.'### 1. 字段说明:'."\n"
."\n"
.'{'."\n"
.' "trafficDrivingType":"引流类型",'."\n"
.' "trafficDrivingContent":"引流内容",'."\n"
.' "variableName":"变量名称",'."\n"
.' "companyName":企事业单位名称,'."\n"
.' "organizationCode":统一社会信用代码,'."\n"
.' "icpNo":ICP备案/许可证号,'."\n"
.' "icpPicOssKey":ICP备案截图OssKey,'."\n"
.' "companyDifferentFromSignQuaReason":企事业单位名称与签名资质不同原因'."\n"
.'}'."\n"
."\n"
.'### 2. 注意事项:'."\n"
."\n"
.'- 如果非变量则variableName不传。'."\n"
."\n"
.'- 企事业单位名称与签名关联资质的企事业单位名称不同,则传入companyDifferentFromSignQuaReason。'."\n"
."\n"
.'- 如果trfficDrivingType=DOMAIN,则传入所有参数。'."\n"
."\n"
.'- 如果trafficDrivingType为其他,则传入trafficDrivingType、trafficDrivingContent、variableName(按需)、companyName、organizationCode、companyDifferentFromSignQuaReason(按需)'."\n"
."\n"
.'### 3. trafficDrivingType引流类型枚举值:'."\n"
.'><warning>因监管要求,不支持手机号码。></warning>'."\n"
.'- DOMAIN:域名类型链接。'."\n"
.'- FIXED_PHONE:固定电话。'."\n"
.'- 400_PHONE:400开头电话。'."\n"
.'- 800_PHONE:800开头电话。'."\n"
.'- 95_PHONE:95开头电话。'."\n"
.'- 96_PHONE:96开头电话。'."\n"
.'- 1_PHONE:1开头,3~5位电话。'."\n"
.'- OTHER_PHONE:其他号码。',
'type' => 'string',
'required' => false,
'example' => '[{"trafficDrivingType":"DOMAIN","trafficDrivingContent":"aliyun.com","companyName":"阿里云计算有限公司","organizationCode":"91330****73959654P","icpNo":"浙B2-20****01-4","icpPicOssKey":"db7784d8-cb0c-498f-****-295f1ad6d665_mf29l7nf.png", "companyDifferentFromSignQuaReason":"这是一段说明文字"},{"trafficDrivingType":"1_PHONE","trafficDrivingContent":"1**86","variableName":"my1Phone","companyName":"阿里云计算有限公司","organizationCode":"91330****73959654P","companyDifferentFromSignQuaReason":"这是一段说明文字"}]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '本次调用请求的ID。是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE991',
],
'Code' => [
'description' => '请求状态码。取值:'."\n"
."\n"
.'* OK:代表请求成功。'."\n"
.'* 其他错误码,请参见本章节的**错误码**列表或产品[API错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'successful',
],
'TemplateName' => [
'description' => '短信模板名称。',
'type' => 'string',
'example' => '验证码模板',
],
'TemplateCode' => [
'description' => '短信模板Code。'."\n"
."\n"
.'提交模板申请后,您可以使用短信模板Code,通过[GetSmsTemplate](~~2807433~~)接口查询模板审核详情。也可以[配置回执消息](~~101508~~),通过[TemplateSmsReport](~~120999~~)获取模板的审核状态消息。',
'type' => 'string',
'example' => 'SMS_10000****',
],
'OrderId' => [
'description' => '工单号。'."\n"
."\n"
.'审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。',
'type' => 'string',
'example' => '2005020****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
[
'errorCode' => 'AssocSignUnapproved',
'errorMessage' => 'Associated signature must be approved.',
],
[
'errorCode' => 'InvalidTemplateRule.Format',
'errorMessage' => 'The parameter TemplateRule format must be JSON.',
],
[
'errorCode' => 'InvalidMoreData',
'errorMessage' => 'Specified parameter MoreData is not valid.',
],
[
'errorCode' => 'TemplateVarLimitExceeded',
'errorMessage' => 'The verification code template only supports one variable.',
],
[
'errorCode' => 'InvalidTemplateContent.Format',
'errorMessage' => 'Invalid template content format.',
],
[
'errorCode' => 'InvalidTemplateRule',
'errorMessage' => 'The template variable format is non-standard. Please refer to the variable format specifications in the help documentation.',
],
[
'errorCode' => 'ServiceNotOpened',
'errorMessage' => 'This product service is not opened.',
],
],
404 => [
[
'errorCode' => 'MissingTemplateName',
'errorMessage' => 'The template name cannot be empty.',
],
[
'errorCode' => 'SmsSignatureNotFound',
'errorMessage' => 'The associated SMS signature does not exist.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE991\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"TemplateName\\": \\"验证码模板\\",\\n \\"TemplateCode\\": \\"SMS_10000****\\",\\n \\"OrderId\\": \\"2005020****\\"\\n}","type":"json"}]',
'title' => '申请短信模板(新接口)',
'description' => '- 新接口和原接口变更的公告详情请参见[关于短信服务更新签名&模板接口的公告](~~2806975~~)。'."\n"
."\n"
.'- 通过接口申请短信模板,建议每次申请至少间隔30秒。'."\n"
."\n"
.'- 通过接口申请的模板信息会同步在短信服务控制台,在控制台对模板的相关操作,请参见[短信模板](~~108085~~)。'."\n"
."\n"
.'- 提交模板申请后,您可以通过[GetSmsTemplate](~~2807433~~)接口查询模板审核状态和详情。也可以[配置回执消息](~~101508~~),通过[TemplateSmsReport](~~120999~~)获取模板的审核状态消息。'."\n"
."\n"
.'- 国内短信模板与国际/港澳台短信模板不通用(不能混用),请根据业务使用场景申请模板。'."\n"
."\n"
.'- 仅支持企业认证用户申请推广短信和国际/港澳台消息,个人用户与企业用户权益区别详情请参见[使用须知](~~55324~~)。',
],
'GetSmsTemplate' => [
'summary' => '申请模板后,通过此接口查询模板审核详情,可查看模板审核状态。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '217890',
'abilityTreeNodes' => [
'FEATUREdysms2H0K7P',
],
],
'parameters' => [
[
'name' => 'TemplateCode',
'in' => 'query',
'schema' => [
'description' => '短信模板Code。'."\n"
."\n"
.'- 在[CreateSmsTemplate](~~2807431~~)接口的返回参数中获取短信模板Code。'."\n"
.'- 在[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面查看短信模板Code。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'SMS_20375****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
],
'Code' => [
'description' => '请求状态码。取值:'."\n"
."\n"
.'* OK:代表请求成功。'."\n"
.'* 其他错误码,请参见[API错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'TemplateName' => [
'description' => '短信模板名称。',
'type' => 'string',
'example' => '验证码',
],
'TemplateCode' => [
'description' => '短信模板Code。',
'type' => 'string',
'example' => 'SMS_20375****',
],
'TemplateContent' => [
'description' => '短信模板内容。',
'type' => 'string',
'example' => '您正在申请手机注册,验证码为:${code},5分钟内有效!',
],
'TemplateType' => [
'description' => '短信类型。取值:'."\n"
."\n"
.'- **0**:验证码。'."\n"
.'- **1**:短信通知。'."\n"
.'- **2**:推广短信。'."\n"
.'- **3**:国际/港澳台消息。'."\n"
."\n"
.'> 仅支持企业认证用户申请推广短信和国际/港澳台消息。个人用户与企业用户权益区别详情请参见[使用须知](https://help.aliyun.com/zh/sms/user-guide/usage-notes?spm=a2c4g.11186623.0.0.67447f576NJnE8)。',
'type' => 'string',
'example' => '0',
],
'TemplateStatus' => [
'description' => '模板审核状态。返回值:'."\n"
."\n"
.'- **0**:审核中。'."\n"
.'- **1**:通过审核。'."\n"
.'- **2**:未通过审核,会返回审核失败的原因,请参考[短信审核失败的处理建议](https://help.aliyun.com/zh/sms/user-guide/causes-of-application-failures-and-suggestions?spm=a2c4g.11186623.0.0.41fd339f3bPSCQ),调用[UpdateSmsTemplate](https://help.aliyun.com/zh/sms/developer-reference/api-dysmsapi-2017-05-25-updatesmstemplate?spm)接口或在[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面修改短信模板。'."\n"
.'- **10**:取消审核。',
'type' => 'string',
'example' => '2',
],
'RelatedSignName' => [
'description' => '申请模板时,关联的短信签名。',
'type' => 'string',
'example' => '阿里云',
],
'TemplateTag' => [
'description' => '模板标识。取值:'."\n"
."\n"
.'- 2:用户自定义创建模板。'."\n"
."\n"
.'- 3:系统赠送模板。'."\n"
."\n"
.'- 4:测试模板。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'OrderId' => [
'description' => '工单号。'."\n"
."\n"
.'审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。',
'type' => 'string',
'example' => '2003019****',
],
'VariableAttribute' => [
'description' => '模板变量规则。'."\n"
."\n"
.'模板变量规则详情,请参见[示例文档](https://help.aliyun.com/zh/sms/templaterule-template-variable-parameter-filling-example)。',
'type' => 'string',
'example' => '{"code":"characterWithNumber"}'."\n",
],
'Remark' => [
'description' => '短信模板申请说明,是模板审核的参考信息之一。',
'type' => 'string',
'example' => '申请验证码模板',
],
'CreateDate' => [
'description' => '创建短信模板的时间。',
'type' => 'string',
'example' => '2024-06-03 10:02:34',
],
'AuditInfo' => [
'description' => '审核信息。',
'type' => 'object',
'properties' => [
'RejectInfo' => [
'description' => '审核未通过的原因。',
'type' => 'string',
'example' => '模板内容中包含错别字。',
],
'AuditDate' => [
'description' => '审核时间。',
'type' => 'string',
'example' => '2024-06-03 11:20:34'."\n",
],
],
],
'FileUrlList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FileUrl' => [
'description' => '文件资料信息。兼容旧接口创建的信息。',
'type' => 'array',
'items' => [
'description' => '文件信息。',
'type' => 'string',
'example' => '//alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/1800975045205261/data.jpg?Expires=1718202335&OSSAccessKeyId=bypFNb*****73PsLI&Signature=3dBy9k%2B0%2B8DnCsvzsHi68GHzRg0%3D',
],
],
],
],
'MoreDataFileUrlList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MoreDataFileUrl' => [
'description' => '更多资料信息,补充上传业务证明文件或业务截图文件列表。',
'type' => 'array',
'items' => [
'description' => 'OSS上的文件信息。',
'type' => 'string',
'example' => '//alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/1800975045205261/test.jpg?Expires=1718202335&OSSAccessKeyId=bypFNb*****73PsLI&Signature=3dBy9k%2B0%2B8DnCsvzsHi68GHzRg0%3D',
],
],
],
],
'IntlType' => [
'description' => '国际/港澳台模板类型。当**TemplateType**参数返回值为**3**时,此参数取值:'."\n"
.'- **0**:短信通知。'."\n"
.'- **1**:推广短信。'."\n"
.'- **2**:验证码。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'ApplyScene' => [
'description' => '应用场景内容。',
'type' => 'string',
'example' => 'http://www.aliyun.com/'."\n",
],
'VendorAuditStatus' => [
'title' => ' 各运营商审核状态 key: MOBILE_VENDOR, TELECOM_VENDOR, UNICOM_VENDOR value: 运营商审核状态 0: 审核中 1:通过 2:不通过 15: 已失效'."\n"
.' ',
'description' => '各运营商审核状态,仅数字短信会返回该参数。'."\n"
."\n\n"
.'key代表运营商。取值:'."\n"
."\n"
.'- MOBILE_VENDOR:中国移动。'."\n"
."\n"
.'- TELECOM_VENDOR:中国电信。'."\n"
."\n"
.'- UNICOM_VENDOR:中国联通。'."\n"
."\n"
.' value代表审核状态。取值: '."\n"
."\n"
.'- 0:审核中。'."\n"
."\n"
.'- 1:通过。'."\n"
."\n"
.' - 2:不通过。'."\n"
."\n"
.' - 15:已失效。',
'type' => 'object',
'example' => '{'."\n"
.' "MOBILE_VENDOR": 0,'."\n"
.' "TELCOM_VENDOR": 0,'."\n"
.' "UNICOM_VENDOR": 0'."\n"
.' }',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
],
404 => [
[
'errorCode' => 'TemplateNotFound',
'errorMessage' => 'The template does not exist.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"TemplateName\\": \\"验证码\\",\\n \\"TemplateCode\\": \\"SMS_20375****\\",\\n \\"TemplateContent\\": \\"您正在申请手机注册,验证码为:${code},5分钟内有效!\\",\\n \\"TemplateType\\": \\"0\\",\\n \\"TemplateStatus\\": \\"2\\",\\n \\"RelatedSignName\\": \\"阿里云\\",\\n \\"TemplateTag\\": 2,\\n \\"OrderId\\": \\"2003019****\\",\\n \\"VariableAttribute\\": \\"{\\\\\\"code\\\\\\":\\\\\\"characterWithNumber\\\\\\"}\\\\n\\",\\n \\"Remark\\": \\"申请验证码模板\\",\\n \\"CreateDate\\": \\"2024-06-03 10:02:34\\",\\n \\"AuditInfo\\": {\\n \\"RejectInfo\\": \\"模板内容中包含错别字。\\",\\n \\"AuditDate\\": \\"2024-06-03 11:20:34\\\\n\\"\\n },\\n \\"FileUrlList\\": {\\n \\"FileUrl\\": [\\n \\"//alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/1800975045205261/data.jpg?Expires=1718202335&OSSAccessKeyId=bypFNb*****73PsLI&Signature=3dBy9k%2B0%2B8DnCsvzsHi68GHzRg0%3D\\"\\n ]\\n },\\n \\"MoreDataFileUrlList\\": {\\n \\"MoreDataFileUrl\\": [\\n \\"//alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/1800975045205261/test.jpg?Expires=1718202335&OSSAccessKeyId=bypFNb*****73PsLI&Signature=3dBy9k%2B0%2B8DnCsvzsHi68GHzRg0%3D\\"\\n ]\\n },\\n \\"IntlType\\": 0,\\n \\"ApplyScene\\": \\"http://www.aliyun.com/\\\\n\\",\\n \\"VendorAuditStatus\\": {\\n \\"MOBILE_VENDOR\\": 0,\\n \\"TELCOM_VENDOR\\": 0,\\n \\"UNICOM_VENDOR\\": 0\\n }\\n}","type":"json"}]',
'title' => '查询模板审核详情(新接口)',
'description' => '- 新接口和原接口变更的公告详情请参见[关于短信服务更新签名&模板接口的公告](~~2806975~~)。'."\n"
.'- 审核时间:一般情况下,模板提交后,阿里云预计在2个小时内审核完成(审核工作时间:周一至周日9:00~21:00,法定节假日顺延)。'."\n"
."\n"
.'- 如果模板未通过审核,会返回审核失败的原因,请参考[短信审核失败的处理建议](~~65990~~),调用[UpdateSmsTemplate](~~UpdateSmsTemplate~~)接口或在[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面修改短信模板。'."\n"
."\n"
.'- 当前接口是通过模板Code查询单个模板的审核详情。[QuerySmsTemplateList](~~419288~~)接口可以查询您当前账号下所有模板的模板详情。',
],
'QuerySmsTemplateList' => [
'summary' => '可以通过此接口查询您账号下的所有模板,方便您查看模板详情,包括模板审核状态、模板类型、模板内容等。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '118761',
'abilityTreeNodes' => [
'FEATUREdysms2H0K7P',
],
],
'parameters' => [
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => [
'description' => '当前页码。默认取值为**1**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示的模板个数。取值范围:**1~50**,默认取值为**10**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => '819BE656-D2E0-4858-8B21-B2E47708****',
],
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'SmsTemplateList' => [
'description' => '结果列表。',
'type' => 'array',
'items' => [
'description' => '单个模板详情。',
'type' => 'object',
'properties' => [
'TemplateCode' => [
'description' => '短信模板Code。',
'type' => 'string',
'example' => 'SMS_1525***',
],
'TemplateName' => [
'description' => '短信模板名称。',
'type' => 'string',
'example' => '验证码模板',
],
'OuterTemplateType' => [
'description' => '模板类型(对外使用)。返回值:'."\n"
."\n"
.'- **0**:验证码短信。'."\n"
.'- **1**:通知短信。'."\n"
.'- **2**:推广短信。'."\n"
.'- **3**:国际/港澳台短信。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'AuditStatus' => [
'description' => '模板审核状态。返回值:'."\n"
."\n"
.'- **AUDIT_STATE_INIT**:审核中。'."\n"
.'- **AUDIT_STATE_PASS**:通过审核。'."\n"
.'- **AUDIT_STATE_NOT_PASS**:未通过审核,请在返回参数Reason中查看审核未通过原因。'."\n"
.'- **AUDIT_SATE_CANCEL**:取消审核。',
'type' => 'string',
'example' => 'AUDIT_STATE_PASS',
],
'TemplateContent' => [
'description' => '模板内容。',
'type' => 'string',
'example' => '验证码为:${code},您正在注册成为平台会员,感谢您的支持!',
],
'CreateDate' => [
'description' => '创建模板的时间,格式为yyyy-MM-dd HH:mm:ss。',
'type' => 'string',
'example' => '2020-06-04 11:42:17',
],
'Reason' => [
'description' => '审核返回值。',
'type' => 'object',
'properties' => [
'RejectDate' => [
'description' => '审核未通过的时间,格式为yyyy-MM-dd HH:mm:ss。',
'type' => 'string',
'example' => '2020-06-04 16:01:17',
],
'RejectInfo' => [
'description' => '审核未通过的原因。',
'type' => 'string',
'example' => '变量不符合规范',
],
'RejectSubInfo' => [
'description' => '审核未通过的详细说明。',
'type' => 'string',
'example' => '变量属性选择错误。'."\n"
.'请根据业务使用场景选择合适的变量属性。',
],
],
],
'OrderId' => [
'description' => '工单号。'."\n"
."\n"
.'审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。',
'type' => 'string',
'example' => '2004983****',
],
'TemplateType' => [
'description' => '模板类型。返回值:'."\n"
."\n"
.'- **0**:短信通知。'."\n"
.'- **1**:推广短信。'."\n"
.'- **2**:验证码短信。'."\n"
.'- **6**:国际/港澳台短信。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'SignatureName' => [
'description' => '关联签名名称。',
'type' => 'string',
'example' => '阿里云',
],
'TrafficDriving' => [
'description' => '引流信息列表JSON字符串。'."\n"
.'><notice>JSON格式,传入前请转为字符串。></notice>'."\n"
."\n"
.'### 1. 字段说明:'."\n"
."\n"
.'{'."\n"
.' "trafficDrivingType":"引流类型",'."\n"
.' "trafficDrivingContent":"引流内容",'."\n"
.' "variableName":"变量名称",'."\n"
.' "companyName":企事业单位名称,'."\n"
.' "organizationCode":统一社会信用代码,'."\n"
.' "icpNo":ICP备案/许可证号,'."\n"
.' "icpPicOssKey":ICP备案截图OssKey,'."\n"
.' "companyDifferentFromSignQuaReason":企事业单位名称与签名资质不同原因'."\n"
.'}'."\n"
."\n"
.'### 2. 注意事项:'."\n"
."\n"
.'- 如果非变量则variableName不传。'."\n"
."\n"
.'- 企事业单位名称与签名关联资质的企事业单位名称不同,则传入companyDifferentFromSignQuaReason。'."\n"
."\n"
.'- 如果trfficDrivingType=DOMAIN,则传入所有参数。'."\n"
."\n"
.'- 如果trafficDrivingType为其他,则传入trafficDrivingType、trafficDrivingContent、variableName(按需)、companyName、organizationCode、companyDifferentFromSignQuaReason(按需)'."\n"
."\n"
.'### 3. trafficDrivingType引流类型枚举值:'."\n"
."\n"
.'- DOMAIN:域名类型链接。'."\n"
.'- FIXED_PHONE:固定电话。'."\n"
.'- 400_PHONE:400开头电话。'."\n"
.'- 800_PHONE:800开头电话。'."\n"
.'- 95_PHONE:95开头电话。'."\n"
.'- 96_PHONE:96开头电话。'."\n"
.'- 1_PHONE:1开头,3~5位电话。'."\n"
.'- OTHER_PHONE:其他号码。',
'type' => 'string',
'example' => '[{"trafficDrivingType":"DOMAIN","trafficDrivingContent":"aliyun.com","companyName":"阿里云计算有限公司","organizationCode":"91330****73959654P","icpNo":"浙B2-20****01-4","icpPicOssKey":"db7784d8-cb0c-498f-****-295f1ad6d665_mf29l7nf.png","companyDifferentFromSignQuaReason":"这是一段说明文字"},{"trafficDrivingType":"1_PHONE","trafficDrivingContent":"1**86","variableName":"my1Phone","companyName":"阿里云计算有限公司","organizationCode":"91330****73959654P","companyDifferentFromSignQuaReason":"这是一段说明文字"}]',
],
],
],
],
'TotalCount' => [
'description' => '本次查询到的模板总数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'CurrentPage' => [
'description' => '当前页码。默认取值为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '每页显示的模板个数。取值范围:**1~50**。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E47708****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"SmsTemplateList\\": [\\n {\\n \\"TemplateCode\\": \\"SMS_1525***\\",\\n \\"TemplateName\\": \\"验证码模板\\",\\n \\"OuterTemplateType\\": 0,\\n \\"AuditStatus\\": \\"AUDIT_STATE_PASS\\",\\n \\"TemplateContent\\": \\"验证码为:${code},您正在注册成为平台会员,感谢您的支持!\\",\\n \\"CreateDate\\": \\"2020-06-04 11:42:17\\",\\n \\"Reason\\": {\\n \\"RejectDate\\": \\"2020-06-04 16:01:17\\",\\n \\"RejectInfo\\": \\"变量不符合规范\\",\\n \\"RejectSubInfo\\": \\"变量属性选择错误。\\\\n请根据业务使用场景选择合适的变量属性。\\"\\n },\\n \\"OrderId\\": \\"2004983****\\",\\n \\"TemplateType\\": 2,\\n \\"SignatureName\\": \\"阿里云\\",\\n \\"TrafficDriving\\": \\"[{\\\\\\"trafficDrivingType\\\\\\":\\\\\\"DOMAIN\\\\\\",\\\\\\"trafficDrivingContent\\\\\\":\\\\\\"aliyun.com\\\\\\",\\\\\\"companyName\\\\\\":\\\\\\"阿里云计算有限公司\\\\\\",\\\\\\"organizationCode\\\\\\":\\\\\\"91330****73959654P\\\\\\",\\\\\\"icpNo\\\\\\":\\\\\\"浙B2-20****01-4\\\\\\",\\\\\\"icpPicOssKey\\\\\\":\\\\\\"db7784d8-cb0c-498f-****-295f1ad6d665_mf29l7nf.png\\\\\\",\\\\\\"companyDifferentFromSignQuaReason\\\\\\":\\\\\\"这是一段说明文字\\\\\\"},{\\\\\\"trafficDrivingType\\\\\\":\\\\\\"1_PHONE\\\\\\",\\\\\\"trafficDrivingContent\\\\\\":\\\\\\"1**86\\\\\\",\\\\\\"variableName\\\\\\":\\\\\\"my1Phone\\\\\\",\\\\\\"companyName\\\\\\":\\\\\\"阿里云计算有限公司\\\\\\",\\\\\\"organizationCode\\\\\\":\\\\\\"91330****73959654P\\\\\\",\\\\\\"companyDifferentFromSignQuaReason\\\\\\":\\\\\\"这是一段说明文字\\\\\\"}]\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10\\n}","errorExample":""},{"type":"xml","example":"<QuerySmsTemplateListResponse>\\n <RequestId>819BE656-D2E0-4858-8B21-B2E47708****</RequestId>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <SmsTemplateList>\\n <TemplateCode>SMS_1525***</TemplateCode>\\n <TemplateName>阿里云短信测试模板</TemplateName>\\n <TemplateType>7</TemplateType>\\n <AuditStatus>AUDIT_STATE_PASS</AuditStatus>\\n <TemplateContent>123456789</TemplateContent>\\n <CreateDate>2020-06-04 11:42:17</CreateDate>\\n <Reason>\\n <RejectDate>2020-06-04 16:01:17</RejectDate>\\n <RejectInfo>无审批备注</RejectInfo>\\n <RejectSubInfo>无审批备注</RejectSubInfo>\\n </Reason>\\n <OrderId>2361****</OrderId>\\n </SmsTemplateList>\\n</QuerySmsTemplateListResponse>","errorExample":""}]',
'title' => '查询模板列表详情',
'description' => '- 本接口用于查询您当前账号下所有模板的模板详情。如果您需要查询模板变量内容、申请时上传的文件资料信息等更多内容,可以调用[GetSmsTemplate](~~GetSmsTemplate~~)接口通过模板Code查询单个模板审核详情。'."\n"
.'- 您也可登录短信服务控制台[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页查看您当前账号下所有模板的模板详情。',
],
'UpdateSmsTemplate' => [
'summary' => '修改未通过审核的模板,调用本接口修改后将自动提交审核。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '219284',
'abilityTreeNodes' => [
'FEATUREdysms2H0K7P',
],
],
'parameters' => [
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => [
'description' => '模板名称,长度不超过30个字符。您可在控制台[国内消息>模板管理](https://dysms.console.aliyun.com/domestic/text/template)页签查看未通过审核的模板名称。也可通过[QuerySmsTemplateList](~~QuerySmsTemplateList~~)接口查看未通过审核的短信模板名称。',
'type' => 'string',
'required' => true,
'example' => '验证码模板',
'maxLength' => 30,
],
],
[
'name' => 'TemplateCode',
'in' => 'query',
'schema' => [
'description' => '未通过审核的模板Code。您可在控制台[国内消息>模板管理](https://dysms.console.aliyun.com/domestic/text/template)页签查看未通过审核的模板Code。也可通过[QuerySmsTemplateList](~~QuerySmsTemplateList~~)接口查看未通过审核的模板Code。',
'type' => 'string',
'required' => true,
'example' => 'SMS_152550****',
],
],
[
'name' => 'TemplateContent',
'in' => 'query',
'schema' => [
'description' => '模板内容,长度不超过500个字符。'."\n"
."\n"
.'模板内容和变量内容必须符合[短信模板规范](~~463161~~),否则模板会审核失败。您也可以在[申请模板](https://dysms.console.aliyun.com/domestic/text/template/add)页面,查看常用模板示例。使用示例模板可提高审核效率和成功率。变量规范请参见[TemplateContent参数变量规范](~~2806243~~)。',
'type' => 'string',
'required' => true,
'example' => '您正在申请手机注册,验证码为:${code},5分钟内有效!',
'maxLength' => 500,
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '请描述您使用短信的业务场景或提供业务场景的线上链接,并提供短信完整示例(填入变量内容),信息完整有助于提高模板审核通过率。如未按规范进行填写或不填写,可能会影响您模板审核的通过。',
'type' => 'string',
'required' => false,
'example' => '登录场景使用验证码',
'maxLength' => 500,
],
],
[
'name' => 'TemplateType',
'in' => 'query',
'schema' => [
'description' => '短信类型。取值:'."\n"
."\n"
.'- **0**:验证码。'."\n"
.'- **1**:短信通知。'."\n"
.'- **2**:推广短信。'."\n"
.'- **3**:国际/港澳台消息。'."\n"
."\n"
.'> 仅支持企业认证用户申请推广短信和国际/港澳台消息。个人用户与企业用户权益区别详情请参见[使用须知](https://help.aliyun.com/zh/sms/user-guide/usage-notes?spm=a2c4g.11186623.0.0.67447f576NJnE8)。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '0',
'enum' => [
'0',
'1',
'2',
'3',
],
],
],
[
'name' => 'RelatedSignName',
'in' => 'query',
'schema' => [
'description' => '模板申请时关联的短信签名。',
'type' => 'string',
'required' => false,
'example' => '阿里云',
],
],
[
'name' => 'TemplateRule',
'in' => 'query',
'schema' => [
'description' => '模板变量规则。变量规则填写请参见[示例文档](~~2806243~~)。',
'type' => 'string',
'required' => false,
'example' => '{"code":"characterWithNumber"}',
],
],
[
'name' => 'MoreData',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '更多资料,您可以补充上传业务证明文件或业务截图,有助于审核人员了解您的业务详情。如果您申请的短信模板为推广短信(即TemplateType为2),请上传用户授权证明材料,具体说明请参见[用户授权证明材料上传规范](~~312341~~)。',
'type' => 'array',
'items' => [
'description' => '上传到OSS的文件信息。文件上传操作,请参见[OSS上传文件](~~2833114~~)。',
'type' => 'string',
'required' => false,
'example' => '10098689758****/1234qwe.png',
],
'required' => false,
],
],
[
'name' => 'ApplySceneContent',
'in' => 'query',
'schema' => [
'description' => '业务场景。'."\n"
.' - 模板关联的短信签名使用场景如果为“已上线APP”,`ApplySceneContent`必须为以`http://`开头或`https://`开头的App链接。'."\n"
.' - 模板关联的短信签名使用场景如果为“已注册商标名”、“企事业单位名称”,`ApplySceneContent`必填。',
'type' => 'string',
'required' => false,
'example' => 'http://www.aliyun.com/'."\n",
],
],
[
'name' => 'IntlType',
'in' => 'query',
'schema' => [
'description' => '国际/港澳台模板类型。当**TemplateType**参数为**3**时,国际/港澳台模板需要设置此参数,取值:'."\n"
.'- **0**:短信通知。'."\n"
.'- **1**:推广短信。'."\n"
.'- **2**:验证码。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'TrafficDriving',
'in' => 'query',
'schema' => [
'description' => '><warning>'."\n"
.'为管控短信内容安全,短信内容中包含“号码、链接”等引流信息,存在被运营商拦截导致发送失败的风险。建议尽可能在短信模板中避免包含相关信息,以降低短信发送失败风险。></warning>'."\n"
."\n"
.'引流信息列表JSON字符串。'."\n"
.'><notice>JSON格式,传入前请转为字符串。></notice>'."\n"
."\n"
.'### 1. 字段说明:'."\n"
."\n"
.'{'."\n"
.' "trafficDrivingType":"引流类型",'."\n"
.' "trafficDrivingContent":"引流内容",'."\n"
.' "variableName":"变量名称",'."\n"
.' "companyName":企事业单位名称,'."\n"
.' "organizationCode":统一社会信用代码,'."\n"
.' "icpNo":ICP备案/许可证号,'."\n"
.' "icpPicOssKey":ICP备案截图OssKey,'."\n"
.' "companyDifferentFromSignQuaReason":企事业单位名称与签名资质不同原因'."\n"
.'}'."\n"
."\n"
.'### 2. 注意事项:'."\n"
."\n"
.'- 如果非变量则variableName不传。'."\n"
."\n"
.'- 企事业单位名称与签名关联资质的企事业单位名称不同,则传入companyDifferentFromSignQuaReason。'."\n"
."\n"
.'- 如果trfficDrivingType=DOMAIN,则传入所有参数。'."\n"
."\n"
.'- 如果trafficDrivingType为其他,则传入trafficDrivingType、trafficDrivingContent、variableName(按需)、companyName、organizationCode、companyDifferentFromSignQuaReason(按需)'."\n"
."\n"
.'### 3. trafficDrivingType引流类型枚举值:'."\n"
.'><warning>因监管要求,不支持手机号码。></warning>'."\n"
."\n"
.'- DOMAIN:域名类型链接。'."\n"
.'- FIXED_PHONE:固定电话。'."\n"
.'- 400_PHONE:400开头电话。'."\n"
.'- 800_PHONE:800开头电话。'."\n"
.'- 95_PHONE:95开头电话。'."\n"
.'- 96_PHONE:96开头电话。'."\n"
.'- 1_PHONE:1开头,3~5位电话。'."\n"
.'- OTHER_PHONE:其他号码。',
'type' => 'string',
'required' => false,
'example' => '[{"trafficDrivingType":"DOMAIN","trafficDrivingContent":"aliyun.com","companyName":"阿里云计算有限公司","organizationCode":"91330****73959654P","icpNo":"浙B2-20****01-4","icpPicOssKey":"db7784d8-cb0c-498f-****-295f1ad6d665_mf29l7nf.png","companyDifferentFromSignQuaReason":"这是一段说明文字"},{"trafficDrivingType":"1_PHONE","trafficDrivingContent":"1**86","variableName":"my1Phone","companyName":"阿里云计算有限公司","organizationCode":"91330****73959654P","companyDifferentFromSignQuaReason":"这是一段说明文字"}]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => '819BE656-D2E0-4858-8B21-B2E477085AA0',
],
'Code' => [
'description' => '请求状态码。取值:'."\n"
."\n"
.'* OK:代表请求成功。'."\n"
.'* 其他错误码,请参见本章节的**错误码**列表或产品[API错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'TemplateName' => [
'description' => '短信模板名称。',
'type' => 'string',
'example' => '验证码',
],
'TemplateCode' => [
'description' => '短信模板Code。'."\n"
."\n"
.'提交模板修改后,您可以使用短信模板Code,通过[GetSmsTemplate](~~GetSmsTemplate~~)接口查询模板审核详情。也可以[配置回执消息](https://help.aliyun.com/zh/sms/developer-reference/configure-delivery-receipts-1),通过[TemplateSmsReport](~~120999~~)获取模板的审核状态消息。',
'type' => 'string',
'example' => 'SMS_152550****',
],
'OrderId' => [
'description' => '工单号。'."\n"
."\n"
.'审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。',
'type' => 'string',
'example' => '20041271****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
[
'errorCode' => 'AssocSignUnapproved',
'errorMessage' => 'Associated signature must be approved.',
],
[
'errorCode' => 'InvalidTemplateRule',
'errorMessage' => 'The template variable format is non-standard. Please refer to the variable format specifications in the help documentation.',
],
[
'errorCode' => 'InvalidTemplateRule.Format',
'errorMessage' => 'The parameter TemplateRule format must be JSON.',
],
[
'errorCode' => 'InvalidMoreData',
'errorMessage' => 'Specified parameter MoreData is not valid.',
],
[
'errorCode' => 'TemplateVarLimitExceeded',
'errorMessage' => 'The verification code template only supports one variable.',
],
[
'errorCode' => 'InvalidTemplateContent.Format',
'errorMessage' => 'Invalid template content format.',
],
[
'errorCode' => 'ServiceNotOpened',
'errorMessage' => 'This product service is not opened.',
],
],
404 => [
[
'errorCode' => 'MissingTemplateName',
'errorMessage' => 'The template name cannot be empty.',
],
[
'errorCode' => 'SmsSignatureNotFound',
'errorMessage' => 'The associated SMS signature does not exist.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AA0\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"TemplateName\\": \\"验证码\\",\\n \\"TemplateCode\\": \\"SMS_152550****\\",\\n \\"OrderId\\": \\"20041271****\\"\\n}","type":"json"}]',
'title' => '修改短信模板(新接口)',
'description' => '- 新接口和原接口变更的公告详情请参见[关于短信服务更新签名&模板接口的公告](~~2806975~~)。'."\n"
.'- 仅支持修改未通过审核的模板,请参考[短信审核失败的处理建议](~~65990~~),调用此接口修改后重新提交审核。'."\n"
."\n"
.'- 通过接口修改模板的操作会在短信服务控制台同步,在控制台对模板的相关操作,请参见[短信模板](~~108085~~)。'."\n"
."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为1000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
],
'DeleteSmsTemplate' => [
'summary' => '如果您不再使用某个短信模板,需要删除模板时,调用此接口或在短信服务控制台删除短信模板。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102445',
'abilityTreeNodes' => [
'FEATUREdysms2H0K7P',
],
],
'parameters' => [
[
'name' => 'TemplateCode',
'in' => 'query',
'schema' => [
'description' => '短信模板Code。支持删除已撤回、审核失败或审核通过的模板,审核中的短信模板不支持删除。'."\n"
."\n"
.'- 您可通过[QuerySmsTemplateList](~~419288~~)接口获取短信模板Code。'."\n"
."\n"
.'- 或在短信控制台[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面获取短信模板Code。'."\n"
.'><notice>删除短信模板后不可恢复,且后续不可再使用该模板发送短信,请谨慎操作。></notice>',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'SMS_152550****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[API错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CCA2BCFF-2BA7-427C-90EE-AC6994748607',
],
'TemplateCode' => [
'description' => '已删除的模板Code。',
'type' => 'string',
'example' => 'SMS_152550****',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"CCA2BCFF-2BA7-427C-90EE-AC6994748607\\",\\n \\"TemplateCode\\": \\"SMS_152550****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<DeleteSmsTemplateResponse>\\r\\n\\t<TemplateCode>SMS_20375****</TemplateCode>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>CCA2BCFF-2BA7-427C-90EE-AC6994748607</RequestId>\\r\\n\\t<Code>OK</Code>\\r\\n</DeleteSmsTemplateResponse>","errorExample":""}]',
'title' => '删除短信模板',
'description' => '- 支持删除已撤回、审核失败或审核通过的模板,审核中的短信模板不支持删除。'."\n"
.'- 删除短信模板后不可恢复,且后续不可再使用该模板发送短信,请谨慎操作。'."\n"
.'- 通过接口删除模板的操作会在短信服务控制台同步,在控制台对模板的相关操作,请参见[短信模板](~~108085~~)。'."\n"
."\n\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为1000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddSmsTemplate' => [
'summary' => '该接口已下线。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => true,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102439',
'abilityTreeNodes' => [
'FEATUREdysms2H0K7P',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TemplateType',
'in' => 'query',
'schema' => [
'description' => '短信类型。取值:'."\n"
."\n"
.'- **0**:验证码。'."\n"
.'- **1**:短信通知。'."\n"
.'- **2**:推广短信。'."\n"
.'- **3**:国际/港澳台消息。'."\n"
."\n"
.'> 仅支持企业认证用户申请推广短信和国际/港澳台消息。个人用户与企业用户权益区别详情请参见[使用须知](~~55324~~)。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '0',
],
],
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => [
'description' => '模板名称,长度不超过30个字符。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '验证码',
],
],
[
'name' => 'TemplateContent',
'in' => 'query',
'schema' => [
'description' => '模板内容,长度不超过500个字符。'."\n"
."\n"
.'模板内容和变量内容必须符合[短信模板规范](~~463161~~),否则模板会审核失败。您也可以在[申请模板](https://dysms.console.aliyun.com/domestic/text/template/add)页面,查看常用模板示例。使用示例模板可提高审核效率和成功率。变量规范请参见[TemplateContent参数变量规范](~~2806243~~)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '您正在申请手机注册,验证码为:${code},5分钟内有效!',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '短信模板申请说明,长度不超过100个字符。'."\n"
."\n"
.'模板审核的参考信息,完善申请说明有助于审核人员理解您的业务场景,提高审核效率。填写指导:'."\n"
."\n"
.'- 您可以提供已上线业务的使用场景。'."\n"
.'- 您可以提供真实场景的短信示例,体现您的业务场景。'."\n"
.'- 您可以提供变量的传参内容,详细描述业务使用场景和选择这个变量属性的原因。'."\n"
.'- 您可以提供实际业务的网站链接、已备案的域名地址、应用市场下载链接等。'."\n"
.'- 登录场景,您可以提供测试账号和密码。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '申请验证码短信',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'* 返回OK代表请求成功。'."\n"
.'* 其他错误码,请参见[API错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
],
'TemplateCode' => [
'description' => '短信模板Code。'."\n"
."\n"
.'提交模板申请后,您可以使用短信模板Code,通过[QuerySmsTemplate](~~419289~~)接口查询模板审核详情。也可以[配置回执消息](~~101508~~),通过[TemplateSmsReport](~~120999~~)获取模板的审核状态消息。',
'type' => 'string',
'example' => 'SMS_46817****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'TemplateParameterCountIllegal',
'errorMessage' => 'The verification code template only supports 1 verification code as a variable',
],
],
],
'staticInfo' => [
'substitutions' => [
'Dysmsapi::2017-05-25::CreateSmsTemplate',
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"TemplateCode\\": \\"SMS_46817****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<AddSmsTemplateResponse>\\r\\n <TemplateCode>SMS_1525****</TemplateCode>\\r\\n <Message>OK</Message>\\r\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>\\r\\n <Code>OK</Code>\\r\\n</AddSmsTemplateResponse>","errorExample":""}]',
'title' => '申请短信模板(已下线)',
'description' => '- 根据工信部规定与运营商[相关要求](~~2806975~~),阿里云进行了模板相关API的功能改造。为提升您模板的审核效率和审核通过率,请您使用新接口[CreateSmsTemplate-申请短信模板](~~2807431~~)。'."\n"
."\n"
.'- 通过接口申请短信模板,一个自然日最多可以提交100次短信模板申请。建议每次申请至少间隔30秒。通过[控制台](https://dysms.console.aliyun.com/domestic/text/template)申请短信模板,提交次数无限制。'."\n"
."\n"
.'- 通过接口申请的模板信息会同步在短信服务控制台,在控制台对模板的相关操作,请参见[短信模板](~~108085~~)。'."\n"
."\n"
.'- 提交模板申请后,您可以通过[QuerySmsTemplate](~~419289~~)接口查询模板审核状态和详情。也可以[配置回执消息](~~101508~~),通过[TemplateSmsReport](~~120999~~)获取模板的审核状态消息。'."\n"
."\n"
.'- 国内短信模板与国际/港澳台短信模板不通用(不能混用),请根据业务使用场景申请模板。'."\n"
."\n"
.'- 仅支持企业认证用户申请推广短信和国际/港澳台消息,个人用户与企业用户权益区别详情请参见[使用须知](~~55324~~)。'."\n"
."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为1000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifySmsTemplate' => [
'summary' => '该接口已下线。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => true,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102450',
'abilityTreeNodes' => [
'FEATUREdysms2H0K7P',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TemplateType',
'in' => 'query',
'schema' => [
'description' => '短信类型。取值:'."\n"
."\n"
.'- **0**:验证码。'."\n"
.'- **1**:短信通知。'."\n"
.'- **2**:推广短信。'."\n"
.'- **3**:国际/港澳台消息。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '0',
],
],
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => [
'description' => '模板名称,长度限制为1~30个字符。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '验证码模板',
],
],
[
'name' => 'TemplateCode',
'in' => 'query',
'schema' => [
'description' => '未通过审核的短信模板Code。'."\n"
."\n"
.'- 通过[QuerySmsTemplateList](~~419288~~)接口获取未通过审核的短信模板Code。'."\n"
.'- 在[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面查看未通过审核的短信模板Code。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'SMS_15255****',
],
],
[
'name' => 'TemplateContent',
'in' => 'query',
'schema' => [
'description' => '模板内容,长度不超过500个字符。'."\n"
."\n"
.'模板内容和变量内容必须符合[短信模板规范](~~463161~~),否则模板会审核失败。您也可以在[申请模板](https://dysms.console.aliyun.com/domestic/text/template/add)页面,查看常用模板示例。使用示例模板可提高审核效率和成功率。变量规范请参见[TemplateContent参数变量规范](~~2806243~~)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '您正在申请手机注册,验证码为:${code},5分钟内有效!',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '短信模板申请说明,长度不超过100个字符。'."\n"
."\n"
.'模板审核的参考信息,完善申请说明有助于审核人员理解您的业务场景,提高审核效率。填写指导:'."\n"
."\n"
.'- 您可以提供已上线业务的使用场景。'."\n"
.'- 您可以提供真实场景的短信示例,体现您的业务场景。'."\n"
.'- 您可以提供变量的传参内容,详细描述业务使用场景和选择这个变量属性的原因。'."\n"
.'- 您可以提供实际业务的网站链接、已备案的域名地址、应用市场下载链接等。'."\n"
.'- 登录场景,您可以提供测试账号和密码。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '手机注册登录',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
],
'TemplateCode' => [
'description' => '已修改的模板Code。',
'type' => 'string',
'example' => 'SMS_15255****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'TemplateParameterCountIllegal',
'errorMessage' => 'The verification code template only supports 1 verification code as a variable',
],
],
],
'staticInfo' => [
'substitutions' => [
'Dysmsapi::2017-05-25::UpdateSmsTemplate',
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"TemplateCode\\": \\"SMS_15255****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<ModifySmsTemplateResponse>\\r\\n <TemplateCode>SMS_15255****</TemplateCode>\\r\\n <Message>OK</Message>\\r\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>\\r\\n <Code>OK</Code>\\r\\n</ModifySmsTemplateResponse>","errorExample":""}]',
'title' => '修改短信模板(已下线)',
'description' => '- 根据工信部规定与运营商[相关要求](~~2806975~~),阿里云进行了模板相关API的功能改造。为提升您模板的审核效率和审核通过率,请您使用新接口[UpdateSmsTemplate-修改短信模板](~~2807432~~)。'."\n"
."\n"
.'- 仅支持修改未通过审核的模板,请参考[短信审核失败的处理建议](~~65990~~),调用此接口修改后重新提交审核。'."\n"
."\n"
.'- 通过接口修改模板的操作会在短信服务控制台同步,在控制台对模板的相关操作,请参见[短信模板](~~108085~~)。'."\n"
."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为1000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QuerySmsTemplate' => [
'summary' => '该接口已下线。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102460',
'abilityTreeNodes' => [
'FEATUREdysms2H0K7P',
],
],
'parameters' => [
[
'name' => 'TemplateCode',
'in' => 'query',
'schema' => [
'description' => '短信模板CODE。'."\n"
.'- 在[AddSmsTemplate](~~121208~~)接口的返回参数中获取短信模板Code。'."\n"
.'- 在[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面查看短信模板Code。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'SMS_1525****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TemplateContent' => [
'description' => '短信模板内容。',
'type' => 'string',
'example' => '亲爱的会员!阿里云短信服务祝您新年快乐!',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '0A974B78-02BF-4C79-ADF3-90CFBA1B55B1',
],
'TemplateCode' => [
'description' => '短信模板Code。',
'type' => 'string',
'example' => 'SMS_1525****',
],
'TemplateStatus' => [
'description' => '模板审核状态。返回值:'."\n"
."\n"
.'- **0**:审核中。'."\n"
.'- **1**:通过审核。'."\n"
.'- **2**:未通过审核,会返回审核失败的原因,请参考[短信审核失败的处理建议](~~65990~~),调用[ModifySmsTemplate](~~419287~~)接口或在[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面修改短信模板。'."\n"
.'- **10**:取消审核。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'TemplateType' => [
'description' => '短信类型。返回值:'."\n"
."\n"
.'- **0**:验证码。'."\n"
.'- **1**:短信通知。'."\n"
.'- **2**:推广短信。'."\n"
.'- **3**:国际/港澳台消息。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'TemplateName' => [
'description' => '短信模板名称。',
'type' => 'string',
'example' => '通知短信',
],
'CreateDate' => [
'description' => '创建短信模板的时间。',
'type' => 'string',
'example' => '2024-06-03 10:02:34',
],
'Reason' => [
'description' => '模板审核备注。'."\n"
."\n"
.'- 如果审核状态为**通过审核**或**审核中**,Reason返回“无审批备注”。'."\n"
.'- 如果审核状态为**未通过审核**,Reason返回未审核通过的具体原因。',
'type' => 'string',
'example' => '无审批备注',
],
],
],
],
],
'staticInfo' => [
'substitutions' => [
'Dysmsapi::2017-05-25::GetSmsTemplate',
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TemplateContent\\": \\"亲爱的会员!阿里云短信服务祝您新年快乐!\\",\\n \\"RequestId\\": \\"0A974B78-02BF-4C79-ADF3-90CFBA1B55B1\\",\\n \\"TemplateCode\\": \\"SMS_1525****\\",\\n \\"TemplateStatus\\": 0,\\n \\"Code\\": \\"OK\\",\\n \\"TemplateType\\": 1,\\n \\"Message\\": \\"OK\\",\\n \\"TemplateName\\": \\"通知短信\\",\\n \\"CreateDate\\": \\"2024-06-03 10:02:34\\",\\n \\"Reason\\": \\"无审批备注\\"\\n}","errorExample":""},{"type":"xml","example":"<QuerySmsTemplateResponse>\\n<TemplateCode>SMS_16703****</TemplateCode>\\n<Message>OK</Message>\\n<RequestId>0A974B78-02BF-4C79-ADF3-90CFBA1B55B1</RequestId>\\n<TemplateContent>亲爱的会员!阿里云短信服务祝您新年快乐!</TemplateContent>\\n<TemplateName>阿里云短信测试模板</TemplateName>\\n<TemplateType>1</TemplateType>\\n<CreateDate>2019-06-04 11:42:17</CreateDate>\\n<Code>OK</Code>\\n<Reason>无审批备注</Reason>\\n<TemplateStatus>1</TemplateStatus>\\n</QuerySmsTemplateResponse>","errorExample":""}]',
'title' => '查询模板审核状态(已下线)',
'description' => '- 根据工信部规定与运营商[相关要求](~~2806975~~),阿里云进行了模板相关API的功能改造。请您使用新接口[GetSmsTemplate-查询模板审核详情](~~2807433~~),新接口查询结果返回参数中将比原有接口返回更多的模板详情信息。'."\n"
."\n"
.'- 审核时间:一般情况下,模板提交后,阿里云预计在2个小时内审核完成(审核工作时间:周一至周日9:00~21:00,法定节假日顺延),建议您尽量在18:00前提交申请。'."\n"
."\n"
.'- 如果模板未通过审核,会返回审核失败的原因,请参考[短信审核失败的处理建议](~~65990~~),调用[ModifySmsTemplate](~~419287~~)接口或在[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面修改短信模板。'."\n"
."\n"
.'- QuerySmsTemplate当前接口是通过模板Code查询单个模板的审核详情。[QuerySmsTemplateList](~~419288~~)接口可以查询您当前账号下所有模板的模板详情。',
],
'SendSms' => [
'summary' => '向指定的手机号码发送短信。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '102468',
'abilityTreeNodes' => [
'FEATUREdysmsKC679O',
],
],
'parameters' => [
[
'name' => 'PhoneNumbers',
'in' => 'query',
'schema' => [
'description' => '接收短信的手机号码。手机号码格式:'."\n"
."\n"
.'* 国内短信:+/+86/0086/86或无任何前缀的手机号码,例如1390000\\*\\*\\*\\*。'."\n"
.'* 国际/港澳台消息:国际区号+号码,例如852000012\\*\\*\\*\\*。'."\n"
.'* 接收测试短信的手机号:必须先在[控制台](https://dysms.console.aliyun.com/quickstart)绑定测试手机号后才可以发送。'."\n"
."\n"
.'>支持向不同的手机号码发送短信,手机号码之间以半角逗号(,)分隔。上限为1000个手机号码。批量发送相对于单条发送,及时性稍有延迟。验证码类型的短信,建议单条发送。',
'type' => 'string',
'required' => true,
'example' => '1390000****',
],
],
[
'name' => 'SignName',
'in' => 'query',
'schema' => [
'description' => '短信签名名称。'."\n"
."\n"
.'您可以通过[QuerySmsSignList](~~419282~~)接口查询当前账号已申请的签名或在[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/sign)查看签名列表,必须使用**审核通过**的签名发送短信。'."\n"
."\n"
.'> - 1、如果验证码签名和通用签名相同时,默认使用通用签名发送短信。'."\n"
.'> - 2、系统会根据您选择的签名执行短信发送任务。',
'type' => 'string',
'required' => true,
'example' => '阿里云',
],
],
[
'name' => 'TemplateCode',
'in' => 'query',
'schema' => [
'description' => '短信模板Code。'."\n"
."\n"
.'您可以通过[QuerySmsTemplateList](~~419288~~)接口查询当前账号已申请的模板或在[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/template)查看模板列表,必须使用已**审核通过**的模板Code发送短信。',
'type' => 'string',
'required' => true,
'example' => 'SMS_15305****',
],
],
[
'name' => 'TemplateParam',
'in' => 'query',
'schema' => [
'description' => '短信模板变量对应的实际值,请传入**JSON字符串**。当您选择的模板内容含有变量时,此参数必填。参数个数应与模板内变量个数一致。'."\n"
."\n"
.'> - 如果JSON中需要带换行符,请参照标准的JSON协议处理。'."\n"
.'> - 模板变量规范,请参见[短信模板规范](~~463161~~)。',
'type' => 'string',
'required' => false,
'example' => '{"name":"张三","number":"1390000****"}',
],
],
[
'name' => 'SmsUpExtendCode',
'in' => 'query',
'schema' => [
'description' => '上行短信扩展码。上行短信指发送给通信服务提供商的短信,用于定制某种服务、完成查询,或是办理某种业务等,需要收费,按运营商普通短信资费进行扣费。'."\n"
.'> 扩展码是生成签名时系统自动默认生成的,不支持自行传入。无特殊需要可忽略此字段。',
'type' => 'string',
'required' => false,
'example' => '90999',
],
],
[
'name' => 'OutId',
'in' => 'query',
'schema' => [
'description' => '外部流水扩展字段。'."\n"
."\n"
.'> 无特殊需要可忽略此字段。',
'type' => 'string',
'required' => false,
'example' => 'abcdefgh',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'* 返回OK代表请求成功。'."\n"
.'* 其他错误码,请参见[API错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'BizId' => [
'description' => '发送回执ID。'."\n"
."\n"
.'可根据发送回执ID在接口[QuerySendDetails](~~QuerySendDetails~~)中查询具体的发送状态。',
'type' => 'string',
'example' => '9006197469364984****',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"BizId\\": \\"9006197469364984****\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","errorExample":""},{"type":"xml","example":"<SendSmsResponse>\\n <Message>OK</Message>\\n <RequestId>44DF7A95-603F-4651-9298-BE1850BEB53F</RequestId>\\n <BizId>336006646937050335^0</BizId>\\n <Code>OK</Code>\\n</SendSmsResponse>","errorExample":""}]',
'title' => '发送短信',
'description' => '本接口主要用于向单个手机号发送短信,也支持向多个手机号(单次最多支持 1000 个手机号)发送相同签名、相同模板变量的短信,群发存在一定延迟。如果您需要向多个手机号发送不同签名、不同模板变量的短信,请使用[SendBatchSms](~~419274~~)接口(单次最多支持100个手机号)。'."\n"
."\n"
.'### 注意事项'."\n"
.'- 国内短信服务超时时间建议设置为≥1S;发生超时失败的情况时,建议查看回执状态后再判断是否重试。超时和重试的相关设置,请参见[超时机制](~~262079~~)、[重试机制](~~262080~~)。'."\n"
.'- 国内短信、国际短信及多媒体短信目前均不支持幂等的能力,请您做好幂等控制,防止因多次重试而导致的重复操作问题。'."\n"
.'- 发送短信为计费接口,国内短信按照运营商回执状态计费,调用 SendSms 提交成功但运营商回执失败时不计费。计费详情请参见[计费概述](~~44340~~)。'."\n"
."\n"
.'### QPS 限制'."\n"
.'本接口的单用户 QPS 限制为 5000/秒。超过限制,API 调用将会被限流,请合理使用。',
'requestParamsDescription' => '## 请求示例'."\n"
.'- 服务地址URL:dysmsapi.aliyuncs.com(中国站)'."\n"
.'- 请求风格:RPC'."\n"
.'- 请求方式:POST/GET (推荐使用POST)'."\n"
.'- 公共请求头:[V3版本请求体公共请求头](~~2593177#sectiondiv-726-v1i-gel~~)'."\n"
.'- 请求参数:见上方请求参数表格'."\n"
."\n"
.'### SDK示例'."\n"
.'如果您需要了解如何使用SDK,请参见[首次调用API](~~2841024~~)。'."\n"
.'```Java'."\n"
.'// 构造请求对象'."\n"
.'SendSmsRequest sendSmsRequest = new SendSmsRequest()'."\n"
.' .setPhoneNumbers("1390000****")'."\n"
.' .setSignName("阿里云")'."\n"
.' .setTemplateCode("SMS_15305****")'."\n"
.' // TemplateParam为序列化后的JSON字符串。其中\\"表示转义后的双引号。'."\n"
.' .setTemplateParam("{\\"name\\":\\"张三\\",\\"number\\":\\"1390000****\\"}"); '."\n"
."\n"
.'// 发送API请求'."\n"
.'SendSmsResponse sendSmsResponse = client.sendSms(sendSmsRequest);'."\n"
.'```'."\n"
.'您可以访问[OpenAPI门户](https://api.aliyun.com/api/Dysmsapi/2017-05-25/SendSms?tab=DEMO&lang=JAVA),查看各语言SDK请求完整示例。'."\n"
."\n"
.'### 自签名请求示例'."\n"
.'推荐您通过SDK调用API,SDK已经封装了签名等机制。'."\n"
.'```HTTP'."\n"
.'POST /?PhoneNumbers=123****4567&SignName=阿里云短信测试&TemplateCode=SMS_154950909&TemplateParam={"code":"1234"} HTTP/1.1'."\n"
.'Host: dysmsapi.aliyuncs.com'."\n"
.'Authorization: ACS3-HMAC-SHA256 Credential=YourAccessKeyId,SignedHeaders=host;x-acs-action;x-acs-content-sha256;x-acs-date;x-acs-signature-nonce;x-acs-version,Signature=06563a9e1b43f5dfe96b81********ceab24a1d853912eee15083a6f0f3283c0'."\n"
.'x-acs-action: SendSms'."\n"
.'x-acs-version: 2017-05-25'."\n"
.'x-acs-signature-nonce: d410180a5abf7f********74aca91fc0'."\n"
.'x-acs-date: 2024-12-02T06:53:09Z'."\n"
.'x-acs-content-sha256: e3b0c44298fc1c149afb********b92427ae41e4649b934ca495991b7852b855'."\n"
.'```'."\n"
.'自定义封装API调用签名机制,请参见[V3版本签名机制示例](~~2593177#79cbd5a0c1gif~~)。',
],
'SendBatchSms' => [
'summary' => '调用此接口可以给不同的手机号码,发送不同签名、同一个模板(可以是不同模板变量)的短信。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '102462',
'abilityTreeNodes' => [
'FEATUREdysmsKC679O',
],
],
'parameters' => [
[
'name' => 'PhoneNumberJson',
'in' => 'formData',
'schema' => [
'description' => '接收短信的手机号码。手机号码格式:'."\n"
."\n"
.'* 国内短信:+/+86/0086/86或无任何前缀的手机号码,例如1590000\\*\\*\\*\\*。'."\n"
.'* 国际/港澳台消息:国际区号+号码,例如852000012\\*\\*\\*\\*。'."\n"
."\n"
.'> 验证码类型短信,建议使用[SendSms](~~419273~~)接口单条发送。',
'type' => 'string',
'required' => true,
'example' => '["1590000****","1350000****"]',
],
],
[
'name' => 'SignNameJson',
'in' => 'formData',
'schema' => [
'description' => '短信签名名称,签名数量需与手机号码数量一致。'."\n"
."\n"
.'您可以通过[QuerySmsSignList](~~419282~~)接口查询当前账号已申请的签名或在[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/sign)查看已审核通过的签名,必须使用审核通过的签名发送短信。'."\n"
."\n"
.'> '."\n"
.'> - 系统会根据您选择的签名执行短信发送任务。',
'type' => 'string',
'required' => true,
'example' => '["阿里云","阿里巴巴"]',
],
],
[
'name' => 'TemplateCode',
'in' => 'query',
'schema' => [
'description' => '短信模板Code。国内短信模板和国际短信模板不可以混用。'."\n"
."\n"
.'您可以通过[QuerySmsTemplateList](~~419288~~)接口查询当前账号已申请的模板或在[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/template)查看模板列表,必须使用已审核通过的模板Code发送短信。',
'type' => 'string',
'required' => true,
'example' => 'SMS_15255****',
],
],
[
'name' => 'TemplateParamJson',
'in' => 'formData',
'schema' => [
'description' => '短信模板变量对应的实际值。当您选择的模板内含有变量时,此参数必填。'."\n"
."\n"
.'> - 模板变量值的个数必须与手机号码、签名的个数相同、内容一一对应,表示向指定手机号码中发对应签名的短信,且短信模板中的变量参数替换为对应的值。'."\n"
.'> - 如果JSON中需要带换行符,请参照标准的JSON协议处理。',
'type' => 'string',
'required' => false,
'example' => '[{"name":"TemplateParamJson"},{"name":"TemplateParamJson"}]',
],
],
[
'name' => 'SmsUpExtendCodeJson',
'in' => 'formData',
'schema' => [
'description' => '上行短信扩展码,JSON数组格式。'."\n"
."\n"
.'> 无特殊需要可忽略此字段。',
'type' => 'string',
'required' => false,
'example' => '["90999","90998"]',
],
],
[
'name' => 'OutId',
'in' => 'query',
'schema' => [
'description' => '外部流水扩展字段,长度小于256的字符串。'."\n"
."\n"
.'> 无特殊需要可忽略此字段。',
'type' => 'string',
'required' => false,
'example' => 'abcdefg',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '是否调用接口成功的描述。',
'type' => 'string',
'example' => 'OK',
],
'BizId' => [
'description' => '发送回执ID。'."\n"
."\n"
.'- 根据该ID在接口[QuerySendDetails](~~102352~~)中查询具体的发送状态。'."\n"
.'- 登录[短信服务控制台](https://dysms.console.aliyun.com/dysms.htm#/overview),在**业务统计**-**发送记录查询**页面查看发送详情。',
'type' => 'string',
'example' => '9006197469364984400',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D230E',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"BizId\\": \\"9006197469364984400\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D230E\\"\\n}","type":"json"}]',
'title' => '批量发送短信',
'description' => '### 基本信息'."\n"
.'- 本接口主要用于向多个手机号发送短信,支持发送不同签名、同一模板、不同模板变量的短信,单次调用最多支持 100 个手机号。'."\n"
.'- [服务接入点](~~419270~~) (Endpoint):全局接入点域名为`dysmsapi.aliyuncs.com`。请参见[服务接入点](~~419270~~) ,根据您的使用地域,选择对应的接入点地址。'."\n"
.'### 快速调用'."\n"
.'- 推荐您通过 SDK 调用 API。 如果您需要了解如何使用 ,请参见[首次调用API](~~2841024~~)。'."\n"
.'- 如果您需要使用控制台发送短信,请参见[群发短信](~~108266~~)。'."\n"
.'- 如果您需要自定义封装API调用,请参见[V3版本请求体&签名机制](~~2593177~~)'."\n"
.'### 注意事项'."\n"
.'- 国内短信服务超时时间建议设置为≥1S;发生超时失败的情况时,建议查看回执状态后再判断是否重试。超时和重试的相关设置,请参见[超时机制](~~262079~~)、[重试机制](~~262080~~)。'."\n"
.'- 国内短信、国际短信及多媒体短信目前均不支持幂等的能力,请您做好幂等控制,防止因多次重试而导致的重复操作问题。'."\n"
.'- 发送短信为计费接口,国内短信按照运营商回执状态计费,调用SendBatchSms提交成功但运营商回执失败的短信不计费,计费详情请参见[计费概述](~~44340~~)。'."\n"
.'### QPS 限制'."\n"
.'本接口的单用户 QPS 限制为 5000/秒。超过限制,API 调用将会被限流,请合理使用。',
],
'QuerySendDetails' => [
'summary' => '查询单个号码的短信发送记录和发送状态等信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102455',
'abilityTreeNodes' => [
'FEATUREdysmsWO2BNU',
],
],
'parameters' => [
[
'name' => 'PhoneNumber',
'in' => 'query',
'schema' => [
'description' => '需要查询的手机号码。格式:'."\n"
."\n"
.'* 国内短信:11位手机号码,例如1390000\\*\\*\\*\\*。'."\n"
.'* 国际/港澳台消息:国际区号+号码,例如8520000\\*\\*\\*\\*。'."\n"
."\n"
.'> 只能传入一个手机号码。',
'type' => 'string',
'required' => true,
'example' => '1390000****',
],
],
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '发送回执ID。即发送流水号,调用[SendSms](~~419273~~)或[SendBatchSms](~~419274~~)发送短信时,返回值中的BizId字段。'."\n"
."\n"
.'> 只能传入一个Bizid的值,无法传入多个Bizid。',
'type' => 'string',
'required' => false,
'example' => '134523^435****',
],
],
[
'name' => 'SendDate',
'in' => 'query',
'schema' => [
'description' => '短信发送日期,支持查询最近30天的记录。'."\n"
."\n"
.'格式:**yyyyMMdd**,例如20250601。',
'type' => 'string',
'required' => true,
'example' => '20250601',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示的短信记录数量,供分页查看发送记录使用。'."\n"
."\n"
.'取值范围为1~50。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '20',
],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'description' => '发送记录的当前页码,供分页查看发送记录使用。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF',
],
'TotalCount' => [
'description' => '短信发送总条数。',
'type' => 'string',
'example' => '1',
],
'SmsSendDetailDTOs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SmsSendDetailDTO' => [
'description' => '短信发送明细。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ErrCode' => [
'description' => '运营商短信状态码。'."\n"
."\n"
.'- 短信发送成功:DELIVERED。'."\n"
.'- 短信发送失败:失败错误码请参见[错误码](~~101347~~)。',
'type' => 'string',
'example' => 'DELIVERED',
],
'TemplateCode' => [
'description' => '短信模板Code。'."\n"
."\n"
.'> 若选择`[测试专用]阿里云通信`和`[测试专用]阿里云通信测试模板`发送的测试短信,本接口将不会返回TemplateCode字段。',
'type' => 'string',
'example' => 'SMS_12231****',
],
'OutId' => [
'description' => '外部流水扩展字段。'."\n"
."\n"
.'> 若发送短信时未传入OutId,本接口将不会返回OutId字段。',
'type' => 'string',
'example' => '123',
],
'ReceiveDate' => [
'description' => '短信接收日期和时间。',
'type' => 'string',
'example' => '2025-06-01 16:44:13',
],
'SendDate' => [
'description' => '短信发送日期和时间。',
'type' => 'string',
'example' => '2025-06-01 16:44:10',
],
'PhoneNum' => [
'description' => '接收短信的手机号码。',
'type' => 'string',
'example' => '1390000****',
],
'Content' => [
'description' => '短信内容。',
'type' => 'string',
'example' => '【阿里云】验证码为:123,您正在登录,若非本人操作,请勿泄露',
],
'SendStatus' => [
'description' => '短信发送状态,包括:'."\n"
."\n"
.'- **1**:等待回执。'."\n"
.'- **2**:发送失败。'."\n"
.'- **3**:发送成功。',
'type' => 'integer',
'format' => 'int64',
'example' => '3',
],
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"SmsSendDetailDTOs\\": {\\n \\"SmsSendDetailDTO\\": [\\n {\\n \\"ErrCode\\": \\"DELIVERED\\",\\n \\"TemplateCode\\": \\"SMS_12231****\\",\\n \\"OutId\\": \\"123\\",\\n \\"ReceiveDate\\": \\"2025-06-01 16:44:13\\",\\n \\"SendDate\\": \\"2025-06-01 16:44:10\\",\\n \\"PhoneNum\\": \\"1390000****\\",\\n \\"Content\\": \\"【阿里云】验证码为:123,您正在登录,若非本人操作,请勿泄露\\",\\n \\"SendStatus\\": 3\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询短信发送详情',
'description' => '- 本接口主要用于查询指定日期下,向某个手机号码发送短信的记录详情。您也可以传入发送流水号(BizId),查询该号码的指定发送记录。'."\n"
."\n"
.'- 本接口仅支持查询单个手机号码发送详情。如果需要批量查看短信发送详情,您可以使用[QuerySendStatistics](~~419276~~)接口,查询短信发送统计详情;或登录[控制台发送记录查询](https://dysms.console.aliyun.com/record)页面,查询发送详情。'."\n"
."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为5000/秒。超过限制,API调用将会被限流,请合理使用。',
'requestParamsDescription' => '您可以访问[OpenAPI](https://api.aliyun.com/api/Dysmsapi/2017-05-25/QuerySendDetails?tab=DEMO&lang=JAVA)门户,查看各语言SDK请求示例。',
],
'QuerySendStatistics' => [
'summary' => '查询短信发送统计详情,包括短信发送时间、短信发送成功条数、接收回执条数等。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '118726',
'abilityTreeNodes' => [
'FEATUREdysmsWO2BNU',
],
],
'parameters' => [
[
'name' => 'IsGlobe',
'in' => 'query',
'schema' => [
'description' => '短信发送范围。取值:'."\n"
."\n"
.'- **1**:国内短信发送记录。'."\n"
."\n"
.'- **2**:国际/港澳台短信发送记录。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '2',
'minimum' => '1',
'example' => '1',
'maxLength' => 2,
'minLength' => 1,
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'description' => '开始日期,格式为yyyyMMdd。',
'type' => 'string',
'required' => true,
'example' => '20201002',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'description' => '结束日期,格式为yyyyMMdd。',
'type' => 'string',
'required' => true,
'example' => '20201003',
],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'minimum' => '1',
'example' => '1',
'minLength' => 1,
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示的条数。取值范围:**1~50**。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
'maxLength' => 50,
'minLength' => 1,
],
],
[
'name' => 'TemplateType',
'in' => 'query',
'schema' => [
'description' => '模板类型。取值:'."\n"
."\n"
.'- **0**:验证码。'."\n"
."\n"
.'- **1**:通知短信。'."\n"
."\n"
.'- **2**:推广短信。(仅支持企业客户)'."\n"
."\n"
.'- **3**:国际/港澳台消息。(仅支持企业客户)'."\n"
."\n"
.'- **7**:数字短信。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'SignName',
'in' => 'query',
'schema' => [
'description' => '签名名称。',
'type' => 'string',
'required' => false,
'example' => '阿里云平台',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'."\n",
],
'Code' => [
'description' => '请求状态码。取值:'."\n"
."\n"
.'- OK:代表请求成功。'."\n"
."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'TotalSize' => [
'description' => '返回数据的总条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'TargetList' => [
'description' => '返回数据列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '发送成功的短信条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'RespondedSuccessCount' => [
'description' => '接收到回执成功的短信条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '17',
],
'RespondedFailCount' => [
'description' => '接收到回执失败的短信条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'NoRespondedCount' => [
'description' => '未收到回执的短信条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'SendDate' => [
'description' => '短信发送日期,格式为yyyyMMdd。',
'type' => 'string',
'example' => '20201010',
],
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\\\n\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TotalSize\\": 20,\\n \\"TargetList\\": [\\n {\\n \\"TotalCount\\": 20,\\n \\"RespondedSuccessCount\\": 17,\\n \\"RespondedFailCount\\": 2,\\n \\"NoRespondedCount\\": 1,\\n \\"SendDate\\": \\"20201010\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QuerySendStatisticsResponse>\\n <RequestId>819BE656-D2E0-4858-8B21-B2E47708****</RequestId>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <Data>\\n <TotalSize>20</TotalSize>\\n <TargetList>\\n <TotalCount>20</TotalCount>\\n <RespondedSuccessCount>17</RespondedSuccessCount>\\n <RespondedFailCount>2</RespondedFailCount>\\n <NoRespondedCount>1</NoRespondedCount>\\n <SendDate>20201010</SendDate>\\n </TargetList>\\n </Data>\\n</QuerySendStatisticsResponse>","errorExample":""}]',
'title' => '查询短信发送量统计',
'description' => '- 如果选择的时间范围较长的话,可以分页查看。指定每页显示的短信详情数量和查看的页数,即可分页查看发送记录。'."\n"
."\n"
.'- 您可以登录[短信服务控制台](https://dysms.console.aliyun.com/dysms.htm#/overview),在**业务统计**-**发送记录**页面查询发送详情。',
],
'CreateDigitalSignOrder' => [
'summary' => '创建/编辑签名接口',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'OrderType',
'in' => 'query',
'schema' => [
'description' => '必填 请求类型 按照枚举类型进行签名管理 新增、编辑、删除操作',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'UPDATE_DIGITALSMS_SIGN' => '更新',
'DELETE_DIGITALSMS_SIGN' => '删除',
'CREATE_DIGITALSMS_SIGN' => '创建',
],
'example' => 'CREATE_DIGITALSMS_SIGN',
],
],
[
'name' => 'Submitter',
'in' => 'query',
'schema' => [
'description' => '非必填',
'type' => 'string',
'required' => false,
'example' => '110000001750080',
],
],
[
'name' => 'SignName',
'in' => 'query',
'schema' => [
'description' => '签名名称 创建/更新/删除当前字段必填。'."\n"
."\n"
.'1. 仅支持纯中文、中英文、中文+数字、英文+数字组合输入,字符长度限制2~16字符以内'."\n"
."\n"
.'2. 输入限制规则'."\n"
.'- 禁止任何特殊字符输入,包括但不限于 “$、&、%、#、@、!、^、*、(、)、_、+、-、=、{、}、[、]、|、;、:、\'、"、<、>、,、.、/、?、~、`” 等特殊符号'."\n"
.'- 不支持纯英文字母输入'."\n"
.'- 不接受纯数字输入严格禁止输入空格,无论是单个空格还是多个连续空格'."\n"
.'- 不允许输入emoji',
'type' => 'string',
'required' => false,
'example' => '阿里云商城',
],
],
[
'name' => 'QualificationId',
'in' => 'query',
'schema' => [
'description' => '非必填',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '41',
],
],
[
'name' => 'QualificationVersion',
'in' => 'query',
'schema' => [
'description' => '非必填',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '49',
],
],
[
'name' => 'OrderContext',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '资质信息,在这个结构中,在【创建】时必填,【更新】时需要变更资质信息则必填'."\n"
.'- qualificationCompanyName 企业名称。符号仅支持中点·、中文【】()、英文()及空格,不可含其他符号或纯数字,长度不超过 150 字符'."\n"
.'- qualificationOrganizationCode 企业社会信用代码(18位) 仅支持统一社会信用,18位数字或大小写英文字母组成的代码'."\n"
.'- qualificationAdminName 经办人姓名(中文) 法定代表人姓名。'."\n"
.'- qualificationAdminIDCard 经办人身份证号(18位)当前只支持身份证,数据校验格式为身份证格式(数字+字母 18位)'."\n"
.'- qualificationLegalPersonName 法人姓名 经办人姓名。'."\n"
.'- qualificationLegalPersonIDCard 身份证号(18位) 当前只支持身份证,数据校验格式为身份证格式(数字+字母 18位)',
'type' => 'object',
'required' => false,
'enumValueTitles' => [],
'example' => '{'."\n"
.' "qualificationCompanyName": "阿里阿巴",'."\n"
.' "qualificationOrganizationCode": "91330106MA2A0XABCD",'."\n"
.' "qualificationLegalPersonName": "张三",'."\n"
.' "qualificationLegalPersonIDCard": "110105199001011234",'."\n"
.' "qualificationAdminName": "李四",'."\n"
.' "qualificationAdminIDCard": "1101051990010100000"'."\n"
.'}',
],
],
[
'name' => 'SignIndustry',
'in' => 'query',
'schema' => [
'description' => '行业类型'."\n"
.'- 0:通用(GENERAL);1:电商零售(ECOMMERCE)。'."\n"
.'- 新增/更新签名时,当前字段必填;删除时非必填。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => [
'通用(GENERAL)',
'电商零售(ECOMMERCE)',
],
'example' => '0',
],
],
[
'name' => 'SignId',
'in' => 'query',
'schema' => [
'description' => '非必填 签名ID-系统内唯一签名标识',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '80',
],
],
[
'name' => 'SignSource',
'in' => 'query',
'schema' => [
'description' => '签名来源 '."\n"
.'- 新增/更新签名时,当前字段必填;删除时非必填。'."\n"
.'- 0:企事业单位;2:App应用;5:商标名;7:电商/旗舰店。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => [
'企事业单位',
2 => 'App应用',
5 => '商标名',
7 => '电商/旗舰店',
],
'example' => '0',
],
],
[
'name' => 'ExtendMessage',
'in' => 'query',
'schema' => [
'description' => '非必填',
'type' => 'string',
'required' => false,
'example' => '示例值示例值',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。',
'type' => 'string',
'example' => 'None',
],
'RequestId' => [
'description' => '阿里云为该请求生成的唯一标识符。',
'type' => 'string',
'example' => '2D0133B9-6C0D-0BAE-8161-1EEF9E2D4069',
],
'Message' => [
'description' => '是否调用接口成功的描述。',
'type' => 'string',
'example' => '示例值示例值',
],
'Data' => [
'description' => '接口返回参数body'."\n"
.'- signName 签名名称 创建的签名名称'."\n"
.'- signOrderId 签名OrderId 关联的签名订单唯一标识'."\n"
.'- signCode 签名编码 签名在系统中的唯一数字ID'."\n"
.'- signId 签名ID 签名在系统中的唯一数字ID',
'type' => 'object',
'example' => '{\'signId\': \'20067468291\', \'signCode\': \'SIGN_100000184736042_1744164758835_hpMd1\', \'signOrderId\': 22469795330, \'signName\': u\'\\u8d5b\\u745e\\u5a05\\u808c\\u80a4\\u7ba1\\u7406\'}',
],
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[API错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'enumValueTitles' => [
'true' => '成功',
'false' => '失败',
],
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"2D0133B9-6C0D-0BAE-8161-1EEF9E2D4069\\",\\n \\"Message\\": \\"示例值示例值\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '数字短信签名管理',
'description' => '创建/编辑/删除 签名接口',
'requestParamsDescription' => '资质信息,在这个结构中,在【创建】时必填,【更新】时需要变更资质信息则必填'."\n"
.'json示例:'."\n"
.'`{'."\n"
.' "qualificationCompanyName": "阿里阿巴",'."\n"
.' "qualificationOrganizationCode": "91330106MA2A0XABCD",'."\n"
.' "qualificationLegalPersonName": "张三",'."\n"
.' "qualificationLegalPersonIDCard": "110105199001011234",'."\n"
.' "qualificationAdminName": "李四",'."\n"
.' "qualificationAdminIDCard": "1101051990010100000"'."\n"
.'}`'."\n"
.'- qualificationCompanyName 企业名称。符号仅支持中点·、中文【】()、英文()及空格,不可含其他符号或纯数字,长度不超过 150 字符'."\n"
.'- qualificationOrganizationCode 企业社会信用代码(18位) 仅支持统一社会信用,18位数字或大小写英文字母组成的代码'."\n"
.'- qualificationAdminName 经办人姓名(中文) 法定代表人姓名。'."\n"
.'- qualificationAdminIDCard 经办人身份证号(18位)当前只支持身份证,数据校验格式为身份证格式(数字+字母 18位)'."\n"
.'- qualificationLegalPersonName 法人姓名 经办人姓名。'."\n"
.'- qualificationLegalPersonIDCard 身份证号(18位) 当前只支持身份证,数据校验格式为身份证格式(数字+字母 18位)',
'extraInfo' => '提交签名申请后,您可以通过 GetSmsSign 接口查询签名报备状态和详情。也可以[配置回执消息](https://dysmsnext.console.aliyun.com/general/audit)'."\n"
.'核心处理逻辑:'."\n"
."\n"
.'1. 删除签名:通过接口删除签名的操作会在短信服务控制台同步,页面将移除该签名记录;若任意一家运营商存在‘报备中’状态,不支持删除,请等待结果返回后再试。'."\n"
.'2. 关联模板失效:自动查询此签名关联的所有短信模板,并将这些模板的状态批量变更为“已失效”。'."\n"
.'3. 标记原因:在关联模板的状态变更记录中,会附加失效原因:“模板关联的签名被删除”。'."\n"
."\n"
.'● 使用限制与说明:'."\n"
."\n"
.'1. 权限:仅签名所属的阿里云账号可对其进行删除操作。'."\n"
.'2. 不可逆:签名删除后不可恢复,如需使用需重新提交申请。'."\n"
.'3. 发送影响:签名删除且关联模板失效后,所有基于这些模板的'."\n"
."\n"
.'短信发送请求将会失败。请在操作前务必确认影响范围。',
],
'QueryDigitalSignByName' => [
'summary' => '根据签名名称查询签名详细信息',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'SignName',
'in' => 'query',
'schema' => [
'description' => '必填 签名名称'."\n"
.'必须是本账号已申请的数字短信签名。',
'type' => 'string',
'required' => false,
'example' => '阿里云数字商城',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Data' => [
'description' => '- gmtModified 最后修改时间 '."\n"
.'- creator 创建者 创建者ID'."\n"
.'- signName 短信签名名称 '."\n"
.'- qualificationId 资质ID 接口或控制台创建的资质ID'."\n"
.'- signIndustry 行业类型 行业类型。0:通用(GENERAL);1:电商零售(ECOMMERCE)。'."\n"
.'- signVersion 签名版本 若有版本迭代会更新数字,当前为1'."\n"
.'- telecomRegisterStatus 电信报备状态 0, "报备失败" 3, "报备成功" -1, "报备中" -2, "未报备"'."\n"
.'- signCode 签名code 短信签名 Code。'."\n"
.'- gmtCreate 创建时间 '."\n"
.'- signId 签名ID 系统内唯一签名标识'."\n"
.'- mobileRegisterStatus 移动报备状态 '."\n"
.'- SignSource 签名来源 2 签名来源。取值:'."\n"
.'0:企事业单位的全称或简称。'."\n"
.'2:App 应用的全称或简称。'."\n"
.'5:商标名的全称或简称。'."\n"
.'7:电商、旗舰店(仅接口可创建此类型)'."\n"
.'- mobileAvailableStatus 移动可用性 0, "不可用"/1, "可用" 创建模板或发送数字短信时请尽可能选择‘可用’签名。'."\n"
.'- unicomRegisterStatus 联通报备状态 0, "报备失败"/3, "报备成功"/-1, "报备中"/-2, "未报备"'."\n"
.'- unicomAvailableStatus 联通可用性 0, "不可用"/1, "可用" 创建模板或发送数字短信时请尽可能选择‘可用’签名。'."\n"
.'- telecomAvailableStatus 电信可用性 0, "不可用"/1, "可用" 创建模板或发送数字短信时请尽可能选择‘可用’签名。',
'type' => 'object',
'example' => ' "Data": {'."\n"
.' "gmtModified": 1770005896000,'."\n"
.' "creator": "UID:1498275912899720",'."\n"
.' "signName": "驳回理由",'."\n"
.' "qualificationId": 2757722,'."\n"
.' "qualificationVersion": 1768974751432,'."\n"
.' "signIndustry": 0,'."\n"
.' "registerStatueReason": {},'."\n"
.' "signVersion": 1,'."\n"
.' "remark": "",'."\n"
.' "telecomRegisterStatus": -1,'."\n"
.' "signCode": "DIGSIGN_100000168688001_1769050485148_pYZu1",'."\n"
.' "gmtCreate": 1769050485000,'."\n"
.' "signId": 22784769,'."\n"
.' "mobileRegisterStatus": -1,'."\n"
.' "signSource": 0,'."\n"
.' "mobileAvailableStatus": 0,'."\n"
.' "attachmentList": [],'."\n"
.' "unicomRegisterStatus": 3,'."\n"
.' "unicomAvailableStatus": 1,'."\n"
.' "signType": 1,'."\n"
.' "telecomAvailableStatus": 0,'."\n"
.' "extendMessage": "{}"'."\n"
.' },',
],
'Code' => [
'description' => '请求状态码。'."\n"
.'OK代表成功,其他为错误码。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => 'ture:成功'."\n"
.'false:失败',
'type' => 'boolean',
'enumValueTitles' => [
'true' => '成功',
'false' => '失败',
],
'example' => 'false',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]',
'title' => '数字短信签名查询',
'description' => '查询范围:仅支持查询当前阿里云账号下已申请的数字短信签名。',
],
'CreateDigitalSmsTemplate' => [
'summary' => '创建数字短信模板',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102441',
'abilityTreeNodes' => [
'FEATUREdysms0VSOON',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => [
'description' => '模板名称,不要超过20字符',
'type' => 'string',
'required' => true,
'example' => '****模板',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '短信模板申请说明。请在申请说明中描述您的业务使用场景',
'type' => 'string',
'required' => true,
'example' => '***业务需要',
],
],
[
'name' => 'TemplateContents',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '短信模板内容 数组',
'type' => 'array',
'items' => [
'description' => '短信模板内容。',
'type' => 'object',
'properties' => [
'FileContents' => [
'description' => '文件二进制数组转base64,转的时候指定编码格式为UTF-8',
'type' => 'string',
'required' => false,
'example' => '字符',
],
'FileSuffix' => [
'description' => '文件后缀名,文字内容转成txt,图片支持gif、jpg、png格式,音频支持mp3格式,视频支持mp4格式,目前只支持上传一个视频文件',
'type' => 'string',
'required' => false,
'example' => 'txt',
],
'FileName' => [
'description' => '文件名称,不要带扩展名',
'type' => 'string',
'required' => false,
'example' => 'file-1',
],
'FileSize' => [
'description' => '文件大小,单位:字节',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1840901',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 10,
],
],
[
'name' => 'SignName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '签名',
'type' => 'string',
'required' => false,
'example' => '签名',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。返回OK代表请求成功。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '附加信息。取值说明如下:请求正常,返回success。请求异常,返回具体异常错误码。',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
],
'TemplateCode' => [
'description' => '模板code',
'type' => 'string',
'example' => 'DIGITAL_SMS_0001',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"TemplateCode\\": \\"DIGITAL_SMS_0001\\"\\n}","type":"json"}]',
'title' => '数字短信模板创建',
'description' => '数字短信-创建模板接口',
],
'GetOSSInfoForCardTemplate' => [
'summary' => '获取卡片短信所属OSS资源配置信息,此配置信息将用于后续OSS文件上传操作。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102447',
'abilityTreeNodes' => [
'FEATUREdysms17QZIS',
],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'- OK:代表请求成功。'."\n"
.'- 其他错误码,请参见[API错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Signature' => [
'description' => '短信签名。',
'type' => 'string',
'example' => '阿里云',
],
'Host' => [
'description' => '访问地址。',
'type' => 'string',
'example' => 'http://***.aliyuncs.com'."\n",
],
'Policy' => [
'description' => '签名策略。',
'type' => 'string',
'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0yNlQwMzo0NDoyMy4xNTlaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCIxNDIwNjM0******************',
],
'ExpireTime' => [
'description' => '超时时间戳。单位:秒。',
'type' => 'string',
'example' => '1634209418',
],
'AliUid' => [
'description' => '阿里云账号ID。',
'type' => 'string',
'example' => '168**********184'."\n",
],
'AccessKeyId' => [
'description' => '签名使用的AccessKey ID。',
'type' => 'string',
'example' => 'LTAI************',
],
'StartPath' => [
'description' => '策略路径。',
'type' => 'string',
'example' => '168**********184',
],
'Bucket' => [
'description' => 'OSS文件保存桶名称。',
'type' => 'string',
'example' => 'alicom-cardsms-resources',
],
],
],
],
],
],
],
'errorCodes' => [
200 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Signature\\": \\"阿里云\\",\\n \\"Host\\": \\"http://***.aliyuncs.com\\\\n\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0yNlQwMzo0NDoyMy4xNTlaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCIxNDIwNjM0******************\\",\\n \\"ExpireTime\\": \\"1634209418\\",\\n \\"AliUid\\": \\"168**********184\\\\n\\",\\n \\"AccessKeyId\\": \\"LTAI************\\",\\n \\"StartPath\\": \\"168**********184\\",\\n \\"Bucket\\": \\"alicom-cardsms-resources\\"\\n }\\n}","type":"json"}]',
'title' => '获取OSS上传信息',
'description' => '- 您在调用卡片短信相关API接口前,首先需要开通卡片短信功能,目前卡片短信在内部邀约阶段,请联系您的阿里云商务经理申请开通或联系[阿里云售前咨询](https://help.aliyun.com/document_detail/464625.html)。'."\n"
."\n"
.'- 卡片短信模板中使用的图片、视频等素材资源可上传到OSS文件系统保存。文件上传操作,请参见[OSS文件上传](~~437303~~)。'."\n"
."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为300次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
'requestParamsDescription' => '### 请求参数说明'."\n"
.'GetOSSInfoForCardTemplate接口没有入参,直接调用接口即可获取OSS上传信息。',
],
'GetMediaResourceId' => [
'summary' => '将用户上传到卡片短信OSS存储的图片、视频转换成(生成)资源数据统一管理,并返回资源ID,用户可以对返回的资源ID自行管理。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102446',
'abilityTreeNodes' => [
'FEATUREdysms17QZIS',
],
],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。'."\n"
."\n"
.'- **1**:文本'."\n"
.'- **2**:图片。小图片限制在100 KB以内,大图片限制在2 MB以内,图片要求清晰;图片格式支持JPG、JPEG、PNG。'."\n"
.'- **3**:音频'."\n"
.'- **4**:视频。视频格式支持MP4。'."\n"
.'> '."\n"
.'> - 资源类型为图片时**img_rate**必填。'."\n"
.'> - 1:1比例:oneToOne'."\n"
.'> - 16:9比例:sixteenToNine'."\n"
.'> - 3:1比例:threeToOne'."\n"
.'> - 48:65比例:fortyEightToSixtyFiv',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '10000',
'minimum' => '0',
'example' => '1',
],
],
[
'name' => 'OssKey',
'in' => 'query',
'schema' => [
'description' => '获取的资源地址。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'oss://alicom-fc-media/1947741454322274/alicom-fc-media/pic/202205191526575398603697152.png',
],
],
[
'name' => 'FileSize',
'in' => 'query',
'schema' => [
'description' => '文件大小,单位:Byte。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '9223372036854775807',
'minimum' => '0',
'example' => '12',
],
],
[
'name' => 'ExtendInfo',
'in' => 'query',
'schema' => [
'description' => '扩展字段。'."\n"
."\n"
.'> 资源类型为**图片**时必填。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '{\\"img_rate\\":\\"oneToOne\\"}',
],
],
[
'name' => 'Memo',
'in' => 'query',
'schema' => [
'description' => '上传资源的描述。',
'type' => 'string',
'required' => false,
'example' => '图片信息',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F07CF237-F6E3-5F77-B91B-F9B7C5DE84AB',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'ResourceId' => [
'description' => '资源ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ResUrlDownload' => [
'description' => '资源下载地址。',
'type' => 'string',
'example' => 'http://test-example.com/download.jpg',
],
],
],
],
],
],
],
'errorCodes' => [
200 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"F07CF237-F6E3-5F77-B91B-F9B7C5DE84AB\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ResourceId\\": 0,\\n \\"ResUrlDownload\\": \\"http://test-example.com/download.jpg\\"\\n }\\n}","type":"json"}]',
'title' => '获取媒体资源ID',
'description' => '### QPS限制'."\n"
.'本接口的单用户QPS限制为300次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
],
'CreateCardSmsTemplate' => [
'summary' => '创建卡片短信模板。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102440',
'abilityTreeNodes' => [
'FEATUREdysms17QZIS',
],
],
'parameters' => [
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => [
'description' => '卡片短信模板名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '阿里云图文类模板',
],
],
[
'name' => 'Template',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '卡片短信的模板内容。'."\n"
."\n"
.'> - Template、ExtendInfo、TemplateContent、TmpCard、Action等字段说明,请参见[卡片短信模板参数字段说明](~~434929~~)。'."\n"
.'> - 不同类型的卡片短信模板的内容结构不同,详情请参见[卡片短信模板示例](~~435361~~)。',
'type' => 'object',
'required' => true,
'docRequired' => true,
'example' => '{'."\n"
.' "extendInfo":{'."\n"
.' "scene":"HMOVM图文",'."\n"
.' "purpose":"2",'."\n"
.' "userExt":{'."\n"
.' "outId":"1234554321"'."\n"
.' }'."\n"
.' },'."\n"
.' "templateContent":{'."\n"
.' "pages":['."\n"
.' {'."\n"
.'"tmpCards":['."\n"
.' {'."\n"
.' "type":"IMAGE",'."\n"
.' "srcType":1,'."\n"
.' "src":"28755",'."\n"
.' "actionType":"OPEN_APP",'."\n"
.' "action":{'."\n"
.' "target":"https://s.tb.cn/c.KxzZ",'."\n"
.' "merchantName":"测试-图文模板",'."\n"
.' "packageName":['."\n"
.' "com.taobao.taobao"],'."\n"
.' "floorUrl":"https://s.tb.cn/c.KxzZ"'."\n"
.' },'."\n"
.' "positionNumber":1'."\n"
.' },'."\n"
.' {'."\n"
.' "type":"TEXT",'."\n"
.' "content":"测试- BENZ AMG 2020 试驾邀请",'."\n"
.' "isTextTitle":true,'."\n"
.' "positionNumber":2'."\n"
.' },'."\n"
.' {'."\n"
.' "type":"TEXT",'."\n"
.' "content":"测试-梅赛德斯-奔驰,创新激情永不灭。作为汽车 XXXX",'."\n"
.' "isTextTitle":false,'."\n"
.' "positionNumber":3'."\n"
.' },'."\n"
.' {'."\n"
.' "type":"BUTTON",'."\n"
.' "content":"预约试驾",'."\n"
.' "actionType":"OPEN_BROWSER",'."\n"
.' "action":{'."\n"
.' "target":"https://www.mercedes-benz.com.cn",'."\n"
.' "merchantName":"测试-正在跳转梅赛德斯-奔驰"'."\n"
.'},'."\n"
.' "positionNumber":4'."\n"
.' }]'."\n"
.' }]'."\n"
.' },'."\n"
.' "cardSignName":"阿里云",'."\n"
.' "cardType":5'."\n"
.'}',
],
],
[
'name' => 'Memo',
'in' => 'query',
'schema' => [
'description' => '对上传模板的描述。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '图文类模板',
],
],
[
'name' => 'Factorys',
'in' => 'query',
'schema' => [
'description' => '模板提交的厂商。厂商类型取值:'."\n"
."\n"
.'- **HuaWei**:表示华为厂商。'."\n"
.'- **XiaoMi**:表示小米厂商。'."\n"
.'- **OPPO**:表示OPPO厂商。'."\n"
.'- **VIVO**:表示VIVO厂商。'."\n"
.'- **MEIZU**:表示魅族厂商。'."\n"
.'- **HONOR**:表示荣耀厂商。'."\n"
."\n"
.'> 该参数不填时,系统自动匹配模板支持的手机厂商。',
'type' => 'string',
'required' => false,
'example' => '["HuaWei","XiaoMi"] ',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '数据对象。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。取值:'."\n"
."\n"
.'- OK:代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'TemplateCode' => [
'description' => '卡片短信模板Code。您可以在控制台**卡片短信**[模板管理](https://dysms.console.aliyun.com/domestic/card)页面查看**模板Code**。'."\n"
."\n"
.'>必须是已添加、并通过审核的卡片短信模板。',
'type' => 'string',
'example' => 'CARD_SMS_2****',
],
],
],
],
],
],
],
'errorCodes' => [
200 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TemplateCode\\": \\"CARD_SMS_2****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateCardSmsTemplateResponse>\\n <Code>ok</Code>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>\\n <Success>true</Success>\\n <Data>\\n <TemplateCode>CARD_SMS_600000001</TemplateCode>\\n </Data>\\n</CreateCardSmsTemplateResponse>","errorExample":""}]',
'title' => '创建卡片短信模板',
'description' => '- 目前卡片短信在内部邀约阶段,请联系您的阿里云商务经理申请开通或联系[阿里云售前咨询](https://help.aliyun.com/document_detail/464625.html?spm=a2c4g.11186623.0.0.213273d4Xe6UEu#section-81n-72q-ybm)。'."\n"
."\n"
.'- 保存卡片短信模板信息,提交手机厂商审核,并返回模板Code。'."\n"
.'- 使用CreateCardSmsTemplate创建卡片短信模板,若模板中包含厂商不支持的模板类型或事件时,将不向对应厂商提交审核。更多信息,请参见[厂商支持的模板说明](~~434611~~)。'."\n"
.'- 更多卡片短信模板的示例,请参见[卡片短信模板示例](~~435361~~)。'."\n"
."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为300次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryCardSmsTemplate' => [
'summary' => '查询卡片短信模板审核状态,返回手机厂商审核相关信息。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102452',
'abilityTreeNodes' => [
'FEATUREdysms17QZIS',
],
],
'parameters' => [
[
'name' => 'TemplateCode',
'in' => 'query',
'schema' => [
'description' => '卡片短信模板Code。取值:'."\n"
."\n"
.'- 调用[创建卡片短信模板](~~CreateCardSmsTemplate~~)接口后,返回参数**TemplateCode**即为新创建的卡片短信模板Code。'."\n"
."\n"
.'- 您也可登录控制台[国内卡片短信](https://dysms.console.aliyun.com/domestic/card)页面,在**模板管理**页签查看卡片短信模板Code。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'CARD_SMS_2****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'* 返回OK代表请求成功。'."\n"
.'* 其他错误码,请参见[API错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
],
'Success' => [
'description' => '接口调用是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Templates' => [
'description' => '返回模板列表。'."\n",
'type' => 'array',
'items' => [
'description' => '返回的模板信息,具体信息以实际返回值为准。'."\n"
.'- tmpName:模板名称。'."\n"
.'- tmpCode:模板Code。'."\n"
.'- state:模板审核状态。0:审核中,1:审核通过。2:审核未通过'."\n"
.'- tmpOps:手机厂商审核列表。(state:手机厂商审核状态。vendorCode:手机厂商信息。remark:手机厂商审核意见。)',
'type' => 'object',
'example' => ' {'."\n"
.'"tmpName": "测试",'."\n"
.'"tmpCode": "CARD_SMS_****",'."\n"
.'"state": 1,'."\n"
.'"tmpOps": ['."\n"
.' {'."\n"
.' "tmpOpId": "536363",'."\n"
.' "vendorTmpId": "600302896",'."\n"
.' "remark": "自动审核通过",'."\n"
.' "supplierCode": "MW",'."\n"
.' "state": 1,'."\n"
.' "vendorName": "华为",'."\n"
.' "vendorCode": "HUAWEI"'."\n"
.' }]'."\n"
.'}',
],
],
],
],
],
],
],
],
'errorCodes' => [
200 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Templates\\": [\\n {\\n \\"tmpName\\": \\"测试\\",\\n \\"tmpCode\\": \\"CARD_SMS_****\\",\\n \\"state\\": 1,\\n \\"tmpOps\\": [\\n {\\n \\"tmpOpId\\": \\"536363\\",\\n \\"vendorTmpId\\": \\"600302896\\",\\n \\"remark\\": \\"自动审核通过\\",\\n \\"supplierCode\\": \\"MW\\",\\n \\"state\\": 1,\\n \\"vendorName\\": \\"华为\\",\\n \\"vendorCode\\": \\"HUAWEI\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询卡片短信模板状态',
'description' => '- 未开通卡片短信业务的阿里云账号无法调用此API。'."\n"
.'- 目前卡片短信在内部邀约阶段,请联系您的阿里云商务经理申请开通或[联系阿里云售前咨询](https://help.aliyun.com/document_detail/464625.html)。'."\n"
.'- 您也可登录控制台[国内卡片短信](https://dysms.console.aliyun.com/domestic/card)页面,在模板管理页签内查询卡片短信模板的审核状态。'."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为300次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
],
'CheckMobilesCardSupport' => [
'summary' => '检查手机号码是否支持卡片短信。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '125700',
'abilityTreeNodes' => [
'FEATUREdysmsB35KN5',
],
],
'parameters' => [
[
'name' => 'TemplateCode',
'in' => 'query',
'schema' => [
'description' => '卡片短信模板Code。'."\n"
.'登录短信服务控制台[国内卡片短信](https://dysms.console.aliyun.com/domestic/card)页面,在**模板管理**页签查看卡片短信模板列表。'."\n"
."\n"
.'>必须是已添加、并通过审核的卡片短信模板。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'CARD_SMS_****',
],
],
[
'name' => 'Mobiles',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => '待查询的手机号列表。',
'type' => 'array',
'items' => [
'description' => '待查询的手机号,且该参数的填写格式必须为{"#6#mobile":"1380000****"},否则会报手机号格式错误。一次请求最多支持查询10000个号码。',
'type' => 'object',
'required' => false,
'example' => '{"#6#mobile":"1322587****"}',
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF',
],
'Success' => [
'description' => '接口调用是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回数据。'."\n",
'type' => 'object',
'properties' => [
'queryResult' => [
'description' => '查询结果列表。',
'type' => 'array',
'items' => [
'description' => '查询数据。',
'type' => 'object',
'properties' => [
'mobile' => [
'description' => '手机号码。',
'type' => 'string',
'example' => '1390000****',
],
'support' => [
'description' => '是否支持卡片短信能力。取值:'."\n"
."\n"
.'- **true**:支持卡片短信。'."\n"
."\n"
.'- **false**:不支持卡片短信。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
200 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"queryResult\\": [\\n {\\n \\"mobile\\": \\"1390000****\\",\\n \\"support\\": true\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '检查手机号是否支持卡片短信(旧接口)',
'description' => '- 未开通卡片短信业务的阿里云账号无法调用此API。'."\n"
.'- 目前卡片短信在内部邀约阶段,请联系您的阿里云商务经理申请开通或[联系阿里云售前咨询](https://help.aliyun.com/document_detail/464625.html)。'."\n"
.'- 推荐使用新接口[QueryMobilesCardSupport](~~QueryMobilesCardSupport~~)查询手机号是否支持卡片短信。'."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为2000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
'requestParamsDescription' => '完整请求参数示例:'."\n"
."\n"
.'```'."\n"
.'{'."\n"
.' "Mobiles": ['."\n"
.' {'."\n"
.' "#6#mobile": "137******00"'."\n"
.' },'."\n"
.' {'."\n"
.' "#6#mobile": "130******00"'."\n"
.' }'."\n"
.' ],'."\n"
.' "TemplateCode": "CARD_SMS_6***9"'."\n"
.'}'."\n"
.'```',
],
'QueryMobilesCardSupport' => [
'summary' => '查询手机号是否支持卡片短信。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '161447',
'abilityTreeNodes' => [
'FEATUREdysmsB35KN5',
],
],
'parameters' => [
[
'name' => 'TemplateCode',
'in' => 'query',
'schema' => [
'description' => '卡片短信模板Code。请在控制台选择**国内消息**>[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面查看。'."\n"
."\n"
.'>必须是已添加、并通过审核的卡片短信模板。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'CARD_SMS_2****',
],
],
[
'name' => 'Mobiles',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '手机号列表。',
'type' => 'array',
'items' => [
'description' => '待查询的手机号。一次请求最多支持查询10000个号码。',
'type' => 'object',
'required' => false,
'example' => '{'."\n"
.' "mobile": "138****0000"'."\n"
.'}',
],
'required' => true,
],
],
[
'name' => 'EncryptType',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '手机号码加密方式。取值:'."\n"
.'- SHA1:SHA1加密方式。'."\n"
.'- NORMAL:不加密,明文传输。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'NORMAL',
'maxLength' => 100,
'default' => 'NORMAL',
'enum' => [
'SHA1',
'NORMAL',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回值根对象。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '阿里云为该请求生成的唯一标识符。',
'type' => 'string',
'example' => '08C17DFE-2E10-54F4-BAFB-7180039CC217',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'QueryResult' => [
'description' => '查询值。',
'type' => 'array',
'items' => [
'description' => '查询值。',
'type' => 'object',
'properties' => [
'Mobile' => [
'description' => '查询的手机号码。',
'type' => 'string',
'example' => '1380000****',
],
'Support' => [
'description' => '是否支持卡片短信。取值:'."\n"
."\n"
.'- **true**:支持。'."\n"
.'- **false**:不支持。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
200 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"08C17DFE-2E10-54F4-BAFB-7180039CC217\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"QueryResult\\": [\\n {\\n \\"Mobile\\": \\"1380000****\\",\\n \\"Support\\": true\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询手机号是否支持卡片短信(新接口)',
'description' => '- 未开通卡片短信业务的阿里云账号无法调用此API。'."\n"
.'- 目前卡片短信在内部邀约阶段,请联系您的阿里云商务经理申请开通或[联系阿里云售前咨询](https://help.aliyun.com/document_detail/464625.html)。',
],
'GetCardSmsLink' => [
'summary' => '获取卡片短信短链。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '125584',
'abilityTreeNodes' => [
'FEATUREdysms17QZIS',
],
],
'parameters' => [
[
'name' => 'CardTemplateCode',
'in' => 'query',
'schema' => [
'description' => '卡片短信模板Code。请在控制台[卡片短信>模板管理](https://dysms.console.aliyun.com/domestic/card)页面选择已通过审核的卡片短信模板Code。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'CARD_SMS_****',
],
],
[
'name' => 'OutId',
'in' => 'query',
'schema' => [
'description' => '外部流水扩展字段。',
'type' => 'string',
'required' => false,
'example' => 'BC20220608102511660860762****',
],
],
[
'name' => 'PhoneNumberJson',
'in' => 'query',
'schema' => [
'description' => '手机号码、用户ID或系统内部标识。'."\n"
."\n"
.'> - 最多支持1万个手机号码。'."\n"
.'> - 用户也可自定义标识,长度不超过60个字符。'."\n"
.'> - OPPO厂商的模板一次最多申请10个。',
'type' => 'string',
'required' => false,
'example' => '[\\"1390000****'."\n"
.'\\",\\"1370000****'."\n"
.'\\"]',
],
],
[
'name' => 'SignNameJson',
'in' => 'query',
'schema' => [
'description' => '短信签名名称。'."\n"
.'请在控制台[国内消息>签名管理](https://dysms.console.aliyun.com/domestic/text/sign)页签下**签名名称**一列查看。也可通过[QuerySmsSignList](https://help.aliyun.com/zh/sms/developer-reference/api-dysmsapi-2017-05-25-querysmssignlist?spm=a2c4g.11186623.help-menu-search-44282.d_0)接口查看的短信签名名称。'."\n"
."\n"
.'>必须是已添加、并通过审核的短信签名;且短信签名的个数必须与手机号码的个数相同、内容一一对应。',
'type' => 'string',
'required' => true,
'example' => '[\\"阿里云\\", \\"阿里云2\\"]',
],
],
[
'name' => 'CardTemplateParamJson',
'in' => 'query',
'schema' => [
'description' => '卡片短信动参。',
'type' => 'string',
'required' => false,
'example' => ' [{\\"customUrl\\":\\"https://alibaba.com\\",\\"dyncParams\\": \\"{\\\\\\"动参key\\\\\\":\\\\\\"动参value\\\\\\"}\\"},{\\"customUrl\\":\\"https://alibaba.com\\",\\"dyncParams\\": \\"{\\\\\\"动参key\\\\\\":\\\\\\"动参value\\\\\\"}\\"}]',
],
],
[
'name' => 'CardCodeType',
'in' => 'query',
'schema' => [
'description' => '卡片短信短链编码类型。取值:'."\n"
.'- 1:群发。'."\n"
.'- 2:个性化。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
[
'name' => 'CardLinkType',
'in' => 'query',
'schema' => [
'description' => '卡片短信短链类型。取值:'."\n"
.'- 1:标准生成短码。'."\n"
.'- 2:自定义生成短码。'."\n"
."\n"
.'> **CardLinkType**不填时,默认为标准生成短码。如需生成自定义短码,请联系阿里运营人员进行报备。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'Domain',
'in' => 'query',
'schema' => [
'description' => '发送账号分配的短链域名,需要提前报备。'."\n"
."\n"
.'> - 当**CardLinkType**为**2**时,**Domain**参数必填。'."\n"
.'> - 当**Domain**参数不填时,则使用系统默认域名。长度不超过100个字符。',
'type' => 'string',
'required' => false,
'example' => 'xxx.com',
],
],
[
'name' => 'CustomShortCodeJson',
'in' => 'query',
'schema' => [
'description' => '客户自定义短码。长度为4~8位的数字或字母。'."\n"
."\n"
.'> 当生成类型为自定义生成短码时必填。',
'type' => 'string',
'required' => false,
'example' => 'abCde',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。取值:'."\n"
.'- OK:代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '请求ID。'."\n",
'type' => 'string',
'example' => 'CC89A90C-978F-46AC-B80D-54738371E7CA',
],
'Success' => [
'description' => '接口调用是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'CardTmpState' => [
'description' => '卡片短信模板审核状态。取值:'."\n"
.'- **0**:审核中。'."\n"
.'- **1**:审核通过。'."\n"
.'- **2**:审核不通过。'."\n"
."\n"
.'> 未审核通过的短信走回落流程。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'NotMediaMobiles' => [
'description' => '不支持卡片短信的手机号。',
'type' => 'string',
'example' => '1390000****',
],
'CardPhoneNumbers' => [
'description' => '支持卡片短信的手机号码。',
'type' => 'string',
'example' => '[\\"1390000****\\",\\"1370000****\\"]',
],
'CardSmsLinks' => [
'description' => '卡片短信短链。',
'type' => 'string',
'example' => '[\\"mw2m.cn/LAaGGa\\",\\"mw2m.cn/LAAaes\\"]',
],
'CardSignNames' => [
'description' => '用于申请卡片短信短链的短信签名,在发送时签名、接收号码、卡片短信短链要一一对应。',
'type' => 'string',
'example' => '["阿里云","阿里云2"]',
],
],
],
],
],
],
],
'errorCodes' => [
200 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"CC89A90C-978F-46AC-B80D-54738371E7CA\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CardTmpState\\": 0,\\n \\"NotMediaMobiles\\": \\"1390000****\\",\\n \\"CardPhoneNumbers\\": \\"[\\\\\\\\\\\\\\"1390000****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"1370000****\\\\\\\\\\\\\\"]\\",\\n \\"CardSmsLinks\\": \\"[\\\\\\\\\\\\\\"mw2m.cn/LAaGGa\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mw2m.cn/LAAaes\\\\\\\\\\\\\\"]\\",\\n \\"CardSignNames\\": \\"[\\\\\\"阿里云\\\\\\",\\\\\\"阿里云2\\\\\\"]\\"\\n }\\n}","type":"json"}]',
'title' => '获取卡片短信短链',
'description' => '- 目前卡片短信在内部邀约阶段,请联系您的阿里云商务经理申请开通或联系[阿里云售前咨询](https://help.aliyun.com/document_detail/464625.html?spm=a2c4g.11186623.0.0.213273d4Xe6UEu#section-81n-72q-ybm)。'."\n"
."\n"
.'### QPS限制'."\n"
.'- 本接口的单用户QPS限制为1000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
],
'GetCardSmsDetails' => [
'summary' => '查询单个号码的卡片短信发送记录和发送状态等信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'description' => '分页查看发送记录,指定发送记录的当前页码。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查看发送记录,指定每页显示的卡片短信记录数量。'."\n"
."\n"
.'取值范围为1~50。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
[
'name' => 'SendDate',
'in' => 'query',
'schema' => [
'description' => '卡片短信发送日期,支持查询最近30天的记录。'."\n"
."\n"
.'格式为yyyyMMdd,例如20240112。',
'type' => 'string',
'required' => true,
'example' => '20240112',
],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
'schema' => [
'description' => '接收短信的国内手机号码。格式:11位手机号码,例如1390000****。',
'type' => 'string',
'required' => true,
'example' => '1390000****',
],
],
[
'name' => 'BizCardId',
'in' => 'query',
'schema' => [
'description' => '卡片短信发送ID。通过[SendCardSms](~~434120~~)接口或[SendBatchCardSms](~~434119~~)接口发送卡片短信时,获取返回值中的BizCardId字段。',
'type' => 'string',
'required' => false,
'example' => '123456^0',
],
],
[
'name' => 'BizSmsId',
'in' => 'query',
'schema' => [
'description' => '文本短信发送ID,调用[SendCardSms](~~434120~~)接口或[SendBatchCardSms](~~434119~~)接口发送卡片短信时,获取返回值中的BizSmsId字段。',
'type' => 'string',
'required' => false,
'example' => '1234576^0',
],
],
[
'name' => 'BizDigitId',
'in' => 'query',
'schema' => [
'description' => '数字短信发送ID,调用[SendCardSms](~~434120~~)接口或[SendBatchCardSms](~~434119~~)接口发送卡片短信时,获取返回值中的BizDigitalId字段。',
'type' => 'string',
'required' => false,
'example' => '12346^0',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息。',
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息;只有RAM校验失败才会返回此字段。',
'type' => 'string',
'example' => '无',
],
'Message' => [
'title' => '状态描述',
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK'."\n",
],
'CardSendDetailDTO' => [
'title' => '卡片短信发送结果',
'description' => '卡片短信发送结果。',
'type' => 'object',
'properties' => [
'TotalCount' => [
'title' => '总量',
'description' => '总量。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'PageSize' => [
'title' => '页数',
'description' => '页数。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'CurrentPage' => [
'title' => '页码',
'description' => '页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'Records' => [
'description' => '卡片短信发送记录列表。',
'type' => 'array',
'items' => [
'description' => '卡片短信发送记录。',
'type' => 'object',
'properties' => [
'TemplateCode' => [
'title' => '模板code',
'description' => '模板code。',
'type' => 'string',
'example' => 'CARD_SMS_6***',
],
'RenderDate' => [
'title' => '渲染时间',
'description' => '渲染时间。',
'type' => 'string',
'example' => '2024-09-27 12:13:39',
],
'ReceiveDate' => [
'title' => '接收时间',
'description' => '接收时间。',
'type' => 'string',
'example' => '2024-09-27 11:26:35',
],
'RenderStatus' => [
'title' => '解析状态.。0:未解析;1:解析成功;3:未解析',
'description' => '解析状态。取值:'."\n"
."\n"
.'- 0:未解析;'."\n"
.'- 1:解析成功;'."\n"
.'- 3:未解析。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'ReceiveType' => [
'title' => '接收短信类型',
'description' => '接收短信类型。',
'type' => 'string',
'example' => 'CARD_SMS',
],
'SendStatus' => [
'title' => '发送状态 1:发送中;2:发送失败;3:发送成功;4:寻址失败',
'description' => '发送状态。取值:'."\n"
."\n"
.'- 1:发送中;'."\n"
.'- 2:发送失败;'."\n"
.'- 3:发送成功;'."\n"
.'- 4:寻址失败',
'type' => 'integer',
'format' => 'int64',
'example' => '3',
],
'OutId' => [
'title' => '客户传输outId',
'description' => '客户传输outId。',
'type' => 'string',
'example' => '12345678',
],
'PhoneNumber' => [
'title' => '接收短信手机号',
'description' => '接收短信手机号。',
'type' => 'string',
'example' => '156****9080',
],
'SmsContent' => [
'title' => '短信内容。只有文本短信有值',
'description' => '短信内容。只有文本短信有值。',
'type' => 'string',
'example' => '您收到一条短信消息',
],
'SendDate' => [
'title' => '短信发送时间',
'description' => '短信发送时间。',
'type' => 'string',
'example' => '2024-09-27 11:26:32',
],
'ErrCode' => [
'title' => '发送错误码',
'description' => '发送错误码。',
'type' => 'string',
'example' => 'Success',
],
],
],
'example' => '',
],
],
'example' => '',
],
'Code' => [
'title' => '状态码',
'description' => '请求状态码。'."\n"
.'* 返回OK代表请求成功。'."\n"
.'* 其他错误码,请参见[API错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK'."\n",
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorMessage' => 'Incorrect phone number format.',
'errorCode' => 'InvalidParam.PhoneNumber',
],
[
'errorMessage' => 'PageSize must be less than or equal to 50.',
'errorCode' => 'InvalidParam.PageSize',
],
[
'errorMessage' => 'Only the last 30 days can be queried.',
'errorCode' => 'InvalidParam.SendDate',
],
[
'errorMessage' => 'At most, only one parameter can be passed among bizCardId, bizSmsId, and bizDigitId.',
'errorCode' => 'InvalidParameter',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"OK\\\\n\\",\\n \\"CardSendDetailDTO\\": {\\n \\"TotalCount\\": 10,\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"Records\\": [\\n {\\n \\"TemplateCode\\": \\"CARD_SMS_6***\\",\\n \\"RenderDate\\": \\"2024-09-27 12:13:39\\",\\n \\"ReceiveDate\\": \\"2024-09-27 11:26:35\\",\\n \\"RenderStatus\\": 1,\\n \\"ReceiveType\\": \\"CARD_SMS\\",\\n \\"SendStatus\\": 3,\\n \\"OutId\\": \\"12345678\\",\\n \\"PhoneNumber\\": \\"156****9080\\",\\n \\"SmsContent\\": \\"您收到一条短信消息\\",\\n \\"SendDate\\": \\"2024-09-27 11:26:32\\",\\n \\"ErrCode\\": \\"Success\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '查询单个号码的卡片短信发送记录和发送状态等信息',
],
'QueryCardSmsTemplateReport' => [
'summary' => '查询卡片短信指定模板的解析数据,解析数据包括短信解析回执成功数、消息曝光次数和消息点击数等。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '118232',
'abilityTreeNodes' => [
'FEATUREdysms3V8ND3',
],
],
'parameters' => [
[
'name' => 'TemplateCodes',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => '卡片短信对象。',
'type' => 'array',
'items' => [
'description' => '卡片短信模板Code。请在控制台**国内消息**页面中的**模板管理**页签下**模板CODE**一列查看。'."\n"
."\n"
.'>必须是已添加、并通过审核的卡片短信模板。',
'type' => 'string',
'required' => false,
'example' => 'CARD_SMS_391',
],
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'description' => '开始时间,格式为yyyy-MM-dd HH:mm:ss',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2020-10-10 00:00:01',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'description' => '结束时间,格式为yyyy-MM-dd HH:mm:ss',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2020-10-11 00:00:01',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '数据对象。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
."\n"
.'- 其他错误码请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'B71F06CA-7735-183A-B52E-234EF8AFE14B',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'model' => [
'description' => '返回数据列表。',
'type' => 'array',
'items' => [
'description' => '返回数据明细。'."\n"
.'- tmpCode:模板Code。'."\n"
.'- date:数据日期。格式为yyyy-MM-dd HH:mm:ss'."\n"
.'- rptSuccessCount:短信解析回执成功数。'."\n"
.'- exposeUv:消息曝光数。'."\n"
.'- exposePv:消息曝光次数。'."\n"
.'- clickUv:消息点击数。'."\n"
.'- clickPv:消息点击次数。'."\n"
.'- facPvUvList:厂商信息列表。',
'type' => 'object',
],
'enumValueTitles' => [],
],
],
],
],
],
],
],
'errorCodes' => [
200 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"B71F06CA-7735-183A-B52E-234EF8AFE14B\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"model\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryCardSmsTemplateReportResponse>\\n <Code>ok</Code>\\n <RequestId>12343</RequestId>\\n <Success>true</Success>\\n <Data/>\\n</QueryCardSmsTemplateReportResponse>","errorExample":""}]',
'title' => '查询卡片短信指定模板的解析数据',
'description' => '### QPS限制'."\n"
.'本接口的单用户QPS限制为300次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
],
'SendCardSms' => [
'summary' => '发送卡片短信。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '102463',
'abilityTreeNodes' => [
'FEATUREdysmsB35KN5',
],
],
'parameters' => [
[
'name' => 'CardObjects',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => '卡片短信对象。',
'type' => 'array',
'items' => [
'description' => '卡片短信对象。',
'type' => 'object',
'properties' => [
'customUrl' => [
'description' => '渲染失败后跳转链接。',
'type' => 'string',
'required' => false,
'example' => 'https://alibaba.com',
],
'dyncParams' => [
'description' => '动态参数。动参变量不需要${}',
'type' => 'string',
'required' => false,
'example' => '{"param3":"李四3","param1":"李四","param2":"李四2"}',
],
'mobile' => [
'description' => '接收卡片短信的手机号码。',
'type' => 'string',
'required' => false,
'example' => '1390000****',
],
],
'required' => false,
],
'required' => true,
'docRequired' => true,
'example' => 'SendCardSms',
],
],
[
'name' => 'SignName',
'in' => 'query',
'schema' => [
'description' => '短信签名名称。您可以通过[QuerySmsSignList](~~419282~~)接口查询当前账号已申请的签名或在[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/sign)查看签名列表。'."\n"
.'>必须是通过审核的短信签名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '阿里云',
],
],
[
'name' => 'CardTemplateCode',
'in' => 'query',
'schema' => [
'description' => '卡片短信模板Code。请在控制台**卡片短信**[模板管理](https://dysms.console.aliyun.com/domestic/card)页面选择已通过审核的卡片短信模板Code。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'CARD_SMS_70',
],
],
[
'name' => 'SmsTemplateCode',
'in' => 'query',
'schema' => [
'description' => '回落文本短信的模板Code。**FallbackType**选择**SMS**回落文本短信时,此参数必填。'."\n"
."\n"
.'您可以通过[QuerySmsTemplateList](~~419288~~)接口查询当前账号已申请的模板或在[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/template)查看模板列表。'."\n"
.'>必须是已添加、并通过审核的短信模板。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'SMS_48068****',
],
],
[
'name' => 'SmsUpExtendCode',
'in' => 'query',
'schema' => [
'description' => '上行短信扩展码。上行短信,指发送给通信服务提供商的短信,用于定制某种服务、完成查询,或是办理某种业务等,需要收费的,按运营商普通短信资费进行扣费。'."\n"
.'>无上述需求的用户请忽略此字段。',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'FallbackType',
'in' => 'query',
'schema' => [
'description' => '回落类型。取值:'."\n"
.'- **SMS**:不支持卡片短信的号码,回落文本短信。'."\n"
.'- **DIGITALSMS**:不支持卡片短信的号码,回落数字短信。'."\n"
.'- **NONE**:不需要回落。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'SMS',
],
],
[
'name' => 'DigitalTemplateCode',
'in' => 'query',
'schema' => [
'description' => '回落数字短信的模板Code。**FallbackType**选择**DIGITALSMS**回落数字短信时,此参数必填。'."\n"
."\n"
.'您可在控制台**数字短信**[模板管理](https://dysms.console.aliyun.com/domestic/digit)页面查看数字短信模板列表。'."\n"
."\n"
.'>必须是已添加、并通过审核的数字短信模板。',
'type' => 'string',
'required' => false,
'example' => 'DIGITAL_SMS_31359****',
],
],
[
'name' => 'OutId',
'in' => 'query',
'schema' => [
'description' => '预留给调用方使用的ID。',
'type' => 'string',
'required' => false,
'example' => '38d76c9b-4a9a-4c89-afae-61fd8e0e****',
],
],
[
'name' => 'SmsTemplateParam',
'in' => 'query',
'schema' => [
'description' => '回落文本短信的模板变量对应的实际值。**SmsTemplateCode**回落的文本短信模板内含有变量时,此参数必填。'."\n"
."\n"
.'>如果JSON中需要带换行符,请参照标准的JSON协议处理。',
'type' => 'string',
'required' => false,
'example' => '{"jifen":"积分"}',
],
],
[
'name' => 'DigitalTemplateParam',
'in' => 'query',
'schema' => [
'description' => '回落数字短信的模板变量对应的实际值。**DigitalTemplateCode**回落的数字短信模板内含有变量时,此参数必填。'."\n"
."\n"
.'>如果JSON中需要带换行符,请参照标准的JSON协议处理。',
'type' => 'string',
'required' => false,
'example' => '{"msg","xxxd"}',
],
],
[
'name' => 'TemplateCode',
'in' => 'query',
'schema' => [
'description' => '自定义发送内容模板CODE。'."\n"
."\n"
.'自定义内容会按照选定的文本短信模板+卡片解析链接的形式下发到终端,您可以登录[短信服务控制台](https://dysms.console.aliyun.com/overview),选择**国内消息**或**国际/港澳台短信**,在**模板管理**页签下查看**模板CODE**。'."\n"
."\n"
.'> - 必须是已添加、并通过审核的模板CODE;且发送国际/港澳台消息时,请使用国际/港澳台短信模版。'."\n"
.'> - 例如:选择的文本短信模板内容为:您有一条消息待查收;卡片解析链接为:`1*.cn/2**d`。最终下发内容:`您有一条消息待查收1*.cn/2**d`。请在下发前做好测试和字数控制。',
'type' => 'string',
'required' => false,
'example' => 'SMS_2322****',
],
],
[
'name' => 'TemplateParam',
'in' => 'query',
'schema' => [
'description' => '自定义发送内容模板变量对应的实际值。**TemplateCode**填入包含变量的短信模板时,此参数必填。'."\n"
."\n"
.'>如果JSON中需要带换行符,请参照标准的JSON协议处理。',
'type' => 'string',
'required' => false,
'example' => '{'."\n"
.' "code": "1111"'."\n"
.'}',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
.'* 返回OK代表请求成功。'."\n"
.'* 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D28D0',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回数据。'."\n",
'type' => 'object',
'properties' => [
'MediaMobiles' => [
'description' => '接收卡片短信的手机号。',
'type' => 'string',
'example' => '1390000****',
],
'BizCardId' => [
'description' => '卡片短信发送ID。',
'type' => 'string',
'example' => '123',
],
'BizDigitalId' => [
'description' => '数字短信发送ID。',
'type' => 'string',
'example' => '232',
],
'CardTmpState' => [
'description' => '卡片短信模板审核状态。取值:'."\n"
.'- **0**:审核中。'."\n"
.'- **1**:审核通过。'."\n"
.'- **2**:审核不通过。'."\n"
.'> 审核不通过的短信可通过**FallbackType**字段设置回落流程。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'NotMediaMobiles' => [
'description' => '回落的手机号。',
'type' => 'string',
'example' => '1390000****',
],
'BizSmsId' => [
'description' => '文本短信发送ID。',
'type' => 'string',
'example' => '524',
],
],
],
],
],
],
],
'errorCodes' => [
200 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D28D0\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MediaMobiles\\": \\"1390000****\\",\\n \\"BizCardId\\": \\"123\\",\\n \\"BizDigitalId\\": \\"232\\",\\n \\"CardTmpState\\": 0,\\n \\"NotMediaMobiles\\": \\"1390000****\\",\\n \\"BizSmsId\\": \\"524\\"\\n }\\n}","type":"json"}]',
'title' => '发送卡片短信',
'description' => '- 发送卡片短信为计费接口,卡片短信发送失败或渲染失败时不计费,详情请参见[多媒体短信定价](~~437951~~)。'."\n"
.'- 目前卡片短信在内部邀约阶段,请联系您的阿里云商务经理申请开通或联系[阿里云售前咨询](https://help.aliyun.com/document_detail/464625.html?spm=a2c4g.11186623.0.0.213219fcSn2Ykj#section-81n-72q-ybm)。'."\n"
.'- 卡片短信超时时间建议设置为≥3S;发生超时失败的情况时,建议查看回执状态后再判断是否重试。同时建议您在调用此接口时,不要开启SDK重试逻辑,否则可能会造成多次发送的情况。超时和重试的相关设置,请参见[超时机制](~~262079~~)、[重试机制](~~262080~~)。'."\n"
.'- 国内短信、国际短信及多媒体短信目前均不支持幂等的能力,请您做好幂等控制,防止因多次重试而导致的重复操作问题。'."\n"
.'- 发送卡片短信前需添加卡片短信模板且模板审核通过。本接口在发送短信时,会校验号码是否支持卡片短信。如果该手机号不支持发送卡片短信,可在接口中设置是否接受数字短信和文本短信的回落,提升发送的触达率。'."\n"
."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为1000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
],
'SendBatchCardSms' => [
'summary' => '批量发送卡片短信。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '125151',
'abilityTreeNodes' => [
'FEATUREdysmsB35KN5',
],
],
'parameters' => [
[
'name' => 'CardTemplateCode',
'in' => 'query',
'schema' => [
'description' => '卡片短信模板Code。请在控制台**卡片短信**[模板管理](https://dysms.console.aliyun.com/domestic/card)页面选择**已通过审核**的卡片短信模板Code。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'CARD_SMS_3**5',
],
],
[
'name' => 'SmsTemplateCode',
'in' => 'query',
'schema' => [
'description' => '回落文本短信的模板Code。**FallbackType**选择**SMS**回落文本短信时,此参数必填。'."\n"
."\n"
.'您可以通过[QuerySmsTemplateList](~~419288~~)接口查询当前账号已申请的模板或在[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/template)查看模板列表。'."\n"
.'>必须是已添加、并通过审核的短信模板。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'SMS_23425****',
],
],
[
'name' => 'FallbackType',
'in' => 'query',
'schema' => [
'description' => '回落类型。取值:'."\n"
.'- **SMS**:不支持卡片短信的号码,回落文本短信。'."\n"
.'- **DIGITALSMS**:不支持卡片短信的号码,回落数字短信。'."\n"
.'- **NONE**:不需要回落。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'SMS',
],
],
[
'name' => 'DigitalTemplateCode',
'in' => 'query',
'schema' => [
'description' => '回落数字短信的模板Code。**FallbackType**选择**DIGITALSMS**回落数字短信时,此参数必填。'."\n"
."\n"
.'您可在控制台**国内数字短信**[模板管理](https://dysms.console.aliyun.com/domestic/digit)页面查看数字短信模板列表。'."\n"
.'>必须是已添加、并通过审核的数字短信模板。',
'type' => 'string',
'required' => false,
'example' => 'DIGITAL_SMS_23408****',
],
],
[
'name' => 'OutId',
'in' => 'query',
'schema' => [
'description' => '预留给调用方使用的ID。',
'type' => 'string',
'required' => false,
'example' => '16545681783595370',
],
],
[
'name' => 'PhoneNumberJson',
'in' => 'query',
'schema' => [
'description' => '接收短信的手机号码。',
'type' => 'string',
'required' => true,
'example' => '["1390000****","1370000****"]',
],
],
[
'name' => 'SignNameJson',
'in' => 'query',
'schema' => [
'description' => '短信签名名称。'."\n"
.'您可以通过[QuerySmsSignList](~~419282~~)接口查询当前账号已申请的签名或在[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/sign)查看签名列表。'."\n"
.'>必须是已添加、并通过审核的短信签名;且短信签名的个数必须与手机号码的个数相同、内容一一对应。',
'type' => 'string',
'required' => true,
'example' => '["阿里云","阿里巴巴"]',
],
],
[
'name' => 'CardTemplateParamJson',
'in' => 'query',
'schema' => [
'description' => '卡片短信模板参数对应的实际值。**CardTemplateCode**卡片短信模板内含有变量时,此参数必填。'."\n"
."\n"
.'>如果JSON中需要带换行符,请参照标准的JSON协议处理。',
'type' => 'string',
'required' => false,
'example' => '[{"customurl":"http://www.alibaba.com","dyncParams":"{"a":"hello","b":"world"}"}]',
],
],
[
'name' => 'SmsTemplateParamJson',
'in' => 'query',
'schema' => [
'description' => '文本短信模板参数对应的实际值。**SmsTemplateCode**回落的文本短信模板内含有变量时,此参数必填。'."\n"
."\n"
.'>如果JSON中需要带换行符,请参照标准的JSON协议处理。',
'type' => 'string',
'required' => false,
'example' => '[{"a":1,"b":2},{"a":9,"b":8}]',
],
],
[
'name' => 'DigitalTemplateParamJson',
'in' => 'query',
'schema' => [
'description' => '数字短信模板参数对应的实际值。**DigitalTemplateCode**回落的数字短信模板内含有变量时,此参数必填。'."\n"
.'>如果JSON中需要带换行符,请参照标准的JSON协议处理。',
'type' => 'string',
'required' => false,
'example' => '[{"a":1,"b":2},{"a":9,"b":8}]',
],
],
[
'name' => 'SmsUpExtendCodeJson',
'in' => 'query',
'schema' => [
'description' => '上行短信扩展码。',
'type' => 'string',
'required' => false,
'example' => '[\\"6\\",\\"6\\"]',
],
],
[
'name' => 'TemplateCode',
'in' => 'query',
'schema' => [
'description' => '自定义发送内容模板CODE。'."\n"
."\n"
.'自定义内容会按照选定的文本短信模板+卡片解析链接的形式下发到终端,您可以登录[短信服务控制台](https://dysms.console.aliyun.com/overview),选择**国内消息**或**国际/港澳台短信**,在**模板管理**页面查看**模板CODE**。'."\n"
."\n"
.'> - 必须是已添加、并通过审核的短信模板;且发送国际/港澳台消息时,请使用国际/港澳台短信模板。'."\n"
.'> - 例如:选择的文本短信模板内容为:您有一条消息待查收;卡片解析链接为:`1*.cn/2**d`。最终下发内容:`您有一条消息待查收1*.cn/2**d`。请在下发前做好测试和字数控制。',
'type' => 'string',
'required' => false,
'example' => 'SMS_20375****',
],
],
[
'name' => 'TemplateParamJson',
'in' => 'query',
'schema' => [
'description' => '自定义发送内容模板变量对应的实际值。**TemplateCode**填入包含变量的短信模板时,此参数必填。'."\n"
."\n"
.'> - 如果JSON中需要带换行符,请参照标准的JSON协议处理;'."\n"
.'> - 模板变量值的个数必须与手机号码、签名的个数相同、内容一一对应,表示向指定手机号码中发对应签名的短信,且短信模板中的变量参数替换为对应的值。',
'type' => 'string',
'required' => false,
'example' => '[{"name":"TemplateParamJson"},{"name":"TemplateParamJson"}]',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
.'* 返回OK代表请求成功。'."\n"
.'* 其他错误码,请参见[API错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回数据。'."\n",
'type' => 'object',
'properties' => [
'MediaMobiles' => [
'description' => '接收卡片短信的手机号。',
'type' => 'string',
'example' => '1390000****',
],
'BizCardId' => [
'description' => '卡片短信发送ID。',
'type' => 'string',
'example' => '123',
],
'BizDigitalId' => [
'description' => '数字短信发送ID。',
'type' => 'string',
'example' => '3214',
],
'CardTmpState' => [
'description' => '卡片短信模板审核状态。取值:'."\n"
.'- **0**:审核中。'."\n"
.'- **1**:审核通过。'."\n"
.'- **2**:审核不通过。'."\n"
.'> 审核不通过的短信可通过**FallbackType**字段设置回落流程。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'NotMediaMobiles' => [
'description' => '回落的手机号。',
'type' => 'string',
'example' => '1390000****',
],
'BizSmsId' => [
'description' => '文本短信发送ID。',
'type' => 'string',
'example' => '3256',
],
],
],
],
],
],
],
'errorCodes' => [
200 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MediaMobiles\\": \\"1390000****\\",\\n \\"BizCardId\\": \\"123\\",\\n \\"BizDigitalId\\": \\"3214\\",\\n \\"CardTmpState\\": 0,\\n \\"NotMediaMobiles\\": \\"1390000****\\",\\n \\"BizSmsId\\": \\"3256\\"\\n }\\n}","type":"json"}]',
'title' => '批量发送卡片短信',
'description' => '- 发送卡片短信为计费接口,卡片短信发送失败或渲染失败时不计费,详情请参见[多媒体短信定价](~~437951~~)。'."\n"
.'- 目前卡片短信在内部邀约阶段,请联系您的阿里云商务经理申请开通或联系[阿里云售前咨询](https://help.aliyun.com/document_detail/464625.html?spm=a2c4g.11186623.0.0.213219fcSn2Ykj#section-81n-72q-ybm)。'."\n"
.'- 卡片短信超时时间建议设置为≥3S;发生超时失败的情况时,建议查看回执状态后再判断是否重试。同时建议您在调用此接口时,不要开启SDK重试逻辑,否则可能会造成多次发送的情况。超时和重试的相关设置,请参见[超时机制](~~262079~~)、[重试机制](~~262080~~)。'."\n"
.'- 国内短信、国际短信及多媒体短信目前均不支持幂等的能力,请您做好幂等控制,防止因多次重试而导致的重复操作问题。'."\n"
.'- 发送卡片短信前需添加卡片短信模板且模板审核通过。本接口在发送短信时,会校验号码是否支持卡片短信。如果该手机号不支持发送卡片短信,可在接口中设置是否接受数字短信和文本短信的回落,提升发送的触达率。'."\n"
.'- 批量发送卡片短信,每个号码可以使用不同的签名,不同的回落。在一次请求中,最多可以向100个手机号码分别发送卡片短信。'."\n"
."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为1000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
],
'GetQualificationOssInfo' => [
'summary' => '获取资质材料OSS资源配置信息,此配置信息将用于后续授权委托书、企业证件等资质文件的上传操作。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '264692',
'abilityTreeNodes' => [
'FEATUREdysmsJ2BZAJ',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'BizType',
'in' => 'query',
'schema' => [
'title' => '业务,非空',
'description' => '业务类型。申请资质或创建授权委托书文件时请填写**dysms**。',
'type' => 'string',
'required' => true,
'example' => 'dysms',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'title' => '',
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA',
],
'Message' => [
'title' => '',
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Data' => [
'title' => '',
'description' => 'OSS配置信息。',
'type' => 'object',
'properties' => [
'Policy' => [
'title' => '策略',
'description' => '签名策略。',
'type' => 'string',
'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0wOVQxMTo1NTozOS4wMDFaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0seyJidWNrZXQiOiJhbGljb20tZmMtbWVkaWEifSxbImVxIiwiJGtleSIsIjEwMDAwMDM1ODA4MjA2M1wv********',
],
'Expire' => [
'title' => '过期时间',
'description' => '过期时间戳,单位:秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1741521339',
],
'StartPath' => [
'title' => '前缀',
'description' => '策略路径。',
'type' => 'string',
'example' => '1000********001',
],
'AccessKeyId' => [
'title' => 'ak',
'description' => '签名使用的 AccessKey ID。',
'type' => 'string',
'example' => 'bypFNbG******',
],
'Signature' => [
'title' => '签名',
'description' => '根据AccessKey Secret和Policy计算出的签名信息。调用OSS API时,OSS验证该签名信息,从而确认请求的合法性。',
'type' => 'string',
'example' => 'QvNTGC9DSLTeByP+ZWW******',
],
'Host' => [
'title' => '域名',
'description' => 'Host 地址。',
'type' => 'string',
'example' => 'http://***.oss-cn-zhangjiakou.aliyuncs.com',
],
],
'example' => '',
],
'Code' => [
'title' => '',
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[API错误码](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '',
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'OssBiztypeNotSupportError',
'errorMessage' => 'Retrieving OSS configuration does not support this biz type.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"25D5AFDE-8EBC-132E-8909-1FDC071DA\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0wOVQxMTo1NTozOS4wMDFaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0seyJidWNrZXQiOiJhbGljb20tZmMtbWVkaWEifSxbImVxIiwiJGtleSIsIjEwMDAwMDM1ODA4MjA2M1wv********\\",\\n \\"Expire\\": 1741521339,\\n \\"StartPath\\": \\"1000********001\\",\\n \\"AccessKeyId\\": \\"bypFNbG******\\",\\n \\"Signature\\": \\"QvNTGC9DSLTeByP+ZWW******\\",\\n \\"Host\\": \\"http://***.oss-cn-zhangjiakou.aliyuncs.com\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '获取资质材料/授权书OSS配置信息',
'description' => '- 您在申请资质/签名时,若用途为他用或涉及第三方,需要提供[授权委托书](~~56741~~)。'."\n"
.'- 请使用本接口获取OSS资源配置信息后,通过OSS上传相关资质材料。具体操作,可参见[通过OSS上传文件](~~2833114~~)。'."\n"
.'- 待上传的文件命名不支持包含中文和特殊符号。',
],
'GetOSSInfoForUploadFile' => [
'summary' => '获取OSS资源配置信息,此配置信息将用于后续OSS文件上传操作。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '218013',
'abilityTreeNodes' => [
'FEATUREdysms2H0K7P',
'FEATUREdysmsJ2BZAJ',
],
],
'parameters' => [
[
'name' => 'BizType',
'in' => 'query',
'schema' => [
'description' => '业务类型,默认值为**fcMediaSms**。'."\n"
."\n"
.'创建签名、创建模板时,上传**更多资料**场景,该值为**fcMediaSms**。',
'type' => 'string',
'required' => false,
'example' => 'fcMediaSms',
'default' => 'fcMediaSms',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => 'A90E4451-FED7-49D2-87C8-00700EDCFD0D',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Model' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'Policy' => [
'description' => '签名策略。',
'type' => 'string',
'example' => 'eyJleHBpcmF0aW9uIjoiMjAyN***Ni0yNVQwNjozNzoyNS45NzBaI**iY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0sWyJzdGFydHMtd2l0***sIiRrZXkiLCIiXV19',
],
'StartPath' => [
'description' => '策略路径。',
'type' => 'string',
'example' => '123456',
],
'AccessKeyId' => [
'description' => '签名使用的AccessKey ID。',
'type' => 'string',
'example' => 'LTAI************'."\n",
],
'Signature' => [
'description' => '根据**AccessKey Secret**和**Policy**计算出的签名信息。调用OSS API时,OSS验证该签名信息,从而确认Post请求的合法性。',
'type' => 'string',
'example' => 'BXnwCWPrhVb*****aoZHZfli5KE=',
],
'Host' => [
'description' => 'Host地址。',
'type' => 'string',
'example' => 'https://alicom-fc-media.oss-cn-zhangjiakou.aliyuncs.com',
],
'ExpireTime' => [
'description' => '到期时间。',
'type' => 'string',
'example' => '1719297445',
],
],
],
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](https://help.aliyun.com/document_detail/101346.htm)。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '接口调用是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700EDCFD0D\\",\\n \\"Message\\": \\"OK\\",\\n \\"Model\\": {\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyN***Ni0yNVQwNjozNzoyNS45NzBaI**iY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0sWyJzdGFydHMtd2l0***sIiRrZXkiLCIiXV19\\",\\n \\"StartPath\\": \\"123456\\",\\n \\"AccessKeyId\\": \\"LTAI************\\\\n\\",\\n \\"Signature\\": \\"BXnwCWPrhVb*****aoZHZfli5KE=\\",\\n \\"Host\\": \\"https://alicom-fc-media.oss-cn-zhangjiakou.aliyuncs.com\\",\\n \\"ExpireTime\\": \\"1719297445\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '获取签名/模板材料OSS配置信息',
'description' => '- 您在创建签名或模板时,可上传带有链接的登录页面、后台页面截图、软著、协议补充等资料。有助于审核人员了解您的业务详情。如果是多个资料,可拼成一个文件,支持png、jpg、jpeg、doc、docx、pdf格式。'."\n"
."\n"
.'- 创建签名或模板所需的更多资料,可上传到OSS文件系统保存。文件上传操作,请参见[OSS上传文件](~~2833114~~)。',
],
'GetSmsOcrOssInfo' => [
'summary' => '获取 OCR 的 OSS 信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '287263',
'abilityTreeNodes' => [
'FEATUREdysms2H0K7P',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'TaskType',
'in' => 'query',
'schema' => [
'title' => 'OCR任务类型',
'description' => 'OCR任务类型。可选值:'."\n"
.'- ICP_DOMAIN(域名类型链接ICP备案截图)',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'ICP_DOMAIN' => '域名类型链接ICP备案截图',
],
'example' => 'ICP_DOMAIN',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有 RAM 校验失败才会返回此字段。',
'type' => 'string',
'example' => 'None',
],
'RequestId' => [
'title' => '',
'description' => '本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => '25D5AFDE-xxxx-132E-8909-1FDC071DA',
],
'Message' => [
'title' => '',
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Model' => [
'title' => '',
'description' => 'OSS配置信息。',
'type' => 'object',
'properties' => [
'Policy' => [
'title' => '',
'description' => '签名策略。',
'type' => 'string',
'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0wOVQxMTo1NTozOS4wMDFaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0seyJidWNrZXQiOiJhbGljb20tZmMtbWVkaWEifSxbImVxIiwiJGtleSIsIjEwMDAwMDM1ODA4MjA2M1wv********',
],
'StartPath' => [
'title' => '',
'description' => '策略路径。',
'type' => 'string',
'example' => '1000********001',
],
'Bucket' => [
'title' => '',
'description' => 'bucket名称。',
'type' => 'string',
'example' => '示例值',
],
'AccessKeyId' => [
'title' => '',
'description' => '签名使用的 AccessKey ID。',
'type' => 'string',
'example' => 'bypFNbG******',
],
'Signature' => [
'title' => '',
'description' => '根据 AccessKey Secret 和 Policy 计算出的签名信息。调用 OSS API 时,OSS 验证该签名信息,从而确认请求的合法性。',
'type' => 'string',
'example' => 'QvNTGC9DSLTeByP+ZWW******',
],
'Host' => [
'title' => '',
'description' => 'Host 地址。',
'type' => 'string',
'example' => 'http://***.oss-cn-zhangjiakou.aliyuncs.com',
],
'ExpireTime' => [
'title' => '',
'description' => '过期时间戳,单位:秒。',
'type' => 'string',
'example' => '1741521339',
],
],
'example' => '',
],
'Code' => [
'title' => '',
'description' => '请求状态码。'."\n"
."\n"
.'- 返回 OK 代表请求成功。'."\n"
."\n"
.'- 其他错误码,请参见 [API 错误码](https://help.aliyun.com/zh/sms/developer-reference/api-error-codes)。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '',
'description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- true:调用成功。'."\n"
."\n"
.'- false:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"25D5AFDE-xxxx-132E-8909-1FDC071DA\\",\\n \\"Message\\": \\"OK\\",\\n \\"Model\\": {\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0wOVQxMTo1NTozOS4wMDFaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0seyJidWNrZXQiOiJhbGljb20tZmMtbWVkaWEifSxbImVxIiwiJGtleSIsIjEwMDAwMDM1ODA4MjA2M1wv********\\",\\n \\"StartPath\\": \\"1000********001\\",\\n \\"Bucket\\": \\"示例值\\",\\n \\"AccessKeyId\\": \\"bypFNbG******\\",\\n \\"Signature\\": \\"QvNTGC9DSLTeByP+ZWW******\\",\\n \\"Host\\": \\"http://***.oss-cn-zhangjiakou.aliyuncs.com\\",\\n \\"ExpireTime\\": \\"1741521339\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '获取OCR图片识别OSS信息',
],
'SmsConversionIntl' => [
'summary' => '将每一条消息ID(MessageId) 对应短信的接收情况反馈给阿里云国际短信平台。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '176603',
'abilityTreeNodes' => [
'FEATUREdysmsWO2BNU',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'MessageId',
'in' => 'query',
'schema' => [
'description' => '消息ID。',
'type' => 'string',
'required' => true,
'example' => '1008030300****'."\n",
],
],
[
'name' => 'Delivered',
'in' => 'query',
'schema' => [
'description' => '如果您的用户回复了您发送的消息,则设置为 true。否则,设置为 false。',
'type' => 'boolean',
'required' => true,
'example' => 'true',
],
],
[
'name' => 'ConversionTime',
'in' => 'query',
'schema' => [
'description' => '触达发送目标的时间戳。必须是Unix时间戳,毫秒级别长整型。'."\n"
."\n"
.'- 如果不指定该字段:默认当前的时间戳。'."\n"
."\n"
.'- 如果指定该字段:该时间戳必须大于发送时间并且小于当前时间戳。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1349055900000',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '接口返回参数。',
'type' => 'object',
'properties' => [
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D****'."\n",
],
'Code' => [
'description' => '状态码。返回OK代表请求成功,其他错误码,请参见[错误码列表](https://help.aliyun.com/document_detail/101346.html?spm=a2c4g.101345.0.0.74326ff2J5EZyt)。',
'type' => 'string',
'example' => 'OK',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D****\\\\n\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
'title' => '国内发国际短信转化反馈',
'description' => '指标说明:'."\n"
."\n"
.'- OTP发送量:验证码发送量。'."\n"
."\n"
.'- OTP转化量:验证码转换量。(用户成功获取验证码,并进行回传)'."\n"
."\n"
.'转化率=OTP转化量/OTP发送量。'."\n"
."\n"
.'> 转化率反馈功能会对业务系统有一定的侵入性,为了防止调用转化率API的抖动影响业务逻辑,请考虑: - 使用异步模式(例如:队列或事件驱动)调用API。 - 添加可降级的方案保护业务逻辑(例如:手动降级开工或者使用断路器自动降级)。',
],
'ConversionDataIntl' => [
'summary' => '将短信转化率统计数据反馈给阿里云短信平台。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '176602',
'abilityTreeNodes' => [
'FEATUREdysmsWO2BNU',
],
],
'parameters' => [
[
'name' => 'ReportTime',
'in' => 'query',
'schema' => [
'description' => '转化率观测的时间点。必须是Unix时间戳,毫秒级别长整型。'."\n"
."\n"
.'>如果不指定该字段:默认当前的时间戳。'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1349055900000',
],
],
[
'name' => 'ConversionRate',
'in' => 'query',
'schema' => [
'description' => '转化率监控回报值。'."\n"
.'>该参数取值为double类型 ,区间是\\[0,1]。',
'type' => 'string',
'required' => true,
'example' => '0.53',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF'."\n",
],
'Code' => [
'description' => '状态码。取值:'."\n"
."\n"
.'- OK:代表请求成功。'."\n"
."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\\\n\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
'title' => '国内发国际转化率数据接入API',
'description' => '指标说明:转化率=OTP 转化量/OTP 发送量。'."\n"
.'- OTP发送量:验证码发送量。'."\n"
.'- OTP转化量:验证码转换量。(用户成功获取验证码,并进行回传)'."\n"
.'>转化率反馈功能会对业务系统有一定的侵入性,为了防止调用转化率 API 的抖动影响业务逻辑,请考虑: '."\n"
.'>- 使用异步模式(例如:队列或事件驱动)调用 API。 '."\n"
.'>- 添加可降级的方案保护业务逻辑(例如:手动降级开工或者使用断路器自动降级)。',
],
'AddShortUrl' => [
'summary' => '创建短链。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102437',
'abilityTreeNodes' => [
'FEATUREdysmsQAI8QG',
],
],
'parameters' => [
[
'name' => 'SourceUrl',
'in' => 'formData',
'schema' => [
'description' => '原始链接地址。不超过1000个字符。'."\n"
.'><notice>短信服务暂时不支持使用此接口。></notice>',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'https://www.****.com/product/sms',
],
],
[
'name' => 'ShortUrlName',
'in' => 'formData',
'schema' => [
'description' => '短链服务名称。不超过13个字符。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '阿里短链测试',
],
],
[
'name' => 'EffectiveDays',
'in' => 'formData',
'schema' => [
'description' => '短链服务使用有效期。单位为天,有效期最长为90天。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '7',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF',
],
'Data' => [
'description' => '短链详情。',
'type' => 'object',
'properties' => [
'SourceUrl' => [
'description' => '原始链接地址。',
'type' => 'string',
'example' => 'https://www.****.com/product/sms',
],
'ExpireDate' => [
'description' => '短链服务使用失效时间。'."\n"
."\n"
.'> **ExpireDate**值为整点时间。',
'type' => 'string',
'example' => '2021-09-19 00:00:00',
],
'ShortUrl' => [
'description' => '生成的短链服务地址。',
'type' => 'string',
'example' => 'http://****.cn/6y8uy7',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\",\\n \\"Data\\": {\\n \\"SourceUrl\\": \\"https://www.****.com/product/sms\\",\\n \\"ExpireDate\\": \\"2021-09-19 00:00:00\\",\\n \\"ShortUrl\\": \\"http://****.cn/6y8uy7\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddShortUrlResponse>\\n<Message>OK</Message>\\n<RequestId>819BE656-D2E0-4858-8B21-B2E477085AAF</RequestId>\\n<Data>\\n <SourceUrl>https://www.****.com/product/sms</SourceUrl>\\n <ShortUrl>http://****.cn/6y8uy7</ShortUrl>\\n <ExpireDate>2022-09-19 11:21:11</ExpireDate>\\n</Data>\\n<Code>OK</Code>\\n</AddShortUrlResponse>","errorExample":""}]',
'title' => '创建短链',
'description' => '><notice>短信服务暂时不支持使用此接口。></notice>'."\n"
."\n"
.'- 一个自然日最多可以创建3000个短链。'."\n"
.'- 短链接生成后,需要进行安全审核,审核时长一般为10分钟~2小时,安全审核通过之前,短链接无法直接访问。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteShortUrl' => [
'summary' => '删除短链,删除后短链将无法使用,无法还原为原链。',
'methods' => [
'post',
'get',
'delete',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102443',
'abilityTreeNodes' => [
'FEATUREdysmsAF8QUN',
],
],
'parameters' => [
[
'name' => 'SourceUrl',
'in' => 'formData',
'schema' => [
'description' => '原始链接地址。不超过1000个字符。'."\n"
.'><notice>短信服务暂时不支持使用此接口。></notice>',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'https://www.****.com/product/sms',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteShortUrlResponse>\\n <Message>OK</Message>\\n <RequestId>819BE656-D2E0-4858-8B21-B2E477085AAF</RequestId>\\n <Code>OK</Code>\\n</DeleteShortUrlResponse>\\n","errorExample":""}]',
'title' => '删除短链',
'description' => '><notice>短信服务暂时不支持使用此接口。></notice>'."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryShortUrl' => [
'summary' => '查询短链状态,可判断短链是否可用。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102456',
'abilityTreeNodes' => [
'FEATUREdysms2D1XSC',
],
],
'parameters' => [
[
'name' => 'ShortUrl',
'in' => 'formData',
'schema' => [
'description' => '生成的短链服务地址。可通过[AddShortUrl](~~186774~~)接口获取。'."\n"
.'><notice>短信服务暂时不支持使用此接口。></notice>',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'http://****.cn/6y8uy7',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF',
],
'Data' => [
'description' => '短链详情。',
'type' => 'object',
'properties' => [
'UniqueVisitorCount' => [
'description' => '短链使用的UV数据。',
'type' => 'string',
'example' => '23',
],
'SourceUrl' => [
'description' => '原始链接地址。',
'type' => 'string',
'example' => 'https://www.****.com/product/sms',
],
'ShortUrlStatus' => [
'description' => '短链状态。取值:'."\n"
."\n"
.'- **expired**:失效。'."\n"
.'- **effective**:有效。'."\n"
.'- **audit**:审核中。'."\n"
.'- **reject**:审核拒绝。',
'type' => 'string',
'example' => 'expired',
],
'PageViewCount' => [
'description' => '短链使用的PV数据。',
'type' => 'string',
'example' => '300',
],
'ExpireDate' => [
'description' => '短链失效时间。',
'type' => 'string',
'example' => '2019-01-22 11:21:11',
],
'ShortUrlName' => [
'description' => '短链服务名称。',
'type' => 'string',
'example' => '阿里短链测试',
],
'CreateDate' => [
'description' => '短链创建时间。',
'type' => 'string',
'example' => '2019-01-08 16:44:13',
],
'ShortUrl' => [
'description' => '生成的短链服务地址。',
'type' => 'string',
'example' => 'http://****.cn/6y8uy7',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\",\\n \\"Data\\": {\\n \\"UniqueVisitorCount\\": \\"23\\",\\n \\"SourceUrl\\": \\"https://www.****.com/product/sms\\",\\n \\"ShortUrlStatus\\": \\"expired\\",\\n \\"PageViewCount\\": \\"300\\",\\n \\"ExpireDate\\": \\"2019-01-22 11:21:11\\",\\n \\"ShortUrlName\\": \\"阿里短链测试\\",\\n \\"CreateDate\\": \\"2019-01-08 16:44:13\\",\\n \\"ShortUrl\\": \\"http://****.cn/6y8uy7\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryShortUrlResponse>\\n<Message>OK</Message>\\n<RequestId>819BE656-D2E0-4858-8B21-B2E477085AAF</RequestId>\\n<Data>\\n <ShortUrlName>阿里短链测试</ShortUrlName>\\n <SourceUrl>https://www.****.com/product/sms</SourceUrl>\\n <ShortUrl>http://****.cn/6y8uy7</ShortUrl>\\n <ExpireDate>2022-09-19 11:21:11</ExpireDate>\\n <PageViewCount>300</PageViewCount>\\n <CreateDate>2019-01-08 16:44:13</CreateDate>\\n <ShortUrlStatus>expired</ShortUrlStatus>\\n <UniqueVisitorCount>23</UniqueVisitorCount>\\n</Data>\\n<Code>OK</Code>\\n</QueryShortUrlResponse>\\n","errorExample":""}]',
'title' => '短链状态查询',
'description' => '><notice>短信服务暂时不支持使用此接口。></notice>'."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为20次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListTagResources' => [
'summary' => '标签是您为模板添加的标记,每个标签都由一对键值对(Key-Value)组成。您可以查询标签键值对绑定的模板Code,也可以查询某个模板已绑定的所有标签。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102448',
'abilityTreeNodes' => [
'FEATUREdysmsGD2ZLS',
],
],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型,默认填写TEMPLATE。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'TEMPLATE',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。默认取值:**cn-hangzhou**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '查询下一页标签的Token。',
'type' => 'string',
'required' => false,
'example' => '23432453245',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示条数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
[
'name' => 'ProdCode',
'in' => 'query',
'schema' => [
'description' => '产品名。默认取值:**dysms**。',
'type' => 'string',
'required' => false,
'example' => 'dysms',
'default' => 'dysms',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表。标签列表和**ResourceId**(短信模板Code)不能同时为空。最多可输入20个标签。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'required' => false,
'example' => 'TestKey',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'required' => false,
'example' => 'TestValue',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 21,
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '短信模板Code。短信模板Code和标签列表**Tag**不能同时为空。',
'type' => 'array',
'items' => [
'description' => '短信模板Code。',
'type' => 'string',
'required' => false,
'example' => 'SMS_2342****',
],
'required' => false,
'example' => 'SMS_23423423',
'maxItems' => 51,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'NextToken' => [
'description' => '查询下一页标签的Token。',
'type' => 'string',
'example' => '"23432453245"',
],
'RequestId' => [
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D',
],
'TagResources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagResource' => [
'description' => '标签资源。',
'type' => 'array',
'items' => [
'description' => '标签资源。',
'type' => 'object',
'properties' => [
'ResourceType' => [
'description' => '资源类型。',
'type' => 'string',
'example' => 'ALIYUN::DYSMS::TEMPLATE',
],
'TagValue' => [
'description' => '标签值。',
'type' => 'string',
'example' => 'TestValue',
],
'ResourceId' => [
'description' => '短信模板Code。',
'type' => 'string',
'example' => 'SMS_23423****',
],
'TagKey' => [
'description' => '标签键。',
'type' => 'string',
'example' => 'TestKey',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
200 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"NextToken\\": \\"\\\\\\"23432453245\\\\\\"\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"ALIYUN::DYSMS::TEMPLATE\\",\\n \\"TagValue\\": \\"TestValue\\",\\n \\"ResourceId\\": \\"SMS_23423****\\",\\n \\"TagKey\\": \\"TestKey\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTagResourcesResponse>\\n <Code>OK</Code>\\n <NextToken>\\"23432453245\\"</NextToken>\\n <RequestId>A90E4451-FED7-49D2-87C8-00700A8C4D0D</RequestId>\\n <TagResources>\\n <ResourceType>ALIYUN::DYSMS::TEMPLATE</ResourceType>\\n <TagValue>TestValue</TagValue>\\n <ResourceId>SMS_23423****</ResourceId>\\n <TagKey>TestKey</TagKey>\\n </TagResources>\\n</ListTagResourcesResponse>","errorExample":""}]',
'title' => '查询模板标签',
'description' => '您可登录短信服务控制台[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面筛选标签键值对已绑定的短信模板,或单击操作列**详情**按钮查看当前模板已绑定的标签。'."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'TagResources' => [
'summary' => '标签可以标记资源,允许企业或个人将同类型的模板进行资源归类,便于搜索和资源聚合。调用本接口对短信模板进行标签绑定。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102472',
'abilityTreeNodes' => [
'FEATUREdysmsGD2ZLS',
],
],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型,默认取值:**TEMPLATE**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'TEMPLATE',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID,默认取值:**cn-hangzhou**。更多地域ID请参见[服务接入点](~~419270~~)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ProdCode',
'in' => 'query',
'schema' => [
'description' => '产品名。默认取值:**dysms**。',
'type' => 'string',
'required' => false,
'example' => 'dysms',
'default' => 'dysms',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签。单次添加的标签数量不超过20。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'required' => false,
'example' => 'TestKey',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'required' => false,
'example' => 'TestValue',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 21,
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '短信模板Code。数量不能超过20条。',
'type' => 'array',
'items' => [
'description' => '短信模板Code。'."\n"
."\n"
.'>- 在[CreateSmsTemplate](~~CreateSmsTemplate~~)接口的返回参数中获取短信模板Code。'."\n"
.'>- 在[国内消息>模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面查看短信模板Code。',
'type' => 'string',
'required' => false,
'example' => 'SMS_2342****',
],
'required' => false,
'example' => 'SMS_23423423',
'maxItems' => 51,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。取值:'."\n"
."\n"
.'- OK:代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Data' => [
'description' => '添加标签的执行结果。取值:'."\n"
."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'string',
'example' => 'true',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF'."\n",
],
],
],
],
],
'errorCodes' => [
200 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\\\n\\"\\n}","type":"json"}]',
'title' => '添加模板标签',
'description' => '- 每个模板最多可以绑定20个标签。'."\n"
.'- 同一个模板的标签键(Key)必须唯一,一个模板如果设置了同Key不同Value的两个标签,新值将覆盖旧值。'."\n"
.'- 此功能仅适用于中国站短信服务的国内文本短信。'."\n"
."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UntagResources' => [
'summary' => '标签可以标记资源,允许企业或个人将同类型的模板进行资源归类,便于搜索和资源聚合。如果模板不再适用于当前已绑定的标签,可以从模板中解绑标签。您可以删除单个标签,也可以批量删除标签。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '102473',
'abilityTreeNodes' => [
'FEATUREdysmsGD2ZLS',
],
],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型,默认填写TEMPLATE。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'TEMPLATE',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID,默认填写cn-hangzhou。'."\n"
.'更多地域ID请参见[服务接入点](~~419270~~)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => [
'description' => '是否删除该模板下的所有标签。取值:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'ProdCode',
'in' => 'query',
'schema' => [
'description' => '产品名。默认取值:**dysms**。',
'type' => 'string',
'required' => false,
'example' => 'dysms',
'default' => 'dysms',
],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签键。单次添加的标签数量不超过20。',
'type' => 'array',
'items' => [
'description' => '标签键。'."\n"
.'在[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面标签栏查看标签键。',
'type' => 'string',
'required' => false,
'example' => 'sampleTagKey',
],
'required' => false,
'example' => 'TestKey',
'maxItems' => 21,
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '短信模板Code。数量不能超过20条。',
'type' => 'array',
'items' => [
'description' => '短信模板Code。'."\n"
."\n"
.'>- 在[CreateSmsTemplate](~~CreateSmsTemplate~~)接口的返回参数中获取短信模板Code。'."\n"
.'>- 在[国内消息>模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面查看短信模板Code。',
'type' => 'string',
'required' => false,
'example' => 'SMS_2342****',
],
'required' => false,
'example' => 'SMS_23423423',
'maxItems' => 51,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求状态码。取值:'."\n"
."\n"
.'- OK:代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。',
'type' => 'string',
'example' => 'OK',
],
'Data' => [
'description' => '删除标签的执行结果。取值:'."\n"
."\n"
.'- **true**:成功。'."\n"
."\n"
.'- **false**:失败。',
'type' => 'string',
'example' => 'true',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF'."\n",
],
],
],
],
],
'errorCodes' => [
200 => [
[
'errorCode' => 'ForbiddenAction',
'errorMessage' => 'Access to the account is denied. Please contact the administrator.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\\\n\\"\\n}","errorExample":""},{"type":"xml","example":"<UntagResourcesResponse>\\n<RequestId>A90E4451-FED7-49D2-87C8-00700A8C****</RequestId>\\n<Data>true</Data>\\n<Code>OK</Code>\\n</UntagResourcesResponse>","errorExample":""}]',
'title' => '删除模板标签',
'description' => '### QPS限制'."\n"
.'本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetSmsTemplateList' => [
'summary' => '查询模板列表详情(新接口)',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SignName',
'in' => 'query',
'schema' => [
'title' => '签名',
'description' => '签名名称',
'type' => 'string',
'required' => false,
'example' => '示例签名',
],
],
[
'name' => 'TemplateType',
'in' => 'query',
'schema' => [
'title' => '模板类型',
'description' => '模板类型',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => [
'通知',
'推广',
'验证码',
],
'example' => '0',
],
],
[
'name' => 'AuditStatus',
'in' => 'query',
'schema' => [
'title' => '模板审核状态',
'description' => '模板审核状态',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => [
'审批中',
'通过',
'不通过',
],
'example' => '1',
],
],
[
'name' => 'UsableStateList',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '模板状态',
'description' => '模板状态',
'type' => 'array',
'items' => [
'description' => '模板状态',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'AVAILABLE' => '可用',
'MISSING_SIGNATURE' => '缺少签名',
'MISSING_TRAFFIC_DRIVING' => '缺少引流',
'MISSING_TRAFFIC_DRIVING_ARCHIVE' => '缺少引流材料',
'UNAVAILABLE' => '不可用',
'MISSING_VARIABLE' => '缺少变量',
],
'example' => 'MISSING_SIGNATURE',
],
'required' => false,
'example' => '',
],
],
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => [
'title' => '模板名称',
'description' => '模板名称',
'type' => 'string',
'required' => false,
'example' => '模板名称',
],
],
[
'name' => 'TemplateTag',
'in' => 'query',
'schema' => [
'title' => '模板标签',
'description' => '模板标签',
'type' => 'string',
'required' => false,
'example' => '[{"TagKey":"test2","TagValue":"测试修改,test22"},{"TagKey":"book","TagValue":"sanguo"}]',
],
],
[
'name' => 'TemplateCode',
'in' => 'query',
'schema' => [
'title' => '模板code',
'description' => '模板code',
'type' => 'string',
'required' => false,
'example' => 'SMS_1688168',
],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => [
'title' => '页码, 默认1',
'description' => '页码, 默认1',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'title' => '每页数量,默认10',
'description' => '每页数量,默认10',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。',
'type' => 'string',
'example' => 'None',
],
'RequestId' => [
'title' => '',
'description' => '本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => '示例值',
],
'Message' => [
'title' => '',
'description' => '错误信息,仅错误时返回错误信息。',
'type' => 'string',
'example' => '示例值示例值',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'PageSize' => [
'title' => '',
'description' => '每页数据条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '78',
],
'Total' => [
'title' => '',
'description' => '总条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '64',
],
'PageNo' => [
'title' => '',
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '97',
],
'List' => [
'title' => '',
'description' => '满足过滤条件的数据列表。',
'type' => 'array',
'items' => [
'description' => '单个模板详情',
'type' => 'object',
'properties' => [
'TemplateCode' => [
'title' => '模板code',
'description' => '模板code',
'type' => 'string',
'example' => '示例值示例值示例值',
],
'GmtCreate' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'string',
'example' => '示例值',
],
'AuditStatus' => [
'title' => '模板审核状态',
'description' => '模板审核状态',
'type' => 'integer',
'format' => 'int64',
'example' => '88',
],
'TemplateTag' => [
'title' => '模板标签',
'description' => '模板标签',
'type' => 'array',
'items' => [
'description' => '标签',
'type' => 'object',
'properties' => [
'TagKey' => [
'title' => '',
'description' => '标签键。',
'type' => 'string',
'example' => '示例值',
],
'TagValue' => [
'title' => '',
'description' => '标签值。',
'type' => 'string',
'example' => '示例值示例值',
],
],
],
'example' => '',
],
'WorkOrderId' => [
'title' => '工单号',
'description' => '工单号',
'type' => 'string',
'example' => '示例值示例值',
],
'UsableStateList' => [
'title' => '模板可用状态',
'description' => '模板可用状态列表',
'type' => 'array',
'items' => [
'description' => '模板可用状态',
'type' => 'string',
'example' => 'MISSING_SIGNATURE'."\n",
],
'example' => '',
],
'TemplateName' => [
'title' => '模板名称',
'description' => '模板名称',
'type' => 'string',
'example' => '示例值',
],
'TemplateType' => [
'title' => '模板类型',
'description' => '模板类型',
'type' => 'integer',
'format' => 'int64',
'example' => '43',
],
'SignName' => [
'title' => '签名',
'description' => '签名',
'type' => 'string',
'example' => '示例值示例值',
],
],
],
'example' => '',
],
],
],
'Code' => [
'title' => '',
'description' => '请求状态码。取值:'."\n"
."\n"
.'* OK:代表请求成功。'."\n"
.'* 其他错误码,请参见本章节的**错误码**列表或产品[API错误码](~~101346~~)。',
'type' => 'string',
'example' => '示例值示例值',
],
'Success' => [
'title' => '',
'description' => '接口调用是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"示例值\\",\\n \\"Message\\": \\"示例值示例值\\",\\n \\"Data\\": {\\n \\"PageSize\\": 78,\\n \\"Total\\": 64,\\n \\"PageNo\\": 97,\\n \\"List\\": [\\n {\\n \\"TemplateCode\\": \\"示例值示例值示例值\\",\\n \\"GmtCreate\\": \\"示例值\\",\\n \\"AuditStatus\\": 88,\\n \\"TemplateTag\\": [\\n {\\n \\"TagKey\\": \\"示例值\\",\\n \\"TagValue\\": \\"示例值示例值\\"\\n }\\n ],\\n \\"WorkOrderId\\": \\"示例值示例值\\",\\n \\"UsableStateList\\": [\\n \\"MISSING_SIGNATURE\\\\n\\"\\n ],\\n \\"TemplateName\\": \\"示例值\\",\\n \\"TemplateType\\": 43,\\n \\"SignName\\": \\"示例值示例值\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"示例值示例值\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '查询模板列表',
],
],
'endpoints' => [
[
'regionId' => 'ap-southeast-1',
'endpoint' => 'dysmsapi.ap-southeast-1.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-5',
'endpoint' => 'dysmsapi.ap-southeast-5.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'ap-northeast-2-pop',
'endpoint' => 'dysmsapi.ap-southeast-1.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-finance-1',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-finance-pop',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-gov-1',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-nu16-b01',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-chengdu',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-edge-1',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-fujian',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-haidian-cm12-c01',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-bj-b01',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-finance',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-prod-1',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-1',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-2',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-3',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-test-306',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong-finance-pop',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-huhehaote-nebula-1',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-north-2-gov-1',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-qingdao-nebula',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-et15-b01',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-et2-b01',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-finance-1',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-inner',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-internal-test-1',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-finance-1',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-inner',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-st4-d01',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-su18-b01',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-wuhan',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-yushanfang',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-zhangbei',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-zhangbei-na61-b01',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-zhangjiakou-na62-a01',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-zhengzhou-nebula-1',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'eu-central-1',
'endpoint' => 'dysmsapi.eu-central-1.aliyuncs.com',
],
[
'regionId' => 'eu-west-1-oxs',
'endpoint' => 'dysmsapi.ap-southeast-1.aliyuncs.com',
],
[
'regionId' => 'rus-west-1-pop',
'endpoint' => 'dysmsapi.ap-southeast-1.aliyuncs.com',
],
[
'regionId' => 'cn-qingdao',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-zhangjiakou',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-huhehaote',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'dysmsapi.aliyuncs.com',
],
],
];
|