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
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'Dysmsapi', 'version' => '2017-05-25'],
'directories' => [
[
'children' => ['SubmitSmsQualification', 'QuerySmsQualificationRecord', 'QuerySingleSmsQualification', 'UpdateSmsQualification', 'DeleteSmsQualification', 'RequiredPhoneCode', 'ValidPhoneCode'],
'type' => 'directory',
'title' => 'Qualification management',
],
[
'children' => ['CreateSmsAuthorizationLetter', 'QuerySmsAuthorizationLetter'],
'type' => 'directory',
'title' => 'Power of attorney',
],
[
'children' => ['CreateSmsSign', 'GetSmsSign', 'QuerySmsSignList', 'UpdateSmsSign', 'DeleteSmsSign', 'ChangeSignatureQualification', 'AddSmsSign', 'ModifySmsSign', 'QuerySmsSign'],
'type' => 'directory',
'title' => 'Signature management',
],
[
'children' => ['CreateSmsTrademark', 'QuerySmsTrademark', 'CreateSmsAppIcpRecord', 'QuerySmsAppIcpRecord'],
'type' => 'directory',
'title' => 'Trademark and ICP filing',
],
[
'children' => ['CreateSmsTemplate', 'GetSmsTemplate', 'QuerySmsTemplateList', 'UpdateSmsTemplate', 'DeleteSmsTemplate', 'AddSmsTemplate', 'ModifySmsTemplate', 'QuerySmsTemplate'],
'type' => 'directory',
'title' => 'Template management',
],
[
'children' => ['SendSms', 'SendBatchSms'],
'type' => 'directory',
'title' => 'SMS sending',
],
[
'children' => ['QuerySendDetails', 'QuerySendStatistics'],
'type' => 'directory',
'title' => 'Sending query',
],
[
'children' => ['CreateDigitalSignOrder', 'QueryDigitalSignByName', 'CreateDigitalSmsTemplate'],
'type' => 'directory',
'title' => 'Digital SMS',
],
[
'children' => ['GetOSSInfoForCardTemplate', 'GetMediaResourceId', 'CreateCardSmsTemplate', 'QueryCardSmsTemplate', 'CheckMobilesCardSupport', 'QueryMobilesCardSupport', 'GetCardSmsLink', 'GetCardSmsDetails', 'QueryCardSmsTemplateReport', 'SendCardSms', 'SendBatchCardSms'],
'type' => 'directory',
'title' => 'Card SMS',
],
[
'children' => ['GetQualificationOssInfo', 'GetSmsOcrOssInfo'],
'type' => 'directory',
'title' => 'Retrieve OSS upload information',
],
[
'children' => ['SmsConversionIntl', 'ConversionDataIntl'],
'type' => 'directory',
'title' => 'Domestic-to-international SMS conversion rate',
],
[
'children' => ['AddShortUrl', 'DeleteShortUrl', 'QueryShortUrl'],
'type' => 'directory',
'title' => 'Short URL management',
],
[
'children' => ['GetOSSInfoForUploadFile', 'ListTagResources', 'TagResources', 'UntagResources'],
'title' => 'Others',
'type' => 'directory',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AddShortUrl' => [
'summary' => 'Creates a short URL.',
'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' => 'The URL that you want to shorten. Maximum length: 1,000 characters.'."\n"
."\n"
.'><notice>'."\n"
."\n"
.'Short Message Service does not currently support this API operation.'."\n"
."\n"
.'></notice>', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'https://www.****.com/product/sms', 'title' => ''],
],
[
'name' => 'ShortUrlName',
'in' => 'formData',
'schema' => ['description' => 'The name of the short URL. Maximum length: 13 characters.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '阿里短链测试', 'title' => ''],
],
[
'name' => 'EffectiveDays',
'in' => 'formData',
'schema' => ['description' => 'The validity period of the short URL, in days. The maximum value is 90.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The status code of the request.'."\n"
."\n"
.'- A value of `OK` indicates that the request was successful.'."\n"
."\n"
.'- For other error codes, see [Error Code List](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message that describes the status.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF', 'title' => ''],
'Data' => [
'description' => 'The details of the short URL.',
'type' => 'object',
'properties' => [
'SourceUrl' => ['description' => 'The source URL that was shortened.', 'type' => 'string', 'example' => 'https://www.****.com/product/sms', 'title' => ''],
'ExpireDate' => ['description' => 'The expiration time of the short URL.'."\n"
."\n"
.'> The value of **ExpireDate** is always on the hour.', 'type' => 'string', 'example' => '2021-09-19 00:00:00', 'title' => ''],
'ShortUrl' => ['description' => 'The generated short URL.', 'type' => 'string', 'example' => 'http://****.cn/6y8uy7', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
'title' => 'AddShortUrl',
'description' => '><notice>'."\n"
."\n"
.'Short Message Service does not currently support this API operation.'."\n"
."\n"
.'></notice>'."\n"
."\n"
.'- You can create up to 3,000 short URLs per calendar day.'."\n"
."\n"
.'- After a short URL is generated, it must pass a security review, which typically takes 10 minutes to 2 hours. You cannot access the short URL until it passes this review.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddShortUrl'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'dysms:AddShortUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'AddSmsSign' => [
'summary' => 'This API has been discontinued.',
'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' => 'The signature name. The signature name must comply with the [Signature specifications](~~108076#section-0p8-qn8-mmy~~).'."\n"
."\n"
.'> - Signature names are case-insensitive. For example, [Aliyun Communication] and [aliyun communication] are considered the same name.'."\n"
.'> - When your verification code signature and general-purpose signature have the same name, the system uses the general-purpose signature to send SMS messages by default.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '阿里云', 'title' => ''],
],
[
'name' => 'SignSource',
'in' => 'query',
'schema' => ['description' => 'The source of the signature. Valid values:'."\n"
."\n"
.'- **0**: Full name or abbreviation of an enterprise or public institution.'."\n"
.'- **1**: Full name or abbreviation of a website registered with the Ministry of Industry and Information Technology (MIIT).'."\n"
.'- **2**: Full name or abbreviation of an app.'."\n"
.'- **3**: Full name or abbreviation of an official account or mini program.'."\n"
.'- **4**: Full name or abbreviation of an e-commerce platform store name.'."\n"
.'- **5**: Full name or abbreviation of a trademark name.'."\n"
."\n"
.'For detailed descriptions of signature sources, see [Signature source](https://help.aliyun.com/en/sms/user-guide/signature-specifications-1?spm=a2c4g.11186623.0.0.4f9710fder2gR7#section-xup-k46-yi4).'."\n"
."\n"
.'>This API does not support applying for signatures whose signature source is **Test or learning** or **Online trial**. If you need to apply for signatures with these two sources, go to the [Short Message Service (SMS) console](https://dysms.console.aliyun.com/domestic/text/sign/add/qualification) to submit your application.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => ['description' => 'The description of the SMS signature scenario. The description cannot exceed 200 characters in length.'."\n"
."\n"
.'This is reference information for signature review. Providing a complete application description helps reviewers understand your business scenario and improves review efficiency. Guidelines for filling in:'."\n"
."\n"
.'- You can provide the use cases of a business that has been launched.'."\n"
."\n"
.'- You can provide real-world SMS message examples to reflect your business scenarios.'."\n"
."\n"
.'- You can provide the parameter values passed to variables and describe the business use cases and the reasons for choosing these variable attributes in detail.'."\n"
."\n"
.'- You can provide the website links, registered domain names, or app store download links of your actual business.'."\n"
."\n"
.'- For login scenarios, you can provide a test account and password.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '当前的短信签名应用于双11大促推广营销', 'title' => ''],
],
[
'name' => 'SignFileList',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of signature files.',
'type' => 'array',
'items' => [
'description' => 'The signature data.',
'type' => 'object',
'properties' => [
'FileContents' => ['description' => 'The Base64-encoded string of the qualification certificate file for the signature. The image size cannot exceed 2 MB. In some scenarios, you need to upload a certificate file when you apply for a signature.'."\n"
."\n"
.'For detailed specifications, see [File upload specifications](~~463316~~).', 'type' => 'string', 'required' => true, 'example' => 'R0lGODlhHAAmAKIHAKqqqsvLy0hISObm5vf394uL****', 'title' => ''],
'FileSuffix' => ['description' => 'The format of the signature certificate file. Multiple images can be uploaded. Currently, JPG, PNG, GIF, and JPEG formats are supported. In some scenarios, you need to upload a certificate file when you apply for a signature.'."\n"
."\n"
.'> If the signature is for third-party use or if you are an individual-certified user whose self-use signature source is an enterprise or public institution name, you also need to upload a certificate file and a power of attorney. For more information, see [Certificate file](~~108076~~) and [Power of attorney](~~56741~~).', 'type' => 'string', 'required' => true, 'example' => 'jpg', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 10,
'title' => '',
'example' => '',
],
],
[
'name' => 'SignType',
'in' => 'query',
'schema' => ['description' => 'The type of the signature.'."\n"
."\n"
.'- **0**: Verification code'."\n"
.'- **1**: General-purpose', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The HTTP status code.'."\n"
."\n"
.'* OK is returned if the request is successful.'."\n"
.'* For other error codes, see [API error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', 'title' => ''],
'SignName' => ['description' => 'The signature name.', 'type' => 'string', 'example' => '阿里云', 'title' => ''],
],
'title' => '',
'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' => 'Apply for an SMS signature (discontinued)',
'description' => '- In accordance with the regulations of the Ministry of Industry and Information Technology (MIIT) and the [relevant requirements](~~2806975~~) of carriers, Alibaba Cloud has made functional modifications to signature-related APIs. To improve the review efficiency and approval rate of your signatures, use the new API [CreateSmsSign - Apply for an SMS signature](~~2807427~~).'."\n"
."\n"
.'- An individual user can apply for one signature per natural day under the same Alibaba Cloud account. Enterprise users have no limit on the number of applications. For details about the differences in rights and interests between individual users and enterprise users, see [Usage notes](~~55324~~).'."\n"
."\n"
.'- The signature information applied for through the API is synchronized to the SMS console. For operations on signatures in the console, see [SMS signatures](~~108073~~).'."\n"
."\n"
.'- After you submit a signature application, you can call the [QuerySmsSign](~~419283~~) API to query the review status and details of the signature. You can also [configure receipt messages](~~101508~~) and use [SignSmsReport](~~120998~~) to obtain signature review status messages.'."\n"
."\n"
.'### QPS limit'."\n"
.'The single-user QPS limit for this API is 1 call per second. If the limit is exceeded, API calls will be throttled, which may affect your business. Call this API at a reasonable rate.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-08-15T04:21:05.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-08-15T04:21:02.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-08-15T04:03:26.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-08-15T04:02:05.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-07-09T12:20:25.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-07-09T12:20:18.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-07-09T12:20:05.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddSmsSign'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'dysms:AddSmsSign',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'AddSmsTemplate' => [
'summary' => 'An SMS template is the detailed content received by the recipient, including variables and template content. You can apply for verification code, notification, or promotional SMS templates based on your business needs. SMS can only be sent after the template is approved.',
'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' => 'The SMS type. Valid values:'."\n"
."\n"
.'- **0**: verification code.'."\n"
.'- **1**: notification SMS.'."\n"
.'- **2**: promotional SMS.'."\n"
.'- **3**: international/Hong Kong, Macao, and Taiwan messages.'."\n"
."\n"
.'> Only enterprise-verified users can apply for promotional SMS and international/Hong Kong, Macao, and Taiwan messages. For details about the differences between individual and enterprise user privileges, see [Usage notes](~~55324~~).', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '0', 'title' => ''],
],
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => ['description' => 'The template name. The length must not exceed 30 characters.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '验证码', 'title' => ''],
],
[
'name' => 'TemplateContent',
'in' => 'query',
'schema' => ['description' => 'The template content. The length must not exceed 500 characters.'."\n"
."\n"
.'The template content and variable content must comply with the [SMS template specifications](~~463161~~); otherwise, the template review will fail. You can also view common template examples on the [Apply for template](https://dysms.console.aliyun.com/domestic/text/template/add) page. Using example templates can improve review efficiency and success rate. For variable specifications, see [TemplateContent parameter variable specifications](~~2806243~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '您正在申请手机注册,验证码为:${code},5分钟内有效!', 'title' => ''],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => ['description' => 'The description for the SMS template application. The length must not exceed 100 characters.'."\n"
."\n"
.'This is reference information for template review. Providing a complete application description helps reviewers understand your business scenario and improves review efficiency. Guidelines:'."\n"
."\n"
.'- You can provide the usage scenario of business that has been launched.'."\n"
.'- You can provide SMS examples for real scenarios to demonstrate your business scenario.'."\n"
.'- You can provide the variable parameter content, describing the business usage scenario in detail and the reason for choosing this variable attribute.'."\n"
.'- You can provide website links of actual business, registered domain addresses, app market download links, and so on.'."\n"
.'- For login scenarios, you can provide a test account and password.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '申请验证码短信', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The request status code.'."\n"
."\n"
.'* The value OK indicates that the request was successful.'."\n"
.'* For other error codes, see [API error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', 'title' => ''],
'TemplateCode' => ['description' => 'The SMS template code.'."\n"
."\n"
.'After submitting the template application, you can use the SMS template code to query the template review details through the [QuerySmsTemplate](~~419289~~) operation. You can also [configure receipt messages](~~101508~~) and obtain the template review status messages through [TemplateSmsReport](~~120999~~).', 'type' => 'string', 'example' => 'SMS_46817****', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'TemplateParameterCountIllegal', 'errorMessage' => 'The verification code template only supports 1 verification code as a variable', 'description' => 'Verification code templates support only one variable, which must be a verification code.'],
],
],
'staticInfo' => [
'substitutions' => ['Dysmsapi::2017-05-25::CreateSmsTemplate'],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"TemplateCode\\": \\"SMS_46817****\\"\\n}","type":"json"}]',
'title' => 'Apply for SMS template (discontinued)',
'description' => '- In accordance with the regulations of the Ministry of Industry and Information Technology and the [related requirements](~~2806975~~) of carriers, Alibaba Cloud has revamped the functionality of template-related APIs. To improve the review efficiency and approval rate of your templates, please use the new operation [CreateSmsTemplate - Apply for SMS template](~~2807431~~).'."\n"
."\n"
.'- You can submit a maximum of 100 SMS template applications per natural day via the API. It is recommended that each application be submitted at intervals of at least 30 seconds. There is no limit on the number of submissions when applying for SMS templates through the [console](https://dysms.console.aliyun.com/domestic/text/template).'."\n"
."\n"
.'- Template information applied for through the API is synchronized to the SMS service console. For related template operations in the console, see [SMS templates](~~108085~~).'."\n"
."\n"
.'- After submitting the template application, you can query the template review status and details through the [QuerySmsTemplate](~~419289~~) operation. You can also [configure receipt messages](~~101508~~) and obtain the template review status messages through [TemplateSmsReport](~~120999~~).'."\n"
."\n"
.'- Domestic SMS templates and international/Hong Kong, Macao, and Taiwan SMS templates are not interchangeable (cannot be mixed). Please apply for templates based on your business usage scenarios.'."\n"
."\n"
.'- Only enterprise-verified users can apply for promotional SMS and international/Hong Kong, Macao, and Taiwan messages. For details about the differences between individual and enterprise user privileges, see [Usage notes](~~55324~~).'."\n"
."\n"
.'### QPS limits'."\n"
.'The per-user QPS limit for this operation is 1,000 calls per second. If the limit is exceeded, API calls will be throttled, which may affect your business. Please call the operation reasonably.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-08-15T04:21:06.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-08-15T04:21:02.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-07-09T12:20:25.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-07-09T12:20:18.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-07-09T12:20:05.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddSmsTemplate'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'dysms:AddSmsTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ChangeSignatureQualification' => [
'summary' => 'Updates the qualification and authorization letter for a signature.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '268874',
'abilityTreeNodes' => ['FEATUREdysmsJ2BZAJ'],
],
'parameters' => [
[
'name' => 'SignatureName',
'in' => 'query',
'schema' => ['description' => 'The signature.', 'type' => 'string', 'required' => true, 'example' => '阿里云', 'title' => ''],
],
[
'name' => 'QualificationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the qualification, which is returned when you apply for it. You can also find this ID on the [Qualification Management](https://dysms.console.aliyun.com/domestic/text/qualification) page in the console for messages to the Chinese mainland.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1*****2', 'title' => ''],
],
[
'name' => 'AuthorizationLetterId',
'in' => 'query',
'schema' => ['description' => 'The ID of the authorization letter.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000********1234', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'Details of the access denial. This field is returned only if RAM authentication fails.', 'type' => 'string', 'example' => '无', 'title' => ''],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates this unique identifier to help you troubleshoot issues.', 'type' => 'string', 'example' => '0A974B78-02BF-4C79-ADF3-90CFBA1B55B1', 'title' => ''],
'Data' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'This field is not used. You can ignore it.', 'type' => 'object', 'title' => '', 'example' => ''],
'ErrMessage' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrCode' => ['description' => 'The status code of the request.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
],
'description' => 'The returned data structure.',
'title' => '',
'example' => '',
],
'Code' => ['description' => 'The status code of the request.'."\n"
."\n"
.'- A value of `OK` indicates that the request was successful.'."\n"
."\n"
.'- For other error codes, see the error code list in this topic or the [API Error Codes](~~101346~~) topic.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Success' => [
'description' => 'Indicates whether the call was successful. Valid values:'."\n"
."\n"
.'- **true**: The call was successful.'."\n"
."\n"
.'- **false**: The call failed.',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'QualificationNotExist', 'errorMessage' => 'Can\'t query qualification information.', 'description' => 'Can\'t query qualification information'],
['errorCode' => 'SmsAuthorizationLetterNotExist', 'errorMessage' => 'Authorization does not belong to the customer.', 'description' => ''],
['errorCode' => 'SmsSignatureNotExist', 'errorMessage' => 'Signature does not exist.', 'description' => '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.', 'description' => '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.', 'description' => '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.', 'description' => 'Please bind and unify the qualification authorization letter with the same and available social credit code.'."\n"],
['errorCode' => 'QualificationNotComplete', 'errorMessage' => 'The qualification elements are incomplete.', 'description' => 'The qualification elements are incomplete, and the missing elements are []'],
['errorCode' => 'SmsSignNotAuthorized', 'errorMessage' => 'the signature is not in the sign scope of the authorization letter.', 'description' => 'The signature is not within the scope of the authorization.'],
['errorCode' => 'SMS_STATUS_ILLEGAL', 'errorMessage' => 'When replacing the qualification and power of attorney of the signature, the signature status must be approved.', 'description' => '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' => 'Replace the Qualification and Letter of Authorization for a Signature (to be unpublished)',
'changeSet' => [
['createdAt' => '2025-08-01T04:05:19.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [],
],
'CheckMobilesCardSupport' => [
'summary' => 'Checks whether phone numbers support card SMS.',
'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' => 'The code of the card SMS template.'."\n"
.'Log on to the SMS Service console and go to the [Domestic Card SMS](https://dysms.console.aliyun.com/domestic/card) page. On the **Template Management** tab, you can view the list of card SMS templates.'."\n"
."\n"
.'>The template must be added and approved.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CARD_SMS_****', 'title' => ''],
],
[
'name' => 'Mobiles',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The list of phone numbers to be queried.',
'type' => 'array',
'items' => ['description' => 'The phone number to be queried. The parameter must be in the format of {"#6#mobile":"1380000****"}. Otherwise, a phone number format error is returned. Up to 10,000 phone numbers can be queried in a single request.', 'type' => 'object', 'required' => false, 'example' => '{"#6#mobile":"1322587****"}', 'title' => ''],
'required' => true,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The request status code.'."\n"
.'- The value OK indicates that the request was successful.'."\n"
.'- For information about other error codes, see [Error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => 'The request ID, which is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF', 'title' => ''],
'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n"
."\n"
.'- **true**: The call was successful.'."\n"
.'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The returned data.'."\n",
'type' => 'object',
'properties' => [
'queryResult' => [
'description' => 'The list of query results.',
'type' => 'array',
'items' => [
'description' => 'The query data.',
'type' => 'object',
'properties' => [
'mobile' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '1390000****', 'title' => ''],
'support' => ['description' => 'Indicates whether card SMS is supported. Valid values:'."\n"
."\n"
.'- **true**: Card SMS is supported.'."\n"
."\n"
.'- **false**: Card SMS is not supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
200 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => 'No access, please contact 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' => 'Check whether phone numbers support card SMS (Old API)',
'description' => '- Alibaba Cloud accounts that have not activated card SMS cannot call this API.'."\n"
.'- Card SMS is currently in the internal invitation phase. Contact your Alibaba Cloud account manager to apply for activation or [contact Alibaba Cloud pre-sales](https://help.aliyun.com/document_detail/464625.html).'."\n"
.'- We recommend that you use the new API [QueryMobilesCardSupport](~~QueryMobilesCardSupport~~) to query whether phone numbers support card SMS.'."\n"
.'### QPS limit'."\n"
.'The per-user QPS limit for this API is 2,000 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Make calls reasonably.',
'requestParamsDescription' => 'Complete request parameter example:'."\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"
.'```',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckMobilesCardSupport'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:CheckMobilesCardSupport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ConversionDataIntl' => [
'summary' => 'Reports SMS conversion rate statistics to the Alibaba Cloud SMS platform.',
'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' => 'The point in time when the conversion rate is observed. The value must be a Unix timestamp in milliseconds, represented as a long integer.'."\n"
."\n"
.'>If you do not specify this parameter, the current timestamp is used by default.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1349055900000', 'title' => ''],
],
[
'name' => 'ConversionRate',
'in' => 'query',
'schema' => ['description' => 'The conversion rate monitoring value.'."\n"
.'>This parameter is of the double type. Valid values: \\[0,1].', 'type' => 'string', 'required' => true, 'example' => '0.53', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF'."\n", 'title' => ''],
'Code' => ['description' => '状态码。取值:'."\n"
."\n"
.'- OK:代表请求成功。'."\n"
."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。', 'type' => 'string', 'example' => 'OK', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\\\n\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
'title' => 'Report conversion rate data for international SMS sent from China',
'description' => '指标说明:转化率=OTP 转化量/OTP 发送量。'."\n"
.'- OTP发送量:验证码发送量。'."\n"
.'- OTP转化量:验证码转换量。(用户成功获取验证码,并进行回传)'."\n"
.'>转化率反馈功能会对业务系统有一定的侵入性,为了防止调用转化率 API 的抖动影响业务逻辑,请考虑: '."\n"
.'>- 使用异步模式(例如:队列或事件驱动)调用 API。 '."\n"
.'>- 添加可降级的方案保护业务逻辑(例如:手动降级开工或者使用断路器自动降级)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConversionDataIntl'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:ConversionDataIntl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CreateCardSmsTemplate' => [
'summary' => 'Creates a card SMS template.',
'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' => 'The name of the card SMS template.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '阿里云图文类模板', 'title' => ''],
],
[
'name' => 'Template',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'The content of the card SMS template.'."\n"
."\n"
.'> - For more information about the `Template`, `ExtendInfo`, `TemplateContent`, `TmpCard`, and `Action` fields, see [Card SMS template parameters](~~434929~~).'."\n"
.'>'."\n"
.'> - The content structure varies based on the type of card SMS template. For more information, see [Card SMS template examples](~~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"
.' "companyName": "投放企业名称"'."\n"
.'}', 'title' => ''],
],
[
'name' => 'Memo',
'in' => 'query',
'schema' => ['description' => 'A description of the template.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '图文类模板', 'title' => ''],
],
[
'name' => 'Factorys',
'in' => 'query',
'schema' => ['description' => 'The vendors to which the template will be submitted. Valid values:'."\n"
."\n"
.'- **HuaWei**: Huawei'."\n"
."\n"
.'- **XiaoMi**: Xiaomi'."\n"
."\n"
.'- **OPPO**: OPPO'."\n"
."\n"
.'- **VIVO**: VIVO'."\n"
."\n"
.'- **MEIZU**: MEIZU'."\n"
."\n"
.'- **HONOR**: HONOR'."\n"
."\n"
.'> If you do not specify this parameter, the system automatically submits the template to all supported mobile phone vendors.', 'type' => 'string', 'required' => false, 'example' => '["HuaWei","XiaoMi"] ', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The data object.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The request status code. Valid values:'."\n"
."\n"
.'- OK: The request was successful.'."\n"
."\n"
.'- For a list of other error codes, see [Error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'- **true**: The call was successful.'."\n"
."\n"
.'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The data returned by the operation.',
'type' => 'object',
'properties' => [
'TemplateCode' => ['description' => 'The code for the card SMS template. You can view the **Template Code** on the **Card SMS** > [template management](https://dysms.console.aliyun.com/domestic/card) page in the console.'."\n"
."\n"
.'> The card SMS template must be approved before it can be used.', 'type' => 'string', 'example' => 'CARD_SMS_2****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
200 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => 'No access, please contact administrator.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TemplateCode\\": \\"CARD_SMS_2****\\"\\n }\\n}","type":"json"}]',
'title' => 'CreateCardSmsTemplate',
'description' => '- The card SMS feature is currently available by invitation only. To enable this feature, contact your Alibaba Cloud business manager or our [pre-sales consultation](https://help.aliyun.com/document_detail/464625.html?spm=a2c4g.11186623.0.0.213273d4Xe6UEu#section-81n-72q-ybm) team.'."\n"
."\n"
.'- This operation saves a card SMS template, submits it to mobile phone vendors for review, and returns a template code.'."\n"
."\n"
.'- If a card SMS template contains a type or event that a vendor does not support, the system does not submit the template to that vendor for review. For more information, see [Supported template types by vendor](~~434611~~).'."\n"
."\n"
.'- For more examples of card SMS templates, see [Card SMS template examples](~~435361~~).'."\n"
."\n"
.'### QPS limit'."\n"
."\n"
.'The QPS limit for a single user is 300. API calls that exceed this limit are throttled, which may impact your business. Plan your calls accordingly.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2026-02-04T08:10:39.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-12-06T14:40:53.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-12-06T14:40:42.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-24T02:44:52.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-24T02:44:41.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCardSmsTemplate'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'dysms:CreateCardSmsTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CreateDigitalSignOrder' => [
'summary' => 'Creates an order to add, update, or delete a digital message signature.',
'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' => 'The operation to perform on the signature. Valid values:'."\n"
."\n"
.'- `UPDATE_DIGITALSMS_SIGN`: Update a signature.'."\n"
."\n"
.'- `DELETE_DIGITALSMS_SIGN`: Delete a signature.'."\n"
."\n"
.'- `CREATE_DIGITALSMS_SIGN`: Create a signature.',
'enumValueTitles' => ['UPDATE_DIGITALSMS_SIGN' => 'Update', 'DELETE_DIGITALSMS_SIGN' => 'Delete', 'CREATE_DIGITALSMS_SIGN' => 'Create'],
'type' => 'string',
'required' => false,
'example' => 'CREATE_DIGITALSMS_SIGN',
'title' => '',
],
],
[
'name' => 'Submitter',
'in' => 'query',
'schema' => ['description' => 'The ID of the user who submits the order.', 'type' => 'string', 'required' => false, 'example' => '110000001750080', 'title' => ''],
],
[
'name' => 'SignName',
'in' => 'query',
'schema' => ['description' => 'The signature name. This parameter is required for creating, updating, and deleting signatures.'."\n"
."\n"
.'1. The name must be 2 to 16 characters in length.'."\n"
."\n"
.'2. The name can contain Chinese characters, letters, and digits.'."\n"
."\n"
.'- Special characters are not allowed, including $, &, %, #, @, !, ^, \\*, (, ), \\_, +, -, =, {, }, \\[, ], |, ;, :, \', ", <, >, ,, ., /, ?, \\~, and .'."\n"
."\n"
.'- The name cannot be only letters.'."\n"
."\n"
.'- The name cannot be only digits. Spaces are not allowed.'."\n"
."\n"
.'- Emojis are not allowed.', 'type' => 'string', 'required' => false, 'example' => '阿里云商城', 'title' => ''],
],
[
'name' => 'QualificationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the qualification.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '41', 'title' => ''],
],
[
'name' => 'QualificationVersion',
'in' => 'query',
'schema' => ['description' => 'The version of the qualification.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '49', 'title' => ''],
],
[
'name' => 'OrderContext',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The qualification information. This object is required when you create a signature, or when you update a signature\'s qualification information.'."\n"
."\n"
.'- qualificationCompanyName: Company name. The name can be up to 150 characters long. It cannot consist of only digits or contain symbols other than the middle dot (·), Chinese brackets (【】), Chinese parentheses (()), English parentheses (()), and spaces.'."\n"
."\n"
.'- `qualificationOrganizationCode`: The 18-character Unified Social Credit Identifier (USCI). It must be an 18-digit code or a code that consists of 18 uppercase or lowercase letters and digits.'."\n"
."\n"
.'- `qualificationAdminName`: The name of the agent or legal representative. The name must be in Chinese.'."\n"
."\n"
.'- `qualificationAdminIDCard`: The 18-digit ID card number of the agent. Only PRC ID cards are supported.'."\n"
."\n"
.'- `qualificationLegalPersonName`: The name of the legal representative or agent.'."\n"
."\n"
.'- `qualificationLegalPersonIDCard`: The 18-digit ID card number of the legal representative. Only PRC ID cards are supported.',
'enumValueTitles' => [],
'type' => 'object',
'required' => false,
'example' => '{'."\n"
.' "qualificationCompanyName": "阿里阿巴",'."\n"
.' "qualificationOrganizationCode": "91330106MA2A0XABCD",'."\n"
.' "qualificationLegalPersonName": "张三",'."\n"
.' "qualificationLegalPersonIDCard": "110105199001011234",'."\n"
.' "qualificationAdminName": "李四",'."\n"
.' "qualificationAdminIDCard": "11010519900101****"'."\n"
.'}',
'title' => '',
],
],
[
'name' => 'SignIndustry',
'in' => 'query',
'schema' => [
'description' => 'The industry type. This parameter is required when you create or update a signature. It is optional when you delete a signature. Valid values:'."\n"
."\n"
.'- `0`: General (GENERAL)'."\n"
."\n"
.'- `1`: E-commerce and retail (ECOMMERCE)',
'enumValueTitles' => ['General (GENERAL)', 'E-commerce and retail (ECOMMERCE)'],
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
'title' => '',
],
],
[
'name' => 'SignId',
'in' => 'query',
'schema' => ['description' => 'The unique ID of the signature.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '80', 'title' => ''],
],
[
'name' => 'SignSource',
'in' => 'query',
'schema' => [
'description' => 'The signature source. This parameter is required when you create or update a signature. It is optional when you delete a signature. Valid values:'."\n"
."\n"
.'- `0`: Enterprises and public institutions'."\n"
."\n"
.'- `2`: App',
'enumValueTitles' => ['Enterprises and public institutions', 2 => 'App', 5 => 'Brand name', 7 => 'E-commerce or flagship store'],
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
'title' => '',
],
],
[
'name' => 'ExtendMessage',
'in' => 'query',
'schema' => ['description' => 'Reserved for future use.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The details about the access denial. This parameter is returned only if the RAM user is not authorized.', 'type' => 'string', 'example' => 'None', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '2D0133B9-6C0D-0BAE-8161-1EEF9E2D4069', 'title' => ''],
'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'example', 'title' => ''],
'Data' => ['description' => 'The returned data.'."\n"
."\n"
.'- `signName`: The name of the signature.'."\n"
."\n"
.'- `signOrderId`: The ID of the signature order.'."\n"
."\n"
.'- `signCode`: The code of the signature.'."\n"
."\n"
.'- `signId`: The ID of the signature.', 'type' => 'object', 'example' => '{\'signId\': \'2006746****\', \'signCode\': \'SIGN_100000184736042_174416475****_hpMd1\', \'signOrderId\': 2246979****, \'signName\': u\'\\u8d5b\\u745e\\u5a05\\u808c\\u80a4\\u7ba1\\u7406\'}', 'title' => ''],
'Code' => ['description' => 'The status code.'."\n"
."\n"
.'- If the request is successful, `OK` is returned.'."\n"
."\n"
.'- For more information about other error codes, see [API error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Success' => [
'description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'- **true**: The request was successful.'."\n"
."\n"
.'- **false**: The request failed.',
'enumValueTitles' => ['true' => 'Success', 'false' => 'Failure'],
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Digital Message SMS Signature Management ',
'description' => 'Creates, updates, or deletes a signature.',
'requestParamsDescription' => 'The qualification information. This object is required when you create a signature, or when you update a signature\'s qualification information.'."\n"
."\n"
.'Example in JSON format:'."\n"
.'`{ "qualificationCompanyName": "Aliaba", "qualificationOrganizationCode": "91330106MA2A0XABCD", "qualificationLegalPersonName": "Zhang San", "qualificationLegalPersonIDCard": "110105199001011234", "qualificationAdminName": "Li Si", "qualificationAdminIDCard": "1101051990010100000" }`'."\n"
."\n"
.'- qualificationCompanyName The name of the company. The only supported symbols are the middle dot (·), Chinese brackets (【】), Chinese parentheses (()), English parentheses (()), and spaces. The value cannot consist of only digits, and its length cannot exceed 150 characters.'."\n"
."\n"
.'- `qualificationOrganizationCode`: The 18-character USCI. It must be an 18-digit code or a code that consists of 18 uppercase or lowercase letters and digits.'."\n"
."\n"
.'- `qualificationAdminName`: The name of the agent or legal representative. The name must be in Chinese.'."\n"
."\n"
.'- `qualificationAdminIDCard`: The 18-digit ID card number of the agent. Only PRC ID cards are supported.'."\n"
."\n"
.'- `qualificationLegalPersonName`: The name of the legal representative or agent.'."\n"
."\n"
.'- `qualificationLegalPersonIDCard`: The 18-digit ID card number of the legal representative. Only PRC ID cards are supported.',
'extraInfo' => 'After you commit a sign request, you can use the GetSmsSign API to query the sign filing status and details. You can also [configure receipt messages](https://dysmsnext.console.aliyun.com/general/audit). '."\n"
."\n"
.'Core processing logic: '."\n"
."\n"
.'1. Delete sign: When you delete a sign via the API, the operation synchronizes with the Short Message Service console, and the sign record is removed from the page. If any carrier has a “filing in progress” status for this sign, deletion is not supported. Please wait for the result before retrying. '."\n"
.'2. Associated template invalidation: The system automatically queries all SMS templates associated with this sign and updates their status in batch to “Out Of Effect.” '."\n"
.'3. Mark reason: In the status change records of the associated templates, the reason for invalidation is appended as: “The sign associated with the template was deleted.” '."\n"
."\n"
.'● Limits and notes: '."\n"
."\n"
.'1. Permission: Only the Alibaba Cloud account that owns the sign can perform the delete operation. '."\n"
.'2. Irreversible: Deleted signs cannot be recovered. If you need to use the sign again, you must submit a new request. '."\n"
.'3. Sending impact: After the sign is deleted and its associated templates become invalid, all text message sending requests based on these templates will fail. You must confirm the impact scope before performing this operation.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"2D0133B9-6C0D-0BAE-8161-1EEF9E2D4069\\",\\n \\"Message\\": \\"example\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'CreateDigitalSmsTemplate' => [
'summary' => 'Creates a digital SMS template.',
'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' => 'The template name. The name can contain up to 20 characters.', 'type' => 'string', 'required' => true, 'example' => '****模板', 'title' => ''],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => ['description' => 'The application description. Describe your business use case for the template.', 'type' => 'string', 'required' => true, 'example' => '***业务需要', 'title' => ''],
],
[
'name' => 'TemplateContents',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'maxItems' => 10,
'description' => 'An array of objects that define the template content.',
'type' => 'array',
'items' => [
'description' => 'The template content.',
'type' => 'object',
'properties' => [
'FileContents' => ['description' => 'The file content, converted to a Base64 string. The file must be UTF-8 encoded before the Base64 conversion.', 'type' => 'string', 'required' => false, 'example' => '字符', 'title' => ''],
'FileSuffix' => ['description' => 'The file suffix. Supported formats are `txt` for text; `gif`, `jpg`, and `png` for images; `mp3` for audio; and `mp4` for video. You can upload only one video file per template.', 'type' => 'string', 'required' => false, 'example' => 'txt', 'title' => ''],
'FileName' => ['description' => 'The file name without the extension.', 'type' => 'string', 'required' => false, 'example' => 'file-1', 'title' => ''],
'FileSize' => ['description' => 'The file size, in bytes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1840901', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => true,
'title' => '',
'example' => '',
],
],
[
'name' => 'SignName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'The signature.', 'type' => 'string', 'required' => false, 'example' => '签名', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The status code of the request. A value of `OK` indicates a successful request.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message. `success` indicates a successful request. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'RequestId' => ['description' => 'The request ID. This unique identifier is generated by Alibaba Cloud and can be used to troubleshoot issues.', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', 'title' => ''],
'TemplateCode' => ['description' => 'The template code.', 'type' => 'string', 'example' => 'DIGITAL_SMS_0001', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Digital SMS Template Creation ',
'description' => 'Use this operation to create a reusable template for your digital SMS messages.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"TemplateCode\\": \\"DIGITAL_SMS_0001\\"\\n}","type":"json"}]',
],
'CreateSmsAppIcpRecord' => [
'summary' => 'The process for using a live app as a signature source has changed. If you use an app as the signature source, you must call this operation to create an ICP filing record for it.',
'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' => 'OSS key of the APP-ICP filing details screenshot ', 'description' => 'The fileKey for the screenshot of your app\'s ICP filing details.'."\n"
."\n"
.'1. To look up your ICP filing, go to the [MIIT service platform](https://beian.miit.gov.cn/#/Integrated/recordQuery), search for your filing, and open its details page.'."\n"
."\n"
.'2. The ICP filing screenshot must be uploaded to OSS and meet the following requirements:'."\n"
."\n"
.'- The filename cannot contain Chinese characters or special characters.'."\n"
."\n"
.'- The file must be an image in `jpg`, `png`, `gif`, or `jpeg` format. The file size cannot exceed 5 MB.'."\n"
."\n"
.'- The screenshot must show the full URL.'."\n"
."\n"
.'- For **Record Type**, select "APP".'."\n"
."\n"
.'- The **principal unit name** must be identical to the company or institution name on the qualification documents associated with the signature.'."\n"
."\n"
.'- The screenshot must clearly show the complete ICP record/license number.'."\n"
."\n"
.'- The **service name** must be identical to the **signature name**.'."\n"
."\n"
.'3. To obtain the fileKey, see [Upload files through OSS](~~2833114~~).', 'type' => 'string', 'required' => true, 'example' => ' '."\n"
.'123456/test1719383196031.jpg'."\n"],
],
[
'name' => 'AppServiceName',
'in' => 'query',
'schema' => ['title' => 'App service name', 'description' => 'The service name from your ICP filing. The name must not exceed 15 characters.', 'type' => 'string', 'required' => true, 'example' => '阿里云'],
],
[
'name' => 'AppPrincipalUnitName',
'in' => 'query',
'schema' => ['title' => 'Sponsoring Organization Name ', 'description' => 'The principal unit name from your ICP filing. The name must not exceed 50 characters.', 'type' => 'string', 'required' => true, 'example' => '阿里云计算有限公司'],
],
[
'name' => 'AppIcpLicenseNumber',
'in' => 'query',
'schema' => ['title' => 'ICP Filing/License Number ', 'description' => 'The ICP record/license number. The number must not exceed 15 characters.', 'type' => 'string', 'required' => true, 'example' => '浙B2-20080101'],
],
[
'name' => 'AppApprovalDate',
'in' => 'query',
'schema' => ['title' => 'Review pass date, for example, 2025-09-01', 'description' => 'The ICP filing approval date.', 'type' => 'string', 'required' => true, 'example' => '2025-05-22'],
],
[
'name' => 'Domain',
'in' => 'query',
'schema' => ['title' => 'Link to the APP Application Store', 'description' => 'The app store link.'."\n"
."\n"
.'> - The link must start with `http://` or `https://`.', 'type' => 'string', 'required' => true, 'example' => 'https://apps.apple.com/cn/app/阿里云/id981011420'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''],
'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates this unique identifier for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'."\n"],
'Message' => ['description' => 'The message returned with the request status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Data' => ['description' => 'The ID of the app\'s ICP filing record.', 'type' => 'string', 'title' => '', 'example' => '10000*******'],
'Code' => ['description' => 'The request status code.'."\n"
."\n"
.'- A value of `OK` indicates that the request was successful.'."\n"
."\n"
.'- For other error codes, see the [error code list](~~101346~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n"
."\n"
.'- **`true`**'."\n"
."\n"
.'- **`false`**', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'AppIcpRecordOssFileNotUploadError', 'errorMessage' => 'The APP-ICP record screenshot file is not uploaded.', 'description' => ''],
['errorCode' => 'AppIcpRecordDateNotMatchRegex', 'errorMessage' => 'The format of the APP-ICP record approval date is incorrect.', 'description' => ''],
['errorCode' => 'AppPrincipalUnitNameNotMatchRegex', 'errorMessage' => 'The principal unit name of the APP cannot be empty.', 'description' => ''],
['errorCode' => 'AppPrincipalUnitNameOverLimit', 'errorMessage' => 'The principal unit name of the APP exceeds the length limit.', 'description' => ''],
['errorCode' => 'AppIcpLicenseNumberNotMatchRegex', 'errorMessage' => 'The ICP record/license number cannot be empty.', 'description' => ''],
['errorCode' => 'AppIcpLicenseNumberOverLimit', 'errorMessage' => 'The ICP record/license number exceeds the length limit.', 'description' => ''],
['errorCode' => 'AppDomainNotMatchRegex', 'errorMessage' => 'The APP app store link cannot be empty and must start with http:// or https://.', 'description' => ''],
['errorCode' => 'AppDomainOverLimit', 'errorMessage' => 'The APP app store link exceeds the length limit.', 'description' => ''],
['errorCode' => 'AppApprovalDateNotValid', 'errorMessage' => 'The validity period of the APP-ICP record is not within the valid range.', 'description' => ''],
['errorCode' => 'AppIcpRecordPicsFileError', 'errorMessage' => 'The format of the APP-ICP record screenshot file is incorrect.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create an ICP Filing Entity ',
'description' => '><notice>To use a **live app** as a signature source, you must now provide its ICP filing information.></notice> This requires you to upload a screenshot of the app\'s ICP filing.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [],
'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"}]',
],
'CreateSmsAuthorizationLetter' => [
'summary' => 'If the qualification is intended for use by a third party or the requested signature involves third-party rights, you must obtain third-party authorization and create an authorization letter before submitting the application.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '264691',
'abilityTreeNodes' => ['FEATUREdysmsJ2BZAJ'],
],
'parameters' => [
[
'name' => 'AuthorizationLetterPic',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The fileKey of the authorization letter.'."\n"
."\n"
.'1. The authorization letter file uploaded to OSS. Download the [Authorization Letter Template](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), then fill it out and stamp it according to the [specifications](~~56741~~) before uploading. File upload requirements:'."\n"
.'- The name of the file to be uploaded cannot contain Chinese characters or special characters.'."\n"
.'- Only images in JPG, PNG, GIF, or JPEG format are supported, and the image must not exceed 5 MB.'."\n"
."\n"
.'2. To obtain the fileKey, see [Upload files through OSS](~~2833114~~).', 'type' => 'string', 'required' => true, 'example' => '123456/test1719383196031.jpg'],
],
[
'name' => 'SignList',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'The list of authorized signatures. The number of signatures cannot exceed 100.'."\n"
."\n"
.'> We recommend that you authorize all signatures that may be used at once in the authorization letter. This prevents subsequent signature applications from falling outside the scope of the authorization letter, which would cause review failure and require you to supplement the authorization letter.',
'type' => 'array',
'items' => ['title' => '', 'description' => 'The SMS signature name. Comply with the [Signature Specifications](~~108076~~). The length is limited to 2 to 12 characters. Words such as "测试" and "test" are not supported. Symbols such as 【】, (), and [] cannot be added. Special characters such as `、, ,, 。, and spaces` are not supported.', 'type' => 'string', 'required' => false, 'example' => '菜鸟网络'],
'required' => true,
'example' => '',
],
],
[
'name' => 'AuthorizationLetterExpDate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The validity period of the authorization letter. Format: `YYYY-MM-DD~YYYY-MM-DD`.'."\n"
."\n"
.'> The recommended validity period is 1 to 3 years. Set a reasonable time period and avoid making the validity period too long or too short.', 'type' => 'string', 'required' => true, 'example' => '2023-01-01~2026-01-01'],
],
[
'name' => 'Authorization',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorizing party, that is, the owner of the signature. Only the middle dot `·`, Chinese `【】()`, English `()`, and spaces are supported. Other symbols or purely numeric input are not allowed. The length cannot exceed 150 characters.', 'type' => 'string', 'required' => true, 'example' => '菜鸟网络科技有限公司'],
],
[
'name' => 'OrganizationCode',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The unified social credit code of the authorizing party. The length cannot exceed 150 characters. The credit code must be consistent with the unified social credit code field in the qualification information bound to the signature. Otherwise, the signature creation will fail.', 'type' => 'string', 'required' => true, 'example' => '9****************A'],
],
[
'name' => 'ProxyAuthorization',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorized party, that is, the signature applicant. Only the middle dot `·`, Chinese `【】()`, English `()`, and spaces are supported. Other symbols or purely numeric input are not allowed. The length cannot exceed 150 characters.', 'type' => 'string', 'required' => true, 'example' => '支付宝(中国)网络技术有限公司'],
],
[
'name' => 'AuthorizationLetterName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The name of the authorization letter. The name cannot be the same as any of your other authorization letters. Only Chinese characters, English characters, or a combination with numbers are supported. Symbols or purely numeric input are not allowed. The length cannot exceed 100 characters.', 'type' => 'string', 'required' => true, 'example' => '菜鸟公司授权书'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The detailed information about the access denial. This field is returned only when RAM verification fails.', 'type' => 'string', 'example' => '无', 'title' => ''],
'RequestId' => ['description' => 'The ID of the current request, which is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'."\n"],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Data' => ['description' => 'The ID of the authorization letter.', 'type' => 'string', 'title' => '', 'example' => '10000****'],
'Code' => ['description' => 'The status code of the request.'."\n"
."\n"
.'- OK indicates that the request was successful.'."\n"
.'- For other error codes, see the error code list in this chapter or [API Error Codes](~~101346~~) of this product.', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Success' => [
'description' => 'Indicates whether the API call was successful. Valid values:'."\n"
."\n"
.'- **true**: The call was successful.'."\n"
.'- **false**: The call failed.',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'AuthorizationLetterNameRepeat', 'errorMessage' => 'The authorization letter name is duplicated.', 'description' => ''],
['errorCode' => 'AuthorizationLetterDateNotMatchRegex', 'errorMessage' => 'The format of the authorization letter\'s effective and expiry date is incorrect.', 'description' => ''],
['errorCode' => 'AuthorizationLetterDateNotValid', 'errorMessage' => 'The current time is not within the validity period of the authorization letter.', 'description' => ''],
['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.', 'description' => ''],
['errorCode' => 'AuthorizationLetterNameOverLimit', 'errorMessage' => 'The authorization letter name exceeds the 100-character length limit.', 'description' => ''],
['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.', 'description' => ''],
['errorCode' => 'AuthorizationOssFileNotUploadError', 'errorMessage' => 'The authorization letter file has not been uploaded.', 'description' => ''],
['errorCode' => 'AuthorizationOverLimit', 'errorMessage' => 'The authorizer exceeds the 1000-character length limit.', 'description' => ''],
['errorCode' => 'ProxyAuthorizationOverLimit', 'errorMessage' => 'The authorized party exceeds the 1000-character length limit.', 'description' => ''],
['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.', 'description' => ''],
['errorCode' => 'SignNumOverLimit', 'errorMessage' => 'The signature exceeds the limit of 100 entries.', 'description' => ''],
['errorCode' => 'SignNotMatchRegex', 'errorMessage' => 'The signature length is limited to 2-12 characters and does not support some special characters.', 'description' => ''],
['errorCode' => 'OrganizationCodeOverLimit', 'errorMessage' => 'The organization code is limited to 150 characters.', 'description' => 'Social credit code is not allowed to exceed 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' => 'Create an Authorization Letter',
'description' => '- Before use, please read the [Authorization Letter Specifications](~~56741~~). Download the [Authorization Letter Template](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), fill it out and stamp it according to the specifications, and then upload it.'."\n"
.'- The authorization letter you create can be used when applying for SMS qualifications or SMS signatures. If your qualification or signature is intended for use by a third party, you must create and submit an authorization letter.'."\n"
.'- After creating an authorization letter, you can call [QuerySmsAuthorizationLetter](~~QuerySmsAuthorizationLetter~~) to query the details of the created authorization letter. Authorization letter information created through the API is synchronized to the Short Message Service console.',
'changeSet' => [
['createdAt' => '2025-08-01T04:05:19.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [],
],
'CreateSmsSign' => [
'summary' => 'An SMS signature identifies the sender of an SMS message. Before sending SMS messages, you must apply for a signature and a template. The system prepends the approved SMS signature to the message content and sends them together to the recipient.',
'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' => 'The signature name. The signature name must comply with the [signature specifications](~~108076#section-0p8-qn8-mmy~~):'."\n"
."\n"
.'- The name must be 2 to 12 characters in length and cannot contain words such as "test".'."\n"
."\n"
.'- The name cannot contain symbols such as 【】, (), or []. Special characters such as commas, periods, and spaces are not supported.'."\n"
."\n"
.'> - Signature names are case-sensitive. For example, 【Aliyun通信】 and 【aliyun通信】 are treated as two different signatures.'."\n"
.'> - If your verification code signature and general-purpose signature have the same name, the system uses the general-purpose signature to send SMS messages by default.', 'type' => 'string', 'required' => true, 'example' => '阿里云验证码', 'title' => ''],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => ['description' => 'The description of the SMS signature scenario. This is one of the reference materials for signature review. The description can be up to 200 characters in length.'."\n"
.'> - You can describe the scenarios of your online service and provide links to the actual business website or marketplace download page.'."\n"
.'> - You can provide a complete SMS example that reflects your business scenario.'."\n"
.'> - You can provide the pass parameter content of variables and describe in detail the business scenario and the reason for selecting the variable property.'."\n"
.'> - If the signature involves a government or public institution, specify the landline phone number of the institution.'."\n"
."\n"
.'A well-documented application description improves the review efficiency for signatures and templates. Failure to follow the specifications or leaving this field empty may affect the approval of your signature.', 'type' => 'string', 'required' => false, 'maxLength' => 500, 'example' => '登录场景使用验证码', 'title' => ''],
],
[
'name' => 'SignType',
'in' => 'query',
'schema' => ['description' => 'The signature type. Valid values:'."\n"
."\n"
.'- **0**: verification code.'."\n"
."\n"
.'- **1**: general-purpose (default).'."\n"
."\n"
.'We recommend that you use the default value: **general-purpose**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'MoreData',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The supplementary materials. Upload business proof files or business screenshots to help reviewers understand your business details. See [Signature application materials](~~108076#section-xup-k46-yi4~~) and upload the relevant materials.',
'type' => 'array',
'items' => ['description' => 'The information about the file uploaded to OSS. For file upload operations, see [Upload files to OSS](~~2833114~~).', 'type' => 'string', 'required' => false, 'example' => '10098689758*****/123qwe.png', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'QualificationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the approved qualification.'."\n"
."\n"
.'> - Before applying for an SMS signature, [apply for a qualification](~~2539801~~).'."\n"
.'> - You can view the qualification ID on the [Qualification Management](https://dysms.console.aliyun.com/domestic/text/qualification) page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '8563**', 'title' => ''],
],
[
'name' => 'ApplySceneContent',
'in' => 'query',
'schema' => ['description' => '><notice> The signature source of launched apps is no longer supported.></notice>'."\n"
.'The app store link. If the signature source is a launched app, that is, SignSource is set to 2, specify a link that starts with http:// or https:// and make sure the app is already launched.', 'type' => 'string', 'required' => false, 'example' => 'http://www.aliyun.com/', 'title' => ''],
],
[
'name' => 'SignSource',
'in' => 'query',
'schema' => [
'description' => 'The signature source. Valid values:'."\n"
."\n"
.'- **0**: full name or abbreviation of an enterprise or public institution. **(Recommended)**'."\n"
.'- **5**: full name or abbreviation of a trademark.'."\n"
.'- **2**: full name or abbreviation of an app. **(Not recommended)**'."\n"
."\n"
.'For more information about signature sources, see [Signature sources](~~108076#section-fow-bfu-wo9~~).',
'enumValueTitles' => [],
'type' => 'integer',
'format' => 'int32',
'required' => true,
'enum' => ['0', '1', '2', '3', '4', '5'],
'example' => '0',
'title' => '',
],
],
[
'name' => 'ThirdParty',
'in' => 'query',
'schema' => ['description' => 'The signature purpose. Valid values:'."\n"
."\n"
.'- false: for personal use (default). The signature is the enterprise name, website, or product name verified under this account.'."\n"
."\n"
.'- true: for third-party use. The signature is the enterprise name, website, or product name not verified under this account.'."\n"
.'><notice>If the signature is for personal use, select a qualification ID for personal use. If the signature is for third-party use, select a qualification ID for third-party use.></notice>.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'AuthorizationLetterId',
'in' => 'query',
'schema' => ['description' => 'The ID of the power of attorney. When the signature is for third-party use, this parameter is required. Otherwise, the signature review will not pass. The unified social credit code in the power of attorney must match the unified social credit code in the qualification information bound to the signature. Otherwise, the signature creation fails.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000********1234', 'title' => ''],
],
[
'name' => 'TrademarkId',
'in' => 'query',
'schema' => ['description' => 'The trademark entity ID.'."\n"
.'> - 1. This parameter is required when SignSource is set to 5.'."\n"
.'> - 2. You can obtain the trademark entity ID by calling the [CreateSmsTrademark](~~CreateSmsTrademark~~) operation.'."\n"
.'> - 3. Based on carrier real-name registration requirements, provide the relevant field information. Otherwise, the probability of review rejection or carrier registration failure increases significantly.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000009081***', 'title' => ''],
],
[
'name' => 'AppIcpRecordId',
'in' => 'query',
'schema' => ['description' => 'The APP-ICP filing entity ID.'."\n"
.'> - This parameter is required when SignSource is set to 2.'."\n"
.'> - You can obtain the filing entity ID by calling the [CreateSmsAppIcpRecord](~~CreateSmsAppIcpRecord~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000****029', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot issues.', 'type' => 'string', 'example' => 'CCA2BCFF-2BA7-427C-90EE-AC6994748623', 'title' => ''],
'Code' => ['description' => 'The request status code. Valid values:'."\n"
."\n"
.'- OK: The request was successful.'."\n"
.'- For other error codes, see [Error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'SignName' => ['description' => 'The signature name.', 'type' => 'string', 'example' => '阿里云', 'title' => ''],
'OrderId' => ['description' => 'The ticket number.'."\n"
."\n"
.'Reviewers use this parameter when querying reviews. Provide this ticket number if you need to expedite the review.', 'type' => 'string', 'example' => '2004415****', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => ''],
['errorCode' => 'ParameterMismatch.ThirdParty', 'errorMessage' => 'The type of signature, whether for personal use or for a third party, should be consistent with the qualifications.', 'description' => 'Whether the signature is used by a third party should be consistent with the qualification.'],
['errorCode' => 'SignName.Exists', 'errorMessage' => 'Sorry, this signature already exists and cannot be applied for again.', 'description' => 'Sorry, this signature already exists and cannot be reapplied.'],
['errorCode' => 'InvalidQualification', 'errorMessage' => 'The qualification should be approved.', 'description' => 'Invalid qualification, qualification should be approved.'],
['errorCode' => 'InvalidSignName', 'errorMessage' => 'The signature cannot contain spaces, special '."\n"
.'symbols, or all numbers.', 'description' => 'The signature cannot contain special characters such as simplified Chinese, English, or spaces other than digits, and cannot be all digits.'],
['errorCode' => 'InvalidApplySceneContent', 'errorMessage' => 'For certain signature sources, the '."\n"
.'applySceneContent should be an HTTP or HTTPS link.', 'description' => 'invalid application scenario, under some signature sources,'."\n"
.'The application scenario should be an HTTP or HTTPS link.'],
['errorCode' => 'MissApplySceneContent', 'errorMessage' => 'In some signature sources, the applySceneContent is required.', 'description' => 'Under some signature sources, the application scenario is required.'],
['errorCode' => 'MissingSignName', 'errorMessage' => 'The signature name cannot be empty.', 'description' => '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.', 'description' => '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.', 'description' => ''],
['errorCode' => 'SmsSignNotAuthorized', 'errorMessage' => 'the signature is not in the sign scope of the authorization letter.', 'description' => 'The signature is not within the scope of the authorization.'],
['errorCode' => 'TrademarkNotExist', 'errorMessage' => 'The trademark does not exist.', 'description' => ''],
['errorCode' => 'AppIcpRecordNotExist', 'errorMessage' => 'The APP-ICP record does not exist.', 'description' => ''],
],
404 => [
['errorCode' => 'QualificationNotFound', 'errorMessage' => 'Qualification does not exist.', 'description' => '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' => 'Apply for an SMS signature (new operation)',
'description' => '- For details about the changes between the new and original operations, see [Announcement on updating signature and template operations for Short Message Service](~~2806975~~).'."\n"
."\n"
.'- Users who verify your identity - Individual account can apply for one formal signature per calendar day per Alibaba Cloud account. Users who verify your identity - Enterprise account currently have no such limit. For details about the differences between individual and enterprise user privileges, see [Before you begin](~~55324~~).'."\n"
."\n"
.'- Read the [Signature specifications](~~108076~~) to learn about the SMS signature review standards.'."\n"
.'- Signatures applied for through the API are synchronized to the Short Message Service console. For console-related operations, see [SMS signatures](~~108073~~).'."\n"
."\n"
.'- After you submit a signature application, you can call the [GetSmsSign](~~2807429~~) operation to query the signature review status and details. You can also [configure receipt messages](~~101508~~) and use [SignSmsReport](~~120998~~) to obtain the signature review status messages.',
'changeSet' => [
['createdAt' => '2025-12-16T07:31:35.000Z', 'description' => 'Error codes changed, Request parameters changed'],
['createdAt' => '2025-12-11T12:44:31.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-12-11T12:44:31.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-12-11T10:08:22.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-12-11T10:08:22.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-14T02:14:07.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-14T02:14:00.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-14T02:07:46.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-03T13:14:42.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-03T13:14:37.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-03T13:14:01.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-03T13:14:00.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSmsSign'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'dysms:CreateSmsSign',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CreateSmsTemplate' => [
'summary' => 'A message template defines the content of an SMS message. This content includes the message text and any variables. You can create templates for various business needs, such as sending verification codes, notifications, or promotional messages. A template must be approved before you can use it to send messages.',
'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' => 'The template name. The name must be 30 characters or less.', 'type' => 'string', 'required' => true, 'example' => '验证码', 'maxLength' => 30, 'title' => ''],
],
[
'name' => 'TemplateContent',
'in' => 'query',
'schema' => ['description' => 'The template content. The content must be 500 characters or less.'."\n"
."\n"
.'The template content and variables must comply with the [SMS Template Specifications](~~463161~~). Templates that do not comply may be rejected. You can find common template examples on the [Apply for Template](https://dysms.console.aliyun.com/domestic/text/template/add) page. Using these examples can speed up the review process and increase the approval rate. For variable specifications, see [Variable Specifications for the TemplateContent Parameter](~~2806243~~).', 'type' => 'string', 'required' => true, 'example' => '您正在申请手机注册,验证码为:${code},5分钟内有效!'."\n", 'maxLength' => 500, 'title' => ''],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => ['description' => 'Describe the business scenario for the SMS messages, or provide a URL for online scenarios. You must also provide a complete SMS example with actual values for any variables. Complete information increases the chance of template approval. Templates that do not provide this information as specified may be rejected.', 'type' => 'string', 'required' => false, 'example' => '申请验证码短信', 'maxLength' => 500, 'title' => ''],
],
[
'name' => 'TemplateType',
'in' => 'query',
'schema' => [
'description' => 'The SMS type. Valid values:'."\n"
."\n"
.'- **0**: verification code.'."\n"
."\n"
.'- **1**: notification message.'."\n"
."\n"
.'- **2**: promotional message.'."\n"
."\n"
.'- **3**: international/Hong Kong, Macao, and Taiwan messages.'."\n"
."\n"
.'> Only enterprise-verified users can apply for promotional messages or international/Hong Kong, Macao, and Taiwan messages. For more information about the differences in privileges between individual and enterprise users, see [Usage Notes](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'],
'title' => '',
],
],
[
'name' => 'RelatedSignName',
'in' => 'query',
'schema' => ['description' => 'The name of the signature to associate with the template. The signature must be an approved signature.'."\n"
."\n"
.'><notice>'."\n"
."\n"
.'- This parameter is required if **TemplateType** is set to **0**, **1**, or **2**.'."\n"
."\n"
.'- Associating a signature can expedite the review process. The signature associated here is unrelated to the one you select when sending SMS messages.'."\n"
."\n"
.'></notice>', 'type' => 'string', 'required' => false, 'example' => '验证码签名', 'title' => ''],
],
[
'name' => 'TemplateRule',
'in' => 'query',
'schema' => ['description' => 'The rules for variables in the template. For instructions on how to define these rules, see [Sample Document](~~2806243~~).'."\n"
."\n"
.'> - This parameter is required if the message template contains variables.', 'type' => 'string', 'required' => false, 'example' => '{"code":"characterWithNumber2"}'."\n", 'title' => ''],
],
[
'name' => 'MoreData',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'Additional information. You can upload supporting documents or business screenshots to help reviewers better understand your business scenario. If you are applying for a promotional message template (where `TemplateType` is `2`), you must upload user authorization materials. For more information, see [Specifications for Uploading User Authorization Materials](~~312341~~).',
'type' => 'array',
'items' => ['description' => 'The OSS object key for the uploaded file. For instructions on how to upload a file, see [Upload a file to OSS](~~2833114~~).', 'type' => 'string', 'required' => false, 'example' => '10098689758*****/1234qwe.png', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'ApplySceneContent',
'in' => 'query',
'schema' => ['description' => 'The business scenario.'."\n"
."\n"
.'- If the associated signature\'s use case is "Live App", `ApplySceneContent` must be an app URL that starts with `http://` or `https://`.'."\n"
."\n"
.'- This parameter is required if the associated signature\'s use case is "Registered Trademark Name" or "organization name".', 'type' => 'string', 'required' => false, 'example' => 'http://www.aliyun.com/'."\n", 'title' => ''],
],
[
'name' => 'IntlType',
'in' => 'query',
'schema' => ['description' => 'The type of the template for international/Hong Kong, Macao, and Taiwan messages. This parameter is required when **TemplateType** is set to **3**. Valid values:'."\n"
."\n"
.'- **0**: notification message.'."\n"
."\n"
.'- **1**: promotional message.'."\n"
."\n"
.'- **2**: verification code.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'TrafficDriving',
'in' => 'query',
'schema' => ['description' => '><warning>'."\n"
."\n"
.'To control the security of SMS content, messages that contain traffic-driving information, such as phone numbers and links, may be blocked by carriers, which can lead to delivery failures. To reduce this risk, we recommend that you avoid including such information in message templates.'."\n"
."\n"
.'></warning>'."\n"
."\n"
.'A JSON string that contains a list of traffic-driving information.'."\n"
.'><notice>The value must be a JSON array serialized into a string.></notice>'."\n"
."\n"
.'### 1. Fields'."\n"
."\n"
.'{'."\n"
.'"trafficDrivingType":"traffic driving type",'."\n"
.'"trafficDrivingContent":"traffic driving content",'."\n"
.'"variableName":"variable name",'."\n"
.'"companyName":"organization name",'."\n"
.'"organizationCode":"unified social credit code",'."\n"
.'"icpNo":"ICP filing or license number",'."\n"
.'"icpPicOssKey":"OSS key of the ICP filing screenshot",'."\n"
.'"companyDifferentFromSignQuaReason":"Reason for the discrepancy between the organization name and the signature qualification"'."\n"
.'}'."\n"
."\n"
.'### 2. Notes'."\n"
."\n"
.'- If the content is not a variable, do not pass the `variableName` parameter.'."\n"
."\n"
.'- If the organization name is different from the one in the signature qualification, pass the `companyDifferentFromSignQuaReason` parameter.'."\n"
."\n"
.'- If `trafficDrivingType` is set to `DOMAIN`, all parameters in this object are required.'."\n"
."\n"
.'- If `trafficDrivingType` is set to another value, pass the `trafficDrivingType`, `trafficDrivingContent`, `variableName` (if applicable), `companyName`, `organizationCode`, and `companyDifferentFromSignQuaReason` (if applicable) parameters.'."\n"
."\n"
.'### 3. trafficDrivingType enum values'."\n"
."\n"
.'><warning>'."\n"
."\n"
.'Due to regulatory requirements, mobile phone numbers are not supported.'."\n"
."\n"
.'></warning>'."\n"
."\n"
.'- DOMAIN: A domain link.'."\n"
."\n"
.'- FIXED\\_PHONE: Fixed-line phone.'."\n"
."\n"
.'- 400\\_PHONE: Phone number prefixed with 400.'."\n"
."\n"
.'- 800\\_PHONE: Phone number prefixed with 800.'."\n"
."\n"
.'- 95\\_PHONE: Phone number prefixed with 95.'."\n"
."\n"
.'- 96\\_PHONE: Phone number prefixed with 96.'."\n"
."\n"
.'- 1\\_PHONE: A 3- to 8-digit phone number that starts with 1.'."\n"
."\n"
.'- OTHER\\_PHONE: Other phone number.', '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":"这是一段说明文字"}]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE991', 'title' => ''],
'Code' => ['description' => 'The status code of the request. Valid values:'."\n"
."\n"
.'- OK: The request was successful.'."\n"
."\n"
.'- For other error codes, see the **Error codes** list in this topic or [API Error Codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'TemplateName' => ['description' => 'The name of the message template.', 'type' => 'string', 'example' => '验证码模板', 'title' => ''],
'TemplateCode' => ['description' => 'The code of the message template.'."\n"
."\n"
.'After you submit a template application, you can use the template code to call the [GetSmsTemplate](~~2807433~~) operation and query the review details of the template. You can also [configure delivery receipts](~~101508~~) to receive the review status of the template in the [TemplateSmsReport](~~120999~~) message.', 'type' => 'string', 'example' => 'SMS_10000****', 'title' => ''],
'OrderId' => ['description' => 'The ticket ID.'."\n"
."\n"
.'Reviewers use this ID to check the review status. You must provide this ID when you request an expedited review.', 'type' => 'string', 'example' => '2005020****', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => ''],
['errorCode' => 'AssocSignUnapproved', 'errorMessage' => 'Associated signature must be approved.', 'description' => 'The associated signature needs to use the approved signature.'],
['errorCode' => 'InvalidTemplateRule.Format', 'errorMessage' => 'The parameter TemplateRule format must be JSON.', 'description' => 'Template variable rules must be filled with JSON-formatted data.'],
['errorCode' => 'InvalidMoreData', 'errorMessage' => 'Specified parameter MoreData is not valid.', 'description' => 'The uploaded more information is invalid.'],
['errorCode' => 'TemplateVarLimitExceeded', 'errorMessage' => 'The verification code template only supports one variable.', 'description' => 'The verification code template only supports one variable.'],
['errorCode' => 'InvalidTemplateContent.Format', 'errorMessage' => 'Invalid template content format.', 'description' => 'The template content is not in the correct format.'],
['errorCode' => 'InvalidTemplateRule', 'errorMessage' => 'The template variable format is non-standard. Please refer to the variable format specifications in the help documentation.', 'description' => 'The template variable does not meet the specifications. Please check the SMS template specification document and pass in the template variable that meets the requirements.'],
['errorCode' => 'ServiceNotOpened', 'errorMessage' => 'This product service is not opened.', 'description' => 'Product service not activated'],
],
404 => [
['errorCode' => 'MissingTemplateName', 'errorMessage' => 'The template name cannot be empty.', 'description' => 'Template name cannot be empty.'],
['errorCode' => 'SmsSignatureNotFound', 'errorMessage' => 'The associated SMS signature does not exist.', 'description' => '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' => 'Apply for SMS Template (New Interface)',
'description' => '- For details on the API changes for signatures and templates, see the [Announcement on Signature and Template API Updates for Short Message Service](~~2806975~~).'."\n"
."\n"
.'- Wait at least 30 seconds between API calls when applying for a message template.'."\n"
."\n"
.'- Message templates you apply for via the API are synchronized to the Short Message Service console. For details on how to manage message templates in the console, see [Message templates](~~108085~~).'."\n"
."\n"
.'- After you submit a template for review, you can call the [GetSmsTemplate](~~2807433~~) API to query the template\'s review status and details. You can also [configure status reports](~~101508~~) to receive the template\'s review status through [TemplateSmsReport](~~120999~~).'."\n"
."\n"
.'- Message templates for Chinese mainland messages and international messages are not interchangeable. Apply for message templates based on your use case.'."\n"
."\n"
.'- Only enterprise-verified users can apply for message templates for promotional messages and international messages. For details on the permission differences between individual and enterprise users, see [Usage notes](~~55324~~).',
'changeSet' => [
['createdAt' => '2025-08-12T14:41:31.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-08-12T14:41:26.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-08-12T14:37:16.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-08-12T14:37:06.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-08-12T14:37:03.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-08-12T08:38:21.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-08-12T07:59:59.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSmsTemplate'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'dysms:CreateSmsTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CreateSmsTrademark' => [
'summary' => 'Creates a trademark entity. This operation is used when you need to upload trademark information when the signature source is set to trademark.',
'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' => '', 'description' => 'The fileKey of the trademark details screenshot.'."\n"
."\n"
.'1. How to query a trademark:'."\n"
.'- Log on to the China Trademark Network, click **Trademark Online Query**, and take a screenshot of the trademark details.'."\n"
.'- Accept the terms of use and enter the **Application/Registration Number** to query.'."\n"
.'- Click the **Application/Registration Number** to view the details.'."\n"
."\n"
.'2. Information about the trademark file uploaded to OSS. File upload requirements:'."\n"
.'- The name of the file to be uploaded cannot contain Chinese characters or special characters.'."\n"
.'- Only images in JPG, PNG, GIF, and JPEG formats are supported, and the image size cannot exceed 5 MB.'."\n"
.'- The screenshot must contain the complete URL.'."\n"
.'- The trademark image must be clear and identical to the **signature name**.'."\n"
.'- The **applicant name** must be identical to the name of the enterprise or institution associated with the signature.'."\n"
.'- The trademark status must be registered trademark.'."\n"
."\n"
.'3. To obtain the fileKey, see [Upload files to OSS](~~2833114~~).', 'type' => 'string', 'required' => true, 'example' => '123456/test1719383196031.jpg'],
],
[
'name' => 'TrademarkRegistrationNumber',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The trademark registration number. The value can be up to 15 characters in length.', 'type' => 'string', 'required' => true, 'example' => '766905'],
],
[
'name' => 'TrademarkName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The trademark name. The value can be up to 15 characters in length.', 'type' => 'string', 'required' => true, 'example' => '阿里云'],
],
[
'name' => 'TrademarkApplicantName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The name of the applicant. The value can be up to 50 characters in length.', 'type' => 'string', 'required' => true, 'example' => '阿里巴巴(中国)有限公司'],
],
[
'name' => 'TrademarkEffExpDate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The effective and expiration dates of the exclusive right.', 'type' => 'string', 'required' => true, 'example' => '2010-12-14~2030-12-13'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'title' => '', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Data' => ['description' => 'The trademark ID.', 'type' => 'string', 'title' => '', 'example' => '10000*******'],
'Code' => ['description' => 'The status code of the request.'."\n"
."\n"
.'* If OK is returned, the request was successful.'."\n"
.'* For other error codes, see the error code list in this topic or [API error codes](~~101346~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n"
."\n"
.'- **true**: The call was successful.'."\n"
."\n"
.'- **false**: The call failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'TrademarkOssFileNotUploadError', 'errorMessage' => 'The trademark screenshot file is not uploaded.', 'description' => ''],
['errorCode' => 'TrademarkLetterDateNotMatchRegex', 'errorMessage' => 'The format of the trademark\'s validity period is incorrect.', 'description' => ''],
['errorCode' => 'TrademarkNameNotMatchRegex', 'errorMessage' => 'The trademark name cannot be empty.', 'description' => ''],
['errorCode' => 'TrademarkNameOverLimit', 'errorMessage' => 'The trademark name exceeds the length limit.', 'description' => ''],
['errorCode' => 'TrademarkRegistrationNumberNotMatchRegex', 'errorMessage' => 'The trademark registration number cannot be empty.', 'description' => ''],
['errorCode' => 'TrademarkRegistrationNumberOverLimit', 'errorMessage' => 'The trademark registration number exceeds the length limit.', 'description' => ''],
['errorCode' => 'TrademarkApplicantNameNotMatchRegex', 'errorMessage' => 'The trademark applicant cannot be empty.', 'description' => ''],
['errorCode' => 'TrademarkApplicantNameOverLimit', 'errorMessage' => 'The trademark applicant exceeds the length limit.', 'description' => ''],
['errorCode' => 'TrademarkDateNotValid', 'errorMessage' => 'The trademark\'s validity period is not within the valid range.', 'description' => ''],
['errorCode' => 'TrademarkPicsFileError', 'errorMessage' => 'The format of the trademark screenshot file is incorrect.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create a trademark entity',
'description' => 'The trademark must be searchable on the China Trademark Network of the Trademark Office of the China National Intellectual Property Administration, and the trademark owner must match the enterprise name.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [],
'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"}]',
],
'DeleteShortUrl' => [
'summary' => 'Deletes a short URL. After deletion, the short URL is no longer usable and cannot be resolved to the source URL.',
'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' => 'The source URL. The URL must not exceed 1,000 characters.'."\n"
."\n"
.'><notice>'."\n"
."\n"
.'Short Message Service does not currently support this API operation.'."\n"
."\n"
.'></notice>', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'https://www.****.com/product/sms', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The status code of the request.'."\n"
."\n"
.'- `OK` indicates the request was successful.'."\n"
."\n"
.'- For other error codes, see [Error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF', 'title' => ''],
],
'description' => 'The data returned.',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\"\\n}","type":"json"}]',
'title' => 'DeleteShortUrl',
'description' => '><notice>'."\n"
."\n"
.'Short Message Service does not currently support this API operation.'."\n"
."\n"
.'></notice>'."\n"
."\n"
.'### QPS limit'."\n"
."\n"
.'The QPS limit for a single user is 100. Calls that exceed this limit are subject to rate limiting, which may affect your business. To prevent disruptions, call this operation at a reasonable frequency.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteShortUrl'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'dysms:DeleteShortUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DeleteSmsQualification' => [
'summary' => 'If you no longer use an SMS qualification or need to delete it for other reasons, call this API or delete the SMS qualification in the Short Message Service console.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '264874',
'abilityTreeNodes' => ['FEATUREdysmsJ2BZAJ'],
],
'parameters' => [
[
'name' => 'QualificationGroupId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The qualification ID, which is the ID returned when you [apply for a qualification](~~SubmitSmsQualification~~). You can obtain the qualification ID under the current account by calling the [QuerySmsQualificationRecord](~~QuerySmsQualificationRecord~~) operation, or on the [Qualification Management](https://dysms.console.aliyun.com/domestic/text/qualification) page of Domestic Messages in the console.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000****'],
],
[
'name' => 'OrderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The review ticket ID. You can obtain the qualification and its corresponding review ticket ID under the current account by calling the [QuerySmsQualificationRecord](~~QuerySmsQualificationRecord~~) operation, or on the [Qualification Management](https://dysms.console.aliyun.com/domestic/text/qualification) page of Domestic Messages in the console.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2001****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The details about the access denial. This field is returned only when the RAM verification fails.', 'type' => 'string', 'example' => '无', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot and locate problems.', 'type' => 'string', 'title' => '', 'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA'."\n"],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Data' => [
'description' => 'Indicates whether the deletion is successful. Valid values:'."\n"
."\n"
.'- **true**: success.'."\n"
.'- **false**: failure.',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
'Code' => ['description' => 'The request status code.'."\n"
."\n"
.'- The value OK indicates that the request was successful.'."\n"
.'- For more information, see the error code list in this topic or the product [error code list](~~101346~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Success' => [
'description' => 'Indicates whether the API call is successful. Valid values:'."\n"
."\n"
.'- **true**: The call is successful.'."\n"
.'- **false**: The call fails.',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'QualificationNotExist', 'errorMessage' => 'Qualification does not exist.', 'description' => ''],
['errorCode' => 'BindSignDeleteFailed', 'errorMessage' => 'The qualification is bound to a signature and cannot be deleted temporarily.', 'description' => ''],
],
],
'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' => 'Delete an SMS qualification',
'description' => '><warning>Once a qualification is deleted, it cannot be restored or selected when you apply for signatures later. Proceed with caution.></warning>'."\n"
.'- Qualifications under review cannot be modified or deleted. You can withdraw the application in the Short Message Service [console](https://dysms.console.aliyun.com/domestic/text/qualification) before performing the operation.'."\n"
.'- Approved qualifications that have been bound to signatures cannot be deleted.'."\n"
.'- Rejected qualifications can be directly resubmitted for review after you [modify the qualification information](~~UpdateSmsQualification~~).',
'changeSet' => [
['createdAt' => '2025-08-01T04:05:19.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [],
],
'DeleteSmsSign' => [
'summary' => 'If you no longer use an SMS signature and need to delete it, call this operation or delete the SMS signature in the SMS Service console.',
'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' => 'The SMS signature. You can delete signatures that are in the Withdrawn, Failed, or Approved state. You cannot delete signatures that are in the Pending Approval state.'."\n"
."\n"
.'You can call the [QuerySmsSignList](~~419282~~) operation to query the signatures that have been applied for under the current account, or view the signature list on the [Signature Management](https://dysms.console.aliyun.com/domestic/text/sign) page in the SMS console.'."\n"
.'><notice>Deleted SMS signatures cannot be recovered, and the signature can no longer be used to send SMS messages. Proceed with caution.></notice>', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '阿里云', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The HTTP status code.'."\n"
."\n"
.'* The value OK indicates that the request was successful.'."\n"
.'* For information about other return values, see [Error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D****', 'title' => ''],
'SignName' => ['description' => 'The name of the deleted signature.', 'type' => 'string', 'example' => '阿里云', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D****\\",\\n \\"SignName\\": \\"阿里云\\"\\n}","type":"json"}]',
'title' => 'Delete an SMS signature',
'description' => '- You can delete signatures that are in the Withdrawn, Failed, or Approved state. You cannot delete signatures that are in the Pending Approval state.'."\n"
.'- Deleted SMS signatures cannot be recovered, and the signature can no longer be used to send SMS messages. Proceed with caution.'."\n"
.'- Signature deletion operations performed via the API are synchronized to the SMS Service console. For information about how to manage templates in the console, see [SMS signatures](~~108073~~).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSmsSign'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'dysms:DeleteSmsSign',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DeleteSmsTemplate' => [
'summary' => 'Deletes an SMS template that you no longer need.',
'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' => 'The SMS template code. You can delete SMS templates that are recalled, rejected, or approved. You cannot delete SMS templates that are being reviewed.'."\n"
."\n"
.'- You can call the [QuerySmsTemplateList](~~419288~~) operation to obtain the SMS template code.'."\n"
."\n"
.'- You can also obtain the SMS template code on the [Template Management](https://dysms.console.aliyun.com/domestic/text/template) page of the Short Message Service (SMS) console.'."\n"
.'><notice>Deleted SMS templates cannot be recovered and cannot be used to send messages. Proceed with caution.></notice>.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SMS_152550****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[API错误码](~~101346~~)。', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CCA2BCFF-2BA7-427C-90EE-AC6994748607', 'title' => ''],
'TemplateCode' => ['description' => '已删除的模板Code。', 'type' => 'string', 'example' => 'SMS_152550****', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"CCA2BCFF-2BA7-427C-90EE-AC6994748607\\",\\n \\"TemplateCode\\": \\"SMS_152550****\\"\\n}","type":"json"}]',
'title' => 'Delete an SMS template',
'description' => '- 支持删除已撤回、审核失败或审核通过的模板,审核中的短信模板不支持删除。'."\n"
.'- 删除短信模板后不可恢复,且后续不可再使用该模板发送短信,请谨慎操作。'."\n"
.'- 通过接口删除模板的操作会在短信服务控制台同步,在控制台对模板的相关操作,请参见[短信模板](~~108085~~)。'."\n"
."\n\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为1000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSmsTemplate'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'dysms:DeleteSmsTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GetCardSmsDetails' => [
'summary' => 'Queries the card SMS sending records and sending status of a single phone number.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => ['description' => 'The current page number when you paginate sending records.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of card SMS records to display on each page when you paginate sending records.'."\n"
."\n"
.'Valid values: 1 to 50.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'SendDate',
'in' => 'query',
'schema' => ['description' => 'The card SMS sending date. Records from the last 30 days can be queried.'."\n"
."\n"
.'Format: yyyyMMdd. For example, 20240112.', 'type' => 'string', 'required' => true, 'example' => '20240112', 'title' => ''],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
'schema' => ['description' => 'The domestic mobile phone number that received the SMS. Format: an 11-digit mobile phone number. For example, 1390000****.', 'type' => 'string', 'required' => true, 'example' => '1390000****', 'title' => ''],
],
[
'name' => 'BizCardId',
'in' => 'query',
'schema' => ['description' => 'The card SMS sending ID. When you send a card SMS by calling the [SendCardSms](~~434120~~) or [SendBatchCardSms](~~434119~~) operation, obtain the BizCardId field from the response.', 'type' => 'string', 'required' => false, 'example' => '123456^0', 'title' => ''],
],
[
'name' => 'BizSmsId',
'in' => 'query',
'schema' => ['description' => 'The text SMS sending ID. When you send a card SMS by calling the [SendCardSms](~~434120~~) or [SendBatchCardSms](~~434119~~) operation, obtain the BizSmsId field from the response.', 'type' => 'string', 'required' => false, 'example' => '1234576^0', 'title' => ''],
],
[
'name' => 'BizDigitId',
'in' => 'query',
'schema' => ['description' => 'The digital SMS sending ID. When you send a card SMS by calling the [SendCardSms](~~434120~~) or [SendBatchCardSms](~~434119~~) operation, obtain the BizDigitalId field from the response.', 'type' => 'string', 'required' => false, 'example' => '12346^0', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The returned information.',
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The access denied details. This parameter is returned only when the RAM check fails.', 'type' => 'string', 'example' => '无', 'title' => ''],
'Message' => ['title' => '', 'description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK'."\n"],
'CardSendDetailDTO' => [
'title' => '',
'description' => 'The card SMS sending result.',
'type' => 'object',
'properties' => [
'TotalCount' => ['title' => '', 'description' => 'The total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'CurrentPage' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Records' => [
'description' => 'The list of card SMS sending records.',
'type' => 'array',
'items' => [
'description' => 'The card SMS sending record.',
'type' => 'object',
'properties' => [
'TemplateCode' => ['title' => '', 'description' => 'The template code.', 'type' => 'string', 'example' => 'CARD_SMS_6***'],
'RenderDate' => ['title' => '', 'description' => 'The render time.', 'type' => 'string', 'example' => '2024-09-27 12:13:39'],
'ReceiveDate' => ['title' => '', 'description' => 'The receive time.', 'type' => 'string', 'example' => '2024-09-27 11:26:35'],
'RenderStatus' => ['title' => '', 'description' => 'The parsing status. Valid values:'."\n"
."\n"
.'- 0: not parsed.'."\n"
.'- 1: parsed successfully.'."\n"
.'- 3: not parsed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ReceiveType' => ['title' => '', 'description' => 'The SMS receive type.', 'type' => 'string', 'example' => 'CARD_SMS'],
'SendStatus' => ['title' => '', 'description' => 'The sending status. Valid values:'."\n"
."\n"
.'- 1: sending.'."\n"
.'- 2: sending failed.'."\n"
.'- 3: sending succeeded.'."\n"
.'- 4: addressing failed.', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'OutId' => ['title' => '', 'description' => 'The outId passed by the customer.', 'type' => 'string', 'example' => '12345678'],
'PhoneNumber' => ['title' => '', 'description' => 'The phone number that received the SMS.', 'type' => 'string', 'example' => '156****9080'],
'SmsContent' => ['title' => '', 'description' => 'The SMS content. Only text SMS has a value.', 'type' => 'string', 'example' => '您收到一条短信消息'],
'SendDate' => ['title' => '', 'description' => 'The SMS sending time.', 'type' => 'string', 'example' => '2024-09-27 11:26:32'],
'ErrCode' => ['title' => '', 'description' => 'The sending error code.', 'type' => 'string', 'example' => 'Success'],
],
'title' => '',
'example' => '',
],
'example' => '',
'title' => '',
],
],
'example' => '',
],
'Code' => ['title' => '', 'description' => 'The request status code.'."\n"
.'* OK indicates that the request was successful.'."\n"
.'* For other error codes, see [API error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK'."\n"],
'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
."\n"
.'- **true**: The call was successful.'."\n"
."\n"
.'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorMessage' => 'Incorrect phone number format.', 'errorCode' => 'InvalidParam.PhoneNumber', 'description' => 'Incorrect phone number format'],
['errorMessage' => 'PageSize must be less than or equal to 50.', 'errorCode' => 'InvalidParam.PageSize', 'description' => 'pageSize must be less than or equal to 50'],
['errorMessage' => 'Only the last 30 days can be queried.', 'errorCode' => 'InvalidParam.SendDate', 'description' => 'Only the data of the last 30 days can be queried'],
['errorMessage' => 'At most, only one parameter can be passed among bizCardId, bizSmsId, and bizDigitId.', 'errorCode' => 'InvalidParameter', 'description' => 'At most, only one parameter can be passed among bizCardId, bizSmsId, and bizDigitId.'],
],
],
'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' => 'Queries the card SMS sending records and sending status of a single phone number',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardSmsDetails'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'dysms:GetCardSmsDetails',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GetCardSmsLink' => [
'summary' => 'Retrieves the short URL for a card message.',
'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' => 'The code of the card message template. In the console, go to the [Card Messages > Template Management](https://dysms.console.aliyun.com/domestic/card) page and select the code of an approved card message template.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CARD_SMS_****', 'title' => ''],
],
[
'name' => 'OutId',
'in' => 'query',
'schema' => ['description' => 'The external extension field.', 'type' => 'string', 'required' => false, 'example' => 'BC20220608102511660860762****', 'title' => ''],
],
[
'name' => 'PhoneNumberJson',
'in' => 'query',
'schema' => ['description' => 'The phone number, user ID, or internal system identifier.'."\n"
."\n"
.'> - Supports up to 10,000 phone numbers.'."\n"
.'> - You can also specify a custom identifier of up to 60 characters.'."\n"
.'> - For OPPO templates, you can submit up to 10 requests at a time.', 'type' => 'string', 'required' => false, 'example' => '[\\"1390000****'."\n"
.'\\",\\"1370000****'."\n"
.'\\"]', 'title' => ''],
],
[
'name' => 'SignNameJson',
'in' => 'query',
'schema' => ['description' => 'The signature name of the SMS message.'."\n"
.'In the console, go to the [Domestic Messages > Signature Management](https://dysms.console.aliyun.com/domestic/text/sign) tab and view the name in the **Signature Name** column. You can also call the [QuerySmsSignList](https://www.alibabacloud.com/help/en/sms/developer-reference/api-dysmsapi-2017-05-25-querysmssignlist) operation to view SMS signature names.'."\n"
."\n"
.'> The signature must be added and approved. The number of SMS signatures must match the number of phone numbers, and each signature must correspond to a phone number.', 'type' => 'string', 'required' => true, 'example' => '[\\"阿里云\\", \\"阿里云2\\"]', 'title' => ''],
],
[
'name' => 'CardTemplateParamJson',
'in' => 'query',
'schema' => ['description' => 'The variables of the card message template.', 'type' => 'string', 'required' => false, 'example' => ' [{\\"customUrl\\":\\"https://alibaba.com\\",\\"dyncParams\\": \\"{\\\\\\"动参key\\\\\\":\\\\\\"动参value\\\\\\"}\\"},{\\"customUrl\\":\\"https://alibaba.com\\",\\"dyncParams\\": \\"{\\\\\\"动参key\\\\\\":\\\\\\"动参value\\\\\\"}\\"}]', 'title' => ''],
],
[
'name' => 'CardCodeType',
'in' => 'query',
'schema' => ['description' => 'The encoding type of the short URL for the card message. Valid values:'."\n"
.'- 1: bulk sending.'."\n"
.'- 2: personalized.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
],
[
'name' => 'CardLinkType',
'in' => 'query',
'schema' => ['description' => 'The type of the short URL for the card message. Valid values:'."\n"
.'- 1: standard short URL.'."\n"
.'- 2: custom short URL.'."\n"
."\n"
.'> If **CardLinkType** is left empty, the default value is standard short URL. To generate a custom short URL, contact Alibaba Cloud operations to register in advance.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'Domain',
'in' => 'query',
'schema' => ['description' => 'The short URL domain assigned to the sending account. The domain must be registered in advance.'."\n"
."\n"
.'> - When **CardLinkType** is set to **2**, the **Domain** parameter is required.'."\n"
.'> - If the **Domain** parameter is left empty, the system default domain is used. The value can be up to 100 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'xxx.com', 'title' => ''],
],
[
'name' => 'CustomShortCodeJson',
'in' => 'query',
'schema' => ['description' => 'The custom short code. The value must be 4 to 8 digits or letters.'."\n"
."\n"
.'> This parameter is required when the generation type is custom short URL.', 'type' => 'string', 'required' => false, 'example' => 'abCde', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Code' => ['description' => '请求状态码。取值:'."\n"
.'- OK:代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => 'CC89A90C-978F-46AC-B80D-54738371E7CA', 'title' => ''],
'Success' => ['description' => '接口调用是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'CardTmpState' => ['description' => '卡片短信模板审核状态。取值:'."\n"
.'- **0**:审核中。'."\n"
.'- **1**:审核通过。'."\n"
.'- **2**:审核不通过。'."\n"
."\n"
.'> 未审核通过的短信走回落流程。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'NotMediaMobiles' => ['description' => '不支持卡片短信的手机号。', 'type' => 'string', 'example' => '1390000****', 'title' => ''],
'CardPhoneNumbers' => ['description' => '支持卡片短信的手机号码。', 'type' => 'string', 'example' => '[\\"1390000****\\",\\"1370000****\\"]', 'title' => ''],
'CardSmsLinks' => ['description' => '卡片短信短链。', 'type' => 'string', 'example' => '[\\"mw2m.cn/LAaGGa\\",\\"mw2m.cn/LAAaes\\"]', 'title' => ''],
'CardSignNames' => ['description' => '用于申请卡片短信短链的短信签名,在发送时签名、接收号码、卡片短信短链要一一对应。', 'type' => 'string', 'example' => '["阿里云","阿里云2"]', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
200 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => 'No access, please contact 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' => 'Retrieve the short URL for a card message',
'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调用会被限流,这可能会影响您的业务,请合理调用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '8000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardSmsLink'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:GetCardSmsLink',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GetMediaResourceId' => [
'summary' => 'Converts images and videos uploaded to OSS storage for card SMS into resource data for unified management, and returns a resource ID. You can manage the returned resource ID as needed.',
'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' => 'The resource type.'."\n"
."\n"
.'- **1**: Text'."\n"
.'- **2**: Image. Small images must not exceed 100 KB. Large images must not exceed 2 MB. Images must be clear. Supported formats: JPG, JPEG, PNG.'."\n"
.'- **3**: Audio'."\n"
.'- **4**: Video. Supported format: MP4.'."\n"
.'> '."\n"
.'> - If the resource type is image, **img_rate** is required.'."\n"
.'> - 1:1 ratio: oneToOne'."\n"
.'> - 16:9 ratio: sixteenToNine'."\n"
.'> - 3:1 ratio: threeToOne'."\n"
.'> - 48:65 ratio: fortyEightToSixtyFiv.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10000', 'minimum' => '0', 'example' => '1', 'title' => ''],
],
[
'name' => 'OssKey',
'in' => 'query',
'schema' => ['description' => 'The address of the resource to retrieve.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'oss://alicom-fc-media/1947741454322274/alicom-fc-media/pic/202205191526575398603697152.png', 'title' => ''],
],
[
'name' => 'FileSize',
'in' => 'query',
'schema' => ['description' => 'The file size. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '12', 'title' => ''],
],
[
'name' => 'ExtendInfo',
'in' => 'query',
'schema' => ['description' => 'The extended field.'."\n"
."\n"
.'> Required when the resource type is **image**.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{\\"img_rate\\":\\"oneToOne\\"}', 'title' => ''],
],
[
'name' => 'Memo',
'in' => 'query',
'schema' => ['description' => 'The description of the uploaded resource.', 'type' => 'string', 'required' => false, 'example' => '图片信息', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Code' => ['description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F07CF237-F6E3-5F77-B91B-F9B7C5DE84AB', 'title' => ''],
'Success' => ['description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'ResourceId' => ['description' => '资源ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'ResUrlDownload' => ['description' => '资源下载地址。', 'type' => 'string', 'example' => 'http://test-example.com/download.jpg', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
200 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => 'No access, please contact 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' => 'Retrieve a media resource ID',
'description' => '### QPS限制'."\n"
.'本接口的单用户QPS限制为300次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMediaResourceId'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:GetMediaResourceId',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GetOSSInfoForCardTemplate' => [
'summary' => 'Retrieves the OSS resource configuration information for card messages. This information is used for subsequent OSS file upload operations.',
'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', 'title' => ''],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', 'title' => ''],
'Success' => ['description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Signature' => ['description' => '短信签名。', 'type' => 'string', 'example' => '阿里云', 'title' => ''],
'Host' => ['description' => '访问地址。', 'type' => 'string', 'example' => 'http://***.aliyuncs.com'."\n", 'title' => ''],
'Policy' => ['description' => '签名策略。', 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0yNlQwMzo0NDoyMy4xNTlaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCIxNDIwNjM0******************', 'title' => ''],
'ExpireTime' => ['description' => '超时时间戳。单位:秒。', 'type' => 'string', 'example' => '1634209418', 'title' => ''],
'AliUid' => ['description' => '阿里云账号ID。', 'type' => 'string', 'example' => '168**********184'."\n", 'title' => ''],
'AccessKeyId' => ['description' => '签名使用的AccessKey ID。', 'type' => 'string', 'example' => 'LTAI************', 'title' => ''],
'StartPath' => ['description' => '策略路径。', 'type' => 'string', 'example' => '168**********184', 'title' => ''],
'Bucket' => ['description' => 'OSS文件保存桶名称。', 'type' => 'string', 'example' => 'alicom-cardsms-resources', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
200 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => 'No access, please contact 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' => 'Retrieve OSS upload information',
'description' => '- 您在调用卡片短信相关API接口前,首先需要开通卡片短信功能,目前卡片短信在内部邀约阶段,请联系您的阿里云商务经理申请开通或联系[阿里云售前咨询](https://help.aliyun.com/document_detail/464625.html)。'."\n"
."\n"
.'- 卡片短信模板中使用的图片、视频等素材资源可上传到OSS文件系统保存。文件上传操作,请参见[OSS文件上传](~~437303~~)。'."\n"
."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为300次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
'requestParamsDescription' => '### Request parameter description'."\n"
.'The GetOSSInfoForCardTemplate operation has no request parameters. Call the operation directly to retrieve the OSS upload information.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOSSInfoForCardTemplate'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:GetOSSInfoForCardTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GetOSSInfoForUploadFile' => [
'summary' => 'Obtains OSS resource configuration information, which will be used for subsequent OSS file upload operations.',
'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' => 'The business type. Default value: **fcMediaSms**.'."\n"
."\n"
.'When you create a signature or template and upload **More Materials**, the value is **fcMediaSms**.', 'type' => 'string', 'required' => false, 'example' => 'fcMediaSms', 'default' => 'fcMediaSms', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700EDCFD0D', 'title' => ''],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Model' => [
'description' => 'The returned result.',
'type' => 'object',
'properties' => [
'Policy' => ['description' => 'The signature policy.', 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyN***Ni0yNVQwNjozNzoyNS45NzBaI**iY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0sWyJzdGFydHMtd2l0***sIiRrZXkiLCIiXV19', 'title' => ''],
'StartPath' => ['description' => 'The policy path.', 'type' => 'string', 'example' => '123456', 'title' => ''],
'AccessKeyId' => ['description' => 'The AccessKey ID used for the signature.', 'type' => 'string', 'example' => 'LTAI************'."\n", 'title' => ''],
'Signature' => ['description' => 'The signature information calculated based on the **AccessKey Secret** and **Policy**. When you call an OSS API operation, OSS verifies the signature information to confirm the validity of the POST request.', 'type' => 'string', 'example' => 'BXnwCWPrhVb*****aoZHZfli5KE=', 'title' => ''],
'Host' => ['description' => 'The host address.', 'type' => 'string', 'example' => 'https://alicom-fc-media.oss-cn-zhangjiakou.aliyuncs.com', 'title' => ''],
'ExpireTime' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '1719297445', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Code' => ['description' => 'The status code of the request.'."\n"
."\n"
.'- **OK** indicates that the request is successful.'."\n"
.'- For information about other error codes, see [Error codes](https://help.aliyun.com/document_detail/101346.htm).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Success' => ['description' => 'Indicates whether the API call is successful. Valid values:'."\n"
."\n"
.'- **true**: The call is successful.'."\n"
.'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'Obtain OSS Configuration Information for Signature/Template Materials',
'description' => '- When you create a signature or template, you can upload materials such as login pages with links, backend page screenshots, software copyrights, and supplementary agreements. These materials help reviewers understand the details of your business. If you have multiple materials, you can combine them into one file. The supported formats are png, jpg, jpeg, doc, docx, and pdf.'."\n"
."\n"
.'- Additional materials required for creating a signature or template can be uploaded to the OSS file system for storage. For information about file upload operations, see [Upload files to OSS](~~2833114~~).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOSSInfoForUploadFile'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [],
],
'GetQualificationOssInfo' => [
'summary' => 'Obtains the OSS resource configuration information for qualification materials. This configuration information will be used for subsequent uploads of qualification files such as authorization letters and enterprise certificates.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '264692',
'abilityTreeNodes' => ['FEATUREdysmsJ2BZAJ'],
],
'parameters' => [
[
'name' => 'BizType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The business type. When applying for a qualification or creating an authorization letter file, enter **dysms**.', 'type' => 'string', 'required' => true, 'example' => 'dysms'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The details about the access denial. This parameter is returned only if the RAM check fails.', 'type' => 'string', 'example' => '无', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud for the request. It can be used to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA'],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Data' => [
'title' => '',
'description' => 'The OSS configuration information.',
'type' => 'object',
'properties' => [
'Policy' => ['title' => '', 'description' => 'The signature policy.', 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0wOVQxMTo1NTozOS4wMDFaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0seyJidWNrZXQiOiJhbGljb20tZmMtbWVkaWEifSxbImVxIiwiJGtleSIsIjEwMDAwMDM1ODA4MjA2M1wv********'],
'Expire' => ['title' => '', 'description' => 'The expiration timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1741521339'],
'StartPath' => ['title' => '', 'description' => 'The policy path.', 'type' => 'string', 'example' => '1000********001'],
'AccessKeyId' => ['title' => '', 'description' => 'The AccessKey ID used for the signature.', 'type' => 'string', 'example' => 'bypFNbG******'],
'Signature' => ['title' => '', 'description' => 'The signature information calculated based on the AccessKey secret and the policy. When you call the OSS API, OSS verifies the signature information to confirm the validity of the request.', 'type' => 'string', 'example' => 'QvNTGC9DSLTeByP+ZWW******'],
'Host' => ['title' => '', 'description' => 'The host address.', 'type' => 'string', 'example' => 'http://***.oss-cn-zhangjiakou.aliyuncs.com'],
],
'example' => '',
],
'Code' => ['description' => 'The request status code.'."\n"
."\n"
.'- If OK is returned, the request is successful.'."\n"
.'- For other error codes, see [API error codes](~~101346~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Success' => ['description' => 'Indicates whether the API call is successful. Valid values:'."\n"
."\n"
.'- **true**: The call is successful.'."\n"
."\n"
.'- **false**: The call fails.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OssBiztypeNotSupportError', 'errorMessage' => 'Retrieving OSS configuration does not support this biz type.', 'description' => ''],
],
],
'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' => 'Obtain the OSS configuration information for qualification materials/authorization letters',
'description' => '- When you apply for a qualification or signature, if the purpose is for other use or involves a third party, you must provide an [authorization letter](~~56741~~).'."\n"
.'- After you use this API to obtain the OSS resource configuration information, upload the related qualification materials through OSS. For more information, see [Upload files through OSS](~~2833114~~).'."\n"
.'- The names of files to be uploaded cannot contain Chinese characters or special symbols.',
'changeSet' => [
['createdAt' => '2025-08-01T04:05:19.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [],
],
'GetSmsOcrOssInfo' => [
'summary' => 'Retrieves the OSS information for OCR.',
'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' => '',
'description' => 'The OCR task type. Valid values:'."\n"
.'- ICP_DOMAIN: ICP filing screenshot for domain-type links.',
'enumValueTitles' => ['ICP_DOMAIN' => 'ICP filing screenshot for domain-type links.'],
'type' => 'string',
'required' => false,
'example' => 'ICP_DOMAIN',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息,只有 RAM 校验失败才会返回此字段。', 'type' => 'string', 'example' => 'None', 'title' => ''],
'RequestId' => ['description' => '本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。', 'type' => 'string', 'title' => '', 'example' => '25D5AFDE-xxxx-132E-8909-1FDC071DA'],
'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Model' => [
'title' => '',
'description' => 'OSS配置信息。',
'type' => 'object',
'properties' => [
'Policy' => ['description' => '签名策略。', 'type' => 'string', 'title' => '', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0wOVQxMTo1NTozOS4wMDFaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0seyJidWNrZXQiOiJhbGljb20tZmMtbWVkaWEifSxbImVxIiwiJGtleSIsIjEwMDAwMDM1ODA4MjA2M1wv********'],
'StartPath' => ['description' => '策略路径。', 'type' => 'string', 'title' => '', 'example' => '1000********001'],
'Bucket' => ['description' => 'bucket名称。', 'type' => 'string', 'title' => '', 'example' => '示例值'],
'AccessKeyId' => ['description' => '签名使用的 AccessKey ID。', 'type' => 'string', 'title' => '', 'example' => 'bypFNbG******'],
'Signature' => ['description' => '根据 AccessKey Secret 和 Policy 计算出的签名信息。调用 OSS API 时,OSS 验证该签名信息,从而确认请求的合法性。', 'type' => 'string', 'title' => '', 'example' => 'QvNTGC9DSLTeByP+ZWW******'],
'Host' => ['description' => 'Host 地址。', 'type' => 'string', 'title' => '', 'example' => 'http://***.oss-cn-zhangjiakou.aliyuncs.com'],
'ExpireTime' => ['description' => '过期时间戳,单位:秒。', 'type' => 'string', 'title' => '', 'example' => '1741521339'],
],
'example' => '',
],
'Code' => ['description' => '请求状态码。'."\n"
."\n"
.'- 返回 OK 代表请求成功。'."\n"
."\n"
.'- 其他错误码,请参见 [API 错误码](https://www.alibabacloud.com/help/en/sms/developer-reference/api-error-codes)。', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Success' => ['description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- true:调用成功。'."\n"
."\n"
.'- false:调用失败。', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Retrieve OSS information for OCR image recognition',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:GetSmsOcrOssInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'GetSmsSign' => [
'summary' => 'Queries the review details of a signature after you apply for it.',
'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' => 'The signature name. The signature must be applied for by your account.'."\n"
."\n"
.'- After you call the [CreateSmsSign](~~2807427~~) operation, obtain the signature name from the response.'."\n"
.'- View the signature on the [Signatures](https://dysms.console.aliyun.com/domestic/text/sign) page.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '阿里云', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', 'title' => ''],
'Code' => ['description' => '请求状态码。取值:'."\n"
."\n"
.'- OK:代表请求成功。'."\n"
.'- 其他错误码,请参见[API错误码](~~101346~~)。', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'SignName' => ['description' => '短信签名名称。', 'type' => 'string', 'example' => '登录验证', 'title' => ''],
'SignStatus' => ['description' => '签名审核状态。取值:'."\n"
."\n"
.'- **0**:审核中。'."\n"
.'- **1**:审核通过。'."\n"
.'- **2**:审核失败,请在返回参数`AuditInfo.RejectInfo`中查看审核失败原因。'."\n"
.'- **10**:取消审核。', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
'CreateDate' => ['description' => '短信签名的创建日期和时间。', 'type' => 'string', 'example' => '2024-06-03 10:02:34', 'title' => ''],
'OrderId' => ['description' => '工单号。'."\n"
."\n"
.'审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。', 'type' => 'string', 'example' => '20044156924', 'title' => ''],
'QualificationId' => ['description' => '资质ID。申请签名时关联的资质ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2004393****', 'title' => ''],
'Remark' => ['description' => '短信签名场景说明,长度不超过200个字符。', 'type' => 'string', 'example' => '登录场景验证码', 'title' => ''],
'AuditInfo' => [
'description' => '审核信息。',
'type' => 'object',
'properties' => [
'RejectInfo' => ['description' => '审批未通过的原因。', 'type' => 'string', 'example' => '通过资质信息,不能判断是否可以申请此签名。', 'title' => ''],
'AuditDate' => ['description' => '审核时间。', 'type' => 'string', 'example' => '2024-06-03 12:02:34'."\n", 'title' => ''],
],
'title' => '',
'example' => '',
],
'FileUrlList' => [
'description' => '更多资料信息,补充上传业务证明文件或业务截图文件列表。',
'type' => 'array',
'items' => ['description' => '上传到OSS上的文件信息。', 'type' => 'string', 'example' => '10098689758*****/1234qwe.png'."\n", 'title' => ''],
'title' => '',
'example' => '',
],
'SignCode' => ['description' => '短信签名Code。', 'type' => 'string', 'example' => 'SIGN_100000077042023_17174665*****_ZM2kG', 'title' => ''],
'SignTag' => ['description' => '签名标识。取值:'."\n"
."\n"
.'- 2:用户自定义创建签名。'."\n"
.'- 3:系统赠送签名。'."\n"
.'- 4:测试签名。'."\n"
.'- 5:试用签名。', 'type' => 'string', 'example' => '2', 'title' => ''],
'ApplyScene' => ['description' => '应用场景内容。', 'type' => 'string', 'example' => 'http://www.aliyun.com/'."\n", 'title' => ''],
'ThirdParty' => ['description' => '签名为自用或他用。'."\n"
."\n"
.'- false:自用(默认值)。'."\n"
."\n"
.'- true:他用。', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'SignUsage' => ['description' => '签名使用场景。', 'type' => 'string', 'example' => '已注册商标名称。', 'title' => ''],
'RegisterResult' => ['description' => '**已废弃,请使用`SignIspRegisterDetailList`查看各运营商实名报备结果。**'."\n"
."\n"
.'签名实名制报备结果。取值:'."\n"
.'- 0:报备失败。'."\n"
.'- 1:报备成功。'."\n"
.'- 2:报备失效。'."\n"
.'- -1:无状态。'."\n"
."\n"
.'建议您单击查看[更多签名实名制报备内容及建议操作](~~2873145~~)。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'AuthorizationLetterId' => ['description' => '委托授权书ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000********1234', 'title' => ''],
'AuthorizationLetterAuditPass' => [
'description' => '委托授权书审核状态。取值:'."\n"
.'- true:审核通过。'."\n"
.'- false:审核未通过(包含审核通过外的其他所有状态)。',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'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', 'title' => ''],
'OperatorCode' => ['description' => '运营商类型。取值:'."\n"
.'- **mobile**:中国移动;'."\n"
.'- **unicom**:中国联通;'."\n"
.'- **telecom**:中国电信。', 'type' => 'string', 'example' => 'telecom', 'title' => ''],
'OperatorCompleteTime' => ['description' => '运营商反馈时间,格式为yyyy-MM-dd HH:mm:ss。', 'type' => 'string', 'example' => '2025-06-13 15:55:26', 'title' => ''],
'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', 'title' => ''],
'ReasonDescList' => [
'description' => '原因说明列表。可能返回0个或者多个原因说明,返回原因码不一定会返回原因说明。',
'type' => 'array',
'items' => ['description' => '原因说明。', 'type' => 'string', 'example' => '报备超时。', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TrademarkId' => ['description' => '商标实体id。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000009081***', 'title' => ''],
'AppIcpRecordId' => ['description' => 'APP-ICP备案实体id。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000009***123', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => ''],
],
404 => [
['errorCode' => 'SignatureNotFound', 'errorMessage' => 'The signature does not exist.', 'description' => 'The corresponding signature cannot be found under the account.'],
],
],
'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' => 'Query signature details (new operation)',
'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调用将会被限流,这可能会影响您的业务,请合理调用。',
'changeSet' => [
['createdAt' => '2025-12-16T07:48:18.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2025-12-11T12:44:35.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-12-11T12:44:31.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-12-11T10:08:22.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-12-11T10:08:22.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-14T02:14:07.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-14T02:14:00.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-14T02:07:44.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-10T08:25:02.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-10T08:11:09.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-03T13:14:39.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-03T13:14:37.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-03T13:14:03.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-03T13:13:58.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-06-18T07:40:37.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSmsSign'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'dysms:GetSmsSign',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GetSmsTemplate' => [
'summary' => 'Queries the approval details of a template after you submit a template application. You can view the approval status of the template.',
'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' => 'The code of the SMS template.'."\n"
."\n"
.'- Obtain the SMS template code from the response parameters of the [CreateSmsTemplate](~~2807431~~) operation.'."\n"
.'- View the SMS template code on the [Templates](https://dysms.console.aliyun.com/domestic/text/template) page.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SMS_20375****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', 'title' => ''],
'Code' => ['description' => '请求状态码。取值:'."\n"
."\n"
.'* OK:代表请求成功。'."\n"
.'* 其他错误码,请参见[API错误码](~~101346~~)。', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'TemplateName' => ['description' => '短信模板名称。', 'type' => 'string', 'example' => '验证码', 'title' => ''],
'TemplateCode' => ['description' => '短信模板Code。', 'type' => 'string', 'example' => 'SMS_20375****', 'title' => ''],
'TemplateContent' => ['description' => '短信模板内容。', 'type' => 'string', 'example' => '您正在申请手机注册,验证码为:${code},5分钟内有效!', 'title' => ''],
'TemplateType' => ['description' => '短信类型。取值:'."\n"
."\n"
.'- **0**:验证码。'."\n"
.'- **1**:短信通知。'."\n"
.'- **2**:推广短信。'."\n"
.'- **3**:国际/港澳台消息。'."\n"
."\n"
.'> 仅支持企业认证用户申请推广短信和国际/港澳台消息。个人用户与企业用户权益区别详情请参见[使用须知](https://www.alibabacloud.com/help/en/sms/user-guide/usage-notes)。', 'type' => 'string', 'example' => '0', 'title' => ''],
'TemplateStatus' => ['description' => '模板审核状态。返回值:'."\n"
."\n"
.'- **0**:审核中。'."\n"
.'- **1**:通过审核。'."\n"
.'- **2**:未通过审核,会返回审核失败的原因,请参考[短信审核失败的处理建议](https://www.alibabacloud.com/help/en/sms/user-guide/causes-of-application-failures-and-suggestions),调用[UpdateSmsTemplate](https://www.alibabacloud.com/help/en/sms/developer-reference/api-dysmsapi-2017-05-25-updatesmstemplate)接口或在[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面修改短信模板。'."\n"
.'- **10**:取消审核。', 'type' => 'string', 'example' => '2', 'title' => ''],
'RelatedSignName' => ['description' => '申请模板时,关联的短信签名。', 'type' => 'string', 'example' => '阿里云', 'title' => ''],
'TemplateTag' => ['description' => '模板标识。取值:'."\n"
."\n"
.'- 2:用户自定义创建模板。'."\n"
."\n"
.'- 3:系统赠送模板。'."\n"
."\n"
.'- 4:测试模板。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'OrderId' => ['description' => '工单号。'."\n"
."\n"
.'审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。', 'type' => 'string', 'example' => '2003019****', 'title' => ''],
'VariableAttribute' => ['description' => '模板变量规则。'."\n"
."\n"
.'模板变量规则详情,请参见[示例文档](https://www.alibabacloud.com/help/en/sms/templaterule-template-variable-parameter-filling-example)。', 'type' => 'string', 'example' => '{"code":"characterWithNumber"}'."\n", 'title' => ''],
'Remark' => ['description' => '短信模板申请说明,是模板审核的参考信息之一。', 'type' => 'string', 'example' => '申请验证码模板', 'title' => ''],
'CreateDate' => ['description' => '创建短信模板的时间。', 'type' => 'string', 'example' => '2024-06-03 10:02:34', 'title' => ''],
'AuditInfo' => [
'description' => '审核信息。',
'type' => 'object',
'properties' => [
'RejectInfo' => ['description' => '审核未通过的原因。', 'type' => 'string', 'example' => '模板内容中包含错别字。', 'title' => ''],
'AuditDate' => ['description' => '审核时间。', 'type' => 'string', 'example' => '2024-06-03 11:20:34'."\n", 'title' => ''],
],
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'IntlType' => ['description' => '国际/港澳台模板类型。当**TemplateType**参数返回值为**3**时,此参数取值:'."\n"
.'- **0**:短信通知。'."\n"
.'- **1**:推广短信。'."\n"
.'- **2**:验证码。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'ApplyScene' => ['description' => '应用场景内容。', 'type' => 'string', 'example' => 'http://www.aliyun.com/'."\n", 'title' => ''],
'VendorAuditStatus' => ['title' => '', '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"
.' }'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => ''],
],
404 => [
['errorCode' => 'TemplateNotFound', 'errorMessage' => 'The template does not exist.', 'description' => ''],
],
],
'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' => 'Query template approval details (new operation)',
'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~~)接口可以查询您当前账号下所有模板的模板详情。',
'changeSet' => [
['createdAt' => '2026-06-08T07:44:54.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2026-06-08T07:44:51.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2026-04-07T06:43:39.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2026-04-07T06:43:33.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2026-04-07T06:43:31.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2026-03-30T03:26:05.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2026-03-30T03:12:25.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2026-03-30T03:05:16.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2026-03-30T02:56:05.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2026-03-30T02:44:05.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2026-03-30T02:44:02.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSmsTemplate'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'dysms:GetSmsTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListTagResources' => [
'summary' => 'Tags are markers that you add to templates. Each tag consists of a key-value pair (Key-Value). You can query the template codes bound to a tag key-value pair, or query all tags bound to a specific template.',
'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' => 'The resource type. Default value: TEMPLATE.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TEMPLATE', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID. Default value: **cn-hangzhou**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token used to query the next page of tags.', 'type' => 'string', 'required' => false, 'example' => '23432453245', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'ProdCode',
'in' => 'query',
'schema' => ['description' => 'The product name. Default value: **dysms**.', 'type' => 'string', 'required' => false, 'default' => 'dysms', 'example' => 'dysms', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The tag list. The tag list and **ResourceId** (SMS template code) cannot be empty at the same time. You can specify up to 20 tags.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''],
'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 21,
'title' => '',
'example' => '',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The SMS template code. The SMS template code and the tag list **Tag** cannot be empty at the same time.',
'type' => 'array',
'items' => ['description' => 'The SMS template code.', 'type' => 'string', 'required' => false, 'example' => 'SMS_2342****', 'title' => ''],
'required' => false,
'example' => 'SMS_23423423',
'maxItems' => 51,
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The request status code.'."\n"
."\n"
.'- A value of OK indicates that the request was successful.'."\n"
.'- For other error codes, see [Error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'NextToken' => ['description' => 'The token used to query the next page of tags.', 'type' => 'string', 'example' => '"23432453245"', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request. The request ID is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', 'title' => ''],
'TagResources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagResource' => [
'description' => 'The tag resources.',
'type' => 'array',
'items' => [
'description' => 'The tag resource.',
'type' => 'object',
'properties' => [
'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'ALIYUN::DYSMS::TEMPLATE', 'title' => ''],
'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'TestValue', 'title' => ''],
'ResourceId' => ['description' => 'The SMS template code.', 'type' => 'string', 'example' => 'SMS_23423****', 'title' => ''],
'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'TestKey', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
200 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => 'No access, please contact administrator.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
'title' => 'Queries the tags of a template',
'description' => 'You can log on to the Short Message Service (SMS) console and go to the [Template Management](https://dysms.console.aliyun.com/domestic/text/template) page to filter SMS templates that are bound to tag key-value pairs, or click **Details** in the Actions column to view the tags that are bound to the current template.'."\n"
.'### QPS limit'."\n"
.'The per-user QPS limit of this operation is 50 calls per second. If the limit is exceeded, API calls will be throttled, which may affect your business. Call this operation properly.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dysms:ListTagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ModifySmsSign' => [
'summary' => 'This operation is discontinued.',
'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' => 'The signature name.'."\n"
."\n"
.'> You can modify a signature that has been approved, but you cannot change its name. The modified signature must be reviewed and approved before it can be used. The original signature cannot be used until the review is complete.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '阿里云', 'title' => ''],
],
[
'name' => 'SignSource',
'in' => 'query',
'schema' => ['description' => 'The signature source. Valid values:'."\n"
."\n"
.'- **0**: full name or abbreviation of an enterprise or public institution.'."\n"
.'- **1**: full name or abbreviation of a website filed with the Ministry of Industry and Information Technology (MIIT).'."\n"
.'- **2**: full name or abbreviation of an app.'."\n"
.'- **3**: full name or abbreviation of an official account or mini program.'."\n"
.'- **4**: full name or abbreviation of a store on an e-commerce platform.'."\n"
.'- **5**: full name or abbreviation of a trademark.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => ['description' => 'The description of the SMS signature application. The description cannot exceed 200 characters in length.'."\n"
."\n"
.'The description is used as a reference for signature review. A complete description helps reviewers understand your business scenario and improves review efficiency. Guidelines:'."\n"
."\n"
.'- Provide the use case of a service that is already online.'."\n"
.'- Provide an SMS example from a real scenario to illustrate your business scenario.'."\n"
.'- Provide the values passed for variables, and describe the business scenario in detail and the reason for choosing the variable attributes.'."\n"
.'- Provide the website URL of the actual service, a filed domain name, or an app store download link.'."\n"
.'- For logon scenarios, provide a test account and password.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '当前的短信签名应用于双11大促推广营销', 'title' => ''],
],
[
'name' => 'SignFileList',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of signature files.',
'type' => 'array',
'items' => [
'description' => '签名文件列表。',
'type' => 'object',
'properties' => [
'FileContents' => ['description' => '签名的纸质证明文件经base64编码后的字符串。图片不超过2 MB。'."\n"
."\n"
.'个别场景下,申请签名需要上传证明文件。详细说明,请参见[短信签名规范](~~108076~~)。', 'type' => 'string', 'required' => true, 'example' => 'R0lGODlhHAAmAKIHAKqqqsvLy0hISObm5vf394uLiwAA', 'title' => ''],
'FileSuffix' => ['description' => '签名的证明文件格式,支持上传多张图片。当前支持JPG、PNG、GIF或JPEG格式的图片。'."\n"
."\n"
.'个别场景下,申请签名需要上传证明文件。详细说明,请参见[短信签名规范](~~108076~~)。'."\n"
.'> 如果签名用途为他用或个人认证用户的自用签名来源为企事业单位名时,还需上传证明文件和委托授权书,详情请参见[证明文件](~~108076~~)和[授权委托书](~~56741~~)。', 'type' => 'string', 'required' => true, 'example' => 'jpg', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 10,
'title' => '',
'example' => '',
],
],
[
'name' => 'SignType',
'in' => 'query',
'schema' => ['description' => 'The signature type. Valid values:'."\n"
."\n"
.'- **0**: verification code.'."\n"
."\n"
.'- **1**: general.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Code' => ['description' => '请求状态码。'."\n"
."\n"
.'* 返回OK代表请求成功。'."\n"
.'* 其他错误码,请参见[API错误码](~~101346~~)。', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', 'title' => ''],
'SignName' => ['description' => '签名名称。', 'type' => 'string', 'example' => '阿里云', 'title' => ''],
],
'title' => '',
'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' => 'Modify an SMS signature (discontinued)',
'description' => '- 根据工信部规定与运营商[相关要求](~~2806975~~),阿里云进行了签名相关API的功能改造。为提升您签名的审核效率和审核通过率,请您使用新接口[UpdateSmsSign-修改短信签名](~~2807428~~)。'."\n"
."\n"
.'- 仅支持修改未通过审核的签名,请参考[短信审核失败的处理建议](~~65990~~),调用此接口修改后自动提交审核,签名进入待审核状态。'."\n"
."\n"
.'- 通过接口修改签名的操作会在短信服务控制台同步,在控制台对签名的相关操作,请参见[短信签名](~~108073~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-08-15T04:21:05.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-08-15T04:21:01.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-07-09T12:20:24.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-07-09T12:20:18.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-07-09T12:20:05.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySmsSign'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dysms:ModifySmsSign',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ModifySmsTemplate' => [
'summary' => 'This operation is discontinued.',
'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' => 'The SMS type. Valid values:'."\n"
."\n"
.'- **0**: verification code.'."\n"
.'- **1**: SMS notification.'."\n"
.'- **2**: promotional message.'."\n"
.'- **3**: international or Hong Kong, Macao, and Taiwan message.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '0', 'title' => ''],
],
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => ['description' => 'The template name. The name must be 1 to 30 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '验证码模板', 'title' => ''],
],
[
'name' => 'TemplateCode',
'in' => 'query',
'schema' => ['description' => 'The code of the SMS template that failed the review.'."\n"
."\n"
.'- Call the [QuerySmsTemplateList](~~419288~~) operation to obtain the code of the SMS template that failed the review.'."\n"
.'- View the code of the SMS template that failed the review on the [Templates](https://dysms.console.aliyun.com/domestic/text/template) page.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SMS_15255****', 'title' => ''],
],
[
'name' => 'TemplateContent',
'in' => 'query',
'schema' => ['description' => 'The template content. The content cannot exceed 500 characters in length.'."\n"
."\n"
.'The template content and variable content must comply with the [SMS template specifications](~~463161~~). Otherwise, the template fails the review. You can view common template examples on the [Apply for Template](https://dysms.console.aliyun.com/domestic/text/template/add) page. Using sample templates can improve review efficiency and success rate. For variable specifications, see [TemplateContent variable specifications](~~2806243~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '您正在申请手机注册,验证码为:${code},5分钟内有效!', 'title' => ''],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => ['description' => 'The description of the SMS template application. The description cannot exceed 100 characters in length.'."\n"
."\n"
.'This information helps reviewers understand your business scenarios and improves review efficiency. Guidelines:'."\n"
."\n"
.'- Provide the use case of your live business.'."\n"
.'- Provide SMS examples for real scenarios to reflect your business scenarios.'."\n"
.'- Provide variable values and describe in detail the business use case and the reason for choosing the variable attributes.'."\n"
.'- Provide the website URL, registered domain name, or application marketplace download link of the actual business.'."\n"
.'- For logon scenarios, provide the test account and password.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '手机注册登录', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', 'title' => ''],
'TemplateCode' => ['description' => '已修改的模板Code。', 'type' => 'string', 'example' => 'SMS_15255****', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'TemplateParameterCountIllegal', 'errorMessage' => 'The verification code template only supports 1 verification code as a variable', 'description' => 'Verification code templates support only one variable, which must be a verification code.'],
],
],
'staticInfo' => [
'substitutions' => ['Dysmsapi::2017-05-25::UpdateSmsTemplate'],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"TemplateCode\\": \\"SMS_15255****\\"\\n}","type":"json"}]',
'title' => 'Modify SMS template (discontinued)',
'description' => '- 根据工信部规定与运营商[相关要求](~~2806975~~),阿里云进行了模板相关API的功能改造。为提升您模板的审核效率和审核通过率,请您使用新接口[UpdateSmsTemplate-修改短信模板](~~2807432~~)。'."\n"
."\n"
.'- 仅支持修改未通过审核的模板,请参考[短信审核失败的处理建议](~~65990~~),调用此接口修改后重新提交审核。'."\n"
."\n"
.'- 通过接口修改模板的操作会在短信服务控制台同步,在控制台对模板的相关操作,请参见[短信模板](~~108085~~)。'."\n"
."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为1000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-08-15T04:21:05.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-08-15T04:21:01.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-07-09T12:20:25.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-07-09T12:20:18.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-07-09T12:20:05.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySmsTemplate'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dysms:ModifySmsTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'QueryCardSmsTemplate' => [
'summary' => 'Queries the review status of a card SMS template and returns information about the review by mobile phone vendors.',
'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' => 'The code of the card SMS template. Valid values:'."\n"
."\n"
.'- After you call the [CreateCardSmsTemplate](~~CreateCardSmsTemplate~~) operation, the value of the **TemplateCode** response parameter is the code of the newly created card SMS template.'."\n"
."\n"
.'- You can also log on to the [Domestic Card SMS](https://dysms.console.aliyun.com/domestic/card) page in the console and view the card SMS template code on the **Template Management** tab.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CARD_SMS_2****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The status code.'."\n"
."\n"
.'* If OK is returned, the request is successful.'."\n"
.'* For other error codes, see [API error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud for the request. It can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', 'title' => ''],
'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n"
."\n"
.'- **true**: The call was successful.'."\n"
."\n"
.'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'Templates' => [
'description' => 'The list of returned templates.'."\n",
'type' => 'array',
'items' => ['description' => 'The returned template information. The actual returned values prevail.'."\n"
.'- tmpName: the name of the template.'."\n"
.'- tmpCode: the code of the template.'."\n"
.'- state: the review status of the template. 0: under review. 1: approved. 2: rejected.'."\n"
.'- tmpOps: the list of mobile phone vendor reviews. (state: the review status from the mobile phone vendor. vendorCode: the information about the mobile phone vendor. remark: the review remarks from the mobile phone vendor.)', '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"
.'}', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
200 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => 'No access, please contact 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' => 'Queries the status of a card SMS template',
'description' => '- Alibaba Cloud accounts that have not activated the card SMS service cannot call this API.'."\n"
.'- The card SMS service is currently in the internal invitation phase. Contact your Alibaba Cloud business manager to apply for activation or [contact Alibaba Cloud pre-sales consultation](https://help.aliyun.com/document_detail/464625.html).'."\n"
.'- You can also log on to the [Domestic Card SMS](https://dysms.console.aliyun.com/domestic/card) page in the console and query the review status of card SMS templates on the Template Management tab.'."\n"
.'### QPS limit'."\n"
.'The per-user QPS limit for this operation is 300 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation responsibly.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCardSmsTemplate'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QueryCardSmsTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'QueryCardSmsTemplateReport' => [
'summary' => 'Queries the parsing data of a specified card SMS template. The parsing data includes the number of successful SMS parsing receipts, the number of message exposures, and the number of message clicks.',
'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' => 'The card SMS object.',
'type' => 'array',
'items' => ['description' => 'The code of the card SMS template. You can view the code in the **Template CODE** column on the **Template Management** tab of the **Domestic Messages** page in the console.'."\n"
."\n"
.'>The template must be a card SMS template that is added and approved.', 'type' => 'string', 'required' => false, 'example' => 'CARD_SMS_391', 'title' => ''],
'required' => true,
'docRequired' => true,
'title' => '',
'example' => '',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => ['description' => 'The start time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '2020-10-10 00:00:01', 'title' => ''],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => ['description' => 'The end time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '2020-10-11 00:00:01', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The data object.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The request status code.'."\n"
."\n"
.'- The value OK indicates that the request was successful.'."\n"
."\n"
.'- For information about other error codes, see [Error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B71F06CA-7735-183A-B52E-234EF8AFE14B', 'title' => ''],
'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n"
."\n"
.'- **true**: The call was successful.'."\n"
."\n"
.'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'model' => [
'description' => 'The list of returned data.',
'type' => 'array',
'items' => ['description' => 'The details of the returned data.'."\n"
.'- tmpCode: the template code.'."\n"
.'- date: the data date. Format: yyyy-MM-dd HH:mm:ss.'."\n"
.'- rptSuccessCount: the number of successful SMS parsing receipts.'."\n"
.'- exposeUv: the number of message exposure UVs.'."\n"
.'- exposePv: the number of message exposure PVs.'."\n"
.'- clickUv: the number of message click UVs.'."\n"
.'- clickPv: the number of message click PVs.'."\n"
.'- facPvUvList: the list of vendor information.', 'type' => 'object', 'title' => '', 'example' => ''],
'enumValueTitles' => [],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
200 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => 'No access, please contact administrator.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
'title' => 'Queries the parsing data of a specified card SMS template',
'description' => '### QPS limit'."\n"
.'The QPS limit on this operation is 300 calls per second per user. If the number of calls per second exceeds the limit, throttling is triggered. This may affect your business. Call this operation at a reasonable pace.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCardSmsTemplateReport'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QueryCardSmsTemplateReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'QueryDigitalSignByName' => [
'summary' => 'Retrieves the details of a digital SMS signature by its name.',
'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' => 'The name of the digital SMS signature. The signature must belong to your Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => '阿里云数字商城', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'Details of the access denial. This parameter is returned only if Resource Access Management (RAM) authentication fails.', 'type' => 'string', 'example' => '无', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', 'title' => ''],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => '- `gmtModified`: The time when the signature was last modified.'."\n"
."\n"
.'- `creator`: The ID of the user who created the signature.'."\n"
."\n"
.'- `signName`: The name of the digital SMS signature.'."\n"
."\n"
.'- `qualificationId`: The ID of the qualification. You can create qualifications in the console or by calling an API operation.'."\n"
."\n"
.'- `signIndustry`: The industry type. Valid values: `0` (General) and `1` (E-commerce).'."\n"
."\n"
.'- `signVersion`: The version of the signature. This value is updated for each new version. The current version is 1.'."\n"
."\n"
.'- `telecomRegisterStatus`: The filing status with China Telecom. Valid values: `0` (Filing Failed), `3` (Filing Successful), `-1` (Filing in Progress), and `-2` (Not Filed).'."\n"
."\n"
.'- `signCode`: The code of the digital SMS signature.'."\n"
."\n"
.'- `gmtCreate`: The time when the signature was created.'."\n"
."\n"
.'- `signId`: The ID of the signature. This is a unique identifier.'."\n"
."\n"
.'- `mobileRegisterStatus`: The filing status with China Mobile.'."\n"
."\n"
.'- `SignSource`: The source of the signature. Valid values:'."\n"
."\n"
.'- `mobileAvailableStatus`: The availability status with China Mobile. Valid values: `0` (Unavailable) and `1` (Available). We recommend that you select an available signature when you create a template or send a digital SMS message.'."\n"
."\n"
.'- `unicomRegisterStatus`: The filing status with China Unicom. Valid values: `0` (Filing Failed), `3` (Filing Successful), `-1` (Filing in Progress), and `-2` (Not Filed).'."\n"
."\n"
.'- `unicomAvailableStatus`: The availability status with China Unicom. Valid values: `0` (Unavailable) and `1` (Available). We recommend that you select an available signature when you create a template or send a digital SMS message.'."\n"
."\n"
.'- `telecomAvailableStatus`: The availability status with China Telecom. Valid values: `0` (Unavailable) and `1` (Available). We recommend that you select an available signature when you create a template or send a digital SMS message.', '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"
.' },', 'title' => ''],
'Code' => ['description' => 'The status code of the request. A value of `OK` indicates that the request was successful. Other values indicate error codes.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Success' => [
'description' => 'Indicates whether the request was successful.',
'enumValueTitles' => ['true' => 'The request was successful.', 'false' => 'The request failed.'],
'type' => 'boolean',
'example' => 'false',
'title' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query Digital Message SMS Signature ',
'description' => 'You can query only the digital SMS signatures that belong to your Alibaba Cloud account.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [],
'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"}]',
],
'QueryMobilesCardSupport' => [
'summary' => 'Queries whether a phone number supports card SMS messages.',
'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' => 'The code of the card SMS template. To view the code, log on to the console and choose **Domestic Messages** > [Template Management](https://dysms.console.aliyun.com/domestic/text/template).'."\n"
."\n"
.'>The template must be added and approved.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CARD_SMS_2****', 'title' => ''],
],
[
'name' => 'Mobiles',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The list of phone numbers.',
'type' => 'array',
'items' => ['description' => '待查询的手机号。一次请求最多支持查询10000个号码。', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
.' "mobile": "138****0000"'."\n"
.'}', 'title' => ''],
'required' => true,
'title' => '',
'example' => '',
],
],
[
'name' => 'EncryptType',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => 'The encryption method for the phone number. Valid values:'."\n"
.'- SHA1: SHA1 encryption.'."\n"
.'- NORMAL: no encryption. The phone number is transmitted in plaintext.',
'enumValueTitles' => [],
'type' => 'string',
'example' => 'NORMAL',
'maxLength' => 100,
'default' => 'NORMAL',
'enum' => ['SHA1', 'NORMAL'],
'required' => false,
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回值根对象。',
'type' => 'object',
'properties' => [
'Code' => ['description' => '请求状态码。'."\n"
."\n"
.'- 返回OK代表请求成功。'."\n"
.'- 其他错误码,请参见[错误码列表](~~101346~~)。', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => '08C17DFE-2E10-54F4-BAFB-7180039CC217', 'title' => ''],
'Success' => ['description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'QueryResult' => [
'description' => '查询值。',
'type' => 'array',
'items' => [
'description' => '查询值。',
'type' => 'object',
'properties' => [
'Mobile' => ['description' => '查询的手机号码。', 'type' => 'string', 'example' => '1380000****', 'title' => ''],
'Support' => ['description' => '是否支持卡片短信。取值:'."\n"
."\n"
.'- **true**:支持。'."\n"
.'- **false**:不支持。', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
200 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => 'No access, please contact 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' => 'Query whether a phone number supports card SMS messages (new API)',
'description' => '- 未开通卡片短信业务的阿里云账号无法调用此API。'."\n"
.'- 目前卡片短信在内部邀约阶段,请联系您的阿里云商务经理申请开通或[联系阿里云售前咨询](https://help.aliyun.com/document_detail/464625.html)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMobilesCardSupport'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QueryMobilesCardSupport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'QuerySendDetails' => [
'summary' => 'Queries the delivery records and status of SMS messages sent to a single phone number.',
'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' => 'The phone number to query. The format is as follows:'."\n"
."\n"
.'- For messages to the Chinese mainland, use an 11-digit phone number, such as 1390000\\*\\*\\*\\*.'."\n"
."\n"
.'- For international SMS, use the format: country/region code + phone number, such as 8520000\\*\\*\\*\\*.'."\n"
."\n"
.'> You can specify only one phone number.', 'type' => 'string', 'required' => true, 'example' => '1390000****', 'title' => ''],
],
[
'name' => 'BizId',
'in' => 'query',
'schema' => ['description' => 'The delivery receipt ID. This is the `BizId` returned in the response when you call the [SendSms](~~419273~~) or [SendBatchSms](~~419274~~) operation.'."\n"
."\n"
.'> You can specify only one `BizId`.', 'type' => 'string', 'required' => false, 'example' => '134523^435****', 'title' => ''],
],
[
'name' => 'SendDate',
'in' => 'query',
'schema' => ['description' => 'The date when the SMS message was sent. You can query records from the past 30 days.'."\n"
."\n"
.'Format: **yyyyMMdd**, for example, 20250601.', 'type' => 'string', 'required' => true, 'example' => '20250601', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of delivery records to return on each page.'."\n"
."\n"
.'Valid values: 1 to 50.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20', 'title' => ''],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => ['description' => 'The current page number for paginated results.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The request status code.'."\n"
."\n"
.'- **OK** indicates the request was successful.'."\n"
."\n"
.'- For other error codes, see [Error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => 'The request ID. This unique identifier is generated by Alibaba Cloud for each request and can be used for troubleshooting.', 'type' => 'string', 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF', 'title' => ''],
'TotalCount' => ['description' => 'The total number of SMS messages sent.'."\n"
."\n"
.'> - This value represents the number of submission attempts, not the number of units for billing.', 'type' => 'string', 'example' => '1', 'title' => ''],
'SmsSendDetailDTOs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SmsSendDetailDTO' => [
'description' => 'The SMS delivery details.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ErrCode' => ['description' => 'The delivery status code from the carrier.'."\n"
."\n"
.'- **DELIVERED**: The message was delivered successfully.'."\n"
."\n"
.'- For failure codes, see [Error codes](~~101347~~).', 'type' => 'string', 'example' => 'DELIVERED', 'title' => ''],
'TemplateCode' => ['description' => 'The code of the message template.'."\n"
."\n"
.'> The `TemplateCode` parameter is not returned for test messages sent with the `[Test] Alibaba Cloud` signature and the `[Test] Alibaba Cloud test template`.', 'type' => 'string', 'example' => 'SMS_12231****', 'title' => ''],
'OutId' => ['description' => 'The external ID.'."\n"
."\n"
.'> This parameter is returned only if you specify the `OutId` parameter in the send request.', 'type' => 'string', 'example' => '123', 'title' => ''],
'ReceiveDate' => ['description' => 'The time the message was received by the recipient\'s device.', 'type' => 'string', 'example' => '2025-06-01 16:44:13', 'title' => ''],
'SendDate' => ['description' => 'The time the message was sent.', 'type' => 'string', 'example' => '2025-06-01 16:44:10', 'title' => ''],
'PhoneNum' => ['description' => 'The recipient\'s phone number.', 'type' => 'string', 'example' => '1390000****', 'title' => ''],
'Content' => ['description' => 'The message content.', 'type' => 'string', 'example' => '【阿里云】验证码为:123,您正在登录,若非本人操作,请勿泄露', 'title' => ''],
'SendStatus' => ['description' => 'The delivery status of the SMS message. Valid values include:'."\n"
."\n"
.'- **1**: The message is awaiting a delivery receipt.'."\n"
."\n"
.'- **2**: The message failed to be delivered.'."\n"
."\n"
.'- **3**: The message was delivered successfully.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => 'Contains the delivery details.',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'QuerySendDetails',
'description' => '- This operation queries the details of SMS messages sent to a specific phone number on a given date. You can also provide the `BizId` to query a specific delivery record.'."\n"
."\n"
.'- This operation queries delivery details for a single phone number at a time. To view delivery details in bulk, use the [QuerySendStatistics](~~419276~~) operation to query delivery statistics, or log in to the [Delivery Receipts](https://dysms.console.aliyun.com/record) page in the console.'."\n"
."\n"
.'### QPS limit'."\n"
."\n"
.'The QPS limit for this operation is 5,000 requests per second per user. Calls that exceed this limit are throttled.',
'requestParamsDescription' => 'You can visit the [OpenAPI Portal](https://api.aliyun.com/api/Dysmsapi/2017-05-25/QuerySendDetails?tab=DEMO\\&lang=JAVA) to view SDK request examples for different languages.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySendDetails'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QuerySendDetails',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'QuerySendStatistics' => [
'summary' => 'Queries message delivery statistics, including send dates, the number of successfully sent messages, and the number of received delivery receipts.',
'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' => 'The destination scope of the messages. Valid values:'."\n"
."\n"
.'- **1**: domestic messages.'."\n"
."\n"
.'- **2**: international messages.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '2', 'minimum' => '1', 'maxLength' => 2, 'minLength' => 1, 'example' => '1', 'title' => ''],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => ['description' => 'The start date. The format is yyyyMMdd.', 'type' => 'string', 'required' => true, 'example' => '20201002', 'title' => ''],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => ['description' => 'The end date. The format is yyyyMMdd.', 'type' => 'string', 'required' => true, 'example' => '20201003', 'title' => ''],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'minLength' => 1, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The page size. Valid values: **1 to 50**.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '50', 'minimum' => '1', 'maxLength' => 50, 'minLength' => 1, 'example' => '10', 'title' => ''],
],
[
'name' => 'TemplateType',
'in' => 'query',
'schema' => ['description' => 'The template type. Valid values:'."\n"
."\n"
.'- **0**: verification code.'."\n"
."\n"
.'- **1**: notification message.'."\n"
."\n"
.'- **2**: promotional message. (Enterprise customers only)'."\n"
."\n"
.'- **3**: international message. (Enterprise customers only)'."\n"
."\n"
.'- **7**: digital message.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'SignName',
'in' => 'query',
'schema' => ['description' => 'The signature.', 'type' => 'string', 'required' => false, 'example' => '阿里云平台', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'."\n", 'title' => ''],
'Code' => ['description' => 'The response code. Valid values:'."\n"
."\n"
.'- OK: The request was successful.'."\n"
."\n"
.'- For other values, see [Error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => [
'description' => 'The data returned.',
'type' => 'object',
'properties' => [
'TotalSize' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
'TargetList' => [
'description' => 'A list of delivery statistics.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'The number of successfully sent messages (billable message count).', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
'RespondedSuccessCount' => ['description' => 'The number of messages with successful delivery receipts.', 'type' => 'integer', 'format' => 'int64', 'example' => '17', 'title' => ''],
'RespondedFailCount' => ['description' => 'The number of messages with failed delivery receipts.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
'NoRespondedCount' => ['description' => 'The number of messages with no delivery receipts.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'SendDate' => ['description' => 'The date the messages were sent. Format: yyyyMMdd.', 'type' => 'string', 'example' => '20201010', 'title' => ''],
],
'description' => 'The information about the configuration.'."\n",
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => 'The body of the response.',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
'title' => 'QuerySendStatistics',
'description' => '- If you query data over a long time range, the results are paginated. You can specify the page size and page number to navigate through the Delivery Logs.'."\n"
."\n"
.'- You can also view delivery details by logging in to the [Short Message Service console](https://dysms.console.aliyun.com/dysms.htm#/overview) and navigating to the **Business Statistics** > **Delivery Logs** page.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySendStatistics'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QuerySendStatistics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'QueryShortUrl' => [
'summary' => 'Checks the status and availability of a short link.',
'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' => 'The short link to query. Obtain this URL by calling the [AddShortUrl](~~186774~~) API.'."\n"
."\n"
.'><notice>'."\n"
."\n"
.'This API is not currently supported by Short Message Service.'."\n"
."\n"
.'></notice>', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'http://****.cn/6y8uy7', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The request status code.'."\n"
."\n"
.'- A successful request returns `OK`.'."\n"
."\n"
.'- For other error codes, see [Error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF', 'title' => ''],
'Data' => [
'description' => 'The details of the short link.',
'type' => 'object',
'properties' => [
'UniqueVisitorCount' => ['description' => 'The unique visitor (UV) count for the short link.', 'type' => 'string', 'example' => '23', 'title' => ''],
'SourceUrl' => ['description' => 'The source URL.', 'type' => 'string', 'example' => 'https://www.****.com/product/sms', 'title' => ''],
'ShortUrlStatus' => ['description' => 'The short link status. Valid values:'."\n"
."\n"
.'- **expired**: The short link has expired.'."\n"
."\n"
.'- **effective**: The short link is active.'."\n"
."\n"
.'- **audit**: The short link is under review.'."\n"
."\n"
.'- **reject**: The short link was rejected.', 'type' => 'string', 'example' => 'expired', 'title' => ''],
'PageViewCount' => ['description' => 'The page view (PV) count for the short link.', 'type' => 'string', 'example' => '300', 'title' => ''],
'ExpireDate' => ['description' => 'The expiration date and time of the short link.', 'type' => 'string', 'example' => '2019-01-22 11:21:11', 'title' => ''],
'ShortUrlName' => ['description' => 'The name of the service that generated the short link.', 'type' => 'string', 'example' => '阿里短链测试', 'title' => ''],
'CreateDate' => ['description' => 'The creation date and time of the short link.', 'type' => 'string', 'example' => '2019-01-08 16:44:13', 'title' => ''],
'ShortUrl' => ['description' => 'The generated short link.', 'type' => 'string', 'example' => 'http://****.cn/6y8uy7', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
'title' => 'QueryShortUrl',
'description' => '><notice>'."\n"
."\n"
.'This API is not currently supported by Short Message Service.'."\n"
."\n"
.'></notice>'."\n"
."\n"
.'### QPS limit'."\n"
."\n"
.'The QPS limit for this API is 20 queries per second per user. API calls that exceed this limit are rate-limited, which can impact your business. Plan your calls accordingly.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryShortUrl'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QueryShortUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'QuerySingleSmsQualification' => [
'summary' => 'After you apply for SMS qualifications, you can call this operation to query the details of a single qualification.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'parameters' => [
[
'name' => 'QualificationGroupId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The qualification ID, which is the ID returned when you [apply for a qualification](~~SubmitSmsQualification~~). You can call the [QuerySmsQualificationRecord](~~QuerySmsQualificationRecord~~) operation to obtain the qualification IDs under your current account.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000****'],
],
[
'name' => 'OrderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The review ticket ID. You can call the [QuerySmsQualificationRecord](~~QuerySmsQualificationRecord~~) operation to obtain the qualifications and corresponding review ticket IDs under your current account.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2001****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The details about the access denial. This parameter is returned only when the RAM check fails.', 'type' => 'string', 'example' => '无', 'title' => ''],
'RequestId' => ['description' => 'The ID of this API call request, which is the unique identifier generated by Alibaba Cloud for this request. It can be used to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA'."\n"],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Data' => [
'title' => '',
'description' => 'The details of a single qualification.',
'type' => 'object',
'properties' => [
'AdminIDCardExpDate' => ['title' => '', 'description' => 'The validity period of the administrator\'s certificate. Format: YYYY-MM-DD~YYYY-MM-DD.', 'type' => 'string', 'example' => '2023-01-01~2033-01-01'],
'BusinessType' => ['title' => '', 'description' => 'The industry type.', 'type' => 'string', 'example' => 'dysms'],
'AdminIDCardFrontFace' => ['title' => '', 'description' => 'The full URL of the photo of the front side of the administrator\'s certificate (national emblem side of the ID card).', 'type' => 'string', 'example' => 'https://******.aliyuncs.com/******'],
'Remark' => ['title' => '', 'description' => 'The remarks.', 'type' => 'string', 'example' => '无'],
'LegalPersonName' => ['title' => '', 'description' => 'The name of the legal representative.', 'type' => 'string', 'example' => '李华'],
'CompanyName' => ['title' => '', 'description' => 'The name of the enterprise.', 'type' => 'string', 'example' => '阿里云云通信有限公司'],
'LegalPersonIDCardNo' => ['title' => '', 'description' => 'The certificate number of the legal representative.', 'type' => 'string', 'example' => '511391********5123'."\n"],
'BusinessLicensePics' => [
'title' => '',
'description' => 'The business license information of the enterprise.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The type of business license. Valid values:'."\n"
."\n"
.'- socialCreditLicense: Unified social credit code certificate.'."\n"
.'- businessLicense: Business license.'."\n"
.'- signLegalLicense: Legal person certificate of a public institution.'."\n"
.'- otherLicense: Other types of license certificates.', 'type' => 'string', 'title' => '', 'example' => 'businessLicense'],
'LicensePic' => ['description' => 'The file path parameter of the business license.', 'type' => 'string', 'title' => '', 'example' => '123456/111.png'],
'PicUrl' => ['title' => '', 'description' => 'The full URL of the business license file.', 'type' => 'string', 'example' => 'https://******.aliyuncs.com/******'."\n"],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '',
],
'AdminIDCardNo' => ['title' => '', 'description' => 'The certificate number of the administrator.', 'type' => 'string', 'example' => '511391********5123'],
'OrganizationCode' => ['title' => '', 'description' => 'The unified social credit code.', 'type' => 'string', 'example' => '910X********0012'."\n"],
'LegalPersonIdCardEffTime' => ['title' => '', 'description' => 'The validity period of the legal representative\'s certificate. Format: YYYY-MM-DD~YYYY-MM-DD.', 'type' => 'string', 'example' => '2023-01-01~2033-01-01'],
'AdminPhoneNo' => ['title' => '', 'description' => 'The mobile phone number of the administrator.', 'type' => 'string', 'example' => '137*******'],
'QualificationName' => ['title' => '', 'description' => 'The qualification name.', 'type' => 'string', 'example' => '阿里云云通信有限公司资质李华'."\n"],
'AdminName' => ['title' => '', 'description' => 'The name of the administrator.', 'type' => 'string', 'example' => '李华'],
'CompanyType' => ['title' => '', 'description' => 'The type of enterprise. Valid values:'."\n"
."\n"
.'- COMPANY: Enterprise.'."\n"
.'- NON_PROFIT_ORGANIZATION: Government agency or public institution.', 'type' => 'string', 'example' => 'COMPANY'],
'AdminIDCardType' => ['title' => '', 'description' => 'The type of the administrator\'s certificate. Valid values:'."\n"
."\n"
.'- identityCard: ID card.'."\n"
.'- passport: Passport.'."\n"
.'- homeReturnPermit: Home return permit for Hong Kong and Macao residents.'."\n"
.'- TaiwanCompatriotPermit: Mainland travel permit for Taiwan residents.'."\n"
.'- residencePermit: Residence permit for residents of Hong Kong, Macao, and Taiwan.'."\n"
.'- other: Other.', 'type' => 'string', 'example' => 'identityCard'],
'UseBySelf' => ['title' => '', 'description' => 'The purpose of the qualification application. Valid values:'."\n"
."\n"
.'- **true**: For self-use.'."\n"
.'- **false**: For other use.', 'type' => 'boolean', 'example' => 'false'],
'EffTimeStr' => ['description' => 'The validity period of the business license. Format: YYYY-MM-DD~YYYY-MM-DD.', 'type' => 'string', 'title' => '', 'example' => '2023-01-01~2033-01-01'."\n"],
'QualificationGroupId' => ['description' => 'The qualification ID.', 'type' => 'integer', 'title' => '', 'format' => 'int64', 'example' => '10000****'],
'WhetherShare' => [
'description' => 'Qualification authorization. Indicates whether to allow this qualification to be shared with other cloud communication products (such as Domestic Voice and Domestic Number Privacy Protection). The qualification can be shared and reused only when you apply for a **self-use qualification** and the qualification information **matches the enterprise information authenticated under the current Alibaba Cloud account**. Other cases are invalid. Valid values:'."\n"
."\n"
.'- true: Agree. Your qualification information can be invoked in the "qualification authentication step" of other cloud communication products, eliminating duplicate authentication steps.'."\n"
.'- false: Disagree.',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'boolean',
'title' => '',
'example' => 'false',
],
'WorkOrderId' => ['title' => '', 'description' => 'The review ticket ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2001****'],
'State' => [
'title' => '',
'description' => 'The review status. Valid values:'."\n"
."\n"
.'- INT: Under review.'."\n"
.'- FAILED: Review failed.'."\n"
.'- PASSED: Review passed.'."\n"
.'- NOT_FINISH: Materials to be supplemented.'."\n"
.'- CANCELED: Cancelled.'."\n"
."\n"
.'> This API does not return review remarks. To query review remarks (`AuditRemark`), use [QuerySmsQualificationRecord](~~QuerySmsQualificationRecord~~).',
'enumValueTitles' => ['NOT_FINISH' => 'Materials to be supplemented', 'FAILED' => 'Review failed', 'CANCELED' => 'Cancelled', 'INT' => 'Under review', 'PASSED' => 'Review passed'],
'type' => 'string',
'example' => 'PASSED',
],
'OtherFiles' => [
'title' => '',
'description' => 'Additional materials.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LicensePic' => ['description' => 'The file path parameter of the additional materials.', 'type' => 'string', 'title' => '', 'example' => '123456/111.png'],
'PicUrl' => ['title' => '', 'description' => 'The full URL of the additional materials file.', 'type' => 'string', 'example' => 'https://******.aliyuncs.com/******'],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '',
],
'LegalPersonIDCardType' => ['title' => '', 'description' => 'The type of the legal representative\'s certificate. Valid values:'."\n"
."\n"
.'- identityCard: ID card.'."\n"
.'- passport: Passport.'."\n"
.'- homeReturnPermit: Home return permit for Hong Kong and Macao residents.'."\n"
.'- TaiwanCompatriotPermit: Mainland travel permit for Taiwan residents.'."\n"
.'- residencePermit: Residence permit for residents of Hong Kong, Macao, and Taiwan.'."\n"
.'- other: Other.', 'type' => 'string', 'example' => 'identityCard'],
'AdminIDCardPic' => ['title' => '', 'description' => 'The full URL of the photo of the back side of the administrator\'s certificate (portrait side of the ID card).', 'type' => 'string', 'example' => 'https://******.aliyuncs.com/******'],
],
'example' => '',
],
'Code' => ['description' => 'The status code of the request.'."\n"
."\n"
.'- The value OK indicates that the request was successful.'."\n"
.'- For other error codes, see the error code list in this chapter or the product [error code list](~~101346~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Success' => [
'description' => 'Indicates whether the API call was successful. Valid values:'."\n"
."\n"
.'- **true**: The call was successful.'."\n"
.'- **false**: The call failed.',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'Query the details of a single qualification',
'description' => '- This API queries the details of a single qualification (enterprise information, legal representative information, and administrator information).'."\n"
.'- To query all qualification information under your current account, or to query review details, call the [QuerySmsQualificationRecord](~~QuerySmsQualificationRecord~~) operation.'."\n"
.'- Affected by the SMS signature real-name registration requirements, the volume of qualification review tickets is growing rapidly, and the review time may be extended. Please be patient. The review is expected to be completed within 2 business days (review hours: Monday to Sunday 9:00-21:00, postponed for legal holidays). In special cases, the review time may be extended. Please be patient.',
'changeSet' => [
['createdAt' => '2025-08-01T04:05:19.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [],
],
'QuerySmsAppIcpRecord' => [
'summary' => 'Queries icp record details.',
'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' => [
'description' => 'A list of icp record entity IDs.',
'title' => 'APP ICP filing entity ID list ',
'type' => 'array',
'items' => ['description' => 'The icp record entity ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000***', 'title' => ''],
'required' => true,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The access denial details.', 'type' => 'string', 'example' => '无', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'C9955E63-8BFF-101D-80A1-E6998DFEFF1A'],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Data' => [
'description' => 'A list of APP-ICP record entity details.',
'title' => '',
'type' => 'array',
'items' => [
'description' => 'The details of an APP-ICP record entity.',
'type' => 'object',
'properties' => [
'AppIcpRecordId' => ['title' => 'APP-ICP filing material ID', 'description' => 'The ID of the APP-ICP record material.', 'type' => 'integer', 'format' => 'int64', 'example' => '51'],
'AppIcpRecordPic' => ['title' => 'OSS key of the APP-ICP filing screenshot image (used for submitting tickets related to signatures)', 'description' => 'The OSS fileKey for the APP-ICP record screenshot.', 'type' => 'string', 'example' => '10000025*****02/ac181696-****-49c6-90dc-50689267aa00_mhsjd8b8_17*****662348.jpeg'],
'AppIcpRecordPicUrl' => ['title' => 'URL of the APP-ICP filing screenshot', 'description' => 'The URL of the APP-ICP record screenshot.', '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' => 'Sponsoring organization name', 'description' => 'The hosting unit name.', 'type' => 'string', 'example' => '阿里云'],
'AppIcpLicenseNumber' => ['title' => 'ICP Filing/License Number ', 'description' => 'The icp filing/license number.', 'type' => 'string', 'example' => '123'],
'Domain' => ['title' => 'APP App Store Link ', 'description' => 'The app store link.', 'type' => 'string', 'example' => 'https://apps.apple.com/cn/app/阿里云/id981011420'],
'AppApprovalDate' => ['title' => 'Review pass date, for example: 2025-09-01 ', 'description' => 'The approval date.', 'type' => 'string', 'example' => '2020-01-01'],
'AppServiceName' => ['title' => 'APP service name ', 'description' => 'The app service name.', 'type' => 'string', 'example' => '测试'],
],
'title' => '',
'example' => '',
],
'example' => '',
],
'Code' => ['description' => 'The status code of the request.'."\n"
."\n"
.'- OK indicates a successful request.'."\n"
."\n"
.'- For other error codes, see the [error code list](https://help.aliyun.com/document_detail/101346.htm).', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Success' => ['description' => 'Specifies whether the API call was successful. Valid values:'."\n"
."\n"
.'- **true**: The call was successful.'."\n"
."\n"
.'- **false**: The call failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query ICP Filing Entity ',
'description' => 'Pass a list of icp record IDs to retrieve their details.'."\n"
."\n"
.'For example, call the QuerySmsSignList or GetSmsSign API to obtain the required icp record IDs.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [],
'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"}]',
],
'QuerySmsAuthorizationLetter' => [
'summary' => 'Queries created letters of authorization. You can view the review status and authorized signature scope of the letters.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '264690',
'abilityTreeNodes' => ['FEATUREdysmsJ2BZAJ'],
],
'parameters' => [
[
'name' => 'AuthorizationLetterIdList',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'The list of letter of authorization IDs.',
'type' => 'array',
'items' => ['description' => 'The letter of authorization ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000*****', 'title' => ''],
'required' => false,
'example' => '',
],
],
[
'name' => 'SignName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The signature name. If the authorization scope includes multiple signatures when you create the letter of authorization, the letters of authorization that contain the signature are returned.', 'type' => 'string', 'required' => false, 'example' => '菜鸟网络'],
],
[
'name' => 'OrganizationCode',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The unified social credit code of the authorizing party. The length cannot exceed 150 characters.', 'type' => 'string', 'required' => false, 'example' => '9****************A'],
],
[
'name' => 'State',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The review status of the letter of authorization, which is related to the review status of the signature. Valid values:'."\n"
.'- **INT**: Pending review. The letter of authorization has been created. After you submit a signature application, it enters the review process.'."\n"
.'- **PASSED**: Review passed. When a signature in the authorized signature scope of the letter of authorization passes the review, the status of the letter of authorization changes to PASSED.',
'enumValueTitles' => ['INT' => 'Pending review', 'PASSED' => 'Review passed'],
'type' => 'string',
'required' => false,
'example' => 'PASSED',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The availability status of the letter of authorization, which is related to the validity period of the letter of authorization. Valid values:'."\n"
."\n"
.'- **VALID**: Available. The letter of authorization is within the validity period.'."\n"
.'- **INVALID**: Unavailable. The letter of authorization has expired.',
'enumValueTitles' => ['VALID' => 'Available', 'INVALID' => 'Unavailable'],
'type' => 'string',
'required' => false,
'example' => 'VALID',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The details of the access denial. This parameter is returned only when the RAM check fails.', 'type' => 'string', 'example' => '无', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => '25D5AFDE-8EBC-132E-8909-1FDC071D'],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Data' => [
'title' => '',
'description' => 'The information of the letters of authorization.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Authorization' => ['title' => '', 'description' => 'The authorizing party.', 'type' => 'string', 'example' => '菜鸟网络科技有限公司'],
'Status' => ['title' => '', 'description' => 'The availability status of the letter of authorization, which is related to the validity period of the letter of authorization. Valid values:'."\n"
."\n"
.'- **VALID**: Available. The letter of authorization is within the validity period.'."\n"
.'- **INVALID**: Unavailable. The letter of authorization has expired.', 'type' => 'string', 'example' => 'VALID'],
'SignScope' => ['title' => '', 'description' => 'The authorized signature scope. If multiple signatures are included, the signatures are separated by Chinese enumeration commas (、).', 'type' => 'string', 'example' => '菜鸟网络、菜鸟驿站、菜鸟裹裹'],
'State' => ['title' => '', 'description' => 'The status of the letter of authorization, which is related to the review status of the signature. Valid values:'."\n"
.'- **INT**: Pending review. The letter of authorization has been created. After you submit a signature application, it enters the review process.'."\n"
.'- **PASSED**: Review passed. When a signature in the authorized signature scope of the letter of authorization passes the review, the status of the letter of authorization changes to PASSED.', 'type' => 'string', 'example' => 'PASSED'],
'AuthorizationLetterExpDate' => ['title' => '', 'description' => 'The validity period of the letter of authorization. Format: YYYY-MM-DD~YYYY-MM-DD.', 'type' => 'string', 'example' => '2023-01-01~2026-01-01'],
'AuthorizationLetterPic' => ['title' => '', 'description' => 'The URL of the letter of authorization file.', 'type' => 'string', 'example' => '1000045****/111.png'],
'OrganizationCode' => ['title' => '', 'description' => 'The unified social credit code of the authorizing party.', 'type' => 'string', 'example' => '9****************A'],
'ProxyAuthorization' => ['title' => '', 'description' => 'The authorized party.', 'type' => 'string', 'example' => '支付宝(中国)网络技术有限公司'],
'AuthorizationLetterId' => ['title' => '', 'description' => 'The letter of authorization ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000******'],
'AuthorizationLetterName' => ['title' => '', 'description' => 'The name of the letter of authorization.', 'type' => 'string', 'example' => '菜鸟公司授权书'],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '',
],
'Code' => ['description' => 'The status code of the request.'."\n"
."\n"
.'- The value OK indicates that the request was successful.'."\n"
.'- For other error codes, see the error code list in this topic or [API error codes](~~101346~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Success' => [
'description' => 'Indicates whether the API call was successful. Valid values:'."\n"
."\n"
.'- **true**: The call was successful.'."\n"
.'- **false**: The call failed.',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'Query letters of authorization',
'description' => '- Supports full query or conditional query:'."\n"
.' - **Full query**: Queries the information of all letters of authorization under your current account. No parameters need to be passed. Full query is performed by default.'."\n"
.' - **Conditional query**: Supports queries by letter of authorization ID, signature name, and review status of the letter of authorization. Pass the parameters by which you want to filter.'."\n"
."\n"
.'- Review duration: Affected by the real-name registration requirements for SMS signatures, the volume of qualification review tickets is currently increasing rapidly, and the review duration may be extended. Please wait patiently. The review is expected to be completed within 2 working days. SMS signatures and templates are expected to be reviewed within 2 hours after submission. Reviews involving governments and enterprises are generally completed within 2 working days. If verification upgrades, a large number of review tasks, or non-working hours are encountered, the review duration may be extended. Please wait patiently. (Review working hours: Monday to Sunday, 9:00–21:00, postponed for statutory holidays.)',
'changeSet' => [
['createdAt' => '2025-08-01T04:05:19.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [],
],
'QuerySmsQualificationRecord' => [
'summary' => 'Queries a list of SMS qualifications and their review details after you submit qualification applications. This operation supports filtered query.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'parameters' => [
[
'name' => 'QualificationGroupName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The qualification name.', 'type' => 'string', 'required' => false, 'example' => '阿里云云通信有限公司李华'],
],
[
'name' => 'CompanyName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The company name.', 'type' => 'string', 'required' => false, 'example' => '阿里云云通信有限公司'],
],
[
'name' => 'State',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The review status. Valid values:'."\n"
."\n"
.'- INIT: Under review.'."\n"
.'- NOT_PASS: Review rejected. '."\n"
.'- PASS: Review approved.'."\n"
.'- NOT_FINISH: Additional information required.'."\n"
.'- CANCEL: Withdrawn.', 'type' => 'string', 'required' => false, 'example' => 'PASS'],
],
[
'name' => 'WorkOrderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The review ticket ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2001****'],
],
[
'name' => 'LegalPersonName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The name of the legal representative.', 'type' => 'string', 'required' => false, 'example' => '李华'],
],
[
'name' => 'UseBySelf',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The purpose of the qualification application. Valid values:'."\n"
."\n"
.'- **true**: For self-use.'."\n"
.'- **false**: For use by others.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'title' => '', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page. Valid values: **1 to 50**.', 'type' => 'integer', 'title' => '', 'format' => 'int64', 'required' => false, 'example' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无', 'title' => ''],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'title' => '', 'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA'."\n"],
'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Data' => [
'description' => '资质审核列表',
'type' => 'object',
'properties' => [
'PageSize' => ['description' => '每页数据条数。', 'type' => 'integer', 'title' => '', 'format' => 'int64', 'example' => '20'],
'Total' => ['description' => '总条数。', 'type' => 'integer', 'title' => '', 'format' => 'int64', 'example' => '25'],
'PageNo' => ['description' => '当前页码。', 'type' => 'integer', 'title' => '', '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' => '', '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' => '', 'description' => '资质ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000****'],
'UseBySelf' => ['title' => '', 'description' => '资质申请用途,取值:'."\n"
."\n"
.'- **true**:自用。'."\n"
.'- **false**:他用。', 'type' => 'string', 'example' => 'true'],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Code' => ['description' => '请求状态码。'."\n"
."\n"
.'* 返回OK代表请求成功。'."\n"
.'* 其他错误码,请参见本章节的错误码列表或产品[API错误码](~~101346~~)。', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Success' => ['description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'Query qualification list',
'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)页面修改资质信息后,重新发起审核。',
'changeSet' => [
['createdAt' => '2025-08-01T04:05:19.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [],
],
'QuerySmsSign' => [
'summary' => 'Queries the review status of an SMS signature.',
'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' => 'The name of an existing SMS signature in your account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '阿里云', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CC89A90C-978F-46AC-B80D-54738371E7CA', 'title' => ''],
'SignStatus' => ['description' => 'The review status of the SMS signature. Valid values:'."\n"
."\n"
.'- **0**: Pending Review.'."\n"
."\n"
.'- **1**: Approved.'."\n"
."\n"
.'- **2**: Rejected. For details, see the `Reason` parameter.'."\n"
."\n"
.'- **10**: Canceled.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Code' => ['description' => 'The status code of the request.'."\n"
."\n"
.'- `OK` indicates that the request was successful.'."\n"
."\n"
.'- For other error codes, see [Error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'CreateDate' => ['description' => 'The date and time when the SMS signature was created.', 'type' => 'string', 'example' => ' 2019-01-08 16:44:13', 'title' => ''],
'Reason' => ['description' => 'The review reason.'."\n"
."\n"
.'- If the review status is **Approved** or **Pending Review**, this parameter is empty.'."\n"
."\n"
.'- If the review status is **Rejected**, this parameter provides the reason for the rejection.', 'type' => 'string', 'example' => '文件不能证明信息真实性,请重新上传', 'title' => ''],
'SignName' => ['description' => 'The SMS signature.', 'type' => 'string', 'example' => '阿里云', 'title' => ''],
],
'description' => 'The response body.',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
'title' => 'QuerySmsSign',
'description' => '- To comply with regulations from the Ministry of Industry and Information Technology (MIIT) and [related requirements](~~2806975~~) from carriers, Alibaba Cloud has upgraded its SMS signature management APIs. We recommend using the new [GetSmsSign - Query Signature Details](~~2807429~~) API, which returns more detailed information about signatures than this API.'."\n"
."\n"
.'- We typically review signatures within two hours of submission. The review service is available from 9:00 to 21:00, Monday to Sunday. Reviews may be delayed during public holidays. We recommend submitting your application before 18:00 for a timely review.'."\n"
."\n"
.'- If a signature is rejected, the response includes the review reason. For troubleshooting information, see [Troubleshooting Signature Review Failures](~~65990~~). You can then call the [ModifySmsTemplate](~~419287~~) API or modify the SMS signature on the [Signature Management](https://dysms.console.aliyun.com/domestic/text) page.'."\n"
."\n"
.'- This API queries the review details for a single signature by name. To query all signatures in your account, call the [QuerySmsSignList](~~419288~~) API.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySmsSign'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QuerySmsSign',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'QuerySmsSignList' => [
'summary' => 'You can call this operation to query all signatures under your account, including signature audit status, signature type, and signature name.',
'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' => 'The page number. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'minLength' => 1, 'default' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of signatures to return on each page. Default value: **10**. Valid values: **1 to 50**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'."\n", 'title' => ''],
'Code' => ['description' => 'The HTTP status code. Valid values:'."\n"
.' '."\n"
.'- OK: The request was successful.'."\n"
."\n"
.'- For other error codes, see [Error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'SmsSignList' => [
'description' => 'The list of returned results.',
'type' => 'array',
'items' => [
'description' => 'The list of returned results.',
'type' => 'object',
'properties' => [
'SignName' => ['description' => 'The signature name.', 'type' => 'string', 'example' => '阿里云', 'title' => ''],
'AuditStatus' => ['description' => 'The audit status of the signature. Valid values:'."\n"
."\n"
.'- **AUDIT_STATE_INIT**: under review.'."\n"
."\n"
.'- **AUDIT_STATE_PASS**: approved.'."\n"
."\n"
.'- **AUDIT_STATE_NOT_PASS**: rejected. You can view the rejection reason in the Reason response parameter.'."\n"
."\n"
.'- **AUDIT_STATE_CANCEL**: review canceled.', 'type' => 'string', 'example' => 'AUDIT_STATE_NOT_PASS', 'title' => ''],
'CreateDate' => ['description' => 'The time when the SMS signature was created. The format is yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2020-06-04 11:42:17', 'title' => ''],
'Reason' => [
'description' => 'The audit remarks.'."\n"
."\n"
.'- If the audit status is **approved** or **under review**, the Reason parameter is displayed as "No audit remarks".'."\n"
."\n"
.'- If the audit status is **rejected**, the Reason parameter displays the specific reason for the rejection.',
'type' => 'object',
'properties' => [
'RejectSubInfo' => ['description' => 'The remarks for the rejection.', 'type' => 'string', 'example' => '文件不能证明信息真实性,请重新上传。', 'title' => ''],
'RejectDate' => ['description' => 'The time when the signature was rejected. The format is yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2020-06-04 13:35:10', 'title' => ''],
'RejectInfo' => ['description' => 'The reason for the rejection.', 'type' => 'string', 'example' => '文件不能证明信息真实性,请重新上传。', 'title' => ''],
],
'title' => '',
'example' => '',
],
'BusinessType' => ['description' => 'The scenario type of the signature. Valid values:'."\n"
."\n"
.'- Verification code.'."\n"
."\n"
.'- General-purpose.', 'type' => 'string', 'example' => '验证码类型', 'title' => ''],
'OrderId' => ['description' => 'The order ID.'."\n"
."\n"
.'This parameter is used by auditors when querying the audit. You must provide this order ID if you need to expedite the audit.', 'type' => 'string', 'example' => '2005098****', 'title' => ''],
'AuthorizationLetterId' => ['description' => 'The ID of the letter of authorization.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000********1234', 'title' => ''],
'authorizationLetterAuditPass' => [
'description' => 'The audit status of the letter of authorization. Valid values:'."\n"
.'- true: approved.'."\n"
.'- false: not approved (includes all statuses other than approved).',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'TrademarkId' => ['description' => 'The trademark entity ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000009081***', 'title' => ''],
'AppIcpRecordId' => ['description' => 'The APP-ICP filing entity ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000001***123', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TotalCount' => ['description' => 'The total number of signatures.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'CurrentPage' => ['description' => 'The page number. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of signatures to return on each page. Default value: **10**. Valid values: **1 to 50**.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
'title' => 'Query signature list details',
'description' => 'This operation queries the signature information that was **first created** or the **most recently approved** signature details under your current account. If you need to query more information such as application scenario content or files uploaded during application, you can call the [GetSmsSign](~~GetSmsSign~~) operation to query the audit details of a single signature by signature name.',
'changeSet' => [
['createdAt' => '2025-12-16T07:48:28.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2025-12-11T12:44:33.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-12-11T12:44:31.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-12-11T10:08:22.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-12-11T10:08:22.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-14T02:14:08.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-14T02:14:00.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-14T02:07:46.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-03T13:14:40.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-03T13:14:39.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-03T13:14:00.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-03T13:14:00.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySmsSignList'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QuerySmsSignList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'QuerySmsTemplate' => [
'summary' => 'This API has been deprecated.',
'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' => 'The template code.'."\n"
."\n"
.'- The template code is returned in the response of the [AddSmsTemplate](~~121208~~) API.'."\n"
."\n"
.'- The template code is available on the [Template Management](https://dysms.console.aliyun.com/domestic/text/template) page.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SMS_1525****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TemplateContent' => ['description' => 'The template content.', 'type' => 'string', 'example' => '亲爱的会员!阿里云短信服务祝您新年快乐!', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A974B78-02BF-4C79-ADF3-90CFBA1B55B1', 'title' => ''],
'TemplateCode' => ['description' => 'The template code.', 'type' => 'string', 'example' => 'SMS_1525****', 'title' => ''],
'TemplateStatus' => ['description' => 'The review status of the template. Valid values:'."\n"
."\n"
.'- **0**: Reviewing.'."\n"
."\n"
.'- **1**: Approved.'."\n"
."\n"
.'- **2**: Rejected. The reason for the rejection is returned in the response. For more information, see [Suggestions for handling a failed review](~~65990~~). You can then call the [ModifySmsTemplate](~~419287~~) API or modify the template on the [Template Management](https://dysms.console.aliyun.com/domestic/text/template) page.'."\n"
."\n"
.'- **10**: Canceled.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Code' => ['description' => 'The status code of the request.'."\n"
."\n"
.'- OK indicates that the request was successful.'."\n"
."\n"
.'- For a list of other error codes, see [Error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'TemplateType' => ['description' => 'The message type. Valid values:'."\n"
."\n"
.'- **0**: Verification code.'."\n"
."\n"
.'- **1**: Message notification.'."\n"
."\n"
.'- **2**: Promotional message.'."\n"
."\n"
.'- **3**: International message.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'TemplateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => '通知短信', 'title' => ''],
'CreateDate' => ['description' => 'The time when the template was created.', 'type' => 'string', 'example' => '2024-06-03 10:02:34', 'title' => ''],
'Reason' => ['description' => 'The review notes for the template.'."\n"
."\n"
.'- If the review status is **Approved** or **Reviewing**, the message "No review remarks" is returned.'."\n"
."\n"
.'- If the review status is **Rejected**, the reason for the rejection is returned.', 'type' => 'string', 'example' => '无审批备注', 'title' => ''],
],
'description' => 'The data returned.',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => [
'substitutions' => ['Dysmsapi::2017-05-25::GetSmsTemplate'],
],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
'title' => 'QuerySmsTemplate',
'description' => '- Alibaba Cloud has updated its template-related APIs to comply with regulatory and [carrier requirements](~~2806975~~). We recommend that you use the new [GetSmsTemplate - Query template review details](~~2807433~~) API. The new API returns more detailed template information in its response.'."\n"
."\n"
.'- Review timeline: After you submit a template, Alibaba Cloud typically completes the review within two hours. Review hours are 9:00 to 21:00 (UTC+8) from Monday to Sunday. Reviews are postponed during public holidays. We recommend that you submit your templates before 18:00 (UTC+8).'."\n"
."\n"
.'- If a template fails review, the response includes the reason for the rejection. For more information, see [Suggestions for handling a failed review](~~65990~~). You can then call the [ModifySmsTemplate](~~419287~~) API or modify the template on the [Template Management](https://dysms.console.aliyun.com/domestic/text/template) page.'."\n"
."\n"
.'- QuerySmsTemplate queries the review details of a single template by its template code. To query the details of all templates in your account, call the [QuerySmsTemplateList](~~419288~~) API.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySmsTemplate'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QuerySmsTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'extraInfo' => ' ',
],
'QuerySmsTemplateList' => [
'summary' => 'You can call this operation to query all templates under your account. This way, you can view template details, including the template approval status, template type, and template content.',
'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' => 'The current page number. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of templates displayed per page. Valid values: **1 to 50**. Default value: **10**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. The unique identifier generated by Alibaba Cloud for the request can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => '819BE656-D2E0-4858-8B21-B2E47708****', 'title' => ''],
'Code' => ['description' => 'The HTTP status code.'."\n"
."\n"
.'- The value OK indicates that the request was successful.'."\n"
.'- For information about other status codes, see [Error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'SmsTemplateList' => [
'description' => 'The result list.',
'type' => 'array',
'items' => [
'description' => 'The details of a single template.',
'type' => 'object',
'properties' => [
'TemplateCode' => ['description' => 'The code of the SMS template.', 'type' => 'string', 'example' => 'SMS_1525***', 'title' => ''],
'TemplateName' => ['description' => 'The name of the SMS template.', 'type' => 'string', 'example' => '验证码模板', 'title' => ''],
'OuterTemplateType' => ['description' => 'The template type (for external use). Valid values:'."\n"
."\n"
.'- **0**: verification code message.'."\n"
.'- **1**: notification message.'."\n"
.'- **2**: promotional message.'."\n"
.'- **3**: international or Hong Kong, Macao, and Taiwan message.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'AuditStatus' => ['description' => 'The template approval status. Valid values:'."\n"
."\n"
.'- **AUDIT_STATE_INIT**: under review.'."\n"
.'- **AUDIT_STATE_PASS**: approved.'."\n"
.'- **AUDIT_STATE_NOT_PASS**: rejected. View the rejection reason in the Reason response parameter.'."\n"
.'- **AUDIT_SATE_CANCEL**: review canceled.', 'type' => 'string', 'example' => 'AUDIT_STATE_PASS', 'title' => ''],
'TemplateContent' => ['description' => 'The template content.', 'type' => 'string', 'example' => '验证码为:${code},您正在注册成为平台会员,感谢您的支持!', 'title' => ''],
'CreateDate' => ['description' => 'The time when the template was created. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2020-06-04 11:42:17', 'title' => ''],
'Reason' => [
'description' => 'The approval result.',
'type' => 'object',
'properties' => [
'RejectDate' => ['description' => 'The time when the template was rejected. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2020-06-04 16:01:17', 'title' => ''],
'RejectInfo' => ['description' => 'The reason why the template was rejected.', 'type' => 'string', 'example' => '变量不符合规范', 'title' => ''],
'RejectSubInfo' => ['description' => 'The detailed reason why the template was rejected.', 'type' => 'string', 'example' => '变量属性选择错误。'."\n"
.'请根据业务使用场景选择合适的变量属性。', 'title' => ''],
],
'title' => '',
'example' => '',
],
'OrderId' => ['description' => 'The ticket ID.'."\n"
."\n"
.'Reviewers use this parameter when querying approval information. You must provide this ticket ID when you request expedited approval.', 'type' => 'string', 'example' => '2004983****', 'title' => ''],
'TemplateType' => ['description' => 'The template type. Valid values:'."\n"
."\n"
.'- **0**: notification message.'."\n"
.'- **1**: promotional message.'."\n"
.'- **2**: verification code message.'."\n"
.'- **6**: international or Hong Kong, Macao, and Taiwan message.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'SignatureName' => ['description' => 'The name of the associated signature.', 'type' => 'string', 'example' => '阿里云', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TotalCount' => ['description' => 'The total number of templates returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'CurrentPage' => ['description' => 'The current page number. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of templates displayed per page. Valid values: **1 to 50**.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","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 }\\n ],\\n \\"TotalCount\\": 100,\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
'title' => 'Queries the details of template lists',
'description' => '- This operation queries the template details of all templates under your current account. To query more details such as the template variable content and the file information uploaded during application, you can call the [GetSmsTemplate](~~GetSmsTemplate~~) operation to query the approval details of a single template by template code.'."\n"
.'- You can also log on to the Short Message Service (SMS) console and view the template details of all templates under your current account on the [Template Management](https://dysms.console.aliyun.com/domestic/text/template) page.',
'changeSet' => [
['createdAt' => '2026-06-08T07:45:00.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2026-06-08T07:44:55.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2026-06-04T07:56:04.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2026-06-04T07:55:45.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-27T03:33:20.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-27T03:33:12.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-08-12T14:41:26.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySmsTemplateList'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QuerySmsTemplateList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'QuerySmsTrademark' => [
'summary' => 'Queries the details of one or more trademarks.',
'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' => [
'description' => 'A list of trademark IDs.',
'title' => 'List of trademark entity IDs ',
'type' => 'array',
'items' => ['description' => 'A trademark ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000***', 'title' => ''],
'required' => true,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The details of the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '569E9DBD-23FF-1785-99AD-E4B23608C104'],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Data' => [
'description' => 'A list of trademark details.',
'title' => '',
'type' => 'array',
'items' => [
'description' => 'The details of a trademark.',
'type' => 'object',
'properties' => [
'TrademarkPicUrl' => ['title' => 'URL of the trademark screenshot.', 'description' => 'The URL of the trademark screenshot.', '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' => 'Trademark registration number.', 'description' => 'The trademark registration number.', 'type' => 'string', 'example' => '1234'],
'TrademarkName' => ['title' => 'Trademark name.', 'description' => 'The name of the trademark.', 'type' => 'string', 'example' => '示例商标'],
'TrademarkPic' => ['title' => 'OSS key of the trademark screenshot (used when submitting a ticket for signature).', 'description' => 'The Object Storage Service (OSS) file key for the trademark image.', 'type' => 'string', 'example' => '100000*****802/afdebd46-****-46e4-899d-b4375826c898_mhk9oz0p_1762****31542.png'],
'TrademarkEffExpDate' => ['title' => 'Effective and expiration dates of exclusive rights.', 'description' => 'The validity period of the trademark.', 'type' => 'string', 'example' => '2025-11-01~2025-12-19'],
'TrademarkId' => ['title' => 'Trademark material ID ', 'description' => 'The trademark ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000*******'],
'TrademarkApplicantName' => ['title' => 'Applied By Name ', 'description' => 'The applicant name.', 'type' => 'string', 'example' => '阿里云'],
],
'title' => '',
'example' => '',
],
'example' => '',
],
'Code' => ['description' => 'The status code of the request.'."\n"
."\n"
.'- `OK` indicates that the request was successful.'."\n"
."\n"
.'- For other error codes, see [Error codes](~~101346~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Success' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'- **true**: The request is successful.'."\n"
."\n"
.'- **false**: The request fails.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query trademark entity ',
'description' => 'This operation retrieves the details of trademarks by using a list of trademark IDs.'."\n"
."\n"
.'For example, you can obtain trademark IDs by calling signature query operations such as `QuerySmsSignList` or `GetSmsSign`. You can then use this operation to retrieve the details of each trademark.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [],
'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"}]',
],
'RequiredPhoneCode' => [
'summary' => 'When applying for SMS qualification, the administrator\'s phone number must be verified. Use this operation to obtain an SMS verification code.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'parameters' => [
[
'name' => 'PhoneNo',
'in' => 'query',
'schema' => ['description' => 'The administrator\'s phone number that receives the verification code.'."\n"
.'- The account that **calls this operation to send the verification code must be the same account that submits the qualification**. Otherwise, the call fails.'."\n"
.'- Phone number format: +/+86/0086/86 or a mobile phone number without any prefix, for example 1390000****.', 'type' => 'string', 'title' => '', 'required' => true, 'example' => '137****1234'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****'],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Data' => ['description' => 'This field is not returned and can be ignored.', 'type' => 'string', 'example' => '-', 'title' => ''],
'Code' => ['description' => 'The request status code.'."\n"
."\n"
.'- OK indicates that the request was successful.'."\n"
.'- For other error codes, see [Error codes](~~101346~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Success' => [
'description' => 'Indicates whether the operation call is successful. Valid values:'."\n"
."\n"
.'- **true**: The call is successful.'."\n"
."\n"
.'- **false**: The call fails.',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'Obtain a phone verification code',
'description' => '- After you receive the phone verification code, pass it to the `CertifyCode` parameter of the [SubmitSmsQualification](~~SubmitSmsQualification~~) or [UpdateSmsQualification](~~UpdateSmsQualification~~) operation.'."\n"
.'- You can call the [ValidPhoneCode](~~ValidPhoneCode~~) operation to verify whether the SMS verification code is correct.'."\n"
.'- This operation is subject to [throttling](~~44335#section-0wh-xn6-0t7~~). Do not call it too frequently. For the same phone number, a maximum of 1 message per minute, 5 messages per hour, and 10 messages per day are supported.',
'changeSet' => [
['createdAt' => '2025-08-01T04:05:19.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [],
],
'SendBatchCardSms' => [
'summary' => 'Sends card SMS messages in batches.',
'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' => 'The code of the card SMS template. On the **Card SMS** [Template Management](https://dysms.console.aliyun.com/domestic/card) page in the console, select the code of a card SMS template that has been **approved**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CARD_SMS_3**5', 'title' => ''],
],
[
'name' => 'SmsTemplateCode',
'in' => 'query',
'schema' => ['description' => 'The code of the text SMS template used for fallback. This parameter is required when **FallbackType** is set to **SMS** (fallback to text SMS).'."\n"
."\n"
.'You can call the [QuerySmsTemplateList](~~419288~~) operation to query the templates that have been submitted under the current account, or you can view the list of templates in the [Short Message Service console](https://dysms.console.aliyun.com/domestic/text/template).'."\n"
.'>The template must be added and approved.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'SMS_23425****', 'title' => ''],
],
[
'name' => 'FallbackType',
'in' => 'query',
'schema' => ['description' => 'The fallback type. Valid values:'."\n"
.'- **SMS**: Phone numbers that do not support card SMS messages fall back to text SMS messages.'."\n"
.'- **DIGITALSMS**: Phone numbers that do not support card SMS messages fall back to digital SMS messages.'."\n"
.'- **NONE**: No fallback is required.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SMS', 'title' => ''],
],
[
'name' => 'DigitalTemplateCode',
'in' => 'query',
'schema' => ['description' => 'The code of the digital SMS template used for fallback. This parameter is required when **FallbackType** is set to **DIGITALSMS** (fallback to digital SMS).'."\n"
."\n"
.'You can view the list of digital SMS templates on the **Domestic Digital SMS** [Template Management](https://dysms.console.aliyun.com/domestic/digit) page in the console.'."\n"
.'>The template must be added and approved.', 'type' => 'string', 'required' => false, 'example' => 'DIGITAL_SMS_23408****', 'title' => ''],
],
[
'name' => 'OutId',
'in' => 'query',
'schema' => ['description' => 'The ID reserved for the caller.', 'type' => 'string', 'required' => false, 'example' => '16545681783595370', 'title' => ''],
],
[
'name' => 'PhoneNumberJson',
'in' => 'query',
'schema' => ['description' => 'The mobile phone numbers that receive the SMS messages.', 'type' => 'string', 'required' => true, 'example' => '["1390000****","1370000****"]', 'title' => ''],
],
[
'name' => 'SignNameJson',
'in' => 'query',
'schema' => ['description' => 'The name of the SMS signature.'."\n"
.'You can call the [QuerySmsSignList](~~419282~~) operation to query the signatures that have been submitted under the current account, or you can view the list of signatures in the [Short Message Service console](https://dysms.console.aliyun.com/domestic/text/sign).'."\n"
.'>The signature must be added and approved. The number of SMS signatures must be the same as the number of phone numbers, and the signatures must be in one-to-one correspondence with the phone numbers.', 'type' => 'string', 'required' => true, 'example' => '["阿里云","阿里巴巴"]', 'title' => ''],
],
[
'name' => 'CardTemplateParamJson',
'in' => 'query',
'schema' => ['description' => 'The actual values of the variables in the card SMS template. This parameter is required when the card SMS template specified by **CardTemplateCode** contains variables.'."\n"
."\n"
.'>If the JSON contains line breaks, handle them based on the standard JSON protocol.', 'type' => 'string', 'required' => false, 'example' => '[{"customurl":"http://www.alibaba.com","dyncParams":"{"a":"hello","b":"world"}"}]', 'title' => ''],
],
[
'name' => 'SmsTemplateParamJson',
'in' => 'query',
'schema' => ['description' => 'The actual values of the variables in the text SMS template. This parameter is required when the fallback text SMS template specified by **SmsTemplateCode** contains variables.'."\n"
."\n"
.'>If the JSON contains line breaks, handle them based on the standard JSON protocol.', 'type' => 'string', 'required' => false, 'example' => '[{"a":1,"b":2},{"a":9,"b":8}]', 'title' => ''],
],
[
'name' => 'DigitalTemplateParamJson',
'in' => 'query',
'schema' => ['description' => 'The actual values of the variables in the digital SMS template. This parameter is required when the fallback digital SMS template specified by **DigitalTemplateCode** contains variables.'."\n"
.'>If the JSON contains line breaks, handle them based on the standard JSON protocol.', 'type' => 'string', 'required' => false, 'example' => '[{"a":1,"b":2},{"a":9,"b":8}]', 'title' => ''],
],
[
'name' => 'SmsUpExtendCodeJson',
'in' => 'query',
'schema' => ['description' => 'The extension code of the MO (mobile-originated) SMS message.', 'type' => 'string', 'required' => false, 'example' => '[\\"6\\",\\"6\\"]', 'title' => ''],
],
[
'name' => 'TemplateCode',
'in' => 'query',
'schema' => ['description' => 'The code of the custom send content template.'."\n"
."\n"
.'The custom content is sent to the terminal in the form of the selected text SMS template plus the card parsing link. You can log on to the [Short Message Service console](https://dysms.console.aliyun.com/overview), choose **Domestic Messages** or **International/Hong Kong, Macao, and Taiwan Messages**, and then view the **Template Code** on the **Template Management** page.'."\n"
."\n"
.'> - The template must be added and approved. To send international or Hong Kong, Macao, and Taiwan messages, use an international or Hong Kong, Macao, and Taiwan SMS template.'."\n"
.'> - For example, the selected text SMS template content is: You have a message to check; the card parsing link is: `1*.cn/2**d`. The final delivered content is: `You have a message to check 1*.cn/2**d`. Perform testing and control the number of characters before sending.', 'type' => 'string', 'required' => false, 'example' => 'SMS_20375****', 'title' => ''],
],
[
'name' => 'TemplateParamJson',
'in' => 'query',
'schema' => ['description' => 'The actual values of the variables in the custom send content template. This parameter is required when the SMS template specified by **TemplateCode** contains variables.'."\n"
."\n"
.'> - If the JSON contains line breaks, handle them based on the standard JSON protocol.'."\n"
.'> - The number of template variable values must be the same as the number of phone numbers and signatures, and they must be in one-to-one correspondence. This indicates that an SMS message with the corresponding signature is sent to the specified phone number, and the variable parameters in the SMS template are replaced with the corresponding values.', 'type' => 'string', 'required' => false, 'example' => '[{"name":"TemplateParamJson"},{"name":"TemplateParamJson"}]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The request status code.'."\n"
.'* If **OK** is returned, the request is successful.'."\n"
.'* For information about other error codes, see [API error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n"
."\n"
.'- **true**: The call is successful.'."\n"
."\n"
.'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The returned data.'."\n",
'type' => 'object',
'properties' => [
'MediaMobiles' => ['description' => 'The mobile phone numbers that receive the card SMS messages.', 'type' => 'string', 'example' => '1390000****', 'title' => ''],
'BizCardId' => ['description' => 'The ID of the card SMS sending task.', 'type' => 'string', 'example' => '123', 'title' => ''],
'BizDigitalId' => ['description' => 'The ID of the digital SMS sending task.', 'type' => 'string', 'example' => '3214', 'title' => ''],
'CardTmpState' => ['description' => 'The review status of the card SMS template. Valid values:'."\n"
.'- **0**: Under review.'."\n"
.'- **1**: Approved.'."\n"
.'- **2**: Rejected.'."\n"
.'> For SMS messages that are rejected, you can configure the fallback process by using the **FallbackType** parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'NotMediaMobiles' => ['description' => 'The fallback phone numbers.', 'type' => 'string', 'example' => '1390000****', 'title' => ''],
'BizSmsId' => ['description' => 'The ID of the text SMS sending task.', 'type' => 'string', 'example' => '3256', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
200 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => 'No access, please contact 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' => 'Sends card SMS messages in batches',
'description' => '- Sending card SMS messages is a billable operation. You are not charged if a card SMS message fails to be sent or rendered. For more information, see [Multimedia SMS pricing](~~437951~~).'."\n"
.'- The card SMS feature is currently in the internal invitation phase. Contact your Alibaba Cloud business manager to apply for activation, or contact [Alibaba Cloud pre-sales consulting](https://help.aliyun.com/document_detail/464625.html?spm=a2c4g.11186623.0.0.213219fcSn2Ykj#section-81n-72q-ybm).'."\n"
.'- We recommend that you set the timeout period for card SMS messages to a value greater than or equal to 3 seconds. If a timeout failure occurs, we recommend that you check the delivery status before deciding whether to retry. We also recommend that you do not enable SDK retry logic when calling this operation; otherwise, multiple sending attempts may occur. For more information about timeout and retry settings, see [Timeout mechanism](~~262079~~) and [Retry mechanism](~~262080~~).'."\n"
.'- Domestic SMS, international SMS, and multimedia SMS do not currently support idempotency. Implement idempotency control to prevent duplicate operations caused by multiple retries.'."\n"
.'- Before you send a card SMS message, you must add and obtain approval for a card SMS template. When this operation is called to send an SMS message, the system checks whether the phone number supports card SMS messages. If the phone number does not support card SMS messages, you can configure whether to accept fallback to digital SMS or text SMS in the operation to improve the delivery rate.'."\n"
.'- When you send card SMS messages in batches, each phone number can use a different signature and a different fallback. In a single request, you can send card SMS messages to a maximum of 100 phone numbers.'."\n"
."\n"
.'### QPS limit'."\n"
.'The QPS limit per user for this operation is 1,000 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation in a reasonable manner.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendBatchCardSms'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:SendBatchCardSms',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'SendBatchSms' => [
'summary' => 'This operation sends messages to different phone numbers using a single template, with different signatures and template variables for each recipient.',
'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' => 'The recipient phone numbers. Format:'."\n"
."\n"
.'- For domestic SMS: Phone numbers with or without a country code such as `+`, `+86`, `0086`, or `86`. Example: `1590000****`.'."\n"
."\n"
.'- For international SMS: The country code followed by the phone number. Example: `852000012****`.'."\n"
."\n"
.'> For time-sensitive messages like verification codes, use the [SendSms](~~419273~~) operation to send messages individually.', 'type' => 'string', 'required' => true, 'example' => '["1590000****","1350000****"]', 'title' => ''],
],
[
'name' => 'SignNameJson',
'in' => 'formData',
'schema' => ['description' => 'The signature names. The number of signatures must match the number of phone numbers.'."\n"
."\n"
.'You can call the [QuerySmsSignList](~~419282~~) operation or check the [Short Message Service console](https://dysms.console.aliyun.com/domestic/text/sign) to find approved signatures. You must use an approved signature.'."\n"
."\n"
.'> - The system uses the selected signature to send SMS messages.', 'type' => 'string', 'required' => true, 'example' => '["阿里云","阿里巴巴"]', 'title' => ''],
],
[
'name' => 'TemplateCode',
'in' => 'query',
'schema' => ['description' => 'The message template code. You cannot use templates for domestic SMS and international SMS interchangeably.'."\n"
."\n"
.'You can call the [QuerySmsTemplateList](~~419288~~) operation or check the [Short Message Service console](https://dysms.console.aliyun.com/domestic/text/template) to find approved template codes. You must use an approved template code.', 'type' => 'string', 'required' => true, 'example' => 'SMS_15255****', 'title' => ''],
],
[
'name' => 'TemplateParamJson',
'in' => 'formData',
'schema' => ['description' => 'The actual values for the template variables. This parameter is required if the template contains variables.'."\n"
."\n"
.'> - The number of template variable sets must match the number of phone numbers and signatures. The elements in the PhoneNumberJson, SignNameJson, and TemplateParamJson arrays must correspond by index to ensure each message is sent with the correct signature and variable values.'."\n"
.'>'."\n"
.'> - If you need to include a line break in the JSON string, follow the standard JSON format.', 'type' => 'string', 'required' => false, 'example' => '[{"name":"TemplateParamJson"},{"name":"TemplateParamJson"}]', 'title' => ''],
],
[
'name' => 'SmsUpExtendCodeJson',
'in' => 'formData',
'schema' => ['description' => 'A JSON array of MO SMS extension codes.'."\n"
."\n"
.'> You can leave this parameter empty if you have no special requirements.', 'type' => 'string', 'required' => false, 'example' => '["90999","90998"]', 'title' => ''],
],
[
'name' => 'OutId',
'in' => 'query',
'schema' => ['description' => 'An external business ID. It must be a string of fewer than 256 characters.'."\n"
."\n"
.'> You can leave this parameter empty if you have no special requirements.', 'type' => 'string', 'required' => false, 'example' => 'abcdefg', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The request status code.'."\n"
."\n"
.'- A value of `OK` indicates a successful request.'."\n"
."\n"
.'- For a list of other error codes, see [Error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The description of the request status.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'BizId' => ['description' => 'The delivery receipt ID.'."\n"
."\n"
.'- You can use this ID to query the delivery status by calling the [QuerySendDetails](~~102352~~) operation.'."\n"
."\n"
.'- Log on to the [Short Message Service console](https://dysms.console.aliyun.com/dysms.htm#/overview) and go to **Statistics** > **Delivery Logs** to view delivery details.', 'type' => 'string', 'example' => '9006197469364984400', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D230E', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'SendBatchSms',
'description' => '### Basic information'."\n"
."\n"
.'- You can send messages to a maximum of 100 phone numbers in a single call.'."\n"
."\n"
.'- The global [endpoint](~~419270~~) is `dysmsapi.aliyuncs.com`. For a list of region-specific endpoints, see [Endpoints](~~419270~~).'."\n"
."\n"
.'### API calls'."\n"
."\n"
.'- We recommend calling this operation using an SDK. For more information, see [Make your first API call](~~2841024~~).'."\n"
."\n"
.'- To send messages from the console, see [Send group messages](~~108266~~).'."\n"
."\n"
.'- To build your own API requests, see [V3 request body and signature mechanism](~~2593177~~).'."\n"
."\n"
.'### Usage notes'."\n"
."\n"
.'- For domestic SMS, we recommend setting the timeout period to 1 second or longer. If a timeout occurs, check the delivery receipt status before you retry the request. For more information about timeout and retry settings, see [timeout mechanism](~~262079~~) and [retry mechanism](~~262080~~).'."\n"
."\n"
.'- This operation does not support idempotence for domestic SMS, international SMS, or Multimedia Messaging Service (MMS) messages. You must implement your own idempotence controls to prevent duplicate operations caused by multiple retries.'."\n"
."\n"
.'- This is a billable operation. For domestic SMS, you are charged based on the delivery receipt status from the carrier. You are not charged for messages that are successfully submitted but fail carrier delivery. For more information, see [Billing overview](~~44340~~).'."\n"
."\n\n"
.' ><warning>'."\n"
."\n"
.' Batch message delivery may be delayed due to system capacity limits. For time-sensitive messages, such as verification codes or alert notifications, use the SendSms operation to send messages individually.'."\n"
."\n"
.' ></warning>'."\n"
."\n"
.'### QPS limit'."\n"
."\n"
.'The Queries Per Second (QPS) limit for a single user is 5,000. Calls that exceed this limit are throttled. Plan your usage accordingly.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendBatchSms'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:SendBatchSms',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'SendCardSms' => [
'summary' => 'Sends a card message.',
'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' => 'The card message objects.',
'type' => 'array',
'items' => [
'description' => '卡片短信对象。',
'type' => 'object',
'properties' => [
'customUrl' => ['description' => '渲染失败后跳转链接。', 'type' => 'string', 'required' => false, 'example' => 'https://alibaba.com', 'title' => ''],
'dyncParams' => ['description' => '动态参数。动参变量不需要${}', 'type' => 'string', 'required' => false, 'example' => '{"param3":"李四3","param1":"李四","param2":"李四2"}', 'title' => ''],
'mobile' => ['description' => '接收卡片短信的手机号码。', 'type' => 'string', 'required' => false, 'example' => '1390000****', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => true,
'docRequired' => true,
'example' => 'SendCardSms',
'title' => '',
],
],
[
'name' => 'SignName',
'in' => 'query',
'schema' => ['description' => 'The signature name. You can call the [QuerySmsSignList](~~419282~~) operation to query the signatures applied for under the current account or view the signature list in the [Short Message Service (SMS) console](https://dysms.console.aliyun.com/domestic/text/sign).'."\n"
.'> The signature must be approved.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '阿里云', 'title' => ''],
],
[
'name' => 'CardTemplateCode',
'in' => 'query',
'schema' => ['description' => 'The code of the card message template. On the [Template Management](https://dysms.console.aliyun.com/domestic/card) page of the **Card Messages** module in the console, select the code of an approved card message template.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CARD_SMS_70', 'title' => ''],
],
[
'name' => 'SmsTemplateCode',
'in' => 'query',
'schema' => ['description' => 'The code of the fallback text message template. This parameter is required if you set **FallbackType** to **SMS**.'."\n"
."\n"
.'You can call the [QuerySmsTemplateList](~~419288~~) operation to query the templates applied for under the current account or view the template list in the [SMS console](https://dysms.console.aliyun.com/domestic/text/template).'."\n"
.'> The template must be added and approved.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'SMS_48068****', 'title' => ''],
],
[
'name' => 'SmsUpExtendCode',
'in' => 'query',
'schema' => ['description' => 'The extension code of the MO message. An MO message is a message sent to the communications service provider to customize a service, perform a query, or handle other business. The message is charged at the standard rate of the carrier.'."\n"
.'> If you do not have such requirements, ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'FallbackType',
'in' => 'query',
'schema' => ['description' => 'The fallback type. Valid values:'."\n"
.'- **SMS**: Falls back to a text message for phone numbers that do not support card messages.'."\n"
.'- **DIGITALSMS**: Falls back to a digital message for phone numbers that do not support card messages.'."\n"
.'- **NONE**: No fallback is required.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SMS', 'title' => ''],
],
[
'name' => 'DigitalTemplateCode',
'in' => 'query',
'schema' => ['description' => 'The code of the fallback digital message template. This parameter is required if you set **FallbackType** to **DIGITALSMS**.'."\n"
."\n"
.'You can view the digital message template list on the [Template Management](https://dysms.console.aliyun.com/domestic/digit) page of the **Digital Messages** module in the console.'."\n"
."\n"
.'> The template must be added and approved.', 'type' => 'string', 'required' => false, 'example' => 'DIGITAL_SMS_31359****', 'title' => ''],
],
[
'name' => 'OutId',
'in' => 'query',
'schema' => ['description' => 'The ID reserved for the caller.', 'type' => 'string', 'required' => false, 'example' => '38d76c9b-4a9a-4c89-afae-61fd8e0e****', 'title' => ''],
],
[
'name' => 'SmsTemplateParam',
'in' => 'query',
'schema' => ['description' => 'The actual values of the variables in the fallback text message template. This parameter is required if the text message template specified by **SmsTemplateCode** contains variables.'."\n"
."\n"
.'> If the JSON value contains line breaks, follow the standard JSON protocol.', 'type' => 'string', 'required' => false, 'example' => '{"jifen":"积分"}', 'title' => ''],
],
[
'name' => 'DigitalTemplateParam',
'in' => 'query',
'schema' => ['description' => 'The actual values of the variables in the fallback digital message template. This parameter is required if the digital message template specified by **DigitalTemplateCode** contains variables.'."\n"
."\n"
.'> If the JSON value contains line breaks, follow the standard JSON protocol.', 'type' => 'string', 'required' => false, 'example' => '{"msg","xxxd"}', 'title' => ''],
],
[
'name' => 'TemplateCode',
'in' => 'query',
'schema' => ['description' => 'The code of the custom content template.'."\n"
."\n"
.'The custom content is sent to the recipient as a text message template combined with a card parsing link. Log on to the [SMS console](https://dysms.console.aliyun.com/overview), choose **Domestic Messages** or **International/HK/MO/TW Messages**, and view the **Template Code** on the **Template Management** tab.'."\n"
."\n"
.'> - The template code must be added and approved. To send international or Hong Kong, Macao, or Taiwan messages, use an international or Hong Kong, Macao, or Taiwan message template.'."\n"
.'> - For example, if the selected text message template is "You have a new message" and the card parsing link is `1*.cn/2**d`, the final content is `You have a new message 1*.cn/2**d`. Test the message and control the word count before sending.', 'type' => 'string', 'required' => false, 'example' => 'SMS_2322****', 'title' => ''],
],
[
'name' => 'TemplateParam',
'in' => 'query',
'schema' => ['description' => 'The actual values of the variables in the custom content template. This parameter is required if the message template specified by **TemplateCode** contains variables.'."\n"
."\n"
.'> If the JSON value contains line breaks, follow the standard JSON protocol.', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "code": "1111"'."\n"
.'}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Code' => ['description' => '请求状态码。'."\n"
.'* 返回OK代表请求成功。'."\n"
.'* 其他错误码,请参见[错误码列表](~~101346~~)。', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D28D0', 'title' => ''],
'Success' => ['description' => '调用接口是否成功。取值:'."\n"
."\n"
.'- **true**:调用成功。'."\n"
."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => '返回数据。'."\n",
'type' => 'object',
'properties' => [
'MediaMobiles' => ['description' => '接收卡片短信的手机号。', 'type' => 'string', 'example' => '1390000****', 'title' => ''],
'BizCardId' => ['description' => '卡片短信发送ID。', 'type' => 'string', 'example' => '123', 'title' => ''],
'BizDigitalId' => ['description' => '数字短信发送ID。', 'type' => 'string', 'example' => '232', 'title' => ''],
'CardTmpState' => ['description' => '卡片短信模板审核状态。取值:'."\n"
.'- **0**:审核中。'."\n"
.'- **1**:审核通过。'."\n"
.'- **2**:审核不通过。'."\n"
.'> 审核不通过的短信可通过**FallbackType**字段设置回落流程。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'NotMediaMobiles' => ['description' => '回落的手机号。', 'type' => 'string', 'example' => '1390000****', 'title' => ''],
'BizSmsId' => ['description' => '文本短信发送ID。', 'type' => 'string', 'example' => '524', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
200 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => 'No access, please contact 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' => 'Send card message',
'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调用会被限流,这可能会影响您的业务,请合理调用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendCardSms'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:SendCardSms',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'SendSms' => [
'summary' => 'Sends an SMS message to one or more specified mobile numbers.',
'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' => 'The recipient\'s mobile number. The format varies based on the destination region:'."\n"
."\n"
.'- For messages to the Chinese mainland: A mobile number, with or without a country code. Valid prefixes are +, +86, 0086, and 86. Example: 1390000\\*\\*\\*\\*.'."\n"
."\n"
.'- For international messages or messages to Hong Kong, Macao, or Taiwan: Use the format \\[Country code]\\[Mobile number]. Example: 852000012\\*\\*\\*\\*.'."\n"
."\n"
.'- To send a test message, bind a test mobile number in the [console](https://dysms.console.aliyun.com/quickstart).'."\n"
."\n"
.'> To send a message to multiple numbers, separate them with commas (,). You can specify up to 1,000 mobile numbers per request. Bulk sending may have higher latency than sending single messages. For time-sensitive messages such as verification codes, we recommend sending them individually.', 'type' => 'string', 'required' => true, 'example' => '1390000****', 'title' => ''],
],
[
'name' => 'SignName',
'in' => 'query',
'schema' => ['description' => 'The signature name.'."\n"
."\n"
.'Call the [QuerySmsSignList](~~419282~~) API or view your list of signatures in the [Short Message Service console](https://dysms.console.aliyun.com/domestic/text/sign). You must use a signature that has been **approved**.'."\n"
."\n"
.'> - 1\\. If a verification code signature and a general-purpose signature share the same name, the general-purpose signature is used by default.'."\n"
.'>'."\n"
.'> - 2\\. The system uses the specified signature to send the message.', 'type' => 'string', 'required' => true, 'example' => '阿里云', 'title' => ''],
],
[
'name' => 'TemplateCode',
'in' => 'query',
'schema' => ['description' => 'The code of the template.'."\n"
."\n"
.'Call the [QuerySmsTemplateList](~~419288~~) API or view your list of templates in the [Short Message Service console](https://dysms.console.aliyun.com/domestic/text/template). You must use the code of a template that has been **approved**.', 'type' => 'string', 'required' => true, 'example' => 'SMS_15305****', 'title' => ''],
],
[
'name' => 'TemplateParam',
'in' => 'query',
'schema' => ['description' => 'The values for the template variables, specified as a **JSON string**. This parameter is required if the template contains variables. The JSON string must provide a value for each variable.'."\n"
."\n"
.'> - If the JSON string needs to include line breaks, format it according to standard JSON specifications.'."\n"
.'>'."\n"
.'> - For more information about template variable formatting, see [SMS template specifications](~~463161~~).', 'type' => 'string', 'required' => false, 'example' => '{"name":"张三","number":"1390000****"}', 'title' => ''],
],
[
'name' => 'SmsUpExtendCode',
'in' => 'query',
'schema' => ['description' => 'The upstream SMS extension code. An upstream SMS message is a message sent from a user to a service provider to subscribe to a service, make a query, or perform other tasks. Such messages are charged by the carrier at standard rates.'."\n"
."\n"
.'> The system assigns a default extension code when a signature is created. Use this parameter to specify a different code. You can ignore this parameter if you do not have special requirements.', 'type' => 'string', 'required' => false, 'example' => '90999', 'title' => ''],
],
[
'name' => 'OutId',
'in' => 'query',
'schema' => ['description' => 'The external transaction ID.'."\n"
."\n"
.'> You can ignore this parameter if you do not have special requirements.', 'type' => 'string', 'required' => false, 'example' => 'abcdefgh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The request status code.'."\n"
."\n"
.'- A value of `OK` indicates that the request was successful.'."\n"
."\n"
.'- For other error codes, see [API error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'BizId' => ['description' => 'The delivery receipt ID.'."\n"
."\n"
.'Use this ID to query the delivery status by calling the [QuerySendDetails](~~QuerySendDetails~~) API.', 'type' => 'string', 'example' => '9006197469364984****', 'title' => ''],
'RequestId' => ['description' => 'The Request ID.', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"BizId\\": \\"9006197469364984****\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","type":"json"}]',
'title' => 'SendSms',
'description' => 'Use this API to send an SMS message to a single mobile number. This API also supports sending messages with the same signature and template variables to multiple mobile numbers, up to 1,000 per request. Note that bulk sending may experience some latency. If you need to send messages with different signatures or template variables to multiple recipients, use the [SendBatchSms](~~419274~~) API, which supports up to 100 mobile numbers per request.'."\n"
."\n"
.'### Usage notes'."\n"
."\n"
.'- For SMS messages sent to the Chinese mainland, we recommend setting the timeout period to 1 second or longer. If a timeout occurs, check the delivery receipt status before retrying the request. For more information about timeout and retry settings, see [Timeout mechanism](~~262079~~) and [Retry mechanism](~~262080~~).'."\n"
."\n"
.'- This API does not support idempotence for domestic, international, or multimedia SMS messages. You must implement your own idempotence controls to prevent sending duplicate messages during retries.'."\n"
."\n"
.'- This is a billable API. For messages sent to the Chinese mainland, billing is based on the delivery receipt status from the carrier. You are not charged if the API call is successful but the carrier fails to deliver the message. For more information, see [Billing](~~44340~~).'."\n"
."\n"
.'### QPS limit'."\n"
."\n"
.'This API has a queries per second (QPS) limit of 5,000 for each user. The system throttles calls that exceed this limit. To avoid throttling, use this API within the specified limit.',
'requestParamsDescription' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendSms'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:SendSms',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'SmsConversionIntl' => [
'summary' => 'Feeds back the SMS delivery status corresponding to each message ID (MessageId) to the Alibaba Cloud International SMS platform.',
'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' => 'Message ID.', 'type' => 'string', 'required' => true, 'example' => '1008030300****'."\n", 'title' => ''],
],
[
'name' => 'Delivered',
'in' => 'query',
'schema' => ['description' => 'Set to true if your user replied to the message you sent. Otherwise, set to false.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''],
],
[
'name' => 'ConversionTime',
'in' => 'query',
'schema' => ['description' => 'The timestamp at which the message reached the recipient. Must be a Unix timestamp, expressed as a long integer in milliseconds.'."\n"
."\n"
.'- If this field is not specified: defaults to the current timestamp.'."\n"
."\n"
.'- If this field is specified: the timestamp must be greater than the send time and less than the current timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1349055900000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters returned by the API.',
'type' => 'object',
'properties' => [
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D****'."\n", 'title' => ''],
'Code' => ['description' => 'The status code. A return value of OK indicates that the request was successful. For other error codes, see [Error Code List](https://help.aliyun.com/document_detail/101346.html?spm=a2c4g.101345.0.0.74326ff2J5EZyt).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D****\\\\n\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
'title' => 'Domestic-to-International SMS Conversion Feedback',
'description' => 'Metric definitions:'."\n"
."\n"
.'- OTP send volume: the number of verification codes sent.'."\n"
."\n"
.'- OTP conversion volume: the number of verification codes converted (the number of times a user successfully obtained a verification code and reported it back).'."\n"
."\n"
.'Conversion rate = OTP conversion volume / OTP send volume.'."\n"
."\n"
.'> The conversion rate feedback feature has a certain level of intrusiveness on the business system. To prevent jitter in conversion rate API calls from affecting business logic, please consider the following: - Call the API in asynchronous mode (for example, using a queue or event-driven approach). - Add a degradable solution to protect business logic (for example, manual degradation, or automatic degradation using a circuit breaker).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SmsConversionIntl'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:SmsConversionIntl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'SubmitSmsQualification' => [
'summary' => 'Submits an SMS qualification application. As required by the Ministry of Industry and Information Technology (MIIT) and carriers for real-name SMS sending, domestic SMS services require qualification credential information of the signature owner. Apply for an SMS qualification first, and then apply for signatures and templates.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '264876',
'abilityTreeNodes' => ['FEATUREdysmsJ2BZAJ'],
],
'parameters' => [
[
'name' => 'QualificationName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The qualification name, used to manage and distinguish multiple qualifications you apply for. It does not appear in SMS content. The name must be unique among your existing qualifications. Only Chinese characters, English letters, or combinations with digits are supported. Symbols or pure digits are not supported. Maximum length: 100 characters.', 'type' => 'string', 'required' => true, 'example' => '阿里云云通信有限公司资质李华'],
],
[
'name' => 'UseBySelf',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The purpose of the qualification application. Valid values:'."\n"
."\n"
.'- **true**: **Self-use**. The entity that owns the signature is the same as the entity verified for this account.'."\n"
.'- **false**: **Third-party use**. The entity that owns the signature is different from the entity verified for this account.', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
],
[
'name' => 'CompanyType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The enterprise type. Valid values:'."\n"
."\n"
.'- COMPANY: enterprise.'."\n"
."\n"
.'- NON_PROFIT_ORGANIZATION: government agency or public institution.', 'type' => 'string', 'required' => true, 'example' => 'COMPANY'],
],
[
'name' => 'BusinessLicensePics',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'The business license information. This parameter is required when the qualification purpose `UseBySelf` is set to `false` (third-party use).'."\n"
.'> - Based on carrier real-name registration regulatory requirements, we strongly recommend that you provide the relevant field information. Otherwise, the probability of "review rejection or carrier registration failure" increases significantly.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['title' => '', 'description' => 'The business license type. Valid values:'."\n"
."\n"
.'- socialCreditLicense: unified social credit code certificate.'."\n"
.'- businessLicense: business license.'."\n"
.'- signLegalLicense: public institution legal person certificate.'."\n"
.'- otherLicense: other.'."\n"
."\n"
.'Upload one type. The certificate must contain the enterprise name, unified social credit code, and certificate validity period.', 'type' => 'string', 'required' => false, 'example' => 'businessLicense'],
'LicensePic' => ['title' => '', 'description' => 'The business license image. Only jpg, png, gif, and jpeg formats are supported. The image must not exceed 5 MB. Specify the file path uploaded to OSS. The file name must not contain Chinese characters or special characters. For upload instructions, see [Upload files through OSS](~~2833114~~).'."\n"
."\n\n"
.'><notice>'."\n"
."\n"
.'Color originals do not require a stamp. If you upload a photocopy or black-and-white photo, stamp the photocopy with the company seal and take a photo to upload.'."\n"
.'></notice>.', 'type' => 'string', 'required' => false, 'example' => '123456/111.png'],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
],
[
'name' => 'CompanyName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The enterprise name. Only the middle dot `·`, Chinese brackets `【】()`, English parentheses `()`, and `spaces` are supported as symbols. Other symbols or pure digits are not allowed. Maximum length: 150 characters.', 'type' => 'string', 'required' => true, 'example' => '阿里云云通信有限公司'],
],
[
'name' => 'OrganizationCode',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The unified social credit code. Maximum length: 150 characters.', 'type' => 'string', 'required' => true, 'example' => '910X********0012'],
],
[
'name' => 'BussinessLicenseExpDate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The business license validity period. Format: YYYY-MM-DD~YYYY-MM-DD.'."\n"
.'> If the certificate has a long-term validity period, set the end date to 2099-12-31.', 'type' => 'string', 'required' => true, 'example' => '2023-01-01~2033-01-01'],
],
[
'name' => 'LegalPersonIdCardFrontSide',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The front photo of the legal representative\'s ID card (national emblem side). Only jpg, png, gif, and jpeg formats are supported. The image must not exceed 5 MB. Specify the file path uploaded to OSS. The file name must not contain Chinese characters or special characters. For upload instructions, see [Upload files through OSS](~~2833114~~).'."\n"
."\n\n"
.'> The system verifies the legal representative\'s name and ID number you provide. If verification fails, you must upload photos of the legal representative\'s ID card.', 'type' => 'string', 'required' => false, 'example' => '123456/111.png'],
],
[
'name' => 'LegalPersonIdCardBackSide',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The back photo of the legal representative\'s ID card (portrait side). Only jpg, png, gif, and jpeg formats are supported. The image must not exceed 5 MB. Specify the file path uploaded to OSS. The file name must not contain Chinese characters or special characters. For upload instructions, see [Upload files through OSS](~~2833114~~).'."\n"
."\n"
.'> The system verifies the legal representative\'s name and ID number you provide. If verification fails, you must upload photos of the legal representative\'s ID card.', 'type' => 'string', 'required' => false, 'example' => '123456/111.png'],
],
[
'name' => 'LegalPersonName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The legal representative\'s name. Maximum length: 50 characters.'."\n"
."\n"
.'> - If the organization certificate does not contain legal representative information but includes a person in charge or chief representative, prepare the ID card photos of the corresponding person in charge or chief representative listed on the certificate.'."\n"
.'> - If the organization certificate contains neither legal representative information nor any person in charge, prepare the name and ID card photos of the primary business contact.', 'type' => 'string', 'required' => true, 'example' => '李华'],
],
[
'name' => 'LegalPersonIDCardNo',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The legal representative\'s ID card number.', 'type' => 'string', 'required' => true, 'example' => '511391********5123'],
],
[
'name' => 'LegalPersonIdCardEffTime',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The legal representative\'s ID card validity period. Format: YYYY-MM-DD~YYYY-MM-DD.'."\n"
.'> If the ID card has a long-term validity period, set the end date to 2099-12-31.', 'type' => 'string', 'required' => true, 'example' => '2023-01-01~2033-01-01'],
],
[
'name' => 'LegalPersonIDCardType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The legal representative\'s ID card type. Valid values:'."\n"
."\n"
.'- identityCard: ID card.'."\n"
.'- passport: passport.'."\n"
.'- homeReturnPermit: Hong Kong/Macao resident travel permit to mainland.'."\n"
.'- TaiwanCompatriotPermit: Taiwan resident travel permit to mainland.'."\n"
.'- residencePermit: Hong Kong/Macao/Taiwan resident residence permit.'."\n"
.'- other: other.', 'type' => 'string', 'required' => true, 'example' => 'identityCard'],
],
[
'name' => 'AdminIDCardPic',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The back photo of the administrator\'s ID card (portrait side). Only jpg, png, gif, and jpeg formats are supported. The image must not exceed 5 MB. Specify the file path uploaded to OSS. The file name must not contain Chinese characters or special characters. For upload instructions, see [Upload files through OSS](~~2833114~~).'."\n"
."\n"
.'><notice>'."\n"
.'Color originals do not require a stamp. If you upload a photocopy or black-and-white photo, stamp the photocopy with the company seal and take a photo to upload.'."\n"
."\n"
.'></notice>.', 'type' => 'string', 'required' => true, 'example' => '123456/111.png'],
],
[
'name' => 'AdminIDCardFrontFace',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The front photo of the administrator\'s ID card (national emblem side). Only jpg, png, gif, and jpeg formats are supported. The image must not exceed 5 MB. Specify the file path uploaded to OSS. The file name must not contain Chinese characters or special characters. For upload instructions, see [Upload files through OSS](~~2833114~~).'."\n"
."\n"
.'><notice>'."\n"
.'Color originals do not require a stamp. If you upload a photocopy or black-and-white photo, stamp the photocopy with the company seal and take a photo to upload.'."\n"
."\n"
.'></notice>.', 'type' => 'string', 'required' => true, 'example' => '123456/111.png'],
],
[
'name' => 'AdminName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The administrator\'s name. Maximum length: 50 characters. **Under the current [SMS signature real-name requirements](~~2873145~~), if the same administrator applies for qualifications for multiple different enterprises, carrier registration will fail. Ensure one administrator per enterprise to improve the registration success rate.**'."\n"
."\n"
.'> The administrator (also called the handler) is the person who logs on to the Alibaba Cloud account and manages SMS services. This person typically manages qualifications, signatures, and templates under this Alibaba Cloud account and performs SMS sending operations. This person\'s phone number must be able to receive verification codes. The administrator does not have to be the Alibaba Cloud account administrator and can be the same person as the legal representative.', 'type' => 'string', 'required' => true, 'example' => '李华'],
],
[
'name' => 'AdminIDCardNo',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The administrator\'s ID card number.', 'type' => 'string', 'required' => true, 'example' => '511391********5123'],
],
[
'name' => 'AdminIDCardType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The administrator\'s ID card type. Valid values:'."\n"
."\n"
.'- identityCard: ID card.'."\n"
.'- passport: passport.'."\n"
.'- homeReturnPermit: Hong Kong/Macao resident travel permit to mainland.'."\n"
.'- TaiwanCompatriotPermit: Taiwan resident travel permit to mainland.'."\n"
.'- residencePermit: Hong Kong/Macao/Taiwan resident residence permit.'."\n"
.'- other: other.', 'type' => 'string', 'required' => true, 'example' => 'identityCard'],
],
[
'name' => 'AdminIDCardExpDate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The administrator\'s ID card validity period. Format: YYYY-MM-DD~YYYY-MM-DD.'."\n"
.'> If the ID card has a long-term validity period, set the end date to 2099-12-31.', 'type' => 'string', 'required' => true, 'example' => '2023-01-01~2033-01-01'],
],
[
'name' => 'AdminPhoneNo',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The administrator\'s phone number. Format: +/+86/0086/86 or a phone number without any prefix, such as 1390000****.', 'type' => 'string', 'required' => true, 'example' => '137****1234'],
],
[
'name' => 'CertifyCode',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The phone verification code. Call the [RequiredPhoneCode](~~RequiredPhoneCode~~) operation with the **administrator\'s phone number**, and then enter the SMS verification code received.'."\n"
."\n"
.'> You can use [ValidPhoneCode](~~ValidPhoneCode~~) to verify whether the SMS verification code is correct before passing it in.', 'type' => 'string', 'required' => true, 'example' => '1234'],
],
[
'name' => 'OtherFiles',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'Additional materials. If you have other supporting documents, notes, or photos, upload them here.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LicensePic' => ['description' => 'The additional material file. Only png, jpg, jpeg, doc, docx, and pdf formats are supported. The file must not exceed 5 MB. Specify the file path uploaded to OSS. The file name must not contain Chinese characters or special characters. For upload instructions, see [Upload files through OSS](~~2833114~~).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '123456/111.png'],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
],
[
'name' => 'WhetherShare',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'Qualification authorization. Specifies whether to share the qualification with other cloud communication products (such as domestic voice services and domestic number privacy protection). Sharing is available only when you apply for a **self-use qualification** and the qualification information **matches the enterprise information verified for the current Alibaba Cloud account**. Otherwise, this setting has no effect. Valid values:'."\n"
."\n"
.'- true: Agree. Your qualification information can be referenced during the qualification verification process of other cloud communication products, eliminating redundant verification.'."\n"
.'- false: Disagree.',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'boolean',
'required' => true,
'example' => 'false',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Remarks. If you have additional information to provide or notes for the qualification verification reviewer, add a description here.', 'type' => 'string', 'required' => false, 'example' => '无'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The access denial details. This field is returned only when RAM authentication fails.', 'type' => 'string', 'example' => '无', 'title' => ''],
'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud for this request. You can use it to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA'."\n"],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Data' => ['description' => 'The qualification ID.', 'type' => 'string', 'title' => '', 'example' => '1000****'],
'Code' => ['description' => 'The request status code.'."\n"
."\n"
.'* OK indicates a successful request.'."\n"
.'* For other error codes, see the error code list in this section or [API error codes](~~101346~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Success' => [
'description' => 'Indicates whether the API call was successful. Valid values:'."\n"
."\n"
.'- **true**: The call was successful.'."\n"
.'- **false**: The call failed.',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'AdminBackOssFileNotUploadError', 'errorMessage' => 'Administrator ID card portrait photo not uploaded.', 'description' => ''],
['errorCode' => 'AdminDateNotValid', 'errorMessage' => 'Current time is outside the administrator ID card validity period.', 'description' => ''],
['errorCode' => 'AdminIdcardExpdateNotMatchRegexError', 'errorMessage' => 'Invalid administrator ID card expiration time format.', 'description' => ''],
['errorCode' => 'AdminIdcardFrontFaceFileError', 'errorMessage' => 'Invalid format for administrator\'s ID card national emblem photo.', 'description' => ''],
['errorCode' => 'AdminIdcardFrontFaceNullError', 'errorMessage' => 'Administrator\'s ID card national emblem photo cannot be empty.', 'description' => ''],
['errorCode' => 'AdminIdcardNoNullError', 'errorMessage' => 'Administrator\'s ID number cannot be empty.', 'description' => ''],
['errorCode' => 'AdminIdcardNotMatchRegex', 'errorMessage' => 'Invalid administrator ID number format.', 'description' => ''],
['errorCode' => 'AdminIdcardPicsFileError', 'errorMessage' => 'Invalid format for administrator\'s ID card portrait photo.', 'description' => ''],
['errorCode' => 'AdminIdcardPicsNullError', 'errorMessage' => 'Administrator\'s ID card portrait photo cannot be empty.', 'description' => ''],
['errorCode' => 'AdminIdcardTypeError', 'errorMessage' => 'Invalid administrator ID card type.', 'description' => ''],
['errorCode' => 'AdminNameNullError', 'errorMessage' => 'Administrator\'s name cannot be empty.', 'description' => ''],
['errorCode' => 'BusinessLicenseDateNotMatchRegexError', 'errorMessage' => 'Invalid business license expiration time format.', 'description' => ''],
['errorCode' => 'BusinessLicenseDateNotValid', 'errorMessage' => 'Current time is outside the business license validity period.', 'description' => ''],
['errorCode' => 'BusinessLicenseOssFileNotUploadError', 'errorMessage' => 'Business license file not uploaded.', 'description' => ''],
['errorCode' => 'BusinessLicensePicsFileError', 'errorMessage' => 'Invalid business license file format.', 'description' => ''],
['errorCode' => 'BusinessLicensePicsNullError', 'errorMessage' => 'Business license documents cannot be empty.', 'description' => ''],
['errorCode' => 'BusinessLicenseTypeError', 'errorMessage' => 'Invalid business license type.', 'description' => ''],
['errorCode' => 'CertifyCodeError', 'errorMessage' => 'SMS verification code is incorrect.', 'description' => ''],
['errorCode' => 'CompanyNameNullError', 'errorMessage' => 'Company name cannot be empty.', 'description' => ''],
['errorCode' => 'CompanyTypeError', 'errorMessage' => 'Invalid company type.', 'description' => ''],
['errorCode' => 'QualificationNameNullError', 'errorMessage' => 'Qualification name cannot be empty.', 'description' => ''],
['errorCode' => 'QualificationNameNotMatchRegex', 'errorMessage' => 'Qualification names must be in Chinese, English, or alphanumeric combinations. Symbols or pure numbers are not supported.', 'description' => ''],
['errorCode' => 'QualificationNameAlreadyExist', 'errorMessage' => 'The qualification name already exists. Please modify and resubmit.', 'description' => ''],
['errorCode' => 'OtherFileTypeError', 'errorMessage' => 'Invalid file format for other documents.', 'description' => ''],
['errorCode' => 'LegalPersonIdcardTypeError', 'errorMessage' => 'Invalid legal person ID card type.', 'description' => ''],
['errorCode' => 'LegalIdCardNoNullError', 'errorMessage' => 'Legal person\'s ID number cannot be empty.', 'description' => ''],
['errorCode' => 'LegalIdCardNotMatchRegex', 'errorMessage' => 'Invalid legal person ID number format.', 'description' => ''],
['errorCode' => 'LegalPersonNameNullError', 'errorMessage' => 'Legal person\'s name cannot be empty.', 'description' => ''],
['errorCode' => 'OrganizationCodeNullError', 'errorMessage' => 'Unified Social Credit Code cannot be empty.', 'description' => ''],
['errorCode' => 'LegalPersonIdcardEfftimeNotMatchRegexError', 'errorMessage' => 'Invalid legal person ID card expiration time format.', 'description' => ''],
['errorCode' => 'LegalDateNotValid', 'errorMessage' => 'Current time is outside the legal person ID card validity period.', 'description' => ''],
['errorCode' => 'LegalFrontOssFileNotUploadError', 'errorMessage' => 'Legal person ID card national emblem photo not uploaded.', 'description' => ''],
['errorCode' => 'LegalBackOssFileNotUploadError', 'errorMessage' => 'Legal person ID card portrait photo not uploaded.', 'description' => ''],
['errorCode' => 'AdminFrontOssFileNotUploadError', 'errorMessage' => 'Administrator ID card national emblem photo not uploaded.', 'description' => ''],
['errorCode' => 'OtherOssFileNotUploadError', 'errorMessage' => 'Other files not uploaded.', 'description' => ''],
['errorCode' => 'GrayCustAccessError', 'errorMessage' => 'This customer is not authorized to use the OpenAPI. Please contact support for whitelisting.', 'description' => ''],
['errorCode' => 'CustNotExistError', 'errorMessage' => 'Customer\'s cloud communication information is invalid.', 'description' => ''],
['errorCode' => 'NotEnterpriseCertifyCustCheckError', 'errorMessage' => 'Non-enterprise certified customers are not allowed to access.', 'description' => ''],
['errorCode' => 'PhoneNoCertifyCodeNullError', 'errorMessage' => 'Phone number and verification code cannot be empty.', 'description' => ''],
['errorCode' => 'CompanyVerificationFailedCompanyStateInvalid', 'errorMessage' => 'Four Elements Verification Failed: Company is not in normal operation.', 'description' => ''],
['errorCode' => 'CompanyVerificationFailedFourElementsError', 'errorMessage' => 'Four Elements Verification Failed: Authentication Failed.', 'description' => ''],
['errorCode' => 'CompanyVerificationFailedMismatch', 'errorMessage' => 'Four Elements Verification Failed: Mismatch between Legal Representative and Company Information.', 'description' => 'The verification of the four elements of the enterprise fails, and the verification of the legal person and the enterprise information is inconsistent.'],
['errorCode' => 'CompanyVerificationFailedNoCompany', 'errorMessage' => 'Four Elements Verification Failed: Company Not Found.', 'description' => ''],
['errorCode' => 'CompanyVerificationFailedNoLegalPerson', 'errorMessage' => 'Four Elements Verification Failed: Legal Representative Not Found.', 'description' => ''],
],
],
'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' => 'Apply for SMS qualification',
'description' => '- Before submitting an application, read [Qualification material description](~~2384377~~) and prepare the required qualification materials.'."\n"
.'- Currently, only users who have completed **verify your identity - Enterprise account** can use the API to apply for SMS qualifications. If your Alibaba Cloud account has completed verify your identity - Individual account, apply for qualifications through the Short Message Service [console](https://dysms.console.aliyun.com/domestic/text/qualification/add), or [upgrade to verify your identity - Enterprise account](~~37178~~). [View my account verification type](https://myaccount.console.aliyun.com/cert-info)'."\n"
.'- Batch qualification applications are not supported. Wait at least 5 seconds between applications.',
'requestParamsDescription' => '><notice>'."\n"
."\n"
.'For specific requirements on SMS qualification materials, see [Qualification material description](~~2384377~~). Requirements may be adjusted in real time based on MIIT and carrier policies. The actual review results prevail.'."\n"
."\n"
.'></notice>.',
'changeSet' => [
['createdAt' => '2025-08-01T04:05:20.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [],
],
'TagResources' => [
'summary' => 'Tags can mark resources, allowing enterprises or individuals to classify templates of the same type for easier search and resource aggregation. Call this operation to bind tags to SMS templates.',
'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' => 'The resource type. Default value: **TEMPLATE**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TEMPLATE', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID. Default value: **cn-hangzhou**. For more region IDs, see [Endpoints](~~419270~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ProdCode',
'in' => 'query',
'schema' => ['description' => 'The product name. Default value: **dysms**.', 'type' => 'string', 'required' => false, 'default' => 'dysms', 'example' => 'dysms', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The tags. You can add up to 20 tags at a time.',
'type' => 'array',
'items' => [
'description' => 'The tag.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''],
'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 21,
'title' => '',
'example' => '',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The SMS template codes. The number of codes cannot exceed 20.',
'type' => 'array',
'items' => ['description' => 'The SMS template code.'."\n"
."\n"
.'>- Obtain the SMS template code from the response parameters of the [CreateSmsTemplate](~~CreateSmsTemplate~~) operation.'."\n"
.'>- View the SMS template code on the [Domestic Messages > Template Management](https://dysms.console.aliyun.com/domestic/text/template) page.', 'type' => 'string', 'required' => false, 'example' => 'SMS_2342****', 'title' => ''],
'required' => false,
'example' => 'SMS_23423423',
'maxItems' => 51,
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The request status code. Valid values:'."\n"
."\n"
.'- OK: The request was successful.'."\n"
.'- For other error codes, see [Error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The result of adding the tags. Valid values:'."\n"
."\n"
.'- **true**: success.'."\n"
.'- **false**: failure.', 'type' => 'string', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF'."\n", 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
200 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => 'No access, please contact 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' => 'Add template tags',
'description' => '- Each template can be bound to up to 20 tags.'."\n"
.'- The tag key (Key) must be unique within the same template. If a template has two tags with the same Key but different Values, the new value overwrites the old value.'."\n"
.'- This feature is only available for domestic text messages of Short Message Service on the China site.'."\n"
."\n"
.'### QPS limit'."\n"
.'The per-user QPS limit of this operation is 50 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation at a reasonable frequency.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dysms:TagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'UntagResources' => [
'summary' => 'Tags can mark resources, allowing enterprises or individuals to categorize templates of the same type for easier search and resource aggregation. If a template is no longer applicable to its currently bound tags, you can unbind the tags from the template. You can delete a single tag or delete tags in batches.',
'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' => 'The resource type. Set the value to TEMPLATE by default.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TEMPLATE', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID. Set the value to cn-hangzhou by default.'."\n"
.'For more region IDs, see [Service endpoints](~~419270~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'All',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to delete all tags under the template. Valid values:'."\n"
."\n"
.'- **true**: yes.'."\n"
.'- **false**: no.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''],
],
[
'name' => 'ProdCode',
'in' => 'query',
'schema' => ['description' => 'The product name. Default value: **dysms**.', 'type' => 'string', 'required' => false, 'default' => 'dysms', 'example' => 'dysms', 'title' => ''],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The tag key. You can add no more than 20 tags at a time.',
'type' => 'array',
'items' => ['description' => 'The tag key.'."\n"
.'You can view the tag key on the Tags column of the [Template Management](https://dysms.console.aliyun.com/domestic/text/template) page.', 'type' => 'string', 'required' => false, 'example' => 'sampleTagKey', 'title' => ''],
'required' => false,
'example' => 'TestKey',
'maxItems' => 21,
'title' => '',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The SMS template code. The number of codes cannot exceed 20.',
'type' => 'array',
'items' => ['description' => 'The SMS template code.'."\n"
."\n"
.'>- You can obtain the SMS template code from the response parameters of the [CreateSmsTemplate](~~CreateSmsTemplate~~) operation.'."\n"
.'>- You can view the SMS template code on the [Domestic Messages > Template Management](https://dysms.console.aliyun.com/domestic/text/template) page.', 'type' => 'string', 'required' => false, 'example' => 'SMS_2342****', 'title' => ''],
'required' => false,
'example' => 'SMS_23423423',
'maxItems' => 51,
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The request status code. Valid values:'."\n"
."\n"
.'- OK: The request was successful.'."\n"
.'- For other error codes, see [Error code list](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The execution result of deleting the tag. Valid values:'."\n"
."\n"
.'- **true**: success.'."\n"
."\n"
.'- **false**: failure.', 'type' => 'string', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF'."\n", 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
200 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => 'No access, please contact 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' => 'Delete Template Tags',
'description' => '### QPS limit'."\n"
.'The QPS limit per user for this operation is 50 calls per second. If the limit is exceeded, API calls will be throttled, which may affect your business. Please call the operation reasonably.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'dysms:UntagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'UpdateSmsQualification' => [
'summary' => 'If you need to update SMS qualification information, you can submit a modification request through this API. After submission, it will re-enter the review process.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '264875',
'abilityTreeNodes' => ['FEATUREdysmsJ2BZAJ'],
],
'parameters' => [
[
'name' => 'QualificationGroupId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The qualification ID, that is, the ID returned when you [apply for SMS qualification](~~SubmitSmsQualification~~). You can obtain the qualification IDs under the current account by calling [Query Qualification List](~~QuerySmsQualificationRecord~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000****'],
],
[
'name' => 'OrderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The review order ID. You can obtain the qualifications and their corresponding review order IDs under the current account by calling [Query Qualification List](~~QuerySmsQualificationRecord~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2001*****'],
],
[
'name' => 'BusinessLicensePics',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'Enterprise business license information. This parameter is required when the purpose of the qualification to be modified is for use by others.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['title' => '', 'description' => 'Business license type. Valid values:'."\n"
."\n"
.'- socialCreditLicense: Social credit code certificate.'."\n"
.'- businessLicense: Enterprise business license.'."\n"
.'- signLegalLicense: Public institution legal person certificate.'."\n"
.'- otherLicense: Other.'."\n"
."\n"
.'Choose one to upload. The certificate must contain: enterprise name, unified social credit code, and certificate validity period.', 'type' => 'string', 'required' => false, 'example' => 'businessLicense'],
'LicensePic' => ['title' => '', 'description' => 'Business license image. Only jpg, png, gif, and jpeg image formats are supported, and the image must not exceed 5 MB. Please provide the path of the file uploaded to OSS. The file name to be uploaded must not contain Chinese characters or special characters. For upload operations, see [Upload Files via OSS](~~2833114~~).'."\n"
."\n"
.'><notice>'."\n"
.'No stamp is required for color originals of the certificate. If you upload a photocopy or black-and-white photo, you must affix the enterprise red seal to the photocopy and take a photo to upload.'."\n"
.'></notice>', 'type' => 'string', 'required' => false, 'example' => '123456/111.png'],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
],
[
'name' => 'CompanyName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Enterprise name. Supported symbols are only the middle dot `·`, the Chinese symbols `【】()`, the English symbols `()`, and the `space`. Other symbols or pure numbers are not allowed. The length must not exceed 150 characters.', 'type' => 'string', 'required' => false, 'example' => '阿里云云通信有限公司'],
],
[
'name' => 'BussinessLicenseExpDate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Validity period of the business license. Format: YYYY-MM-DD~YYYY-MM-DD.'."\n"
.'> When the certificate validity period is long-term, the end date can be set to 2099-12-31.', 'type' => 'string', 'required' => false, 'example' => '2023-01-01~2033-01-01'],
],
[
'name' => 'LegalPersonIdCardFrontSide',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Photo of the front of the legal representative\'s ID card (national emblem side). Only jpg, png, gif, and jpeg image formats are supported, and the image must not exceed 5 MB. Please provide the path of the file uploaded to OSS. The file name to be uploaded must not contain Chinese characters or special characters. For upload operations, see [Upload Files via OSS](~~2833114~~).'."\n"
.'> The system will use the legal person name and ID number you provide for verification. If the verification fails, you need to upload a photo of the legal representative\'s ID card.', 'type' => 'string', 'required' => false, 'example' => '123456/111.png'."\n"],
],
[
'name' => 'LegalPersonIdCardBackSide',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Photo of the back of the legal representative\'s ID card (portrait side). Only jpg, png, gif, and jpeg image formats are supported, and the image must not exceed 5 MB. Please provide the path of the file uploaded to OSS. The file name to be uploaded must not contain Chinese characters or special characters. For upload operations, see [Upload Files via OSS](~~2833114~~).'."\n"
.'> The system will use the legal person name and ID number you provide for verification. If the verification fails, you need to upload a photo of the legal representative\'s ID card.', 'type' => 'string', 'required' => false, 'example' => '123456/111.png'."\n"],
],
[
'name' => 'LegalPersonName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Name of the legal representative.'."\n"
."\n"
.'> - If there is no legal representative information on the organization\'s certificate, but there is information about a person in charge / chief representative or similar, please prepare the ID card photo of the corresponding person in charge or chief representative listed on the certificate.'."\n"
.'> - If there is no legal representative information on the organization\'s certificate, and there is no information about any person in charge, please prepare the name and ID card photo of the main business contact person.', 'type' => 'string', 'required' => false, 'example' => '李华'],
],
[
'name' => 'LegalPersonIDCardNo',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Legal person\'s ID number.', 'type' => 'string', 'required' => false, 'example' => ' '."\n"
.'511391********5123'."\n"],
],
[
'name' => 'LegalPersonIdCardEffTime',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Validity period of the legal person ID card. Format: YYYY-MM-DD~YYYY-MM-DD.'."\n"
.'> When the certificate validity period is long-term, the end date can be set to 2099-12-31.', 'type' => 'string', 'required' => false, 'example' => '2023-01-01~2033-01-01'],
],
[
'name' => 'LegalPersonIDCardType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Legal person ID card type. Valid values:'."\n"
."\n"
.'- identityCard: ID card.'."\n"
.'- passport: Passport.'."\n"
.'- homeReturnPermit: Mainland Travel Permit for Hong Kong and Macao Residents.'."\n"
.'- TaiwanCompatriotPermit: Mainland Travel Permit for Taiwan Residents.'."\n"
.'- residencePermit: Residence Permit for Hong Kong, Macao, and Taiwan Residents.'."\n"
.'- other: Other.', 'type' => 'string', 'required' => false, 'example' => 'identityCard'],
],
[
'name' => 'AdminIDCardPic',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Photo of the back of the administrator\'s ID card (portrait side). Only jpg, png, gif, and jpeg image formats are supported, and the image must not exceed 5 MB. Please provide the path of the file uploaded to OSS. The file name to be uploaded must not contain Chinese characters or special characters. For upload operations, see [Upload Files via OSS](~~2833114~~).'."\n"
."\n"
.'><notice>'."\n"
.' No stamp is required for color originals of the certificate. If you upload a photocopy or black-and-white photo, you must affix the enterprise red seal to the photocopy and take a photo to upload.'."\n"
.'></notice>', 'type' => 'string', 'required' => false, 'example' => '123456/111.png'."\n"],
],
[
'name' => 'AdminIDCardFrontFace',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Photo of the front of the administrator\'s ID card (national emblem side). Only jpg, png, gif, and jpeg image formats are supported, and the image must not exceed 5 MB. Please provide the path of the file uploaded to OSS. The file name to be uploaded must not contain Chinese characters or special characters. For upload operations, see [Upload Files via OSS](~~2833114~~).'."\n"
."\n"
.'><notice>'."\n"
.'No stamp is required for color originals of the certificate. If you upload a photocopy or black-and-white photo, you must affix the enterprise red seal to the photocopy and take a photo to upload.'."\n"
.'></notice>', 'type' => 'string', 'required' => false, 'example' => '123456/111.png'."\n"],
],
[
'name' => 'AdminName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Administrator name.'."\n"
."\n"
.'> The administrator (also known as the operator) refers to the person who logs in to the Alibaba Cloud account and manages the SMS service. Generally, this is the operations personnel who manages qualifications, signatures, and templates and sends SMS messages under this Alibaba Cloud account, and whose phone number can receive verification codes. The administrator is not necessarily the administrator of this Alibaba Cloud account. The administrator can be the same person as the enterprise\'s legal representative.', 'type' => 'string', 'required' => false, 'example' => '李华'],
],
[
'name' => 'AdminIDCardNo',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Administrator\'s ID number.', 'type' => 'string', 'required' => false, 'example' => '511391********5123'."\n"],
],
[
'name' => 'AdminIDCardExpDate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Validity period of the administrator ID card. Format: YYYY-MM-DD~YYYY-MM-DD.'."\n"
.'> When the certificate validity period is long-term, the end date can be set to 2099-12-31.', 'type' => 'string', 'required' => false, 'example' => '2023-01-01~2033-01-01'."\n"
."\n"],
],
[
'name' => 'AdminPhoneNo',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Administrator\'s mobile phone number. Format: +/+86/0086/86 prefix or a phone number without any prefix, for example, 1390000****.', 'type' => 'string', 'required' => true, 'example' => '137********'],
],
[
'name' => 'CertifyCode',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Phone verification code. Please call the [RequiredPhoneCode](~~RequiredPhoneCode~~) API and pass in the **administrator\'s phone number**, then enter the SMS verification code you receive here.'."\n"
."\n"
.'> You can use [ValidPhoneCode](~~ValidPhoneCode~~) to verify whether the SMS verification code is correct before passing it in.', 'type' => 'string', 'required' => true, 'example' => '1234'],
],
[
'name' => 'AdminIDCardType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Administrator ID card type. Valid values:'."\n"
."\n"
.'- identityCard: ID card.'."\n"
.'- passport: Passport.'."\n"
.'- homeReturnPermit: Mainland Travel Permit for Hong Kong and Macao Residents.'."\n"
.'- TaiwanCompatriotPermit: Mainland Travel Permit for Taiwan Residents.'."\n"
.'- residencePermit: Residence Permit for Hong Kong, Macao, and Taiwan Residents.'."\n"
.'- other: Other.', 'type' => 'string', 'required' => false, 'example' => 'identityCard'],
],
[
'name' => 'OtherFiles',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'Additional materials. If you have other supporting or supplementary materials, photos, etc., you can upload them here.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LicensePic' => ['description' => 'Additional material file. Only png, jpg, jpeg, doc, docx, and pdf formats are supported, and the file must not exceed 5 MB. Please provide the path of the file uploaded to OSS. The file name to be uploaded must not contain Chinese characters or special characters. For upload operations, see [Upload Files via OSS](~~2833114~~).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '123456/111.png'."\n"],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'Access denied details. This field is returned only when RAM verification fails.', 'type' => 'string', 'example' => '无', 'title' => ''],
'RequestId' => ['description' => 'The ID of this call request. It is a unique identifier generated by Alibaba Cloud for this request and can be used to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA'."\n"],
'Message' => ['description' => 'Description of the status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Data' => ['description' => 'Qualification ID.', 'type' => 'string', 'title' => '', 'example' => '10000****'],
'Code' => ['description' => 'Request status code.'."\n"
."\n"
.'* OK indicates that the request was successful.'."\n"
.'* For other error codes, see the error code list in this section or the product [Error Code List](~~101346~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Success' => ['description' => 'Whether the API call was successful. Valid values:'."\n"
."\n"
.'- **true**: The call was successful.'."\n"
."\n"
.'- **false**: The call failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'QualificationNameNullError', 'errorMessage' => 'Qualification name cannot be empty.', 'description' => ''],
['errorCode' => 'BusinessLicensePicsNullError', 'errorMessage' => 'Business license documents cannot be empty.', 'description' => ''],
['errorCode' => 'OtherFileTypeError', 'errorMessage' => 'Invalid file format for other documents.', 'description' => ''],
['errorCode' => 'QualificationNameAlreadyExist', 'errorMessage' => 'The qualification name already exists. Please modify and resubmit.', 'description' => ''],
['errorCode' => 'QualificationNameNotMatchRegex', 'errorMessage' => 'Qualification names must be in Chinese, English, or alphanumeric combinations. Symbols or pure numbers are not supported.', 'description' => ''],
['errorCode' => 'AdminIdcardTypeError', 'errorMessage' => 'Invalid administrator ID card type.', 'description' => ''],
['errorCode' => 'BusinessLicensePicsFileError', 'errorMessage' => 'Invalid business license file format.', 'description' => ''],
['errorCode' => 'BusinessLicenseTypeError', 'errorMessage' => 'Invalid business license type.', 'description' => ''],
['errorCode' => 'LegalIdCardNoNullError', 'errorMessage' => 'Legal person\'s ID number cannot be empty.', 'description' => ''],
['errorCode' => 'LegalPersonIdcardTypeError', 'errorMessage' => 'Invalid legal person ID card type.', 'description' => ''],
['errorCode' => 'CompanyNameNullError', 'errorMessage' => 'Company name cannot be empty.', 'description' => ''],
['errorCode' => 'CompanyTypeError', 'errorMessage' => 'Invalid company type.', 'description' => ''],
['errorCode' => 'LegalIdCardNotMatchRegex', 'errorMessage' => 'Invalid legal person ID number format.', 'description' => ''],
['errorCode' => 'LegalPersonNameNullError', 'errorMessage' => 'Legal person\'s name cannot be empty.', 'description' => ''],
['errorCode' => 'OrganizationCodeNullError', 'errorMessage' => 'Unified Social Credit Code cannot be empty.', 'description' => ''],
['errorCode' => 'AdminIdcardFrontFaceFileError', 'errorMessage' => 'Invalid format for administrator\'s ID card national emblem photo.', 'description' => ''],
['errorCode' => 'AdminIdcardFrontFaceNullError', 'errorMessage' => 'Administrator\'s ID card national emblem photo cannot be empty.', 'description' => ''],
['errorCode' => 'AdminIdcardPicsFileError', 'errorMessage' => 'Invalid format for administrator\'s ID card portrait photo.', 'description' => ''],
['errorCode' => 'AdminIdcardPicsNullError', 'errorMessage' => 'Administrator\'s ID card portrait photo cannot be empty.', 'description' => ''],
['errorCode' => 'AdminNameNullError', 'errorMessage' => 'Administrator\'s name cannot be empty.', 'description' => ''],
['errorCode' => 'AdminIdcardExpdateNotMatchRegexError', 'errorMessage' => 'Invalid administrator ID card expiration time format.', 'description' => ''],
['errorCode' => 'AdminIdcardNoNullError', 'errorMessage' => 'Administrator\'s ID number cannot be empty.', 'description' => ''],
['errorCode' => 'AdminIdcardNotMatchRegex', 'errorMessage' => 'Invalid administrator ID number format.', 'description' => ''],
['errorCode' => 'BusinessLicenseDateNotMatchRegexError', 'errorMessage' => 'Invalid business license expiration time format.', 'description' => ''],
['errorCode' => 'LegalPersonIdcardEfftimeNotMatchRegexError', 'errorMessage' => 'Invalid legal person ID card expiration time format.', 'description' => ''],
['errorCode' => 'AdminDateNotValid', 'errorMessage' => 'Current time is outside the administrator ID card validity period.', 'description' => ''],
['errorCode' => 'BusinessLicenseDateNotValid', 'errorMessage' => 'Current time is outside the business license validity period.', 'description' => ''],
['errorCode' => 'BusinessLicenseOssFileNotUploadError', 'errorMessage' => 'Business license file not uploaded.', 'description' => ''],
['errorCode' => 'LegalDateNotValid', 'errorMessage' => 'Current time is outside the legal person ID card validity period.', 'description' => ''],
['errorCode' => 'LegalFrontOssFileNotUploadError', 'errorMessage' => 'Legal person ID card national emblem photo not uploaded.', 'description' => ''],
['errorCode' => 'AdminBackOssFileNotUploadError', 'errorMessage' => 'Administrator ID card portrait photo not uploaded.', 'description' => ''],
['errorCode' => 'AdminFrontOssFileNotUploadError', 'errorMessage' => 'Administrator ID card national emblem photo not uploaded.', 'description' => ''],
['errorCode' => 'CustNotExistError', 'errorMessage' => 'Customer\'s cloud communication information is invalid.', 'description' => ''],
['errorCode' => 'GrayCustAccessError', 'errorMessage' => 'This customer is not authorized to use the OpenAPI. Please contact support for whitelisting.', 'description' => ''],
['errorCode' => 'LegalBackOssFileNotUploadError', 'errorMessage' => 'Legal person ID card portrait photo not uploaded.', 'description' => ''],
['errorCode' => 'OtherOssFileNotUploadError', 'errorMessage' => 'Other files not uploaded.', 'description' => ''],
['errorCode' => 'CertifyCodeError', 'errorMessage' => 'SMS verification code is incorrect.', 'description' => ''],
['errorCode' => 'NotEnterpriseCertifyCustCheckError', 'errorMessage' => 'Non-enterprise certified customers are not allowed to access.', 'description' => ''],
['errorCode' => 'PhoneNoCertifyCodeNullError', 'errorMessage' => 'Phone number and verification code cannot be empty.', 'description' => ''],
['errorCode' => 'SameQualificationGroupError', 'errorMessage' => 'A qualification with the same company and administrator information already exists.', 'description' => ''],
['errorCode' => 'WorkOrderIdExpired', 'errorMessage' => 'Qualification details have changed. Please re-query the qualification list and resubmit.', 'description' => ''],
['errorCode' => 'CompanyVerificationFailedCompanyStateInvalid', 'errorMessage' => 'Four Elements Verification Failed: Company is not in normal operation.', 'description' => ''],
['errorCode' => 'CompanyVerificationFailedFourElementsError', 'errorMessage' => 'Four Elements Verification Failed: Authentication Failed.', 'description' => ''],
['errorCode' => 'CompanyVerificationFailedMismatch', 'errorMessage' => 'Four Elements Verification Failed: Mismatch between Legal Representative and Company Information.', 'description' => 'The verification of the four elements of the enterprise fails, and the verification of the legal person and the enterprise information is inconsistent.'],
['errorCode' => 'CompanyVerificationFailedNoCompany', 'errorMessage' => 'Four Elements Verification Failed: Company Not Found.', 'description' => ''],
['errorCode' => 'CompanyVerificationFailedNoLegalPerson', 'errorMessage' => 'Four Elements Verification Failed: Legal Representative Not Found.', 'description' => ''],
],
],
'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' => 'Modify SMS Qualification',
'description' => '- Qualifications under review do not support modification. Please wait for the review process to finish, or [withdraw the application](https://dysms.console.aliyun.com/domestic/text/qualification) in the SMS Service console before making modifications.'."\n"
.'- The modified SMS qualification **must be re-reviewed** (including qualifications that have already passed review). Please upload materials that meet the specifications according to the [Qualification Material Description](~~2384377~~).'."\n"
.'- **Modification is not supported** for the qualification name, application purpose, or unified social credit code.'."\n"
.'- Batch modification of SMS qualifications is not supported. It is recommended to leave at least 5 seconds between modifications.',
'requestParamsDescription' => '><notice>'."\n"
."\n"
.'For the specific requirements of SMS qualification materials, see the [Qualification Material Description](~~2384377~~). The requirements may be adjusted in real time in accordance with the requirements of the Ministry of Industry and Information Technology and the carriers. The actual review result shall prevail.'."\n"
."\n"
.'></notice>',
'changeSet' => [
['createdAt' => '2025-08-01T04:05:19.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [],
],
'UpdateSmsSign' => [
'summary' => 'You can modify rejected or approved signatures. A modified signature is automatically submitted for review, and its status changes to pending review.',
'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' => 'The name of the rejected SMS signature. You can find rejected SMS signatures on the [Domestic Messages > Signature Management](https://dysms.console.aliyun.com/domestic/text/sign) page in the console, or by calling the [QuerySmsSignList](~~QuerySmsSignList~~) operation.', 'type' => 'string', 'required' => true, 'example' => '阿里云验证码', 'title' => ''],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => ['description' => 'A description of the SMS signature\'s use case. This information is used during the review and must be 200 characters or less.'."\n"
."\n"
.'> - Describe the use case for your live service. Include relevant links, such as a website link or an app store link.'."\n"
.'>'."\n"
.'> - Provide a complete example of an SMS message that reflects your use case.'."\n"
.'>'."\n"
.'> - Provide the values for any variables. Describe the use case in detail and explain why the variables are necessary.'."\n"
.'>'."\n"
.'> - If the signature involves a government agency or public institution, provide its official landline number.'."\n"
."\n"
.'Providing complete and accurate information accelerates the review process. If you do not provide the required information, your signature application may be rejected.', 'type' => 'string', 'required' => false, 'maxLength' => 500, 'example' => '登录场景申请验证码', 'title' => ''],
],
[
'name' => 'SignType',
'in' => 'query',
'schema' => ['description' => 'The signature type. Valid values:'."\n"
."\n"
.'- **0**: verification code.'."\n"
."\n"
.'- **1**: general (default).'."\n"
."\n"
.'We recommend that you use the default value, **general**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'MoreData',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'Additional supporting materials. You can upload supporting business documents or business screenshots to help with the review. For details on what to upload, see [Signature application materials](~~108076#section-xup-k46-yi4~~).',
'type' => 'array',
'items' => ['description' => 'The OSS path of the uploaded file. The **file name cannot contain Chinese characters or special characters**. For information about how to upload a file, see [Upload files via OSS](https://help.aliyun.com/zh/sms/upload-files-through-oss).', 'type' => 'string', 'required' => false, 'example' => '10098689758*****/1234qwe.png'."\n", 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'QualificationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the approved qualification.'."\n"
."\n"
.'> - You must [apply for a qualification](https://help.aliyun.com/zh/sms/user-guide/new-qualification?spm=a2c4g.11186623.0.0.718d187bbkpMRK) before applying for an SMS signature.'."\n"
.'>'."\n"
.'> - You can find the qualification ID on the [qualification management](https://dysms.console.aliyun.com/domestic/text/qualification) page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '8563**', 'title' => ''],
],
[
'name' => 'ApplySceneContent',
'in' => 'query',
'schema' => ['description' => 'The app store link. This parameter is required if the signature source (`SignSource`) is an app (the value is 2). The link must start with `http://` or `https://`, and the app must be published in the app store.', 'type' => 'string', 'required' => false, 'example' => 'http://www.aliyun.com/'."\n", 'title' => ''],
],
[
'name' => 'SignSource',
'in' => 'query',
'schema' => [
'description' => 'The signature source. Valid values:'."\n"
."\n"
.'- **0**: The full or abbreviated name of an enterprise or public institution. **(Recommended)**'."\n"
."\n"
.'- **5**: The full or abbreviated trademark name.'."\n"
."\n"
.'- **2**: The full or abbreviated name of an app. **(Not recommended)**'."\n"
."\n"
.'For more information, see [signature source](~~108076#section-fow-bfu-wo9~~).',
'enumValueTitles' => [],
'type' => 'integer',
'format' => 'int32',
'required' => true,
'enum' => ['0', '1', '2', '3', '4', '5'],
'example' => '2',
'title' => '',
],
],
[
'name' => 'ThirdParty',
'in' => 'query',
'schema' => ['description' => 'The signature purpose. Valid values:'."\n"
."\n"
.'- false: for own use (default). The signature is for a business, website, or product owned by your account\'s verified entity.'."\n"
."\n"
.'- true: for third-party use. The signature is for a business, website, or product not owned by your account\'s verified entity.'."\n"
.' ><notice>Ensure the selected qualification ID matches the signature purpose (for own use or for third-party use).></notice>', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'AuthorizationLetterId',
'in' => 'query',
'schema' => ['description' => 'The authorization letter ID. This parameter is required if the signature is for third-party use (`ThirdParty` is set to `true`). The Unified Social Credit Code on the authorization letter must match the code in the selected qualification\'s information.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000********1234', 'title' => ''],
],
[
'name' => 'TrademarkId',
'in' => 'query',
'schema' => ['description' => 'The trademark entity ID.'."\n"
."\n"
.'> - This parameter is required if `SignSource` is set to 5.'."\n"
.'>'."\n"
.'> - You can obtain the trademark entity ID by calling the [Create Trademark Entity](~~CreateSmsTrademark~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000009081***', 'title' => ''],
],
[
'name' => 'AppIcpRecordId',
'in' => 'query',
'schema' => ['description' => 'The ID of the app\'s ICP filing entity.'."\n"
."\n"
.'> - This parameter is required if `SignSource` is set to 2.'."\n"
.'>'."\n"
.'> - You can obtain the filing entity ID by calling the [Create ICP Filing Entity](~~CreateSmsAppIcpRecord~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100001***1234', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The unique identifier for the request, generated by Alibaba Cloud. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D1D', 'title' => ''],
'Code' => ['description' => 'The status code of the request. Valid values:'."\n"
."\n"
.'- OK: The request was successful.'."\n"
."\n"
.'- For other error codes, see [Error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'SignName' => ['description' => 'The updated signature name.', 'type' => 'string', 'example' => '登录验证', 'title' => ''],
'OrderId' => ['description' => 'The order ID.'."\n"
."\n"
.'Reviewers use this ID to look up the submission. Provide this order ID to request an expedited review.', 'type' => 'string', 'example' => '2004417****', 'title' => ''],
],
'description' => 'The response body.',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => ''],
['errorCode' => 'ParameterMismatch.ThirdParty', 'errorMessage' => 'The type of signature, whether for personal use or for a third party, should be consistent with the qualifications.', 'description' => 'Whether the signature is used by a third party should be consistent with the qualification.'],
['errorCode' => 'SignName.Exists', 'errorMessage' => 'Sorry, this signature already exists and cannot be applied for again.', 'description' => 'Sorry, this signature already exists and cannot be reapplied.'],
['errorCode' => 'InvalidQualification', 'errorMessage' => 'The qualification should be approved.', 'description' => 'Invalid qualification, qualification should be approved.'],
['errorCode' => 'InvalidApplySceneContent', 'errorMessage' => 'For certain signature sources, the '."\n"
.'applySceneContent should be an HTTP or HTTPS link.', 'description' => 'invalid application scenario, under some signature sources,'."\n"
.'The application scenario should be an HTTP or HTTPS link.'],
['errorCode' => 'InvalidSignName', 'errorMessage' => 'The signature cannot contain spaces, special '."\n"
.'symbols, or all numbers.', 'description' => 'The signature cannot contain special characters such as simplified Chinese, English, or spaces other than digits, and cannot be all digits.'],
['errorCode' => 'MissApplySceneContent', 'errorMessage' => 'In some signature sources, the applySceneContent is required.', 'description' => 'Under some signature sources, the application scenario is required.'],
['errorCode' => 'MissingSignName', 'errorMessage' => 'The signature name cannot be empty.', 'description' => '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.', 'description' => '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.', 'description' => ''],
['errorCode' => 'SmsSignNotAuthorized', 'errorMessage' => 'the signature is not in the sign scope of the authorization letter.', 'description' => 'The signature is not within the scope of the authorization.'],
['errorCode' => 'TrademarkNotExist', 'errorMessage' => 'The trademark does not exist.', 'description' => ''],
['errorCode' => 'AppIcpRecordNotExist', 'errorMessage' => 'The APP-ICP record does not exist.', 'description' => ''],
],
404 => [
['errorCode' => 'QualificationNotFound', 'errorMessage' => 'Qualification does not exist.', 'description' => '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' => 'Update SMS Signature (New Interface)',
'description' => '- For details about the updates to the signature and template APIs, see [Announcement on Updating Signature & Template APIs for Short Message Service](~~2806975~~).'."\n"
."\n"
.'- You can modify signatures that are either **rejected** or **approved**. For guidance on handling review failures, see [Handling signature review failures](~~65990~~). Call this API to modify and resubmit the signature for review.'."\n"
."\n"
.'- You cannot use this API to edit the name of a **rejected** signature. To edit the name, go to the [Short Message Service console](https://dysms.console.aliyun.com/domestic/text/sign).'."\n"
."\n"
.'- Signatures you request using this API are synchronized with the Short Message Service console. For information on managing signatures in the console, see [Signatures](~~108073~~).',
'changeSet' => [
['createdAt' => '2025-12-16T07:45:19.000Z', 'description' => 'Error codes changed, Request parameters changed'],
['createdAt' => '2025-12-11T12:44:33.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-12-11T12:44:31.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-12-11T10:08:24.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-12-11T10:08:22.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-14T02:14:09.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-14T02:14:00.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-14T02:07:43.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-03T13:14:38.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-03T13:14:37.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-03T13:14:01.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-03T13:14:00.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSmsSign'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'dysms:UpdateSmsSign',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'UpdateSmsTemplate' => [
'summary' => 'This API modifies a template that failed review and automatically resubmits it.',
'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' => 'The name of the SMS template, up to 30 characters long. You can find the names of rejected templates on the [Messages in Chinese Mainland > Template Management](https://dysms.console.aliyun.com/domestic/text/template) tab in the console or by calling the [QuerySmsTemplateList](~~QuerySmsTemplateList~~) operation.', 'type' => 'string', 'required' => true, 'example' => '验证码模板', 'maxLength' => 30, 'title' => ''],
],
[
'name' => 'TemplateCode',
'in' => 'query',
'schema' => ['description' => 'The code of the rejected SMS template. You can find the template code on the [Messages in Chinese Mainland > Template Management](https://dysms.console.aliyun.com/domestic/text/template) tab in the console or by calling the [QuerySmsTemplateList](~~QuerySmsTemplateList~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'SMS_152550****', 'title' => ''],
],
[
'name' => 'TemplateContent',
'in' => 'query',
'schema' => ['description' => 'The new template content, up to 500 characters long.'."\n"
."\n"
.'The template content and its variables must comply with [SMS template specifications](~~463161~~) to be approved. To increase the approval rate and efficiency, refer to the common examples on the [Apply for Template](https://dysms.console.aliyun.com/domestic/text/template/add) page. For more information about variable specifications, see [TemplateContent parameter variable specifications](~~2806243~~).', 'type' => 'string', 'required' => true, 'example' => '您正在申请手机注册,验证码为:${code},5分钟内有效!', 'maxLength' => 500, 'title' => ''],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => ['description' => 'Describe your business scenario, including a URL if applicable. You must also provide a complete SMS message example with populated variables. Providing this information as required is critical for template approval.', 'type' => 'string', 'required' => false, 'example' => '登录场景使用验证码', 'maxLength' => 500, 'title' => ''],
],
[
'name' => 'TemplateType',
'in' => 'query',
'schema' => [
'description' => 'The SMS type. Valid values:'."\n"
."\n"
.'- **0**: verification code.'."\n"
."\n"
.'- **1**: SMS notification.'."\n"
."\n"
.'- **2**: promotional SMS.'."\n"
."\n"
.'- **3**: international/regional message.'."\n"
."\n"
.'> Only enterprise-verified users can apply for promotional SMS and international/regional messages. For more information about the differences between personal and enterprise accounts, see [Usage notes](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'],
'title' => '',
],
],
[
'name' => 'RelatedSignName',
'in' => 'query',
'schema' => ['description' => 'The SMS signature associated with the template.', 'type' => 'string', 'required' => false, 'example' => '阿里云', 'title' => ''],
],
[
'name' => 'TemplateRule',
'in' => 'query',
'schema' => ['description' => 'The rules for the variables in the template. For details on how to define these rules, see the [example document](~~2806243~~).', 'type' => 'string', 'required' => false, 'example' => '{"code":"characterWithNumber"}', 'title' => ''],
],
[
'name' => 'MoreData',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'Additional materials, such as supporting documents or business screenshots, to help reviewers understand your business. If `TemplateType` is set to `2` (promotional SMS), you must upload proof of user authorization. For more information, see [Upload specifications for user authorization materials](~~312341~~).',
'type' => 'array',
'items' => ['description' => 'The OSS key of the uploaded file. For instructions on how to upload files, see [Upload files to OSS](~~2833114~~).', 'type' => 'string', 'required' => false, 'example' => '10098689758****/1234qwe.png', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'ApplySceneContent',
'in' => 'query',
'schema' => ['description' => 'The business scenario.'."\n"
."\n"
.'- If the associated SMS signature\'s business scenario is "Live App", the `ApplySceneContent` parameter must be an app URL starting with `http://` or `https://`.'."\n"
."\n"
.'- The `ApplySceneContent` parameter is required if the associated SMS signature\'s business scenario is "Registered Trademark" or "Name of Enterprise or Public Institution".', 'type' => 'string', 'required' => false, 'example' => 'http://www.aliyun.com/'."\n", 'title' => ''],
],
[
'name' => 'IntlType',
'in' => 'query',
'schema' => ['description' => 'The type of the international/regional template. This parameter is required when the **TemplateType** parameter is set to **3**. Valid values:'."\n"
."\n"
.'- **0**: SMS notification.'."\n"
."\n"
.'- **1**: promotional SMS.'."\n"
."\n"
.'- **2**: verification code.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'TrafficDriving',
'in' => 'query',
'schema' => ['description' => '><warning>'."\n"
."\n"
.'To manage SMS content security, messages that contain traffic-driving information such as phone numbers and URLs may be blocked by carriers, which can cause delivery failures. We recommend that you avoid including such information in your SMS templates to prevent delivery failures.'."\n"
."\n"
.'></warning>'."\n"
."\n"
.'A JSON string that contains a list of traffic-driving information.'."\n"
.'><notice>The value must be in the JSON format. Convert the value to a string before you pass it in.></notice>'."\n"
."\n"
.'### 1. Fields'."\n"
."\n"
.'{'."\n"
.'"trafficDrivingType":"Traffic-driving type",'."\n"
.'"trafficDrivingContent":"Traffic-driving content",'."\n"
.'"variableName":"variable name",'."\n"
.'"companyName":"Name of the enterprise or public institution",'."\n"
.'"organizationCode":"Unified Social Credit Code",'."\n"
.'"icpNo":"ICP filing/permit number",'."\n"
.'"icpPicOssKey":"OSS key of the ICP filing screenshot",'."\n"
.'"companyDifferentFromSignQuaReason":"The reason why the name of the enterprise or public institution is different from that in the SMS signature qualification"'."\n"
.'}'."\n"
."\n"
.'### 2. Notes'."\n"
."\n"
.'- If the content is not a variable, do not pass the `variableName` field.'."\n"
."\n"
.'- If the name of the enterprise or public institution is different from that in the SMS signature qualification, provide the `companyDifferentFromSignQuaReason` field.'."\n"
."\n"
.'- If `trafficDrivingType` is set to `DOMAIN`, you must provide all the fields.'."\n"
."\n"
.'- For `trafficDrivingType` values other than `DOMAIN`, the `trafficDrivingType`, `trafficDrivingContent`, `companyName`, and `organizationCode` fields are required. The `variableName` and `companyDifferentFromSignQuaReason` fields are optional.'."\n"
."\n"
.'### 3. TrafficDrivingType enumeration'."\n"
."\n"
.'><warning>'."\n"
."\n"
.'Due to regulatory requirements, mobile numbers are not supported.'."\n"
."\n"
.'></warning>'."\n"
."\n"
.'- `DOMAIN`: A domain name.'."\n"
."\n"
.'- `FIXED_PHONE`: A fixed-line phone number.'."\n"
."\n"
.'- `400_PHONE`: A phone number that starts with 400.'."\n"
."\n"
.'- `800_PHONE`: A phone number that starts with 800.'."\n"
."\n"
.'- `95_PHONE`: A phone number that starts with 95.'."\n"
."\n"
.'- `96_PHONE`: A phone number that starts with 96.'."\n"
."\n"
.'- `1_PHONE`: A 3-digit to 8-digit phone number that starts with 1.'."\n"
."\n"
.'- `OTHER_PHONE`: Another type of phone number.', '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":"这是一段说明文字"}]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The unique identifier of the request, generated by Alibaba Cloud. Use this request ID to troubleshoot issues.', 'type' => 'string', 'example' => '819BE656-D2E0-4858-8B21-B2E477085AA0', 'title' => ''],
'Code' => ['description' => 'The status code of the request. Valid values:'."\n"
."\n"
.'- `OK`: The request succeeds.'."\n"
."\n"
.'- For other error codes, see the **Error codes** section of this topic or the product [API error codes](~~101346~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'TemplateName' => ['description' => 'The name of the SMS template.', 'type' => 'string', 'example' => '验证码', 'title' => ''],
'TemplateCode' => ['description' => 'The template code.'."\n"
."\n"
.'After you submit a modified template for review, you can use the template code to call the [GetSmsTemplate](~~GetSmsTemplate~~) operation and query the review details. You can also [configure delivery receipts](https://help.aliyun.com/zh/sms/developer-reference/configure-delivery-receipts-1) to receive the review status in a [TemplateSmsReport](~~120999~~) message.', 'type' => 'string', 'example' => 'SMS_152550****', 'title' => ''],
'OrderId' => ['description' => 'The order ID.'."\n"
."\n"
.'Reviewers use this ID to query the review status. Provide this order ID if you request an expedited review.', 'type' => 'string', 'example' => '20041271****', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenAction', 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', 'description' => ''],
['errorCode' => 'AssocSignUnapproved', 'errorMessage' => 'Associated signature must be approved.', 'description' => 'The associated signature needs to use the approved signature.'],
['errorCode' => 'InvalidTemplateRule', 'errorMessage' => 'The template variable format is non-standard. Please refer to the variable format specifications in the help documentation.', 'description' => 'The template variable does not meet the specifications. Please check the SMS template specification document and pass in the template variable that meets the requirements.'],
['errorCode' => 'InvalidTemplateRule.Format', 'errorMessage' => 'The parameter TemplateRule format must be JSON.', 'description' => 'Template variable rules must be filled with JSON-formatted data.'],
['errorCode' => 'InvalidMoreData', 'errorMessage' => 'Specified parameter MoreData is not valid.', 'description' => 'The uploaded more information is invalid.'],
['errorCode' => 'TemplateVarLimitExceeded', 'errorMessage' => 'The verification code template only supports one variable.', 'description' => 'The verification code template only supports one variable.'],
['errorCode' => 'InvalidTemplateContent.Format', 'errorMessage' => 'Invalid template content format.', 'description' => 'The template content is not in the correct format.'],
['errorCode' => 'ServiceNotOpened', 'errorMessage' => 'This product service is not opened.', 'description' => 'Product service not activated'],
],
404 => [
['errorCode' => 'MissingTemplateName', 'errorMessage' => 'The template name cannot be empty.', 'description' => 'Template name cannot be empty.'],
['errorCode' => 'SmsSignatureNotFound', 'errorMessage' => 'The associated SMS signature does not exist.', 'description' => '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' => 'Update SMS Template (New Interface)',
'description' => '- For details about the changes to the signature and template APIs, see [Announcement on Updating Signature & Template APIs for Short Message Service](~~2806975~~).'."\n"
."\n"
.'- You can only modify templates that have failed review. For troubleshooting, see [Suggestions for handling failed SMS template reviews](~~65990~~). After modifying a template with this API, you must resubmit it for review.'."\n"
."\n"
.'- Template changes made using this API are synchronized with the Short Message Service console. To learn more about managing templates in the console, see [SMS templates](~~108085~~).'."\n"
."\n"
.'### QPS limit'."\n"
."\n"
.'The QPS limit for this API is 1,000 queries per second per user. If you exceed this limit, your API calls will be throttled. This can affect your business, so please use the API responsibly.',
'changeSet' => [
['createdAt' => '2025-08-12T14:41:32.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-08-12T14:41:26.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-08-12T14:37:16.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-08-12T14:37:06.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-08-12T14:37:03.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSmsTemplate'],
],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'dysms:UpdateSmsTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ValidPhoneCode' => [
'summary' => 'When applying for SMS qualification, the administrator\'s phone number must be verified. This operation verifies the phone number and the received verification code.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '264877',
'abilityTreeNodes' => ['FEATUREdysmsJ2BZAJ'],
],
'parameters' => [
[
'name' => 'PhoneNo',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The phone number.', 'type' => 'string', 'required' => true, 'example' => '137****1234'],
],
[
'name' => 'CertifyCode',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The verification code.', 'type' => 'string', 'required' => true, 'example' => '1234'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The details about the access denial. This field is returned only if the RAM check fails.', 'type' => 'string', 'example' => '无', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request. The ID is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****'."\n"],
'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Data' => [
'description' => 'Indicates whether the verification was successful. Valid values:'."\n"
."\n"
.'- **true**: The verification was successful.'."\n"
.'- **false**: The verification failed.',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
'Code' => ['description' => 'The status code of the request.'."\n"
."\n"
.'- A value of OK indicates that the request was successful.'."\n"
.'- For other error codes, see the error code list in this topic or the [Error codes](~~101346~~) of the product.', 'type' => 'string', 'title' => '', 'example' => 'OK'],
'Success' => [
'description' => 'Indicates whether the operation was successful. Valid values:'."\n"
."\n"
.'- true: The call was successful.'."\n"
.'- false: The call failed.',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'Verify the phone verification code',
'description' => '- Call the [RequiredPhoneCode](~~RequiredPhoneCode~~) operation first. Alibaba Cloud sends an SMS verification code to the phone number that you provided.'."\n"
.'- This operation does not affect the SMS qualification application process and is used only to verify the SMS verification code. When you submit the actual application, pass the verification code into the `CertifyCode` parameter of the [SubmitSmsQualification](~~SubmitSmsQualification~~) operation.',
'changeSet' => [
['createdAt' => '2025-08-01T04:05:19.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'dysms', 'title' => '短信服务'],
],
'ramActions' => [],
],
],
'endpoints' => [
['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dysmsapi.aliyuncs.com', 'endpoint' => 'dysmsapi.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dysmsapi.aliyuncs.com', 'endpoint' => 'dysmsapi.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dysmsapi.aliyuncs.com', 'endpoint' => 'dysmsapi.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dysmsapi.aliyuncs.com', 'endpoint' => 'dysmsapi.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dysmsapi.aliyuncs.com', 'endpoint' => 'dysmsapi.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dysmsapi.aliyuncs.com', 'endpoint' => 'dysmsapi.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dysmsapi.aliyuncs.com', 'endpoint' => 'dysmsapi.aliyuncs.com', 'vpc' => 'dysmsapi-xman.vpc-proxy.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dysmsapi.ap-southeast-1.aliyuncs.com', 'endpoint' => 'dysmsapi.ap-southeast-1.aliyuncs.com', 'vpc' => 'dysmsapi-xman.vpc-proxy.aliyuncs.com'],
['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dysmsapi.ap-southeast-5.aliyuncs.com', 'endpoint' => 'dysmsapi.ap-southeast-5.aliyuncs.com', 'vpc' => 'dysmsapi-xman-vpc.ap-southeast-5.aliyuncs.com'],
['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'dysmsapi.eu-central-1.aliyuncs.com', 'endpoint' => 'dysmsapi.eu-central-1.aliyuncs.com', 'vpc' => 'dysmsapi-xman-vpc.eu-central-1.aliyuncs.com'],
['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'dysmsapi.aliyuncs.com', 'endpoint' => 'dysmsapi.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'dysmsapi.aliyuncs.com', 'endpoint' => 'dysmsapi.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'dysmsapi.aliyuncs.com', 'endpoint' => 'dysmsapi.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'dysmsapi.aliyuncs.com', 'endpoint' => 'dysmsapi.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'dysmsapi.aliyuncs.com', 'endpoint' => 'dysmsapi.aliyuncs.com', 'vpc' => ''],
],
'errorCodes' => [
['code' => 'Account.Abnormal', 'message' => 'The status of Alibaba Cloud account is invalid.', 'http_code' => 400, 'description' => 'The account status is invalid.'],
['code' => 'AdminBackOssFileNotUploadError', 'message' => 'Administrator ID card portrait photo not uploaded.', 'http_code' => 400, 'description' => ''],
['code' => 'AdminDateNotValid', 'message' => 'Current time is outside the administrator ID card validity period.', 'http_code' => 400, 'description' => ''],
['code' => 'AdminFrontOssFileNotUploadError', 'message' => 'Administrator ID card national emblem photo not uploaded.', 'http_code' => 400, 'description' => ''],
['code' => 'AdminIdcardExpdateNotMatchRegexError', 'message' => 'Invalid administrator ID card expiration time format.', 'http_code' => 400, 'description' => ''],
['code' => 'AdminIdcardFrontFaceFileError', 'message' => 'Invalid format for administrator\'s ID card national emblem photo.', 'http_code' => 400, 'description' => ''],
['code' => 'AdminIdcardFrontFaceNullError', 'message' => 'Administrator\'s ID card national emblem photo cannot be empty.', 'http_code' => 400, 'description' => ''],
['code' => 'AdminIdcardNoNullError', 'message' => 'Administrator\'s ID number cannot be empty.', 'http_code' => 400, 'description' => ''],
['code' => 'AdminIdcardNotMatchRegex', 'message' => 'Invalid administrator ID number format.', 'http_code' => 400, 'description' => ''],
['code' => 'AdminIdcardPicsFileError', 'message' => 'Invalid format for administrator\'s ID card portrait photo.', 'http_code' => 400, 'description' => ''],
['code' => 'AdminIdcardPicsNullError', 'message' => 'Administrator\'s ID card portrait photo cannot be empty.', 'http_code' => 400, 'description' => ''],
['code' => 'AdminIdcardTypeError', 'message' => 'Invalid administrator ID card type.', 'http_code' => 400, 'description' => ''],
['code' => 'AdminNameNullError', 'message' => 'Administrator\'s name cannot be empty.', 'http_code' => 400, 'description' => ''],
['code' => 'Amount.NotEnough', 'message' => 'The account balance is insufficient.', 'http_code' => 400, 'description' => 'Your account balance is insufficient.'],
['code' => 'AssocSignUnapproved', 'message' => 'Associated signature must be approved.', 'http_code' => 400, 'description' => 'The associated signature needs to use the approved signature.'],
['code' => 'AuthorizationLetterDateNotMatchRegex', 'message' => 'The format of the authorization letter\'s effective and expiry date is incorrect.', 'http_code' => 400, 'description' => ''],
['code' => 'AuthorizationLetterDateNotValid', 'message' => 'The current time is not within the validity period of the authorization letter.', 'http_code' => 400, 'description' => ''],
['code' => 'AuthorizationLetterNameNotMatchRegex', 'message' => '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.', 'http_code' => 400, 'description' => ''],
['code' => 'AuthorizationLetterNameOverLimit', 'message' => 'The authorization letter name exceeds the 100-character length limit.', 'http_code' => 400, 'description' => ''],
['code' => 'AuthorizationLetterNameRepeat', 'message' => 'The authorization letter name is duplicated.', 'http_code' => 400, 'description' => ''],
['code' => 'AuthorizationNotMatchRegex', 'message' => '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.', 'http_code' => 400, 'description' => ''],
['code' => 'AuthorizationOssFileNotUploadError', 'message' => 'The authorization letter file has not been uploaded.', 'http_code' => 400, 'description' => ''],
['code' => 'AuthorizationOverLimit', 'message' => 'The authorizer exceeds the 1000-character length limit.', 'http_code' => 400, 'description' => ''],
['code' => 'BindSignDeleteFailed', 'message' => 'The qualification is bound to a signature and cannot be deleted temporarily.', 'http_code' => 400, 'description' => ''],
['code' => 'BusinessLicenseDateNotMatchRegexError', 'message' => 'Invalid business license expiration time format.', 'http_code' => 400, 'description' => ''],
['code' => 'BusinessLicenseDateNotValid', 'message' => 'Current time is outside the business license validity period.', 'http_code' => 400, 'description' => ''],
['code' => 'BusinessLicenseOssFileNotUploadError', 'message' => 'Business license file not uploaded.', 'http_code' => 400, 'description' => ''],
['code' => 'BusinessLicensePicsFileError', 'message' => 'Invalid business license file format.', 'http_code' => 400, 'description' => ''],
['code' => 'BusinessLicensePicsNullError', 'message' => 'Business license documents cannot be empty.', 'http_code' => 400, 'description' => ''],
['code' => 'BusinessLicenseTypeError', 'message' => 'Invalid business license type.', 'http_code' => 400, 'description' => ''],
['code' => 'card template.NotFound', 'message' => 'The resource of "card template" is not found..', 'http_code' => 400, 'description' => 'Card template not found'],
['code' => 'CertifyCodeError', 'message' => 'SMS verification code is incorrect.', 'http_code' => 400, 'description' => ''],
['code' => 'CompanyNameNullError', 'message' => 'Company name cannot be empty.', 'http_code' => 400, 'description' => ''],
['code' => 'CompanyTypeError', 'message' => 'Invalid company type.', 'http_code' => 400, 'description' => ''],
['code' => 'CompanyVerificationFailedCompanyStateInvalid', 'message' => 'Four Elements Verification Failed: Company is not in normal operation.', 'http_code' => 400, 'description' => ''],
['code' => 'CompanyVerificationFailedFourElementsError', 'message' => 'Four Elements Verification Failed: Authentication Failed.', 'http_code' => 400, 'description' => ''],
['code' => 'CompanyVerificationFailedMismatch', 'message' => 'Four Elements Verification Failed: Mismatch between Legal Representative and Company Information.', 'http_code' => 400, 'description' => 'The verification of the four elements of the enterprise fails, and the verification of the legal person and the enterprise information is inconsistent.'],
['code' => 'CompanyVerificationFailedNoCompany', 'message' => 'Four Elements Verification Failed: Company Not Found.', 'http_code' => 400, 'description' => ''],
['code' => 'CompanyVerificationFailedNoLegalPerson', 'message' => 'Four Elements Verification Failed: Legal Representative Not Found.', 'http_code' => 400, 'description' => ''],
['code' => 'CustNotExistError', 'message' => 'Customer\'s cloud communication information is invalid.', 'http_code' => 400, 'description' => ''],
['code' => 'DayLimitControl', 'message' => 'The daily volume limit is exceeded.', 'http_code' => 400, 'description' => 'The number of the sent messages has exceeded the daily limit.'],
['code' => 'ERROR_PARTNER_ID', 'message' => '查询影子pid结果为空或者异常', 'http_code' => 200, 'description' => 'the shadow pid query result is empty or abnormal.'],
['code' => 'ExtCodeInactive', 'message' => 'No major customer extension code has been activated.', 'http_code' => 400, 'description' => 'Large customer extension code not turned on'],
['code' => 'ExtCodeIsActive', 'message' => 'The custom extension code is in use and cannot be modified.', 'http_code' => 400, 'description' => 'The custom extension code is in use and cannot be modified.'],
['code' => 'ExtCodeNotFound', 'message' => 'Custom extension code does not exist.', 'http_code' => 400, 'description' => 'Custom extension code does not exist'],
['code' => 'ExtCodeNotReady', 'message' => 'The custom extension code control has not been fully implemented. Please try again later.', 'http_code' => 400, 'description' => 'Custom extension code control is not effective, please try again later'],
['code' => 'FILTER', 'message' => '关键字拦截', 'http_code' => 400, 'description' => 'We recommend that you modify the message content.'],
['code' => 'Forbidden.Operation', 'message' => 'You are not authorized to perform the operation.', 'http_code' => 400, 'description' => 'You are not authorized to perform this operation.'],
['code' => 'ForbiddenAction', 'message' => 'Access to the account is denied. Please contact the administrator.', 'http_code' => 200, 'description' => 'No access, please contact administrator.'],
['code' => 'GrayCustAccessError', 'message' => 'This customer is not authorized to use the OpenAPI. Please contact support for whitelisting.', 'http_code' => 400, 'description' => ''],
['code' => 'IntlSmsService.Unvalabe', 'message' => 'The international SMS service has not been activated. You cannot create an international SMS template.', 'http_code' => 400, 'description' => 'The international SMS service has not been activated. You cannot create an international SMS template.'],
['code' => 'InvalidAction.NotFound', 'message' => 'The specified API is not found.', 'http_code' => 400, 'description' => 'The specified API action is not found'],
['code' => 'InvalidApplySceneContent', 'message' => 'For certain signature sources, the '."\n"
.'applySceneContent should be an HTTP or HTTPS link.', 'http_code' => 400, 'description' => 'invalid application scenario, under some signature sources,'."\n"
.'The application scenario should be an HTTP or HTTPS link.'],
['code' => 'InvalidApplySceneContent', 'message' => 'For certain signature sources, the '."\n"
.'applySceneContent should be an HTTP or HTTPS link.', 'http_code' => 400, 'description' => 'invalid application scenario. under some signature sources, the application scenario should be an http or https link.'],
['code' => 'InvalidMoreData', 'message' => 'Specified parameter MoreData is not valid.', 'http_code' => 400, 'description' => 'The uploaded more information is invalid.'],
['code' => 'InvalidParam.PageSize', 'message' => 'PageSize must be less than or equal to 50.', 'http_code' => 400, 'description' => 'pageSize must be less than or equal to 50'],
['code' => 'InvalidParam.PhoneNumber', 'message' => 'Incorrect phone number format.', 'http_code' => 400, 'description' => 'Incorrect phone number format'],
['code' => 'InvalidParam.SendDate', 'message' => 'Only the last 30 days can be queried.', 'http_code' => 400, 'description' => 'Only the data of the last 30 days can be queried'],
['code' => 'InvalidParameter', 'message' => 'Parameter invalid.', 'http_code' => 400, 'description' => 'Parameter error, please check the parameter'],
['code' => 'InvalidParameter', 'message' => 'At most, only one parameter can be passed among bizCardId, bizSmsId, and bizDigitId.', 'http_code' => 400, 'description' => 'At most, only one parameter can be passed among bizCardId, bizSmsId, and bizDigitId.'],
['code' => 'InvalidParameter.Channel', 'message' => 'The specified Channel is invalid.', 'http_code' => 400, 'description' => 'The value of the Channel parameter is invalid.'],
['code' => 'InvalidParameter.endDate', 'message' => 'The specified parameter endDate is not valid.', 'http_code' => 400, 'description' => 'The input parameter endDate does not meet the parameter specification.'],
['code' => 'InvalidParameter.ExternalId', 'message' => 'The specified ExternalId is invalid.', 'http_code' => 400, 'description' => 'The value of the ExternalId parameter is invalid.'],
['code' => 'InvalidParameter.From', 'message' => 'The specified From is invalid.', 'http_code' => 400, 'description' => 'The value of the From parameter is invalid.'],
['code' => 'InvalidParameter.pageSize', 'message' => 'PageSize must be less than or equal to 50.', 'http_code' => 400, 'description' => 'pageSize must be less than or equal to 50'],
['code' => 'InvalidParameter.phoneNumber', 'message' => 'Incorrect phone number format.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidParameter.sendDate', 'message' => 'Only the last 30 days can be queried.', 'http_code' => 400, 'description' => 'Only the data of the last 30 days can be queried'],
['code' => 'InvalidParameter.SenderId', 'message' => 'The specified SenderId is invalid.', 'http_code' => 400, 'description' => 'The value of the SenderId parameter is invalid.'],
['code' => 'InvalidParameter.SMS_CARD_MESSAGE NO ACCESS', 'message' => 'The user has not activated card SMS within the SMS service.', 'http_code' => 400, 'description' => 'The user has not activated the card SMS in the SMS service.'],
['code' => 'InvalidParameter.To', 'message' => 'The specified To is invalid.', 'http_code' => 400, 'description' => 'The value of the To parameter is invalid.'],
['code' => 'InvalidParameter.To', 'message' => 'The specified parameter To is not valid.', 'http_code' => 400, 'description' => 'The to field of the passed-in parameter is invalid.'],
['code' => 'InvalidParameter.Type', 'message' => 'The specified Type is invalid.', 'http_code' => 400, 'description' => 'The value of the Type parameter is invalid.'],
['code' => 'InvalidQualification', 'message' => 'The qualification should be approved.', 'http_code' => 400, 'description' => 'Invalid qualification, qualification should be approved.'],
['code' => 'InvalidSignName', 'message' => 'The signature cannot contain spaces, special '."\n"
.'symbols, or all numbers.', 'http_code' => 400, 'description' => 'The signature cannot contain special characters such as simplified Chinese, English, or spaces other than digits, and cannot be all digits.'],
['code' => 'InvalidTemplateContent.Format', 'message' => 'Invalid template content format.', 'http_code' => 400, 'description' => 'The template content is not in the correct format.'],
['code' => 'InvalidTemplateRule', 'message' => 'The template variable format is non-standard. Please refer to the variable format specifications in the help documentation.', 'http_code' => 400, 'description' => 'The template variable does not meet the specifications. Please check the SMS template specification document and pass in the template variable that meets the requirements.'],
['code' => 'InvalidTemplateRule.Format', 'message' => 'The template variable does not conform to the specification, please check the https://help.aliyun.com/zh/sms/user-guide/message-template-specifications/.', 'http_code' => 400, 'description' => 'The template variable does not conform to the specification, please check the https://help.aliyun.com/zh/sms/user-guide/message-template-specifications/'],
['code' => 'InvalidTemplateRule.Format', 'message' => 'The parameter TemplateRule format must be JSON.', 'http_code' => 400, 'description' => 'Template variable rules must be filled with JSON-formatted data.'],
['code' => 'InvalidTimeStamp.Expired', 'message' => 'The specified timestamp has expired.', 'http_code' => 400, 'description' => 'The specified timestamp is expired'],
['code' => 'InvalidVersion', 'message' => 'Invalid API version.', 'http_code' => 400, 'description' => 'The specified API version is invalid'],
['code' => 'INVALID_PARAMETERS', 'message' => 'The format of MessageId is wrong.', 'http_code' => 200, 'description' => 'The parameter is incorrect. Check whether the parameter is correct.'],
['code' => 'isp.GATEWAY_ERROR', 'message' => 'Unexpected gateway error.', 'http_code' => 400, 'description' => 'Unexpected gateway error'],
['code' => 'isp.RAM_PERMISSION_DENY', 'message' => 'RAM权限DENY', 'http_code' => 400, 'description' => 'We recommend that you contact SMS technical support to fix the issue.'],
['code' => 'isp.RAM_PERMISSION_DENY', 'message' => 'The RAM user is not authorized.', 'http_code' => 400, 'description' => 'The RAM user is not authorized.'],
['code' => 'isp.SYSTEM_ERROR', 'message' => '系统错误', 'http_code' => 500, 'description' => 'We recommend that you contact SMS technical support to fix the issue.'],
['code' => 'isp.SYSTEM_ERROR', 'message' => 'A system error occurred.', 'http_code' => 500, 'description' => 'Unexpected system error occurred'],
['code' => 'isv.ACCOUNT_ABNORMAL', 'message' => '账户异常', 'http_code' => 400, 'description' => 'We recommend that you contact SMS technical support to confirm your account.'],
['code' => 'isv.ACCOUNT_ABNORMAL', 'message' => 'The account is in an abnormal state.', 'http_code' => 400, 'description' => 'The specified account status is abnormal'],
['code' => 'isv.ACCOUNT_NOT_EXISTS', 'message' => 'Account not found', 'http_code' => 404, 'description' => 'We recommend that you open an account.'],
['code' => 'isv.ACCOUNT_NOT_EXISTS', 'message' => 'The specified account does not exist.', 'http_code' => 400, 'description' => 'The specified account does not exist.'],
['code' => 'isv.AMOUNT_NOT_ENOUGH', 'message' => '账户余额不足', 'http_code' => 400, 'description' => 'We recommend that you add funds to the account.'],
['code' => 'isv.AMOUNT_NOT_ENOUGH', 'message' => 'The resource plan is unavailable or your account does not have a sufficient balance.', 'http_code' => 400, 'description' => 'The resource plan is unavailable or your account does not have a sufficient balance.'],
['code' => 'isv.BLACK_KEY_CONTROL_LIMIT', 'message' => '黑名单管控', 'http_code' => 400, 'description' => 'We recommend that you contact SMS technical support to remove your account from the blacklist.'],
['code' => 'isv.BLACK_KEY_CONTROL_LIMIT', 'message' => 'The specified template variable includes one or more blocked keywords.', 'http_code' => 400, 'description' => 'The specified template variable includes one or more blocked keywords.'],
['code' => 'isv.BUSINESS_LIMIT_CONTROL', 'message' => '业务限流', 'http_code' => 403, 'description' => 'We recommend that you contact SMS technical support to fix the issue.'],
['code' => 'isv.BUSINESS_LIMIT_CONTROL', 'message' => 'Cloud communications throttling has been triggered.', 'http_code' => 400, 'description' => 'The business limit is reached'],
['code' => 'isv.CUSTOMER_REFUSED', 'message' => 'The user refuses to receive marketing messages.', 'http_code' => 400, 'description' => 'Customer refused to receive specified MKT sms'],
['code' => 'isv.DAY_LIMIT_CONTROL', 'message' => 'The daily threshold of the messages that the user can send has been reached.', 'http_code' => 400, 'description' => 'The daily threshold of the messages that the user can send has been reached.'],
['code' => 'isv.DENY_IP_RANGE', 'message' => 'SMS does not support the region with the source IP address.', 'http_code' => 400, 'description' => 'Not supported source IP range for SMS'],
['code' => 'isv.DOMESTIC_NUMBER_NOT_SUPPORTED', 'message' => 'Templates for regions outside the Chinese mainland cannot be used for messages sent to numbers in the Chinese mainland.', 'http_code' => 400, 'description' => 'International template is not supported for China-mainland number'],
['code' => 'isv.ERROR_EMPTY_FILE', 'message' => 'The file uploaded is empty.', 'http_code' => 400, 'description' => 'The file uploaded is empty'],
['code' => 'isv.ERROR_SIGN_NOT_DELETE', 'message' => 'Signatures pending approval cannot be deleted.', 'http_code' => 400, 'description' => 'Not allow to delete sign name in approval process'],
['code' => 'isv.ERROR_SIGN_NOT_MODIFY', 'message' => 'Effective signatures cannot be modified.', 'http_code' => 400, 'description' => 'Not allow to modify effective sign name'],
['code' => 'isv.ERROR_TEMPLATE_NOT_DELETE', 'message' => 'Templates pending approval cannot be deleted.', 'http_code' => 400, 'description' => 'Not allow to delete template in approval process'],
['code' => 'isv.ERROR_TEMPLATE_NOT_MODIFY', 'message' => 'Approved templates cannot be modified.', 'http_code' => 400, 'description' => 'Not allow to modify template effective process'],
['code' => 'isv.EXTEND_CODE_ERROR', 'message' => 'SmsUpExtendCode should be unique for each signature.', 'http_code' => 400, 'description' => 'SmsUpExtendCode should be unique for each sign name'],
['code' => 'ISV.Forbidden', 'message' => 'SubUser not authorized to operate on the specified resource.', 'http_code' => 200, 'description' => ''],
['code' => 'isv.INVALID_JSON_PARAM', 'message' => '参数格式错误,请修改为字符串值', 'http_code' => 400, 'description' => 'The specified parameter is invalid. Change the parameter value to a character string.'],
['code' => 'isv.INVALID_JSON_PARAM', 'message' => 'The JSON string failed to be parsed.', 'http_code' => 400, 'description' => 'The JSON string failed to be parsed.'],
['code' => 'isv.INVALID_PARAMETERS', 'message' => '参数异常', 'http_code' => 400, 'description' => 'We recommend that you specify valid parameters.'],
['code' => 'isv.INVALID_PARAMETERS', 'message' => 'The input parameters are invalid.', 'http_code' => 400, 'description' => 'The input parameters are invalid.'],
['code' => 'isv.MOBILE_COUNT_OVER_LIMIT', 'message' => '手机号码数量超过限制', 'http_code' => 400, 'description' => 'We recommend that you reduce mobile phone numbers.'],
['code' => 'isv.MOBILE_COUNT_OVER_LIMIT', 'message' => 'The number of mobile phone numbers exceeds 1,000.', 'http_code' => 400, 'description' => 'The number of mobile phone numbers exceeds 1,000.'],
['code' => 'isv.MOBILE_NUMBER_ILLEGAL', 'message' => '手机号码格式错误', 'http_code' => 400, 'description' => 'We recommend that you specify valid mobile phone numbers.'],
['code' => 'isv.MOBILE_NUMBER_ILLEGAL', 'message' => 'The format of the specified mobile phone number is invalid.', 'http_code' => 400, 'description' => 'The format of the specified mobile phone number is invalid.'],
['code' => 'isv.NOT_SUPPORTED_COUNTRY', 'message' => '暂不支持该国家的国际短信发送', 'http_code' => 400, 'description' => 'The international SMS sending of this country is not supported.'],
['code' => 'isv.NO_AVAILABLE_SHORT_URL', 'message' => 'No available short URLs in the account.', 'http_code' => 400, 'description' => 'No available short URL found'],
['code' => 'isv.OUT_OF_SERVICE', 'message' => '业务停机', 'http_code' => 400, 'description' => 'We recommend that you contact SMS technical support to fix the issue.'],
['code' => 'isv.OUT_OF_SERVICE', 'message' => 'The account has been out of service due to insufficient balance.', 'http_code' => 400, 'description' => 'Account is out of service due to insufficient balance'],
['code' => 'isv.PARAM_LENGTH_LIMIT', 'message' => '参数超出长度限制', 'http_code' => 400, 'description' => 'We recommend that you modify the parameter length.'],
['code' => 'isv.PARAM_LENGTH_LIMIT', 'message' => 'The length of the specified variable exceeds the limit.', 'http_code' => 400, 'description' => 'The length of the specified variable exceeds the limit.'],
['code' => 'isv.PARAM_NOT_SUPPORT_URL', 'message' => '变量不支持传入URL', 'http_code' => 400, 'description' => 'URLs are not allowed in variables.'],
['code' => 'isv.PARAM_NOT_SUPPORT_URL', 'message' => 'URLs cannot be specified for the parameter.', 'http_code' => 400, 'description' => 'Not support URL in parameter'],
['code' => 'isv.PHONENUMBERS_OVER_LIMIT', 'message' => 'The number of mobile phone numbers exceeds 50,000.', 'http_code' => 400, 'description' => 'The number of mobile phone numbers exceeds 50,000.'],
['code' => 'isv.PRODUCT_UNSUBSCRIBE', 'message' => '产品未开通', 'http_code' => 400, 'description' => 'We recommend that you purchase the service.'],
['code' => 'isv.PRODUCT_UNSUBSCRIBE', 'message' => 'SMS has not been activated.', 'http_code' => 400, 'description' => 'SMS service not activated'],
['code' => 'isv.PRODUCT_UN_SUBSCRIPT', 'message' => '未开通云通信产品的阿里云客户', 'http_code' => 401, 'description' => 'We recommend that you activate Cloud Communications.'],
['code' => 'isv.PRODUCT_UN_SUBSCRIPT', 'message' => 'SMS has not been activated.', 'http_code' => 400, 'description' => 'SMS service not activated'],
['code' => 'ISV.PRODUCT_UN_SUBSCRIPT', 'message' => 'SMS service not activated.', 'http_code' => 200, 'description' => 'Alibaba Cloud customers who have not activated cloud communication products'],
['code' => 'isv.SECURITY_FROZEN_ACCOUNT', 'message' => 'The specified account has been frozen.', 'http_code' => 400, 'description' => 'The specified account is frozen'],
['code' => 'isv.SHORTURL_DOMAIN_EMPTY', 'message' => '创建失败,请先提交该链接的一级域名报备', 'http_code' => 200, 'description' => 'Create failed. Submit your original domain name for approval first.'],
['code' => 'isv.SHORTURL_DOMAIN_EMPTY', 'message' => 'Unregistered original URL domain.', 'http_code' => 400, 'description' => 'Unregistered original URL domain'],
['code' => 'isv.SHORTURL_NAME_ILLEGAL', 'message' => '短链服务名称不能超过13个字符长度', 'http_code' => 200, 'description' => 'The activity name of the short URL cannot exceed 13 characters in length.'],
['code' => 'isv.SHORTURL_NAME_ILLEGAL', 'message' => 'A short URL name can contain a maximum of 13 characters.', 'http_code' => 400, 'description' => 'Short URL name over max length'],
['code' => 'isv.SHORTURL_NOT_FOUND', 'message' => '没有可删除的短链', 'http_code' => 200, 'description' => 'No short URL can be deleted.'],
['code' => 'isv.SHORTURL_OVER_LIMIT', 'message' => 'The maximum number of short URLs that can be applied in a day has been exceeded.', 'http_code' => 400, 'description' => 'The max count of short URL registered daily is reached'],
['code' => 'isv.SHORTURL_STILL_AVAILABLE', 'message' => '原始链接生成的短链仍在有效期内', 'http_code' => 200, 'description' => 'The short URL is still valid.'],
['code' => 'isv.SHORTURL_STILL_AVAILABLE', 'message' => 'The short URL is still within the effective period.', 'http_code' => 400, 'description' => 'The short URL is still available'],
['code' => 'isv.SHORTURL_TIME_ILLEGAL', 'message' => '短链有效期期限超过限制', 'http_code' => 200, 'description' => 'The validity period of the short URL is valid.'],
['code' => 'isv.SHORTURL_TIME_ILLEGAL', 'message' => 'EffectiveDays is over the limit.', 'http_code' => 400, 'description' => 'Over the max EffectiveDays'],
['code' => 'isv.SHORTURL_URL_NAME_REPEAT', 'message' => '短链服务名称重复', 'http_code' => 200, 'description' => 'The activity name of the short URL already exists.'],
['code' => 'isv.SIGN_COUNT_OVER_LIMIT', 'message' => 'The maximum number of signatures that can be applied in a day has been exceeded.', 'http_code' => 400, 'description' => 'The max count of sign name registered daily is reached'],
['code' => 'isv.SIGN_FILE_LIMIT', 'message' => 'The specified file is over the size limit.', 'http_code' => 400, 'description' => 'The specified file is over max size'],
['code' => 'isv.SIGN_NAME_ILLEGAL', 'message' => 'The specified signature does not exist or is blocked.', 'http_code' => 400, 'description' => 'The specified signature does not exist or is blocked.'],
['code' => 'isv.SIGN_OVER_LIMIT', 'message' => 'The maximum number of signatures has been exceeded.', 'http_code' => 400, 'description' => 'The specified signature over max length'],
['code' => 'isv.SMS_CONTENT_ILLEGAL', 'message' => 'The message content is invalid.', 'http_code' => 400, 'description' => 'The message content is invalid.'],
['code' => 'isv.SMS_OVER_LIMIT', 'message' => 'A maximum of 100 templates or signatures can be applied.', 'http_code' => 400, 'description' => 'The max count of sign name or template registered daily is reached'],
['code' => 'isv.SMS_OVER_LIMIT', 'message' => '单日最多申请模板或签名100条', 'http_code' => 200, 'description' => 'Apply for up to 100 templates or signatures in a single day.'],
['code' => 'isv.SMS_SIGNATURE_ILLEGAL', 'message' => '该账号下找不到对应签名', 'http_code' => 400, 'description' => 'The specified signature is not found in the account.'],
['code' => 'isv.SMS_SIGNATURE_ILLEGAL', 'message' => 'The specified signature does not exist or is blocked.', 'http_code' => 400, 'description' => 'The specified signature does not exist or is blocked.'],
['code' => 'isv.SMS_SIGNATURE_SCENE_ILLEGAL', 'message' => 'The signature and template type does not match.', 'http_code' => 400, 'description' => 'Sign Name type and template type mismatch'],
['code' => 'isv.SMS_SIGN_EMOJI_ILLEGAL', 'message' => 'Emojis are not supported.', 'http_code' => 400, 'description' => 'Emoji is not supported'],
['code' => 'isv.SMS_SIGN_ILLEGAL', 'message' => 'The specified signature does not exist or is blocked.', 'http_code' => 400, 'description' => 'The specified signature does not exist or is blocked.'],
['code' => 'isv.SMS_TEMPLATE_ILLEGAL', 'message' => '该账号下找不到对应模板', 'http_code' => 400, 'description' => 'The specified template is not found in the account.'],
['code' => 'isv.SMS_TEMPLATE_ILLEGAL', 'message' => 'The specified message template does not exist or is blocked.', 'http_code' => 400, 'description' => 'The specified message template does not exist or is blocked.'],
['code' => 'isv.SMS_TEST_NUMBER_LIMIT', 'message' => 'Test templates can only be sent to authorized phone numbers.', 'http_code' => 400, 'description' => 'Test template can not send to authorized phone'],
['code' => 'isv.SMS_TEST_SIGN_TEMPLATE_LIMIT', 'message' => 'Test signatures must be used together with test templates.', 'http_code' => 400, 'description' => 'Test sign name must use together with test template'],
['code' => 'isv.SMS_TEST_TEMPLATE_PARAMS_ILLEGAL', 'message' => 'Parameters in test templates support only numeric values that consist of 4 to 6 digits.', 'http_code' => 400, 'description' => 'Only 4~6 numeric supported for test template'],
['code' => 'isv.SOURCEURL_OVER_LIMIT', 'message' => 'The maximum number of characters in a source URL name has been exceeded.', 'http_code' => 400, 'description' => 'Source URL name over max length'],
['code' => 'isv.TEMPLATE_COUNT_OVER_LIMIT', 'message' => 'The maximum number of templates that can be applied in a day has been reached.', 'http_code' => 400, 'description' => 'The max count of template registered daily is reached'],
['code' => 'isv.TEMPLATE_MISSING_PARAMETERS', 'message' => 'The variable in the template is empty.', 'http_code' => 400, 'description' => 'The variable in the template is empty.'],
['code' => 'isv.TEMPLATE_OVER_LIMIT', 'message' => 'The maximum number of characters in a template has been exceeded.', 'http_code' => 400, 'description' => 'The specified template content over max length'],
['code' => 'isv.TEMPLATE_PARAMS_ILLEGAL', 'message' => '模版变量里包含非法字符,如emoji表情等', 'http_code' => 400, 'description' => 'Template parameters include invalid characters such as emojis.'],
['code' => 'isv.TEMPLATE_PARAMS_ILLEGAL', 'message' => 'The specified parameter value is of an invalid type.', 'http_code' => 400, 'description' => 'The input parameters are invalid is miss matched with template'],
['code' => 'lc.INVOKE_HSF_ERROR', 'message' => '[lc.INVOKE_HSF_ERROR].', 'http_code' => 500, 'description' => 'Call interface exception'],
['code' => 'LegalBackOssFileNotUploadError', 'message' => 'Legal person ID card portrait photo not uploaded.', 'http_code' => 400, 'description' => ''],
['code' => 'LegalDateNotValid', 'message' => 'Current time is outside the legal person ID card validity period.', 'http_code' => 400, 'description' => ''],
['code' => 'LegalFrontOssFileNotUploadError', 'message' => 'Legal person ID card national emblem photo not uploaded.', 'http_code' => 400, 'description' => ''],
['code' => 'LegalIdCardNoNullError', 'message' => 'Legal person\'s ID number cannot be empty.', 'http_code' => 400, 'description' => ''],
['code' => 'LegalIdCardNotMatchRegex', 'message' => 'Invalid legal person ID number format.', 'http_code' => 400, 'description' => ''],
['code' => 'LegalPersonIdcardEfftimeNotMatchRegexError', 'message' => 'Invalid legal person ID card expiration time format.', 'http_code' => 400, 'description' => ''],
['code' => 'LegalPersonIdcardTypeError', 'message' => 'Invalid legal person ID card type.', 'http_code' => 400, 'description' => ''],
['code' => 'LegalPersonNameNullError', 'message' => 'Legal person\'s name cannot be empty.', 'http_code' => 400, 'description' => ''],
['code' => 'MissApplySceneContent', 'message' => 'In some signature sources, the applySceneContent is required.', 'http_code' => 400, 'description' => 'Under some signature sources, the application scenario is required.'],
['code' => 'MissingParameter', 'message' => 'The ResourceId and Tag lists cannot be empty at the same time.', 'http_code' => 400, 'description' => 'Resource list (ResourceId) and tag list (Tag) cannot be empty at the same time'],
['code' => 'MissingParameter.id', 'message' => 'Parameter "id" which is mandatory for the request is not provided.', 'http_code' => 400, 'description' => 'The request is missing the required parameter id field'],
['code' => 'MissingParameter.Message', 'message' => 'You must specify Message.', 'http_code' => 400, 'description' => 'The Message parameter is missing.'],
['code' => 'MissingParameter.To', 'message' => 'You must specify To.', 'http_code' => 400, 'description' => 'The To parameter is missing.'],
['code' => 'MissingSignName', 'message' => 'The signature name cannot be empty.', 'http_code' => 400, 'description' => 'Signature name cannot be empty'],
['code' => 'MissingTemplateName', 'message' => 'The template name cannot be empty.', 'http_code' => 404, 'description' => 'Template name cannot be empty.'],
['code' => 'MonthLimitControl', 'message' => 'The monthly volume limit is exceeded.', 'http_code' => 400, 'description' => 'The number of the sent messages has exceeded the monthly limit.'],
['code' => 'NotEnterpriseCertifyCustCheckError', 'message' => 'Non-enterprise certified customers are not allowed to access.', 'http_code' => 400, 'description' => ''],
['code' => 'OneExtCodeMultipleSign', 'message' => 'One code with multiple signature error, please verify.', 'http_code' => 400, 'description' => 'One extension code multiple sign error, please check'],
['code' => 'OrderDefinition.NotExist', 'message' => 'The work order scenario definition does not exist.', 'http_code' => 400, 'description' => 'Job scene definition does not exist'],
['code' => 'OrganizationCodeNullError', 'message' => 'Unified Social Credit Code cannot be empty.', 'http_code' => 400, 'description' => ''],
['code' => 'OrganizationCodeOverLimit', 'message' => 'The organization code is limited to 150 characters.', 'http_code' => 400, 'description' => 'Social credit code is not allowed to exceed 150 characters'],
['code' => 'OssBiztypeNotSupportError', 'message' => 'Retrieving OSS configuration does not support this biz type.', 'http_code' => 400, 'description' => ''],
['code' => 'OtherFileTypeError', 'message' => 'Invalid file format for other documents.', 'http_code' => 400, 'description' => ''],
['code' => 'OtherOssFileNotUploadError', 'message' => 'Other files not uploaded.', 'http_code' => 400, 'description' => ''],
['code' => 'OutOfService', 'message' => 'The account is suspended.', 'http_code' => 400, 'description' => ''],
['code' => 'ParameterMismatch.ThirdParty', 'message' => 'The type of signature, whether for personal use or for a third party, should be consistent with the qualifications.', 'http_code' => 400, 'description' => 'Whether the signature is used by a third party should be consistent with the qualification.'],
['code' => 'PARAMS_ILLEGAL', 'message' => 'Invalid parameter value.', 'http_code' => 400, 'description' => 'The parameter input is invalid'],
['code' => 'PhoneNoCertifyCodeNullError', 'message' => 'Phone number and verification code cannot be empty.', 'http_code' => 400, 'description' => ''],
['code' => 'PhoneNumber.Illegal', 'message' => 'The specified phone number is invalid.', 'http_code' => 400, 'description' => 'The mobile phone number is invalid.'],
['code' => 'ProxyAuthorizationNotMatchRegex', 'message' => 'The authorized party name currently does not support any symbols except middle dots, spaces, Chinese brackets, and English parentheses or purely numeric input.', 'http_code' => 400, 'description' => ''],
['code' => 'ProxyAuthorizationOverLimit', 'message' => 'The authorized party exceeds the 1000-character length limit.', 'http_code' => 400, 'description' => ''],
['code' => 'QualificationNameAlreadyExist', 'message' => 'The qualification name already exists. Please modify and resubmit.', 'http_code' => 400, 'description' => ''],
['code' => 'QualificationNameNotMatchRegex', 'message' => 'Qualification names must be in Chinese, English, or alphanumeric combinations. Symbols or pure numbers are not supported.', 'http_code' => 400, 'description' => ''],
['code' => 'QualificationNameNullError', 'message' => 'Qualification name cannot be empty.', 'http_code' => 400, 'description' => ''],
['code' => 'QualificationNotComplete', 'message' => 'The qualification elements are incomplete.', 'http_code' => 400, 'description' => 'The qualification elements are incomplete, and the missing elements are []'],
['code' => 'QualificationNotExist', 'message' => 'Can\'t query qualification information.', 'http_code' => 400, 'description' => 'Can\'t query qualification information'],
['code' => 'QualificationNotExist', 'message' => 'Qualification does not exist.', 'http_code' => 400, 'description' => ''],
['code' => 'QualificationNotFound', 'message' => 'Qualification does not exist.', 'http_code' => 404, 'description' => 'Qualification does not exist.'],
['code' => 'SameQualificationGroupError', 'message' => 'A qualification with the same company and administrator information already exists.', 'http_code' => 400, 'description' => ''],
['code' => 'ServiceNotOpened', 'message' => 'This product service is not opened.', 'http_code' => 400, 'description' => 'Product service not activated'],
['code' => 'SignatureDoesNotMatch', 'message' => 'The signature generated by the client does not match the server.', 'http_code' => 400, 'description' => 'Signature does not matches'],
['code' => 'SignatureNonceUsed', 'message' => 'The specified signature has been used.', 'http_code' => 400, 'description' => 'The specified signature is been used'],
['code' => 'SignatureNotFound', 'message' => 'The signature does not exist.', 'http_code' => 404, 'description' => 'The corresponding signature cannot be found under the account.'],
['code' => 'SIGNATURE_BLACKLIST', 'message' => 'The sign name is intercepted based on the specified risk control strategies.', 'http_code' => 400, 'description' => 'The sign name is intercepted based on the specified risk control strategies.'],
['code' => 'SignName.Exists', 'message' => 'Sorry, this signature already exists and cannot be applied for again.', 'http_code' => 400, 'description' => 'Sorry, this signature already exists and cannot be reapplied.'],
['code' => 'SignNotMatchRegex', 'message' => 'The signature length is limited to 2-12 characters and does not support some special characters.', 'http_code' => 400, 'description' => ''],
['code' => 'SignNumOverLimit', 'message' => 'The signature exceeds the limit of 100 entries.', 'http_code' => 400, 'description' => ''],
['code' => 'SmsAuthorizationLetterNotExist', 'message' => 'Authorization does not belong to the customer.', 'http_code' => 400, 'description' => ''],
['code' => 'SmsAuthorizationLetterNotMatch', 'message' => 'Please bind the available authorization letter whose the social credit code is same to the the social credit code of qualification.', 'http_code' => 400, 'description' => 'Please bind the available authorization letter whose the social credit code is same to the the social credit code of qualification'],
['code' => 'SmsPassedAuthorizationLetterNotMatch', 'message' => 'Please bind audited authorization letter whose the social credit code is same to the the social credit code of qualification.', 'http_code' => 400, 'description' => 'Please bind and unify the qualification authorization letter with the same and available social credit code.'."\n"],
['code' => 'SmsQualificationNotPassed', 'message' => 'The qualification has not been approved and cannot be bound to the signature.', 'http_code' => 400, 'description' => 'The qualification has not been approved and cannot be bound to the signature.'],
['code' => 'SmsQualificationRegisterFailed', 'message' => 'The registration of the current qualification fails. Please modify the qualification and re-bind the qualification before completing the signature registration process again.', 'http_code' => 400, 'description' => 'The registration of the current qualification fails. Please modify the qualification and re-bind the qualification before completing the signature registration process again.'],
['code' => 'SmsSignatureNotExist', 'message' => 'Signature does not exist.', 'http_code' => 400, 'description' => 'Signature does not exist'],
['code' => 'SmsSignatureNotFound', 'message' => 'The associated SMS signature does not exist.', 'http_code' => 404, 'description' => 'The associated SMS signature does not exist.'],
['code' => 'SmsSignNotAuthorized', 'message' => 'The signature is not within the scope of the authorization.', 'http_code' => 400, 'description' => 'The signature is not within the scope of the authorization.'],
['code' => 'SmsSignNotAuthorized', 'message' => 'the signature is not in the sign scope of the authorization letter.', 'http_code' => 400, 'description' => 'The signature is not within the scope of the authorization.'],
['code' => 'SMS_STATUS_ILLEGAL', 'message' => 'When replacing the qualification and power of attorney of the signature, the signature status must be approved.', 'http_code' => 400, 'description' => 'When replacing the qualification and power of attorney of the signature, the signature status must be approved.'],
['code' => 'TemplateNotFound', 'message' => 'The template does not exist.', 'http_code' => 404, 'description' => ''],
['code' => 'TemplateParameterCountIllegal', 'message' => 'The verification code template only supports 1 verification code as a variable', 'http_code' => 400, 'description' => 'Verification code templates support only one variable, which must be a verification code.'],
['code' => 'TemplateVarLimitExceeded', 'message' => 'The verification code template only supports one variable.', 'http_code' => 400, 'description' => 'The verification code template only supports one variable.'],
['code' => 'template_code.NotFound', 'message' => 'The resource of "template_code" is not found..', 'http_code' => 400, 'description' => 'Could not find template code'],
['code' => 'template_parameter_count_illegal', 'message' => 'Only one parameter is supported in an OTP template.', 'http_code' => 400, 'description' => 'Only one parameter supported for OTP template'],
['code' => 'ThreeAbnormal', 'message' => 'Three party anomaly.', 'http_code' => 400, 'description' => 'tripartite anomaly'],
['code' => 'Unknown.CountryCode', 'message' => 'The specified country code is invalid.', 'http_code' => 400, 'description' => 'The country code is unknown.'],
['code' => 'Unsupport.CountryCode', 'message' => 'The specified country code is not supported.', 'http_code' => 400, 'description' => 'The country code is not supported.'],
['code' => 'VALVE:D_MC', 'message' => '重复过滤', 'http_code' => 400, 'description' => 'We recommend that you reduce the number of messages sent per day.'],
['code' => 'VALVE:H_MC', 'message' => '重复过滤', 'http_code' => 400, 'description' => 'We recommend that you reduce the number of messages sent per hour.'],
['code' => 'VALVE:M_MC', 'message' => '重复过滤', 'http_code' => 400, 'description' => 'We recommend that you reduce the number of messages sent per minute.'],
['code' => 'WorkOrderIdExpired', 'message' => 'Qualification details have changed. Please re-query the qualification list and resubmit.', 'http_code' => 400, 'description' => ''],
['code' => 'TrademarkPicsFileError', 'message' => 'The format of the trademark screenshot file is incorrect.', 'http_code' => 400, 'description' => ''],
['code' => 'AppIcpRecordOssFileNotUploadError', 'message' => 'The APP-ICP record screenshot file is not uploaded.', 'http_code' => 400, 'description' => ''],
['code' => 'TrademarkApplicantNameNotMatchRegex', 'message' => 'The trademark applicant cannot be empty.', 'http_code' => 400, 'description' => ''],
['code' => 'AppPrincipalUnitNameOverLimit', 'message' => 'The principal unit name of the APP exceeds the length limit.', 'http_code' => 400, 'description' => ''],
['code' => 'AppIcpRecordDateNotMatchRegex', 'message' => 'The format of the APP-ICP record approval date is incorrect.', 'http_code' => 400, 'description' => ''],
['code' => 'TrademarkLetterDateNotMatchRegex', 'message' => 'The format of the trademark\'s validity period is incorrect.', 'http_code' => 400, 'description' => ''],
['code' => 'AppIcpLicenseNumberOverLimit', 'message' => 'The ICP record/license number exceeds the length limit.', 'http_code' => 400, 'description' => ''],
['code' => 'TrademarkApplicantNameOverLimit', 'message' => 'The trademark applicant exceeds the length limit.', 'http_code' => 400, 'description' => ''],
['code' => 'AppApprovalDateNotValid', 'message' => 'The validity period of the APP-ICP record is not within the valid range.', 'http_code' => 400, 'description' => ''],
['code' => 'AppIcpRecordPicsFileError', 'message' => 'The format of the APP-ICP record screenshot file is incorrect.', 'http_code' => 400, 'description' => ''],
['code' => 'TrademarkRegistrationNumberNotMatchRegex', 'message' => 'The trademark registration number cannot be empty.', 'http_code' => 400, 'description' => ''],
['code' => 'AppDomainNotMatchRegex', 'message' => 'The APP app store link cannot be empty and must start with http:// or https://.', 'http_code' => 400, 'description' => ''],
['code' => 'TrademarkDateNotValid', 'message' => 'The trademark\'s validity period is not within the valid range.', 'http_code' => 400, 'description' => ''],
['code' => 'TrademarkNameNotMatchRegex', 'message' => 'The trademark name cannot be empty.', 'http_code' => 400, 'description' => ''],
['code' => 'AppPrincipalUnitNameNotMatchRegex', 'message' => 'The principal unit name of the APP cannot be empty.', 'http_code' => 400, 'description' => ''],
['code' => 'AppIcpLicenseNumberNotMatchRegex', 'message' => 'The ICP record/license number cannot be empty.', 'http_code' => 400, 'description' => ''],
['code' => 'TrademarkOssFileNotUploadError', 'message' => 'The trademark screenshot file is not uploaded.', 'http_code' => 400, 'description' => ''],
['code' => 'TrademarkRegistrationNumberOverLimit', 'message' => 'The trademark registration number exceeds the length limit.', 'http_code' => 400, 'description' => ''],
['code' => 'TrademarkNameOverLimit', 'message' => 'The trademark name exceeds the length limit.', 'http_code' => 400, 'description' => ''],
['code' => 'AppDomainOverLimit', 'message' => 'The APP app store link exceeds the length limit.', 'http_code' => 400, 'description' => ''],
['code' => 'AppIcpRecordNotExist', 'message' => 'The APP-ICP record does not exist.', 'http_code' => 400, 'description' => ''],
['code' => 'TrademarkNotExist', 'message' => 'The trademark does not exist.', 'http_code' => 400, 'description' => ''],
],
'changeSet' => [
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'QuerySendStatistics'],
['description' => 'OpenAPI offline', 'api' => 'QuerySendDetails'],
],
'createdAt' => '2026-07-02T08:24:57.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'QuerySendStatistics'],
['description' => 'OpenAPI offline', 'api' => 'QuerySendDetails'],
],
'createdAt' => '2026-07-02T08:24:57.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'QuerySendDetails'],
['description' => 'OpenAPI offline', 'api' => 'QuerySendStatistics'],
],
'createdAt' => '2026-07-01T06:01:22.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'QuerySmsAppIcpRecord'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsAppIcpRecord'],
],
'createdAt' => '2026-06-30T09:32:48.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'QuerySmsAppIcpRecord'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsAppIcpRecord'],
],
'createdAt' => '2026-06-30T09:32:45.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'QuerySmsAppIcpRecord'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsAppIcpRecord'],
],
'createdAt' => '2026-06-30T08:39:47.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'QuerySmsAppIcpRecord'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsAppIcpRecord'],
],
'createdAt' => '2026-06-30T08:39:42.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'QuerySmsAppIcpRecord'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsAppIcpRecord'],
],
'createdAt' => '2026-06-30T08:39:42.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'QuerySmsTemplateList'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsTemplate'],
],
'createdAt' => '2026-06-15T07:45:24.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'QuerySmsTemplateList'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
],
'createdAt' => '2026-06-15T07:45:22.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'QuerySmsTemplateList'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
],
'createdAt' => '2026-06-15T07:45:22.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsTemplateList'],
],
'createdAt' => '2026-06-08T07:44:54.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsTemplateList'],
],
'createdAt' => '2026-06-08T07:44:54.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsTemplateList'],
],
'createdAt' => '2026-06-08T07:44:54.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsTemplateList'],
],
'createdAt' => '2026-06-08T07:44:50.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
],
'createdAt' => '2026-06-04T07:56:01.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsTemplateList'],
],
'createdAt' => '2026-06-04T07:55:58.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsTemplateList'],
],
'createdAt' => '2026-06-04T07:55:45.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsTemplateList'],
],
'createdAt' => '2026-06-04T07:55:45.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
],
'createdAt' => '2026-06-03T12:32:29.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
],
'createdAt' => '2026-06-03T12:32:23.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
],
'createdAt' => '2026-06-03T08:56:43.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
],
'createdAt' => '2026-06-03T08:56:31.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetSmsTemplate'],
],
'createdAt' => '2026-04-07T06:43:39.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetSmsTemplate'],
],
'createdAt' => '2026-04-07T06:43:33.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetSmsTemplate'],
],
'createdAt' => '2026-04-07T06:43:31.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsTemplate'],
],
'createdAt' => '2026-03-30T02:44:05.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetSmsTemplate'],
],
'createdAt' => '2026-03-30T02:44:02.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'QuerySmsSignList'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsSignList'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
['description' => 'Error codes changed, Request parameters changed', 'api' => 'CreateSmsSign'],
['description' => 'Error codes changed, Request parameters changed', 'api' => 'UpdateSmsSign'],
],
'createdAt' => '2025-12-11T12:44:31.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'QuerySmsSignList'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsSignList'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
['description' => 'Error codes changed, Request parameters changed', 'api' => 'CreateSmsSign'],
['description' => 'Error codes changed, Request parameters changed', 'api' => 'UpdateSmsSign'],
],
'createdAt' => '2025-12-11T12:44:31.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'QuerySmsSignList'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsSignList'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
['description' => 'Error codes changed, Request parameters changed', 'api' => 'CreateSmsSign'],
['description' => 'Error codes changed, Request parameters changed', 'api' => 'UpdateSmsSign'],
],
'createdAt' => '2025-12-11T12:44:31.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsSignList'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsSignList'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsSign'],
],
'createdAt' => '2025-12-11T10:08:22.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'QuerySmsTemplateList'],
],
'createdAt' => '2025-11-27T03:33:20.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'QuerySmsTemplateList'],
],
'createdAt' => '2025-11-27T03:33:12.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'CreateCardSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'CreateCardSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'CreateCardSmsTemplate'],
],
'createdAt' => '2025-11-24T02:44:52.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'CreateCardSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'CreateCardSmsTemplate'],
],
'createdAt' => '2025-11-24T02:44:41.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsSignList'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsSignList'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
],
'createdAt' => '2025-11-03T13:14:37.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsSignList'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsSignList'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
],
'createdAt' => '2025-11-03T13:14:37.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsSignList'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsSignList'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsSign'],
],
'createdAt' => '2025-11-03T13:13:58.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'AddSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'ModifySmsSign'],
['description' => 'OpenAPI offline', 'api' => 'ModifySmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'AddSmsTemplate'],
],
'createdAt' => '2025-08-15T04:21:05.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'ModifySmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'ModifySmsSign'],
['description' => 'OpenAPI offline', 'api' => 'AddSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'AddSmsTemplate'],
],
'createdAt' => '2025-08-15T04:21:01.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'AddSmsSign'],
],
'createdAt' => '2025-08-15T04:03:26.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'AddSmsSign'],
],
'createdAt' => '2025-08-15T04:02:05.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
],
'createdAt' => '2025-08-12T14:41:31.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'QuerySmsTemplateList'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
],
'createdAt' => '2025-08-12T14:41:26.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'QuerySmsTemplateList'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
],
'createdAt' => '2025-08-12T14:41:26.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
],
'createdAt' => '2025-08-12T14:37:16.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
],
'createdAt' => '2025-08-12T14:37:06.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
],
'createdAt' => '2025-08-12T14:37:06.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsTemplate'],
],
'createdAt' => '2025-08-12T14:37:03.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
],
'createdAt' => '2025-08-12T08:38:21.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'CreateSmsTemplate'],
],
'createdAt' => '2025-08-12T07:59:59.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'ChangeSignatureQualification'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsAuthorizationLetter'],
['description' => 'OpenAPI offline', 'api' => 'QuerySingleSmsQualification'],
['description' => 'OpenAPI offline', 'api' => 'DeleteSmsQualification'],
['description' => 'OpenAPI offline', 'api' => 'RequiredPhoneCode'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsQualificationRecord'],
['description' => 'OpenAPI offline', 'api' => 'ValidPhoneCode'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsQualification'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsAuthorizationLetter'],
['description' => 'OpenAPI offline', 'api' => 'GetQualificationOssInfo'],
],
'createdAt' => '2025-08-01T04:05:19.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'ChangeSignatureQualification'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsAuthorizationLetter'],
['description' => 'OpenAPI offline', 'api' => 'QuerySingleSmsQualification'],
['description' => 'OpenAPI offline', 'api' => 'DeleteSmsQualification'],
['description' => 'OpenAPI offline', 'api' => 'RequiredPhoneCode'],
['description' => 'OpenAPI offline', 'api' => 'QuerySmsQualificationRecord'],
['description' => 'OpenAPI offline', 'api' => 'ValidPhoneCode'],
['description' => 'OpenAPI offline', 'api' => 'UpdateSmsQualification'],
['description' => 'OpenAPI offline', 'api' => 'CreateSmsAuthorizationLetter'],
['description' => 'OpenAPI offline', 'api' => 'GetQualificationOssInfo'],
],
'createdAt' => '2025-08-01T04:05:19.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'ModifySmsSign'],
['description' => 'OpenAPI offline', 'api' => 'AddSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'AddSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'ModifySmsTemplate'],
],
'createdAt' => '2025-07-09T12:20:25.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'ModifySmsSign'],
['description' => 'OpenAPI offline', 'api' => 'AddSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'AddSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'ModifySmsTemplate'],
],
'createdAt' => '2025-07-09T12:20:24.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'AddSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'ModifySmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'AddSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'ModifySmsSign'],
],
'createdAt' => '2025-07-09T12:20:18.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'AddSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'ModifySmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'AddSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'ModifySmsSign'],
],
'createdAt' => '2025-07-09T12:20:18.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'AddSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'ModifySmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'AddSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'ModifySmsSign'],
],
'createdAt' => '2025-07-09T12:20:18.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'AddSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'ModifySmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'AddSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'ModifySmsSign'],
],
'createdAt' => '2025-07-09T12:20:18.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'ModifySmsSign'],
['description' => 'OpenAPI offline', 'api' => 'AddSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'AddSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'ModifySmsTemplate'],
],
'createdAt' => '2025-07-09T12:20:05.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'ModifySmsSign'],
['description' => 'OpenAPI offline', 'api' => 'AddSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'AddSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'ModifySmsTemplate'],
],
'createdAt' => '2025-07-09T12:20:05.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'ModifySmsSign'],
['description' => 'OpenAPI offline', 'api' => 'AddSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'AddSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'ModifySmsTemplate'],
],
'createdAt' => '2025-07-09T12:20:05.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'ModifySmsSign'],
['description' => 'OpenAPI offline', 'api' => 'AddSmsSign'],
['description' => 'OpenAPI offline', 'api' => 'AddSmsTemplate'],
['description' => 'OpenAPI offline', 'api' => 'ModifySmsTemplate'],
],
'createdAt' => '2025-07-09T12:20:05.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetSmsSign'],
],
'createdAt' => '2025-06-18T07:40:37.000Z',
'description' => '',
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSmsTemplate'],
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddSmsSign'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'],
['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'],
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCardSmsTemplate'],
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddSmsTemplate'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSmsSign'],
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendBatchCardSms'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddShortUrl'],
['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySendDetails'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySendStatistics'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSmsSign'],
['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendSms'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySmsTemplateList'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConversionDataIntl'],
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSmsTemplate'],
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSmsSign'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOSSInfoForUploadFile'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteShortUrl'],
['threshold' => '8000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardSmsLink'],
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySmsSign'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryShortUrl'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardSmsDetails'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSmsSign'],
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCardSmsTemplate'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SmsConversionIntl'],
['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySmsSign'],
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMediaResourceId'],
['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySmsTemplate'],
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySmsTemplate'],
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSmsTemplate'],
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendCardSms'],
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCardSmsTemplateReport'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSmsTemplate'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySmsSignList'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMobilesCardSupport'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'],
['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendBatchSms'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckMobilesCardSupport'],
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOSSInfoForCardTemplate'],
],
'product' => ['code' => 'dysms', 'title' => 'Dysmsapi'],
],
'ram' => [
'productCode' => 'SMS',
'productName' => 'Short Message Service',
'ramCodes' => ['dysms', 'cloudcomm', 'dybase', 'sms'],
'ramLevel' => 'SERVICE',
'ramConditions' => [
[
'name' => 'dysms:TLSVersion',
'schema' => [
'type' => 'String',
'description' => 'TLS version',
'enums' => ['TLSv1.0', 'TLSv1.1', 'TLSv1.2', 'TLSv1.3'],
],
],
],
'ramActions' => [
[
'apiName' => 'UntagResources',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dysms:UntagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QuerySmsTemplate',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QuerySmsTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'TagResources',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'dysms:TagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryMobilesCardSupport',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QueryMobilesCardSupport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateSmsTemplate',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'dysms:CreateSmsTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteSmsTemplate',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dysms:DeleteSmsTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCardSmsLink',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:GetCardSmsLink',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateSmsTrademark',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dysms:CreateSmsTrademark',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateCardSmsTemplate',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dysms:CreateCardSmsTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QuerySendStatistics',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QuerySendStatistics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CheckMobilesCardSupport',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:CheckMobilesCardSupport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteShortUrl',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dysms:DeleteShortUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryShortUrl',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QueryShortUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SendCardSms',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:SendCardSms',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetSmsOcrOssInfo',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:GetSmsOcrOssInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCardSmsDetails',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'dysms:GetCardSmsDetails',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddSmsSign',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dysms:AddSmsSign',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifySmsSign',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'dysms:ModifySmsSign',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateSmsSign',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'dysms:CreateSmsSign',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateSmsTemplate',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'dysms:UpdateSmsTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetOSSInfoForCardTemplate',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:GetOSSInfoForCardTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SendBatchSms',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:SendBatchSms',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetMediaResourceId',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:GetMediaResourceId',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetSmsTemplate',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'dysms:GetSmsTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateSmsAppIcpRecord',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dysms:CreateSmsAppIcpRecord',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SendSms',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:SendSms',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDigitalSmsTemplate',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dysms:CreateDigitalSmsTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SmsConversionIntl',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:SmsConversionIntl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddSmsTemplate',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dysms:AddSmsTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QuerySendDetails',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QuerySendDetails',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ConversionDataIntl',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:ConversionDataIntl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QuerySmsAppIcpRecord',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QuerySmsAppIcpRecord',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryCardSmsTemplateReport',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QueryCardSmsTemplateReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTagResources',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'dysms:ListTagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryCardSmsTemplate',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QueryCardSmsTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QuerySmsSignList',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QuerySmsSignList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddShortUrl',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'dysms:AddShortUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteSmsSign',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dysms:DeleteSmsSign',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SendBatchCardSms',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:SendBatchCardSms',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QuerySmsSign',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QuerySmsSign',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QuerySmsTemplateList',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QuerySmsTemplateList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QuerySmsTrademark',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'dysms:QuerySmsTrademark',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetSmsSign',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'dysms:GetSmsSign',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateSmsSign',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'dysms:UpdateSmsSign',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifySmsTemplate',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'dysms:ModifySmsTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'SMS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [],
],
];
|