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
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'Push', 'version' => '2016-08-01'],
'directories' => [
[
'children' => ['Push', 'MassPush', 'ContinuouslyPush', 'CompleteContinuouslyPush', 'CancelPush', 'PushV2', 'MassPushV2'],
'type' => 'directory',
'title' => 'Push operations',
],
[
'children' => ['CheckCertificate', 'QueryPushRecords', 'QueryDeviceStat', 'QueryUniqueDeviceStat', 'QueryDeviceInfo', 'QueryPushStatByApp', 'QueryPushStatByMsg', 'CheckDevices'],
'type' => 'directory',
'title' => 'Query operations',
],
[
'children' => ['BindTag', 'UnbindTag', 'RemoveTag', 'QueryTags'],
'type' => 'directory',
'title' => 'Tag operations',
],
[
'children' => ['BindAlias', 'UnbindAlias', 'QueryAliases', 'QueryDevicesByAlias'],
'type' => 'directory',
'title' => 'Alias operations',
],
[
'children' => ['QueryDevicesByAccount'],
'type' => 'directory',
'title' => 'Account operations',
],
[
'children' => ['BindPhone', 'UnbindPhone'],
'type' => 'directory',
'title' => 'Other operations',
],
[
'children' => ['PushMessageToiOS', 'PushNoticeToiOS', 'PushNoticeToAndroid', 'PushMessageToAndroid', 'CheckDevice', 'ListSummaryApps'],
'type' => 'directory',
'title' => 'Deprecated operations (not recommended)',
],
[
'children' => ['ListTags'],
'title' => 'Others',
'type' => 'directory',
],
],
'components' => [
'schemas' => [
'PushTask' => [
'description' => 'Push task object',
'type' => 'object',
'properties' => [
'Action' => [
'description' => 'Push method. Optional parameter, defaults to `PUSH_IMMEDIATELY`.'."\n"
."\n"
.'><notice>'."\n"
."\n"
.'The batch push API `MassPushV2` only supports the following push methods:'."\n"
."\n"
.'- `PUSH_IMMEDIATELY`'."\n"
.'- `SCHEDULED_PUSH`'."\n"
."\n"
.'></notice>',
'enumValueTitles' => ['SCHEDULED_PUSH' => 'Scheduled push', 'CREATE_CONTINUOUS_PUSH' => 'Create continuous push task', 'PUSH_IMMEDIATELY' => 'Push immediately', 'CONTINUOUS_PUSH' => 'Continuous push'],
'type' => 'string',
'required' => false,
'example' => 'PUSH_IMMEDIATELY',
'enum' => ['PUSH_IMMEDIATELY', 'SCHEDULED_PUSH', 'CREATE_CONTINUOUS_PUSH', 'CONTINUOUS_PUSH'],
'title' => '',
],
'Target' => [
'description' => 'Specifies the target of the message push. This parameter is optional when the `Action` is `CREATE_CONTINUOUS_PUSH` (create continuous push task).',
'type' => 'object',
'properties' => [
'Type' => [
'description' => 'Push target type.'."\n"
."\n"
.'><notice>'."\n"
."\n"
.'The batch push API `MassPushV2` and continuous push `CONTINUOUS_PUSH` only support the following three target types:'."\n"
."\n"
.'- `DEVICE`'."\n"
.'- `ACCOUNT`'."\n"
.'- `ALIAS`'."\n"
."\n"
.'></notice>',
'enumValueTitles' => ['ALL' => 'All', 'ACCOUNT' => 'Account', 'ALIAS' => 'Alias', 'DEVICE' => 'Device', 'TAG' => 'Tag'],
'type' => 'string',
'required' => false,
'example' => 'DEVICE',
'enum' => ['DEVICE', 'TAG', 'ALIAS', 'ACCOUNT', 'ALL', 'FILE'],
'title' => '',
],
'Value' => ['description' => 'Sets the push target based on `Target.Type`, with multiple targets separated by commas. The target types and values are described below:'."\n"
."\n"
.'>* `DEVICE`: Device IDs, e.g., deviceid1,deviceid2, up to 1000.'."\n"
.'>* `ACCOUNT`: Account IDs, e.g., account1,account2, up to 1000.'."\n"
.'>* `ALIAS`: Aliases, e.g., alias1,alias2, up to 1000.'."\n"
.'>* `TAG`: Supports single or multiple tags. See [Tag format specification](https://help.aliyun.com/document_detail/434847.html) for the format.'."\n"
.'>* `ALL`: Push to all devices. No value needs to be set. Pushing to all may increase costs, please use at your discretion.', 'type' => 'string', 'example' => 'value', 'title' => ''],
'Platform' => [
'description' => 'Platform type. Optional parameter.',
'enumValueTitles' => ['ALL' => 'Both platforms, only supported by certain dual-platform applications', 'HMOS' => 'HarmonyOS devices', 'ANDROID' => 'Android devices', 'IOS' => 'iOS devices'],
'type' => 'string',
'required' => false,
'example' => 'IOS',
'enum' => ['ANDROID', 'IOS', 'HMOS', 'ALL'],
'title' => '',
],
],
'title' => '',
'example' => '',
],
'Message' => [
'title' => '',
'description' => 'Pass-through message data sent to the device. Total length must not exceed 4000 bytes.'."\n"
."\n"
.'> Length calculation notes'."\n"
.'> - Length is calculated based on the UTF-8 encoded byte length of the JSON serialized Message object string.'."\n"
.'> - Chinese characters typically occupy 3 bytes in UTF-8 encoding.',
'type' => 'object',
'properties' => [
'Title' => ['description' => 'Title of the message to be sent.', 'type' => 'string', 'example' => 'title', 'title' => ''],
'Body' => ['description' => 'Content of the message to be sent.', 'type' => 'string', 'required' => false, 'example' => '{"key": "value"}', 'title' => ''],
],
'example' => '',
],
'Notification' => [
'description' => 'Vendor notification data sent to the device.'."\n"
."\n"
.'><notice>'."\n"
."\n"
.'When both `Message` and `Notification` are set, the device will only receive one, following these rules:'."\n"
."\n"
.'- When the device is online, pass-through message data is sent;'."\n"
.'- When the device is offline, a system notification is sent;'."\n"
."\n"
.'></notice>',
'type' => 'object',
'properties' => [
'Title' => [
'description' => 'Title of the push notification.'."\n"
."\n"
.'> Length limits:'."\n"
.'> - iOS/Harmony: **byte length** must not exceed 200'."\n"
.'> - Android: **character length** must not exceed 50',
'enumValueTitles' => [],
'type' => 'string',
'example' => '您有一条新消息',
'title' => '',
],
'Body' => ['description' => 'Content of the push notification.'."\n"
."\n"
.'> Length limits:'."\n"
.'> - iOS/Harmony/Android: **character length** must not exceed 200', 'type' => 'string', 'example' => '尊敬的客户,您好!您的预约订单已取消成功。 ', 'title' => ''],
'Ios' => [
'description' => 'iOS notification configuration',
'type' => 'object',
'properties' => [
'Subtitle' => ['description' => 'iOS notification subtitle content.', 'type' => 'string', 'example' => '请查收订单。', 'title' => ''],
'Music' => ['description' => 'iOS notification sound. Specifies the audio file name stored in the app bundle or sandbox Library/Sounds directory. See: [How to set iOS push notification sound](https://help.aliyun.com/document_detail/48906.html).'."\n"
."\n"
.'> - If set to an empty string (""), the notification will be silent.'."\n"
.'> - If not set, defaults to the system alert sound.', 'type' => 'string', 'example' => 'default', 'title' => ''],
'Badge' => ['description' => 'iOS application badge number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'BadgeAutoIncrement' => ['description' => 'Whether to enable badge auto-increment. Optional parameter, defaults to false.'."\n"
."\n"
.'> - Cannot be used together with the badge set parameter.'."\n"
.'> - The badge auto-increment feature is maintained by Alibaba Cloud Push server for each device\'s badge count. Requires SDK version 1.9.5 or above. The SDK actively syncs the badge number to the server.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'Silent' => ['description' => 'Controls whether to enable silent push mode.'."\n"
."\n"
.'> - When sending silent notifications, `title` and `body` parameters can be omitted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'Mutable' => ['description' => 'Enables notification extension, controlling whether the iOS notification supports Notification Service Extension processing.'."\n"
.'> - Must be set to true when sending silent notifications.'."\n"
.'> - Extension processing time must not exceed 30 seconds.'."\n"
.'> - Timeout will cause the notification to display original content.'."\n"
.'> - Requires adding a Notification Service Extension to the application.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Category' => ['description' => 'Specifies the category identifier for iOS notifications, used to define the interaction behavior and display style of notifications.'."\n"
."\n"
.'> - The Category must be pre-registered in the App to take effect.'."\n"
.'> - Different Categories can define different sets of actions.', 'type' => 'string', 'example' => 'MESSAGE_REPLY', 'title' => ''],
'CollapseId' => ['description' => 'A unique identifier for notification collapsing. Notifications with the same identifier will be replaced and displayed as one.', 'type' => 'string', 'example' => 'order_status_update_12345', 'title' => ''],
'ThreadId' => ['description' => 'Thread identifier for iOS notification grouping, used to categorize and collapse related notifications.'."\n"
."\n"
.'> - Notifications with the same thread-id are automatically grouped.'."\n"
.'> - Multiple related notifications are collapsed into one notification group.'."\n"
.'> - Users can expand to view all notifications in the group.', 'type' => 'string', 'example' => 'news_category_tech', 'title' => ''],
'InterruptionLevel' => [
'description' => 'Interruption level. Optional parameter with the following enum values:'."\n"
."\n"
.'- `passive`: The system adds the notification to the notification list without lighting the screen or playing a sound.'."\n"
.'- `active`: The system immediately displays the notification, lights up the screen, and may play a sound.'."\n"
.'- `time-sensitive`: The system immediately presents the notification, lights up the screen, and may play a sound, but does not break through system notification controls.'."\n"
.'- `critical`: The system immediately displays the notification, lights up the screen, and plays a sound bypassing the mute switch.',
'type' => 'string',
'example' => 'active',
'enum' => ['passive', 'active', 'time-sensitive', 'critical'],
'title' => '',
],
'RelevanceScore' => ['description' => 'Relevance score of the notification message, used to control notification priority and display strategy.', 'type' => 'number', 'format' => 'double', 'example' => '0.5', 'title' => ''],
'ExtParameters' => ['description' => 'Custom extension attributes for iOS notifications.'."\n"
."\n"
.'> - Parameters must be passed in standard JSON Map format. Incorrect format will cause parsing failure.', 'type' => 'string', 'example' => '{"attachment": "https://xxxx.xxx/notification_pic.png"} ', 'title' => ''],
'LiveActivity' => [
'description' => 'Live Activity (Dynamic Island) parameter object.'."\n"
."\n"
.'><notice>'."\n"
."\n"
.'- Live Activity push only supports pushing to a **single device** by `DEVICE` type.'."\n"
.'- When pushing Live Activities, `title` and `body` parameters can be omitted.'."\n"
."\n"
.'></notice>',
'type' => 'object',
'properties' => [
'Id' => ['description' => 'Unique identifier of the Live Activity, used to associate the device-side activity instance with the server-side push target.'."\n"
."\n"
.'><notice>'."\n"
."\n"
.'- This `ID` must be consistent with the `forActivityId` parameter in the client SDK\'s `registerLiveActivityPushToken` method.'."\n"
."\n"
.'- The server uses this `ID` to locate the specific activity instance.'."\n"
."\n"
.'></notice>', 'type' => 'string', 'example' => 'FOOD_DELIVERY_ORD20231201001', 'title' => ''],
'Event' => [
'description' => 'Start, update, or end a Live Activity.',
'type' => 'string',
'required' => false,
'example' => 'start',
'enum' => ['start', 'update', 'end'],
'title' => '',
],
'AttributesType' => ['description' => 'The type of Live Activity to start.'."\n"
."\n"
.'> Required when `Event` is start.', 'type' => 'string', 'example' => 'OrderActivityAttributes', 'title' => ''],
'Attributes' => ['description' => 'Static pass-through parameters for iOS Live Activities push, used to pass immutable business identification information.'."\n"
."\n"
.'> Required when `Event` is start.', 'type' => 'string', 'example' => '{'."\n"
.' "orderId": "ORD20231201001",'."\n"
.' "restaurantName": "美味餐厅",'."\n"
.' "customerAddress": "xx区xx路xx号",'."\n"
.' "orderType": "delivery"'."\n"
.'}', 'title' => ''],
'ContentState' => ['description' => 'Dynamic pass-through parameters for Live Activity, containing real-time updatable status information and changing data.'."\n"
."\n"
.'> - Avoid overly frequent updates (recommended interval >= 5 seconds).'."\n"
.'> - Batch update multiple fields to reduce push count.'."\n"
.'> - Consider user experience and avoid UI flickering.'."\n"
.'> - Must be a valid JSON string.', 'type' => 'string', 'example' => '{'."\n"
.' "status": "delivering",'."\n"
.' "estimatedTime": "10分钟",'."\n"
.' "progress": 80,'."\n"
.' "driverName": "李师傅",'."\n"
.' "currentStep": "配送员正在路上"}'."\n"
.'}', 'title' => ''],
'DismissalDate' => ['description' => 'Sets the retention time of a ended Live Activity on the lock screen, allowing users to still view information after the activity ends. Uses Unix timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1701439800', 'title' => ''],
'StaleDate' => ['description' => 'Sets the expiration timestamp for iOS Live Activity content. Uses Unix timestamp in seconds.'."\n"
."\n"
.'> - After the specified time, the system will automatically mark the activity as expired.'."\n"
.'> - Expired activities will be removed from Dynamic Island and the lock screen.'."\n"
.'> - Prevents outdated information from occupying the user interface for extended periods.', 'type' => 'integer', 'format' => 'int64', 'example' => '1701425400', 'title' => ''],
],
'title' => '',
'example' => '',
],
'ApnsEnv' => [
'description' => 'iOS notifications are sent through the APNs center, and the corresponding environment information must be provided. Optional parameter, defaults to production environment.'."\n"
."\n"
.'- DEV: Development environment, for applications installed and debugged directly through Xcode.'."\n"
.'- PRODUCT: Production environment, for applications distributed via App Store, TestFlight, Ad Hoc, and Enterprise distribution.',
'enumValueTitles' => ['DEV' => 'Development environment', 'PRODUCT' => 'Production environment'],
'type' => 'string',
'example' => 'DEV',
'enum' => ['DEV', 'PRODUCT'],
'title' => '',
],
],
'title' => '',
'example' => '',
],
'Hmos' => [
'description' => 'HarmonyOS notification configuration.',
'type' => 'object',
'properties' => [
'Category' => [
'description' => 'Notification message category. Optional parameter, defaults to `MARKETING` category.'."\n"
."\n"
.'> After completing the notification message self-classification rights application, this is used to identify the message type. Different notification message types affect the message display and alert method. For details, see the HarmonyOS official documentation [Notification.category](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section17371529101117).',
'enumValueTitles' => [
'TRAVEL' => 'Travel', 'IM' => 'Instant messaging', 'VOIP' => 'Audio/video calls', 'SUBSCRIPTION' => 'Subscription', 'MARKETING' => 'News, content recommendations, social updates, product promotions, financial updates, lifestyle information, surveys, feature recommendations, operational activities (only labels content, does not accelerate message delivery), collectively referred to as information marketing messages', 'CUSTOMER_SERVICE' => 'Customer service messages', 'ACCOUNT' => 'Account updates', 'MAIL' => 'Mail', 'FINANCE' => 'Finance', 'EXPRESS' => 'Orders & logistics',
'WORK' => 'Work task reminders', 'HEALTH' => 'Health', 'DEVICE_REMINDER' => 'Device reminders',
],
'type' => 'string',
'example' => 'IM',
'enum' => ['IM', 'VOIP', 'SUBSCRIPTION', 'TRAVEL', 'HEALTH', 'WORK', 'ACCOUNT', 'EXPRESS', 'FINANCE', 'DEVICE_REMINDER', 'MAIL', 'CUSTOMER_SERVICE', 'MARKETING'],
'title' => '',
],
'SlotType' => [
'description' => 'Uses the specified type of notification channel.'."\n"
."\n"
.'> - Only effective for Alibaba Cloud proprietary channels.'."\n"
.'> - For details, see the HarmonyOS official documentation [SlotType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/js-apis-notificationmanager-V5#slottype).',
'enumValueTitles' => ['CONTENT_INFORMATION' => 'Content information', 'UNKNOWN_TYPE' => 'Unknown type', 'LIVE_VIEW' => 'Live view', 'SOCIAL_COMMUNICATION' => 'Social communication', 'CUSTOMER_SERVICE' => 'Customer service messages. This type is used for customer service messages between users and merchants, which must be initiated by the user.', 'OTHER_TYPES' => 'Other', 'SERVICE_INFORMATION' => 'Service reminders'],
'type' => 'string',
'example' => 'SOCIAL_COMMUNICATION',
'enum' => ['SOCIAL_COMMUNICATION', 'SERVICE_INFORMATION', 'CONTENT_INFORMATION', 'CUSTOMER_SERVICE', 'OTHER_TYPES', 'UNKNOWN_TYPE', 'LIVE_VIEW'],
'title' => '',
],
'NotifyId' => ['description' => 'Specifies the unique identifier for each message displayed in the notification bar (notifyId). If not provided, the push service will automatically generate a unique identifier. Different notification messages can use the same notifyId to enable new messages to overwrite old ones. See HarmonyOS official documentation [Notification.notifyId](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section17371529101117).', 'type' => 'integer', 'format' => 'int32', 'example' => '123456', 'title' => ''],
'Action' => ['description' => 'Specifies the action corresponding to the in-app page ability.'."\n"
."\n"
.'> For details, see the HarmonyOS official documentation [ClickAction.action](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section152462191216).', 'type' => 'string', 'example' => 'com.example.action', 'title' => ''],
'Uri' => ['description' => 'The URI corresponding to the in-app page ability.'."\n"
."\n"
.'> - When multiple Abilities exist, fill in different actions and URIs for each Ability. The action is used first to find the corresponding in-app page.'."\n"
.'> - For details, see the HarmonyOS official documentation [ClickAction.uri](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section152462191216).', 'type' => 'string', 'example' => 'https://www.example.com:8080/push/example', 'title' => ''],
'RenderStyle' => [
'description' => 'Notification message style. Optional parameter, defaults to standard notification.',
'enumValueTitles' => ['NORMAL' => 'Standard notification (default)', 'MULTI_LINE' => 'Multi-line text style'],
'type' => 'string',
'example' => 'NORMAL',
'enum' => ['NORMAL', 'MULTI_LINE'],
'title' => '',
],
'ImageUrl' => ['description' => 'Large icon URL on the right side of the notification. The URL must use the HTTPS protocol.'."\n"
."\n"
.'> - Supported image formats: png, jpg, jpeg, heif, gif, bmp. Image height * width must be less than 25000 pixels.'."\n"
.'> - For details, see the HarmonyOS official documentation [Notification.image](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section17371529101117).', 'type' => 'string', 'example' => 'https://example.com/xxx.png', 'title' => ''],
'InboxContent' => [
'description' => 'When `RenderStyle` is `MULTI_LINE`, this field must be filled in to define the multi-line text style content. Supports up to 3 items.',
'type' => 'array',
'items' => ['description' => 'Text content.', 'type' => 'string', 'example' => '1. 您有一个事项待处理', 'title' => ''],
'title' => '',
'example' => '',
],
'ExtParameters' => ['description' => 'Sets custom extension attributes for notification messages, used to pass additional business data.'."\n"
."\n"
.'> Parameters must be passed in standard JSON Map format. Incorrect format will cause parsing failure.', 'type' => 'string', 'example' => '{"key": "value"}', 'title' => ''],
'TestMessage' => ['description' => 'Enables test message mode.'."\n"
."\n"
.'> - For details, see the HarmonyOS push parameter [TestMessage](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section418321011212).', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ReceiptId' => ['description' => 'HarmonyOS channel receipt ID. This receipt ID can be viewed in the receipt parameter configuration of the HarmonyOS channel push operations platform.'."\n"
."\n"
.'> - If the default receipt configuration on the HarmonyOS channel push operations platform is Alibaba Cloud receipt, this is not required. Otherwise, it is recommended to first configure the HarmonyOS channel default receipt ID in the Alibaba Cloud EMAS Mobile Push console.'."\n"
.'> - For details, see the HarmonyOS official documentation [pushOptions.receiptId](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section418321011212).', 'type' => 'string', 'example' => 'RCPB***DFD5', 'title' => ''],
'ExtensionPush' => ['description' => 'Enables HarmonyOS notification extension.'."\n"
."\n"
.'> - Notification extension messages require prior permission application on the HarmonyOS official website. For details, see the [HarmonyOS documentation](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/push-send-extend-noti-V5) on sending notification extension messages.'."\n"
.'> - Supported from HarmonyOS SDK version 1.2.0.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'ExtensionExtraData' => ['description' => 'Extra data for notification extension messages.'."\n"
."\n"
.'> - Effective when sending HarmonyOS notification extension messages.'."\n"
.'> - Conceptually equivalent to the extraData field of HarmonyOS notification extension messages. For specific definitions, see the HarmonyOS [ExtensionPayload](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section161192514234) documentation.'."\n"
.'> - Supported from HarmonyOS SDK version 1.2.0.', 'type' => 'string', 'example' => 'text', 'title' => ''],
'BadgeSetNum' => ['description' => 'HarmonyOS application badge set number.'."\n"
."\n"
.'> - See HarmonyOS badge [setNum field](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section266310382145) documentation.'."\n"
.'> - Supported from HarmonyOS SDK version 1.2.0.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'BadgeAddNum' => ['description' => 'HarmonyOS application badge increment number.'."\n"
."\n"
.'> - Supported from HarmonyOS SDK version 1.2.0.'."\n"
.'> - See HarmonyOS badge [addNum field documentation](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section266310382145).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'LiveViewPayload' => ['description' => 'JSON string of the HarmonyOS Live View data structure [LiveViewPayload](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V13/push-scenariozed-api-request-param-V13#section66881469306). For development integration, see the [HarmonyOS Live View Push Guide](https://help.aliyun.com/document_detail/2982112.html).', 'type' => 'string', 'title' => '', 'example' => '{'."\n"
.' "activityId": 1,'."\n"
.' "operation": 0,'."\n"
.' "event": "TAXI",'."\n"
.' "status": "DRIVER_ON_THE_WAY",'."\n"
.' "activityData": {'."\n"
.' "notificationData": {'."\n"
.' "type": 3'."\n"
.' }'."\n"
.' }'."\n"
.'}'],
'Sound' => ['title' => '', 'description' => 'HarmonyOS custom ringtone file name', 'type' => 'string', 'example' => 'music.mp3'],
'SoundDuration' => ['title' => '', 'description' => 'Custom notification ringtone duration in seconds, range [1,60]. If the ringtone duration is insufficient, it will loop.', 'type' => 'integer', 'example' => '2', 'format' => 'int32'],
],
'title' => '',
'example' => '',
],
'Android' => [
'description' => 'Android notification configuration',
'type' => 'object',
'properties' => [
'VendorChannelActivity' => ['description' => 'Specifies the Activity to navigate to after clicking the notification.'."\n"
."\n"
.'><warning>This option must be filled in when using Android vendor channels.></warning>', 'type' => 'string', 'example' => 'com.alibaba.cloudpushdemo.bizactivity', 'title' => ''],
'ChannelId' => ['description' => 'Sets the channelId for the Android app, which must match the channelId in the vendor App.'."\n"
."\n"
.'> - Since the OPPO notification private channel\'s channel_id is the same as the app\'s channelId, the channel_id takes this value when pushing through the OPPO channel.'."\n"
.'> - For Huawei, FCM, and Alibaba Cloud proprietary channel pushes, the channel_id takes this value.'."\n"
.'> - For specific usage, see FAQ: [Notifications not received on Android 8.0+ devices](https://help.aliyun.com/document_detail/67398.html).', 'type' => 'string', 'example' => '8.0up', 'title' => ''],
'RenderStyle' => [
'description' => 'Notification style. Values:'."\n"
."\n"
.'- `0`: Standard mode (default)'."\n"
.'- `1`: Long text mode (supports Huawei, Honor, Xiaomi, OPPO, Meizu, proprietary channel)'."\n"
.'- `2`: Large image mode (supports proprietary channel)'."\n"
.'- `3`: List mode (supports Huawei, Honor, Xiaomi, OPPO, proprietary channel)',
'type' => 'string',
'example' => '0',
'enum' => ['NORMAL', 'BIG_TEXT', 'BIG_PICTURE', 'MULTI_LINE'],
'title' => '',
],
'PictureUrl' => ['description' => 'Image URL for large image mode. Currently supported: Proprietary channel: Android SDK 3.6.0 and above.', 'type' => 'string', 'example' => 'https://imag.example.com/image.png', 'title' => ''],
'ImageUrl' => ['description' => 'Right-side icon URL. Currently supported:'."\n"
."\n"
.'- `Huawei EMUI` (only applicable in long text mode and Inbox mode).'."\n"
.'- `Honor Magic UI` (only applicable in long text mode).'."\n"
.'- `Proprietary channel` (Android SDK 3.5.0 and above).', 'type' => 'string', 'example' => 'https://imag.example.com/image.png', 'title' => ''],
'InboxContent' => [
'description' => 'Body content in Inbox mode. Content must be a valid JSON Array with no more than 5 elements. Currently supported:'."\n"
."\n"
.'- Huawei: EMUI9 and above'."\n"
.'- Honor: Magic UI 4.0 and above'."\n"
.'- Xiaomi: MIUI10 and above'."\n"
.'- OPPO: ColorOS 5.0 and above'."\n"
.'- Proprietary channel: Android SDK 3.6.0 and above',
'type' => 'array',
'items' => ['description' => 'Body text', 'type' => 'string', 'example' => '1. 第一条待处理事项', 'title' => ''],
'title' => '',
'example' => '',
],
'NotifyId' => ['description' => 'Unique identifier for Android notification bar messages, used to control notification override and replacement behavior. New notifications with the same NotifyId will automatically override old ones.', 'type' => 'integer', 'format' => 'int32', 'example' => '233856727', 'title' => ''],
'GroupId' => ['description' => 'Message group. Messages in the same group will only display the latest one and the total message count in the notification bar, without showing all messages or allowing expansion. Currently supported:'."\n"
."\n"
.'- Huawei vendor channel'."\n"
.'- Honor vendor channel'."\n"
.'- Proprietary channel with Android SDK 3.9.1 and below'."\n"
."\n"
.'> The proprietary channel no longer supports this parameter from Android SDK 3.9.2 and above.', 'type' => 'string', 'example' => 'group-1', 'title' => ''],
'ExtParameters' => ['description' => 'Custom extension attributes for Android notifications.'."\n"
."\n"
.'> - Parameters must be passed in standard JSON Map format. Incorrect format will cause parsing failure.', 'type' => 'string', 'example' => '{"key1":"value1"}', 'title' => ''],
'Music' => ['description' => 'Huawei vendor channel notification sound. Specifies the audio file name stored in the client project\'s `app/src/main/res/raw/` directory, without the file format extension. If not set, the default ringtone is used.', 'type' => 'string', 'example' => 'alicloud_notification_sound', 'title' => ''],
'BadgeSetNum' => ['description' => 'Sets a fixed badge number. Value range: [1~99].'."\n"
."\n"
.'> - For vendor channel push, only effective for Huawei and Honor channels.'."\n"
.'> - For Alibaba Cloud proprietary channel push, only effective on Huawei, Honor, and vivo devices.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
'BadgeAddNum' => ['description' => 'Sets the badge increment value, added to the existing badge count.'."\n"
."\n"
.'> - Supports `Huawei` and `Honor` channels.'."\n"
.'> - When both `BadgeAddNum` and `BadgeSetNum` are present, the latter takes precedence.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'BadgeActivity' => ['description' => 'Full class name of the Activity for the badge setting application entry.'."\n"
."\n"
.'> Only effective for Huawei/Honor vendor channel push.', 'type' => 'string', 'example' => 'com.alibaba.cloudpushdemo.bizactivity', 'title' => ''],
'TestMessage' => ['description' => 'Sets the vendor channel notification type:'."\n"
."\n"
.'- `false`: Official notification (default).'."\n"
.'- `true`: Test notification.'."\n"
."\n"
.'> Currently supported: Huawei channel, Honor channel, vivo channel, OPPO Fluid Cloud.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'Options' => [
'description' => 'Detailed channel configuration.',
'type' => 'object',
'properties' => [
'Accs' => [
'description' => 'Alibaba Cloud proprietary channel configuration.'."\n"
."\n"
.'> Only effective when using the Alibaba Cloud proprietary channel.',
'type' => 'object',
'properties' => [
'CustomStyle' => ['description' => 'Android custom notification bar style. Value range: 1-100.'."\n"
."\n"
.'> Requires client-side style preset configuration. See [Custom notification style API](https://help.aliyun.com/document_detail/2834944.html).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Priority' => ['description' => 'Priority of Android notification display position in the notification bar. Allowed values: -2, -1, 0, 1, 2.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'ThreadId' => ['description' => 'Message group. Messages in the same group are collapsed in the notification bar and can be expanded. Different groups are displayed separately.'."\n"
."\n"
.'> Android SDK 3.9.2 and above.', 'type' => 'string', 'example' => 'order_ORD20231201001', 'title' => ''],
'OpenType' => [
'description' => 'Action after clicking the notification. Allowed values:'."\n"
."\n"
.'- `APPLICATION`: Open application (default)'."\n"
.'- `ACTIVITY`: Open specified page `OpenActivity`'."\n"
.'- `URL`: Open URL'."\n"
.'- `NONE`: No navigation',
'type' => 'string',
'example' => 'APPLICATION',
'enum' => ['APPLICATION', 'ACTIVITY', 'URL', 'NONE'],
'title' => '',
],
'OpenActivity' => ['description' => 'Sets the Activity to open on notification click. Effective when `OpenType` is `ACTIVITY`.', 'type' => 'string', 'example' => 'com.alibaba.cloudpushdemo.bizactivity', 'title' => ''],
'OpenUrl' => ['description' => 'URL to open when clicking the push notification on Android. Effective when `OpenType` is `URL`.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''],
'NotifyType' => [
'description' => 'Notification alert method. Allowed values:'."\n"
."\n"
.'- `VIBRATE`: Vibration (default)'."\n"
.'- `SOUND`: Sound'."\n"
.'- `BOTH`: Sound and vibration'."\n"
.'- `NONE`: Silent',
'type' => 'string',
'example' => 'NONE',
'enum' => ['VIBRATE', 'SOUND', 'BOTH', 'NONE'],
'title' => '',
],
],
'title' => '',
'example' => '',
],
'Huawei' => [
'description' => 'Huawei configuration',
'type' => 'object',
'properties' => [
'ReceiptId' => ['description' => 'Huawei channel receipt ID. This receipt ID can be viewed in the receipt parameter configuration of the Huawei channel push operations platform.'."\n"
."\n"
.'> If the default receipt configuration on the Huawei channel push operations platform is Alibaba Cloud receipt, this is not required. Otherwise, it is recommended to first configure the Huawei channel default receipt ID in the Alibaba Cloud EMAS Mobile Push console.', 'type' => 'string', 'example' => 'RCP4C123456', 'title' => ''],
'Category' => ['description' => 'Purpose 1: After completing the [self-classification rights](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835?#section3410731125514) application, used to identify the message type and determine the [notification alert method](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#ZH-CN_TOPIC_0000001149358835__p3850133955718). For accelerated delivery of specific message types, refer to the Huawei Push official documentation [message classification standards](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#section1076611477914) and fill in the "Cloud notification category value" or "Local notification category value" from the documentation table.'."\n"
."\n"
.'Purpose 2: After [applying for special permissions](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/faq-0000001050042183#section037425218509), used to identify high-priority pass-through scenarios with the following values:'."\n"
."\n"
.'- `VOIP`: Audio/video calls'."\n"
.'- `PLAY_VOICE`: Voice broadcast'."\n"
."\n"
.'> - For "Cloud notification category values" marked as "N/A", these go through the Alibaba Cloud proprietary channel.'."\n"
.'> - For "Local notification category values" marked as "N/A", these go through the Huawei channel.', 'type' => 'string', 'example' => 'VOIP', 'title' => ''],
'Urgency' => [
'description' => 'Huawei channel notification delivery priority. Values:'."\n"
."\n"
.'- `HIGH`'."\n"
.'- `NORMAL`'."\n"
."\n"
.'Requires permission application. For details, see: [Application link](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/faq-0000001050042183#section037425218509).',
'type' => 'string',
'example' => 'NORMAL',
'enum' => ['HIGH', 'NORMAL'],
'title' => '',
],
'Importance' => [
'description' => 'Sets the Huawei notification message classification importance parameter, which determines the notification behavior on user devices. Values:'."\n"
."\n"
.'- `0`: Information marketing messages'."\n"
.'- `1`: Service and communication messages'."\n"
."\n"
.'> It is recommended to use `Category` for notification classification, which requires application on the Huawei platform. [Application link](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#section893184112272).',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
'enum' => ['0', '1'],
'title' => '',
],
'BusinessType' => [
'description' => 'Sets the Huawei Quick Notification parameter.'."\n"
.'- **0**: Send standard Huawei notification (default).'."\n"
.'- **1**: Send Huawei Quick Notification.',
'type' => 'integer',
'title' => '',
'example' => '1',
'format' => 'int32',
'enum' => ['0', '1'],
],
'LiveNotificationPayload' => ['description' => 'JSON string of the Huawei Android Live Notification data structure [LiveNotificationPayload](https://developer.huawei.com/consumer/cn/doc/HMSCore-References/rest-live-0000001562939968#ZH-CN_TOPIC_0000001700850537__p195121620102511). For development integration, see the [Huawei Live Notification Push Guide](https://help.aliyun.com/document_detail/2983768.html).', 'type' => 'string', 'title' => '', 'example' => '{'."\n"
.' "activityId": 1,'."\n"
.' "operation": 1,'."\n"
.' "event": "TAXI",'."\n"
.' "activityData": {'."\n"
.' "notificationData": {'."\n"
.' "type": 3'."\n"
.' }'."\n"
.' }'."\n"
.'}'],
],
'title' => '',
'example' => '',
],
'Honor' => [
'description' => 'Honor configuration',
'type' => 'object',
'properties' => [
'Importance' => [
'description' => 'Sets the Honor notification message classification importance parameter, which determines the notification behavior on user devices. Values:'."\n"
."\n"
.'- `0`: Information marketing messages'."\n"
.'- `1`: Service and communication messages'."\n"
."\n"
.'Requires application on the Honor platform. [Application link](https://developer.honor.com/cn/docs/11002/guides/notification-class#%E8%87%AA%E5%88%86%E7%B1%BB%E6%9D%83%E7%9B%8A%E7%94%B3%E8%AF%B7).',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
'enum' => ['0', '1'],
'title' => '',
],
],
'title' => '',
'example' => '',
],
'Xiaomi' => [
'description' => 'Xiaomi configuration',
'type' => 'object',
'properties' => [
'Channel' => ['description' => 'Sets the channelId for Xiaomi notification type. Requires application on the Xiaomi platform. See: [Application link](https://dev.mi.com/console/doc/detail?pId=2422#_4).'."\n"
."\n"
.'> A single application can apply for up to 8 channels on the Xiaomi channel. Please plan ahead.', 'type' => 'string', 'example' => 'michannel', 'title' => ''],
'FocusParam' => ['description' => 'JSON string of the Xiaomi Super Island data structure [miui.focus.param](https://dev.mi.com/xiaomihyperos/documentation/detail?pId=2131). For development integration, see the [Xiaomi Super Island Push Guide](https://help.aliyun.com/zh/document_detail/3037956.html).', 'type' => 'string', 'title' => '', 'example' => '{'."\n"
.' "param_v2": {'."\n"
.' "business": "taxi",'."\n"
.' "updatable": true,'."\n"
.' "orderId": "A580202509130712",'."\n"
.' "param_island": {'."\n"
.' "islandProperty": 1,'."\n"
.' "bigIslandArea": {'."\n"
.' "imageTextInfoLeft": {'."\n"
.' "type": 1'."\n"
.' }'."\n"
.' }'."\n"
.' }'."\n"
.' }'."\n"
.'}'],
'FocusPics' => ['description' => 'JSON string of the Xiaomi Super Island data images [miui.focus.pic_xxx](https://dev.mi.com/xiaomihyperos/documentation/detail?pId=2131). For development integration, see the [Xiaomi Super Island Push Guide](https://help.aliyun.com/zh/document_detail/3037956.html).', 'type' => 'string', 'title' => '', 'example' => '{'."\n"
.' "miui.focus.pic_ticker": "https://example.com/ticker.jpg",'."\n"
.' "miui.focus.pic_aod": "https://example.com/aod.jpg",'."\n"
.' "miui.focus.pic_imageText": "https://example.com/imageText.jpg"'."\n"
.'}'],
'TemplateId' => ['description' => 'Xiaomi private message template ID', 'type' => 'string', 'title' => '', 'example' => 'P10645'],
'TemplateParams' => ['description' => 'Xiaomi private message template parameters, JSON string', 'type' => 'string', 'title' => '', 'example' => '{"keywords1":"Tom","keywords2":"phone"}'],
],
'title' => '',
'example' => '',
],
'Vivo' => [
'description' => 'vivo configuration',
'type' => 'object',
'properties' => [
'Category' => [
'description' => 'vivo classifies messages into two categories: system messages and operational messages.'."\n"
."\n"
.'**System messages:**'."\n"
."\n"
.'- IM: Instant messages'."\n"
.'- ACCOUNT: Account & assets'."\n"
.'- TODO: Schedule & to-do'."\n"
.'- DEVICE_REMINDER: Device information'."\n"
.'- ORDER: Orders & logistics'."\n"
.'- SUBSCRIPTION: Subscription reminders'."\n"
."\n"
.'**Operational messages:**'."\n"
."\n"
.'- NEWS: News'."\n"
.'- CONTENT: Content recommendations'."\n"
.'- MARKETING: Operational activities'."\n"
.'- SOCIAL: Social updates'."\n"
."\n"
.'For details, see [vivo classification documentation](https://dev.vivo.com.cn/documentCenter/doc/359#s-ef3qugc3).',
'type' => 'string',
'example' => 'MARKETING',
'enum' => ['IM', 'ACCOUNT', 'DEVICE_REMINDER', 'ORDER', 'TODO', 'SUBSCRIPTION', 'NEWS', 'CONTENT', 'MARKETING', 'SOCIAL'],
'title' => '',
],
'ReceiptId' => ['description' => 'Message receipt identifier for the vivo vendor push channel, used to receive push result callback notifications.'."\n"
."\n"
.'> - Location: vivo Open Platform → Push Service → Application Info → Receipt Configuration'."\n"
.'> - Recommendation: Configure the default receipt ID in the Alibaba Cloud EMAS console first.'."\n"
.'> - Usage condition: Only required when the default receipt on the vivo platform is not an Alibaba Cloud receipt.', 'type' => 'string', 'example' => '1232221', 'title' => ''],
'Importance' => [
'description' => 'Sets the vivo notification message classification. Values:'."\n"
."\n"
.'- `0`: Operational messages (default)'."\n"
.'- `1`: System messages'."\n"
."\n"
.'> It is recommended to use `Category` for notification classification, which requires application on the vivo platform. See: [Application link](https://dev.vivo.com.cn/documentCenter/doc/359).',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
'enum' => ['0', '1'],
'title' => '',
],
'LiveMessage' => ['description' => 'JSON string of the vivo Atomic Island data structure [liveMessage](https://dev.vivo.com.cn/documentCenter/doc/896#s-fdagzbd4). For development integration, see the [vivo Atomic Island Push Guide](https://help.aliyun.com/zh/document_detail/3030718.html).', 'type' => 'string', 'title' => '', 'example' => '{'."\n"
.' "operation": 0,'."\n"
.' "scene": "HEALTH_REGISTER",'."\n"
.' "templateType": 1,'."\n"
.' "showNotify": true,'."\n"
.' "changeRecord": 999,'."\n"
.' "capsuleData": {'."\n"
.' "bgColor": "#32d4d4"'."\n"
.' }'."\n"
.'}'],
],
'title' => '',
'example' => '',
],
'Oppo' => [
'description' => 'OPPO configuration',
'type' => 'object',
'properties' => [
'Category' => [
'description' => 'OPPO classifies messages into two categories: Communication & Service, and Content & Marketing.'."\n"
."\n"
.'**Communication & Service (requires permission application):**'."\n"
."\n"
.'- IM: Instant messages'."\n"
.'- ACCOUNT: Account & assets'."\n"
.'- TODO: Schedule & to-do'."\n"
.'- DEVICE_REMINDER: Device information'."\n"
.'- ORDER: Orders & logistics'."\n"
.'- SUBSCRIPTION: Subscription reminders'."\n"
."\n"
.'**Content & Marketing:**'."\n"
."\n"
.'- NEWS: News'."\n"
.'- CONTENT: Content recommendations'."\n"
.'- MARKETING: Operational activities'."\n"
.'- SOCIAL: Social updates'."\n"
."\n"
.'For details, see [OPPO classification documentation](https://open.oppomobile.com/new/developmentDoc/info?id=13189).',
'type' => 'string',
'example' => 'NEWS',
'enum' => ['IM', 'ACCOUNT', 'DEVICE_REMINDER', 'ORDER', 'TODO', 'SUBSCRIPTION', 'NEWS', 'CONTENT', 'MARKETING', 'SOCIAL'],
'title' => '',
],
'NotifyLevel' => [
'description' => 'OPPO channel notification bar message alert level. Allowed values:'."\n"
."\n"
.'- `1`: Notification bar'."\n"
.'- `2`: Notification bar, lock screen, ringtone, vibration (default notification level for Communication & Service messages)'."\n"
.'- `16`: Notification bar, lock screen, ringtone, vibration, banner (requires permission application)'."\n"
."\n"
.'> When using the `NotifyLevel` parameter, the `Category` parameter must also be provided.',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
'enum' => ['1', '2', '16'],
'title' => '',
],
'PrivateMsgTemplateId' => ['description' => 'OPPO private message template ID', 'type' => 'string', 'title' => '', 'example' => '687557242b1634hzefs3d5013'],
'PrivateTitleParameters' => ['description' => 'OPPO private message template title parameters', 'type' => 'string', 'title' => '', 'example' => '{"name": "张三"}'],
'PrivateContentParameters' => ['description' => 'OPPO private message template content parameters', 'type' => 'string', 'title' => '', 'example' => '{'."\n"
.'"key1": "value1",'."\n"
.'"key2": "value2"'."\n"
.'}'],
'IntelligentIntent' => ['description' => 'JSON string of the OPPO Fluid Cloud intent sharing data structure [IntelligentIntent](https://open.oppomobile.com/documentation/page/info?id=13565). For development integration, see the [OPPO Fluid Cloud Push Guide](https://help.aliyun.com/document_detail/2997310.html).', 'type' => 'string', 'title' => '', 'example' => '{'."\n"
.' "intentName": "Example.Progress",'."\n"
.' "identifier": "d71ebd3119877b12ecdb6c4fe96b068e",'."\n"
.' "timestamp": 1729485000989,'."\n"
.' "serviceId": {'."\n"
.' "launcher": "999800001",'."\n"
.' "fluidCloud": "999900001"'."\n"
.' },'."\n"
.' "intentAction": {'."\n"
.' "actionStatus": 0'."\n"
.' },'."\n"
.' "intentEntity": {'."\n"
.' "entityName": "TAXI"'."\n"
.' }'."\n"
.'}'],
'DeleteIntentData' => ['description' => 'JSON string of the OPPO Fluid Cloud intent deletion data structure [data](https://open.oppomobile.com/documentation/page/info?id=13578). This parameter is ignored when the AndroidOppoIntelligentIntent parameter is already set. For development integration, see the [OPPO Fluid Cloud Push Guide](https://help.aliyun.com/document_detail/2997310.html).', 'type' => 'string', 'title' => '', 'example' => '{'."\n"
.' "intentName": "Example.Progress",'."\n"
.' "entityIds": ['."\n"
.' "A580202509130712"'."\n"
.' ],'."\n"
.' "serviceId": {'."\n"
.' "launcher": "999800001",'."\n"
.' "fluidCloud": "999900001"'."\n"
.' }'."\n"
.'}'],
],
'title' => '',
'example' => '',
],
'Meizu' => [
'description' => 'Meizu configuration',
'type' => 'object',
'properties' => [
'NoticeMsgType' => [
'description' => 'Meizu message type'."\n"
."\n"
.'- 0: Public message (default)'."\n"
.'- 1: Private message',
'type' => 'integer',
'title' => '',
'example' => '0',
'format' => 'int32',
'enum' => ['0', '1'],
],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Options' => [
'description' => 'Push options',
'type' => 'object',
'properties' => [
'UseChannels' => ['description' => 'Specifies the delivery channels. Values:'."\n"
."\n"
.'- `accs` Alibaba Cloud proprietary channel'."\n"
.'- `huawei` Huawei channel'."\n"
.'- `honor` Honor channel'."\n"
.'- `xiaomi` Xiaomi channel'."\n"
.'- `oppo` OPPO channel'."\n"
.'- `vivo` vivo channel'."\n"
.'- `meizu` Meizu channel'."\n"
.'- `fcm` Google Firebase channel (HTTP v1 API)'."\n"
.'- `apns` APNs channel'."\n"
.'- `harmony` HarmonyOS channel'."\n"
."\n"
.'> - If this parameter is not configured, all channels are available.'."\n"
.'> - If configured, only the specified channels will be used.'."\n"
.'> - If the configured channels conflict with the delivery strategy (e.g., iOS notification should only go through APNs channel, but this parameter does not include apns), delivery will not be performed.', 'type' => 'string', 'example' => 'accs,apns', 'title' => ''],
'PushTime' => ['description' => 'Specifies the message delivery time, up to 7 days in the future. Only effective when the `Action` parameter is `SCHEDULED_PUSH`.'."\n"
."\n"
.'> Uses the ISO 8601 standard with UTC time, in the format yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2025-06-19T12:00:00Z', 'title' => ''],
'ExpireTime' => ['description' => 'Sets the message expiration time. Messages will no longer be sent after expiration, with a maximum retention of 72 hours.'."\n"
."\n"
.'> * Uses the ISO 8601 standard with UTC time, in the format YYYY-MM-DDThh:mm:ssZ.'."\n"
.'> * The expiration time must satisfy: ExpireTime > PushTime + 3 seconds (3 seconds is the margin for network and system latency).'."\n"
.'> * Recommendation: Set the expiration time to no less than 1 minute for single push, and no less than 10 minutes for full or batch push.'."\n"
."\n\n"
.'><notice>For pass-through messages, not setting an expiration time means only online delivery. When the device is offline, the message will be discarded.></notice>', 'type' => 'string', 'example' => '2025-06-21T12:00:00Z', 'title' => ''],
'JobKey' => ['description' => 'Custom identifier for the push task. When JobKey is not empty, the receipt log will include this field. See [Receipt logs](https://help.aliyun.com/document_detail/434651.html) for viewing receipt logs.', 'type' => 'string', 'example' => 'jobkey1727749697913', 'title' => ''],
'Trim' => ['description' => 'Whether to automatically truncate titles and content that exceed length limits.'."\n"
."\n"
.'> Only applicable to vendor channels that explicitly limit title and content length. Not applicable to APNs, Huawei, Honor channels, etc., which only limit the total request body size rather than title/content individually.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'Sms' => [
'description' => 'Supplementary SMS delivery.'."\n"
."\n"
.'> Currently only supports `Android` and `HarmonyOS` devices.',
'type' => 'object',
'properties' => [
'TemplateName' => ['description' => 'SMS template name. Can be obtained from the SMS template management interface. This is the system-assigned name, not the name set by the developer.', 'type' => 'string', 'example' => 'SMS_123456789', 'title' => ''],
'SignName' => ['description' => 'SMS signature.', 'type' => 'string', 'example' => '某某科技', 'title' => ''],
'Params' => ['description' => 'Key-value pairs for SMS template variables.', 'type' => 'string', 'example' => 'key1=value1&key2=value2', 'title' => ''],
'DelaySecs' => ['description' => 'Delay time for triggering SMS, in seconds.'."\n"
."\n"
.'Must be set when using SMS linkage. Recommended to be set to 15 seconds or more, with a maximum of 3 days, to avoid duplication between SMS and push notifications.'."\n"
."\n"
.'> When using SMS linkage, the ExpireTime parameter is ineffective. The notification expiration time is calculated based on the DelaySecs parameter, with the expiration time being the current time plus the DelaySecs value.', 'type' => 'integer', 'format' => 'int64', 'example' => '150', 'title' => ''],
'SendPolicy' => [
'description' => 'SMS delivery policy.',
'enumValueTitles' => ['PUSH_NOT_RECEIVED' => 'Triggered when push is not received', 'USER_NOT_OPENED' => 'Triggered when user has not opened'],
'type' => 'string',
'example' => 'PUSH_NOT_RECEIVED',
'enum' => ['PUSH_NOT_RECEIVED', 'USER_NOT_OPENED'],
'title' => '',
],
],
'title' => '',
'example' => '',
],
'MessageId' => ['description' => 'Unique ID used to identify the message. Only effective when the `Action` parameter is `CONTINUOUS_PUSH`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1174754033128****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'apis' => [
'BindAlias' => [
'summary' => 'Attach an alias to a device.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'Your AppKey.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => 'The unique identifier of the device in Mobile Push. It is 32 characters long and contains only numbers and lowercase letters.', 'type' => 'string', 'required' => true, 'example' => 'e2ba19de97604f55b16557673****', 'title' => ''],
],
[
'name' => 'AliasName',
'in' => 'query',
'schema' => ['description' => 'The alias to attach.'."\n"
."\n"
.'You can attach up to 10 aliases in one request. Separate multiple aliases with commas. Each alias can be up to 128 bytes long. Chinese characters count as three bytes each. A device can have up to 128 aliases attached. An alias can be attached to up to 128 devices.', 'type' => 'string', 'required' => true, 'example' => 'test_alias', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '159E4422-6624-4750-8943-DFD98D34858C', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Invalid%s.Format', 'errorMessage' => 'The specified %s format is invalid.', 'description' => ''],
['errorCode' => 'Invalid%s.BytesExceed', 'errorMessage' => 'The specified %s exceeds the %s bytes limit.', 'description' => ''],
['errorCode' => 'AccountDisabled', 'errorMessage' => 'Your account is not enabled.', 'description' => ''],
['errorCode' => 'Invalid%s.NotFound', 'errorMessage' => 'The specified %s is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.', 'description' => 'The request processing has failed due to some unknown error.'],
],
],
'title' => 'Attach Alias',
'description' => 'You can attach up to 10 aliases in a single request. The attachment takes effect immediately.',
'changeSet' => [
['createdAt' => '2021-12-27T12:34:38.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindAlias'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'mpush:BindAlias',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"159E4422-6624-4750-8943-DFD98D34858C\\"\\n}","type":"json"}]',
],
'BindPhone' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => 'AppKey information.',
'enumValueTitles' => [23793506 => '23793506', 24738888 => '24738888', 27725900 => '27725900', 27819095 => '27819095'],
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '27725900',
'title' => '',
],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => [
'description' => 'The unique identity of the device, 32-bit, a combination of numbers and lowercase letters.',
'enumValueTitles' => ['abcdef1d83d04d34807d229999eefa52' => 'abcdef1d83d04d34807d229999eefa52'],
'type' => 'string',
'required' => true,
'example' => 'eb5f741d83d04d34807d229999eefa52',
'title' => '',
],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
'schema' => [
'description' => 'Phone number.',
'enumValueTitles' => [23456789102 => '23456789102'],
'type' => 'string',
'required' => true,
'example' => '1381111****',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '0D1126F0-F8FF-513D-BAFA-F140447BDED4', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Attach Phone Number',
'summary' => 'Attaches a device to a phone number.',
'changeSet' => [
['createdAt' => '2024-01-25T04:05:39.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-25T04:05:39.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-25T04:05:39.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindPhone'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'mpush:BindPhone',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0D1126F0-F8FF-513D-BAFA-F140447BDED4\\"\\n}","type":"json"}]',
],
'BindTag' => [
'summary' => 'Binds tags to specified device targets. Tag bindings take effect within 10 minutes.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'The AppKey of your application.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'ClientKey',
'in' => 'query',
'schema' => ['description' => 'The ID of the target device. You can specify a maximum of 1,000 device IDs.', 'type' => 'string', 'required' => true, 'example' => 'e2ba19de97604f55b16557673****', 'title' => ''],
],
[
'name' => 'KeyType',
'in' => 'query',
'schema' => [
'description' => 'The type of the `ClientKey`. Valid value:'."\n"
."\n"
.'- **DEVICE**: Indicates a device target.',
'enumValueTitles' => [],
'type' => 'string',
'required' => true,
'enum' => ['DEVICE', 'ACCOUNT', 'ALIAS'],
'example' => 'DEVICE',
'title' => '',
],
],
[
'name' => 'TagName',
'in' => 'query',
'schema' => ['description' => 'The tags to bind. Separate multiple tags with commas (,). You can bind up to 10 tags per request.'."\n"
.'A tag name can be up to 128 characters long (each Chinese character counts as 1 character). Each application can have up to 10,000 tags. A single device can be bound to multiple tags.'."\n"
."\n"
.'><notice>'."\n"
."\n"
.'Do not bind a single tag to more than 100,000 devices. This practice can increase push processing time and increase response time.'."\n"
."\n"
.'- Use the full push feature to send notifications to all devices.'."\n"
."\n"
.'- Split the device set into multiple fine-grained tags and call the push API in batches.'."\n"
."\n"
.'></notice>'."\n"
."\n"
.'> - If you attempt to bind the same tag multiple times, the system automatically removes the duplicates.'."\n"
.'>'."\n"
.'> - When a user uninstalls the application from a device, the tags associated with that device are automatically unbound. This unbinding process may be slightly delayed.', 'type' => 'string', 'required' => true, 'example' => 'test_tag,test_tag2', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '82FD0A09-5BB8-40FB-8221-9A11FE92D620', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'AccountDisabled', 'errorMessage' => 'Your account is not enabled.', 'description' => ''],
['errorCode' => 'Invalid%s.Format', 'errorMessage' => 'The specified %s format is invalid.', 'description' => ''],
['errorCode' => 'Invalid%s.NotFound', 'errorMessage' => 'The specified %s is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.', 'description' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82FD0A09-5BB8-40FB-8221-9A11FE92D620\\"\\n}","type":"json"}]',
'title' => 'Attach Tags ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-12-27T12:34:38.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindTag'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'mpush:BindTag',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CancelPush' => [
'summary' => 'Cancels a scheduled push task that has not yet been executed.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'Your AppKey.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'MessageId',
'in' => 'query',
'schema' => ['description' => 'The message ID of the push task to cancel.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '501029', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Cancel Scheduled Push Task',
'changeSet' => [
['createdAt' => '2024-01-22T14:27:53.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:53.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:53.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelPush'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:CancelPush',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","type":"json"}]',
],
'CheckCertificate' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'The AppKey of the application.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '1000000000', 'minimum' => '0', 'example' => '23267207', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC', 'title' => ''],
'Android' => [
'description' => 'Indicates whether the AppKey belongs to an Android app:'."\n"
."\n"
.'- true'."\n"
."\n"
.'- false',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'boolean',
'example' => 'false',
'title' => '',
],
'IOS' => [
'description' => 'Indicates whether the AppKey belongs to an iOS app:'."\n"
."\n"
.'- true'."\n"
."\n"
.'- false',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
'ProductionCertInfo' => [
'description' => 'The information about the certificate for the production environment.',
'properties' => [
'Status' => [
'description' => 'The status of the certificate. Valid values:'."\n"
."\n"
.'- **EXPIRED**: The certificate is expired.'."\n"
."\n"
.'- **NOT\\_CONFIGURED**: The certificate is not configured.'."\n"
."\n"
.'- **NO\\_PASSWORD**: The password for the certificate is not configured.'."\n"
."\n"
.'- **OK**: The certificate is normal.'."\n"
."\n"
.'- **REVOKED**: The certificate is revoked.',
'enumValueTitles' => ['REVOKED' => 'REVOKED', 'NO_PASSWORD' => 'NO\\_PASSWORD', 'EXPIRED' => 'EXPIRED', 'NOT_CONFIGURED' => 'NOT\\_CONFIGURED', 'OK' => 'OK'],
'type' => 'string',
'example' => 'OK',
'title' => '',
],
'ExipreTime' => ['description' => 'The expiration time of the certificate.', 'type' => 'integer', 'format' => 'int64', 'example' => '1764561600000', 'title' => ''],
],
'type' => 'object',
'title' => '',
'example' => '',
],
'DevelopmentCertInfo' => [
'description' => 'The information about the certificate for the development or sandbox environment.',
'properties' => [
'Status' => [
'description' => 'The status of the certificate. Valid values:'."\n"
."\n"
.'- **EXPIRED**: The certificate is expired.'."\n"
."\n"
.'- **NOT\\_CONFIGURED**: The certificate is not configured.'."\n"
."\n"
.'- **NO\\_PASSWORD**: The password for the certificate is not configured.'."\n"
."\n"
.'- **OK**: The certificate is normal.'."\n"
."\n"
.'- **REVOKED**: The certificate is revoked.',
'enumValueTitles' => ['REVOKED' => 'REVOKED', 'NO_PASSWORD' => 'NO\\_PASSWORD', 'EXPIRED' => 'EXPIRED', 'NOT_CONFIGURED' => 'NOT\\_CONFIGURED', 'OK' => 'OK'],
'type' => 'string',
'example' => 'EXPIRED',
'title' => '',
],
'ExipreTime' => ['description' => 'The expiration time of the certificate.', 'type' => 'integer', 'format' => 'int64', 'example' => '1470024000000', 'title' => ''],
],
'type' => 'object',
'title' => '',
'example' => '',
],
],
'type' => 'object',
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Invalid%s.NotFound', 'errorMessage' => 'The specified %s is not found.', 'description' => ''],
['errorCode' => 'AccountDisabled', 'errorMessage' => 'Your account is not enabled.', 'description' => ''],
['errorCode' => 'PermissionDenied', 'errorMessage' => 'The specified AppKey is not authorized.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.', 'description' => 'The request processing has failed due to some unknown error.'],
],
],
'title' => 'Query certificate status',
'summary' => 'Checks the expiration time and current status of the iOS certificate for a specified app.',
'description' => '- If the returned ExpireTime value is later than the current timestamp, the certificate is not necessarily valid. Also verify that the Status is OK.'."\n"
."\n"
.'- The REVOKED status originates from the Apple Push Notification service (APNs) server. If a certificate has a REVOKED status, at least one push notification to APNs has failed in the corresponding environment.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckCertificate'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:CheckCertificate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"Android\\": false,\\n \\"IOS\\": true,\\n \\"ProductionCertInfo\\": {\\n \\"Status\\": \\"OK\\",\\n \\"ExipreTime\\": 1764561600000\\n },\\n \\"DevelopmentCertInfo\\": {\\n \\"Status\\": \\"EXPIRED\\",\\n \\"ExipreTime\\": 1470024000000\\n }\\n}","type":"json"}]',
],
'CheckDevice' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'The AppKey value.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23419851', 'title' => ''],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => 'The unique identity of the device in Push. It is 32 characters long and contains only digits and lowercase letters.', 'type' => 'string', 'required' => true, 'example' => 'ae296f3b04a58a05b30c95f****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Available' => ['description' => 'Indicates whether the device is active.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => [
'substitutions' => ['Push::2016-08-01::CheckDevices'],
],
'title' => 'Authenticate Device Validity',
'summary' => 'Validates the specified (device).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-03-31T08:27:33.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckDevice'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:CheckDevice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Available\\": true,\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","type":"json"}]',
],
'CheckDevices' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'The AppKey value.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23419851', 'title' => ''],
],
[
'name' => 'DeviceIds',
'in' => 'query',
'schema' => ['description' => 'The unique identifier for each device in the push service. Each ID is 32 characters long and contains only digits and lowercase letters. Separate multiple IDs with commas. You can check up to 100 devices per request.', 'type' => 'string', 'required' => true, 'example' => 'ae296f3b04a58a05b30c95f****,ae296f3b04a58a05b30c95f****,ae296f3b04a58a05b30c95f****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC', 'title' => ''],
'DeviceCheckInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DeviceCheckInfo' => [
'description' => 'The results of the batch device validation.',
'type' => 'array',
'items' => [
'properties' => [
'DeviceId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => 'ae296f3b04a58a05b30c95f****', 'title' => ''],
'Available' => ['description' => 'Indicates whether the device is active.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'type' => 'object',
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'type' => 'object',
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Batch check device validity',
'summary' => 'Validate a specified group of devices.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-01-24T15:21:51.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-24T15:21:51.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-24T15:21:51.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckDevices'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:CheckDevices',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"DeviceCheckInfos\\": {\\n \\"DeviceCheckInfo\\": [\\n {\\n \\"DeviceId\\": \\"ae296f3b04a58a05b30c95f****\\",\\n \\"Available\\": true\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'CompleteContinuouslyPush' => [
'summary' => 'Manually ends a continuous push task.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'The AppKey value.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'MessageId',
'in' => 'query',
'schema' => ['description' => 'The message ID.'."\n"
."\n"
.'This ID is returned after you call the Push operation and set Target to TBD. It identifies a message saved in the push system.', 'type' => 'string', 'required' => true, 'example' => '500131', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => ['description' => 'The message ID for the push request.', 'type' => 'string', 'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '500131', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Complete a Continuous Push Task ',
'description' => 'If you do not call this operation, the continuous push task automatically ends when it reaches its time-to-live (TTL).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'changeSet' => [
['createdAt' => '2024-01-22T14:27:53.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CompleteContinuouslyPush'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'mpush:CompleteContinuouslyPush',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"RequestId\\": \\"500131\\"\\n}","type":"json"}]',
],
'ContinuouslyPush' => [
'summary' => 'Executes a predefined continuous push task.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'AppKey information.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'MessageId',
'in' => 'query',
'schema' => ['description' => 'Message ID.'."\n"
."\n"
.'Obtain this MessageId by calling the Push API with Target set to TBD. It represents a message already saved in the push system.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '500131', 'title' => ''],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => 'Push target:'."\n"
."\n"
.'- **DEVICE**: Push by device'."\n"
."\n"
.'- **ACCOUNT**: Push by account'."\n"
."\n"
.'- **ALIAS**: Push by alias'."\n"
."\n"
.'Continuous push supports only these three target types.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enum' => ['DEVICE', 'ACCOUNT', 'ALIAS'],
'example' => 'DEVICE',
'title' => '',
],
],
[
'name' => 'TargetValue',
'in' => 'query',
'schema' => ['description' => 'Specify values based on Target. Separate multiple values with commas. If you exceed the limit, split the push into multiple calls.'."\n"
."\n"
.'- Target=DEVICE: values such as `deviceid1,deviceid2` (up to 1,000 supported).'."\n"
."\n"
.'- Target=ACCOUNT: values such as `account1,account2` (up to 1,000 supported).'."\n"
."\n"
.'- Target=ALIAS: values such as `alias1,alias2` (up to 1,000 supported).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a692961a92534047ad3625****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'MessageId' => ['description' => 'The message ID that identifies a push request.', 'type' => 'string', 'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC', 'title' => ''],
'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '500131', 'title' => ''],
],
'type' => 'object',
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ContinuouslyPush',
'description' => 'This API addresses the limitations of the [Push Advanced Push API](~~2249916~~), where push-by-device, push-by-account, and push-by-alias operations each have a maximum target count per single call.'."\n"
."\n"
.'- You can use continuous push when your scenario requires sending the same message to many devices. In this case, you can call the continuous push API repeatedly, each time specifying a group of targets for aggregation (the current limit is 1,000 targets per call for device, account, or alias pushes). The total number of pushes for the same MessageId is restricted to 10,000. If you need a higher limit, contact technical support to evaluate your specific scenario.'."\n"
."\n"
.'- Before using this API, you must first call the Push API with Target set to TBD (To Be Determined) and include your message content. This returns a MessageId from the push system. You can then use this MessageId to repeatedly call the continuous push API, specifying different target groups to deliver the same message.'."\n"
."\n"
.'- After calling the Push API with Target set to TBD and obtaining a MessageId, the message is stored in the push system for 24 hours by default. You can use this API to push to specified targets at any time before expiration. Pushes are not allowed after expiration or after reaching the total push limit.'."\n"
."\n"
.'- Each call to this API sends the message immediately. Scheduled pushes are not supported.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '## Java示例代码'."\n"
.'```'."\n"
.'ContinuouslyPushRequest continuouslyPushRequest = new ContinuouslyPushRequest();'."\n"
.'continuouslyPushRequest.setAppKey(appKey);'."\n"
.'// 设置持续推送的消息Id'."\n"
.'continuouslyPushRequest.setMessageId("500131");'."\n"
.'// 指定推送目标'."\n"
.'// 可以继续用同一个`MessageId`,调用此接口指定其它设备,继续推送'."\n"
.'continuouslyPushRequest.setTarget("DEVICE");'."\n"
.'continuouslyPushRequest.setTargetValue("a692961a92534047ad362575f31f57b7");'."\n"
.'ContinuouslyPushResponse continuouslyPushResponse = client.getAcsResponse(continuouslyPushRequest);'."\n"
.'System.out.printf("RequestId: %s, MessageId: %s\\n",'."\n"
.' continuouslyPushResponse.getRequestId(), continuouslyPushResponse.getMessageId());'."\n"
.'```',
'changeSet' => [
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ContinuouslyPush'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:ContinuouslyPush',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"RequestId\\": \\"500131\\"\\n}","type":"json"}]',
],
'ListSummaryApps' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREemasASSZZG'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC', 'title' => ''],
'SummaryAppInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SummaryAppInfo' => [
'description' => 'Application details, a collection of SummaryAppInfo.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AppKey' => ['description' => 'AppKey information.', 'type' => 'integer', 'format' => 'int64', 'example' => '23****07', 'title' => ''],
'AppName' => ['description' => 'Application name.', 'type' => 'string', 'example' => 'abc', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => [
'substitutions' => ['Mhub::2017-08-25::ListApps'],
],
'title' => 'Query the list of applications created by the user',
'summary' => 'Retrieve the list of all applications associated with your Alibaba Cloud account.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSummaryApps'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'mpush:ListSummaryApps',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"SummaryAppInfos\\": {\\n \\"SummaryAppInfo\\": [\\n {\\n \\"AppKey\\": 0,\\n \\"AppName\\": \\"abc\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListTags' => [
'summary' => 'Queries the tags of an app. A maximum of 100 records are returned.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'AppKey information.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23267207', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '6EEF262B-EA7D-41DC-89B9-20F3D1E28194', 'title' => ''],
'TagInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagInfo' => [
'description' => 'Tag list.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagName' => ['description' => 'Tag name.', 'type' => 'string', 'example' => 'test_tag2', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'Timeout', 'errorMessage' => 'The request processing is timeout.', 'description' => 'Request processing timed out.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.', 'description' => 'The request processing has failed due to some unknown error.'],
],
],
'title' => 'Obtain the tag list',
'changeSet' => [
['createdAt' => '2024-01-24T15:21:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-24T15:21:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-24T15:21:50.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTags'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'mpush:ListTags',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EEF262B-EA7D-41DC-89B9-20F3D1E28194\\",\\n \\"TagInfos\\": {\\n \\"TagInfo\\": [\\n {\\n \\"TagName\\": \\"test_tag2\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'MassPush' => [
'summary' => 'Push different messages/notifications to different devices in batch.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeNodes' => ['FEATUREemasBNY9P0', 'FEATUREemasTZ8VEZ'],
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'AppKey information.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'PushTask',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => 'An array of independent push tasks.',
'type' => 'array',
'items' => [
'description' => 'An independent push task.',
'type' => 'object',
'properties' => [
'PushType' => [
'description' => 'Push type. Valid values:'."\n"
."\n"
.'- MESSAGE: indicates a message.'."\n"
.'- NOTICE: indicates a notification.',
'enumValueTitles' => ['MESSAGE' => 'MESSAGE', 'NOTICE' => 'NOTICE'],
'type' => 'string',
'required' => true,
'example' => 'MESSAGE',
'title' => '',
],
'DeviceType' => [
'description' => 'Device type. Valid values:'."\n"
."\n"
.'- HARMONY: HarmonyOS device'."\n"
.'- iOS: iOS device'."\n"
.'- ANDROID: Android device'."\n"
.'- ALL: When the AppKey is for a legacy dual-platform app, this pushes to both Android and iOS devices simultaneously. When the AppKey is for a new single-platform app, the effect is the same as specifying the device type corresponding to the app type.',
'enumValueTitles' => ['ALL' => 'ALL', 'ANDROID' => 'ANDROID', 'iOS' => 'iOS'],
'type' => 'string',
'required' => true,
'example' => 'HARMONY',
'title' => '',
],
'Target' => [
'description' => 'Push target. Valid values:'."\n"
."\n"
.'- DEVICE: push by device.'."\n"
.'- ACCOUNT: push by account.'."\n"
.'- ALIAS: push by alias.',
'enumValueTitles' => ['ACCOUNT' => 'ACCOUNT', 'ALIAS' => 'ALIAS', 'DEVICE' => 'DEVICE'],
'type' => 'string',
'required' => true,
'example' => 'DEVICE',
'title' => '',
],
'TargetValue' => ['description' => 'Set based on Target. Multiple values are separated by commas. If the limit is exceeded, you need to split the push into multiple calls.'."\n"
."\n"
.'- Target=DEVICE: values such as `deviceid1,deviceid2` (up to 1,000 supported).'."\n"
.'- Target=ACCOUNT: values such as `account1,account2` (up to 1,000 supported).'."\n"
.'- Target=ALIAS: values such as `alias1,alias2` (up to 1,000 supported).', 'type' => 'string', 'required' => true, 'example' => 'deviceid1,deviceid2', 'title' => ''],
'StoreOffline' => ['description' => 'Whether to store offline messages/notifications. StoreOffline defaults to false.'."\n"
."\n"
.'If stored, when the user is offline during push, the message will be resent when the user comes online within the expiration time (ExpireTime). ExpireTime defaults to 72 hours. iOS notifications are delivered through the APNs channel and are not affected by StoreOffline.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'SendChannels' => ['description' => 'Specify sending channels. Valid values:'."\n"
."\n"
.'- accs: Alibaba Cloud proprietary channel'."\n"
.'- huawei: Huawei channel'."\n"
.'- honor: Honor channel'."\n"
.'- xiaomi: Xiaomi channel'."\n"
.'- oppo: OPPO channel'."\n"
.'- vivo: vivo channel'."\n"
.'- meizu: Meizu channel'."\n"
.'- gcm: Google GCM channel (legacy HTTP)'."\n"
.'- fcm: Google Firebase channel (HTTP v1 API)'."\n"
.'- apns: APNs channel'."\n"
.'- harmony: HarmonyOS channel'."\n"
."\n"
.'>- If this parameter is not configured, all channels are available.'."\n"
.'>- If this parameter is configured, only the specified channels are used.'."\n"
.'>- If the configured channels conflict with the sending strategy (e.g., iOS notifications only go through the APNs channel, but this parameter does not include apns), the push will not be sent.'."\n"
.'>- If gcm is configured, both Google GCM and FCM channels can be used. If fcm is configured, only the Google FCM channel can be used.', 'type' => 'string', 'required' => false, 'example' => 'accs,huawei,xiaomi', 'title' => ''],
'PushTime' => ['description' => 'Used for scheduled sending. If not set, the default is immediate sending.'."\n"
."\n"
.'The time format follows the ISO 8601 standard and must use UTC time in the format YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2019-02-20T00:00:00Z', 'title' => ''],
'ExpireTime' => ['description' => 'Expiration time of offline messages/notifications. Used together with StoreOffline. Expired messages will no longer be sent. The maximum retention period is 72 hours. The default is 72 hours.'."\n"
."\n"
.'The time format follows the ISO 8601 standard and must use UTC time in the format YYYY-MM-DDThh:mm:ssZ. The expiration time cannot be earlier than the current time or the scheduled push time plus 3 seconds (`ExpireTime > PushTime + 3 seconds`). The 3-second buffer accounts for network and system latency. We recommend at least 1 minute for unicast pushes and at least 10 minutes for broadcast and batch pushes.', 'type' => 'string', 'required' => false, 'example' => '2019-02-20T00:00:00Z', 'title' => ''],
'JobKey' => ['description' => 'Custom identifier for the push task. When JobKey is not empty, this field will be included in the receipt logs. For receipt log details, see [Receipt Logs](~~434651~~).', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''],
'Title' => ['description' => 'Title of the notification/message during push. Length limit: 200 bytes.'."\n"
.'Required for Android and HarmonyOS pushes. Optional for iOS push notifications. If provided:'."\n"
.'* iOS 10+: the notification displays the title.'."\n"
.'* iOS 8.2 <= iOS version < iOS 10: replaces the notification app name.', 'type' => 'string', 'required' => false, 'example' => 'title', 'title' => ''],
'Body' => ['description' => 'Content of the notification/message for Android and HarmonyOS pushes; iOS message/notification content. The push content size is limited. See [Product Limits](~~92832~~).', 'type' => 'string', 'required' => false, 'example' => 'hello', 'title' => ''],
'Trim' => ['description' => 'Whether to automatically truncate titles and content that are too long.'."\n"
.'Note: This only applies to vendor channels that explicitly limit title and content length. It does not apply to channels like APNs, Huawei, and Honor that do not limit title and content individually but only limit the total request body size.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
'iOSApnsEnv' => [
'description' => 'iOS notifications are sent through the APNs center. You need to specify the corresponding environment information.'."\n"
."\n"
.'- DEV: Development environment, applicable to apps installed and debugged directly via Xcode.'."\n"
.'- PRODUCT: Production environment, applicable to apps distributed through App Store, TestFlight, Ad Hoc, and enterprise distribution.',
'enumValueTitles' => ['DEV' => 'DEV', 'PRODUCT' => 'PRODUCT'],
'type' => 'string',
'required' => false,
'example' => 'DEV',
'title' => '',
],
'iOSRemind' => ['description' => 'When the device is offline during message push (i.e., the persistent connection channel to the Mobile Push server is disconnected), this push will be delivered as a notification through Apple\'s APNs channel once.'."\n"
."\n"
.'> Offline message-to-notification conversion only applies to the production environment.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'iOSSubtitle' => ['description' => 'iOS notification subtitle content (iOS 10+).', 'type' => 'string', 'required' => false, 'example' => 'subtitle', 'title' => ''],
'iOSRemindBody' => ['description' => 'iOS notification content used when converting iOS messages to notifications. Only valid when iOSApnsEnv=PRODUCT and iOSRemind is true.', 'type' => 'string', 'required' => false, 'example' => 'ios通知body', 'title' => ''],
'iOSMusic' => ['description' => 'iOS notification sound. Specify the name of an audio file stored in the app bundle or the sandbox Library/Sounds directory. See: How to set notification sound for iOS push.'."\n"
."\n"
.'If set to an empty string (""), the notification is silent. If not set, the default system alert sound is used.', 'type' => 'string', 'required' => false, 'example' => '””', 'title' => ''],
'iOSBadge' => ['description' => 'iOS app icon badge number in the upper-right corner.'."\n"
."\n"
.'> If iOSBadgeAutoIncrement is set to True, this field must be empty.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
'iOSBadgeAutoIncrement' => ['description' => 'Whether to enable badge auto-increment. Defaults to false.'."\n"
."\n"
.'> When this is set to true, iOSBadge must be empty.'."\n"
."\n"
.'The badge auto-increment feature is maintained by the push server for each device\'s badge count. Users must use SDK version V1.9.5 or later and actively sync the badge number to the server.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'iOSSilentNotification' => ['description' => 'Whether to enable iOS silent notification.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'iOSMutableContent' => ['description' => 'iOS notification processing extension flag (iOS 10+). If set to true, APNs push notifications can reach the Extension for processing before being displayed. Must be set to true for silent notifications.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'iOSNotificationCategory' => ['description' => 'Specify the iOS notification Category (iOS 10+).', 'type' => 'string', 'required' => false, 'example' => 'ios', 'title' => ''],
'iOSNotificationCollapseId' => ['description' => 'When a device receives messages with the same CollapseId, they are merged into one. When the device is offline, consecutive messages with the same CollapseId will show only one notification in the notification bar. Supported on iOS 10+.', 'type' => 'string', 'required' => false, 'example' => 'ZD2011', 'title' => ''],
'iOSNotificationThreadId' => ['description' => 'Groups iOS remote notifications using this property, marking the group identifier for collapsed notifications. Only supported on iOS 12.0+.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''],
'iOSInterruptionLevel' => [
'description' => 'Interruption level. Valid values:'."\n"
."\n"
.'- passive: The system adds the notification to the notification list without lighting up the screen or playing sound.'."\n"
."\n"
.'- active: The system immediately displays the notification, lights up the screen, and can play sound.'."\n"
."\n"
.'- time-sensitive: The system immediately presents the notification, lights up the screen, and can play sound, but does not break through system notification controls.'."\n"
."\n"
.'- critical: The system immediately displays the notification, lights up the screen, and plays sound bypassing the mute switch.'."\n",
'enumValueTitles' => ['critical' => 'critical', 'time-sensitive' => 'time-sensitive', 'active' => 'active', 'passive' => 'passive'],
'type' => 'string',
'required' => false,
'example' => 'active',
'title' => '',
],
'iOSRelevanceScore' => ['description' => 'Summary highlight score. Value range: a floating-point number in \\[0,1\\].', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.01', 'title' => ''],
'iOSExtParameters' => ['description' => 'Extended properties of iOS notifications.'."\n"
."\n"
.'On iOS 10+, you can specify the resource URL for rich media push notifications here: `{"attachment": "https://xxxx.xxx/notification_pic.png"} `. This parameter must be passed in JSON map format; otherwise, parsing errors will occur.', 'type' => 'string', 'required' => false, 'example' => '{"attachment": "https://xxxx.xxx/notification_pic.png"} ', 'title' => ''],
'iOSLiveActivityEvent' => [
'description' => 'Start, update, or end a Live Activity.'."\n"
."\n"
.'- Enum: start | update | end',
'type' => 'string',
'enum' => ['start', 'update', 'end'],
'required' => false,
'example' => 'start',
'title' => '',
],
'iOSLiveActivityId' => ['description' => 'The Live Activity ID reported by the device to the user\'s server. A unique identifier for the Live Activity.', 'type' => 'string', 'required' => false, 'example' => '66B94673-B32E-4CA7-863C-3E523054FD46', 'title' => ''],
'iOSLiveActivityAttributesType' => ['description' => 'The type of Live Activity to start.'."\n"
.'> Required when iOSLiveActivityEvent is start.', 'type' => 'string', 'required' => false, 'example' => 'OrderActivityAttributes', 'title' => ''],
'iOSLiveActivityAttributes' => ['description' => 'JSON string. Static pass-through parameters for Dynamic Island push. Contains static user-defined information such as product ID and order information.'."\n"
."\n"
.'> Required when iOSLiveActivityEvent is start.', 'type' => 'string', 'required' => false, 'example' => '{"orderId": "12345", "product": "Shoes"}', 'title' => ''],
'iOSLiveActivityContentState' => ['description' => 'Dynamic pass-through parameters for Dynamic Island push. Contains real-time update information such as price and inventory changes.', 'type' => 'string', 'required' => false, 'example' => '{"status": "delivered", "estimatedArrival": "2023-12-31T12:00:00Z"}', 'title' => ''],
'iOSLiveActivityDismissalDate' => ['description' => 'The ended Live Activity will remain on the lock screen until the specified time, up to a maximum of 4 hours.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1743131967', 'title' => ''],
'iOSLiveActivityStaleDate' => ['description' => 'Timestamp in seconds, marking the expiration time of the activity content.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1743131967', 'title' => ''],
'AndroidNotifyType' => [
'description' => 'Notification alert type. Valid values:'."\n"
."\n"
.'- **VIBRATE**: Vibration (default)'."\n"
.'- **SOUND**: Sound'."\n"
.'- **BOTH**: Sound and vibration'."\n"
.'- **NONE**: Silent',
'enumValueTitles' => ['SOUND' => 'SOUND', 'NONE' => 'NONE', 'VIBRATE' => 'VIBRATE', 'BOTH' => 'BOTH'],
'type' => 'string',
'required' => false,
'example' => 'VIBRATE',
'title' => '',
],
'AndroidRemind' => ['description' => 'When the push type is message and the device is offline, this push will use the auxiliary popup feature. Defaults to false. Only takes effect when PushType=MESSAGE.'."\n"
."\n"
.'If the message-to-notification conversion push is successful, the notification displays the data set by the server\'s AndroidPopupTitle and AndroidPopupBody parameter values. The data obtained when clicking the notification in the auxiliary popup\'s onSysNoticeOpened method is the server-set Title and Body parameter values.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'AndroidOpenType' => [
'description' => 'Action after clicking the notification. Valid values:'."\n"
."\n"
.'- APPLICATION: Open the app (default)'."\n"
.'- ACTIVITY: Open an Android Activity'."\n"
.'- URL: Open a URL'."\n"
.'- NONE: No navigation',
'enumValueTitles' => ['APPLICATION' => 'APPLICATION', 'NONE' => 'NONE', 'ACTIVITY' => 'ACTIVITY', 'URL' => 'URL'],
'type' => 'string',
'required' => false,
'example' => 'APPLICATION',
'title' => '',
],
'AndroidActivity' => ['description' => 'Specify the Activity to open from the notification.'."\n"
."\n"
.'Only applicable when PushTask.N.AndroidOpenType="Activity", e.g., `com.alibaba.cloudpushdemo.bizactivity`.', 'type' => 'string', 'required' => false, 'example' => 'com.alibaba.cloudpushdemo.bizactivity', 'title' => ''],
'AndroidOpenUrl' => ['description' => 'The URL to open after Android receives the push. Only applicable when PushTask.N.AndroidOpenType="URL".', 'type' => 'string', 'required' => false, 'example' => 'https://xxxx.xxx', 'title' => ''],
'AndroidPopupActivity' => ['description' => 'Specify the Activity to navigate to when the notification is clicked.', 'type' => 'string', 'required' => false, 'example' => 'com.alibaba.cloudpushdemo.bizactivity', 'title' => ''],
'AndroidPopupTitle' => ['description' => 'Title content in auxiliary popup mode. Required when the AndroidPopupActivity parameter is not empty.'."\n"
."\n"
.'Length limit: 50 characters (both Chinese and English characters count as one character each).'."\n"
."\n"
.'When using vendor channels, you must also comply with the vendor channel restrictions. For details, see [Android Auxiliary Channel Push Limits](~~165253~~).', 'type' => 'string', 'required' => false, 'example' => 'hello', 'title' => ''],
'AndroidPopupBody' => ['description' => 'Body content in auxiliary popup mode. Required when the AndroidPopupActivity parameter is not empty.'."\n"
."\n"
.'Length limit: 200 characters (both Chinese and English characters count as one character each).'."\n"
."\n"
.'When using vendor channels, you must also comply with the vendor channel restrictions. For details, see [Android Auxiliary Channel Push Limits](~~165253~~).', 'type' => 'string', 'required' => false, 'example' => 'hello', 'title' => ''],
'AndroidRenderStyle' => ['description' => 'Notification style. Valid values:'."\n"
.'- **0**: Standard mode (default)'."\n"
.'- **1**: Long text mode (supported by Huawei, Honor, Xiaomi, OPPO, Meizu, and proprietary channels)'."\n"
.'- **2**: Big picture mode (supported by proprietary channel, not supported on Xiaomi devices)'."\n"
.'- **3**: List mode (supported by Huawei, Honor, Xiaomi, OPPO, and proprietary channels)'."\n"
.'> This parameter is required when using non-standard modes.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
'AndroidBigTitle' => ['description' => 'Title in long text mode. Length limit: 200 bytes (1 Chinese character counts as 3 bytes).'."\n"
."\n"
.'- Currently only supported by the Honor channel and Huawei channel EMUI 11 and later.'."\n"
."\n"
.'- If this parameter is not provided in long text mode, the first non-empty value from Title and AndroidPopupTitle is used.', 'type' => 'string', 'required' => false, 'example' => '示例长标题', 'title' => ''],
'AndroidBigBody' => ['description' => 'Body in long text mode. Length limit: 1,000 bytes (1 Chinese character counts as 3 bytes). Subject to specific vendor channel restrictions when sending.'."\n"
."\n"
.'Currently supported:'."\n"
.'- Huawei: EMUI 10 and later'."\n"
.'- Honor: Magic UI 4.0 and later'."\n"
.'- Xiaomi: MIUI 10 and later'."\n"
.'- OPPO: ColorOS 5.0 and later'."\n"
.'- Meizu: Flyme'."\n"
.'- Proprietary channel: Android SDK 3.6.0 and later'."\n"
."\n"
.'If this parameter is not provided in long text mode, the first non-empty value from Body and AndroidPopupBody is used.', 'type' => 'string', 'required' => false, 'example' => '示例长文本', 'title' => ''],
'AndroidBigPictureUrl' => ['description' => 'Image URL in big picture mode. Currently supported: Proprietary channel: Android SDK 3.6.0 and later.', 'type' => 'string', 'required' => false, 'example' => 'https://imag.example.com/image.png', 'title' => ''],
'AndroidXiaomiBigPictureUrl' => ['description' => 'This parameter has been deprecated. Since August 2023, Xiaomi has officially discontinued support for dynamically setting small icons, right-side icons, and big pictures during push on new devices/systems.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'https://f6.market.xiaomi.com/download/MiPass/aaa/bbb.png', 'title' => ''],
'AndroidImageUrl' => ['description' => 'Right-side icon URL. Currently supported:'."\n"
.'- Huawei EMUI (only applicable in long text mode and Inbox mode)'."\n"
.'- Honor Magic UI (only applicable in long text mode)'."\n"
.'- Proprietary channel: Android SDK 3.5.0 and later', 'type' => 'string', 'required' => false, 'example' => 'https://imag.example.com/image.png', 'title' => ''],
'AndroidXiaomiImageUrl' => ['description' => 'This parameter has been deprecated. Since August 2023, Xiaomi has officially discontinued support for dynamically setting small icons, right-side icons, and big pictures during push on new devices/systems.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'https://imag.example.com/image.png', 'title' => ''],
'AndroidInboxBody' => ['description' => 'Body content in Inbox mode. The content must be a valid JSON Array with no more than 5 elements. Currently supported:'."\n"
."\n"
.'- Huawei: EMUI 9 and later'."\n"
.'- Honor: Magic UI 4.0 and later'."\n"
.'- Xiaomi: MIUI 10 and later'."\n"
.'- OPPO: ColorOS 5.0 and later'."\n"
.'- Proprietary channel: Android SDK 3.6.0 and later', 'type' => 'string', 'required' => false, 'example' => '["第一行","第二行"]', 'title' => ''],
'AndroidNotificationBarType' => ['description' => 'Android custom notification bar style. Value range: 1-100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
'AndroidNotificationBarPriority' => ['description' => 'Priority of the notification position in the Android notification bar. Valid values: -2, -1, 0, 1, 2.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
'AndroidNotificationNotifyId' => ['description' => 'Unique identifier for each message displayed in the notification bar. Different notification bar messages can share the same NotifyId, allowing new notifications to replace old ones.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100001', 'title' => ''],
'AndroidNotificationChannel' => ['description' => 'The channelId of the Android app. Must match the channelId configured in the app.'."\n"
.'- Set the NotificationChannel parameter. For specific usage, see [FAQ: Notifications not received on Android 8.0+ devices](~~67398~~).'."\n"
.'- Since the OPPO notification private channel\'s channel_id is the same as the app\'s channelId, the channel_id takes this value when pushing through the OPPO channel.'."\n"
.'- For Huawei, FCM, and Alibaba Cloud proprietary channel pushes, the channel_id takes this value.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
'AndroidNotificationHuaweiChannel' => [
'description' => 'Set the Huawei notification message classification importance parameter, which determines the notification behavior on user devices. Valid values:'."\n"
."\n"
.'- LOW: Information and marketing messages'."\n"
.'- NORMAL: Service and communication messages'."\n"
."\n"
.'>- The Huawei channel now recommends using AndroidMessageHuaweiCategory for notification classification. AndroidNotificationHuaweiChannel is no longer required.'."\n"
.'>- Application is required on the Huawei platform. [Application link](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#section893184112272).',
'enumValueTitles' => ['LOW' => 'LOW', 'NORMAL' => 'NORMAL'],
'type' => 'string',
'required' => false,
'example' => 'LOW',
'title' => '',
],
'AndroidNotificationHonorChannel' => [
'description' => 'Set the Honor notification message classification importance parameter, which determines the notification behavior on user devices. Valid values:'."\n"
."\n"
.'- LOW: Information and marketing messages'."\n"
."\n"
.'- NORMAL: Service and communication messages'."\n"
."\n"
.'Application is required on the Honor platform. [Application link](https://developer.honor.com/cn/docs/11002/guides/notification-class#%E8%87%AA%E5%88%86%E7%B1%BB%E6%9D%83%E7%9B%8A%E7%94%B3%E8%AF%B7).',
'enumValueTitles' => ['LOW' => 'LOW', 'NORMAL' => 'NORMAL'],
'type' => 'string',
'required' => false,
'example' => 'LOW',
'title' => '',
],
'AndroidNotificationXiaomiChannel' => ['description' => 'Set the channelId for Xiaomi notification types. Application is required on the Xiaomi platform. See: [Application link](https://dev.mi.com/console/doc/detail?pId=2422#_4).'."\n"
.'>- A single application on the Xiaomi channel can apply for up to 8 channels. Please plan ahead.', 'type' => 'string', 'required' => false, 'example' => 'michannel', 'title' => ''],
'AndroidNotificationVivoChannel' => [
'description' => 'Set the vivo notification message classification. Valid values:'."\n"
."\n"
.'- 0: Operational messages (default)'."\n"
.'- 1: System messages'."\n"
."\n"
.'>- The vivo channel now recommends using AndroidMessageVivoCategory for notification classification. AndroidNotificationVivoChannel is no longer required.'."\n"
.'>- Application is required on the vivo platform. See: [Application link](https://dev.vivo.com.cn/documentCenter/doc/359).',
'enumValueTitles' => ['0', '1'],
'type' => 'string',
'required' => false,
'example' => '0',
'title' => '',
],
'AndroidNotificationGroup' => ['description' => 'Message grouping. Messages in the same group display only the latest one and the total count of messages received in that group in the notification bar. All messages are not displayed and cannot be expanded. Currently supported:'."\n"
."\n"
.'- Huawei vendor channel'."\n"
.'- Honor vendor channel'."\n"
.'- Proprietary channel: Android SDK 3.9.1 and earlier'."\n"
."\n"
.'> The proprietary channel no longer supports this parameter on Android SDK 3.9.2 and later.', 'type' => 'string', 'required' => false, 'example' => 'group-1', 'title' => ''],
'AndroidNotificationThreadId' => ['description' => 'Message grouping. Messages in the same group are displayed collapsed in the notification bar and can be expanded. Notifications from different groups are displayed separately. Currently supported:'."\n"
."\n"
.'- Proprietary channel: Android SDK 3.9.2 and later', 'type' => 'string', 'required' => false, 'example' => 'thread-1', 'title' => ''],
'AndroidExtParameters' => ['description' => 'Set notification extended properties. This property does not take effect when the push type PushType is set to MESSAGE.'."\n"
."\n"
.'This parameter must be passed in JSON map format; otherwise, parsing errors will occur.', 'type' => 'string', 'required' => false, 'example' => '{"key1":"value1","api_name":"PushNoticeToAndroidRequest"}', 'title' => ''],
'AndroidMessageHuaweiUrgency' => [
'description' => 'Huawei channel notification delivery priority. Valid values:'."\n"
."\n"
.'- HIGH'."\n"
."\n"
.'- NORMAL'."\n"
."\n"
.'Permission application is required. See: [Application link](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/faq-0000001050042183#section037425218509).',
'enumValueTitles' => ['HIGH' => 'HIGH', 'NORMAL' => 'NORMAL'],
'type' => 'string',
'required' => false,
'example' => 'HIGH',
'title' => '',
],
'AndroidMessageHuaweiCategory' => ['description' => 'Purpose 1: After completing the [self-classification privilege application](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835?#section3410731125514), this is used to identify the message type, determine the [notification alert method](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#ZH-CN_TOPIC_0000001149358835__p3850133955718), and speed up delivery for specific message types. For valid values, refer to the Huawei Push official documentation\'s [Message Classification Standard](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#section1076611477914). Use the "Cloud notification category value" or "Local notification category value" from the documentation table.'."\n"
."\n"
.'Purpose 2: After [applying for special permissions](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/faq-0000001050042183#section037425218509), this is used to identify high-priority pass-through scenarios. Valid values:'."\n"
.'- VOIP: Audio/video calls'."\n"
.'- PLAY_VOICE: Voice playback'."\n"
."\n"
.'> For "Cloud notification category values" marked as "Not applicable", the Alibaba Cloud proprietary channel is used. For "Local notification category values" marked as "Not applicable", the Huawei channel is used.', 'type' => 'string', 'required' => false, 'example' => 'SUBSCRIPTION', 'title' => ''],
'AndroidMessageOppoCategory' => ['description' => 'OPPO classifies messages into two categories: Communication & Service, and Content & Marketing.'."\n"
."\n"
.'Communication & Service (permission application required):'."\n"
.'- IM: Instant messaging, audio, and video calls'."\n"
.'- ACCOUNT: Personal account and asset changes'."\n"
.'- DEVICE_REMINDER: Personal device reminders'."\n"
.'- ORDER: Personal order/logistics status changes'."\n"
.'- TODO: Personal schedule/to-do items'."\n"
.'- SUBSCRIPTION: Personal subscriptions'."\n"
."\n"
.'Content & Marketing:'."\n"
.'- NEWS: News and information'."\n"
.'- CONTENT: Content recommendations'."\n"
.'- MARKETING: Platform promotions'."\n"
.'- SOCIAL: Social updates'."\n"
."\n"
.'For details, see [OPUSH Message Classification Rules](https://open.oppomobile.com/new/developmentDoc/info?id=13189)', 'type' => 'string', 'required' => false, 'example' => 'MARKETING', 'title' => ''],
'AndroidMessageOppoNotifyLevel' => ['description' => 'OPPO channel notification bar message alert level. Valid values:'."\n"
.'- 1: Notification bar'."\n"
.'- 2: Notification bar, lock screen, ringtone, and vibration (default notification level for Communication & Service messages)'."\n"
.'- 16: Notification bar, lock screen, ringtone, vibration, and banner (permission application required)'."\n"
."\n"
.'> When using the AndroidMessageOppoNotifyLevel parameter, the AndroidMessageOppoCategory parameter must also be provided.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
'AndroidMessageVivoCategory' => ['description' => 'vivo classifies messages into two categories: System messages and Operational messages.'."\n"
."\n"
.'System messages:'."\n"
.'- IM: Instant messages'."\n"
.'- ACCOUNT: Account and assets'."\n"
.'- TODO: Schedule and to-do items'."\n"
.'- DEVICE_REMINDER: Device information'."\n"
.'- ORDER: Orders and logistics'."\n"
.'- SUBSCRIPTION: Subscription reminders'."\n"
."\n"
.'Operational messages:'."\n"
.'- NEWS: News'."\n"
.'- CONTENT: Content recommendations'."\n"
.'- MARKETING: Operational campaigns'."\n"
.'- SOCIAL: Social updates'."\n"
.'> For details, see [Classification Description](https://dev.vivo.com.cn/documentCenter/doc/359#s-ef3qugc3)', 'type' => 'string', 'required' => false, 'example' => 'TODO', 'title' => ''],
'AndroidTargetUserType' => [
'description' => 'Set the vendor channel notification type:'."\n"
.'- **0**: Production notification (default).'."\n"
.'- **1**: Test notification.'."\n"
."\n"
.'>- Configuring this parameter is equivalent to simultaneously configuring the AndroidHuaweiTargetUserType, AndroidHonorTargetUserType, AndroidVivoPushMode, and AndroidOppoIntentEnv parameters. The corresponding parameter for a specific vendor channel can override this parameter.'."\n"
.'>- Currently supported: Huawei channel, Honor channel, vivo channel, and OPPO Fluid Cloud.',
'type' => 'integer',
'format' => 'int32',
'enum' => ['0', '1'],
'required' => false,
'example' => '1',
'title' => '',
],
'AndroidHuaweiTargetUserType' => [
'description' => 'Set the Huawei channel notification type:'."\n"
.'- **0**: Production notification (default).'."\n"
.'- **1**: Test notification.'."\n"
."\n"
.'> Each application can send up to 500 test notifications per day, and this is not subject to the daily per-device push limit.',
'enumValueTitles' => ['0', '1'],
'type' => 'integer',
'format' => 'int32',
'enum' => ['0', '1'],
'required' => false,
'example' => '1',
'title' => '',
],
'AndroidHonorTargetUserType' => [
'description' => 'Set the Honor channel notification type:'."\n"
.'- **0**: Production notification (default).'."\n"
.'- **1**: Test notification.'."\n"
."\n"
.'> Each application can send up to 1,000 test notifications per day, and this is not subject to the daily per-device push limit.',
'type' => 'integer',
'format' => 'int32',
'enum' => ['0', '1'],
'required' => false,
'example' => '1',
'title' => '',
],
'AndroidVivoPushMode' => [
'description' => 'Set the vivo channel notification type:'."\n"
.'- **0**: Production push (default).'."\n"
.'- **1**: Test push.'."\n"
."\n"
.'> For test pushes, configure test devices in the vivo console in advance. The test device RegId can be obtained by searching for "onReceiveRegId regId" in the device startup logs.',
'enumValueTitles' => ['0', '1'],
'type' => 'integer',
'format' => 'int32',
'enum' => ['0', '1'],
'required' => false,
'example' => '1',
'title' => '',
],
'AndroidOppoIntentEnv' => [
'description' => 'Set the OPPO Fluid Cloud push environment:'."\n"
.'- **0**: Production environment (default).'."\n"
.'- **1**: Test environment.'."\n"
."\n"
.'> The OPPO Fluid Cloud test environment requires client-side setup. See [Environment Setup](https://open.oppomobile.com/documentation/page/info?id=13590).',
'type' => 'integer',
'format' => 'int32',
'enum' => ['0', '1'],
'required' => false,
'example' => '1',
'title' => '',
],
'AndroidHuaweiBusinessType' => [
'description' => 'Set the Huawei instant notification parameter:'."\n"
.'- **0**: Send a regular Huawei notification (default).'."\n"
.'- **1**: Send a Huawei instant notification.',
'type' => 'integer',
'format' => 'int32',
'enum' => ['0', '1'],
'required' => false,
'example' => '1',
'title' => '',
],
'AndroidHuaweiReceiptId' => ['description' => 'Huawei channel receipt ID. This receipt ID can be found in the receipt parameter configuration on the Huawei channel push operations platform.'."\n"
."\n"
.'> If the default receipt configuration on the Huawei channel push operations platform is set to Alibaba Cloud receipt, this is not required. If not, we recommend configuring the default Huawei channel receipt ID in the Alibaba Cloud EMAS Mobile Push console first.', 'type' => 'string', 'required' => false, 'example' => 'RCP4C123456', 'title' => ''],
'AndroidVivoReceiptId' => ['description' => 'vivo channel receipt ID. This receipt ID can be found in the app information section of the push service on the vivo open platform.'."\n"
."\n"
.'> If the default receipt configuration on the vivo open platform is set to Alibaba Cloud receipt, this is not required. If not, we recommend configuring the default vivo channel receipt ID in the Alibaba Cloud EMAS Mobile Push console first.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''],
'AndroidBadgeClass' => ['description' => 'Full class name of the app entry Activity for badge settings.'."\n"
."\n"
.'> Only valid for Huawei/Honor vendor channel pushes.', 'type' => 'string', 'required' => false, 'example' => 'com.alibaba.cloudpushdemo.bizactivity'."\n", 'title' => ''],
'AndroidBadgeAddNum' => ['description' => 'Set the badge increment value. The value is added to the existing badge count. Value range: [1-99].'."\n"
.'> Only valid for Huawei/Honor vendor channel pushes. When both AndroidBadgeAddNum and AndroidBadgeSetNum are present, AndroidBadgeSetNum takes precedence.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false, 'title' => ''],
'AndroidBadgeSetNum' => ['description' => 'Set the badge to a fixed number. Value range: [0-99].'."\n"
."\n"
.'> For vendor channel pushes, this only takes effect on Huawei and Honor channels. For Alibaba Cloud proprietary channel pushes, this only takes effect on Huawei, Honor, and vivo devices.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'default' => '0', 'required' => false, 'title' => ''],
'AndroidMusic' => ['description' => 'Huawei vendor channel notification sound. Specify the name of an audio file stored in the client project\'s app/src/main/res/raw/ directory. The file extension is not required.'."\n"
."\n"
.'If not set, the default ringtone is used.', 'type' => 'string', 'required' => false, 'example' => 'alicloud_notification_sound', 'title' => ''],
'HarmonyRemind' => ['description' => 'When the push type is message and the device is offline, this push will use the auxiliary popup feature. Defaults to false. Only takes effect when PushType=MESSAGE.'."\n"
."\n"
.'If the message-to-notification conversion push is successful, the notification displays the data set by the server\'s HarmonyRemindTitle and HarmonyRemindBody parameter values.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
'HarmonyRemindTitle' => ['description' => 'HarmonyOS notification title used when converting HarmonyOS messages to notifications. Only valid when HarmonyRemind is true.', 'type' => 'string', 'required' => false, 'example' => '新消息', 'title' => ''],
'HarmonyRemindBody' => ['description' => 'HarmonyOS notification content used when converting HarmonyOS messages to notifications. Only valid when HarmonyRemind is true.', 'type' => 'string', 'required' => false, 'example' => '您有一条新消息,请查收', 'title' => ''],
'HarmonyCategory' => [
'description' => 'Notification message category. After completing the notification message self-classification privilege application, this is used to identify the message type. Different notification message types affect the display and alert methods. Valid values:'."\n"
."\n"
.'- IM: Instant messaging'."\n"
.'- VOIP: Audio/video calls'."\n"
.'- SUBSCRIPTION: Subscriptions'."\n"
.'- TRAVEL: Travel'."\n"
.'- HEALTH: Health'."\n"
.'- WORK: Work task reminders'."\n"
.'- ACCOUNT: Account updates'."\n"
.'- EXPRESS: Orders & logistics'."\n"
.'- FINANCE: Finance'."\n"
.'- DEVICE_REMINDER: Device reminders'."\n"
.'- MAIL: Email'."\n"
.'- CUSTOMER_SERVICE: Customer service messages'."\n"
.'- MARKETING: News, content recommendations, social updates, product promotions, financial updates, lifestyle information, surveys, feature recommendations, and operational campaigns (only marks the content, does not speed up message delivery), collectively referred to as information and marketing messages'."\n"
."\n"
.'For details, see HarmonyOS official documentation [Notification.category](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section17371529101117)',
'type' => 'string',
'enum' => ['IM', 'VOIP', 'SUBSCRIPTION', 'TRAVEL', 'HEALTH', 'WORK', 'ACCOUNT', 'EXPRESS', 'FINANCE', 'DEVICE_REMINDER', 'MAIL', 'CUSTOMER_SERVICE', 'MARKETING'],
'required' => false,
'example' => 'IM',
'title' => '',
],
'HarmonyNotificationSlotType' => [
'description' => 'Use the specified type of notification slot. Only valid when the Alibaba Cloud proprietary channel is online.'."\n"
."\n"
.'- SOCIAL_COMMUNICATION: Social communication.'."\n"
.'- SERVICE_INFORMATION: Service reminders.'."\n"
.'- CONTENT_INFORMATION: Content information.'."\n"
.'- CUSTOMER_SERVICE: Customer service messages. This type is used for customer service messages between users and merchants, and must be initiated by the user.'."\n"
.'- OTHER_TYPES: Others.'."\n"
."\n"
.'For details, see HarmonyOS official documentation [SlotType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/js-apis-notificationmanager-V5#slottype)',
'type' => 'string',
'enum' => ['SOCIAL_COMMUNICATION', 'SERVICE_INFORMATION', 'CONTENT_INFORMATION', 'CUSTOMER_SERVICE', 'OTHER_TYPES'],
'required' => false,
'example' => 'SOCIAL_COMMUNICATION',
'title' => '',
],
'HarmonyNotifyId' => ['description' => 'Unique identifier for each message displayed in the notification. When not provided, the push service automatically generates a unique identifier for each message. Different notification messages can share the same notifyId, enabling new messages to replace old ones.'."\n"
."\n"
.'For details, see HarmonyOS official documentation [Notification.notifyId](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section17371529101117)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
'HarmonyActionType' => [
'description' => 'Action after clicking the notification. Valid values:'."\n"
."\n"
.'- APP_HOME_PAGE: Open the app home page'."\n"
.'- APP_CUSTOM_PAGE: Open a custom app page',
'type' => 'string',
'enum' => ['APP_HOME_PAGE', 'APP_CUSTOM_PAGE'],
'required' => false,
'example' => 'APP_HOME_PAGE',
'title' => '',
],
'HarmonyAction' => ['description' => 'The action corresponding to the built-in page ability of the app.'."\n"
."\n"
.'><notice>When HarmonyActionType is APP_CUSTOM_PAGE, at least one of HarmonyUri and HarmonyAction must be provided.></notice>'."\n"
."\n"
.'For details, see HarmonyOS official documentation [ClickAction.action](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section152462191216)', 'type' => 'string', 'required' => false, 'example' => 'com.example.action', 'title' => ''],
'HarmonyUri' => ['description' => 'The URI corresponding to the built-in page ability of the app.'."\n"
.'><notice>When HarmonyActionType is APP_CUSTOM_PAGE, at least one of HarmonyUri and HarmonyAction must be provided. When multiple Abilities exist, provide different action and URI values for each Ability. The action is prioritized when looking up the corresponding built-in app page.></notice>'."\n"
."\n"
.'For details, see HarmonyOS official documentation [ClickAction.uri](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section152462191216)', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com:8080/push/example', 'title' => ''],
'HarmonyRenderStyle' => [
'description' => 'Notification message style:'."\n"
.'- NORMAL: Standard notification (default)'."\n"
.'- MULTI_LINE: Multi-line text style',
'type' => 'string',
'enum' => ['NORMAL', 'MULTI_LINE'],
'required' => false,
'example' => 'NORMAL',
'title' => '',
],
'HarmonyImageUrl' => ['description' => 'URL for the large icon on the right side of the notification. The URL must use the HTTPS protocol.'."\n"
."\n"
.'> Supported image formats: png, jpg, jpeg, heif, gif, bmp. Image dimensions must satisfy height × width < 25,000 pixels.'."\n"
."\n"
.'For details, see HarmonyOS official documentation [Notification.image](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section17371529101117)', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/xxx.png', 'title' => ''],
'HarmonyInboxContent' => ['description' => 'Content for multi-line text style. Required when HarmonyRenderStyle is MULTI_LINE. Up to 3 content items are supported.', 'type' => 'string', 'required' => false, 'example' => '["1.content1","2.content2","3.content3"]'."\n", 'title' => ''],
'HarmonyExtParameters' => ['description' => 'Set notification extended properties. This property does not take effect when the push type PushType is set to MESSAGE.'."\n"
."\n"
.'This parameter must be passed in JSON map format; otherwise, parsing errors will occur.', 'type' => 'string', 'required' => false, 'example' => '{"key1":"value1","api_name":"PushNoticeToAndroidRequest"}'."\n", 'title' => ''],
'HarmonyTestMessage' => ['description' => 'Test message flag:'."\n"
."\n"
.'- false: Normal message (default)'."\n"
.'- true: Test message'."\n"
."\n"
.'For details, see HarmonyOS official documentation [pushOptions.testMessage](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section418321011212)', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'HarmonyReceiptId' => ['description' => 'HarmonyOS channel receipt ID. This receipt ID can be found in the receipt parameter configuration on the HarmonyOS channel push operations platform.'."\n"
."\n"
.'> If the default receipt configuration on the HarmonyOS channel push operations platform is set to Alibaba Cloud receipt, this is not required. If not, we recommend configuring the default HarmonyOS channel receipt ID in the Alibaba Cloud EMAS Mobile Push console first.'."\n"
."\n"
.'For details, see HarmonyOS official documentation [pushOptions.receiptId](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section418321011212)', 'type' => 'string', 'required' => false, 'example' => 'RCPB***DFD5'."\n", 'title' => ''],
'HarmonyExtensionPush' => ['description' => 'When PushType is NOTICE, whether this is a HarmonyOS notification extension message.'."\n"
."\n"
.'- true: Send a notification extension message'."\n"
.'- false: Send a regular notification (default)'."\n"
."\n"
.'Notification extension messages require permission to be applied for on the HarmonyOS side before sending. For details, see the HarmonyOS documentation [Send Notification Extension Messages](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/push-send-extend-noti-V5).</br>'."\n"
.'Supported from HarmonyOS SDK 1.2.0.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'HarmonyExtensionExtraData' => ['description' => 'Extra data for notification extension messages.</br>'."\n"
.'Valid when sending HarmonyOS notification extension messages.</br>'."\n"
.'Conceptually equivalent to the extraData field of HarmonyOS notification extension messages. For the specific definition, see [HarmonyOS ExtensionPayload Description](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section161192514234).</br>'."\n"
.'Supported from HarmonyOS SDK 1.2.0.', 'type' => 'string', 'required' => false, 'example' => '示例额外数据', 'title' => ''],
'HarmonyBadgeAddNum' => ['description' => 'HarmonyOS app badge increment number. See [HarmonyOS badge addNum field description](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section266310382145).</br>'."\n"
.'Supported from HarmonyOS SDK 1.2.0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
'HarmonyBadgeSetNum' => ['description' => 'HarmonyOS app badge set number. See [HarmonyOS badge setNum field description](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section266310382145).</br>'."\n"
.'Supported from HarmonyOS SDK 1.2.0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
'SendSpeed' => ['description' => 'This parameter has been deprecated.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'required' => false, 'example' => '0', 'title' => ''],
'AndroidXiaoMiNotifyTitle' => ['description' => 'This parameter has been deprecated. All third-party auxiliary popups are now supported by the new parameter **AndroidPopupTitle**.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '无', 'title' => ''],
'AndroidXiaoMiNotifyBody' => ['description' => 'This parameter has been deprecated. All third-party auxiliary popups are now supported by the new parameter **AndroidPopupBody**.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '无', 'title' => ''],
'AndroidXiaoMiActivity' => ['description' => 'This parameter has been deprecated. All third-party auxiliary popups are now supported by the new parameter **AndroidPopupActivity**.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '无', 'title' => ''],
'AndroidMeizuNoticeMsgType' => [
'description' => 'Meizu message type'."\n"
."\n"
.'- 0: Public message (default)'."\n"
.'- 1: Private message',
'enumValueTitles' => ['Public message (default)', 'Private message'],
'type' => 'integer',
'format' => 'int32',
'example' => '0',
'enum' => ['0', '1'],
'required' => false,
'title' => '',
],
'AndroidOppoPrivateMsgTemplateId' => ['title' => '', 'description' => 'OPPO private message template ID'."\n"
."\n"
.'><warning>The OPPO private message template feature is no longer supported by MaasPush. To use this feature, please use the Push, PushV2, or MassPushV2 API instead.></warning>', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '687557242b1634hzef3zd5013'],
'AndroidOppoPrivateTitleParameters' => [
'title' => '',
'description' => 'OPPO private message template title parameters',
'type' => 'object',
'deprecated' => true,
'required' => false,
'additionalProperties' => ['description' => 'Variable name and variable value in the OPPO private message template title', 'type' => 'string', 'example' => 'my_title', 'title' => ''],
'example' => '',
],
'AndroidOppoPrivateContentParameters' => [
'title' => '',
'description' => 'OPPO private message template content parameters',
'type' => 'object',
'deprecated' => true,
'required' => false,
'additionalProperties' => ['description' => 'Variable name and variable value in the OPPO private message template content', 'type' => 'string', 'example' => 'my_content', 'title' => ''],
'example' => '',
],
'AndroidXiaomiTemplateId' => ['title' => '', 'description' => 'Xiaomi private message template ID', 'type' => 'string', 'required' => false, 'example' => 'P10645'],
'AndroidXiaomiTemplateParams' => ['title' => '', 'description' => 'Xiaomi private message template parameters, JSON string', 'type' => 'string', 'required' => false, 'example' => '{"keywords1":"Tom","keywords2":"phone"}'],
'HarmonyLiveViewPayload' => ['description' => 'JSON string of the HarmonyOS Live View data structure [LiveViewPayload](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V13/push-scenariozed-api-request-param-V13#section66881469306). For development integration, see [HarmonyOS Live View Push Guide](https://help.aliyun.com/document_detail/2982112.html)', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "activityId": 1,'."\n"
.' "operation": 0,'."\n"
.' "event": "TAXI",'."\n"
.' "status": "DRIVER_ON_THE_WAY",'."\n"
.' "activityData": {'."\n"
.' "notificationData": {'."\n"
.' "type": 3'."\n"
.' }'."\n"
.' }'."\n"
.'}', 'title' => ''],
'AndroidHuaweiLiveNotificationPayload' => ['description' => 'JSON string of the Huawei Android Live Notification data structure [LiveNotificationPayload](https://developer.huawei.com/consumer/cn/doc/HMSCore-References/rest-live-0000001562939968#ZH-CN_TOPIC_0000001700850537__p195121620102511). For development integration, see [Huawei Live Notification Push Guide](https://help.aliyun.com/document_detail/2983768.html)', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "activityId": 1,'."\n"
.' "operation": 1,'."\n"
.' "event": "TAXI",'."\n"
.' "activityData": {'."\n"
.' "notificationData": {'."\n"
.' "type": 3'."\n"
.' }'."\n"
.' }'."\n"
.'}', 'title' => ''],
'AndroidOppoIntelligentIntent' => ['description' => 'JSON string of the OPPO Fluid Cloud intent sharing data structure [IntelligentIntent](https://open.oppomobile.com/documentation/page/info?id=13565). For development integration, see [OPPO Fluid Cloud Push Guide](https://help.aliyun.com/document_detail/2997310.html)', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "intentName": "Example.Progress",'."\n"
.' "identifier": "d71ebd3119877b12ecdb6c4fe96b068e",'."\n"
.' "timestamp": 1729485000989,'."\n"
.' "serviceId": {'."\n"
.' "launcher": "999800001",'."\n"
.' "fluidCloud": "999900001"'."\n"
.' },'."\n"
.' "intentAction": {'."\n"
.' "actionStatus": 0'."\n"
.' },'."\n"
.' "intentEntity": {'."\n"
.' "entityName": "TAXI"'."\n"
.' }'."\n"
.'}', 'title' => ''],
'AndroidOppoDeleteIntentData' => ['description' => 'JSON string of the OPPO Fluid Cloud intent deletion data structure [data](https://open.oppomobile.com/documentation/page/info?id=13578). This parameter is ignored when the AndroidOppoIntelligentIntent parameter is already provided. For development integration, see [OPPO Fluid Cloud Push Guide](https://help.aliyun.com/document_detail/2997310.html)', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "intentName": "Example.Progress",'."\n"
.' "entityIds": ['."\n"
.' "A580202509130712"'."\n"
.' ],'."\n"
.' "serviceId": {'."\n"
.' "launcher": "999800001",'."\n"
.' "fluidCloud": "999900001"'."\n"
.' }'."\n"
.'}', 'title' => ''],
'AndroidVivoLiveMessage' => ['description' => 'JSON string of the vivo Atomic Island data structure [liveMessage](https://dev.vivo.com.cn/documentCenter/doc/896#s-fdagzbd4). For development integration, see [vivo Atomic Island Push Guide](https://help.aliyun.com/zh/document_detail/3030718.html)', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "operation": 0,'."\n"
.' "scene": "HEALTH_REGISTER",'."\n"
.' "templateType": 1,'."\n"
.' "showNotify": true,'."\n"
.' "changeRecord": 999,'."\n"
.' "capsuleData": {'."\n"
.' "bgColor": "#32d4d4"'."\n"
.' }'."\n"
.'}', 'title' => ''],
'AndroidXiaomiFocusParam' => ['description' => 'JSON string of the Xiaomi Super Island data structure [miui.focus.param](https://dev.mi.com/xiaomihyperos/documentation/detail?pId=2131). For development integration, see [Xiaomi Super Island Push Guide](https://help.aliyun.com/zh/document_detail/3037956.html)', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "param_v2": {'."\n"
.' "business": "taxi",'."\n"
.' "updatable": true,'."\n"
.' "orderId": "A580202509130712",'."\n"
.' "param_island": {'."\n"
.' "islandProperty": 1,'."\n"
.' "bigIslandArea": {'."\n"
.' "imageTextInfoLeft": {'."\n"
.' "type": 1'."\n"
.' }'."\n"
.' }'."\n"
.' }'."\n"
.' }'."\n"
.'}', 'title' => ''],
'AndroidXiaomiFocusPics' => ['description' => 'JSON string of the Xiaomi Super Island images [miui.focus.pic_xxx](https://dev.mi.com/xiaomihyperos/documentation/detail?pId=2131). For development integration, see [Xiaomi Super Island Push Guide](https://help.aliyun.com/zh/document_detail/3037956.html)', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "miui.focus.pic_ticker": "https://example.com/ticker.jpg",'."\n"
.' "miui.focus.pic_aod": "https://example.com/aod.jpg",'."\n"
.' "miui.focus.pic_imageText": "https://example.com/imageText.jpg"'."\n"
.'}', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'IdempotentToken',
'in' => 'query',
'schema' => ['description' => 'An idempotency parameter used to prevent duplicate pushes caused by API caller retries. When calls are made with the same IdempotentToken within 15 minutes, only one push is performed, and subsequent calls return the result of the first successful push.'."\n"
."\n"
.'> '."\n"
.'> - The parameter format is a standard 36-character UUID (8-4-4-4-12). Each valid character is a hexadecimal digit in the range 0-9 or a-f, case-insensitive.'."\n"
.'> - This parameter is only used to prevent duplicate pushes caused by retries and cannot prevent duplicate pushes caused by concurrent calls.', 'type' => 'string', 'maxLength' => 36, 'minLength' => 36, 'required' => false, 'example' => 'c8016d13-6e76-410c-9bda-769383d11787', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MessageId' => [
'description' => 'List of batch message IDs. Each message ID corresponds to the push result of the input PushTask.',
'type' => 'array',
'items' => ['description' => 'Message ID', 'type' => 'string', 'example' => '501030', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Invalid%s.Format', 'errorMessage' => 'The specified %s format is invalid.', 'description' => ''],
['errorCode' => 'AccountDisabled', 'errorMessage' => 'Your account is not enabled.', 'description' => ''],
['errorCode' => 'FileNotExist', 'errorMessage' => 'The specified file does not exist.', 'description' => ''],
['errorCode' => 'IncorrectPassword', 'errorMessage' => 'The password is incorrect.', 'description' => ''],
['errorCode' => 'NotApnsCertificate', 'errorMessage' => 'The Certificate is not an APNs certificate.', 'description' => ''],
['errorCode' => 'PermissionDenied', 'errorMessage' => 'The specified AppKey is not authorized.', 'description' => ''],
['errorCode' => 'SendSpeedNotSupported', 'errorMessage' => 'SendSpeed is not supported for specified Target.', 'description' => ''],
['errorCode' => 'SmsProfileConfigFailed', 'errorMessage' => 'Failed to configure SMS profile.', 'description' => ''],
['errorCode' => 'SmsProfileGetFailed', 'errorMessage' => 'Failed to get SMS profile.', 'description' => ''],
['errorCode' => 'SmsRoleAuthorizeFailed', 'errorMessage' => 'Failed to authorize SMS role.', 'description' => ''],
['errorCode' => 'SmsRoleUnauthorized', 'errorMessage' => 'The SMS role is unauthorized.', 'description' => ''],
['errorCode' => 'TagsNumberBeyondLimit', 'errorMessage' => 'The number of tags bound to this app exceeds the limit.', 'description' => ''],
['errorCode' => 'Invalid%s.LengthExceed', 'errorMessage' => 'The specified %s length cannot be greater than %s.', 'description' => ''],
['errorCode' => 'Invalid%s.BytesExceed', 'errorMessage' => 'The specified %s exceeds the %s bytes limit.', 'description' => ''],
['errorCode' => 'Invalid%s.Empty', 'errorMessage' => 'The specified %s cannot be empty.', 'description' => ''],
['errorCode' => 'Invalid.Parameter', 'errorMessage' => 'The specified parameter is invalid: %s.', 'description' => ''],
['errorCode' => 'TargetNotSupported', 'errorMessage' => 'Target is not supported for batch push.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.', 'description' => 'The request processing has failed due to some unknown error.'],
['errorCode' => 'Timeout', 'errorMessage' => 'The request processing is timeout.', 'description' => 'Request processing timed out.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageIds\\": {\\n \\"MessageId\\": [\\n \\"501030\\"\\n ]\\n },\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","type":"json"}]',
'title' => 'MassPush',
'description' => '**Before using this API, make sure you fully understand the [billing methods and pricing](~~434638~~) of the EMAS Mobile Push service.**'."\n"
."\n"
.'In certain business scenarios, you may need to push different messages to different devices in a very short time. When the number of devices and messages is extremely large, this can generate high QPS and reach the QPS limit per source IP, causing some pushes to fail.'."\n"
."\n"
.'This API is designed to address this problem. It supports up to 100 independent push tasks in a single call, effectively reducing QPS through request aggregation and improving the stability and success rate of large-scale unicast pushes. Batch push is limited to 500 calls per second per account.'."\n"
."\n"
.'Each independent push task only supports three types of push targets: device, account, and alias, and does not currently support SMS integration configuration.'."\n"
."\n"
.'> The SDK must be upgraded to version 3.11.0 or later.'."\n"
."\n"
.'## PushTask Properties'."\n"
."\n\n"
.'- The PushTask property format is: PushTask.N.Property. It includes:'."\n"
.' - Push target (destination)'."\n"
.' - Push configuration (config)'."\n"
.' - iOS notification task configuration'."\n"
.' - Android notification task configuration'."\n"
.' - Android auxiliary popup configuration'."\n"
.' - HarmonyOS notification task configuration '."\n"
.' - Push control'."\n"
.'- Each PushTask represents an independent push task, with a maximum of 100 supported. Push-related configurations are consistent with the Push API.'."\n"
.'- The PushTask.N.Target parameter only supports three types: DEVICE, ACCOUNT, and ALIAS.'."\n"
.'- PushTask does not support SMS integration configuration.'."\n"
.'- The product of parent nodes and child nodes cannot exceed 10,000; otherwise, the parameters are considered invalid.',
'extraInfo' => '## Java Sample Code'."\n"
.'```'."\n"
.'MassPushRequest massPushRequest = new MassPushRequest();'."\n"
.'massPushRequest.setAppKey(appKey);'."\n"
.'List<MassPushRequest.PushTask> pushTasks = new ArrayList<>();'."\n"
.'for (int i = 0; i < 100; i++) {'."\n"
.' MassPushRequest.PushTask pushTask = new MassPushRequest.PushTask();'."\n"
.' // Push target'."\n"
.' pushTask.setTarget("DEVICE"); //Push target: DEVICE: push to device; ACCOUNT: push to specified account; TAG: push to custom tag; ALIAS: push by alias; ALL: push to all'."\n"
.' pushTask.setTargetValue("device1,device2,device3"); //Set based on Target. For example, if Target=DEVICE, the corresponding values are deviceId1,deviceId2. Multiple values are separated by commas (accounts and devices are limited to 100 per request).'."\n"
.' pushTask.setDeviceType("iOS"); // Device type deviceType, iOS device: "iOS"; Android device: "ANDROID"; All: "ALL", this is the default value.'."\n"
.' // Push configuration'."\n"
.' pushTask.setPushType("MESSAGE"); // MESSAGE: indicates message (default), NOTICE: indicates notification'."\n"
.' pushTask.setTitle("Hello-" + i); // Message title'."\n"
.' pushTask.setBody("PushRequest body" + i); // Message content'."\n"
.' // Push configuration: iOS'."\n"
.' pushTask.setIOSBadge(5); // iOS app icon badge number in the upper-right corner'."\n"
.' pushTask.setIOSMusic("default"); // iOS notification sound'."\n"
.' pushTask.setIOSApnsEnv("PRODUCT");//iOS notifications are sent through the APNs center. You need to specify the corresponding environment information. \'DEV\': development environment; \'PRODUCT\': production environment'."\n"
.' pushTask.setIOSRemind(true); // When the device is offline during message push (i.e., the persistent connection channel to the Mobile Push server is disconnected), this push will be delivered as a notification through Apple\'s APNs channel once. Note: **Offline message-to-notification conversion only applies to the `production environment`**'."\n"
.' pushTask.setIOSRemindBody("PushRequest summary"); // iOS notification content used when converting iOS messages to notifications, only valid when iOSApnsEnv=`PRODUCT` && iOSRemind is true'."\n"
.' pushTask.setIOSExtParameters("{\\"k1\\":\\"ios\\",\\"k2\\":\\"v2\\"}"); //Notification extended properties (Note: this parameter must be passed in json map format, otherwise parsing errors will occur)'."\n"
.' // Push configuration: Android'."\n"
.' pushTask.setAndroidOpenType("ACTIVITY"); // Action after clicking notification: \'APPLICATION\': open app; \'ACTIVITY\': open Android Activity; \'URL\': open URL; \'NONE\': no navigation'."\n"
.' pushTask.setAndroidNotifyType("SOUND"); // Notification alert type: \'VIBRATE\': vibration; \'SOUND\': sound; \'DEFAULT\': sound and vibration; \'NONE\': no processing, user-defined'."\n"
.' pushTask.setAndroidOpenUrl("http://www.alibaba.com");'."\n"
.' pushTask.setAndroidMusic("alicloud_notification_sound"); // Huawei vendor channel notification sound'."\n"
.' pushTask.setAndroidActivity("com.alibaba.push.PushActivity"); // Open the corresponding Activity after Android receives the push, only valid when `AndroidOpenType="ACTIVITY"`'."\n"
.' pushTask.setAndroidPopupActivity("com.alibaba.push.PopupActivity"); //Setting this parameter enables the auxiliary popup feature. Specify the Activity to navigate to when the notification is clicked (prerequisites for auxiliary popup: 1. Integrate third-party auxiliary channels; 2. Set StoreOffline parameter to true)'."\n"
.' pushTask.setAndroidPopupTitle("Popup Title"); //Set the title of the auxiliary popup notification'."\n"
.' pushTask.setAndroidPopupBody("Popup Body"); //Set the content of the auxiliary popup notification'."\n"
.' pushTask.setAndroidNotificationBarType(50); //Android custom notification bar style, value range: 1-100'."\n"
.' pushTask.setAndroidNotificationBarPriority(2); //Priority of the notification position in the Android notification bar: -2 -1 0 1 2'."\n"
.' pushTask.setAndroidExtParameters("{\\"k1\\":\\"android\\",\\"k2\\":\\"v2\\"}"); //Set notification extended properties. (Note: this parameter must be passed in json map format, otherwise parsing errors will occur)'."\n"
.' // Push control'."\n"
.' final Date pushDate = new Date(System.currentTimeMillis() + 3600 * 1000); //Used for scheduled sending. If not set, the default is immediate sending. The time format follows the ISO8601 standard and must use UTC time in the format `YYYY-MM-DDThh:mm:ssZ`.'."\n"
.' final String pushTime = ParameterHelper.getISO8601Time(pushDate);'."\n"
.' pushTask.setPushTime(pushTime); // Delayed push. Optional. If not set, push is sent immediately'."\n"
.' pushTask.setStoreOffline(true); // Whether to store offline messages. If stored, when the user is offline during push, they will receive the message the next time they come online'."\n"
.' final String expireTime = ParameterHelper.getISO8601Time(new Date(System.currentTimeMillis() + 12 * 3600 * 1000)); // Message expires after 12 hours and will no longer be sent'."\n"
.' pushTask.setExpireTime(expireTime);'."\n"
.' pushTasks.add(pushTask);'."\n"
.'}'."\n"
.'massPushRequest.setPushTasks(pushTasks);'."\n"
.'MassPushResponse massPushResponse = client.getAcsResponse(massPushRequest);'."\n"
.'System.out.printf("RequestId: %s, MessageIds: %s\\n", massPushResponse.getRequestId(), massPushResponse.getMessageIds().toString());'."\n"
.'```',
'changeSet' => [
['createdAt' => '2025-11-25T08:17:08.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-09-19T03:03:01.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-09-18T09:24:49.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-09-09T08:21:44.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-08-21T11:21:59.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-03-21T09:22:04.000Z', 'description' => 'Error codes changed, Request parameters changed'],
['createdAt' => '2025-01-16T07:23:21.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-11-13T03:09:40.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-10-23T08:32:10.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-10-23T08:32:10.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-10-10T01:26:31.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-08-07T05:34:12.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-06-25T04:40:41.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-18T11:18:34.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-10-12T07:14:53.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-03-15T14:04:19.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-06-07T11:29:17.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2021-09-15T06:53:20.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MassPush'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:MassPush',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'MassPushV2' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeNodes' => ['FEATUREemasBNY9P0', 'FEATUREemasTZ8VEZ'],
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'AppKey value.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '23267***', 'title' => ''],
],
[
'name' => 'IdempotentToken',
'in' => 'query',
'schema' => ['description' => 'An idempotency token to prevent duplicate pushes caused by API retries. If you call this API with the same IdempotentToken within 15 minutes, only one push is sent. Subsequent calls return the result of the first successful push.'."\n"
."\n"
.'> - The token must be a standard 36-character UUID in 8-4-4-4-12 format. Valid characters are hexadecimal digits 0–9 and a–f. Case does not matter.'."\n"
.'>'."\n"
.'> - This parameter prevents duplicates only from retries. It does not prevent duplicates from concurrent calls.', 'type' => 'string', 'maxLength' => 36, 'minLength' => 36, 'required' => false, 'example' => 'c8016d13-6e76-****-9bda-769383d11787', 'title' => ''],
],
[
'name' => 'PushTasks',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'array',
'items' => ['description' => 'A push task.', '$ref' => '#/components/schemas/PushTask', 'required' => false, 'title' => '', 'example' => ''],
'required' => true,
'description' => 'Batch push tasks.',
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '159E4422-6624-****-8943-DFD98D34858C', 'title' => ''],
'MessageIds' => [
'type' => 'array',
'items' => ['description' => 'Message ID.', 'type' => 'string', 'example' => '1091371886864****', 'title' => ''],
'description' => 'List of message IDs.',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidPeriod.ExceedDays', 'errorMessage' => 'The period between specified EndTime and StartTime exceeds %s days.', 'description' => ''],
['errorCode' => 'Invalid%s.Format', 'errorMessage' => 'The specified %s format is invalid.', 'description' => ''],
['errorCode' => 'AccountDisabled', 'errorMessage' => 'Your account is not enabled.', 'description' => ''],
['errorCode' => 'FileNotExist', 'errorMessage' => 'The specified file does not exist.', 'description' => ''],
['errorCode' => 'IncorrectPassword', 'errorMessage' => 'The password is incorrect.', 'description' => ''],
['errorCode' => 'NotApnsCertificate', 'errorMessage' => 'The Certificate is not an APNs certificate.', 'description' => ''],
['errorCode' => 'PermissionDenied', 'errorMessage' => 'The specified AppKey is not authorized.', 'description' => ''],
['errorCode' => 'SendSpeedNotSupported', 'errorMessage' => 'SendSpeed is not supported for specified Target.', 'description' => ''],
['errorCode' => 'SmsProfileConfigFailed', 'errorMessage' => 'Failed to configure SMS profile.', 'description' => ''],
['errorCode' => 'SmsProfileGetFailed', 'errorMessage' => 'Failed to get SMS profile.', 'description' => ''],
['errorCode' => 'SmsRoleAuthorizeFailed', 'errorMessage' => 'Failed to authorize SMS role.', 'description' => ''],
['errorCode' => 'SmsRoleUnauthorized', 'errorMessage' => 'The SMS role is unauthorized.', 'description' => ''],
['errorCode' => 'TagsNumberBeyondLimit', 'errorMessage' => 'The number of tags bound to this app exceeds the limit.', 'description' => ''],
['errorCode' => 'Invalid%s.LengthExceed', 'errorMessage' => 'The specified %s length cannot be greater than %s.', 'description' => ''],
['errorCode' => 'Invalid%s.BytesExceed', 'errorMessage' => 'The specified %s exceeds the %s bytes limit.', 'description' => ''],
['errorCode' => 'Invalid%s.Empty', 'errorMessage' => 'The specified %s cannot be empty.', 'description' => ''],
['errorCode' => 'Invalid.Parameter', 'errorMessage' => 'The specified parameter is invalid: %s.', 'description' => ''],
['errorCode' => 'TargetNotSupported', 'errorMessage' => 'Target is not supported for batch push.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.', 'description' => 'The request processing has failed due to some unknown error.'],
['errorCode' => 'Timeout', 'errorMessage' => 'The request processing is timeout.', 'description' => 'Request processing timed out.'],
],
],
'title' => 'Batch Push',
'summary' => 'Advanced push API v2.',
'description' => 'Before using this API, review the [pricing and billing details](https://help.aliyun.com/document_detail/434638.html) for EMAS Mobile Push.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MassPushV2'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:MassPushV2',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"159E4422-6624-****-8943-DFD98D34858C\\",\\n \\"MessageIds\\": [\\n \\"1091371886864****\\"\\n ]\\n}","type":"json"}]',
],
'Push' => [
'summary' => 'Advanced Push API that pushes notifications or messages to different device endpoints. This API provides rich push customization parameters to implement push behavior in different scenarios.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeNodes' => ['FEATUREemasBNY9P0', 'FEATUREemasTZ8VEZ'],
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'AppKey information.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'PushType',
'in' => 'query',
'schema' => [
'description' => 'Push type. Valid values:'."\n"
.'- **NOTICE**: Notification. Notifications are delivered to devices through vendor channels such as APNs, Huawei, Xiaomi, and HarmonyOS, and are displayed directly in the device notification bar. When an Android device is online (app process is alive), the notification is preferentially delivered through the Alibaba Cloud proprietary channel, where the Push SDK constructs and displays the notification, providing better push performance and potentially saving vendor push message quotas in some scenarios.'."\n"
.'- **MESSAGE**: Message. Messages are delivered through the Alibaba Cloud proprietary online channel. They are not displayed in the notification bar by default, but need to be received and processed by the app when the process is active, allowing the business to decide whether to trigger certain business behaviors. When the device is offline (app process is inactive), messages cannot be received in a timely manner. In this case, you can use the `iOSRemind` or `AndroidRemind` parameters below to convert messages to notifications when the device is offline; or set the `StoreOffline` parameter below so the push system saves the message when the device is offline and automatically delivers it when the device comes online.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enum' => ['MESSAGE', 'NOTICE'],
'example' => 'MESSAGE',
'title' => '',
],
],
[
'name' => 'DeviceType',
'in' => 'query',
'schema' => [
'description' => 'Device type. Valid values:'."\n"
."\n"
.'- **HARMONY**: HarmonyOS device'."\n"
.'- **iOS**: iOS device'."\n"
.'- **ANDROID**: Android device'."\n"
.'- **ALL**: When the AppKey is for a legacy dual-platform application, this represents pushing to both Android and iOS devices simultaneously; when the AppKey is for a new single-platform application, the effect is the same as specifying the device type corresponding to the application type.',
'enumValueTitles' => ['ALL' => 'ALL', 'ANDROID' => 'ANDROID', 'iOS' => 'iOS'],
'type' => 'string',
'required' => true,
'docRequired' => true,
'enum' => ['iOS', 'ANDROID', 'ALL', 'HARMONY'],
'example' => 'HARMONY',
'title' => '',
],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => 'Push target. Valid values:'."\n"
."\n"
.'- **DEVICE**: Push by device.'."\n"
.'- **ACCOUNT**: Push by account.'."\n"
.'- **ALIAS**: Push by alias.'."\n"
.'- **TAG**: Push by tag.'."\n"
.'- **ALL**: Push to all devices (the interval between two full pushes of the same DeviceType must be at least 1 second).'."\n"
.' > Pushing to all iOS devices will push to devices that have been active within the last 24 months but have not uninstalled the app. Once APNs (Apple Push Notification service) receives the push request without returning an error, it is considered delivered, which may cause a surge in active device counts and generate significant costs. Please use with discretion.'."\n"
.'- **TBD**: Initialize continuous push. The push target is specified by the subsequent [ContinuouslyPush](~~2249917~~) API.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enum' => ['ALL', 'DEVICE', 'ACCOUNT', 'ALIAS', 'TAG', 'TBD', 'FILE'],
'example' => 'ALL',
'title' => '',
],
],
[
'name' => 'TargetValue',
'in' => 'query',
'schema' => ['description' => 'Set based on the Target type. Multiple values are separated by commas. If the limit is exceeded, split into multiple pushes.'."\n"
."\n"
.'- Target=DEVICE: Values such as `deviceid1,deviceid2` (up to 1000).'."\n"
.'- Target=ACCOUNT: Values such as `account1,account2` (up to 1000).'."\n"
.'- Target=ALIAS: Values such as `alias1,alias2` (up to 1000).'."\n"
.'- Target=TAG: Supports single and multiple tags. For the format, see [Tag Format](~~434847~~).'."\n"
.'- Target=ALL: Value is **ALL** (fixed parameter for full push).'."\n"
.'- Target=TBD: Value is **TBD** (fixed parameter for continuous push).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ALL', 'title' => ''],
],
[
'name' => 'StoreOffline',
'in' => 'query',
'schema' => ['description' => 'Whether to store offline messages/notifications. StoreOffline defaults to **false**.'."\n"
."\n"
.'If enabled, when the user is offline during push, the message will be resent when the user comes online within the expiration time (ExpireTime). ExpireTime defaults to 72 hours. iOS notifications go through the APNs channel and are not affected by StoreOffline.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'SendChannels',
'in' => 'query',
'schema' => ['description' => 'Specify sending channels. Valid values:'."\n"
."\n"
.'- accs: Alibaba Cloud proprietary channel'."\n"
.'- huawei: Huawei channel'."\n"
.'- honor: Honor channel'."\n"
.'- xiaomi: Xiaomi channel'."\n"
.'- oppo: OPPO channel'."\n"
.'- vivo: vivo channel'."\n"
.'- meizu: Meizu channel'."\n"
.'- gcm: Google GCM channel (legacy HTTP)'."\n"
.'- fcm: Google Firebase channel (HTTP v1 API)'."\n"
.'- apns: APNs channel'."\n"
.'- harmony: HarmonyOS channel'."\n"
."\n"
.'>- If this parameter is not configured, all channels are available.'."\n"
.'>- If this parameter is configured, only the specified channels are used.'."\n"
.'>- If the configured channels conflict with the sending strategy (e.g., iOS notifications only go through the APNs channel, but this parameter does not include apns), the push will not be sent.'."\n"
.'>- If gcm is configured, both Google GCM and FCM channels can be used. If fcm is configured, only the Google FCM channel can be used.', 'type' => 'string', 'required' => false, 'example' => 'accs,huawei,xiaomi', 'title' => ''],
],
[
'name' => 'PushTime',
'in' => 'query',
'schema' => ['description' => 'Used for scheduled sending. If not set, the default is immediate sending.'."\n"
.'Scheduled sending must be no later than 7 days from now.'."\n"
."\n"
.'The time format follows the ISO8601 standard and must use UTC time, in the format YYYY-MM-DDThh:mm:ssZ.'."\n"
.'>When Target is TBD (continuous push), scheduled sending is not supported.', 'type' => 'string', 'required' => false, 'example' => '2019-02-20T00:00:00Z', 'title' => ''],
],
[
'name' => 'ExpireTime',
'in' => 'query',
'schema' => ['description' => 'Expiration time for offline messages/notifications, used in conjunction with StoreOffline. Expired messages will no longer be sent. Maximum retention is 72 hours. Default is 72 hours.'."\n"
."\n"
.'The time format follows the ISO8601 standard and must use UTC time, in the format YYYY-MM-DDThh:mm:ssZ. The expiration time must be greater than the current time or the scheduled send time plus 3 seconds (`ExpireTime > PushTime + 3 seconds`). The 3-second buffer accounts for network and system delay tolerance. It is recommended to set at least 1 minute for single push, and at least 10 minutes for full push or batch push.', 'type' => 'string', 'required' => false, 'example' => '2019-02-20T00:00:00Z', 'title' => ''],
],
[
'name' => 'JobKey',
'in' => 'query',
'schema' => ['description' => 'Custom identifier for the push task. When JobKey is not empty, the receipt log will include this field. For viewing receipt logs, see [Receipt Logs](~~434651~~).'."\n"
.'>Format requirements: Only letters, digits, or the symbols \'_\' and \'-\' (any combination) are allowed, and the length must not exceed 32 characters.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => ['description' => 'Title of the notification/message during push. Length limit: 200 bytes.'."\n"
."\n"
.'Required for Android and HarmonyOS push; optional for iOS notifications. If provided:'."\n"
."\n"
.'- iOS 10+: Displayed as the notification title.'."\n"
."\n"
.'- iOS 8.2 <= iOS version < iOS 10: Replaces the notification app name.', 'type' => 'string', 'required' => false, 'example' => 'title', 'title' => ''],
],
[
'name' => 'Body',
'in' => 'query',
'schema' => ['description' => 'Notification content/message content for Android and HarmonyOS push; iOS message/notification content. The push content size is limited. See [Product Limits](~~434629~~).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'hello', 'title' => ''],
],
[
'name' => 'Trim',
'in' => 'query',
'schema' => ['description' => 'Whether to automatically truncate overly long titles and content.'."\n"
."\n"
.'>Only applies to vendor channels that explicitly limit title and content length. Does not apply to APNs, Huawei, Honor, and other channels that do not limit title or content individually but only limit the total request body size.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'iOSApnsEnv',
'in' => 'query',
'schema' => [
'description' => 'iOS notifications are sent through the APNs center, and the corresponding environment information must be provided.'."\n"
."\n"
.'- **DEV**: Development environment, applicable to apps installed and debugged directly via Xcode.'."\n"
.'- **PRODUCT**: Production environment, applicable to apps distributed via App Store, TestFlight, Ad Hoc, and enterprise distribution.',
'enumValueTitles' => ['DEV' => 'DEV', 'PRODUCT' => 'PRODUCT'],
'type' => 'string',
'required' => false,
'enum' => ['PRODUCT', 'DEV'],
'example' => 'DEV',
'title' => '',
],
],
[
'name' => 'iOSRemind',
'in' => 'query',
'schema' => ['description' => 'When the device is offline during message push (i.e., the persistent connection to the push server is disconnected), this push will be delivered as a notification through Apple\'s APNs channel once.'."\n"
."\n"
.'> Offline message-to-notification conversion only applies to the production environment.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'iOSSubtitle',
'in' => 'query',
'schema' => ['description' => 'iOS notification subtitle content (iOS 10+).', 'type' => 'string', 'required' => false, 'example' => 'su\'b', 'title' => ''],
],
[
'name' => 'iOSRemindBody',
'in' => 'query',
'schema' => ['description' => 'iOS notification content used when converting iOS messages to notifications. Only valid when iOSApnsEnv=PRODUCT and iOSRemind is true.', 'type' => 'string', 'required' => false, 'example' => 'ios通知body', 'title' => ''],
],
[
'name' => 'iOSMusic',
'in' => 'query',
'schema' => ['description' => 'iOS notification sound. Specify the name of an audio file stored in the app bundle or the sandbox Library/Sounds directory. See: [How to Set iOS Push Notification Sound](~~48906~~).'."\n"
."\n"
.'If set to an empty string (""), the notification will be silent; if not set, it defaults to the system alert sound.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''],
],
[
'name' => 'iOSBadge',
'in' => 'query',
'schema' => ['description' => 'iOS app icon badge number in the upper-right corner.'."\n"
."\n"
.'> If iOSBadgeAutoIncrement is set to True, this field must be empty.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'iOSBadgeAutoIncrement',
'in' => 'query',
'schema' => ['description' => 'Whether to enable badge auto-increment. Default is false.'."\n"
."\n"
.'>When this is set to true, iOSBadge must be empty.'."\n"
."\n"
.'The badge auto-increment feature is maintained by the push server for each device\'s badge count. Users must use SDK version 1.9.5 or above and actively sync the badge count to the server.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'iOSSilentNotification',
'in' => 'query',
'schema' => ['description' => 'Whether to enable iOS silent notification.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'iOSMutableContent',
'in' => 'query',
'schema' => ['description' => 'iOS notification processing extension flag (iOS 10+). If set to true, the APNs push notification can reach the Extension for processing before being displayed. For silent notifications, this must be set to true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'iOSNotificationCategory',
'in' => 'query',
'schema' => ['description' => 'Specify the iOS notification Category (iOS 10+).', 'type' => 'string', 'required' => false, 'example' => 'ios', 'title' => ''],
],
[
'name' => 'iOSNotificationCollapseId',
'in' => 'query',
'schema' => ['description' => 'When a device receives messages with the same CollapseId, they will be merged into one. When the device is offline and consecutive messages with the same CollapseId are sent, only the latest one is displayed in the notification bar. iOS 10+ supports this parameter.', 'type' => 'string', 'required' => false, 'example' => 'ZD2011', 'title' => ''],
],
[
'name' => 'iOSNotificationThreadId',
'in' => 'query',
'schema' => ['description' => 'This attribute is used to group iOS remote notifications, identifying the group name for collapsed notifications.'."\n"
.'Only supported on iOS 12.0+.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''],
],
[
'name' => 'iOSInterruptionLevel',
'in' => 'query',
'schema' => ['description' => 'Interruption level. Valid values:'."\n"
."\n"
.'- **passive**: The system adds the notification to the notification list without lighting up the screen or playing a sound.'."\n"
.'- **active**: The system displays the notification immediately, lights up the screen, and can play a sound.'."\n"
.'- **time-sensitive**: The system displays the notification immediately, lights up the screen, and can play a sound, but does not break through system notification controls.'."\n"
.'- **critical**: The system displays the notification immediately, lights up the screen, and plays a sound bypassing the silent switch.', 'type' => 'string', 'required' => false, 'example' => 'active', 'title' => ''],
],
[
'name' => 'iOSRelevanceScore',
'in' => 'query',
'schema' => ['description' => 'Summary highlight score. Value range: floating-point number in \\[0,1\\].', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.01', 'title' => ''],
],
[
'name' => 'iOSExtParameters',
'in' => 'query',
'schema' => ['description' => 'Extension attributes for iOS notifications.'."\n"
."\n"
.'For iOS 10+, you can specify the resource URL for rich media push notifications here: `{"attachment": "https://xxxx.xxx/notification_pic.png"}`. This parameter must be passed in JSON map format, otherwise parsing will fail.', 'type' => 'string', 'required' => false, 'example' => '{"attachment": "https://xxxx.xxx/notification_pic.png"} ', 'title' => ''],
],
[
'name' => 'iOSLiveActivityEvent',
'in' => 'query',
'schema' => [
'description' => 'Start, update, or end a Live Activity.'."\n"
."\n"
.'- Enum: start | update | end',
'type' => 'string',
'enum' => ['start', 'update', 'end'],
'required' => false,
'example' => 'start',
'title' => '',
],
],
[
'name' => 'iOSLiveActivityId',
'in' => 'query',
'schema' => ['description' => 'The Live Activity ID reported from the device to the user\'s server. The unique identifier of the Live Activity.', 'type' => 'string', 'required' => false, 'example' => '66B94673-B32E-4CA7-863C-3E523054FD46', 'title' => ''],
],
[
'name' => 'iOSLiveActivityAttributesType',
'in' => 'query',
'schema' => ['description' => 'The type of Live Activity to start.'."\n"
.'> Required when iOSLiveActivityEvent is start.', 'type' => 'string', 'required' => false, 'example' => 'OrderActivityAttributes', 'title' => ''],
],
[
'name' => 'iOSLiveActivityAttributes',
'in' => 'query',
'schema' => ['description' => 'JSON string, static parameters for Live Activity (Dynamic Island) push. Contains static user-defined information such as product IDs and order information.'."\n"
."\n"
.'> Required when iOSLiveActivityEvent is start.', 'type' => 'string', 'required' => false, 'example' => '{"orderId": "12345", "product": "Shoes"}', 'title' => ''],
],
[
'name' => 'iOSLiveActivityContentState',
'in' => 'query',
'schema' => ['description' => 'Dynamic parameters for Live Activity (Dynamic Island) push, containing real-time update information such as price and inventory changes.', 'type' => 'string', 'required' => false, 'example' => '{"status": "delivered", "estimatedArrival": "2023-12-31T12:00:00Z"}', 'title' => ''],
],
[
'name' => 'iOSLiveActivityDismissalDate',
'in' => 'query',
'schema' => ['description' => 'Timestamp in seconds. The ended Live Activity will remain on the lock screen until this specified time, with a maximum of 4 hours.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1743131967', 'title' => ''],
],
[
'name' => 'iOSLiveActivityStaleDate',
'in' => 'query',
'schema' => ['description' => 'Timestamp in seconds. Marks the expiration time of the activity content.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1743131967', 'title' => ''],
],
[
'name' => 'AndroidNotifyType',
'in' => 'query',
'schema' => [
'description' => 'Notification alert type. Valid values:'."\n"
."\n"
.'- **VIBRATE**: Vibration (default)'."\n"
.'- **SOUND**: Sound'."\n"
.'- **BOTH**: Sound and vibration'."\n"
.'- **NONE**: Silent',
'type' => 'string',
'required' => false,
'enum' => ['NONE', 'VIBRATE', 'SOUND', 'BOTH'],
'example' => 'BOTH',
'title' => '',
],
],
[
'name' => 'AndroidRemind',
'in' => 'query',
'schema' => ['description' => 'When the push type is message and the device is offline, this push will use the supplementary popup feature. Default is false. Only effective when PushType=MESSAGE.'."\n"
."\n"
.'If the message-to-notification push is successful, the notification displays the AndroidPopupTitle and AndroidPopupBody parameter values set on the server. The data obtained in the onSysNoticeOpened method of the supplementary popup when clicking the notification is the Title and Body parameter values set on the server.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'AndroidOpenType',
'in' => 'query',
'schema' => [
'description' => 'Action after clicking the notification. Valid values:'."\n"
."\n"
.'- **APPLICATION**: Open the application (default)'."\n"
.'- **ACTIVITY**: Open an Android Activity'."\n"
.'- **URL**: Open a URL'."\n"
.'- **NONE**: No redirect',
'type' => 'string',
'required' => false,
'enum' => ['APPLICATION', 'ACTIVITY', 'URL', 'NONE'],
'example' => 'APPLICATION',
'title' => '',
],
],
[
'name' => 'AndroidActivity',
'in' => 'query',
'schema' => ['description' => 'Specify the activity to open from the notification.'."\n"
."\n"
.'Only pass this when AndroidOpenType="Activity", e.g.: `com.alibaba.cloudpushdemo.bizactivity`.', 'type' => 'string', 'required' => false, 'example' => 'com.alibaba.cloudpushdemo.bizactivity', 'title' => ''],
],
[
'name' => 'AndroidOpenUrl',
'in' => 'query',
'schema' => ['description' => 'URL to open when Android receives the push.'."\n"
."\n"
.'Only pass this when AndroidOpenType="URL".', 'type' => 'string', 'required' => false, 'example' => 'https://xxxx.xxx', 'title' => ''],
],
[
'name' => 'AndroidPopupActivity',
'in' => 'query',
'schema' => ['description' => 'Specify the Activity to navigate to after clicking the notification.', 'type' => 'string', 'required' => false, 'example' => 'com.alibaba.cloudpushdemo.bizactivity', 'title' => ''],
],
[
'name' => 'AndroidPopupTitle',
'in' => 'query',
'schema' => ['description' => 'Title content in supplementary popup mode. Required when the **AndroidPopupActivity** parameter is not empty.'."\n"
."\n"
.'Length limit: 50 characters (both Chinese and English characters count as one character).'."\n"
."\n"
.'If using vendor channels, it must also comply with vendor channel limits. For details, see: [Android Supplementary Channel Push Limits](~~165253~~).', 'type' => 'string', 'required' => false, 'example' => 'hello', 'title' => ''],
],
[
'name' => 'AndroidPopupBody',
'in' => 'query',
'schema' => ['description' => 'Body content in supplementary popup mode. Required when the **AndroidPopupActivity** parameter is not empty.'."\n"
."\n"
.'Length limit: 200 characters (both Chinese and English characters count as one character).'."\n"
."\n"
.'If using vendor channels, it must also comply with vendor channel limits. For details, see: [Android Supplementary Channel Push Limits](~~165253~~).', 'type' => 'string', 'required' => false, 'example' => 'hello', 'title' => ''],
],
[
'name' => 'AndroidRenderStyle',
'in' => 'query',
'schema' => [
'description' => 'Notification style. Valid values:'."\n"
.'- **0**: Standard mode (default)'."\n"
.'- **1**: Long text mode (supported by Huawei, Honor, Xiaomi, OPPO, Meizu, and proprietary channels)'."\n"
.'- **2**: Big picture mode (supported by the proprietary channel, not supported on Xiaomi devices)'."\n"
.'- **3**: List mode (supported by Huawei, Honor, Xiaomi, OPPO, and proprietary channels)'."\n"
.'> If using a non-standard mode, this parameter must be provided.',
'enumValueTitles' => ['0', '1', '2'],
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'title' => '',
],
],
[
'name' => 'AndroidBigTitle',
'in' => 'query',
'schema' => ['description' => 'Title in long text mode. Length limit: 200 bytes (1 Chinese character counts as 3 bytes).'."\n"
."\n"
.'- Currently only supported by the Honor channel and Huawei channel EMUI 11 and above.'."\n"
."\n"
.'- If not provided in long text mode, the first non-empty value from Title or AndroidPopupTitle is used.', 'type' => 'string', 'required' => false, 'example' => '示例长标题', 'title' => ''],
],
[
'name' => 'AndroidBigBody',
'in' => 'query',
'schema' => ['description' => 'Body in long text mode. Length limit: 1000 bytes (1 Chinese character counts as 3 bytes). Subject to specific vendor channel limits when sending.'."\n"
."\n"
.'Currently supported by:'."\n"
."\n"
.'- Huawei: EMUI 10 and above'."\n"
."\n"
.'- Honor: Magic UI 4.0 and above'."\n"
."\n"
.'- Xiaomi: MIUI 10 and above'."\n"
."\n"
.'- OPPO: ColorOS 5.0 and above'."\n"
."\n"
.'- Meizu: Flyme'."\n"
.'- Proprietary channel: Android SDK 3.6.0 and above'."\n"
."\n"
.'>If not provided in long text mode, the first non-empty value from Body or AndroidPopupBody is used.', 'type' => 'string', 'required' => false, 'example' => '示例长文本', 'title' => ''],
],
[
'name' => 'AndroidBigPictureUrl',
'in' => 'query',
'schema' => ['description' => 'Image URL in big picture mode. Currently supported by: Proprietary channel: Android SDK 3.6.0 and above.', 'type' => 'string', 'required' => false, 'example' => 'https://imag.example.com/image.png', 'title' => ''],
],
[
'name' => 'AndroidXiaomiBigPictureUrl',
'in' => 'query',
'schema' => ['description' => 'This parameter is deprecated. Starting from August 2023, Xiaomi officially no longer supports dynamically setting small icons, right-side icons, and big pictures during push on new devices/systems.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'https://f6.market.xiaomi.com/download/MiPass/aaa/bbb.png', 'title' => ''],
],
[
'name' => 'AndroidImageUrl',
'in' => 'query',
'schema' => ['description' => 'Right-side icon URL.'."\n"
.'Currently supported by:'."\n"
.'- Huawei EMUI (only applicable in long text mode and Inbox mode).'."\n"
."\n"
.'- Honor Magic UI (only applicable in long text mode).'."\n"
."\n"
.'- Proprietary channel: Android SDK 3.5.0 and above.', 'type' => 'string', 'required' => false, 'example' => 'https://imag.example.com/image.png', 'title' => ''],
],
[
'name' => 'AndroidXiaomiImageUrl',
'in' => 'query',
'schema' => ['description' => 'This parameter is deprecated. Starting from August 2023, Xiaomi officially no longer supports dynamically setting small icons, right-side icons, and big pictures during push on new devices/systems.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'https://imag.example.com/image.png', 'title' => ''],
],
[
'name' => 'AndroidInboxBody',
'in' => 'query',
'schema' => ['description' => 'Body content in Inbox mode. The content must be a valid JSON Array with no more than 5 elements. Currently supported by:'."\n"
."\n"
.'- Huawei: EMUI 9 and above'."\n"
.'- Honor: Magic UI 4.0 and above'."\n"
.'- Xiaomi: MIUI 10 and above'."\n"
.'- OPPO: ColorOS 5.0 and above'."\n"
.'- Proprietary channel: Android SDK 3.6.0 and above', 'type' => 'string', 'required' => false, 'example' => '["第一行","第二行"]', 'title' => ''],
],
[
'name' => 'AndroidNotificationBarType',
'in' => 'query',
'schema' => ['description' => 'Android custom notification bar style. Value range: 1-100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '2', 'title' => ''],
],
[
'name' => 'AndroidNotificationBarPriority',
'in' => 'query',
'schema' => ['description' => 'Priority of the Android notification position in the notification bar. Valid values: -2, -1, 0, 1, 2.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2', 'minimum' => '-2', 'example' => '0', 'title' => ''],
],
[
'name' => 'AndroidNotificationNotifyId',
'in' => 'query',
'schema' => ['description' => 'Unique identifier for each message when displayed in the notification bar. Different notification bar messages can share the same NotifyId, allowing new notifications to replace old ones.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100001', 'title' => ''],
],
[
'name' => 'AndroidNotificationChannel',
'in' => 'query',
'schema' => ['description' => 'The channelId of the Android app, which must correspond to the channelId in the app.'."\n"
.'- Set the NotificationChannel parameter. For specific usage, see [FAQ: Notifications Not Received on Android 8.0+ Devices](~~67398~~).'."\n"
.'- Since the OPPO private message channel\'s channel_id is the same as the app\'s channelId, the channel_id for OPPO channel push takes this value.'."\n"
.'- For Huawei, FCM, and Alibaba Cloud proprietary channel push, the channel_id takes this value.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'AndroidNotificationHuaweiChannel',
'in' => 'query',
'schema' => [
'description' => 'Set the Huawei notification message classification importance parameter, which determines notification behavior on user devices. Valid values:'."\n"
."\n"
.'- LOW: Information and marketing messages'."\n"
.'- NORMAL: Service and communication messages'."\n"
."\n"
.'>- Huawei channel currently recommends using AndroidMessageHuaweiCategory for notification classification. AndroidNotificationHuaweiChannel is no longer required.'."\n"
.'>- Requires application on the Huawei platform. [Application Link](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#section893184112272).',
'enumValueTitles' => ['LOW' => 'LOW', 'NORMAL' => 'NORMAL'],
'type' => 'string',
'required' => false,
'example' => 'LOW',
'title' => '',
],
],
[
'name' => 'AndroidNotificationHonorChannel',
'in' => 'query',
'schema' => [
'description' => 'Set the Honor notification message classification importance parameter, which determines notification behavior on user devices. Valid values:'."\n"
."\n"
.'- **LOW**: Information and marketing messages'."\n"
.'- **NORMAL**: Service and communication messages'."\n"
."\n"
.'Requires application on the Honor platform. [Application Link](https://developer.honor.com/cn/docs/11002/guides/notification-class#%E8%87%AA%E5%88%86%E7%B1%BB%E6%9D%83%E7%9B%8A%E7%94%B3%E8%AF%B7).',
'enumValueTitles' => ['LOW' => 'LOW', 'NORMAL' => 'NORMAL'],
'type' => 'string',
'required' => false,
'example' => 'LOW',
'title' => '',
],
],
[
'name' => 'AndroidNotificationXiaomiChannel',
'in' => 'query',
'schema' => ['description' => 'Set the Xiaomi notification type channelId. Requires application on the Xiaomi platform. For details, see: [Application Link](https://dev.mi.com/console/doc/detail?pId=2422#_4).'."\n"
.'>- A single application can apply for a maximum of 8 channels on the Xiaomi channel. Please plan ahead.', 'type' => 'string', 'required' => false, 'example' => 'michannel', 'title' => ''],
],
[
'name' => 'AndroidNotificationVivoChannel',
'in' => 'query',
'schema' => [
'description' => 'Set the vivo notification message classification. Valid values:'."\n"
."\n"
.'- 0: Operational messages (default)'."\n"
.'- 1: System messages'."\n"
."\n"
.'>- vivo channel currently recommends using AndroidMessageVivoCategory for notification classification. AndroidNotificationVivoChannel is no longer required.'."\n"
.'>- Requires application on the vivo platform. For details, see: [Application Link](https://dev.vivo.com.cn/documentCenter/doc/359).',
'enumValueTitles' => ['0', '1'],
'type' => 'string',
'required' => false,
'example' => 'classification',
'title' => '',
],
],
[
'name' => 'AndroidNotificationGroup',
'in' => 'query',
'schema' => ['description' => 'Message grouping. Messages in the same group are displayed as only the latest one in the notification bar along with the total count of messages received for that group. All messages are not shown and cannot be expanded. Currently supported by:'."\n"
."\n"
.'- Huawei vendor channel'."\n"
.'- Honor vendor channel'."\n"
.'- Proprietary channel: Android SDK 3.9.1 and below'."\n"
."\n"
.'> The proprietary channel no longer supports this parameter on Android SDK 3.9.2 and above.', 'type' => 'string', 'required' => false, 'example' => 'group-1', 'title' => ''],
],
[
'name' => 'AndroidNotificationThreadId',
'in' => 'query',
'schema' => ['description' => 'Message grouping. Messages in the same group are collapsed in the notification bar and can be expanded. Notifications from different groups are displayed separately. Currently supported by:'."\n"
."\n"
.'- Proprietary channel: Android SDK 3.9.2 and above', 'type' => 'string', 'required' => false, 'example' => 'thread-1', 'title' => ''],
],
[
'name' => 'AndroidExtParameters',
'in' => 'query',
'schema' => ['description' => 'Set the extension attributes of the notification. This attribute does not take effect when PushType is set to MESSAGE.'."\n"
."\n"
.'This parameter must be passed in JSON map format, otherwise parsing will fail.', 'type' => 'string', 'required' => false, 'example' => '{"key1":"value1","api_name":"PushNoticeToAndroidRequest"}', 'title' => ''],
],
[
'name' => 'AndroidMessageHuaweiUrgency',
'in' => 'query',
'schema' => [
'description' => 'Huawei channel notification delivery priority. Valid values:'."\n"
."\n"
.'- **HIGH**'."\n"
.'- **NORMAL**'."\n"
."\n"
.'Requires permission application. For details, see: [Application Link](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/faq-0000001050042183#section037425218509).',
'enumValueTitles' => ['HIGH' => 'HIGH', 'NORMAL' => 'NORMAL'],
'type' => 'string',
'required' => false,
'example' => 'HIGH',
'title' => '',
],
],
[
'name' => 'AndroidMessageHuaweiCategory',
'in' => 'query',
'schema' => ['description' => 'Purpose 1: After completing the [self-classification rights application](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835?#section3410731125514), this is used to identify the message type, determine the [message notification method](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#ZH-CN_TOPIC_0000001149358835__p3850133955718), and accelerate delivery for specific message types. For valid values, refer to the [Message Classification Standard](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#section1076611477914) in Huawei\'s official push documentation, using the "Cloud notification category value" or "Local notification category value" from the table.'."\n"
."\n"
.'Purpose 2: After [applying for special permissions](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/faq-0000001050042183#section037425218509), this is used to identify high-priority transparent transmission scenarios. Valid values:'."\n"
.'- VOIP: Audio/video calls'."\n"
.'- PLAY_VOICE: Voice playback'."\n"
."\n"
.'> For items where "Cloud notification category value" is "Not applicable", they are delivered through the Alibaba Cloud proprietary channel. For items where "Local notification category value" is "Not applicable", they are delivered through the Huawei channel.', 'type' => 'string', 'required' => false, 'example' => 'VOIP', 'title' => ''],
],
[
'name' => 'AndroidMessageOppoCategory',
'in' => 'query',
'schema' => ['description' => 'OPPO classifies messages into two categories for management: Communication & Service, and Content & Marketing.'."\n"
."\n"
.'Communication & Service (requires permission application):'."\n"
.'- IM: Instant messaging, audio, video calls'."\n"
.'- ACCOUNT: Personal account and asset changes'."\n"
.'- DEVICE_REMINDER: Personal device reminders'."\n"
.'- ORDER: Personal order/logistics status changes'."\n"
.'- TODO: Personal schedules/to-dos'."\n"
.'- SUBSCRIPTION: Personal subscriptions'."\n"
."\n"
.'Content & Marketing:'."\n"
.'- NEWS: News and information'."\n"
.'- CONTENT: Content recommendations'."\n"
.'- MARKETING: Platform promotions'."\n"
.'- SOCIAL: Social updates'."\n"
."\n"
.'For details, refer to [OPUSH Message Classification Rules](https://open.oppomobile.com/new/developmentDoc/info?id=13189).', 'type' => 'string', 'required' => false, 'example' => 'MARKETING', 'title' => ''],
],
[
'name' => 'AndroidMessageOppoNotifyLevel',
'in' => 'query',
'schema' => ['description' => 'OPPO channel notification bar message notification level. Valid values:'."\n"
.'- 1: Notification bar'."\n"
.'- 2: Notification bar, lock screen, ringtone, vibration (default notification level for Communication & Service messages)'."\n"
.'- 16: Notification bar, lock screen, ringtone, vibration, banner (requires permission application)'."\n"
."\n"
.'> When using the AndroidMessageOppoNotifyLevel parameter, the AndroidMessageOppoCategory parameter must also be provided.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'AndroidMessageVivoCategory',
'in' => 'query',
'schema' => ['description' => 'vivo classifies messages into two categories for management: System messages and Operational messages.'."\n"
.'System messages:'."\n"
.'- IM: Instant messages'."\n"
.'- ACCOUNT: Accounts and assets'."\n"
.'- TODO: Schedules and to-dos'."\n"
.'- DEVICE_REMINDER: Device information'."\n"
.'- ORDER: Orders and logistics'."\n"
.'- SUBSCRIPTION: Subscription reminders'."\n"
."\n"
.'Operational messages:'."\n"
.'- NEWS: News'."\n"
.'- CONTENT: Content recommendations'."\n"
.'- MARKETING: Operational promotions'."\n"
.'- SOCIAL: Social updates'."\n"
."\n"
.'For details, refer to [Classification Description](https://dev.vivo.com.cn/documentCenter/doc/359#s-ef3qugc3).', 'type' => 'string', 'required' => false, 'example' => 'TODO', 'title' => ''],
],
[
'name' => 'AndroidTargetUserType',
'in' => 'query',
'schema' => [
'description' => 'Set vendor channel notification type:'."\n"
.'- **0**: Official notification (default).'."\n"
.'- **1**: Test notification.'."\n"
."\n"
.'>- When this parameter is configured, it is equivalent to simultaneously configuring AndroidHuaweiTargetUserType, AndroidHonorTargetUserType, AndroidVivoPushMode, and AndroidOppoIntentEnv. The specific vendor channel parameters can override this parameter.'."\n"
.'>- Currently supported by: Huawei channel, Honor channel, vivo channel, and OPPO Fluid Cloud.',
'type' => 'integer',
'format' => 'int32',
'enum' => ['0', '1'],
'required' => false,
'example' => '0',
'title' => '',
],
],
[
'name' => 'AndroidHuaweiTargetUserType',
'in' => 'query',
'schema' => [
'description' => 'Set Huawei channel notification type:'."\n"
.'- **0**: Official notification (default).'."\n"
.'- **1**: Test notification.'."\n"
."\n"
.'> Each application can send up to 500 test notifications per day, and these are not subject to the daily per-device push limit.',
'enumValueTitles' => ['0', '1'],
'type' => 'integer',
'format' => 'int32',
'enum' => ['0', '1'],
'required' => false,
'example' => '0',
'title' => '',
],
],
[
'name' => 'AndroidHonorTargetUserType',
'in' => 'query',
'schema' => [
'description' => 'Set Honor channel notification type:'."\n"
.'- **0**: Official notification (default).'."\n"
.'- **1**: Test notification.'."\n"
."\n"
.'> Each application can send up to 1000 test notifications per day, and these are not subject to the daily per-device push limit.',
'type' => 'integer',
'format' => 'int32',
'enum' => ['0', '1'],
'required' => false,
'example' => '0',
'title' => '',
],
],
[
'name' => 'AndroidVivoPushMode',
'in' => 'query',
'schema' => [
'description' => 'Set vivo channel notification type:'."\n"
.'- **0**: Official push (default).'."\n"
.'- **1**: Test push.'."\n"
."\n"
.'> For test push, please configure the test device on the vivo console in advance. The test device RegId can be obtained by searching for "onReceiveRegId regId" in the device startup logs.',
'enumValueTitles' => ['0', '1'],
'type' => 'integer',
'format' => 'int32',
'enum' => ['0', '1'],
'required' => false,
'example' => '0',
'title' => '',
],
],
[
'name' => 'AndroidOppoIntentEnv',
'in' => 'query',
'schema' => [
'description' => 'Set OPPO Fluid Cloud push environment:'."\n"
.'- **0**: Production environment (default).'."\n"
.'- **1**: Test environment.'."\n"
."\n"
.'> OPPO Fluid Cloud test environment requires setting up the client environment as described in [Environment Setup](https://open.oppomobile.com/documentation/page/info?id=13590).',
'type' => 'integer',
'format' => 'int32',
'enum' => ['0', '1'],
'required' => false,
'example' => '1',
'title' => '',
],
],
[
'name' => 'AndroidHuaweiBusinessType',
'in' => 'query',
'schema' => [
'description' => 'Set Huawei Quick Notification parameter:'."\n"
.'- **0**: Send Huawei standard notification (default).'."\n"
.'- **1**: Send Huawei Quick Notification.',
'type' => 'integer',
'format' => 'int32',
'enum' => ['0', '1'],
'required' => false,
'example' => '1',
'title' => '',
],
],
[
'name' => 'AndroidHuaweiReceiptId',
'in' => 'query',
'schema' => ['description' => 'Huawei channel receipt ID. This receipt ID can be found in the receipt parameter configuration on the Huawei channel push management platform.'."\n"
."\n"
.'> If the default receipt configuration on the Huawei channel push management platform is set to the Alibaba Cloud receipt, this is not required. If not, it is recommended to configure the Huawei channel default receipt ID in the Alibaba Cloud EMAS Mobile Push console first.', 'type' => 'string', 'required' => false, 'example' => 'RCP4C123456', 'title' => ''],
],
[
'name' => 'AndroidVivoReceiptId',
'in' => 'query',
'schema' => ['description' => 'vivo channel receipt ID. This receipt ID can be found in the application information of the push service on the vivo open platform.'."\n"
."\n"
.'> If the default receipt configuration on the vivo open platform is set to the Alibaba Cloud receipt, this is not required. If not, it is recommended to configure the vivo channel default receipt ID in the Alibaba Cloud EMAS Mobile Push console first.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''],
],
[
'name' => 'AndroidBadgeClass',
'in' => 'query',
'schema' => ['description' => 'Full class name of the app entry Activity for badge settings.'."\n"
."\n"
.'> Only effective for Huawei/Honor vendor channel push.', 'type' => 'string', 'required' => false, 'example' => 'com.alibaba.cloudpushdemo.bizactivity', 'title' => ''],
],
[
'name' => 'AndroidBadgeAddNum',
'in' => 'query',
'schema' => ['description' => 'Set the badge increment value, which is added to the current badge count. Value range: [1-99].'."\n"
.'> Only effective for Huawei/Honor vendor channel push. When both AndroidBadgeAddNum and AndroidBadgeSetNum are present, AndroidBadgeSetNum takes precedence.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '99', 'minimum' => '1', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'AndroidBadgeSetNum',
'in' => 'query',
'schema' => ['description' => 'Set a fixed badge number. Value range: [0-99].'."\n"
."\n"
.'> For vendor channel push, only effective on Huawei and Honor channels. For Alibaba Cloud proprietary channel push, only effective on Huawei, Honor, and vivo devices.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '99', 'minimum' => '1', 'required' => false, 'example' => '5', 'title' => ''],
],
[
'name' => 'AndroidMusic',
'in' => 'query',
'schema' => ['description' => 'Huawei vendor channel notification sound. Specify the name of an audio file stored in the client project\'s app/src/main/res/raw/ directory, without the file extension.'."\n"
."\n"
.'If not set, the default ringtone is used.', 'type' => 'string', 'required' => false, 'example' => 'alicloud_notification_sound', 'title' => ''],
],
[
'name' => 'HarmonyRemind',
'in' => 'query',
'schema' => ['description' => 'When the push type is message and the device is offline, this push will use the supplementary popup feature. Default is false. Only effective when PushType=MESSAGE.'."\n"
."\n"
.'If the message-to-notification push is successful, the notification displays the HarmonyRemindTitle and HarmonyRemindBody parameter values set on the server.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'HarmonyRemindTitle',
'in' => 'query',
'schema' => ['description' => 'HarmonyOS notification title used when converting HarmonyOS messages to notifications. Only valid when HarmonyRemind is true.', 'type' => 'string', 'required' => false, 'example' => '新消息', 'title' => ''],
],
[
'name' => 'HarmonyRemindBody',
'in' => 'query',
'schema' => ['description' => 'HarmonyOS notification content used when converting HarmonyOS messages to notifications. Only valid when HarmonyRemind is true.', 'type' => 'string', 'required' => false, 'example' => '您有一条新消息,请查收', 'title' => ''],
],
[
'name' => 'HarmonyCategory',
'in' => 'query',
'schema' => [
'description' => 'Notification message category. After completing the notification message self-classification rights application, this is used to identify the message type. Different notification message types affect how messages are displayed and how alerts are triggered. Valid values:'."\n"
."\n"
.'- IM: Instant messaging'."\n"
.'- VOIP: Audio/video calls'."\n"
.'- SUBSCRIPTION: Subscriptions'."\n"
.'- TRAVEL: Travel'."\n"
.'- HEALTH: Health'."\n"
.'- WORK: Work task reminders'."\n"
.'- ACCOUNT: Account updates'."\n"
.'- EXPRESS: Orders & logistics'."\n"
.'- FINANCE: Finance'."\n"
.'- DEVICE_REMINDER: Device reminders'."\n"
.'- MAIL: Email'."\n"
.'- CUSTOMER_SERVICE: Customer service messages'."\n"
.'- MARKETING: News, content recommendations, social updates, product promotions, financial updates, lifestyle information, surveys, feature recommendations, operational promotions (only identifies content, does not accelerate message delivery), collectively referred to as information and marketing messages'."\n"
."\n"
.'For details, see the HarmonyOS official documentation [Notification.category](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section17371529101117).',
'type' => 'string',
'enum' => ['IM', 'VOIP', 'SUBSCRIPTION', 'TRAVEL', 'HEALTH', 'WORK', 'ACCOUNT', 'EXPRESS', 'FINANCE', 'DEVICE_REMINDER', 'MAIL', 'CUSTOMER_SERVICE', 'MARKETING'],
'required' => false,
'example' => 'IM',
'title' => '',
],
],
[
'name' => 'HarmonyNotificationSlotType',
'in' => 'query',
'schema' => [
'description' => 'Use the specified notification channel type. Only effective when the Alibaba Cloud proprietary channel is online.'."\n"
."\n"
.'- SOCIAL_COMMUNICATION: Social communication.'."\n"
.'- SERVICE_INFORMATION: Service reminders.'."\n"
.'- CONTENT_INFORMATION: Content information.'."\n"
.'- CUSTOMER_SERVICE: Customer service messages. This type is used for customer service messages between users and merchants, and must be initiated by the user.'."\n"
.'- OTHER_TYPES: Other.'."\n"
."\n"
.'For details, see the HarmonyOS official documentation [SlotType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/js-apis-notificationmanager-V5#slottype).',
'type' => 'string',
'enum' => ['SOCIAL_COMMUNICATION', 'SERVICE_INFORMATION', 'CONTENT_INFORMATION', 'CUSTOMER_SERVICE', 'OTHER_TYPES'],
'required' => false,
'example' => 'SOCIAL_COMMUNICATION',
'title' => '',
],
],
[
'name' => 'HarmonyNotifyId',
'in' => 'query',
'schema' => ['description' => 'Unique identifier for each message when displayed as a notification. If not provided, the push service automatically generates a unique identifier for each message. Different notification messages can share the same notifyId, enabling the new message to replace the old one.'."\n"
."\n"
.'For details, see the HarmonyOS official documentation [Notification.notifyId](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section17371529101117).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'HarmonyActionType',
'in' => 'query',
'schema' => [
'description' => 'Action after clicking the notification. Valid values:'."\n"
."\n"
.'- APP_HOME_PAGE: Open app home page'."\n"
.'- APP_CUSTOM_PAGE: Open app custom page',
'type' => 'string',
'enum' => ['APP_HOME_PAGE', 'APP_CUSTOM_PAGE'],
'required' => false,
'example' => 'APP_HOME_PAGE',
'title' => '',
],
],
[
'name' => 'HarmonyAction',
'in' => 'query',
'schema' => ['description' => 'The action corresponding to the in-app page ability.'."\n"
."\n"
.'><notice>When HarmonyActionType is APP_CUSTOM_PAGE, at least one of HarmonyUri and HarmonyAction must be provided.></notice>'."\n"
."\n"
.'For details, see the HarmonyOS official documentation [ClickAction.action](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section152462191216).', 'type' => 'string', 'required' => false, 'example' => 'com.example.action', 'title' => ''],
],
[
'name' => 'HarmonyUri',
'in' => 'query',
'schema' => ['description' => 'The URI corresponding to the in-app page ability.'."\n"
.'><notice>When HarmonyActionType is APP_CUSTOM_PAGE, at least one of HarmonyUri and HarmonyAction must be provided. When multiple Abilities exist, fill in the action and uri of each Ability separately. The action is used first to find the corresponding in-app page.></notice>'."\n"
."\n"
.'For details, see the HarmonyOS official documentation [ClickAction.uri](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section152462191216).', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com:8080/push/example', 'title' => ''],
],
[
'name' => 'HarmonyRenderStyle',
'in' => 'query',
'schema' => [
'description' => 'Notification message style:'."\n"
.'- NORMAL: Standard notification (default)'."\n"
.'- MULTI_LINE: Multi-line text style',
'type' => 'string',
'enum' => ['NORMAL', 'MULTI_LINE'],
'required' => false,
'example' => 'NORMAL',
'title' => '',
],
],
[
'name' => 'HarmonyImageUrl',
'in' => 'query',
'schema' => ['description' => 'URL for the large icon on the right side of the notification. The URL must use the HTTPS protocol.'."\n"
."\n"
.'> Supported image formats: png, jpg, jpeg, heif, gif, bmp. Image width * height must be less than 25000 pixels.'."\n"
."\n"
.'For details, see the HarmonyOS official documentation [Notification.image](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section17371529101117).', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/xxx.png', 'title' => ''],
],
[
'name' => 'HarmonyInboxContent',
'in' => 'query',
'schema' => ['description' => 'Content for multi-line text style. Required when HarmonyRenderStyle is MULTI_LINE. Supports up to 3 items.', 'type' => 'string', 'required' => false, 'example' => '["1.content1","2.content2","3.content3"]', 'title' => ''],
],
[
'name' => 'HarmonyExtParameters',
'in' => 'query',
'schema' => ['description' => 'Set the extension attributes of the notification. This attribute does not take effect when PushType is set to MESSAGE.'."\n"
."\n"
.'This parameter must be passed in JSON map format, otherwise parsing will fail.', 'type' => 'string', 'required' => false, 'example' => '{"key1":"value1","api_name":"PushNoticeToAndroidRequest"}'."\n", 'title' => ''],
],
[
'name' => 'HarmonyTestMessage',
'in' => 'query',
'schema' => ['description' => 'Test message flag:'."\n"
."\n"
.'- false: Official message (default)'."\n"
.'- true: Test message'."\n"
."\n"
.'For details, see the HarmonyOS official documentation [pushOptions.testMessage](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section418321011212).', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'HarmonyReceiptId',
'in' => 'query',
'schema' => ['description' => 'HarmonyOS channel receipt ID. This receipt ID can be found in the receipt parameter configuration on the HarmonyOS channel push management platform.'."\n"
."\n"
.'> If the default receipt configuration on the HarmonyOS channel push management platform is set to the Alibaba Cloud receipt, this is not required. If not, it is recommended to configure the HarmonyOS channel default receipt ID in the Alibaba Cloud EMAS Mobile Push console first.'."\n"
."\n"
.'For details, see the HarmonyOS official documentation [pushOptions.receiptId](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section418321011212).', 'type' => 'string', 'required' => false, 'example' => 'RCPB***DFD5', 'title' => ''],
],
[
'name' => 'HarmonyExtensionPush',
'in' => 'query',
'schema' => ['description' => 'When PushType is NOTICE, whether to send as a HarmonyOS notification extension message.'."\n"
."\n"
.'- true: Send notification extension message'."\n"
.'- false: Send standard notification (default)'."\n"
."\n"
.'Notification extension messages require permission application on the HarmonyOS side before sending. For details, refer to the HarmonyOS documentation [Send Notification Extension Messages](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/push-send-extend-noti-V5).</br>'."\n"
.'Supported from HarmonyOS SDK 1.2.0.', 'type' => 'boolean', 'required' => false, 'example' => 'true'."\n", 'title' => ''],
],
[
'name' => 'HarmonyExtensionExtraData',
'in' => 'query',
'schema' => ['description' => 'Extra data for notification extension messages.</br>'."\n"
.'Effective when sending HarmonyOS notification extension messages.</br>'."\n"
.'Conceptually equivalent to the extraData field of HarmonyOS notification extension messages. For the specific definition, refer to [HarmonyOS ExtensionPayload Description](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section161192514234).</br>'."\n"
.'Supported from HarmonyOS SDK 1.2.0.', 'type' => 'string', 'required' => false, 'example' => '示例额外数据', 'title' => ''],
],
[
'name' => 'HarmonyBadgeAddNum',
'in' => 'query',
'schema' => ['description' => 'HarmonyOS app badge increment number. Refer to [HarmonyOS badge addNum field description](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section266310382145).</br>'."\n"
.'Supported from HarmonyOS SDK 1.2.0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'HarmonyBadgeSetNum',
'in' => 'query',
'schema' => ['description' => 'HarmonyOS app badge set number. Refer to [HarmonyOS badge setNum field description](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section266310382145).'."\n"
.'Supported from HarmonyOS SDK 1.2.0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'SmsTemplateName',
'in' => 'query',
'schema' => ['description' => 'The template name for supplementary SMS. This can be obtained from the SMS template management page and is a system-assigned name, not a developer-defined name.', 'type' => 'string', 'required' => false, 'example' => '短信模板名称', 'title' => ''],
],
[
'name' => 'SmsSignName',
'in' => 'query',
'schema' => ['description' => 'The signature for supplementary SMS.', 'type' => 'string', 'required' => false, 'example' => '短信签名', 'title' => ''],
],
[
'name' => 'SmsParams',
'in' => 'query',
'schema' => ['description' => 'Variable name-value pairs for the SMS template, in the format: `key1=value1&key2=value2`.', 'type' => 'string', 'required' => false, 'example' => 'key1=value1', 'title' => ''],
],
[
'name' => 'SmsDelaySecs',
'in' => 'query',
'schema' => ['description' => 'Delay time before triggering SMS, in seconds.'."\n"
."\n"
.'Must be set when using SMS convergence. Recommended to be 15 seconds or more, with a maximum of 3 days, to avoid duplication between SMS and push notifications.'."\n"
."\n"
.'> When SMS convergence is used, the ExpireTime parameter becomes ineffective. The notification expiration time is calculated based on the SmsDelaySecs parameter, with the expiration time being the current time plus SmsDelaySecs.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '15', 'title' => ''],
],
[
'name' => 'SmsSendPolicy',
'in' => 'query',
'schema' => [
'description' => 'Condition for triggering SMS. Valid values:'."\n"
."\n"
.'- **0**: Triggered when push is not received.'."\n"
.'- **1**: Triggered when user has not opened the notification.',
'enumValueTitles' => ['0', '1'],
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '1',
'minimum' => '0',
'example' => '0',
'title' => '',
],
],
[
'name' => 'SendSpeed',
'in' => 'query',
'schema' => ['description' => 'This parameter is deprecated.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'required' => false, 'minimum' => '10000', 'example' => '0', 'title' => ''],
],
[
'name' => 'AndroidXiaoMiNotifyTitle',
'in' => 'query',
'schema' => ['description' => 'This parameter is deprecated. All third-party supplementary popups are now supported by the new parameter **AndroidPopupTitle**.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '无', 'title' => ''],
],
[
'name' => 'AndroidXiaoMiNotifyBody',
'in' => 'query',
'schema' => ['description' => 'This parameter is deprecated. All third-party supplementary popups are now supported by the new parameter **AndroidPopupBody**.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '无', 'title' => ''],
],
[
'name' => 'AndroidXiaoMiActivity',
'in' => 'query',
'schema' => ['description' => 'This parameter is deprecated. All third-party supplementary popups are now supported by the new parameter **AndroidPopupActivity**.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '无', 'title' => ''],
],
[
'name' => 'IdempotentToken',
'in' => 'query',
'schema' => ['description' => 'An idempotent parameter to prevent duplicate pushes caused by API client retries. When the same IdempotentToken is used for calls within 15 minutes, only one push will be made, and subsequent calls will return the result of the first successful push.'."\n"
."\n"
.'> '."\n"
.'> - The parameter format is a standard 36-character UUID (8-4-4-4-12). Each valid character is a hexadecimal digit in the range 0-9 or a-f, case-insensitive.'."\n"
.'> - This parameter is only used to prevent duplicate pushes caused by retries. It cannot prevent duplicate pushes caused by concurrent calls.', 'type' => 'string', 'maxLength' => 36, 'minLength' => 36, 'required' => false, 'example' => 'c8016d13-6e76-410c-9bda-769383d11787', 'title' => ''],
],
[
'name' => 'AndroidMeizuNoticeMsgType',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => 'Meizu message type:'."\n"
.'- 0: Public message (default)'."\n"
.'- 1: Private message',
'enumValueTitles' => ['Public message (default)', 'Private message'],
'type' => 'integer',
'format' => 'int32',
'docRequired' => false,
'example' => '0',
'enum' => ['0', '1'],
'required' => false,
'title' => '',
],
],
[
'name' => 'AndroidOppoPrivateMsgTemplateId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'OPPO private message template ID', 'type' => 'string', 'required' => false, 'example' => '687557242b1634hzefs3d5013'],
],
[
'name' => 'AndroidOppoPrivateTitleParameters',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'OPPO private message template title parameters',
'type' => 'object',
'required' => false,
'additionalProperties' => ['description' => 'Variable name and value in the OPPO private message template title', 'type' => 'string', 'example' => 'my_title', 'title' => ''],
'example' => '',
],
],
[
'name' => 'AndroidOppoPrivateContentParameters',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'OPPO private message template content parameters',
'type' => 'object',
'required' => false,
'additionalProperties' => ['description' => 'Variable name and value in the OPPO private message template content', 'type' => 'string', 'example' => 'my_content', 'title' => ''],
'example' => '',
],
],
[
'name' => 'AndroidXiaomiTemplateId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Xiaomi private message template ID', 'type' => 'string', 'required' => false, 'example' => 'P10645'],
],
[
'name' => 'AndroidXiaomiTemplateParams',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Xiaomi private message template parameters, JSON string', 'type' => 'string', 'required' => false, 'example' => '{"keywords1":"Tom","keywords2":"phone"}'],
],
[
'name' => 'HarmonyLiveViewPayload',
'in' => 'query',
'schema' => ['description' => 'JSON string of the HarmonyOS Live View data structure [LiveViewPayload](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V13/push-scenariozed-api-request-param-V13#section66881469306). For development integration, refer to the documentation [HarmonyOS Live View Push Guide](https://help.aliyun.com/document_detail/2982112.html).', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "activityId": 1,'."\n"
.' "operation": 0,'."\n"
.' "event": "TAXI",'."\n"
.' "status": "DRIVER_ON_THE_WAY",'."\n"
.' "activityData": {'."\n"
.' "notificationData": {'."\n"
.' "type": 3'."\n"
.' }'."\n"
.' }'."\n"
.'}', 'title' => ''],
],
[
'name' => 'AndroidHuaweiLiveNotificationPayload',
'in' => 'query',
'schema' => ['description' => 'JSON string of the Huawei Android Live Notification data structure [LiveNotificationPayload](https://developer.huawei.com/consumer/cn/doc/HMSCore-References/rest-live-0000001562939968#ZH-CN_TOPIC_0000001700850537__p195121620102511). For development integration, refer to the documentation [Huawei Live Notification Push Guide](https://help.aliyun.com/document_detail/2983768.html).', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "activityId": 1,'."\n"
.' "operation": 1,'."\n"
.' "event": "TAXI",'."\n"
.' "activityData": {'."\n"
.' "notificationData": {'."\n"
.' "type": 3'."\n"
.' }'."\n"
.' }'."\n"
.'}', 'title' => ''],
],
[
'name' => 'AndroidOppoIntelligentIntent',
'in' => 'query',
'schema' => ['description' => 'JSON string of the OPPO Fluid Cloud intent sharing data structure [IntelligentIntent](https://open.oppomobile.com/documentation/page/info?id=13565). For development integration, refer to the documentation [OPPO Fluid Cloud Push Guide](https://help.aliyun.com/document_detail/2997310.html).', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "intentName": "Example.Progress",'."\n"
.' "identifier": "d71ebd3119877b12ecdb6c4fe96b068e",'."\n"
.' "timestamp": 1729485000989,'."\n"
.' "serviceId": {'."\n"
.' "launcher": "999800001",'."\n"
.' "fluidCloud": "999900001"'."\n"
.' },'."\n"
.' "intentAction": {'."\n"
.' "actionStatus": 0'."\n"
.' },'."\n"
.' "intentEntity": {'."\n"
.' "entityName": "TAXI"'."\n"
.' }'."\n"
.'}', 'title' => ''],
],
[
'name' => 'AndroidOppoDeleteIntentData',
'in' => 'query',
'schema' => ['description' => 'JSON string of the OPPO Fluid Cloud intent deletion data structure [data](https://open.oppomobile.com/documentation/page/info?id=13578). When the AndroidOppoIntelligentIntent parameter is already provided, this parameter is ignored. For development integration, refer to the documentation [OPPO Fluid Cloud Push Guide](https://help.aliyun.com/document_detail/2997310.html).', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "intentName": "Example.Progress",'."\n"
.' "entityIds": ['."\n"
.' "A580202509130712"'."\n"
.' ],'."\n"
.' "serviceId": {'."\n"
.' "launcher": "999800001",'."\n"
.' "fluidCloud": "999900001"'."\n"
.' }'."\n"
.'}', 'title' => ''],
],
[
'name' => 'AndroidVivoLiveMessage',
'in' => 'query',
'schema' => ['description' => 'JSON string of the vivo Atomic Island data structure [liveMessage](https://dev.vivo.com.cn/documentCenter/doc/896#s-fdagzbd4). For development integration, refer to the documentation [vivo Atomic Island Push Guide](https://help.aliyun.com/zh/document_detail/3030718.html).', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "operation": 0,'."\n"
.' "scene": "HEALTH_REGISTER",'."\n"
.' "templateType": 1,'."\n"
.' "showNotify": true,'."\n"
.' "changeRecord": 999,'."\n"
.' "capsuleData": {'."\n"
.' "bgColor": "#32d4d4"'."\n"
.' }'."\n"
.'}', 'title' => ''],
],
[
'name' => 'AndroidXiaomiFocusParam',
'in' => 'query',
'schema' => ['description' => 'JSON string of the Xiaomi Super Island data structure [miui.focus.param](https://dev.mi.com/xiaomihyperos/documentation/detail?pId=2131). For development integration, refer to the documentation [Xiaomi Super Island Push Guide](https://help.aliyun.com/zh/document_detail/3037956.html).', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "param_v2": {'."\n"
.' "business": "taxi",'."\n"
.' "updatable": true,'."\n"
.' "orderId": "A580202509130712",'."\n"
.' "param_island": {'."\n"
.' "islandProperty": 1,'."\n"
.' "bigIslandArea": {'."\n"
.' "imageTextInfoLeft": {'."\n"
.' "type": 1'."\n"
.' }'."\n"
.' }'."\n"
.' }'."\n"
.' }'."\n"
.'}', 'title' => ''],
],
[
'name' => 'AndroidXiaomiFocusPics',
'in' => 'query',
'schema' => ['description' => 'JSON string of the Xiaomi Super Island image data [miui.focus.pic_xxx](https://dev.mi.com/xiaomihyperos/documentation/detail?pId=2131). For development integration, refer to the documentation [Xiaomi Super Island Push Guide](https://help.aliyun.com/zh/document_detail/3037956.html).', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "miui.focus.pic_ticker": "https://example.com/ticker.jpg",'."\n"
.' "miui.focus.pic_aod": "https://example.com/aod.jpg",'."\n"
.' "miui.focus.pic_imageText": "https://example.com/imageText.jpg"'."\n"
.'}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => ['description' => 'The message ID that identifies a push operation.', 'type' => 'string', 'example' => '501029', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidPeriod.ExceedDays', 'errorMessage' => 'The period between specified EndTime and StartTime exceeds %s days.', 'description' => ''],
['errorCode' => 'Invalid%s.Format', 'errorMessage' => 'The specified %s format is invalid.', 'description' => ''],
['errorCode' => 'AccountDisabled', 'errorMessage' => 'Your account is not enabled.', 'description' => ''],
['errorCode' => 'FileNotExist', 'errorMessage' => 'The specified file does not exist.', 'description' => ''],
['errorCode' => 'IncorrectPassword', 'errorMessage' => 'The password is incorrect.', 'description' => ''],
['errorCode' => 'NotApnsCertificate', 'errorMessage' => 'The Certificate is not an APNs certificate.', 'description' => ''],
['errorCode' => 'PermissionDenied', 'errorMessage' => 'The specified AppKey is not authorized.', 'description' => ''],
['errorCode' => 'SendSpeedNotSupported', 'errorMessage' => 'SendSpeed is not supported for specified Target.', 'description' => ''],
['errorCode' => 'SmsProfileConfigFailed', 'errorMessage' => 'Failed to configure SMS profile.', 'description' => ''],
['errorCode' => 'SmsProfileGetFailed', 'errorMessage' => 'Failed to get SMS profile.', 'description' => ''],
['errorCode' => 'SmsRoleAuthorizeFailed', 'errorMessage' => 'Failed to authorize SMS role.', 'description' => ''],
['errorCode' => 'SmsRoleUnauthorized', 'errorMessage' => 'The SMS role is unauthorized.', 'description' => ''],
['errorCode' => 'TagsNumberBeyondLimit', 'errorMessage' => 'The number of tags bound to this app exceeds the limit.', 'description' => ''],
['errorCode' => 'Invalid%s.LengthExceed', 'errorMessage' => 'The specified %s length cannot be greater than %s.', 'description' => ''],
['errorCode' => 'Invalid%s.BytesExceed', 'errorMessage' => 'The specified %s exceeds the %s bytes limit.', 'description' => ''],
['errorCode' => 'Invalid%s.Empty', 'errorMessage' => 'The specified %s cannot be empty.', 'description' => ''],
['errorCode' => 'Invalid.Parameter', 'errorMessage' => 'The specified parameter is invalid: %s.', 'description' => ''],
['errorCode' => 'TargetNotSupported', 'errorMessage' => 'Target is not supported for batch push.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.', 'description' => 'The request processing has failed due to some unknown error.'],
['errorCode' => 'Timeout', 'errorMessage' => 'The request processing is timeout.', 'description' => 'Request processing timed out.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"501029\\",\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","type":"json"}]',
'title' => 'Advanced Push',
'description' => '**Please ensure that you have fully understood the [billing methods and pricing](~~434638~~) of the EMAS Mobile Push product before using this API.**'."\n"
."\n"
.'This API differentiates between Android, iOS, and HarmonyOS platforms. For push calls on different platforms, you need to pass the corresponding platform\'s AppKey.',
'requestParamsDescription' => '## Additional Information on Request Parameters'."\n"
.'**Title/Body details are as follows:**'."\n"
."\n"
.'|Attribute\\Push Type|Message (iOS)|Message (Android)|Notification (iOS)| Notification (Android)|'."\n"
.'|:-----------------|:-----------------|:-----------------|:-----------------|:-----------------|'."\n"
.'|Title |Message title, corresponding to the title field of CCPSysMessage in the message callback| CPushMessage.title field| Notification title | Notification title, notification callback method (onNotificationOpened)|'."\n"
.'Body| Message body, corresponding to the body field of CCPSysMessage in the message callback| Message body, CPushMessage.content field| Notification content |Notification content, notification callback method (onNotificationOpened)|'."\n"
."\n"
.'**The following configurations only apply to the Android supplementary popup feature:**'."\n"
."\n"
.'When the device is offline during push (i.e., the persistent connection to the push server is disconnected), the push can activate the supplementary popup feature. To enable the supplementary popup feature, see [Mobile Push Supplementary Channel Configuration](https://help.aliyun.com/document_detail/30067.html). The following conditions must also be met:'."\n"
."\n"
.'* Third-party supplementary channels are integrated.'."\n"
.'* The StoreOffline parameter is set to true.'."\n"
.'* Push notification (no need to set AndroidRemind) or push message with AndroidRemind set to true.'."\n"
.'* The AndroidPopupActivity, AndroidPopupTitle, and AndroidPopupBody parameters are correctly set.',
'responseParamsDescription' => ' ',
'extraInfo' => '## Java Sample Code'."\n"
."\n"
.'```'."\n"
.'PushRequest pushRequest = new PushRequest();'."\n"
.'// Push target'."\n"
.'pushRequest.setAppKey(appKey);'."\n"
.'pushRequest.setTarget("ALL"); // Push target: DEVICE: push to devices; ACCOUNT: push to specified accounts; TAG: push to custom tags; ALIAS: push by alias; ALL: push to all'."\n"
.'pushRequest.setTargetValue("all"); // Set according to Target. For example, if Target=DEVICE, the value is deviceid1,deviceid2. Multiple values are separated by commas. (Accounts and devices have a limit of 100 per request)'."\n"
.'pushRequest.setDeviceType("iOS"); // Device type deviceType. iOS devices: "iOS"; Android devices: "ANDROID"; All: "ALL", this is the default value.'."\n"
.'// Push configuration'."\n"
.'pushRequest.setPushType("MESSAGE"); // MESSAGE: message (default), NOTICE: notification'."\n"
.'pushRequest.setTitle("Hello"); // Message title'."\n"
.'pushRequest.setBody("PushRequest body"); // Message content'."\n"
.'// Push configuration: iOS'."\n"
.'pushRequest.setIOSBadge(5); // iOS app icon badge number'."\n"
.'pushRequest.setIOSMusic("default"); // iOS notification sound'."\n"
.'pushRequest.setIOSApnsEnv("PRODUCT"); // iOS notifications are sent through the APNs center. Fill in the corresponding environment information. \'DEV\': development environment \'PRODUCT\': production environment'."\n"
.'pushRequest.setIOSRemind(true); // When the device is offline during message push (i.e., the persistent connection to the push server is disconnected), this push will be delivered as a notification through Apple\'s APNs channel once. Note: **Offline message-to-notification conversion only applies to the `production environment`**'."\n"
.'pushRequest.setIOSRemindBody("PushRequest summary"); // iOS notification content used when converting messages to notifications, only valid when iOSApnsEnv=`PRODUCT` && iOSRemind is true'."\n"
.'pushRequest.setIOSExtParameters("{\\"k1\\":\\"ios\\",\\"k2\\":\\"v2\\"}"); // Notification extension attributes (Note: this parameter must be passed in JSON map format, otherwise parsing will fail)'."\n"
.'// Push configuration: Android'."\n"
.'pushRequest.setAndroidOpenType("ACTIVITY"); // Action after clicking notification. \'APPLICATION\': open app \'ACTIVITY\': open Android Activity \'URL\': open URL \'NONE\': no redirect'."\n"
.'pushRequest.setAndroidNotifyType("SOUND"); // Notification alert type. \'VIBRATE\': vibration \'SOUND\': sound \'DEFAULT\': sound and vibration \'NONE\': no processing, user-defined'."\n"
.'pushRequest.setAndroidOpenUrl("http://www.alibaba.com");'."\n"
.'pushRequest.setAndroidMusic("alicloud_notification_sound"); // Huawei vendor channel notification sound'."\n"
.'pushRequest.setAndroidActivity("com.alibaba.push.PushActivity"); // Open the corresponding ACTIVITY after Android receives the push, only valid when `AndroidOpenType="ACTIVITY"`'."\n"
.'pushRequest.setAndroidPopupActivity("com.alibaba.push.PopupActivity"); // Setting this parameter enables the supplementary popup feature. Specifies the Activity to navigate to after clicking the notification (Prerequisites: 1. Third-party supplementary channel integrated; 2. StoreOffline set to true)'."\n"
.'pushRequest.setAndroidPopupTitle("Popup Title"); // Set supplementary popup notification title'."\n"
.'pushRequest.setAndroidPopupBody("Popup Body"); // Set supplementary popup notification content'."\n"
.'pushRequest.setAndroidNotificationBarType(50); // Android custom notification bar style, value range: 1-100'."\n"
.'pushRequest.setAndroidNotificationBarPriority(2); // Priority of Android notification position in the notification bar: -2 -1 0 1 2'."\n"
.'pushRequest.setAndroidExtParameters("{\\"k1\\":\\"android\\",\\"k2\\":\\"v2\\"}"); // Set notification extension attributes (Note: this parameter must be passed in JSON map format, otherwise parsing will fail)'."\n"
.'// Push control'."\n"
.'final Date pushDate = new Date(System.currentTimeMillis() + 3600 * 1000); // For scheduled sending. If not set, the default is immediate sending. Time format follows the ISO8601 standard in UTC, format: `YYYY-MM-DDThh:mm:ssZ`.'."\n"
.'final String pushTime = ParameterHelper.getISO8601Time(pushDate);'."\n"
.'pushRequest.setPushTime(pushTime); // Delayed push. Optional, if not set, it means immediate push'."\n"
.'pushRequest.setStoreOffline(true); // Whether to save offline messages. If saved, when the user is offline during push, they will receive it when they next come online. On Android, if set to false, only the Alibaba Cloud proprietary online channel is used'."\n"
.'final String expireTime = ParameterHelper.getISO8601Time(new Date(System.currentTimeMillis() + 12 * 3600 * 1000)); // Message expires after 12 hours and will no longer be sent'."\n"
.'pushRequest.setExpireTime(expireTime);'."\n"
.'pushRequest.setSendChannels("accs,huawei,honor,vivo,xiaomi,oppo"); // Specify push channels for delivery. If not specified, delivery can be made through any available channel'."\n"
.'pushRequest.setAndroidNotificationNotifyId(1234567); // Set notification override parameter to avoid displaying multiple identical notifications in retry scenarios'."\n"
.'pushRequest.setAndroidTargetUserType(0); // Indicates that if this push is sent to Huawei, Honor, or vivo channels, it is an official notification. However, in this code example, this value is overridden by vendor channel-specific parameters'."\n"
.'pushRequest.setAndroidHuaweiTargetUserType(1); // Indicates that if this push is sent to the Huawei channel, it is a test notification'."\n"
.'pushRequest.setAndroidHonorTargetUserType(1); // Indicates that if this push is sent to the Honor channel, it is a test notification'."\n"
.'pushRequest.setAndroidVivoPushMode(1); // Indicates that if this push is sent to the vivo channel, it is a test notification. Please add the vivo device regId to the test device list on the vivo push platform before pushing'."\n"
.'pushRequest.setAndroidHuaweiReceiptId("ABCDEFG"); // Huawei vendor channel'."\n"
.'// Vendor channel notification classification'."\n"
.'pushRequest.setAndroidNotificationChannel("user_define"); // OPPO private message channel channel_id, and general Android channel_id'."\n"
.'pushRequest.setAndroidNotificationXiaomiChannel("user_define"); // Xiaomi channel notification type channel_id'."\n"
.'pushRequest.setAndroidNotificationHonorChannel("NORMAL"); // Honor channel message classification parameter, corresponding to the Honor channel importance parameter'."\n"
.'pushRequest.setAndroidMessageHuaweiCategory("ACCOUNT"); // Huawei channel notification classification parameter. Service and communication notifications require permission application from the Huawei channel'."\n"
.'pushRequest.setAndroidMessageVivoCategory("ACCOUNT"); // vivo channel notification classification parameter. System messages require permission application from the vivo channel'."\n"
.'// SMS convergence notification'."\n"
.'pushRequest.setSmsTemplateName("SMS_1234567"); // Set SMS template name'."\n"
.'pushRequest.setSmsSignName("Test"); // Set SMS signature'."\n"
.'pushRequest.setSmsParams("name=Bob&code=123"); // SMS template variables'."\n"
.'pushRequest.setSmsSendPolicy(0); // SMS resend policy. 0 indicates resend when the device has not received the push'."\n"
.'pushRequest.setSmsDelaySecs(120); // Trigger SMS if not received within two minutes'."\n"
.'PushResponse pushResponse = client.getAcsResponse(pushRequest);'."\n"
.'System.out.printf("RequestId: %s, MessageId: %s\\n",'."\n"
.' pushResponse.getRequestId(), pushResponse.getMessageId());'."\n"
.'```',
'changeSet' => [
['createdAt' => '2025-11-25T08:17:08.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-09-19T03:03:01.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-09-18T09:24:49.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-09-09T08:21:44.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-08-21T11:21:59.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-03-21T09:22:04.000Z', 'description' => 'Error codes changed, Request parameters changed'],
['createdAt' => '2025-01-16T07:23:21.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-11-13T03:09:40.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-10-23T08:32:10.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-10-23T08:32:10.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-10-10T01:26:31.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-08-07T05:34:11.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-06-25T04:40:41.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-18T11:18:34.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-10-12T07:14:53.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-03-15T14:04:19.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-06-07T11:29:17.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2021-09-15T06:53:20.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'Push'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:Push',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'PushMessageToAndroid' => [
'summary' => 'Sends a message to an Android device through the Alibaba Cloud Mobile Push proprietary channel. After the app on the device receives the message, it must handle subsequent actions, such as implementing business logic or displaying a local notification.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'The AppKey.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => 'The push target. Valid values:'."\n"
."\n"
.'- **DEVICE**: Pushes messages to devices.'."\n"
."\n"
.'- **ACCOUNT**: Pushes messages to accounts.'."\n"
."\n"
.'- **ALIAS**: Pushes messages to aliases.'."\n"
."\n"
.'- **TAG**: Pushes messages to tags.'."\n"
."\n"
.'- **ALL**: Pushes messages to all devices.',
'type' => 'string',
'required' => true,
'enum' => ['ALL', 'DEVICE', 'ACCOUNT', 'ALIAS', 'TAG'],
'example' => 'ALL',
'title' => '',
],
],
[
'name' => 'TargetValue',
'in' => 'query',
'schema' => ['description' => 'Set this parameter based on the value of \\`Target\\`. Use commas (,) to separate multiple values. If you exceed the limit, send the pushes in batches.'."\n"
."\n"
.'- If \\`Target\\` is set to \\`DEVICE\\`, specify device IDs. Example: `deviceid111,deviceid1111`. You can specify up to 1,000 device IDs.'."\n"
."\n"
.'- If \\`Target\\` is set to \\`ACCOUNT\\`, specify account IDs. Example: `account111,account222`. You can specify up to 1,000 account IDs.'."\n"
."\n"
.'- If \\`Target\\` is set to \\`ALIAS\\`, specify aliases. Example: `alias111,alias222`. You can specify up to 1,000 aliases.'."\n"
."\n"
.'- If \\`Target\\` is set to \\`TAG\\`, you can specify one or more tags. For more information about the format, see [Tag format](~~434847~~).'."\n"
."\n"
.'- If \\`Target\\` is set to \\`ALL\\`, set the value to **all**.', 'type' => 'string', 'required' => true, 'example' => 'all', 'title' => ''],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => ['description' => 'The title of the message.', 'type' => 'string', 'required' => true, 'example' => 'my title', 'title' => ''],
],
[
'name' => 'Body',
'in' => 'query',
'schema' => ['description' => 'The content of the message.', 'type' => 'string', 'required' => true, 'example' => 'my body', 'title' => ''],
],
[
'name' => 'StoreOffline',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to store the message offline. The default value is false.'."\n"
."\n"
.'If you store the message and the user is offline, the message is sent again when the user comes online within the time-to-live (TTL) period. The default TTL is 72 hours.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'JobKey',
'in' => 'query',
'schema' => ['description' => 'A custom ID for the push task. If \\`JobKey\\` is not empty, this field is included in the receipt logs. For more information, see [Receipt logs](~~434651~~).', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => ['description' => 'The ID of the message pushed.', 'type' => 'string', 'example' => '501029', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Invalid%s.Format', 'errorMessage' => 'The specified %s format is invalid.', 'description' => ''],
['errorCode' => 'Invalid%s.Empty', 'errorMessage' => 'The specified %s cannot be empty.', 'description' => ''],
['errorCode' => 'Invalid.Parameter', 'errorMessage' => 'The specified parameter is invalid: %s.', 'description' => ''],
],
500 => [
['errorCode' => 'Timeout', 'errorMessage' => 'The request processing is timeout.', 'description' => 'Request processing timed out.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.', 'description' => 'The request processing has failed due to some unknown error.'],
],
],
'title' => 'Push Message to Android Devices'."\n",
'description' => '**This operation will be deprecated soon. Use the [advanced push API](~~2249916~~), which provides enhanced push capabilities. To achieve the same result, set the `DeviceType` parameter to `ANDROID` and the `PushType` parameter to `MESSAGE` in the advanced push API.**'."\n"
."\n"
.'**Before using this operation, review the [billing methods and pricing](~~434638~~) for EMAS Mobile Push.**'."\n"
."\n"
.'By default, this operation sends messages only to online devices. If a device is offline, set the `StoreOffline` parameter. The push system then stores the message and delivers it automatically when the device comes online.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-01-22T14:27:51.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:51.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:51.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-10-12T07:14:53.000Z', 'description' => 'Request parameters changed, Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '60000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'PushMessageToAndroid'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:PushMessageToAndroid',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"501029\\",\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","type":"json"}]',
],
'PushMessageToiOS' => [
'summary' => 'Pushes messages to iOS devices. These messages are delivered through the proprietary channel of Alibaba Cloud Mobile Push. After the app on a device receives a message, it must handle subsequent actions, such as implementing business behaviors or creating local notifications.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'AppKey information.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '24780725', 'title' => ''],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => 'Push target. Valid values:'."\n"
."\n"
.'- **DEVICE**: Push by device'."\n"
."\n"
.'- **ACCOUNT**: Push by account'."\n"
."\n"
.'- **ALIAS**: Push by alias'."\n"
."\n"
.'- **TAG**: Push by tag'."\n"
."\n"
.'- **ALL**: Push to all devices',
'type' => 'string',
'required' => true,
'enum' => ['ALL', 'DEVICE', 'ACCOUNT', 'ALIAS', 'TAG'],
'example' => 'ALL',
'title' => '',
],
],
[
'name' => 'TargetValue',
'in' => 'query',
'schema' => ['description' => 'Set based on Target. Separate multiple values with commas. If the limit is exceeded, push multiple times.'."\n"
."\n"
.'- Target=DEVICE. Example values: `deviceid111,deviceid1111` (supports up to 1,000).'."\n"
."\n"
.'- Target=ACCOUNT. Example values: `account111,account222` (supports up to 1,000).'."\n"
."\n"
.'- Target=ALIAS. Example values: `alias111,alias222` (supports up to 1,000).'."\n"
."\n"
.'- Target=TAG. Supports single and multiple tags. For format, see [Tag Format](~~434847~~).'."\n"
."\n"
.'- Target=ALL. Value is **all**.', 'type' => 'string', 'required' => true, 'example' => 'all', 'title' => ''],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => ['description' => 'The title of the message.', 'type' => 'string', 'required' => true, 'example' => 'my title', 'title' => ''],
],
[
'name' => 'Body',
'in' => 'query',
'schema' => ['description' => 'The content of the message.', 'type' => 'string', 'required' => true, 'example' => 'my body', 'title' => ''],
],
[
'name' => 'StoreOffline',
'in' => 'query',
'schema' => ['description' => 'Whether to store the message offline. StoreOffline is set to false by default.'."\n"
."\n"
.'If stored, and the user is offline during the push, the message is sent again when the user comes online within the time-to-live (TTL). The default time-to-live (TTL) is 72 hours.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'JobKey',
'in' => 'query',
'schema' => ['description' => 'The custom ID for the push Job. If JobKey is not empty, this field is included in the receipt log. For receipt logs, see [Receipt Logs](~~434651~~).', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => ['description' => 'The message ID that identifies a push.', 'type' => 'string', 'example' => '501029', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Push Message to iOS Devices'."\n",
'description' => '**This API is deprecated. Use the [advanced push API](~~2249916~~) for more push capabilities. In that API, set the push platform `DeviceType` to `iOS` and the push type `PushType` to `MESSAGE` to achieve the same effect.**'."\n"
."\n"
.'**Before you use this API, review the [billing methods and pricing](~~434638~~) for EMAS Mobile Push.**'."\n"
."\n"
.'By default, this API sends messages only to online devices. If a device is offline, you can set the `StoreOffline` parameter. The push system then saves the message and automatically delivers it when the device comes back online.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-10-12T07:14:53.000Z', 'description' => 'Request parameters changed, Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '60000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'PushMessageToiOS'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:PushMessageToiOS',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"501029\\",\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","type":"json"}]',
],
'PushNoticeToAndroid' => [
'summary' => 'Sends a notification to Android devices. The notification appears directly in the device’s notification tray and may be delivered through Alibaba Cloud’s proprietary channel or the device manufacturer’s channel, depending on the scenario.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'Your AppKey.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => 'The target of the push. Valid values:'."\n"
."\n"
.'- **DEVICE**: Push to specific devices.'."\n"
."\n"
.'- **ACCOUNT**: Push to specific accounts.'."\n"
."\n"
.'- **ALIAS**: Push to users with specific aliases.'."\n"
."\n"
.'- **TAG**: Push to users with specific tags.'."\n"
."\n"
.'- **ALL**: Push to all devices.',
'type' => 'string',
'required' => true,
'enum' => ['ALL', 'DEVICE', 'ACCOUNT', 'ALIAS', 'TAG'],
'example' => 'ALL',
'title' => '',
],
],
[
'name' => 'TargetValue',
'in' => 'query',
'schema' => ['description' => 'Set this based on the Target value. Separate multiple values with commas. If you exceed the limit, send multiple requests.'."\n"
."\n"
.'- If Target=DEVICE, use values such as `deviceid111,deviceid1111`. Maximum: 1000 devices.'."\n"
."\n"
.'- If Target=ACCOUNT, use values such as `account111,account222`. Maximum: 1000 accounts.'."\n"
."\n"
.'- If Target=ALIAS, use values such as `alias111,alias222`. Maximum: 1000 aliases.'."\n"
."\n"
.'- If Target=TAG, support single or multiple tags. For format details, see [Tag format](~~434847~~).'."\n"
."\n"
.'- If Target=ALL, set this to **ALL**.', 'type' => 'string', 'required' => true, 'example' => 'ALL', 'title' => ''],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => ['description' => 'The title of the notification.', 'type' => 'string', 'required' => true, 'example' => 'title', 'title' => ''],
],
[
'name' => 'Body',
'in' => 'query',
'schema' => ['description' => 'The body of the notification.', 'type' => 'string', 'required' => true, 'example' => 'body', 'title' => ''],
],
[
'name' => 'StoreOffline',
'in' => 'query',
'schema' => ['description' => 'Whether to store the notification for offline delivery. Default: false.'."\n"
."\n"
.'If enabled, the notification is redelivered when the user comes online within the time-to-live (TTL) period. Default TTL: 72 hours.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'JobKey',
'in' => 'query',
'schema' => ['description' => 'A custom ID for the push task. If you specify a non-empty JobKey, it appears in the delivery receipt log. For more information, see [Delivery receipt logs](~~434651~~).', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''],
],
[
'name' => 'ExtParameters',
'in' => 'query',
'schema' => ['description' => 'Custom key-value pairs for Android-specific extensions. Pass this as a JSON object.', 'type' => 'string', 'required' => false, 'example' => '{"key1":"value1","api_name":"PushNoticeToAndroidRequest"}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => ['description' => 'The message ID for this push request.', 'type' => 'string', 'example' => '501029', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Push Notification to Android Devices',
'description' => '**This operation is deprecated. Use the [Advanced Push API](~~2249916~~) instead. In that API, set the `DeviceType` parameter to `ANDROID` and the `PushType` parameter to `NOTICE`.**'."\n"
."\n"
.'**Before using this operation, review the [pricing and billing model](~~434638~~) for EMAS Mobile Push.**',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-10-12T07:14:53.000Z', 'description' => 'Request parameters changed, Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '60000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'PushNoticeToAndroid'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:PushNoticeToAndroid',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"501029\\",\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","type":"json"}]',
],
'PushNoticeToiOS' => [
'summary' => 'Send a notification to iOS devices. The notification uses Apple’s APNs channel and appears directly in the device notification center.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'Your AppKey.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '24780725', 'title' => ''],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => 'The target of the push. Valid values:'."\n"
."\n"
.'- **DEVICE**: Push to specific devices.'."\n"
."\n"
.'- **ACCOUNT**: Push to specific accounts.'."\n"
."\n"
.'- **ALIAS**: Push to users with specific aliases.'."\n"
."\n"
.'- **TAG**: Push to users with specific tags.'."\n"
."\n"
.'- **ALL**: Push to all devices.',
'type' => 'string',
'required' => true,
'enum' => ['ALL', 'DEVICE', 'ACCOUNT', 'ALIAS', 'TAG'],
'example' => 'ALL',
'title' => '',
],
],
[
'name' => 'TargetValue',
'in' => 'query',
'schema' => ['description' => 'Values depend on the Target value. Separate multiple values with commas. If you exceed the limit, send multiple requests.'."\n"
."\n"
.'- If Target=DEVICE, use values such as `deviceid111,deviceid1111`. Maximum: 1000.'."\n"
."\n"
.'- If Target=ACCOUNT, use values such as `account111,account222`. Maximum: 1000.'."\n"
."\n"
.'- If Target=ALIAS, use values such as `alias111,alias222`. Maximum: 1000.'."\n"
."\n"
.'- If Target=TAG, support single or multiple tags. For format details, see [Tag format](~~434847~~).'."\n"
."\n"
.'- If Target=ALL, set this to **ALL**.', 'type' => 'string', 'required' => true, 'example' => 'ALL', 'title' => ''],
],
[
'name' => 'ApnsEnv',
'in' => 'query',
'schema' => [
'description' => 'iOS notifications use Apple’s APNs service. Specify the environment.'."\n"
."\n"
.'- DEV: Development environment.'."\n"
."\n"
.'- PRODUCT: Production environment.',
'type' => 'string',
'required' => true,
'enum' => ['DEV', 'PRODUCT'],
'example' => 'DEV',
'title' => '',
],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => ['description' => 'The title of the notification.'."\n"
."\n"
.'- iOS 10 and later: Displays as the notification title.'."\n"
."\n"
.'- iOS 8.2 through iOS 9.x: Replaces the app name in the notification.', 'type' => 'string', 'required' => false, 'example' => 'title', 'title' => ''],
],
[
'name' => 'Body',
'in' => 'query',
'schema' => ['description' => 'The body text of the notification.', 'type' => 'string', 'required' => true, 'example' => 'Hello World', 'title' => ''],
],
[
'name' => 'JobKey',
'in' => 'query',
'schema' => ['description' => 'A custom ID for the push task. If you specify a JobKey, the delivery log includes this field. For more information, see [Delivery logs](~~434651~~).', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''],
],
[
'name' => 'ExtParameters',
'in' => 'query',
'schema' => ['description' => 'A custom key-value map for developer extensions.'."\n"
."\n"
.'> For iOS devices, pass this parameter as a JSON object. Otherwise, parsing fails.', 'type' => 'string', 'required' => false, 'example' => '{"k1":"ios","k2":"v2"}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => ['description' => 'The message ID for this push request.', 'type' => 'string', 'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '501029', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Push Notification to iOS Devices',
'description' => '**This operation is deprecated. Use the [Advanced Push API](~~2249916~~) instead. Set the `DeviceType` parameter to `iOS` and the `PushType` parameter to `NOTICE`.**'."\n"
."\n"
.'**Before you use this operation, review the [pricing and billing model](~~434638~~) for EMAS Mobile Push.**',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-01-22T14:27:51.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:51.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T14:27:51.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '60000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'PushNoticeToiOS'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:PushNoticeToiOS',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"RequestId\\": \\"501029\\"\\n}","type":"json"}]',
],
'PushV2' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeNodes' => ['FEATUREemasBNY9P0', 'FEATUREemasTZ8VEZ'],
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'AppKey value.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '****530646', 'title' => ''],
],
[
'name' => 'IdempotentToken',
'in' => 'query',
'schema' => ['description' => 'An idempotency token to prevent duplicate pushes caused by client-side retries. If you call this API with the same IdempotentToken within 15 minutes, only one push is sent. Subsequent calls return the result of the first successful push.'."\n"
."\n"
.'> - Format the token as a standard 36-character UUID (8-4-4-4-12). Valid characters are hexadecimal digits 0–9 and a–f. Case-insensitive.'."\n"
.'>'."\n"
.'> - This parameter prevents duplicates only from retries. It does not prevent duplicates from concurrent calls.', 'type' => 'string', 'maxLength' => 36, 'minLength' => 36, 'required' => false, 'example' => 'c8016d13-6e76-****-9bda-769383d11787', 'title' => ''],
],
[
'name' => 'PushTask',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'Push task definition.', 'required' => true, '$ref' => '#/components/schemas/PushTask', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => ['description' => 'ID of the push message.', 'type' => 'string', 'example' => '11747540****88320', 'title' => ''],
'RequestId' => ['description' => 'ID of the request.', 'type' => 'string', 'example' => '159E4422-6624-****-8943-DFD98D34858C', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidPeriod.ExceedDays', 'errorMessage' => 'The period between specified EndTime and StartTime exceeds %s days.', 'description' => ''],
['errorCode' => 'Invalid%s.Format', 'errorMessage' => 'The specified %s format is invalid.', 'description' => ''],
['errorCode' => 'AccountDisabled', 'errorMessage' => 'Your account is not enabled.', 'description' => ''],
['errorCode' => 'FileNotExist', 'errorMessage' => 'The specified file does not exist.', 'description' => ''],
['errorCode' => 'IncorrectPassword', 'errorMessage' => 'The password is incorrect.', 'description' => ''],
['errorCode' => 'NotApnsCertificate', 'errorMessage' => 'The Certificate is not an APNs certificate.', 'description' => ''],
['errorCode' => 'PermissionDenied', 'errorMessage' => 'The specified AppKey is not authorized.', 'description' => ''],
['errorCode' => 'SendSpeedNotSupported', 'errorMessage' => 'SendSpeed is not supported for specified Target.', 'description' => ''],
['errorCode' => 'SmsProfileConfigFailed', 'errorMessage' => 'Failed to configure SMS profile.', 'description' => ''],
['errorCode' => 'SmsProfileGetFailed', 'errorMessage' => 'Failed to get SMS profile.', 'description' => ''],
['errorCode' => 'SmsRoleAuthorizeFailed', 'errorMessage' => 'Failed to authorize SMS role.', 'description' => ''],
['errorCode' => 'SmsRoleUnauthorized', 'errorMessage' => 'The SMS role is unauthorized.', 'description' => ''],
['errorCode' => 'TagsNumberBeyondLimit', 'errorMessage' => 'The number of tags bound to this app exceeds the limit.', 'description' => ''],
['errorCode' => 'Invalid%s.LengthExceed', 'errorMessage' => 'The specified %s length cannot be greater than %s.', 'description' => ''],
['errorCode' => 'Invalid%s.BytesExceed', 'errorMessage' => 'The specified %s exceeds the %s bytes limit.', 'description' => ''],
['errorCode' => 'Invalid%s.Empty', 'errorMessage' => 'The specified %s cannot be empty.', 'description' => ''],
['errorCode' => 'Invalid.Parameter', 'errorMessage' => 'The specified parameter is invalid: %s.', 'description' => ''],
['errorCode' => 'TargetNotSupported', 'errorMessage' => 'Target is not supported for batch push.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.', 'description' => 'The request processing has failed due to some unknown error.'],
['errorCode' => 'Timeout', 'errorMessage' => 'The request processing is timeout.', 'description' => 'Request processing timed out.'],
],
],
'title' => 'Advanced Push',
'summary' => 'This is the advanced push API v2.',
'description' => '**Before using this API, review the [pricing and billing methods](~~434638~~) for EMAS Mobile Push.**'."\n"
."\n"
.'This API supports Android, iOS, and HarmonyOS. For each platform, pass its assigned AppKey.',
'requestParamsDescription' => 'For more information, see the [PushV2 API integration guide](https://help.aliyun.com/document_detail/2986583.html).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'PushV2'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:PushV2',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"11747540****88320\\",\\n \\"RequestId\\": \\"159E4422-6624-****-8943-DFD98D34858C\\"\\n}","type":"json"}]',
],
'QueryAliases' => [
'summary' => 'Query the list of aliases attached to a specified device.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'The AppKey value.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => 'The unique identifier for the device in Mobile Push. It is 32 characters long and contains only digits and lowercase letters.', 'type' => 'string', 'required' => true, 'example' => 'e2ba19de97604f55b165576****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '159E4422-6624-4750-8943-DFD98D34858C', 'title' => ''],
'AliasInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AliasInfo' => [
'description' => 'The list of aliases.',
'type' => 'array',
'items' => [
'properties' => [
'AliasName' => ['description' => 'The alias name.', 'type' => 'string', 'example' => 'test_alias1', 'title' => ''],
],
'type' => 'object',
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'type' => 'object',
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query alias',
'changeSet' => [
['createdAt' => '2024-01-25T04:05:39.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-25T04:05:39.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-25T04:05:39.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryAliases'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:QueryAliases',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"159E4422-6624-4750-8943-DFD98D34858C\\",\\n \\"AliasInfos\\": {\\n \\"AliasInfo\\": [\\n {\\n \\"AliasName\\": \\"test_alias1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'QueryDeviceInfo' => [
'summary' => 'Query details of a specified device.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'AppKey information.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23419851', 'title' => ''],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => 'The unique identity of the device in the push system. Query only one at a time.', 'type' => 'string', 'required' => true, 'example' => 'a64ae296f3b04a58a05b30c9****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '6EEF262B-EA7D-41DC-89B9-20F3D1E28194', 'title' => ''],
'DeviceInfo' => [
'description' => 'Device details.',
'type' => 'object',
'properties' => [
'Account' => ['description' => 'Account attached to the device.', 'type' => 'string', 'example' => 'test@aliyun.com', 'title' => ''],
'LastOnlineTime' => ['description' => 'Last online time.', 'type' => 'string', 'example' => '2018-03-27T02:19:40Z', 'title' => ''],
'PhoneNumber' => ['description' => 'Phone number.', 'type' => 'string', 'example' => '133********', 'title' => ''],
'PushEnabled' => ['description' => 'Is push feature enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'DeviceType' => ['description' => 'Device type.', 'type' => 'string', 'example' => 'iOS', 'title' => ''],
'DeviceId' => ['description' => 'Device ID.', 'type' => 'string', 'example' => 'a64ae296f3b04a58a05b30c95****', 'title' => ''],
'Online' => ['description' => 'Is online.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'Tags' => ['description' => 'Tags attached to the device.', 'type' => 'string', 'example' => 'test_tag,test_tag2', 'title' => ''],
'DeviceToken' => ['description' => 'Device token.', 'type' => 'string', 'example' => '5ecc7b4012aaa801b63******5543ccbda6b4930d09629e936e1ac4b762a7df', 'title' => ''],
'Alias' => ['description' => 'Alias attached to the device.', 'type' => 'string', 'example' => 'test_alias,test_alias2', 'title' => ''],
'Brand' => ['description' => 'Device brand.', 'type' => 'string', 'example' => 'HUAWEI', 'title' => ''],
'Model' => ['description' => 'Device model.', 'type' => 'string', 'example' => 'VOG-AL00', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query device details ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-09-26T08:23:22.000Z', 'description' => 'Response parameters changed, Error codes changed'],
['createdAt' => '2023-09-26T08:23:22.000Z', 'description' => 'Response parameters changed, Error codes changed'],
['createdAt' => '2023-09-26T08:23:22.000Z', 'description' => 'Response parameters changed, Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDeviceInfo'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:QueryDeviceInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EEF262B-EA7D-41DC-89B9-20F3D1E28194\\",\\n \\"DeviceInfo\\": {\\n \\"Account\\": \\"test@aliyun.com\\",\\n \\"LastOnlineTime\\": \\"2018-03-27T02:19:40Z\\",\\n \\"PhoneNumber\\": \\"133********\\",\\n \\"PushEnabled\\": true,\\n \\"DeviceType\\": \\"iOS\\",\\n \\"DeviceId\\": \\"a64ae296f3b04a58a05b30c95****\\",\\n \\"Online\\": false,\\n \\"Tags\\": \\"test_tag,test_tag2\\",\\n \\"DeviceToken\\": \\"5ecc7b4012aaa801b63******5543ccbda6b4930d09629e936e1ac4b762a7df\\",\\n \\"Alias\\": \\"test_alias,test_alias2\\",\\n \\"Brand\\": \\"HUAWEI\\",\\n \\"Model\\": \\"VOG-AL00\\"\\n }\\n}","type":"json"}]',
],
'QueryDeviceStat' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'AppKey information.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The start time of the query. The time format follows the ISO8601 standard and uses UTC time, in the format YYYY-MM-DDThh:mm:ssZ.'."\n"
."\n"
.'> The statistics start date is 00:00 UTC+8 on the start time\'s day.', 'type' => 'string', 'required' => true, 'example' => '2016-07-28T00:00:00Z', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end time of the query. The time format follows the ISO8601 standard and uses UTC time, in the format YYYY-MM-DDThh:mm:ssZ.'."\n"
."\n"
.'> The statistics end date is the end time\'s day.', 'type' => 'string', 'required' => true, 'example' => '2016-07-29T00:00:00Z', 'title' => ''],
],
[
'name' => 'DeviceType',
'in' => 'query',
'schema' => [
'description' => '><notice>'."\n"
."\n"
.'This parameter is only valid for early Android and iOS dual-platform application types. If your application is a dual-platform application, specify this parameter as iOS or ANDROID to query the number of devices for each type. By default, it queries ALL types.'."\n"
."\n"
.'></notice>'."\n"
."\n"
.'The device type. Valid values:'."\n"
."\n"
.'- **iOS**: iOS devices'."\n"
."\n"
.'- **ANDROID**: Android devices'."\n"
."\n"
.'- **ALL**: All device types',
'enumValueTitles' => ['ALL' => 'ALL', 'ANDROID' => 'ANDROID', 'iOS' => 'iOS'],
'type' => 'string',
'required' => false,
'enum' => ['iOS', 'ANDROID', 'ALL'],
'example' => 'iOS',
'title' => '',
],
],
[
'name' => 'QueryType',
'in' => 'query',
'schema' => [
'description' => 'Query new devices or historical cumulative devices. Valid values:'."\n"
."\n"
.'- **NEW**: New devices'."\n"
."\n"
.'- **TOTAL**: Cumulative devices',
'type' => 'string',
'required' => true,
'enum' => ['NEW', 'TOTAL'],
'example' => 'TOTAL',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC', 'title' => ''],
'AppDeviceStats' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AppDeviceStat' => [
'description' => 'An array of device statistics, AppDeviceStat.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Time' => ['description' => 'The end time. Use ISO 8601 format in UTC, such as YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'example' => '2016-07-28T16:00:00Z', 'title' => ''],
'DeviceType' => ['description' => 'Device type.', 'type' => 'string', 'example' => 'iOS', 'title' => ''],
'Count' => ['description' => 'Number of devices.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
],
'description' => 'The AppDeviceStat object for device statistics.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'New and Retained Devices',
'summary' => 'Queries device statistics by application dimension.',
'description' => '> Currently, this API supports only daily data. The daily dimension lets you query data for up to 31 days. Days are calculated based on UTC+8.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-07-10T08:12:34.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-01-25T04:05:37.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-25T04:05:37.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-25T04:05:37.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '6', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDeviceStat'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:QueryDeviceStat',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"AppDeviceStats\\": {\\n \\"AppDeviceStat\\": [\\n {\\n \\"Time\\": \\"2016-07-28T16:00:00Z\\",\\n \\"DeviceType\\": \\"iOS\\",\\n \\"Count\\": 100\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'QueryDevicesByAccount' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'AppKey information.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'Account',
'in' => 'query',
'schema' => ['description' => 'Account name. You can query only one account at a time.', 'type' => 'string', 'required' => true, 'example' => 'test_account', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'A8A24108-2AD0-4F6E-81C7-A8A24C2C2AD0', 'title' => ''],
'DeviceIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DeviceId' => [
'description' => 'List of device IDs.',
'type' => 'array',
'items' => ['description' => 'Device ID', 'type' => 'string', 'example' => 'f6e43770afb944a1a879b46130ZZ****', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'AccountLimitExceed', 'errorMessage' => 'The number of devices bound to the account exceeds 10000.', 'description' => 'The number of devices bound to the account exceeds 10000.'],
],
],
'title' => 'Query device list by account ',
'summary' => 'Retrieve the list of devices associated with an account using the account name.',
'changeSet' => [
['createdAt' => '2022-01-11T10:18:12.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDevicesByAccount'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:QueryDevicesByAccount',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A8A24108-2AD0-4F6E-81C7-A8A24C2C2AD0\\",\\n \\"DeviceIds\\": {\\n \\"DeviceId\\": [\\n \\"f6e43770afb944a1a879b46130ZZ****\\"\\n ]\\n }\\n}","type":"json"}]',
],
'QueryDevicesByAlias' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'AppKey information.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'Alias',
'in' => 'query',
'schema' => ['description' => 'The alias. You can query only one alias at a time.', 'type' => 'string', 'required' => true, 'example' => 'test_alias', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DeviceIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DeviceId' => [
'description' => 'List of device IDs.',
'type' => 'array',
'items' => ['description' => 'Device ID', 'type' => 'string', 'example' => 'f6e43770afb944a1a879b4613****', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '6A9FD644-35A5-40E4-89B0-2021CAEDC1B4', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query device list by alias',
'summary' => 'Query the list of devices by alias.',
'changeSet' => [
['createdAt' => '2024-01-25T04:05:37.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-25T04:05:37.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-25T04:05:37.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDevicesByAlias'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:QueryDevicesByAlias',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DeviceIds\\": {\\n \\"DeviceId\\": [\\n \\"f6e43770afb944a1a879b4613****\\"\\n ]\\n },\\n \\"RequestId\\": \\"6A9FD644-35A5-40E4-89B0-2021CAEDC1B4\\"\\n}","type":"json"}]',
],
'QueryPushRecords' => [
'summary' => 'You can query push records with pagination and basic filtering.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREemasIDMTIS'],
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'The AppKey of the application.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '333526247', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The start time for the query. Specify the time in UTC, using the ISO-8601 format `YYYY-MM-DDThh:mm:ssZ`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-09-15T02:05:24Z', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end time for the query. Specify the time in UTC, using the ISO-8601 format `YYYY-MM-DDThh:mm:ssZ`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-09-29T06:24:58Z', 'title' => ''],
],
[
'name' => 'PushType',
'in' => 'query',
'schema' => [
'description' => 'The push type. Valid values:'."\n"
."\n"
.'- **MESSAGE**: A message.'."\n"
."\n"
.'- **NOTICE**: A notification.'."\n"
."\n"
.'- **LIVE\\_ACTIVITY**: A Live Activity.',
'type' => 'string',
'required' => false,
'enum' => ['MESSAGE', 'NOTICE', 'LIVE_ACTIVITY'],
'example' => 'NOTICE',
'title' => '',
],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => 'The push target. Valid values:'."\n"
."\n"
.'- **DEVICE**: Push to devices.'."\n"
."\n"
.'- **ACCOUNT**: Push to accounts.'."\n"
."\n"
.'- **ALIAS**: Push to aliases.'."\n"
."\n"
.'- **TAG**: Push to tags.'."\n"
."\n"
.'- **ALL**: Push to all devices.'."\n"
."\n"
.'- **TBD**: Initializes a continuous push. The push target is specified in a subsequent call to the `ContinuouslyPush` API operation.',
'type' => 'string',
'required' => false,
'enum' => ['ACCOUNT', 'ALIAS', 'DEVICE', 'TAG', 'TBD', 'FILE', 'ALL'],
'example' => 'DEVICE',
'title' => '',
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'description' => 'The push source. Valid values:'."\n"
."\n"
.'- **API**: Pushes initiated via an OpenAPI call.'."\n"
."\n"
.'- **CONSOLE**: Pushes initiated from the Mobile Push console.'."\n"
."\n"
.'- **OpenAPIExplorer**: Pushes initiated from Alibaba Cloud OpenAPI Explorer.',
'type' => 'string',
'required' => false,
'enum' => ['CONSOLE', 'API', 'OpenAPIExplorer'],
'example' => 'API',
'title' => '',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => ['description' => 'The keyword used for the query. The search covers the `MessageId`, `Title`, and `Body` fields. For `Title` and `Body`, the system applies Chinese word segmentation and matches whole tokens instead of substrings.', 'type' => 'string', 'required' => false, 'example' => '统计数据测试通知805', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => 'FFPpkmhCPm*****************xjk=', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. Default: 20. Maximum: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '20', 'example' => '10', 'title' => ''],
],
[
'name' => 'Page',
'in' => 'query',
'schema' => ['description' => 'The page number to query. Default: 1. Maximum: 10,000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'default' => '1', 'example' => '8', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => 'Deprecated. This parameter is no longer used.', 'type' => 'string', 'example' => 'i91D***********kXIh/dVBEQ==', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B24B396-249D-55E4-8CA1-66C9B50BB734', 'title' => ''],
'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '193', 'title' => ''],
'Page' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''],
'PushInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PushInfo' => [
'description' => 'The details of a specific notification or message.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The status of the message. Valid values:'."\n"
."\n"
.'- **WAITING**: The push is waiting to be sent.'."\n"
."\n"
.'- **SENT**: The push has been sent.'."\n"
."\n"
.'- **CANCELED**: The push has been canceled.', 'type' => 'string', 'example' => 'SENT', 'title' => ''],
'MessageId' => ['description' => 'The message ID.', 'type' => 'string', 'example' => '510431', 'title' => ''],
'AppKey' => ['description' => 'The AppKey of the application.', 'type' => 'integer', 'format' => 'int64', 'example' => '333526247', 'title' => ''],
'DeviceType' => [
'description' => 'The device type. Valid values:'."\n"
."\n"
.'- **ALL**: All device types.'."\n"
."\n"
.'- **iOS**: iOS devices.'."\n"
."\n"
.'- **Android**: Android devices.',
'enumValueTitles' => ['ALL' => 'ALL', 'IOS' => 'iOS', 'ANDROID' => 'Android'],
'type' => 'string',
'example' => 'ANDROID',
'title' => '',
],
'PushType' => [
'description' => 'The push type. Valid values:'."\n"
."\n"
.'- **MESSAGE**: A message.'."\n"
."\n"
.'- **NOTICE**: A notification.',
'enumValueTitles' => ['MESSAGE' => 'MESSAGE', 'NOTICE' => 'NOTICE'],
'type' => 'string',
'example' => 'NOTICE',
'title' => '',
],
'Body' => ['description' => 'The push body.', 'type' => 'string', 'example' => 'abcd', 'title' => ''],
'Title' => ['description' => 'The push title.', 'type' => 'string', 'example' => 'sssss', 'title' => ''],
'Source' => [
'description' => 'The source of the push. Valid values:'."\n"
."\n"
.'- **API**: A push triggered by an OpenAPI call, including pushes from the OpenAPI console.'."\n"
."\n"
.'- **CONSOLE**: A push triggered from the Mobile Push console.',
'enumValueTitles' => ['CONSOLE' => 'CONSOLE', 'API' => 'API'],
'type' => 'string',
'example' => 'DEVICE',
'title' => '',
],
'PushTime' => ['description' => 'The UTC time when the push was sent, in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'example' => '2021-09-15T02:05:24Z', 'title' => ''],
'Target' => ['description' => 'The push target. Valid values:'."\n"
."\n"
.'- **ACCOUNT**: Push to a specified account.'."\n"
."\n"
.'- **ALIAS**: Push to a specified alias.'."\n"
."\n"
.'- **DEVICE**: Push to a specified device.'."\n"
."\n"
.'- **TAG**: Push to a specified tag.'."\n"
."\n"
.'- **ALL**: Push to all devices.'."\n"
."\n"
.'- **TBD**: Initializes a continuous push. The target is specified later by calling the `ContinuouslyPush` API operation.', 'type' => 'string', 'example' => 'DEVICE', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'AccountDisabled', 'errorMessage' => 'Your account is not enabled.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.', 'description' => 'The request processing has failed due to some unknown error.'],
['errorCode' => 'Timeout', 'errorMessage' => 'The request processing is timeout.', 'description' => 'Request processing timed out.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"i91D***********kXIh/dVBEQ==\\",\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"9B24B396-249D-55E4-8CA1-66C9B50BB734\\",\\n \\"Total\\": 193,\\n \\"Page\\": 11,\\n \\"PushInfos\\": {\\n \\"PushInfo\\": [\\n {\\n \\"Status\\": \\"SENT\\",\\n \\"MessageId\\": \\"510431\\",\\n \\"AppKey\\": 333526247,\\n \\"DeviceType\\": \\"ANDROID\\",\\n \\"PushType\\": \\"NOTICE\\",\\n \\"Body\\": \\"abcd\\",\\n \\"Title\\": \\"sssss\\",\\n \\"Source\\": \\"DEVICE\\",\\n \\"PushTime\\": \\"2021-09-15T02:05:24Z\\",\\n \\"Target\\": \\"DEVICE\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => 'Query Alert Delivery Records ',
'changeSet' => [
['createdAt' => '2024-05-13T08:11:37.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-01-25T04:05:36.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-12-27T12:34:38.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPushRecords'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'mpush:QueryPushRecords',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'QueryPushStatByApp' => [
'summary' => 'Query push statistics for an app.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'The AppKey value.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The start time of the query. Specify the time in ISO 8601 format, YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'example' => '2016-07-25T00:00:00Z', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end time of the query. Specify the time in ISO 8601 format, YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'example' => '2016-07-29T00:00:00Z', 'title' => ''],
],
[
'name' => 'Granularity',
'in' => 'query',
'schema' => [
'description' => 'The data granularity of the response. You can only query data for up to 31 days at daily granularity. Valid values:'."\n"
."\n"
.'- **DAY**: Query data at daily granularity.',
'type' => 'string',
'required' => true,
'enum' => ['DAY'],
'example' => 'DAY',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC', 'title' => ''],
'AppPushStats' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AppPushStat' => [
'description' => 'An array of AppPushStat objects. The API returns data based on the specified time granularity.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Time' => ['description' => 'The timestamp.', 'type' => 'string', 'example' => '2016-07-25T00:00:00Z', 'title' => ''],
'DeletedCount' => ['description' => 'The number of notifications cleared on devices.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'OpenedCount' => ['description' => 'The number of notifications clicked on devices.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
'SmsReceiveSuccessCount' => ['description' => 'The number of text messages successfully received in composite SMS push notifications. This value can be empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'SmsSkipCount' => ['description' => 'The number of text messages skipped in composite SMS push notifications. For example, this occurs when no phone number is bound to the device. This value can be empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'SmsReceiveFailedCount' => ['description' => 'The number of text messages sent but not received on mobile phones in composite SMS push notifications. This value can be empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'SmsFailedCount' => ['description' => 'The number of text messages that failed to send in composite SMS push notifications. Failures may occur due to service unavailability, authorization failure, or invalid parameters. This value can be empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'ReceivedCount' => ['description' => 'The number of notifications actually delivered to devices.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''],
'SentCount' => ['description' => 'The number of notifications actually sent from the push server.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'SmsSentCount' => ['description' => 'The number of text messages sent in composite SMS push notifications. This value can be empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'AcceptCount' => ['description' => 'The number of push notifications accepted by the push server.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'App dimension push statistics',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-01-25T04:05:36.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-25T04:05:36.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-25T04:05:36.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '6', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPushStatByApp'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:QueryPushStatByApp',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"AppPushStats\\": {\\n \\"AppPushStat\\": [\\n {\\n \\"Time\\": \\"2016-07-25T00:00:00Z\\",\\n \\"DeletedCount\\": 10,\\n \\"OpenedCount\\": 30,\\n \\"SmsReceiveSuccessCount\\": 0,\\n \\"SmsSkipCount\\": 0,\\n \\"SmsReceiveFailedCount\\": 0,\\n \\"SmsFailedCount\\": 0,\\n \\"ReceivedCount\\": 60,\\n \\"SentCount\\": 100,\\n \\"SmsSentCount\\": 0,\\n \\"AcceptCount\\": 120\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'QueryPushStatByMsg' => [
'summary' => 'Queries push statistics for a message.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'The AppKey.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'MessageId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the pushed message. This ID is returned after a message is pushed.'."\n"
."\n"
.'> Push data is available the next day. You cannot query data for the current day.',
'enumValueTitles' => [],
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '510427',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CF195C34-98FB-491A-98D7-19CBC1FA880B', 'title' => ''],
'PushStats' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PushStat' => [
'description' => 'An array of PushStat objects. Each object contains the push statistics for a message or notification.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'MessageId' => ['description' => 'The message ID.', 'type' => 'string', 'example' => '510427', 'title' => ''],
'DeletedCount' => ['description' => 'The number of times the notification was cleared on devices.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'OpenedCount' => ['description' => 'The number of times the notification was opened on devices.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
'SmsReceiveSuccessCount' => ['description' => '(Optional) The number of text messages successfully received in a composite push.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'SmsSkipCount' => ['description' => '(Optional) The number of text messages skipped in a composite push, for example, when no mobile number is bound.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'SmsReceiveFailedCount' => ['description' => '(Optional) The number of text messages that were sent in a composite push but were not received.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'SmsFailedCount' => ['description' => '(Optional) The number of text messages that failed to send in a composite push. This can happen if the service is not activated, authorization is denied, or parameters are invalid.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'ReceivedCount' => ['description' => 'The number of messages delivered to devices.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''],
'SentCount' => ['description' => 'The number of messages sent from the push server.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'SmsSentCount' => ['description' => '(Optional) The number of text messages sent in a composite push.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'AcceptCount' => ['description' => 'The number of pushes accepted by the push server.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Job Dimension Push Statistics',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-01-25T04:05:36.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-25T04:05:36.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-25T04:05:36.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPushStatByMsg'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:QueryPushStatByMsg',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CF195C34-98FB-491A-98D7-19CBC1FA880B\\",\\n \\"PushStats\\": {\\n \\"PushStat\\": [\\n {\\n \\"MessageId\\": \\"510427\\",\\n \\"DeletedCount\\": 10,\\n \\"OpenedCount\\": 30,\\n \\"SmsReceiveSuccessCount\\": 0,\\n \\"SmsSkipCount\\": 0,\\n \\"SmsReceiveFailedCount\\": 0,\\n \\"SmsFailedCount\\": 0,\\n \\"ReceivedCount\\": 60,\\n \\"SentCount\\": 100,\\n \\"SmsSentCount\\": 0,\\n \\"AcceptCount\\": 120\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'QueryTags' => [
'summary' => 'Queries tags for a specified object, such as a device, account, or alias.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'The AppKey value.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'ClientKey',
'in' => 'query',
'schema' => ['description' => 'The device, account, or alias. Query one ClientKey at a time.', 'type' => 'string', 'required' => true, 'example' => 'e2ba19de97604f55b165576****', 'title' => ''],
],
[
'name' => 'KeyType',
'in' => 'query',
'schema' => [
'description' => 'The type of the ClientKey.',
'enumValueTitles' => ['ACCOUNT' => 'Account', 'ALIAS' => 'Alias', 'DEVICE' => 'Device'],
'type' => 'string',
'required' => true,
'enum' => ['DEVICE', 'ACCOUNT', 'ALIAS'],
'example' => 'DEVICE',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D68AE5C6-8AAF-46C9-B627-3FDACD1A4168', 'title' => ''],
'TagInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagInfo' => [
'description' => 'The list of tags.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagName' => ['description' => 'The name of the attached tag.', 'type' => 'string', 'example' => 'test_tag2', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query Tag List',
'changeSet' => [
['createdAt' => '2024-01-25T04:05:36.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-25T04:05:36.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-25T04:05:36.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTags'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:QueryTags',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D68AE5C6-8AAF-46C9-B627-3FDACD1A4168\\",\\n \\"TagInfos\\": {\\n \\"TagInfo\\": [\\n {\\n \\"TagName\\": \\"test_tag2\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'QueryUniqueDeviceStat' => [
'summary' => 'Obtain deduplicated device statistics for an app.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'Your app key.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The start time of the query, in ISO 8601 format. Format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'example' => '2016-07-25T00:00:00Z', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end time of the query, in ISO 8601 format. Format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'example' => '2016-07-26T00:00:00Z', 'title' => ''],
],
[
'name' => 'Granularity',
'in' => 'query',
'schema' => [
'description' => 'The time granularity for the query. Valid values:'."\n"
."\n"
.'- DAY'."\n"
."\n"
.'- MONTH',
'type' => 'string',
'required' => true,
'enum' => ['DAY', 'MONTH'],
'example' => 'DAY',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC', 'title' => ''],
'AppDeviceStats' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AppDeviceStat' => [
'description' => 'An array of AppDeviceStat objects.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Time' => ['description' => 'The time slice.', 'type' => 'string', 'example' => '2016-07-25T00:00:00Z', 'title' => ''],
'Count' => ['description' => 'The number of deduplicated devices.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
],
'description' => 'An AppDeviceStat object.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Deduplicated Device Statistics ',
'description' => '> This operation returns data only at the daily granularity. You can query up to 31 days of data. Deduplicated device counts reset on the first day of each month.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-01-25T04:05:36.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-25T04:05:36.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-25T04:05:36.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '6', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryUniqueDeviceStat'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:QueryUniqueDeviceStat',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"AppDeviceStats\\": {\\n \\"AppDeviceStat\\": [\\n {\\n \\"Time\\": \\"2016-07-25T00:00:00Z\\",\\n \\"Count\\": 100\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'RemoveTag' => [
'summary' => 'Removes a tag from an app.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'The AppKey value.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'TagName',
'in' => 'query',
'schema' => ['description' => 'The name of the tag to remove. You can remove only one tag at a time. Maximum length: 128 characters.', 'type' => 'string', 'required' => true, 'example' => 'test_tag', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '23000F3C-0EFE-4C89-82EE-E04F42D37B3C', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Remove Tags',
'description' => 'Deleting a tag takes time. The time required depends on the number of tagged resources. Do not immediately recreate a tag with the same name after you delete it. Wait at least 5 minutes before you recreate a tag in the same app. If you delete multiple tags, wait at least 5 minutes for each deleted tag before you recreate them.',
'changeSet' => [
['createdAt' => '2024-01-24T14:41:24.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-24T14:41:24.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-24T14:41:24.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveTag'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'mpush:RemoveTag',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"23000F3C-0EFE-4C89-82EE-E04F42D37B3C\\"\\n}","type":"json"}]',
],
'UnbindAlias' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'The AppKey.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => 'The unique device identifier for push notifications. It is 32 characters long and consists of digits and lowercase letters.', 'type' => 'string', 'required' => true, 'example' => 'e2ba19de97604f55b16557673****', 'title' => ''],
],
[
'name' => 'AliasName',
'in' => 'query',
'schema' => ['description' => 'The alias to detach.'."\n"
."\n"
.'An alias supports up to 128 bytes (one Chinese character counts as 3 bytes). This field is required when UnbindAll is false. You can detach up to 10 aliases at once. Separate multiple aliases with commas.', 'type' => 'string', 'required' => false, 'example' => 'test_alias', 'title' => ''],
],
[
'name' => 'UnbindAll',
'in' => 'query',
'schema' => ['description' => 'Whether to detach all aliases. Default is false.'."\n"
."\n"
.'If true, detaches all aliases currently bound to the device. If false, detaches only the aliases specified in AliasName.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '159E4422-6624-4750-8943-DFD98D34858C', 'title' => ''],
],
'type' => 'object',
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Detach Alias ',
'summary' => 'Unbinds an alias. The change takes effect immediately.',
'changeSet' => [
['createdAt' => '2024-01-24T14:41:24.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-24T14:41:24.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-24T14:41:24.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindAlias'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'mpush:UnbindAlias',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"159E4422-6624-4750-8943-DFD98D34858C\\"\\n}","type":"json"}]',
],
'UnbindPhone' => [
'summary' => 'Unbind the mobile phone number from a specified device.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'AppKey information.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => 'The unique identity of the device. It is 32 characters long and consists of digits and lowercase letters.', 'type' => 'string', 'required' => true, 'example' => 'eb5f741d83d04d34807d229999eefa52', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0D1126F0-F8FF-513D-BAFA-F140447BDED4', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Detach Phone Number',
'changeSet' => [
['createdAt' => '2024-01-24T14:41:24.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-24T14:41:24.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-24T14:41:24.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindPhone'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'mpush:UnbindPhone',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0D1126F0-F8FF-513D-BAFA-F140447BDED4\\"\\n}","type":"json"}]',
],
'UnbindTag' => [
'summary' => 'Unbinds one or more tags from a specified target.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'The AppKey of your application.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23267207', 'title' => ''],
],
[
'name' => 'ClientKey',
'in' => 'query',
'schema' => ['description' => 'The ID of the device.', 'type' => 'string', 'required' => true, 'example' => 'e2ba19de97604f55b16557673****', 'title' => ''],
],
[
'name' => 'KeyType',
'in' => 'query',
'schema' => [
'description' => 'The type of the ClientKey. Valid value:'."\n"
."\n"
.'- **DEVICE**: The key is a device ID.',
'enumValueTitles' => [],
'type' => 'string',
'required' => true,
'enum' => ['DEVICE', 'ACCOUNT', 'ALIAS'],
'example' => 'DEVICE',
'title' => '',
],
],
[
'name' => 'TagName',
'in' => 'query',
'schema' => ['description' => 'Specifies the tag to unbind. To unbind multiple tags, separate them with commas. A maximum of 10 tags, each up to 128 characters long, can be unbound per request. The system supports a total of 10,000 tags.', 'type' => 'string', 'required' => true, 'example' => 'test_tag1,test_tag2', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '159E4422-6624-4750-8943-DFD98D34858C', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"159E4422-6624-4750-8943-DFD98D34858C\\"\\n}","type":"json"}]',
'title' => 'Detach Tag',
'changeSet' => [
['createdAt' => '2024-01-24T14:41:24.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-24T14:41:24.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-24T14:41:24.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindTag'],
],
'product' => ['code' => 'cps', 'title' => '移动推送'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'mpush:UnbindTag',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
],
'endpoints' => [
['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => 'cloudpush.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => 'cloudpush.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => 'cloudpush.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => 'cloudpush.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => 'cloudpush.vpc-proxy.aliyuncs.com'],
['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cloudpush.aliyuncs.com', 'endpoint' => 'cloudpush.aliyuncs.com', 'vpc' => ''],
],
'errorCodes' => [
['code' => 'AccountDisabled', 'message' => 'Your account is not enabled.', 'http_code' => 400, 'description' => ''],
['code' => 'AccountLimitExceed', 'message' => 'The number of devices bound to the account exceeds 10000.', 'http_code' => 400, 'description' => 'The number of devices bound to the account exceeds 10000.'],
['code' => 'AliasLimitExceed', 'message' => 'The number of aliases bound to the deviceId exceeds 128.', 'http_code' => 400, 'description' => 'The number of aliases bound to the deviceId exceeds 128.'],
['code' => 'AppNotConfigAndroid', 'message' => 'The PackageName of specified app is not configured.', 'http_code' => null, 'description' => ''],
['code' => 'AppTypeNotIos', 'message' => 'The AppType of specified AppKey is not iOS.', 'http_code' => 400, 'description' => ''],
['code' => 'CertificateExpired', 'message' => 'The certificate has expired.', 'http_code' => 400, 'description' => ''],
['code' => 'CertificateRevoked', 'message' => 'The certificate is revoked.', 'http_code' => 400, 'description' => ''],
['code' => 'CertModeNotMatch', 'message' => 'The Certificate does not match the specified environment.', 'http_code' => 400, 'description' => ''],
['code' => 'ChannelConfigNotConfigured', 'message' => 'The config of %s channel is not configured.', 'http_code' => 400, 'description' => 'The specified vendor channel information is not configured.'],
['code' => 'ChannelConfigNotEmpty', 'message' => 'The configuration of %s channel is not empty.', 'http_code' => 400, 'description' => ''],
['code' => 'ContinuousPushNotSupportDelay', 'message' => 'Continuous push does not support delay.', 'http_code' => 400, 'description' => ''],
['code' => 'DeviceLimitExceed', 'message' => 'The number of devices bound to the alias exceeds 128.', 'http_code' => 400, 'description' => 'The number of devices bound to the alias exceeds 128.'],
['code' => 'FileNotExist', 'message' => 'The specified file does not exist.', 'http_code' => 400, 'description' => ''],
['code' => 'IncorrectPassword', 'message' => 'The password is incorrect.', 'http_code' => 400, 'description' => ''],
['code' => 'InitialMessageNotExists', 'message' => 'The expected initialization message does not exist.', 'http_code' => 400, 'description' => ''],
['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.', 'http_code' => 500, 'description' => 'The request processing has failed due to some unknown error.'],
['code' => 'Invalid%s.BytesExceed', 'message' => 'The specified %s exceeds the %s bytes limit.', 'http_code' => 400, 'description' => ''],
['code' => 'Invalid%s.Duplicated', 'message' => 'The specified %s=%s is duplicated.', 'http_code' => 400, 'description' => ''],
['code' => 'Invalid%s.Empty', 'message' => 'The specified %s cannot be empty.', 'http_code' => 400, 'description' => ''],
['code' => 'Invalid%s.Format', 'message' => 'The specified %s format is invalid.', 'http_code' => 400, 'description' => ''],
['code' => 'Invalid%s.LengthExceed', 'message' => 'The specified %s length cannot be greater than %s.', 'http_code' => 400, 'description' => ''],
['code' => 'Invalid%s.NotFound', 'message' => 'The specified %s is not found.', 'http_code' => null, 'description' => ''],
['code' => 'Invalid%s.NotInRange', 'message' => 'The specified %s=%s is not in range.', 'http_code' => 400, 'description' => ''],
['code' => 'Invalid.Parameter', 'message' => 'The specified parameter is invalid: %s.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidAppKey.NotFound', 'message' => 'The specified AppKey is not found.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidCertificateFormat', 'message' => 'The format of the specified certificate is incorrect.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidEndTime.TooEarly', 'message' => 'The StartTime must be earlier than EndTime.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidExpireTime.TooEarly', 'message' => 'The specified ExpireTime cannot be before the current time plus three seconds.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidMessageStatus', 'message' => 'The message status is invalid for continuous pushing.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidParameterPushPeriodTooShort', 'message' => 'The period between specified ExpireTime and PushTime cannot be less than three seconds.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidPeriod.ExceedDays', 'message' => 'The period between specified EndTime and StartTime exceeds %s days.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidPeriod.ExceedMonth', 'message' => 'The period between specified EndTime and StartTime exceeds 31 days.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidPeriod.ExceedYear', 'message' => 'The period between specified EndTime and StartTime exceeds 366 days.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidStartTime.TooLate', 'message' => 'The StartTime cannot be later than the current time.', 'http_code' => 400, 'description' => ''],
['code' => 'NotApnsCertificate', 'message' => 'The Certificate is not an APNs certificate.', 'http_code' => 400, 'description' => ''],
['code' => 'PermissionDenied', 'message' => 'The specified AppKey is not authorized.', 'http_code' => null, 'description' => ''],
['code' => 'SendSpeedNotSupported', 'message' => 'SendSpeed is not supported for specified Target.', 'http_code' => 400, 'description' => ''],
['code' => 'SlrDeleteCheckFailed', 'message' => 'Check SLR for delete failed.', 'http_code' => 400, 'description' => ''],
['code' => 'SmsProfileConfigFailed', 'message' => 'Failed to configure SMS profile.', 'http_code' => 400, 'description' => ''],
['code' => 'SmsProfileGetFailed', 'message' => 'Failed to get SMS profile.', 'http_code' => 400, 'description' => ''],
['code' => 'SmsRoleAuthorizeFailed', 'message' => 'Failed to authorize SMS role.', 'http_code' => 400, 'description' => ''],
['code' => 'SmsRoleUnauthorized', 'message' => 'The SMS role is unauthorized.', 'http_code' => 400, 'description' => ''],
['code' => 'TagsNumberBeyondLimit', 'message' => 'The number of tags bound to this app exceeds the limit.', 'http_code' => 400, 'description' => ''],
['code' => 'TargetNotSupported', 'message' => 'Target is not supported for file push.', 'http_code' => 400, 'description' => ''],
['code' => 'TargetNotSupported', 'message' => 'Target is not supported for batch push.', 'http_code' => 400, 'description' => ''],
['code' => 'TargetNotSupported', 'message' => 'Target is not supported for iOS live activity.', 'http_code' => 400, 'description' => ''],
['code' => 'Timeout', 'message' => 'The request processing is timeout.', 'http_code' => 500, 'description' => 'Request processing timed out.'],
['code' => 'TraceInfoExpired', 'message' => 'The trace information of specified MessageId has expired.', 'http_code' => 400, 'description' => ''],
],
'changeSet' => [
[
'apis' => [
['description' => 'Error codes changed', 'api' => 'MassPush'],
['description' => 'Request parameters changed', 'api' => 'MassPush'],
['description' => 'Error codes changed', 'api' => 'Push'],
['description' => 'Request parameters changed', 'api' => 'Push'],
],
'createdAt' => '2025-11-25T08:17:24.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'MassPush'],
['description' => 'Request parameters changed', 'api' => 'Push'],
],
'createdAt' => '2024-10-10T01:26:55.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'MassPush'],
['description' => 'Request parameters changed', 'api' => 'Push'],
],
'createdAt' => '2024-08-07T05:34:23.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'QueryDeviceStat'],
],
'createdAt' => '2024-07-10T08:13:05.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'MassPush'],
['description' => 'Request parameters changed', 'api' => 'Push'],
],
'createdAt' => '2024-06-25T04:40:50.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'QueryPushRecords'],
],
'createdAt' => '2024-05-13T08:11:44.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Error codes changed', 'api' => 'BindPhone'],
['description' => 'Error codes changed', 'api' => 'QueryAliases'],
['description' => 'Error codes changed', 'api' => 'QueryDevicesByAlias'],
['description' => 'Error codes changed', 'api' => 'QueryDeviceStat'],
['description' => 'Error codes changed', 'api' => 'QueryPushRecords'],
['description' => 'Error codes changed', 'api' => 'QueryPushStatByApp'],
],
'createdAt' => '2024-01-25T04:05:48.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Error codes changed', 'api' => 'CheckDevices'],
['description' => 'Error codes changed', 'api' => 'ListTags'],
],
'createdAt' => '2024-01-24T15:21:59.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Error codes changed', 'api' => 'RemoveTag'],
['description' => 'Error codes changed', 'api' => 'UnbindAlias'],
['description' => 'Error codes changed', 'api' => 'UnbindPhone'],
['description' => 'Error codes changed', 'api' => 'UnbindTag'],
],
'createdAt' => '2024-01-24T14:41:33.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Error codes changed', 'api' => 'CancelPush'],
['description' => 'Error codes changed', 'api' => 'CompleteContinuouslyPush'],
['description' => 'Error codes changed', 'api' => 'ContinuouslyPush'],
['description' => 'Error codes changed', 'api' => 'MassPush'],
['description' => 'Error codes changed', 'api' => 'Push'],
['description' => 'Error codes changed', 'api' => 'PushMessageToAndroid'],
['description' => 'Error codes changed', 'api' => 'PushNoticeToiOS'],
],
'createdAt' => '2024-01-22T14:28:03.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'MassPush'],
['description' => 'Request parameters changed', 'api' => 'Push'],
],
'createdAt' => '2023-12-18T11:18:44.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'MassPush'],
['description' => 'Request parameters changed', 'api' => 'Push'],
['description' => 'Request parameters changed, Error codes changed', 'api' => 'PushMessageToAndroid'],
['description' => 'Request parameters changed, Error codes changed', 'api' => 'PushMessageToiOS'],
['description' => 'Request parameters changed, Error codes changed', 'api' => 'PushNoticeToAndroid'],
],
'createdAt' => '2023-10-12T07:15:03.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed, Error codes changed', 'api' => 'QueryDeviceInfo'],
],
'createdAt' => '2023-09-26T08:23:28.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'MassPush'],
['description' => 'Request parameters changed', 'api' => 'Push'],
],
'createdAt' => '2023-03-24T08:22:06.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'MassPush'],
['description' => 'Request parameters changed', 'api' => 'Push'],
],
'createdAt' => '2022-06-07T11:37:48.000Z',
'description' => 'fix: 修复AndroidNotificationNotifyId取值范围问题',
],
[
'apis' => [
['description' => 'Error codes changed', 'api' => 'CheckDevice'],
],
'createdAt' => '2022-03-31T09:28:25.000Z',
'description' => '修改CheckDevice为废弃,QueryDeviceCount为私有。',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'MassPush'],
['description' => 'Request parameters changed', 'api' => 'Push'],
],
'createdAt' => '2022-03-30T09:07:12.000Z',
'description' => '在Push、MassPushAPI中,增加对Trim、AndroidVivoPushMode、iOSInterruptionLevel、iOSRelevanceScore参数的支持。',
],
[
'apis' => [
['description' => 'Error codes changed', 'api' => 'QueryDevicesByAccount'],
],
'createdAt' => '2022-01-11T10:18:37.000Z',
'description' => '完善错误码',
],
[
'apis' => [
['description' => 'Error codes changed', 'api' => 'BindAlias'],
['description' => 'Error codes changed', 'api' => 'BindTag'],
['description' => 'Error codes changed', 'api' => 'QueryPushRecords'],
],
'createdAt' => '2021-12-28T04:36:06.000Z',
'description' => '错误码文档更新',
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '6', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDeviceStat'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindTag'],
['threshold' => '6', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPushStatByApp'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckCertificate'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckDevice'],
['threshold' => '1000000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'Push'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDevicesByAlias'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTags'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindAlias'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MassPush'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDeviceInfo'],
['threshold' => '10000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CompleteContinuouslyPush'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPushStatByMsg'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryAliases'],
['threshold' => '6', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryUniqueDeviceStat'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSummaryApps'],
['threshold' => '60000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'PushMessageToAndroid'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MassPushV2'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDevicesByAccount'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindAlias'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindPhone'],
['threshold' => '60000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'PushNoticeToiOS'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckDevices'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelPush'],
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveTag'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTags'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindTag'],
['threshold' => '60000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'PushMessageToiOS'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindPhone'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ContinuouslyPush'],
['threshold' => '60000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'PushNoticeToAndroid'],
['threshold' => '1000000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'PushV2'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPushRecords'],
],
'product' => ['code' => 'cps', 'title' => 'Push'],
],
'ram' => [
'productCode' => 'Push',
'productName' => 'Enterprise Mobile Application Studio',
'ramCodes' => ['mpush', 'mhub'],
'ramLevel' => 'OPERATION',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'RemoveTag',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'mpush:RemoveTag',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ContinuouslyPush',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:ContinuouslyPush',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryPushStatByMsg',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:QueryPushStatByMsg',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CheckDevices',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:CheckDevices',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'PushMessageToiOS',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:PushMessageToiOS',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'PushNoticeToiOS',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:PushNoticeToiOS',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'BindAlias',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'mpush:BindAlias',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryDeviceInfo',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:QueryDeviceInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryDeviceStat',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:QueryDeviceStat',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'PushV2',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:PushV2',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryPushStatByApp',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:QueryPushStatByApp',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'BindPhone',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'mpush:BindPhone',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryTags',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:QueryTags',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'BindTag',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'mpush:BindTag',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'Push',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:Push',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UnbindAlias',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'mpush:UnbindAlias',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTags',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'mpush:ListTags',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CheckCertificate',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:CheckCertificate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListSummaryApps',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'mpush:ListSummaryApps',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryUniqueDeviceStat',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:QueryUniqueDeviceStat',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'PushNoticeToAndroid',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:PushNoticeToAndroid',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CompleteContinuouslyPush',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'mpush:CompleteContinuouslyPush',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'MassPushV2',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:MassPushV2',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CheckDevice',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:CheckDevice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryAliases',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:QueryAliases',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'MassPush',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:MassPush',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryPushRecords',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'mpush:QueryPushRecords',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UnbindPhone',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'mpush:UnbindPhone',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UnbindTag',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'mpush:UnbindTag',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'PushMessageToAndroid',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:PushMessageToAndroid',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryDevicesByAccount',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:QueryDevicesByAccount',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryDevicesByAlias',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'mpush:QueryDevicesByAlias',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CancelPush',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'mpush:CancelPush',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Push', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [],
],
];
|