1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
|
<?php return [
'version' => '1.0',
'info' => [
'style' => 'RPC',
'product' => 'Push',
'version' => '2016-08-01',
],
'directories' => [
[
'id' => 165111,
'title' => '推送相关接口',
'type' => 'directory',
'children' => [
'Push',
'MassPush',
'ContinuouslyPush',
'CompleteContinuouslyPush',
'CancelPush',
'PushV2',
'MassPushV2',
],
],
[
'id' => 165112,
'title' => '查询相关接口',
'type' => 'directory',
'children' => [
'CheckCertificate',
'QueryPushRecords',
'QueryDeviceStat',
'QueryUniqueDeviceStat',
'QueryDeviceInfo',
'QueryPushStatByApp',
'QueryPushStatByMsg',
'CheckDevices',
],
],
[
'id' => 95678,
'title' => '标签相关接口',
'type' => 'directory',
'children' => [
'BindTag',
'UnbindTag',
'RemoveTag',
'QueryTags',
'ListTags',
],
],
[
'id' => 165138,
'title' => '别名相关接口',
'type' => 'directory',
'children' => [
'BindAlias',
'UnbindAlias',
'QueryAliases',
'QueryDevicesByAlias',
],
],
[
'id' => 95697,
'title' => '账号相关接口',
'type' => 'directory',
'children' => [
'QueryDevicesByAccount',
],
],
[
'id' => 95671,
'title' => '其他接口',
'type' => 'directory',
'children' => [
'BindPhone',
'UnbindPhone',
],
],
[
'id' => 200051,
'title' => '后续下线接口(不建议使用)',
'type' => 'directory',
'children' => [
'PushMessageToiOS',
'PushNoticeToiOS',
'PushNoticeToAndroid',
'PushMessageToAndroid',
'CheckDevice',
'ListSummaryApps',
],
],
],
'components' => [
'schemas' => [
'PushTask' => [
'description' => '推送任务对象',
'type' => 'object',
'properties' => [
'Action' => [
'description' => '推送方式。可选参数,默认为 `PUSH_IMMEDIATELY`(立即推送)。'."\n"
."\n"
.'><notice>'."\n"
."\n"
.'批量推送接口 `CreateMassPushTask` 仅支持以下推送方式:'."\n"
."\n"
.'- `PUSH_IMMEDIATELY`(立即推送)'."\n"
.'- `SCHEDULED_PUSH`(定时推送)'."\n"
."\n"
.'></notice>',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'SCHEDULED_PUSH' => '定时推送',
'CREATE_CONTINUOUS_PUSH' => '创建持续推送任务',
'PUSH_IMMEDIATELY' => '立即推送',
'CONTINUOUS_PUSH' => '持续推送',
],
'example' => 'PUSH_IMMEDIATELY',
'enum' => [
'PUSH_IMMEDIATELY',
'SCHEDULED_PUSH',
'CREATE_CONTINUOUS_PUSH',
'CONTINUOUS_PUSH',
],
],
'Target' => [
'description' => '指定消息推送的目标对象。当操作类型`Action`为`CREATE_CONTINUOUS_PUSH`(创建连续推送任务)时,此参数为可选。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '推送目标类型。'."\n"
."\n"
.'><notice>'."\n"
."\n"
.'批量推送接口 `CreateMassPushTask` 和 持续推送 `CONTINUOUS_PUSH` 仅支持以下三种目标类型:'."\n"
."\n"
.'- `DEVICE`(设备)'."\n"
.'- `ACCOUNT`(账号)'."\n"
.'- `ALIAS`(别名)'."\n"
."\n"
.'></notice>',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'ALL' => '全推',
'ACCOUNT' => '账户',
'ALIAS' => '别名',
'DEVICE' => '设备',
'TAG' => '标签',
],
'example' => 'DEVICE',
'enum' => [
'DEVICE',
'TAG',
'ALIAS',
'ACCOUNT',
'ALL',
'FILE',
],
],
'Value' => [
'description' => '根据 `Target.Type` 设置推送目标,多个目标以逗号分隔。目标类型及目标值详细说明如下:'."\n"
."\n"
.'>* `DEVICE`:设备ID,如 deviceid1,deviceid2,最多1000个。'."\n"
.'>* `ACCOUNT`:账号ID,如 account1,account2,最多1000个。'."\n"
.'>* `ALIAS`:别名,如 alias1,alias2,最多1000个。'."\n"
.'>* `TAG`:支持单个或多个标签,格式参见[标签格式规范](https://help.aliyun.com/document_detail/434847.html)。'."\n"
.'>* `ALL`:全量推送,无需设置值,全推可能会导致费用增加,请您酌情使用。',
'type' => 'string',
'example' => 'value',
],
'Platform' => [
'description' => '平台类型,可选参数。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'ALL' => '双端设备,仅部分双端应用支持',
'HMOS' => '鸿蒙设备',
'ANDROID' => '安卓设备',
'IOS' => 'iOS设备',
],
'example' => 'IOS',
'enum' => [
'ANDROID',
'IOS',
'HMOS',
'ALL',
],
],
],
],
'Message' => [
'title' => '消息内容',
'description' => '发送给设备的透传消息数据。总长度不超过4000字节。'."\n"
."\n"
.'> 长度计算说明'."\n"
.'> - 长度计算基于 Message 对象经过 JSON 序列化后,使用 UTF-8 编码的字符串字节长度。'."\n"
.'> - 中文字符在 UTF-8 编码下通常占用 3 个字节',
'type' => 'object',
'properties' => [
'Title' => [
'description' => '发送的消息标题。',
'type' => 'string',
'example' => 'title',
],
'Body' => [
'description' => '发送的消息内容。',
'type' => 'string',
'required' => false,
'example' => '{"key": "value"}',
],
],
],
'Notification' => [
'description' => '发送给设备的厂商通知数据。'."\n"
."\n"
.'><notice>'."\n"
."\n"
.'当同时设置了 `Message` 和 `Notification` 时,设备只会收到一个,发送规则如下:'."\n"
."\n"
.'- 当设备在线,透传消息数据;'."\n"
.'- 当设备离线,发送系统通知;'."\n"
."\n"
.'></notice>',
'type' => 'object',
'properties' => [
'Title' => [
'description' => '推送的通知标题。'."\n"
."\n"
.'> 长度限制如下:'."\n"
.'> - iOS/Harmony 限制**字节长度**不超过200'."\n"
.'> - Android 限制**字符长度**不超过50',
'type' => 'string',
'enumValueTitles' => [],
'example' => '您有一条新消息',
],
'Body' => [
'description' => '推送的通知内容。'."\n"
."\n"
.'> 长度限制如下:'."\n"
.'> - iOS/Harmony/Android 限制**字符长度**不超过200',
'type' => 'string',
'example' => '尊敬的客户,您好!您的预约订单已取消成功。 ',
],
'Ios' => [
'description' => 'iOS通知配置',
'type' => 'object',
'properties' => [
'Subtitle' => [
'description' => 'iOS 通知副标题内容。',
'type' => 'string',
'example' => '请查收订单。',
],
'Music' => [
'description' => 'iOS 通知声音。指定存放在 app bundle 或沙盒 Library/Sounds 目录下的音频文件名,请参见:[ iOS 推送如何设定通知声音](https://help.aliyun.com/document_detail/48906.html)。'."\n"
."\n"
.'> - 若指定为空串(””),通知为静音'."\n"
.'> - 若不设置,默认填充 default 为系统提示音',
'type' => 'string',
'example' => 'default',
],
'Badge' => [
'description' => 'iOS 应用角标。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'BadgeAutoIncrement' => [
'description' => '是否开启角标自增功能,可选参数,默认为 false。'."\n"
."\n"
.'> - 不可和角标设定参数一起使用'."\n"
.'> - 角标自增功能由阿里云推送服务器维护每个设备的角标计数,需使用 1.9.5 以上版本的 SDK,通过SDK主动同步角标数字到服务端',
'type' => 'boolean',
'example' => 'false',
],
'Silent' => [
'description' => '控制是否启用静默推送模式。'."\n"
."\n"
.'> - 发送静默通知,可不填 `title` 和 `body` 参数',
'type' => 'boolean',
'example' => 'false',
],
'Mutable' => [
'description' => '启用扩展通知,控制iOS通知是否支持Notification Service Extension处理。'."\n"
.'> - 当发送静默通知时,必须设置为true'."\n"
.'> - Extension处理时间不能超过30秒'."\n"
.'> - 超时会导致通知显示原始内容'."\n"
.'> - 需要在应用中添加Notification Service Extension',
'type' => 'boolean',
'example' => 'true',
],
'Category' => [
'description' => '指定 iOS 通知的类别标识符,用于定义通知的交互行为和展示样式。'."\n"
."\n"
.'> - Category 需要在 App 中预先注册才能生效。'."\n"
.'> - 不同的 Category 可以定义不同的操作集合。',
'type' => 'string',
'example' => 'MESSAGE_REPLY',
],
'CollapseId' => [
'description' => '用于控制通知合并的唯一标识符,相同标识的通知将被覆盖显示。',
'type' => 'string',
'example' => 'order_status_update_12345',
],
'ThreadId' => [
'description' => 'iOS通知分组的线程标识符,用于将相关通知归类折叠显示。'."\n"
."\n"
.'> - 相同thread-id的通知会自动分组显示'."\n"
.'> - 多条相关通知折叠为一个通知组'."\n"
.'> - 用户可展开查看组内所有通知',
'type' => 'string',
'example' => 'news_category_tech',
],
'InterruptionLevel' => [
'description' => '中断级别,可选参数,枚举值如下:'."\n"
."\n"
.'- `passive`:系统在不点灯、不播放声音的情况下将通知添加到通知列表中。'."\n"
.'- `active`:系统立即显示通知,点亮屏幕,并可以播放声音。'."\n"
.'- `time-sensitive`:系统立即呈现通知,点亮屏幕,并可以播放声音,但不会突破系统通知控制。'."\n"
.'- `critical`:系统立即显示通知,屏幕亮起,并绕过静音开关播放声音。',
'type' => 'string',
'example' => 'active',
'enum' => [
'passive',
'active',
'time-sensitive',
'critical',
],
],
'RelevanceScore' => [
'description' => '通知消息的相关性评分,用于控制通知的优先级和展示策略。',
'type' => 'number',
'format' => 'double',
'example' => '0.5',
],
'ExtParameters' => [
'description' => 'iOS 通知的自定义扩展属性。'."\n"
."\n"
.'> - 参数必须以标准的JSON Map格式传入,格式错误将导致解析失败。',
'type' => 'string',
'example' => '{"attachment": "https://xxxx.xxx/notification_pic.png"} ',
],
'LiveActivity' => [
'description' => '灵动岛参数对象。'."\n"
."\n"
.'><notice>'."\n"
."\n"
.'- 灵动岛推送仅支持按照 `DEVICE` 类型**单台设备**进行推送'."\n"
.'- 推送灵动岛时,可不填 title 和 body 参数'."\n"
."\n"
.'></notice>',
'type' => 'object',
'properties' => [
'Id' => [
'description' => 'Live Activity的唯一标识符,用于关联设备端活动实例与服务端推送目标。'."\n"
."\n"
.'><notice>'."\n"
."\n"
.'- 该 `ID` 必须与客户端SDK中 `registerLiveActivityPushToken` 方法的 `forActivityId` 参数保持一致'."\n"
."\n"
.'- 服务端推送时使用此 `ID` 定位具体的活动实例'."\n"
."\n"
.'></notice>',
'type' => 'string',
'example' => 'FOOD_DELIVERY_ORD20231201001',
],
'Event' => [
'description' => '启动、更新、结束实时活动。',
'type' => 'string',
'required' => false,
'example' => 'start',
'enum' => [
'start',
'update',
'end',
],
],
'AttributesType' => [
'description' => '待启动的 Live Activity 类型。'."\n"
."\n"
.'> `Event` 为 start 时必填',
'type' => 'string',
'example' => 'OrderActivityAttributes',
],
'Attributes' => [
'description' => 'iOS灵动岛(Live Activities)推送的静态透传参数,用于传递不变的业务标识信息。'."\n"
."\n"
.'> `Event` 为 start 时必填',
'type' => 'string',
'example' => '{'."\n"
.' "orderId": "ORD20231201001",'."\n"
.' "restaurantName": "美味餐厅",'."\n"
.' "customerAddress": "xx区xx路xx号",'."\n"
.' "orderType": "delivery"'."\n"
.'}',
],
'ContentState' => [
'description' => '灵动岛活动的动态透传参数,包含可实时更新的状态信息和变化数据。'."\n"
."\n"
.'> - 避免过于频繁的更新(建议间隔≥5秒)'."\n"
.'> - 批量更新多个字段,减少推送次数'."\n"
.'> - 考虑用户体验,避免界面闪烁'."\n"
.'> - 有效的JSON字符串',
'type' => 'string',
'example' => '{'."\n"
.' "status": "delivering",'."\n"
.' "estimatedTime": "10分钟",'."\n"
.' "progress": 80,'."\n"
.' "driverName": "李师傅",'."\n"
.' "currentStep": "配送员正在路上"}'."\n"
.'}',
],
'DismissalDate' => [
'description' => '设定已结束的灵动岛活动在锁屏界面的保留时间,让用户在活动结束后仍可查看信息,秒级Unix时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1701439800',
],
'StaleDate' => [
'description' => '设定iOS灵动岛活动内容的过期时间戳,秒级Unix时间戳。'."\n"
."\n"
.'> - 到达指定时间后,系统会自动将活动标记为过期状态'."\n"
.'> - 过期的活动会从灵动岛和锁屏界面中移除'."\n"
.'> - 防止过时信息长期占用用户界面',
'type' => 'integer',
'format' => 'int64',
'example' => '1701425400',
],
],
],
'ApnsEnv' => [
'description' => 'iOS的通知是通过APNS中心来发送的,需要填写对应的环境信息。可选参数,默认是生产环境。'."\n"
."\n"
.'- DEV:开发环境,适用于 Xcode 直接安装调试的应用。'."\n"
.'- PRODUCT:生产环境,适用于 App Store、TestFlight、Ad Hoc 及企业分发的应用。',
'type' => 'string',
'enumValueTitles' => [
'DEV' => '开发环境',
'PRODUCT' => '生产环境',
],
'example' => 'DEV',
'enum' => [
'DEV',
'PRODUCT',
],
],
],
],
'Hmos' => [
'description' => '鸿蒙通知配置。',
'type' => 'object',
'properties' => [
'Category' => [
'description' => '通知消息类别,可选参数,默认是 `MARKETING` 类别。'."\n"
."\n"
.'> 完成申请通知消息自分类权益后,用于标识消息类型,不同的通知消息类型影响消息展示和提醒方式。详情参见鸿蒙官网 [Notification.category](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section17371529101117)',
'type' => 'string',
'enumValueTitles' => [
'TRAVEL' => '出行',
'IM' => '即时聊天',
'VOIP' => '音视频通话',
'SUBSCRIPTION' => '订阅',
'MARKETING' => '新闻、内容推荐、社交动态、产品促销、财经动态、生活资讯、调研、功能推荐、运营活动(仅对内容进行标识,不会加快消息发送),统称为资讯营销类消息',
'CUSTOMER_SERVICE' => '客服消息',
'ACCOUNT' => '账号动态',
'MAIL' => '邮件',
'FINANCE' => '财务',
'EXPRESS' => '订单&物流',
'WORK' => '工作事项提醒',
'HEALTH' => '健康',
'DEVICE_REMINDER' => '设备提醒',
],
'example' => 'IM',
'enum' => [
'IM',
'VOIP',
'SUBSCRIPTION',
'TRAVEL',
'HEALTH',
'WORK',
'ACCOUNT',
'EXPRESS',
'FINANCE',
'DEVICE_REMINDER',
'MAIL',
'CUSTOMER_SERVICE',
'MARKETING',
],
],
'SlotType' => [
'description' => '使用指定类型的通知渠道。'."\n"
."\n"
.'> - 仅对阿里云自有通道有效。'."\n"
.'> - 详情参见鸿蒙官网 [SlotType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/js-apis-notificationmanager-V5#slottype)',
'type' => 'string',
'enumValueTitles' => [
'CONTENT_INFORMATION' => '内容资讯',
'UNKNOWN_TYPE' => '未知类型',
'LIVE_VIEW' => '实况窗',
'SOCIAL_COMMUNICATION' => '社交通信',
'CUSTOMER_SERVICE' => '客服消息。该类型用于用户与商家之间的客服消息,需由用户主动发起。',
'OTHER_TYPES' => '其他',
'SERVICE_INFORMATION' => '服务提醒',
],
'example' => 'SOCIAL_COMMUNICATION',
'enum' => [
'SOCIAL_COMMUNICATION',
'SERVICE_INFORMATION',
'CONTENT_INFORMATION',
'CUSTOMER_SERVICE',
'OTHER_TYPES',
'UNKNOWN_TYPE',
'LIVE_VIEW',
],
],
'NotifyId' => [
'description' => '指定每条消息在通知栏显示时的唯一标识(notifyId)。若未提供,推送服务将自动生成一个唯一标识。不同通知消息可使用相同的 notifyId,以实现新消息覆盖旧消息的功能。请参考鸿蒙官网 [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',
],
'Action' => [
'description' => '指定应用内页面的 ability 对应的 action。'."\n"
."\n"
.'> 详情请参考鸿蒙官网 [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',
],
'Uri' => [
'description' => '应用内置页面 ability 对应的 uri。'."\n"
."\n"
.'> - 当存在多个 Ability 时,分别填写不同 Ability 的 action 和 uri,优先使用 action 查找对应的应用内置页面。'."\n"
.'> - 详情参见鸿蒙官网 [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',
],
'RenderStyle' => [
'description' => '通知消息样式,可选参数,默认是普通通知。',
'type' => 'string',
'enumValueTitles' => [
'NORMAL' => '普通通知(默认值)',
'MULTI_LINE' => '多行文本样式',
],
'example' => 'NORMAL',
'enum' => [
'NORMAL',
'MULTI_LINE',
],
],
'ImageUrl' => [
'description' => '通知右侧大图标 URL,URL 使用的协议必须是 HTTPS 协议。'."\n"
."\n"
.'> - 支持图片格式为 png、jpg、jpeg、heif、gif、bmp,图片长*宽<25000 像素。'."\n"
.'> - 详情参见鸿蒙官网 [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',
],
'InboxContent' => [
'description' => '当 `RenderStyle` 为 `MULTI_LINE` 时,需填写此字段,用于定义多行文本样式的内容。最多支持3条内容。',
'type' => 'array',
'items' => [
'description' => '文本。',
'type' => 'string',
'example' => '1. 您有一个事项待处理',
],
],
'ExtParameters' => [
'description' => '设定通知消息的自定义扩展属性,用于传递额外的业务数据。'."\n"
."\n"
.'> 参数必须以标准的JSON Map 格式传入,格式错误将导致解析失败。',
'type' => 'string',
'example' => '{"key": "value"}',
],
'TestMessage' => [
'description' => '启用测试消息。'."\n"
."\n"
.'> - 详情参考鸿蒙推送参数 [TestMessage](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section418321011212)',
'type' => 'boolean',
'example' => 'true',
],
'ReceiptId' => [
'description' => '鸿蒙通道回执 ID,该回执 ID 可以在鸿蒙通道推送运营平台的回执参数配置中查看。'."\n"
."\n"
.'> - 如果在鸿蒙通道推送运营平台配置的默认回执配置是阿里云回执,则无需提供,如果不是,建议优先在阿里云 EMAS 移动推送控制台中配置鸿蒙通道默认回执 ID。'."\n"
.'> - 详情参见鸿蒙官网 [pushOptions.receiptId](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section418321011212)',
'type' => 'string',
'example' => 'RCPB***DFD5',
],
'ExtensionPush' => [
'description' => '启用鸿蒙通知扩展。'."\n"
."\n"
.'> - 通知扩展消息需要先在鸿蒙官网申请权限才能发送,相关内容请参考[鸿蒙文档](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/push-send-extend-noti-V5)发送通知扩展消息。'."\n"
.'> - 鸿蒙 SDK 1.2.0 版本开始支持。',
'type' => 'boolean',
'example' => 'false',
],
'ExtensionExtraData' => [
'description' => '通知扩展消息的额外数据。'."\n"
."\n"
.'> - 发送鸿蒙通知扩展消息时有效。'."\n"
.'> - 概念上等同鸿蒙通知扩展消息的 extraData 字段,具体定义参考鸿蒙 [ExtensionPayload](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section161192514234) 说明。'."\n"
.'> - 鸿蒙 SDK 1.2.0 版本开始支持。',
'type' => 'string',
'example' => 'text',
],
'BadgeSetNum' => [
'description' => '鸿蒙应用角标设置数字。'."\n"
."\n"
.'> - 参考鸿蒙角标 [setNum 字段](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section266310382145)说明。'."\n"
.'> - 鸿蒙 SDK 1.2.0 版本开始支持。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'BadgeAddNum' => [
'description' => '鸿蒙应用角标累加数字。'."\n"
."\n"
.'> - 鸿蒙 SDK 1.2.0 版本开始支持。'."\n"
.'> - 参考鸿蒙角标 [addNum 字段说明](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section266310382145)。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'LiveViewPayload' => [
'description' => '鸿蒙实况窗数据结构 [LiveViewPayload](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V13/push-scenariozed-api-request-param-V13#section66881469306) 的 JSON 字符串,开发接入请参考文档[HarmonyOS 实况窗推送指南](https://help.aliyun.com/document_detail/2982112.html)',
'type' => 'string',
'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' => '鸿蒙自定义铃声文件名',
'type' => 'string',
'example' => 'music.mp3',
],
'SoundDuration' => [
'title' => '自定义消息通知铃声时长,单位秒,范围 [1,60],铃声时长不足时将会循环播放',
'description' => '自定义消息通知铃声时长,单位秒,范围 [1,60],铃声时长不足时将会循环播放',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
],
],
'Android' => [
'description' => 'Android通知配置',
'type' => 'object',
'properties' => [
'VendorChannelActivity' => [
'description' => '指定点击通知后跳转的 Activity。'."\n"
."\n"
.'><warning>当使用安卓厂商通道时,必须填写该选项。></warning>',
'type' => 'string',
'example' => 'com.alibaba.cloudpushdemo.bizactivity',
],
'ChannelId' => [
'description' => '设置Android app 的 channelId,需要与厂商App中的 channelId 能对应上。'."\n"
."\n"
.'> - 因 OPPO 通知私信通道的 channel_id 与 app 的 channelId 相同,故 OPPO 通道推送时,channel_id 取此值。'."\n"
.'> - 华为、FCM、阿里云自有通道推送中,channel_id 取此值。'."\n"
.'> - 具体用途请参见常见问题: [Android 8.0 以上设备通知接收不到](https://help.aliyun.com/document_detail/67398.html)',
'type' => 'string',
'example' => '8.0up',
],
'RenderStyle' => [
'description' => '通知样式,取值为:'."\n"
."\n"
.'- `0`:标准模式(默认)'."\n"
.'- `1`:长文本模式(支持华为、荣耀、小米、OPPO、魅族、自有通道)'."\n"
.'- `2`:大图模式(支持自有通道)'."\n"
.'- `3`:列表模式(支持华为、荣耀、小米、OPPO、自有通道)',
'type' => 'string',
'example' => '0',
'enum' => [
'NORMAL',
'BIG_TEXT',
'BIG_PICTURE',
'MULTI_LINE',
],
],
'PictureUrl' => [
'description' => '大图模式下的图片 URL,当前支持:自有通道:安卓 SDK 3.6.0 及以上。',
'type' => 'string',
'example' => 'https://imag.example.com/image.png',
],
'ImageUrl' => [
'description' => '大图标 URL。 当前支持:'."\n"
."\n"
.'- `华为 EMUI`(仅长文本模式、Inbox 模式下适用)。'."\n"
.'- `荣耀 Magic UI`(仅长文本模式下适用)。'."\n"
.'- `自有通道`(安卓 SDK3.5.0 及以上)。',
'type' => 'string',
'example' => 'https://imag.example.com/image.png',
],
'InboxContent' => [
'description' => 'Inbox 模式下的正文,内容为合法的 JSON Array,且元素不超过 5 个。当前支持:'."\n"
."\n"
.'- 华为:EMUI9 及以上'."\n"
.'- 荣耀:Magic UI 4.0 及以上'."\n"
.'- 小米:MIUI10 及以上'."\n"
.'- OPPO:ColorOS 5.0 以上'."\n"
.'- 自有通道:安卓 SDK3.6.0 及以上',
'type' => 'array',
'items' => [
'description' => '正文',
'type' => 'string',
'example' => '1. 第一条待处理事项',
],
],
'NotifyId' => [
'description' => 'Android通知栏消息的唯一标识符,用于控制通知的覆盖和替换行为。相同NotifyId的新通知会自动覆盖旧通知。'."\n"
."\n"
.'> 支持:华为、小米、OPPO、Vivo、魅族等厂商通道(FCM除外)',
'type' => 'integer',
'format' => 'int32',
'example' => '233856727',
],
'GroupId' => [
'description' => '消息分组,同一组消息在通知栏里只显示最新一条和当前该组接受到的消息总数目,不会展示所有消息也无法展开。当前支持:'."\n"
."\n"
.'- 华为'."\n"
.'- 荣耀'."\n"
.'- 自有通道',
'type' => 'string',
'example' => 'group-1',
],
'ExtParameters' => [
'description' => 'Android 通知的自定义扩展属性。'."\n"
."\n"
.'> - 参数必须以标准的JSON Map格式传入,格式错误将导致解析失败。',
'type' => 'string',
'example' => '{"key1":"value1"}',
],
'Music' => [
'description' => '华为厂商通道通知声音。指定存放在客户端项目 `app/src/main/res/raw/` 目录下的音频文件名,不需要携带文件格式后缀名。若不设置,则使用默认铃声。',
'type' => 'string',
'example' => 'alicloud_notification_sound',
],
'BadgeSetNum' => [
'description' => '设置角标数字固定值,取值范围[1~99]。'."\n"
."\n"
.'> - 厂商通道推送仅华为、荣耀通道生效。 '."\n"
.'> - 阿里云自有通道推送时仅华为机型、荣耀机型与 vivo 机型上生效。',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
'BadgeAddNum' => [
'description' => '设置角标累加值,在原角标的基础上进行累加。'."\n"
."\n"
.'> - 支持`华为`和`荣耀` 通道。'."\n"
.'> - `BadgeAddNum` 与 `BadgeSetNum` 同时存在时,以后者为准。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'BadgeActivity' => [
'description' => '角标设置应用入口 Activity 的全类名。'."\n"
."\n"
.'> 仅华为/荣耀产商通道推送时有效',
'type' => 'string',
'example' => 'com.alibaba.cloudpushdemo.bizactivity',
],
'TestMessage' => [
'description' => '设置厂商通道通知类型:'."\n"
."\n"
.'- `false`:正式通知(默认)。'."\n"
.'- `true`:测试通知。'."\n"
."\n"
.'> 当前支持:华为通道、荣耀通道、vivo 通道、OPPO流体云。',
'type' => 'boolean',
'example' => 'false',
],
'Options' => [
'description' => '通道详细配置。',
'type' => 'object',
'properties' => [
'Accs' => [
'description' => '阿里云自有配置'."\n"
."\n"
.'> 仅走阿里云自有通道时有效',
'type' => 'object',
'properties' => [
'CustomStyle' => [
'description' => 'Android 自定义通知栏样式,取值:1-100。'."\n"
."\n"
.'> 需要客户端配置完成样式预设,参考文档[自定义通知样式接口](https://help.aliyun.com/document_detail/2834944.html)。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Priority' => [
'description' => 'Android 通知在通知栏展示时排列位置的优先级。可取值: -2,-1,0,1,2。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'ThreadId' => [
'description' => '消息分组,同一组消息在通知栏里折叠展示,可展开,不同组通知分开展示。'."\n"
."\n"
.'> 安卓 SDK3.9.2 及以上',
'type' => 'string',
'example' => 'order_ORD20231201001',
],
'OpenType' => [
'description' => '点击通知后动作。可取值:'."\n"
."\n"
.'- `APPLICATION`:打开应用(默认值)'."\n"
.'- `ACTIVITY`:打开指定页面 `OpenActivity`'."\n"
.'- `URL`:打开 URL'."\n"
.'- `NONE`:无跳转',
'type' => 'string',
'example' => 'APPLICATION',
'enum' => [
'APPLICATION',
'ACTIVITY',
'URL',
'NONE',
],
],
'OpenActivity' => [
'description' => '设定点击通知打开的 activity。当 `OpenType` 取值为 `ACTIVITY`时有效.',
'type' => 'string',
'example' => 'com.alibaba.cloudpushdemo.bizactivity',
],
'OpenUrl' => [
'description' => 'Android 收到推送后,点击通知打开对应的 url。当 `OpenType` 取值为 `URL` 时有效。',
'type' => 'string',
'example' => 'www.example.com',
],
'NotifyType' => [
'description' => '通知的提醒方式。可取值:'."\n"
."\n"
.'- `VIBRATE`:振动(默认值)'."\n"
.'- `SOUND`:声音'."\n"
.'- `BOTH`:声音和振动'."\n"
.'- `NONE`:静音',
'type' => 'string',
'example' => 'NONE',
'enum' => [
'VIBRATE',
'SOUND',
'BOTH',
'NONE',
],
],
],
],
'Huawei' => [
'description' => '华为配置',
'type' => 'object',
'properties' => [
'ReceiptId' => [
'description' => '华为通道回执 ID,该回执 ID 可以在华为通道推送运营平台的回执参数配置中查看。'."\n"
."\n"
.'> 如果在华为通道推送运营平台配置的默认回执配置是阿里云回执,则无需提供,如果不是,建议优先在阿里云 EMAS 移动推送控制台中配置华为通道默认回执 ID。',
'type' => 'string',
'example' => 'RCP4C123456',
],
'Category' => [
'description' => '作用一:完成[自分类权益](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835?#section3410731125514)申请后,用于标识消息类型,确定[消息提醒方式](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#ZH-CN_TOPIC_0000001149358835__p3850133955718),对特定类型消息加快发送,取值请参考华为推送官方文档的[消息分类标准](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#section1076611477914),填写文档表格中的“云端通知 category 取值”或“本地通知 category 取值”。'."\n"
."\n"
.'作用二:[申请特殊权限](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/faq-0000001050042183#section037425218509)后,用于标识高优先级透传场景,取值如下:'."\n"
."\n"
.'- `VOIP`:音视频通话'."\n"
.'- `PLAY_VOICE`:语音播报'."\n"
."\n"
.'> - 对于“云端通知 category 取值”为“不涉及”的一概走阿里云自有通道'."\n"
.'> - 对于“本地通知 category 取值”为“不涉及”的一概走华为通道',
'type' => 'string',
'example' => 'VOIP',
],
'Urgency' => [
'description' => '华为通道透传消息投递优先级,取值如下:'."\n"
."\n"
.'- `HIGH`'."\n"
.'- `NORMAL`'."\n"
."\n"
.'需要申请权限,具体请参见:[申请链接](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/faq-0000001050042183#section037425218509)。',
'type' => 'string',
'example' => 'NORMAL',
'enum' => [
'HIGH',
'NORMAL',
],
],
'Importance' => [
'description' => '设置 Huawei 通知消息分类 importance 参数,决定用户设备消息通知行为,取值如下:'."\n"
."\n"
.'- `0`:资讯营销类消息'."\n"
.'- `1`:服务与通讯类消息'."\n"
."\n"
.'> 建议使用 `Category` 进行通知分类,需要在 Huawei 平台申请,[申请链接](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#section893184112272)。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
'enum' => [
'0',
'1',
],
],
'BusinessType' => [
'description' => '设置华为快通知参数'."\n"
.'- **0**:发送华为普通通知(默认)。'."\n"
.'- **1**:发送华为快通知。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'enum' => [
'0',
'1',
],
],
'LiveNotificationPayload' => [
'description' => '华为安卓实况窗数据结构 [LiveNotificationPayload](https://developer.huawei.com/consumer/cn/doc/HMSCore-References/rest-live-0000001562939968#ZH-CN_TOPIC_0000001700850537__p195121620102511) 的 JSON 字符串,开发接入请参考文档[华为实况窗推送指南](https://help.aliyun.com/document_detail/2983768.html)',
'type' => 'string',
'example' => '{'."\n"
.' "activityId": 1,'."\n"
.' "operation": 1,'."\n"
.' "event": "TAXI",'."\n"
.' "activityData": {'."\n"
.' "notificationData": {'."\n"
.' "type": 3'."\n"
.' }'."\n"
.' }'."\n"
.'}',
],
],
],
'Honor' => [
'description' => '荣耀配置',
'type' => 'object',
'properties' => [
'Importance' => [
'description' => '设置荣耀通知消息分类 importance 参数,决定用户设备消息通知行为,取值如下:'."\n"
."\n"
.'- `0`:资讯营销类消息'."\n"
.'- `1`:服务与通讯类消息'."\n"
."\n"
.'需要在荣耀平台申请,[申请链接](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',
],
],
],
],
'Xiaomi' => [
'description' => '小米配置',
'type' => 'object',
'properties' => [
'Channel' => [
'description' => '设置小米通知类型的 channelId,需要在小米平台申请,详见:[申请链接](https://dev.mi.com/console/doc/detail?pId=2422#_4)。'."\n"
."\n"
.'> 小米通道单个应用最多可申请 8 个 channel,请提前做好规划。',
'type' => 'string',
'example' => 'michannel',
],
],
],
'Vivo' => [
'description' => 'VIVO配置',
'type' => 'object',
'properties' => [
'Category' => [
'description' => 'vivo 将消息分为:系统消息、运营消息两个类别进行管理。 '."\n"
."\n"
.'**系统消息:**'."\n"
."\n"
.'- IM:即时消息'."\n"
.'- ACCOUNT:账号与资产'."\n"
.'- TODO:日程待办'."\n"
.'- DEVICE_REMINDER:设备信息'."\n"
.'- ORDER:订单与物流'."\n"
.'- SUBSCRIPTION:订阅提醒'."\n"
."\n"
.'**运营消息:**'."\n"
."\n"
.'- NEWS:新闻'."\n"
.'- CONTENT:内容推荐'."\n"
.'- MARKETING:运营活动'."\n"
.'- SOCIAL:社交动态'."\n"
."\n"
.'详细请参考[vivo分类说明](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',
],
],
'ReceiptId' => [
'description' => 'Vivo厂商推送通道的消息回执标识符,用于接收推送结果回调通知。'."\n"
."\n"
.'> - 查看位置:Vivo开放平台→ 推送服务 → 应用信息 → 回执配置'."\n"
.'> - 配置建议:优先在阿里云EMAS控制台配置默认回执ID'."\n"
.'> - 使用条件:仅当Vivo平台默认回执非阿里云回执时需要配置',
'type' => 'string',
'example' => '1232221',
],
'Importance' => [
'description' => '设置 vivo 通知消息分类,取值为:'."\n"
."\n"
.'- `0`:运营类消息(默认)'."\n"
.'- `1`:系统类消息'."\n"
."\n"
.'> 建议使用 `Category` 进行通知分类,需要在 vivo 平台申请,详见:[申请链接](https://dev.vivo.com.cn/documentCenter/doc/359)。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
'enum' => [
'0',
'1',
],
],
],
],
'Oppo' => [
'description' => 'OPPO配置',
'type' => 'object',
'properties' => [
'Category' => [
'description' => 'OPPO 将消息分类:通讯与服务、内容与营销两个类别进行管理。 '."\n"
."\n"
.'**通讯与服务(需申请权限):**'."\n"
."\n"
.'- IM:即时消息'."\n"
.'- ACCOUNT:账号与资产'."\n"
.'- TODO:日程待办'."\n"
.'- DEVICE_REMINDER:设备信息'."\n"
.'- ORDER:订单与物流'."\n"
.'- SUBSCRIPTION:订阅提醒'."\n"
."\n"
.'**内容与营销:**'."\n"
."\n"
.'- NEWS:新闻'."\n"
.'- CONTENT:内容推荐'."\n"
.'- MARKETING:运营活动'."\n"
.'- SOCIAL:社交动态'."\n"
."\n"
.'详细请参考[vivo分类说明](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',
],
],
'NotifyLevel' => [
'description' => 'OPPO 通道通知栏消息提醒等级。可取值为:'."\n"
."\n"
.'- `1`:通知栏'."\n"
.'- `2`:通知栏、锁屏、铃声、振动(通讯与服务类消息默认通知级别)'."\n"
.'- `16`:通知栏、锁屏、铃声、振动、横幅(需申请权限)'."\n"
."\n"
.'> 使用 `NotifyLevel` 参数时,必须同时传 `Category` 参数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
'enum' => [
'1',
'2',
'16',
],
],
'PrivateMsgTemplateId' => [
'description' => 'OPPO 私信模板 ID',
'type' => 'string',
'example' => '687557242b1634hzefs3d5013',
],
'PrivateTitleParameters' => [
'description' => 'OPPO 私信模版标题参数',
'type' => 'string',
'example' => '{"name": "张三"}',
],
'PrivateContentParameters' => [
'description' => 'OPPO 私信模版内容参数',
'type' => 'string',
'example' => '{'."\n"
.'"key1": "value1",'."\n"
.'"key2": "value2"'."\n"
.'}',
],
'IntelligentIntent' => [
'description' => 'OPPO流体云的意图共享数据结构[IntelligentIntent](https://open.oppomobile.com/documentation/page/info?id=13565)的JSON字符串,开发接入请参考文档[OPPO流体云推送指南](https://help.aliyun.com/document_detail/2997310.html)',
'type' => 'string',
'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' => 'OPPO流体云的意图删除数据结构[data](https://open.oppomobile.com/documentation/page/info?id=13578)的JSON字符串,当AndroidOppoIntelligentIntent参数已填写时此参数无效,开发接入请参考文档[OPPO流体云推送指南](https://help.aliyun.com/document_detail/2997310.html)',
'type' => 'string',
'example' => '{'."\n"
.' "intentName": "Example.Progress",'."\n"
.' "entityIds": ['."\n"
.' "A580202509130712"'."\n"
.' ],'."\n"
.' "serviceId": {'."\n"
.' "launcher": "999800001",'."\n"
.' "fluidCloud": "999900001"'."\n"
.' }'."\n"
.'}',
],
],
],
'Meizu' => [
'description' => '魅族配置',
'type' => 'object',
'properties' => [
'NoticeMsgType' => [
'description' => '魅族消息类型'."\n"
."\n"
.'- 0 公信消息(默认)'."\n"
.'- 1 私信消息',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
'enum' => [
'0',
'1',
],
],
],
],
],
],
],
],
],
],
'Options' => [
'description' => '推送选项',
'type' => 'object',
'properties' => [
'UseChannels' => [
'description' => '指定发送通道,取值如下:'."\n"
."\n"
.'- `accs` 阿里云自有通道'."\n"
.'- `huawei` 华为通道'."\n"
.'- `honor` 荣耀通道'."\n"
.'- `xiaomi` 小米通道'."\n"
.'- `oppo` OPPO 通道'."\n"
.'- `vivo` vivo 通道'."\n"
.'- `meizu` 魅族通道'."\n"
.'- `gcm` 谷歌 GCM 通道(旧版 HTTP)'."\n"
.'- `fcm` 谷歌 Firebase 通道(HTTP v1 API)'."\n"
.'- `apns` APNs 通道'."\n"
.'- `harmony` 鸿蒙通道'."\n"
."\n"
.'> - 如果未配置此参数,则代表所有通道均可使用。'."\n"
.'> - 如果配置了此参数,则严格使用参数中的通道。'."\n"
.'> - 如果配置的通道和发送策略冲突(如 iOS 通知仅走 APNs 通道,但本参数中不包含 apns),则不实施发送。'."\n"
.'> - 若配置 gcm,则可以走谷歌 GCM 和 FCM 通道,若配置 fcm,则只能走谷歌 FCM 通道。',
'type' => 'string',
'example' => 'accs,apns',
],
'PushTime' => [
'description' => '指定消息的发送时间,最晚不超过7天。仅当 `Action` 参数为 `SCHEDULED_PUSH` 时有效。'."\n"
."\n"
.'> 采用 ISO 8601 标准,使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ'."\n"
.'。',
'type' => 'string',
'example' => '2025-06-19T12:00:00Z',
],
'ExpireTime' => [
'description' => '设置消息的过期时间,过期后将不再发送,最长保存72小时。'."\n"
."\n"
.'> * 采用 ISO 8601 标准,使用 UTC 时间,格式为 YYYY-MM-DDThh:mm:ssZ。'."\n"
.'> * 过期时间需满足:ExpireTime > PushTime + 3秒(3秒为网络和系统延迟的冗余)。'."\n"
.'> * 建议:单推过期时间不低于1分钟,全推或批量推送不低于10分钟。'."\n"
."\n\n"
.'><notice>对于透传消息,不设置过期时间即代表只发在线,当设备不在线时,丢弃消息。></notice>',
'type' => 'string',
'example' => '2025-06-21T12:00:00Z',
],
'JobKey' => [
'description' => '推送任务自定义标识,当JobKey不为空时,回执日志中会附带该字段。查看回执日志参见[回执日志](https://help.aliyun.com/document_detail/434651.html)。',
'type' => 'string',
'example' => 'jobkey1727749697913',
],
'Trim' => [
'description' => '是否自动对过长标题、内容进行截断。'."\n"
."\n"
.'>仅支持明确限制标题、内容的厂商通道,对APNs、华为、荣耀通道等不限制标题、内容,只限制总请求体大小的不适用。',
'type' => 'boolean',
'example' => 'false',
],
'Sms' => [
'description' => '补发短信。'."\n"
."\n"
.'> 当前仅支持 `Android` 和 `HarmonyOS` 设备',
'type' => 'object',
'properties' => [
'TemplateName' => [
'description' => '短信模板名,可以在短信模板管理界面获取,是系统分配的名称,而非开发者设置的名称。',
'type' => 'string',
'example' => 'SMS_123456789',
],
'SignName' => [
'description' => '短信签名。',
'type' => 'string',
'example' => '某某科技',
],
'Params' => [
'description' => '短信模板的变量名键值对。',
'type' => 'string',
'example' => 'key1=value1&key2=value2',
],
'DelaySecs' => [
'description' => '触发短信的延迟时间,单位:秒。'."\n"
."\n"
.'若使用短信联动必须设置,推荐设置为 15 秒以上,最大不超过 3 天,避免短信和推送的重复。'."\n"
."\n"
.'> 短信联动时,ExpireTime 参数失效,通知失效时间以 DelaySecs 参数计算,失效时间为当前时间加上 DelaySecs 时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '150',
],
'SendPolicy' => [
'description' => '短信发送策略。',
'type' => 'string',
'enumValueTitles' => [
'PUSH_NOT_RECEIVED' => '推送未收到时触发',
'USER_NOT_OPENED' => '用户未打开时触发',
],
'example' => 'PUSH_NOT_RECEIVED',
'enum' => [
'PUSH_NOT_RECEIVED',
'USER_NOT_OPENED',
],
],
],
],
'MessageId' => [
'description' => '用于标识消息的唯一ID。仅当 `Action` 参数为 `CONTINUOUS_PUSH` 时有效。',
'type' => 'integer',
'format' => 'int64',
'example' => '1174754033128****',
],
],
],
],
],
],
],
'apis' => [
'Push' => [
'summary' => '高级推送接口,推送通知或者消息到不同设备端,本接口提供丰富的推送定制参数,以实现不同场景下的推送行为。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '23267207',
],
],
[
'name' => 'PushType',
'in' => 'query',
'schema' => [
'description' => '推送类型。取值:'."\n"
.'- **NOTICE**:表示通知。通知的特点是会走APNs、华为、小米、鸿蒙等厂商通道下发到设备端,并直接在设备通知栏弹出。当Android设备在线(App进程存活)时,它会优先走阿里云自有通道,由推送SDK构造通知并弹出,从而获得更好的推送性能,并在某些场景下能节省厂商推送消息额度。'."\n"
.'- **MESSAGE**:表示消息。消息的特点是会走阿里云自有在线通道下发,它不会默认在通知栏弹出,而是需要由App在进程活跃时接收并处理,由业务自行决定是否触发某些业务行为。设备离线(App进程不活跃)时,将无法及时接收到消息,此时可以通过下述的`iOSRemind`或`AndroidRemind`参数,在设备离线时将消息转为通知下发;或者设置下述的`StoreOffline`参数,在设备离线时,由推送系统保存该消息,等设备上线后再自动将消息下发。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'MESSAGE',
'enum' => [
'MESSAGE',
'NOTICE',
],
],
],
[
'name' => 'DeviceType',
'in' => 'query',
'schema' => [
'description' => '设备类型,取值范围为:'."\n"
."\n"
.'- **HARMONY**:鸿蒙设备'."\n"
.'- **iOS**:iOS设备'."\n"
.'- **ANDROID**:Android设备'."\n"
.'- **ALL**:当AppKey为旧版本双端应用时,代表同时推送Android和iOS设备;当AppKey为新版本单端应用时,效果和指定该应用类型对应的设备类型一样。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => [
'ALL' => 'ALL',
'ANDROID' => 'ANDROID',
'iOS' => 'iOS',
],
'example' => 'HARMONY',
'enum' => [
'iOS',
'ANDROID',
'ALL',
'HARMONY',
],
],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => '推送目标。可取值:'."\n"
."\n"
.'- **DEVICE**:根据设备推送。'."\n"
.'- **ACCOUNT**:根据账号推送。'."\n"
.'- **ALIAS**:根据别名推送。'."\n"
.'- **TAG**:根据标签推送。'."\n"
.'- **ALL**:推送给全部设备(同一种DeviceType的两次全推的间隔至少为1秒)。'."\n"
.' > 对iOS设备全推,会推送给24个月内活跃过但未卸载的设备,一旦APNs(苹果推送服务)接收到推送请求且未返回错误信息即为送达,导致活跃设备数暴增,从而产生大量费用,请您酌情使用。'."\n"
.'- **TBD**:初始化持续推送,推送目标由后续的[ContinuouslyPush](~~2249917~~)接口指定。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ALL',
'enum' => [
'ALL',
'DEVICE',
'ACCOUNT',
'ALIAS',
'TAG',
'TBD',
'FILE',
],
],
],
[
'name' => 'TargetValue',
'in' => 'query',
'schema' => [
'description' => '根据Target类型来设定,多个值使用逗号分隔,超过限制需要分多次推送。'."\n"
."\n"
.'- Target=DEVICE,值如`deviceid1,deviceid2`(最多支持1000个)。'."\n"
.'- Target=ACCOUNT,值如`account1,account2`(最多支持1000个)。'."\n"
.'- Target=ALIAS,值如`alias1,alias2`(最多支持1000个)。'."\n"
.'- Target=TAG,支持单Tag和多Tag,格式请参见[标签格式](~~434847~~)。'."\n"
.'- Target=ALL,值为**ALL**(全推固定参数组合)。'."\n"
.'- Target=TBD,值为**TBD**(持续推送固定参数组合)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ALL',
],
],
[
'name' => 'StoreOffline',
'in' => 'query',
'schema' => [
'description' => '离线消息、通知是否保存。StoreOffline默认设置为**false**。'."\n"
."\n"
.'若保存,在推送时候用户不在线,在过期时间(ExpireTime)内用户上线时会被再次发送。ExpireTime默认为72小时。iOS通知走APNs链路,不受StoreOffline影响。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'SendChannels',
'in' => 'query',
'schema' => [
'description' => '指定发送通道,取值如下:'."\n"
."\n"
.'- accs:阿里云自有通道'."\n"
.'- huawei:华为通道'."\n"
.'- honor:荣耀通道'."\n"
.'- xiaomi:小米通道'."\n"
.'- oppo:OPPO通道'."\n"
.'- vivo:vivo通道'."\n"
.'- meizu:魅族通道'."\n"
.'- gcm:谷歌GCM通道(旧版HTTP)'."\n"
.'- fcm: 谷歌Firebase通道(HTTP v1 API)'."\n"
.'- apns:APNs通道'."\n"
.'- harmony: 鸿蒙通道'."\n"
."\n"
.'>- 如果未配置此参数,则代表所有通道均可使用。'."\n"
.'>- 如果配置了此参数,则严格使用参数中的通道。'."\n"
.'>- 如果配置的通道和发送策略冲突(如iOS通知仅走APNs通道,但本参数中不包含apns),则不实施发送。'."\n"
.'>- 若配置gcm,则可以走谷歌GCM和FCM通道,若配置fcm,则只能走谷歌FCM通道。',
'type' => 'string',
'required' => false,
'example' => 'accs,huawei,xiaomi',
],
],
[
'name' => 'PushTime',
'in' => 'query',
'schema' => [
'description' => '用于定时发送。不设置缺省是立即发送。'."\n"
.'设置定时发送最迟不能晚于7天发送。'."\n"
."\n"
.'时间格式按照ISO8601标准表示,并需要使用UTC时间,格式为YYYY-MM-DDThh:mm:ssZ。'."\n"
.'>Target为TBD(持续推送)时,不支持定时设置。',
'type' => 'string',
'required' => false,
'example' => '2019-02-20T00:00:00Z',
],
],
[
'name' => 'ExpireTime',
'in' => 'query',
'schema' => [
'description' => '离线消息/通知的过期时间,和StoreOffline配合使用,过期则不会再被发送,最长保存72小时。默认为72小时。'."\n"
."\n"
.'时间格式按照ISO8601标准表示,并需要使用UTC时间,格式为YYYY-MM-DDThh:mm:ssZ,过期时间不能小于当前时间或者定时发送时间加上3秒(`ExpireTime > PushTime+ 3秒`),3秒是为了冗余网络和系统延迟造成的误差。建议单推不小于1分钟,全推、批量推送不少于10分钟。',
'type' => 'string',
'required' => false,
'example' => '2019-02-20T00:00:00Z',
],
],
[
'name' => 'JobKey',
'in' => 'query',
'schema' => [
'description' => '推送任务自定义标识,当JobKey不为空时,回执日志中会附带该字段。查看回执日志参见[回执日志](~~434651~~)。'."\n"
.'>格式要求:只能使用字母或数字或符号‘_’、‘-’任意一项或组合 ,且长度不超过32个字符',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => [
'description' => '推送时通知/消息的标题,长度限制:200字节。'."\n"
."\n"
.'在Android和Harmony推送时必填;在iOS通知时非必填,如果填写,则:'."\n"
."\n"
.'- iOS 10+通知显示标题。'."\n"
."\n"
.'- iOS 8.2 <= iOS系统 < iOS 10:替换通知应用名称。',
'type' => 'string',
'required' => false,
'example' => 'title',
],
],
[
'name' => 'Body',
'in' => 'query',
'schema' => [
'description' => 'Android和Harmony推送时通知的内容/消息的内容;iOS消息/通知内容,推送的内容大小是有限制的,参见[产品限制](~~434629~~)。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'hello',
],
],
[
'name' => 'Trim',
'in' => 'query',
'schema' => [
'description' => '是否自动对过长标题、内容进行截断。'."\n"
."\n"
.'>仅支持明确限制标题、内容的厂商通道,对APNs、华为、荣耀通道等不限制标题、内容,只限制总请求体大小的不适用。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'iOSApnsEnv',
'in' => 'query',
'schema' => [
'description' => 'iOS的通知是通过APNs中心来发送的,需要填写对应的环境信息。'."\n"
."\n"
.'- **DEV**:开发环境,适用于Xcode直接安装调试的应用。'."\n"
.'- **PRODUCT**:生产环境,适用于 App Store、TestFlight、Ad Hoc 及企业分发的应用。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'DEV' => 'DEV',
'PRODUCT' => 'PRODUCT',
],
'example' => 'DEV',
'enum' => [
'PRODUCT',
'DEV',
],
],
],
[
'name' => 'iOSRemind',
'in' => 'query',
'schema' => [
'description' => '消息推送时设备不在线(即与移动推送的服务端的长连接通道不通),则这条推送会做为通知,通过苹果的APNs通道送达一次。'."\n"
."\n"
.'> 离线消息转通知仅适用于生产环境。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'iOSSubtitle',
'in' => 'query',
'schema' => [
'description' => 'iOS通知副标题内容(iOS 10+)。',
'type' => 'string',
'required' => false,
'example' => 'su\'b',
],
],
[
'name' => 'iOSRemindBody',
'in' => 'query',
'schema' => [
'description' => 'iOS消息转通知时使用的iOS通知内容,仅当iOSApnsEnv=PRODUCT && iOSRemind为true时有效。',
'type' => 'string',
'required' => false,
'example' => 'ios通知body',
],
],
[
'name' => 'iOSMusic',
'in' => 'query',
'schema' => [
'description' => 'iOS通知声音。指定存放在app bundle或沙盒Library/Sounds目录下的音频文件名,请参见:[iOS推送如何设定通知声音](~~48906~~)。'."\n"
."\n"
.'若指定为空串(””),通知为静音;若不设置,默认填充default为系统提示音。',
'type' => 'string',
'required' => false,
'example' => '""',
],
],
[
'name' => 'iOSBadge',
'in' => 'query',
'schema' => [
'description' => 'iOS应用图标右上角角标。'."\n"
."\n"
.'> 若iOSBadgeAutoIncrement设置为True,则此项必须为空。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'iOSBadgeAutoIncrement',
'in' => 'query',
'schema' => [
'description' => '是否开启角标自增功能,默认为false。'."\n"
."\n"
.'>当该项为true时,iOSBadge必须为空。'."\n"
."\n"
.'角标自增功能由推送服务端维护每个设备的角标计数,需要用户使用1.9.5以上版本的SDK,并且需要用户主动同步角标数字到服务端。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'iOSSilentNotification',
'in' => 'query',
'schema' => [
'description' => '是否开启iOS静默通知。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'iOSMutableContent',
'in' => 'query',
'schema' => [
'description' => 'iOS通知处理扩展标记(iOS 10+)。如果设为true,则APNs推送的通知在弹出前,可先到达Extension进行处理。静默通知时,必须设为true。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'iOSNotificationCategory',
'in' => 'query',
'schema' => [
'description' => '指定iOS通知Category(iOS 10+)。',
'type' => 'string',
'required' => false,
'example' => 'ios',
],
],
[
'name' => 'iOSNotificationCollapseId',
'in' => 'query',
'schema' => [
'description' => '设备收到有相同CollapseId的消息,会合并成一条。设备不在线,连续发相同CollapseId的消息,通知栏只会显示一条,iOS 10+支持设置此参数。',
'type' => 'string',
'required' => false,
'example' => 'ZD2011',
],
],
[
'name' => 'iOSNotificationThreadId',
'in' => 'query',
'schema' => [
'description' => '通过该属性对iOS的远程通知进行分组,标记折叠的组别识别名。'."\n"
.'仅支持iOS 12.0+版本。',
'type' => 'string',
'required' => false,
'example' => 'abc',
],
],
[
'name' => 'iOSInterruptionLevel',
'in' => 'query',
'schema' => [
'description' => '中断级别,取值:'."\n"
."\n"
.'- **passive**:系统在不点灯、不播放声音的情况下将通知添加到通知列表中。'."\n"
.'- **active**:系统立即显示通知,点亮屏幕,并可以播放声音。'."\n"
.'- **time-sensitive**:系统立即呈现通知,点亮屏幕,并可以播放声音,但不会突破系统通知控制。'."\n"
.'- **critical**:系统立即显示通知,屏幕亮起,并绕过静音开关播放声音。',
'type' => 'string',
'required' => false,
'example' => 'active',
],
],
[
'name' => 'iOSRelevanceScore',
'in' => 'query',
'schema' => [
'description' => '摘要突出显示分数。取值范围:\\[0,1\\]的浮点数。',
'type' => 'number',
'format' => 'double',
'required' => false,
'example' => '0.01',
],
],
[
'name' => 'iOSExtParameters',
'in' => 'query',
'schema' => [
'description' => 'iOS通知的扩展属性。'."\n"
."\n"
.'iOS10+可以在此指定富媒体推送通知的资源Url:`{"attachment": "https://xxxx.xxx/notification_pic.png"} `。该参数要以JSON map的格式传入,否则会解析出错。',
'type' => 'string',
'required' => false,
'example' => '{"attachment": "https://xxxx.xxx/notification_pic.png"} ',
],
],
[
'name' => 'iOSLiveActivityEvent',
'in' => 'query',
'schema' => [
'description' => '启动、更新、结束实时活动。'."\n"
."\n"
.'- 枚举:start | update | end',
'type' => 'string',
'required' => false,
'example' => 'start',
'enum' => [
'start',
'update',
'end',
],
],
],
[
'name' => 'iOSLiveActivityId',
'in' => 'query',
'schema' => [
'description' => '由设备上报到用户服务器的Live Activity ID,Live Activity的唯一标识符。',
'type' => 'string',
'required' => false,
'example' => '66B94673-B32E-4CA7-863C-3E523054FD46',
],
],
[
'name' => 'iOSLiveActivityAttributesType',
'in' => 'query',
'schema' => [
'description' => '待启动的Live Activity类型。'."\n"
.'> iOSLiveActivityEvent为start时必填',
'type' => 'string',
'required' => false,
'example' => 'OrderActivityAttributes',
],
],
[
'name' => 'iOSLiveActivityAttributes',
'in' => 'query',
'schema' => [
'description' => 'JSON字符串,灵动岛推送透传静态参数。包含静态的用户自定义信息,如产品编号、订单信息等。'."\n"
."\n"
.'> iOSLiveActivityEvent为start时必填',
'type' => 'string',
'required' => false,
'example' => '{"orderId": "12345", "product": "Shoes"}',
],
],
[
'name' => 'iOSLiveActivityContentState',
'in' => 'query',
'schema' => [
'description' => '灵动岛推送透传动态参数,包含实时更新信息,如价格、库存变化等',
'type' => 'string',
'required' => false,
'example' => '{"status": "delivered", "estimatedArrival": "2023-12-31T12:00:00Z"}',
],
],
[
'name' => 'iOSLiveActivityDismissalDate',
'in' => 'query',
'schema' => [
'description' => '秒级时间戳,结束的Live Activity在锁屏上会保留到该指定时间,最长为4小时。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1743131967',
],
],
[
'name' => 'iOSLiveActivityStaleDate',
'in' => 'query',
'schema' => [
'description' => '秒级时间戳,标记该活动的内容过期时间。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1743131967',
],
],
[
'name' => 'AndroidNotifyType',
'in' => 'query',
'schema' => [
'description' => '通知的提醒方式。可取值:'."\n"
."\n"
.'- **VIBRATE**:振动(默认值)'."\n"
.'- **SOUND**:声音'."\n"
.'- **BOTH**:声音和振动'."\n"
.'- **NONE**:静音',
'type' => 'string',
'required' => false,
'example' => 'BOTH',
'enum' => [
'NONE',
'VIBRATE',
'SOUND',
'BOTH',
],
],
],
[
'name' => 'AndroidRemind',
'in' => 'query',
'schema' => [
'description' => '推送类型为消息时设备不在线,则这条推送会使用辅助弹窗功能。默认值为false,仅当PushType=MESSAGE时生效。'."\n"
."\n"
.'如果消息转通知推送成功,收到通知是展示的数据为服务端设置的AndroidPopupTitle和AndroidPopupBody参数值,点击通知在辅助弹窗的onSysNoticeOpened方法中获取到的数据是服务端设置的Title和Body参数值。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'AndroidOpenType',
'in' => 'query',
'schema' => [
'description' => '点击通知后动作。可取值:'."\n"
."\n"
.'- **APPLICATION**:打开应用(默认值)'."\n"
.'- **ACTIVITY**:打开应用AndroidActivity'."\n"
.'- **URL**:打开URL'."\n"
.'- **NONE**:无跳转',
'type' => 'string',
'required' => false,
'example' => 'APPLICATION',
'enum' => [
'APPLICATION',
'ACTIVITY',
'URL',
'NONE',
],
],
],
[
'name' => 'AndroidActivity',
'in' => 'query',
'schema' => [
'description' => '设定通知打开的activity。'."\n"
."\n"
.'仅当AndroidOpenType=”Activity”时传入,如:`com.alibaba.cloudpushdemo.bizactivity`。',
'type' => 'string',
'required' => false,
'example' => 'com.alibaba.cloudpushdemo.bizactivity',
],
],
[
'name' => 'AndroidOpenUrl',
'in' => 'query',
'schema' => [
'description' => 'Android收到推送后打开对应的url。'."\n"
."\n"
.'仅当AndroidOpenType=”URL”时传入。',
'type' => 'string',
'required' => false,
'example' => 'https://xxxx.xxx',
],
],
[
'name' => 'AndroidPopupActivity',
'in' => 'query',
'schema' => [
'description' => '指定点击通知后跳转的Activity。',
'type' => 'string',
'required' => false,
'example' => 'com.alibaba.cloudpushdemo.bizactivity',
],
],
[
'name' => 'AndroidPopupTitle',
'in' => 'query',
'schema' => [
'description' => '辅助弹窗模式下标题内容。**AndroidPopupActivity**参数不为空时,该参数必填。 '."\n"
."\n"
.'长度限制:50个字符,中英文都算一个字符。'."\n"
."\n"
.'如使用厂商通道,则需同时符合厂商通道的限制,具体内容参见:[Android端辅助通道推送限制](~~165253~~)。',
'type' => 'string',
'required' => false,
'example' => 'hello',
],
],
[
'name' => 'AndroidPopupBody',
'in' => 'query',
'schema' => [
'description' => '辅助弹窗模式下Body内容。**AndroidPopupActivity**参数不为空时,该参数必填。'."\n"
."\n"
.'长度限制:200个字符,中英文都算一个字符。'."\n"
."\n"
.'如使用厂商通道,则需同时符合厂商通道的限制,具体内容参见:[Android端辅助通道推送限制](~~165253~~)。',
'type' => 'string',
'required' => false,
'example' => 'hello',
],
],
[
'name' => 'AndroidRenderStyle',
'in' => 'query',
'schema' => [
'description' => '通知样式,取值为:'."\n"
.'- **0**:标准模式(默认)'."\n"
.'- **1**:长文本模式(支持华为、荣耀、小米、OPPO、魅族、自有通道)'."\n"
.'- **2**:大图模式(支持自有通道,不支持小米机型)'."\n"
.'- **3**:列表模式(支持华为、荣耀、小米、OPPO、自有通道)'."\n"
.'> 若使用非标准模式,此参数必须提供。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => [
'0',
'1',
'2',
],
'example' => '1',
],
],
[
'name' => 'AndroidBigTitle',
'in' => 'query',
'schema' => [
'description' => '长文本模式下的标题,长度限制:200个字节(1个汉字算作3字节)。'."\n"
."\n"
.'- 当前仅支持荣耀通道和华为通道EMUI11及以上版本。'."\n"
."\n"
.'- 若长文本模式下未提供此参数,则从Title、AndroidPopupTitle里取第一个非空值。',
'type' => 'string',
'required' => false,
'example' => '示例长标题',
],
],
[
'name' => 'AndroidBigBody',
'in' => 'query',
'schema' => [
'description' => '长文本模式下的body,长度限制:1000字节(1个汉字算作3字节),发送时受具体厂商通道的限制。'."\n"
."\n"
.'当前支持:'."\n"
."\n"
.'- 华为:EMUI10及以上'."\n"
."\n"
.'- 荣耀:Magic UI 4.0及以上'."\n"
."\n"
.'- 小米:MIUI10及以上'."\n"
."\n"
.'- OPPO:ColorOS 5.0以上'."\n"
."\n"
.'- 魅族:Flyme '."\n"
.'- 自有通道:安卓SDK3.6.0及以上'."\n"
."\n"
.'>若长文本模式下未提供此参数,则从Body、AndroidPopupBody里取第一个非空值。',
'type' => 'string',
'required' => false,
'example' => '示例长文本',
],
],
[
'name' => 'AndroidBigPictureUrl',
'in' => 'query',
'schema' => [
'description' => '大图模式下的图片URL,当前支持:自有通道:安卓SDK3.6.0及以上。',
'type' => 'string',
'required' => false,
'example' => 'https://imag.example.com/image.png',
],
],
[
'name' => 'AndroidXiaomiBigPictureUrl',
'in' => 'query',
'schema' => [
'description' => '该参数已废弃,小米从 2023.08 开始,官方在新设备/系统已经不再支持推送时动态设置小图标、右侧图标、大图片功能。',
'type' => 'string',
'deprecated' => true,
'required' => false,
'example' => 'https://f6.market.xiaomi.com/download/MiPass/aaa/bbb.png',
],
],
[
'name' => 'AndroidImageUrl',
'in' => 'query',
'schema' => [
'description' => '大图标URL。'."\n"
.'当前支持:'."\n"
.'- 华为EMUI(仅长文本模式、Inbox模式下适用)。'."\n"
."\n"
.'- 荣耀Magic UI(仅长文本模式下适用)。'."\n"
."\n"
.'- 自有通道:安卓SDK3.5.0及以上。',
'type' => 'string',
'required' => false,
'example' => 'https://imag.example.com/image.png',
],
],
[
'name' => 'AndroidXiaomiImageUrl',
'in' => 'query',
'schema' => [
'description' => '该参数已废弃,小米从 2023.08 开始,官方在新设备/系统已经不再支持推送时动态设置小图标、右侧图标、大图片功能。',
'type' => 'string',
'deprecated' => true,
'required' => false,
'example' => 'https://imag.example.com/image.png',
],
],
[
'name' => 'AndroidInboxBody',
'in' => 'query',
'schema' => [
'description' => 'Inbox模式下的正文,内容为合法的JSON Array,且元素不超过5个。当前支持:'."\n"
."\n"
.'- 华为:EMUI9及以上'."\n"
.'- 荣耀:Magic UI 4.0及以上'."\n"
.'- 小米:MIUI10及以上'."\n"
.'- OPPO:ColorOS 5.0以上'."\n"
.'- 自有通道:安卓SDK3.6.0及以上',
'type' => 'string',
'required' => false,
'example' => '["第一行","第二行"]',
],
],
[
'name' => 'AndroidNotificationBarType',
'in' => 'query',
'schema' => [
'description' => 'Android自定义通知栏样式,取值:1-100。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '0',
'example' => '2',
],
],
[
'name' => 'AndroidNotificationBarPriority',
'in' => 'query',
'schema' => [
'description' => 'Android通知在通知栏展示时排列位置的优先级。可取值: -2,-1,0,1,2。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2',
'minimum' => '-2',
'example' => '0',
],
],
[
'name' => 'AndroidNotificationNotifyId',
'in' => 'query',
'schema' => [
'description' => '标识每条消息在通知显示时的唯一标识,不同的通知栏消息可以相同的NotifyId,实现新的通知栏消息覆盖老的,当前支持除FCM通道外的其他厂商通道。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '100001',
],
],
[
'name' => 'AndroidNotificationChannel',
'in' => 'query',
'schema' => [
'description' => 'Android app的channelId,需要与app中的channelId能对应上。'."\n"
.'- 设置NotificationChannel参数,具体用途请参见[常见问题:Android 8.0以上设备通知接收不到](~~67398~~)。'."\n"
.'- 因OPPO通知私信通道的channel_id与app的channelId相同,故OPPO通道推送时,channel_id取此值。'."\n"
.'- 华为、FCM、阿里云自有通道推送中,channel_id取此值。',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'AndroidNotificationHuaweiChannel',
'in' => 'query',
'schema' => [
'description' => '设置Huawei通知消息分类importance参数,决定用户设备消息通知行为,取值如下:'."\n"
."\n"
.'- LOW:资讯营销类消息'."\n"
.'- NORMAL:服务与通讯类消息'."\n"
."\n"
.'>- 当前华为通道建议使用AndroidMessageHuaweiCategory进行通知分类,可不再使用AndroidNotificationHuaweiChannel。'."\n"
.'>- 需要在Huawei平台申请,[申请链接](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#section893184112272)。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'LOW' => 'LOW',
'NORMAL' => 'NORMAL',
],
'example' => 'LOW',
],
],
[
'name' => 'AndroidNotificationHonorChannel',
'in' => 'query',
'schema' => [
'description' => '设置荣耀通知消息分类importance参数,决定用户设备消息通知行为,取值如下:'."\n"
."\n"
.'- **LOW**:资讯营销类消息'."\n"
.'- **NORMAL**:服务与通讯类消息'."\n"
."\n"
.'需要在荣耀平台申请,[申请链接](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' => 'string',
'required' => false,
'enumValueTitles' => [
'LOW' => 'LOW',
'NORMAL' => 'NORMAL',
],
'example' => 'LOW',
],
],
[
'name' => 'AndroidNotificationXiaomiChannel',
'in' => 'query',
'schema' => [
'description' => '设置小米通知类型的channelId,需要在小米平台申请,详见:[申请链接](https://dev.mi.com/console/doc/detail?pId=2422#_4)。'."\n"
.'>- 小米通道单个应用最多可申请8个channel,请提前做好规划。',
'type' => 'string',
'required' => false,
'example' => 'michannel',
],
],
[
'name' => 'AndroidNotificationVivoChannel',
'in' => 'query',
'schema' => [
'description' => '设置vivo通知消息分类,取值为:'."\n"
."\n"
.'- 0:运营类消息(默认)'."\n"
.'- 1:系统类消息'."\n"
."\n"
.'>- 当前vivo通道建议使用AndroidMessageVivoCategory进行通知分类,可不再使用AndroidNotificationVivoChannel。'."\n"
.'>- 需要在vivo平台申请,详见:[申请链接](https://dev.vivo.com.cn/documentCenter/doc/359)。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'0',
'1',
],
'example' => 'classification',
],
],
[
'name' => 'AndroidNotificationGroup',
'in' => 'query',
'schema' => [
'description' => '消息分组,同一组消息在通知栏里只显示最新一条和当前该组接受到的消息总数目,不会展示所有消息也无法展开。当前支持:'."\n"
."\n"
.'- 华为'."\n"
.'- 荣耀'."\n"
.'- 自有通道',
'type' => 'string',
'required' => false,
'example' => 'group-1',
],
],
[
'name' => 'AndroidNotificationThreadId',
'in' => 'query',
'schema' => [
'description' => '消息分组,同一组消息在通知栏里折叠展示,可展开,不同组通知分开展示。当前支持:'."\n"
."\n"
.'- 自有通道 安卓 SDK3.9.2 及以上',
'type' => 'string',
'required' => false,
'example' => 'thread-1',
],
],
[
'name' => 'AndroidExtParameters',
'in' => 'query',
'schema' => [
'description' => '设定通知的扩展属性。当推送类型PushType设置为MESSAGE消息类型时,该属性不生效。'."\n"
."\n"
.'该参数要以JSON map的格式传入,否则会解析出错。',
'type' => 'string',
'required' => false,
'example' => '{"key1":"value1","api_name":"PushNoticeToAndroidRequest"}',
],
],
[
'name' => 'AndroidMessageHuaweiUrgency',
'in' => 'query',
'schema' => [
'description' => '华为通道透传消息投递优先级,取值如下:'."\n"
."\n"
.'- **HIGH**'."\n"
.'- **NORMAL**'."\n"
."\n"
.'需要申请权限,具体请参见:[申请链接](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/faq-0000001050042183#section037425218509)。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'HIGH' => 'HIGH',
'NORMAL' => 'NORMAL',
],
'example' => 'HIGH',
],
],
[
'name' => 'AndroidMessageHuaweiCategory',
'in' => 'query',
'schema' => [
'description' => '作用一:完成[自分类权益申请](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835?#section3410731125514)后,用于标识消息类型,确定[消息提醒方式](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#ZH-CN_TOPIC_0000001149358835__p3850133955718),对特定类型消息加快发送,取值请参考华为推送官方文档的[消息分类标准](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#section1076611477914),填写文档表格中的“云端通知category取值”或“本地通知category取值”。'."\n"
."\n"
.'作用二:[申请特殊权限](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/faq-0000001050042183#section037425218509)后,用于标识高优先级透传场景,取值如下:'."\n"
.'- VOIP:音视频通话'."\n"
.'- PLAY_VOICE:语音播报'."\n"
."\n"
.'> 对于“云端通知category取值”为“不涉及”的一概走阿里云自有通道,对于“本地通知category取值”为“不涉及”的一概走华为通道。',
'type' => 'string',
'required' => false,
'example' => 'VOIP',
],
],
[
'name' => 'AndroidMessageOppoCategory',
'in' => 'query',
'schema' => [
'description' => 'OPPO将消息分类:通讯与服务、内容与营销两个类别进行管理。'."\n"
."\n"
.'通讯与服务(需申请权限):'."\n"
.'- IM:即时聊天、音频、视频通话'."\n"
.'- ACCOUNT:个人账号与资产变化'."\n"
.'- DEVICE_REMINDER:个人设备提醒'."\n"
.'- ORDER:个人订单/物流状态变化'."\n"
.'- TODO:个人日程/待办'."\n"
.'- SUBSCRIPTION:个人订阅'."\n"
."\n"
.'内容与营销:'."\n"
.'- NEWS:新闻资讯'."\n"
.'- CONTENT:内容推荐'."\n"
.'- MARKETING:平台活动'."\n"
.'- SOCIAL:社交动态'."\n"
."\n"
.'详细请参考[OPUSH消息分类细则](https://open.oppomobile.com/new/developmentDoc/info?id=13189)',
'type' => 'string',
'required' => false,
'example' => 'MARKETING',
],
],
[
'name' => 'AndroidMessageOppoNotifyLevel',
'in' => 'query',
'schema' => [
'description' => 'OPPO通道通知栏消息提醒等级。可取值为:'."\n"
.'- 1:通知栏'."\n"
.'- 2:通知栏、锁屏、铃声、振动(通讯与服务类消息默认通知级别)'."\n"
.'- 16:通知栏、锁屏、铃声、振动、横幅(需申请权限)'."\n"
."\n"
.'> 使用AndroidMessageOppoNotifyLevel参数时,必须同时传AndroidMessageOppoCategory参数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'AndroidMessageVivoCategory',
'in' => 'query',
'schema' => [
'description' => 'vivo将消息分为:系统消息、运营消息两个类别进行管理。'."\n"
.'系统消息:'."\n"
.'- IM:即时消息'."\n"
.'- ACCOUNT:账号与资产'."\n"
.'- TODO:日程待办'."\n"
.'- DEVICE_REMINDER:设备信息'."\n"
.'- ORDER:订单与物流'."\n"
.'- SUBSCRIPTION:订阅提醒'."\n"
."\n"
.'运营消息:'."\n"
.'- NEWS:新闻'."\n"
.'- CONTENT:内容推荐'."\n"
.'- MARKETING:运营活动'."\n"
.'- SOCIAL:社交动态'."\n"
."\n"
.'详细请参考[分类说明](https://dev.vivo.com.cn/documentCenter/doc/359#s-ef3qugc3)',
'type' => 'string',
'required' => false,
'example' => 'TODO',
],
],
[
'name' => 'AndroidTargetUserType',
'in' => 'query',
'schema' => [
'description' => '设置厂商通道通知类型:'."\n"
.'- **0**:正式通知(默认)。'."\n"
.'- **1**:测试通知。'."\n"
."\n"
.'>- 本参数配置后等价于同时配置AndroidHuaweiTargetUserType、AndroidHonorTargetUserType、AndroidVivoPushMode、AndroidOppoIntentEnv四个参数,具体厂商通道的对应参数能覆盖本参数。'."\n"
.'>- 当前支持:华为通道、荣耀通道、vivo通道、OPPO流体云。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
'enum' => [
'0',
'1',
],
],
],
[
'name' => 'AndroidHuaweiTargetUserType',
'in' => 'query',
'schema' => [
'description' => '设置华为通道通知类型:'."\n"
.'- **0**:正式通知(默认)。'."\n"
.'- **1**:测试通知。'."\n"
."\n"
.'> 每个应用每日可发送该测试通知500条且不受每日单设备推送数量上限要求。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => [
'0',
'1',
],
'example' => '0',
'enum' => [
'0',
'1',
],
],
],
[
'name' => 'AndroidHonorTargetUserType',
'in' => 'query',
'schema' => [
'description' => '设置荣耀通道通知类型:'."\n"
.'- **0**:正式通知(默认)。'."\n"
.'- **1**:测试通知。'."\n"
."\n"
.'> 每个应用每日可发送该测试通知1000条且不受每日单设备推送数量上限要求。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
'enum' => [
'0',
'1',
],
],
],
[
'name' => 'AndroidVivoPushMode',
'in' => 'query',
'schema' => [
'description' => '设置vivo通道通知类型:'."\n"
.'- **0**:正式推送(默认)。'."\n"
.'- **1**:测试推送。'."\n"
."\n"
.'> 测试推送请事先在vivo控制台配置测试设备。测试设备RegId可在设备启动日志中搜索“onReceiveRegId regId”获得。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => [
'0',
'1',
],
'example' => '0',
'enum' => [
'0',
'1',
],
],
],
[
'name' => 'AndroidOppoIntentEnv',
'in' => 'query',
'schema' => [
'description' => '设置OPPO流体云推送环境'."\n"
.'- **0**:正式环境(默认)。'."\n"
.'- **1**:测试环境。'."\n"
."\n"
.'> OPPO流体云测试环境需要参考[环境搭建](https://open.oppomobile.com/documentation/page/info?id=13590)在客户端搭建',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'enum' => [
'0',
'1',
],
],
],
[
'name' => 'AndroidHuaweiBusinessType',
'in' => 'query',
'schema' => [
'description' => '设置华为快通知参数'."\n"
.'- **0**:发送华为普通通知(默认)。'."\n"
.'- **1**:发送华为快通知。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'enum' => [
'0',
'1',
],
],
],
[
'name' => 'AndroidHuaweiReceiptId',
'in' => 'query',
'schema' => [
'description' => '华为通道回执ID,该回执ID可以在华为通道推送运营平台的回执参数配置中查看。'."\n"
."\n"
.'> 如果在华为通道推送运营平台配置的默认回执配置是阿里云回执,则无需提供,如果不是,建议优先在阿里云EMAS移动推送控制台中配置华为通道默认回执ID。',
'type' => 'string',
'required' => false,
'example' => 'RCP4C123456',
],
],
[
'name' => 'AndroidVivoReceiptId',
'in' => 'query',
'schema' => [
'description' => 'vivo通道回执ID,该回执ID可以在vivo开放平台推送服务的应用信息中查看。'."\n"
."\n"
.'> 如果在vivo开放平台配置的默认回执配置是阿里云回执,则无需提供,如果不是,建议优先在阿里云EMAS移动推送控制台中配置vivo通道默认回执ID。',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
[
'name' => 'AndroidBadgeClass',
'in' => 'query',
'schema' => [
'description' => '角标设置应用入口Activity的全类名'."\n"
."\n"
.'> 仅华为/荣耀产商通道推送时有效',
'type' => 'string',
'required' => false,
'example' => 'com.alibaba.cloudpushdemo.bizactivity',
],
],
[
'name' => 'AndroidBadgeAddNum',
'in' => 'query',
'schema' => [
'description' => '设置角标累加值,在原角标的基础上进行累加,取值范围[1~99]。'."\n"
.'> 仅华为/荣耀厂商通道推送时有效。AndroidBadgeAddNum 与 AndroidBadgeSetNum 同时存在时,以AndroidBadgeSetNum为准',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '99',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'AndroidBadgeSetNum',
'in' => 'query',
'schema' => [
'description' => '设置角标数字固定值,取值范围[0~99]。'."\n"
."\n"
.'> 厂商通道推送时仅华为、荣耀通道生效。 阿里云自有通道推送时仅华为机型、荣耀机型与vivo机型上生效。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '99',
'minimum' => '1',
'example' => '5',
],
],
[
'name' => 'AndroidMusic',
'in' => 'query',
'schema' => [
'description' => '华为厂商通道通知声音。指定存放在客户端项目app/src/main/res/raw/目录下的音频文件名,不需要携带文件格式后缀名。'."\n"
."\n"
.'若不设置,则使用默认铃声。',
'type' => 'string',
'required' => false,
'example' => 'alicloud_notification_sound',
],
],
[
'name' => 'HarmonyRemind',
'in' => 'query',
'schema' => [
'description' => '推送类型为消息时设备不在线,则这条推送会使用辅助弹窗功能。默认值为false,仅当PushType=MESSAGE时生效。'."\n"
."\n"
.'如果消息转通知推送成功,收到通知是展示的数据为服务端设置的HarmonyRemindTitle和HarmonyRemindBody参数值。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'HarmonyRemindTitle',
'in' => 'query',
'schema' => [
'description' => 'Harmony消息转通知时使用的Harmony通知标题,仅当HarmonyRemind为true时有效。',
'type' => 'string',
'required' => false,
'example' => '新消息',
],
],
[
'name' => 'HarmonyRemindBody',
'in' => 'query',
'schema' => [
'description' => 'Harmony消息转通知时使用的Harmony通知内容,仅当HarmonyRemind为true时有效。',
'type' => 'string',
'required' => false,
'example' => '您有一条新消息,请查收',
],
],
[
'name' => 'HarmonyCategory',
'in' => 'query',
'schema' => [
'description' => '通知消息类别。完成申请通知消息自分类权益后,用于标识消息类型,不同的通知消息类型影响消息展示和提醒方式。取值如下:'."\n"
."\n"
.'- IM:即时聊天'."\n"
.'- VOIP:音视频通话'."\n"
.'- SUBSCRIPTION:订阅'."\n"
.'- TRAVEL:出行'."\n"
.'- HEALTH:健康'."\n"
.'- WORK:工作事项提醒'."\n"
.'- ACCOUNT:账号动态'."\n"
.'- EXPRESS:订单&物流'."\n"
.'- FINANCE:财务'."\n"
.'- DEVICE_REMINDER:设备提醒'."\n"
.'- MAIL:邮件'."\n"
.'- CUSTOMER_SERVICE:客服消息'."\n"
.'- MARKETING:新闻、内容推荐、社交动态、产品促销、财经动态、生活资讯、调研、功能推荐、运营活动(仅对内容进行标识,不会加快消息发送),统称为资讯营销类消息'."\n"
."\n"
.'详情参见鸿蒙官网 [Notification.category](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section17371529101117)',
'type' => 'string',
'required' => false,
'example' => 'IM',
'enum' => [
'IM',
'VOIP',
'SUBSCRIPTION',
'TRAVEL',
'HEALTH',
'WORK',
'ACCOUNT',
'EXPRESS',
'FINANCE',
'DEVICE_REMINDER',
'MAIL',
'CUSTOMER_SERVICE',
'MARKETING',
],
],
],
[
'name' => 'HarmonyNotificationSlotType',
'in' => 'query',
'schema' => [
'description' => '使用指定类型的通知渠道。仅在阿里云自有通道在线时有效。'."\n"
."\n"
.'- SOCIAL_COMMUNICATION: 社交通信。'."\n"
.'- SERVICE_INFORMATION: 服务提醒。'."\n"
.'- CONTENT_INFORMATION: 内容资讯。'."\n"
.'- CUSTOMER_SERVICE: 客服消息。该类型用于用户与商家之间的客服消息,需由用户主动发起。'."\n"
.'- OTHER_TYPES: 其他。'."\n"
."\n"
.'详情参见鸿蒙官网 [SlotType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/js-apis-notificationmanager-V5#slottype)',
'type' => 'string',
'required' => false,
'example' => 'SOCIAL_COMMUNICATION',
'enum' => [
'SOCIAL_COMMUNICATION',
'SERVICE_INFORMATION',
'CONTENT_INFORMATION',
'CUSTOMER_SERVICE',
'OTHER_TYPES',
],
],
],
[
'name' => 'HarmonyNotifyId',
'in' => 'query',
'schema' => [
'description' => '每条消息在通知显示时的唯一标识。不携带时,推送服务自动为每条消息生成一个唯一标识;不同的通知消息可以拥有相同的notifyId,实现新消息覆盖旧消息功能。'."\n"
."\n"
.'详情参见鸿蒙官网 [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',
],
],
[
'name' => 'HarmonyActionType',
'in' => 'query',
'schema' => [
'description' => '点击通知后动作。可取值:'."\n"
."\n"
.'- APP_HOME_PAGE:打开应用首页'."\n"
.'- APP_CUSTOM_PAGE:打开应用自定义页面',
'type' => 'string',
'required' => false,
'example' => 'APP_HOME_PAGE',
'enum' => [
'APP_HOME_PAGE',
'APP_CUSTOM_PAGE',
],
],
],
[
'name' => 'HarmonyAction',
'in' => 'query',
'schema' => [
'description' => '应用内置页面ability对应的action。'."\n"
."\n"
.'><notice>当HarmonyActionType为APP_CUSTOM_PAGE时,字段HarmonyUri和HarmonyAction至少填写一个。></notice>'."\n"
."\n"
.'详情参见鸿蒙官网 [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',
],
],
[
'name' => 'HarmonyUri',
'in' => 'query',
'schema' => [
'description' => '应用内置页面ability对应的uri。'."\n"
.'><notice>当HarmonyActionType为APP_CUSTOM_PAGE时,字段HarmonyUri和HarmonyAction至少填写一个。当存在多个Ability时,分别填写不同Ability的action和uri,优先使用action查找对应的应用内置页面。></notice>'."\n"
."\n"
.'详情参见鸿蒙官网 [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',
],
],
[
'name' => 'HarmonyRenderStyle',
'in' => 'query',
'schema' => [
'description' => '通知消息样式:'."\n"
.'- NORMAL: 普通通知(默认值)'."\n"
.'- MULTI_LINE: 多行文本样式',
'type' => 'string',
'required' => false,
'example' => 'NORMAL',
'enum' => [
'NORMAL',
'MULTI_LINE',
],
],
],
[
'name' => 'HarmonyImageUrl',
'in' => 'query',
'schema' => [
'description' => '通知右侧大图标URL,URL使用的协议必须是HTTPS协议。'."\n"
."\n"
.'> 支持图片格式为png、jpg、jpeg、heif、gif、bmp,图片长*宽<25000像素。'."\n"
."\n"
.'详情参见鸿蒙官网 [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',
],
],
[
'name' => 'HarmonyInboxContent',
'in' => 'query',
'schema' => [
'description' => '多行文本样式的内容,当HarmonyRenderStyle为MULTI_LINE时,本字段必填,最多支持3条内容。',
'type' => 'string',
'required' => false,
'example' => '["1.content1","2.content2","3.content3"]',
],
],
[
'name' => 'HarmonyExtParameters',
'in' => 'query',
'schema' => [
'description' => '设定通知的扩展属性。当推送类型PushType设置为MESSAGE消息类型时,该属性不生效。'."\n"
."\n"
.'该参数要以JSON map的格式传入,否则会解析出错。',
'type' => 'string',
'required' => false,
'example' => '{"key1":"value1","api_name":"PushNoticeToAndroidRequest"}'."\n",
],
],
[
'name' => 'HarmonyTestMessage',
'in' => 'query',
'schema' => [
'description' => '测试消息标识:'."\n"
."\n"
.'- false:正常消息(默认值)'."\n"
.'- true:测试消息'."\n"
."\n"
.'详情参见鸿蒙官网 [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',
],
],
[
'name' => 'HarmonyReceiptId',
'in' => 'query',
'schema' => [
'description' => '鸿蒙通道回执ID,该回执ID可以在鸿蒙通道推送运营平台的回执参数配置中查看。'."\n"
."\n"
.'> 如果在鸿蒙通道推送运营平台配置的默认回执配置是阿里云回执,则无需提供,如果不是,建议优先在阿里云EMAS移动推送控制台中配置鸿蒙通道默认回执ID。'."\n"
."\n"
.'详情参见鸿蒙官网 [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',
],
],
[
'name' => 'HarmonyExtensionPush',
'in' => 'query',
'schema' => [
'description' => 'PushType为NOTICE时,是否为鸿蒙通知扩展消息。'."\n"
."\n"
.'- true:发送通知扩展消息'."\n"
.'- false:发送普通通知(默认值)'."\n"
."\n"
.'通知扩展消息需要先在鸿蒙侧申请权限才能发送,相关内容请参考鸿蒙文档[发送通知扩展消息](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/push-send-extend-noti-V5)。</br>'."\n"
.'鸿蒙SDK1.2.0版本开始支持。',
'type' => 'boolean',
'required' => false,
'example' => 'true'."\n",
],
],
[
'name' => 'HarmonyExtensionExtraData',
'in' => 'query',
'schema' => [
'description' => '通知扩展消息的额外数据。</br>'."\n"
.'发送鸿蒙通知扩展消息时有效。</br>'."\n"
.'概念上等同鸿蒙通知扩展消息的extraData字段,具体定义参考[鸿蒙ExtensionPayload说明](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section161192514234)。</br>'."\n"
.'鸿蒙SDK1.2.0版本开始支持。',
'type' => 'string',
'required' => false,
'example' => '示例额外数据',
],
],
[
'name' => 'HarmonyBadgeAddNum',
'in' => 'query',
'schema' => [
'description' => '鸿蒙应用角标累加数字。参考[鸿蒙角标addNum字段说明](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section266310382145)。</br>'."\n"
.'鸿蒙SDK1.2.0版本开始支持。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'HarmonyBadgeSetNum',
'in' => 'query',
'schema' => [
'description' => '鸿蒙应用角标设置数字。参考[鸿蒙角标setNum字段说明](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section266310382145)。'."\n"
.'鸿蒙SDK1.2.0版本开始支持。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'SmsTemplateName',
'in' => 'query',
'schema' => [
'description' => '补发短信的模板名,可以在短信模板管理界面获取,是系统分配的名称,而非开发者设置的名称。',
'type' => 'string',
'required' => false,
'example' => '短信模板名称',
],
],
[
'name' => 'SmsSignName',
'in' => 'query',
'schema' => [
'description' => '补发短信的签名。',
'type' => 'string',
'required' => false,
'example' => '短信签名',
],
],
[
'name' => 'SmsParams',
'in' => 'query',
'schema' => [
'description' => '短信模板的变量名值对,格式: `key1=value1&key2=value2`。',
'type' => 'string',
'required' => false,
'example' => 'key1=value1',
],
],
[
'name' => 'SmsDelaySecs',
'in' => 'query',
'schema' => [
'description' => '触发短信的延迟时间,单位:秒。'."\n"
."\n"
.'若使用短信联动必须设置,推荐设置为15秒以上,最大不超过3天,避免短信和推送的重复。'."\n"
."\n"
.'> 短信联动时,ExpireTime参数失效,通知失效时间以SmsDelaySecs参数计算,失效时间为当前时间加上SmsDelaySecs时间。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'minimum' => '1',
'example' => '15',
],
],
[
'name' => 'SmsSendPolicy',
'in' => 'query',
'schema' => [
'description' => '触发短信的条件。可取值:'."\n"
."\n"
.'- **0**:推送未收到时触发。'."\n"
.'- **1**:用户未打开时触发。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '1',
'minimum' => '0',
'enumValueTitles' => [
'0',
'1',
],
'example' => '0',
],
],
[
'name' => 'SendSpeed',
'in' => 'query',
'schema' => [
'description' => '该参数已废弃。',
'type' => 'integer',
'format' => 'int32',
'deprecated' => true,
'required' => false,
'minimum' => '10000',
'example' => '0',
],
],
[
'name' => 'AndroidXiaoMiNotifyTitle',
'in' => 'query',
'schema' => [
'description' => '该参数已废弃,所有第三方辅助弹窗都由新参数**AndroidPopupTitle**统一支持。',
'type' => 'string',
'deprecated' => true,
'required' => false,
'example' => '无',
],
],
[
'name' => 'AndroidXiaoMiNotifyBody',
'in' => 'query',
'schema' => [
'description' => '该参数已废弃,所有第三方辅助弹窗都由新参数**AndroidPopupBody**统一支持。',
'type' => 'string',
'deprecated' => true,
'required' => false,
'example' => '无',
],
],
[
'name' => 'AndroidXiaoMiActivity',
'in' => 'query',
'schema' => [
'description' => '该参数已废弃,所有第三方辅助弹窗都由新参数**AndroidPopupActivity**统一支持。',
'type' => 'string',
'deprecated' => true,
'required' => false,
'example' => '无',
],
],
[
'name' => 'IdempotentToken',
'in' => 'query',
'schema' => [
'description' => '用于防止API调用端重试造成服务端重复推送的一个幂等参数。15分钟内使用相同IdempotentToken进行调用时,只会进行一次推送,后续返回第一次成功推送的结果。'."\n"
."\n"
.'> '."\n"
.'> - 参数格式为标准36位UUID(8-4-4-4-12),每个有效字符是0-9 或 a-f 范围内的一个十六进制的数字,不区分大小写。'."\n"
.'> - 此参数仅用于避免重试造成的重复推送,无法避免并发调用造成的重复推送。',
'type' => 'string',
'required' => false,
'example' => 'c8016d13-6e76-410c-9bda-769383d11787',
'maxLength' => 36,
'minLength' => 36,
],
],
[
'name' => 'AndroidMeizuNoticeMsgType',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '魅族消息类型'."\n"
.'- 0 公信消息(默认)'."\n"
.'- 1 私信消息',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'enumValueTitles' => [
'公信消息(默认)',
'私信消息',
],
'example' => '0',
'enum' => [
'0',
'1',
],
],
],
[
'name' => 'AndroidOppoPrivateMsgTemplateId',
'in' => 'query',
'schema' => [
'title' => '私信模板ID',
'description' => 'OPPO 私信模板ID',
'type' => 'string',
'required' => false,
'example' => '687557242b1634hzefs3d5013',
],
],
[
'name' => 'AndroidOppoPrivateTitleParameters',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '私信标题参数',
'description' => 'OPPO 私信模版标题参数',
'type' => 'object',
'required' => false,
'additionalProperties' => [
'type' => 'string',
'description' => 'OPPO 私信模版标题中的变量名,变量值',
'example' => 'my_title',
],
],
],
[
'name' => 'AndroidOppoPrivateContentParameters',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '私信内容参数',
'description' => 'OPPO 私信模版内容参数',
'type' => 'object',
'required' => false,
'additionalProperties' => [
'type' => 'string',
'description' => 'OPPO 私信模版内容中的变量名,变量值',
'example' => 'my_content',
],
],
],
[
'name' => 'HarmonyLiveViewPayload',
'in' => 'query',
'schema' => [
'description' => '鸿蒙实况窗数据结构 [LiveViewPayload](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V13/push-scenariozed-api-request-param-V13#section66881469306) 的 JSON 字符串,开发接入请参考文档[HarmonyOS 实况窗推送指南](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"
.'}',
],
],
[
'name' => 'AndroidHuaweiLiveNotificationPayload',
'in' => 'query',
'schema' => [
'description' => '华为安卓实况窗数据结构 [LiveNotificationPayload](https://developer.huawei.com/consumer/cn/doc/HMSCore-References/rest-live-0000001562939968#ZH-CN_TOPIC_0000001700850537__p195121620102511) 的 JSON 字符串,开发接入请参考文档[华为实况窗推送指南](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"
.'}',
],
],
[
'name' => 'AndroidOppoIntelligentIntent',
'in' => 'query',
'schema' => [
'description' => 'OPPO流体云的意图共享数据结构[IntelligentIntent](https://open.oppomobile.com/documentation/page/info?id=13565)的JSON字符串,开发接入请参考文档[OPPO流体云推送指南](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"
.'}',
],
],
[
'name' => 'AndroidOppoDeleteIntentData',
'in' => 'query',
'schema' => [
'description' => 'OPPO流体云的意图删除数据结构[data](https://open.oppomobile.com/documentation/page/info?id=13578)的JSON字符串,当AndroidOppoIntelligentIntent参数已填写时此参数无效,开发接入请参考文档[OPPO流体云推送指南](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"
.'}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '标志一次推送的消息ID。',
'type' => 'string',
'example' => '501029',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidPeriod.ExceedDays',
'errorMessage' => 'The period between specified EndTime and StartTime exceeds %s days.',
],
[
'errorCode' => 'Invalid%s.Format',
'errorMessage' => 'The specified %s format is invalid.',
],
[
'errorCode' => 'AccountDisabled',
'errorMessage' => 'Your account is not enabled.',
],
[
'errorCode' => 'FileNotExist',
'errorMessage' => 'The specified file does not exist.',
],
[
'errorCode' => 'IncorrectPassword',
'errorMessage' => 'The password is incorrect.',
],
[
'errorCode' => 'NotApnsCertificate',
'errorMessage' => 'The Certificate is not an APNs certificate.',
],
[
'errorCode' => 'PermissionDenied',
'errorMessage' => 'The specified AppKey is not authorized.',
],
[
'errorCode' => 'SendSpeedNotSupported',
'errorMessage' => 'SendSpeed is not supported for specified Target.',
],
[
'errorCode' => 'SmsProfileConfigFailed',
'errorMessage' => 'Failed to configure SMS profile.',
],
[
'errorCode' => 'SmsProfileGetFailed',
'errorMessage' => 'Failed to get SMS profile.',
],
[
'errorCode' => 'SmsRoleAuthorizeFailed',
'errorMessage' => 'Failed to authorize SMS role.',
],
[
'errorCode' => 'SmsRoleUnauthorized',
'errorMessage' => 'The SMS role is unauthorized.',
],
[
'errorCode' => 'TagsNumberBeyondLimit',
'errorMessage' => 'The number of tags bound to this app exceeds the limit.',
],
[
'errorCode' => 'Invalid%s.LengthExceed',
'errorMessage' => 'The specified %s length cannot be greater than %s.',
],
[
'errorCode' => 'Invalid%s.BytesExceed',
'errorMessage' => 'The specified %s exceeds the %s bytes limit.',
],
[
'errorCode' => 'Invalid%s.Empty',
'errorMessage' => 'The specified %s cannot be empty.',
],
[
'errorCode' => 'Invalid.Parameter',
'errorMessage' => 'The specified parameter is invalid: %s.',
],
[
'errorCode' => 'TargetNotSupported',
'errorMessage' => 'Target is not supported for batch push.',
],
],
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.',
],
[
'errorCode' => 'Timeout',
'errorMessage' => 'The request processing is timeout.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"501029\\",\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","type":"json"}]',
'title' => '高级推送',
'description' => '**请确保在使用该接口前,已充分了解EMAS移动推送产品的[收费方式和价格](~~434638~~)。**'."\n"
."\n"
.'本接口区分Android、iOS和HarmonyOS平台,对于不同平台的推送调用,需要传入平台对应的AppKey。',
'requestParamsDescription' => '## 请求参数补充说明'."\n"
.'**Title/Body 展开说明如下:**'."\n"
."\n"
.'|属性\\推送类型|消息(iOS)|消息(Android)|通知(iOS)| 通知(Android)|'."\n"
.'|:-----------------|:-----------------|:-----------------|:-----------------|:-----------------|'."\n"
.'|Title |消息标题,对应消息回调中CCPSysMessage的title字段| CPushMessage.title字段| 通知标题 | 通知标题,通知回调方法(onNotificationOpened)|'."\n"
.'Body| 消息体,对应消息回调中CCPSysMessage的body字段| 消息体,CPushMessage.content字段| 通知内容 |通知内容,通知回调方法(onNotificationOpened)|'."\n"
."\n"
.'**下述配置仅作用于Android辅助弹窗功能:**'."\n"
."\n"
.'推送时设备不在线(既与移动推送的服务端的长连接通道不通),则这条推送可以启动辅助弹窗功能,启动辅助弹窗功能参见[移动推送辅助通道配置](https://help.aliyun.com/document_detail/30067.html),且需要具备如下条件:'."\n"
."\n"
.'* 集成第三方辅助通道。'."\n"
.'* StoreOffline参数设为true。'."\n"
.'* 推送通知(无需设置AndroidRemind)或者推送消息并设置AndroidRemind为true。'."\n"
.'* 正确设置AndroidPopupActivity、AndroidPopupTitle、AndroidPopupBody参数。',
'responseParamsDescription' => ' ',
'extraInfo' => '## Java示例代码'."\n"
."\n"
.'```'."\n"
.'PushRequest pushRequest = new PushRequest();'."\n"
.'// 推送目标'."\n"
.'pushRequest.setAppKey(appKey);'."\n"
.'pushRequest.setTarget("ALL"); //推送目标: DEVICE:推送给设备; ACCOUNT:推送给指定账号,TAG:推送给自定义标签; ALIAS: 按别名推送; ALL: 全推'."\n"
.'pushRequest.setTargetValue("all"); //根据Target来设定,如Target=DEVICE, 则对应的值为 设备id1,设备id2. 多个值使用逗号分隔.(账号与设备有一次最多100个的限制)'."\n"
.'pushRequest.setDeviceType("iOS"); // 设备类型deviceType, iOS设备: "iOS"; Android设备: "ANDROID"; 全部: "ALL", 这是默认值.'."\n"
.'// 推送配置'."\n"
.'pushRequest.setPushType("MESSAGE"); // MESSAGE:表示消息(默认), NOTICE:表示通知'."\n"
.'pushRequest.setTitle("Hello"); // 消息的标题'."\n"
.'pushRequest.setBody("PushRequest body"); // 消息的内容'."\n"
.'// 推送配置: iOS'."\n"
.'pushRequest.setIOSBadge(5); // iOS应用图标右上角角标'."\n"
.'pushRequest.setIOSMusic("default"); // iOS通知声音'."\n"
.'pushRequest.setIOSApnsEnv("PRODUCT");//iOS的通知是通过APNs中心来发送的,需要填写对应的环境信息。\'DEV\': 表示开发环境 \'PRODUCT\': 表示生产环境'."\n"
.'pushRequest.setIOSRemind(true); // 消息推送时设备不在线(既与移动推送的服务端的长连接通道不通),则这条推送会做为通知,通过苹果的APNs通道送达一次。注意:**离线消息转通知仅适用于`生产环境`**'."\n"
.'pushRequest.setIOSRemindBody("PushRequest summary"); // iOS消息转通知时使用的iOS通知内容,仅当iOSApnsEnv=`PRODUCT` && iOSRemind为true时有效'."\n"
.'pushRequest.setIOSExtParameters("{\\"k1\\":\\"ios\\",\\"k2\\":\\"v2\\"}"); //通知的扩展属性(注意 : 该参数要以json map的格式传入,否则会解析出错)'."\n"
.'// 推送配置: Android'."\n"
.'pushRequest.setAndroidOpenType("ACTIVITY"); // 点击通知后动作 \'APPLICATION\': 打开应用 \'ACTIVITY\': 打开应用AndroidActivity \'URL\': 打开URL \'NONE\': 无跳转'."\n"
.'pushRequest.setAndroidNotifyType("SOUND"); // 通知的提醒方式 ‘VIBRATE\': 振动 \'SOUND\': 声音 \'DEFAULT\': 声音和振动 \'NONE\': 不做处理,用户自定义'."\n"
.'pushRequest.setAndroidOpenUrl("http://www.alibaba.com");'."\n"
.'pushRequest.setAndroidMusic("alicloud_notification_sound"); // 华为厂商通道通知声音'."\n"
.'pushRequest.setAndroidActivity("com.alibaba.push.PushActivity"); // Android收到推送后打开对应的ACTIVITY,仅当`AndroidOpenType="ACTIVITY"`有效'."\n"
.'pushRequest.setAndroidPopupActivity("com.alibaba.push.PopupActivity"); //设置该参数后启动辅助弹窗功能, 此处指定通知点击后跳转的Activity(辅助弹窗的前提条件:1. 集成第三方辅助通道;2. StoreOffline参数设为true)'."\n"
.'pushRequest.setAndroidPopupTitle("Popup Title"); //设置辅助弹窗通知的标题'."\n"
.'pushRequest.setAndroidPopupBody("Popup Body"); //设置辅助弹窗通知的内容'."\n"
.'pushRequest.setAndroidNotificationBarType(50); //Android自定义通知栏样式,取值:1-100'."\n"
.'pushRequest.setAndroidNotificationBarPriority(2); //Android通知在通知栏展示时排列位置的优先级 -2 -1 0 1 2'."\n"
.'pushRequest.setAndroidExtParameters("{\\"k1\\":\\"android\\",\\"k2\\":\\"v2\\"}"); //设定通知的扩展属性。(注意 : 该参数要以 json map 的格式传入,否则会解析出错)'."\n"
.'// 推送控制'."\n"
.'final Date pushDate = new Date(System.currentTimeMillis() + 3600 * 1000); //用于定时发送。不设置缺省是立即发送。时间格式按照ISO8601标准表示,并需要使用UTC时间,格式为`YYYY-MM-DDThh:mm:ssZ`。'."\n"
.'final String pushTime = ParameterHelper.getISO8601Time(pushDate);'."\n"
.'pushRequest.setPushTime(pushTime); // 延后推送。可选,如果不设置表示立即推送'."\n"
.'pushRequest.setStoreOffline(true); // 离线消息是否保存,若保存, 在推送时候,用户即使不在线,下一次上线则会收到,安卓中若为false则只走阿里云自有在线通道'."\n"
.'final String expireTime = ParameterHelper.getISO8601Time(new Date(System.currentTimeMillis() + 12 * 3600 * 1000)); // 12小时后消息失效, 不会再发送'."\n"
.'pushRequest.setExpireTime(expireTime);'."\n"
.'pushRequest.setSendChannels("accs,huawei,honor,vivo,xiaomi,oppo"); // 指定下发的推送通道,若不填可从任何可行的通道下发'."\n"
.'pushRequest.setAndroidNotificationNotifyId(1234567); // 设置通知覆盖参数,避免重试等场景用户显示多条相同的通知'."\n"
.'pushRequest.setAndroidTargetUserType(0); // 代表本次推送如果推送到华为、荣耀、vivo通道,是一个正式通知,但本代码示例中这个值被厂商通道特有参数所覆盖'."\n"
.'pushRequest.setAndroidHuaweiTargetUserType(1); // 代表本次推送如果推送到华为通道,是一个测试性质的通知'."\n"
.'pushRequest.setAndroidHonorTargetUserType(1); // 代表本次推送如果推送到荣耀通道,是一个测试性质的通知'."\n"
.'pushRequest.setAndroidVivoPushMode(1); // 代表本次推送如果推送到华为通道,是一个测试性质的通知,请在推送前把vivo设备regId加入vivo推送平台的测试设备列表中'."\n"
.'pushRequest.setAndroidHuaweiReceiptId("ABCDEFG"); // 华为厂商通道'."\n"
.'// 厂商通道通知分类'."\n"
.'pushRequest.setAndroidNotificationChannel("user_define"); // OPPO通道私信通道channel_id,以及通用安卓channel_id'."\n"
.'pushRequest.setAndroidNotificationXiaomiChannel("user_define"); //小米通道通知类型channel_id'."\n"
.'pushRequest.setAndroidNotificationHonorChannel("NORMAL"); // 荣耀通道消息分类参数,对应荣耀通道importance参数'."\n"
.'pushRequest.setAndroidMessageHuaweiCategory("ACCOUNT"); // 华为通道的通知分类参数,服务与通讯类通知需向华为通道申请权限'."\n"
.'pushRequest.setAndroidMessageVivoCategory("ACCOUNT"); // vivo通道的通知分类参数,系统消息需向vivo通道申请权限'."\n"
.'// 短信融合通知'."\n"
.'pushRequest.setSmsTemplateName("SMS_1234567"); // 设置短信模板名'."\n"
.'pushRequest.setSmsSignName("测试"); //设置短信签名'."\n"
.'pushRequest.setSmsParams("name=Bob&code=123"); // 短信模板变量'."\n"
.'pushRequest.setSmsSendPolicy(0); // 补发短信的策略,0 表示当设备未收到推送时补发'."\n"
.'pushRequest.setSmsDelaySecs(120); // 两分钟未收到触发短信'."\n"
.'PushResponse pushResponse = client.getAcsResponse(pushRequest);'."\n"
.'System.out.printf("RequestId: %s, MessageId: %s\\n",'."\n"
.' pushResponse.getRequestId(), pushResponse.getMessageId());'."\n"
.'```',
],
'MassPush' => [
'summary' => '批量给不同的设备推送不同的消息/通知。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '23267207',
],
],
[
'name' => 'PushTask',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => '独立推送任务组成的数组。',
'type' => 'array',
'items' => [
'description' => '独立推送任务。',
'type' => 'object',
'properties' => [
'PushType' => [
'description' => '推送类型。取值:'."\n"
."\n"
.'- MESSAGE:表示消息。'."\n"
.'- NOTICE:表示通知。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
'MESSAGE' => 'MESSAGE',
'NOTICE' => 'NOTICE',
],
'example' => 'MESSAGE',
],
'DeviceType' => [
'description' => '设备类型,取值范围为:'."\n"
."\n"
.'- HARMONY:鸿蒙设备'."\n"
.'- iOS:iOS设备'."\n"
.'- ANDROID:Android设备'."\n"
.'- ALL:当AppKey为旧版本双端应用时,代表同时推送Android和iOS设备;当AppKey为新版本单端应用时,效果和指定该应用类型对应的设备类型一样。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
'ALL' => 'ALL',
'ANDROID' => 'ANDROID',
'iOS' => 'iOS',
],
'example' => 'HARMONY',
],
'Target' => [
'description' => '推送目标。可取值:'."\n"
."\n"
.'- DEVICE:根据设备推送。'."\n"
.'- ACCOUNT:根据账号推送。'."\n"
.'- ALIAS:根据别名推送。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
'ACCOUNT' => 'ACCOUNT',
'ALIAS' => 'ALIAS',
'DEVICE' => 'DEVICE',
],
'example' => 'DEVICE',
],
'TargetValue' => [
'description' => '根据Target来设定,多个值使用逗号分隔,超过限制需要分多次推送。'."\n"
."\n"
.'- Target=DEVICE,值如`deviceid1,deviceid2`(最多支持1000个)。'."\n"
.'- Target=ACCOUNT,值如`account1,account2`(最多支持1000个)。'."\n"
.'- Target=ALIAS,值如`alias1,alias2`(最多支持1000个)。',
'type' => 'string',
'required' => true,
'example' => 'deviceid1,deviceid2',
],
'StoreOffline' => [
'description' => '离线消息/通知是否保存。StoreOffline默认设置为false。'."\n"
."\n"
.'若保存,在推送时候用户不在线,在过期时间(ExpireTime)内用户上线时会被再次发送。ExpireTime默认为72小时。iOS通知走APNs链路,不受StoreOffline影响。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'SendChannels' => [
'description' => '指定发送通道,取值如下:'."\n"
."\n"
.'- accs:阿里云自有通道'."\n"
.'- huawei:华为通道'."\n"
.'- honor:荣耀通道'."\n"
.'- xiaomi:小米通道'."\n"
.'- oppo:OPPO通道'."\n"
.'- vivo:vivo通道'."\n"
.'- meizu:魅族通道'."\n"
.'- gcm:谷歌GCM通道(旧版HTTP)'."\n"
.'- fcm: 谷歌Firebase通道(HTTP v1 API)'."\n"
.'- apns:APNs通道'."\n"
.'- harmony: 鸿蒙通道'."\n"
."\n"
.'>- 如果未配置此参数,则代表所有通道均可使用。'."\n"
.'>- 如果配置了此参数,则严格使用参数中的通道。'."\n"
.'>- 如果配置的通道和发送策略冲突(如iOS通知仅走APNs通道,但本参数中不包含apns),则不实施发送。'."\n"
.'>- 若配置gcm,则可以走谷歌GCM和FCM通道,若配置fcm,则只能走谷歌FCM通道。',
'type' => 'string',
'required' => false,
'example' => 'accs,huawei,xiaomi',
],
'PushTime' => [
'description' => '用于定时发送。不设置缺省是立即发送。'."\n"
."\n"
.'时间格式按照ISO8601标准表示,并需要使用UTC时间,格式为YYYY-MM-DDThh:mm:ssZ。',
'type' => 'string',
'required' => false,
'example' => '2019-02-20T00:00:00Z',
],
'ExpireTime' => [
'description' => '离线消息/通知的过期时间,和StoreOffline配合使用,过期则不会再被发送,最长保存72小时。默认为72小时。'."\n"
."\n"
.'时间格式按照ISO8601标准表示,并需要使用UTC时间,格式为YYYY-MM-DDThh:mm:ssZ,过期时间不能小于当前时间或者定时发送时间加上3秒(`ExpireTime > PushTime+3秒`),3秒是为了冗余网络和系统延迟造成的误差。建议单推不小于1分钟,全推、批量推送不少于10分钟。',
'type' => 'string',
'required' => false,
'example' => '2019-02-20T00:00:00Z',
],
'JobKey' => [
'description' => '推送任务自定义标识,当JobKey不为空时,回执日志中会附带该字段。查看回执日志参见[回执日志](~~434651~~)。',
'type' => 'string',
'required' => false,
'example' => '123',
],
'Title' => [
'description' => '推送时通知/消息的标题,长度限制:200字节。'."\n"
.'在Android推送和Harmony推送时必填;在iOS推送通知时非必填,如果填写,则:'."\n"
.'* iOS 10+通知显示标题。'."\n"
.'* iOS 8.2 <= iOS系统 < iOS 10:替换通知应用名称。',
'type' => 'string',
'required' => false,
'example' => 'title',
],
'Body' => [
'description' => 'Android和Harmony推送时通知的内容/消息的内容;iOS消息/通知内容,推送的内容大小是有限制的,参见[产品限制](~~92832~~)。',
'type' => 'string',
'required' => false,
'example' => 'hello',
],
'Trim' => [
'description' => '是否自动对过长标题、内容进行截断。'."\n"
.'注:仅支持明确限制标题、内容的厂商通道,对APNs、华为、荣耀通道等不限制标题、内容,只限制总请求体大小的不适用。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
'iOSApnsEnv' => [
'description' => 'iOS的通知是通过APNs中心来发送的,需要填写对应的环境信息。'."\n"
."\n"
.'- DEV:开发环境,适用于Xcode直接安装调试的应用。'."\n"
.'- PRODUCT:生产环境,适用于 App Store、TestFlight、Ad Hoc 及企业分发的应用。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'DEV' => 'DEV',
'PRODUCT' => 'PRODUCT',
],
'example' => 'DEV',
],
'iOSRemind' => [
'description' => '消息推送时设备不在线(即与移动推送的服务端的长连接通道不通),则这条推送会做为通知,通过苹果的APNs通道送达一次。'."\n"
."\n"
.'> 离线消息转通知仅适用于生产环境。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'iOSSubtitle' => [
'description' => 'iOS通知副标题内容(iOS 10+)。',
'type' => 'string',
'required' => false,
'example' => 'subtitle',
],
'iOSRemindBody' => [
'description' => 'iOS消息转通知时使用的iOS通知内容,仅当iOSApnsEnv=PRODUCT && iOSRemind为true时有效。',
'type' => 'string',
'required' => false,
'example' => 'ios通知body',
],
'iOSMusic' => [
'description' => 'iOS通知声音。指定存放在app bundle或沙盒Library/Sounds目录下的音频文件名,请参见:iOS推送如何设定通知声音。'."\n"
."\n"
.'若指定为空串(””),通知为静音;若不设置,默认填充default为系统提示音。',
'type' => 'string',
'required' => false,
'example' => '””',
],
'iOSBadge' => [
'description' => 'iOS应用图标右上角角标。'."\n"
."\n"
.'> 若iOSBadgeAutoIncrement设置为True,则此项必须为空。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
'iOSBadgeAutoIncrement' => [
'description' => '是否开启角标自增功能,默认为false。'."\n"
."\n"
.'>当该项为true时,iOSBadge必须为空。'."\n"
."\n"
.'角标自增功能由推送服务端维护每个设备的角标计数,需要用户使用V1.9.5以上版本的SDK,并且需要用户主动同步角标数字到服务端。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'iOSSilentNotification' => [
'description' => '是否开启iOS静默通知。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'iOSMutableContent' => [
'description' => 'iOS通知处理扩展标记(iOS 10+)。如果设为true,则APNs推送的通知在弹出前,可先到达Extension进行处理。静默通知时,必须设为true。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'iOSNotificationCategory' => [
'description' => '指定iOS通知Category(iOS 10+)。',
'type' => 'string',
'required' => false,
'example' => 'ios',
],
'iOSNotificationCollapseId' => [
'description' => '设备收到有相同CollapseId的消息,会合并成一条。设备不在线,连续发相同CollapseId的消息,通知栏只会显示一条,iOS 10+支持设置此参数。',
'type' => 'string',
'required' => false,
'example' => 'ZD2011',
],
'iOSNotificationThreadId' => [
'description' => '通过该属性对iOS的远程通知进行分组,标记折叠的组别识别名。仅支持iOS 12.0+版本。',
'type' => 'string',
'required' => false,
'example' => 'abc',
],
'iOSInterruptionLevel' => [
'description' => '中断级别,取值:'."\n"
."\n"
.'- passive:系统在不点灯、不播放声音的情况下将通知添加到通知列表中。'."\n"
."\n"
.'- active:系统立即显示通知,点亮屏幕,并可以播放声音。'."\n"
."\n"
.'- time-sensitive:系统立即呈现通知,点亮屏幕,并可以播放声音,但不会突破系统通知控制。'."\n"
."\n"
.'- critical:系统立即显示通知,屏幕亮起,并绕过静音开关播放声音。'."\n",
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'critical' => 'critical',
'time-sensitive' => 'time-sensitive',
'active' => 'active',
'passive' => 'passive',
],
'example' => 'active',
],
'iOSRelevanceScore' => [
'description' => '摘要突出显示分数。取值范围:\\[0,1\\]的浮点数。',
'type' => 'number',
'format' => 'double',
'required' => false,
'example' => '0.01',
],
'iOSExtParameters' => [
'description' => 'iOS通知的扩展属性。'."\n"
."\n"
.'iOS10+可以在此指定富媒体推送通知的资源Url:`{"attachment": "https://xxxx.xxx/notification_pic.png"} `。该参数要以JSON map的格式传入,否则会解析出错。',
'type' => 'string',
'required' => false,
'example' => '{"attachment": "https://xxxx.xxx/notification_pic.png"} ',
],
'iOSLiveActivityEvent' => [
'description' => '启动、更新、结束实时活动。'."\n"
."\n"
.'- 枚举:start | update | end',
'type' => 'string',
'required' => false,
'example' => 'start',
'enum' => [
'start',
'update',
'end',
],
],
'iOSLiveActivityId' => [
'description' => '由设备上报到用户服务器的Live Activity ID,Live Activity的唯一标识符。',
'type' => 'string',
'required' => false,
'example' => '66B94673-B32E-4CA7-863C-3E523054FD46',
],
'iOSLiveActivityAttributesType' => [
'description' => '待启动的Live Activity类型。'."\n"
.'> iOSLiveActivityEvent为start时必填',
'type' => 'string',
'required' => false,
'example' => 'OrderActivityAttributes',
],
'iOSLiveActivityAttributes' => [
'description' => 'JSON字符串,灵动岛推送透传静态参数。包含静态的用户自定义信息,如产品编号、订单信息等。'."\n"
."\n"
.'> iOSLiveActivityEvent为start时必填',
'type' => 'string',
'required' => false,
'example' => '{"orderId": "12345", "product": "Shoes"}',
],
'iOSLiveActivityContentState' => [
'description' => '灵动岛推送透传动态参数,包含实时更新信息,如价格、库存变化等',
'type' => 'string',
'required' => false,
'example' => '{"status": "delivered", "estimatedArrival": "2023-12-31T12:00:00Z"}',
],
'iOSLiveActivityDismissalDate' => [
'description' => '结束的Live Activity在锁屏上会保留到该指定时间,最长为4小时。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1743131967',
],
'iOSLiveActivityStaleDate' => [
'description' => '秒级时间戳,标记该活动的内容过期时间。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1743131967',
],
'AndroidNotifyType' => [
'description' => '通知的提醒方式。可取值:'."\n"
."\n"
.'- **VIBRATE**:振动(默认值)'."\n"
.'- **SOUND**:声音'."\n"
.'- **BOTH**:声音和振动'."\n"
.'- **NONE**:静音',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'SOUND' => 'SOUND',
'NONE' => 'NONE',
'VIBRATE' => 'VIBRATE',
'BOTH' => 'BOTH',
],
'example' => 'VIBRATE',
],
'AndroidRemind' => [
'description' => '推送类型为消息时设备不在线,则这条推送会使用辅助弹窗功能。默认值为false,仅当PushType=MESSAGE时生效。'."\n"
."\n"
.'如果消息转通知推送成功,收到通知是展示的数据为服务端设置的AndroidPopupTitle和AndroidPopupBody参数值,点击通知在辅助弹窗的onSysNoticeOpened方法中获取到的数据是服务端设置的Title和Body参数值。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'AndroidOpenType' => [
'description' => '点击通知后动作。可取值:'."\n"
."\n"
.'- APPLICATION:打开应用(默认值)'."\n"
.'- ACTIVITY:打开应用AndroidActivity'."\n"
.'- URL:打开URL'."\n"
.'- NONE:无跳转',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'APPLICATION' => 'APPLICATION',
'NONE' => 'NONE',
'ACTIVITY' => 'ACTIVITY',
'URL' => 'URL',
],
'example' => 'APPLICATION',
],
'AndroidActivity' => [
'description' => '设定通知打开的activity。'."\n"
."\n"
.'仅当PushTask.N.AndroidOpenType=”Activity”时传入,如:`com.alibaba.cloudpushdemo.bizactivity`。',
'type' => 'string',
'required' => false,
'example' => 'com.alibaba.cloudpushdemo.bizactivity',
],
'AndroidOpenUrl' => [
'description' => 'Android收到推送后打开对应的url。仅当PushTask.N.AndroidOpenType=”URL”时传入。',
'type' => 'string',
'required' => false,
'example' => 'https://xxxx.xxx',
],
'AndroidPopupActivity' => [
'description' => '指定点击通知后跳转的Activity。',
'type' => 'string',
'required' => false,
'example' => 'com.alibaba.cloudpushdemo.bizactivity',
],
'AndroidPopupTitle' => [
'description' => '辅助弹窗模式下标题内容。AndroidPopupActivity参数不为空时,该参数必填。 '."\n"
."\n"
.'长度限制:50个字符,中英文都算一个字符。'."\n"
."\n"
.'如使用厂商通道,则需同时符合厂商通道的限制,具体内容参见:[Android端辅助通道推送限制](~~165253~~)。',
'type' => 'string',
'required' => false,
'example' => 'hello',
],
'AndroidPopupBody' => [
'description' => '辅助弹窗模式下Body内容。AndroidPopupActivity参数不为空时,该参数必填。'."\n"
."\n"
.'长度限制:200个字符,中英文都算一个字符。'."\n"
."\n"
.'如使用厂商通道,则需同时符合厂商通道的限制,具体内容参见:[Android端辅助通道推送限制](~~165253~~)。',
'type' => 'string',
'required' => false,
'example' => 'hello',
],
'AndroidRenderStyle' => [
'description' => '通知样式,取值为:'."\n"
.'- **0**:标准模式(默认)'."\n"
.'- **1**:长文本模式(支持华为、荣耀、小米、OPPO、魅族、自有通道)'."\n"
.'- **2**:大图模式(支持自有通道,不支持小米机型)'."\n"
.'- **3**:列表模式(支持华为、荣耀、小米、OPPO、自有通道)'."\n"
.'> 若使用非标准模式,此参数必须提供。',
'type' => 'string',
'required' => false,
'example' => '1',
],
'AndroidBigTitle' => [
'description' => '长文本模式下的标题,长度限制:200个字节(1个汉字算作3字节)。'."\n"
."\n"
.'- 当前仅支持荣耀通道和华为通道EMUI11及以上版本。'."\n"
."\n"
.'- 若长文本模式下未提供此参数,则从Title、AndroidPopupTitle里取第一个非空值。',
'type' => 'string',
'required' => false,
'example' => '示例长标题',
],
'AndroidBigBody' => [
'description' => '长文本模式下的body,长度限制:1000字节(1个汉字算作3字节),发送时受具体厂商通道的限制。'."\n"
."\n"
.'当前支持:'."\n"
.'- 华为:EMUI10及以上'."\n"
.'- 荣耀:Magic UI 4.0及以上'."\n"
.'- 小米:MIUI10及以上'."\n"
.'- OPPO:ColorOS5.0以上'."\n"
.'- 魅族:Flyme'."\n"
.'- 自有通道:安卓SDK3.6.0及以上'."\n"
."\n"
.'若长文本模式下未提供此参数,则从Body、AndroidPopupBody里取第一个非空值。',
'type' => 'string',
'required' => false,
'example' => '示例长文本',
],
'AndroidBigPictureUrl' => [
'description' => '大图模式下的图片URL,当前支持:自有通道:安卓SDK3.6.0及以上。',
'type' => 'string',
'required' => false,
'example' => 'https://imag.example.com/image.png',
],
'AndroidXiaomiBigPictureUrl' => [
'description' => '该参数已废弃,小米从 2023.08 开始,官方在新设备/系统已经不再支持推送时动态设置小图标、右侧图标、大图片功能。',
'type' => 'string',
'deprecated' => true,
'required' => false,
'example' => 'https://f6.market.xiaomi.com/download/MiPass/aaa/bbb.png',
],
'AndroidImageUrl' => [
'description' => '大图标URL。当前支持:'."\n"
.'- 华为EMUI(仅长文本模式、Inbox模式下适用)'."\n"
.'- 荣耀Magic UI(仅长文本模式下适用)'."\n"
.'- 自有通道:安卓SDK3.5.0及以上'."\n",
'type' => 'string',
'required' => false,
'example' => 'https://imag.example.com/image.png',
],
'AndroidXiaomiImageUrl' => [
'description' => '该参数已废弃,小米从 2023.08 开始,官方在新设备/系统已经不再支持推送时动态设置小图标、右侧图标、大图片功能。',
'type' => 'string',
'deprecated' => true,
'required' => false,
'example' => 'https://imag.example.com/image.png',
],
'AndroidInboxBody' => [
'description' => 'Inbox模式下的正文,内容为合法的JSON Array,且元素不超过5个。当前支持:'."\n"
."\n"
.'- 华为:EMUI9及以上'."\n"
.'- 荣耀:Magic UI 4.0及以上'."\n"
.'- 小米:MIUI10及以上'."\n"
.'- OPPO:ColorOS 5.0以上'."\n"
.'- 自有通道:安卓SDK3.6.0及以上',
'type' => 'string',
'required' => false,
'example' => '["第一行","第二行"]',
],
'AndroidNotificationBarType' => [
'description' => 'Android自定义通知栏样式,取值:1-100。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
'AndroidNotificationBarPriority' => [
'description' => 'Android通知在通知栏展示时排列位置的优先级。可取值: -2,-1,0,1,2。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
'AndroidNotificationNotifyId' => [
'description' => '标识每条消息在通知显示时的唯一标识,不同的通知栏消息可以相同的NotifyId,实现新的通知栏消息覆盖老的,当前支持除FCM通道外的其他厂商通道。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '100001',
],
'AndroidNotificationChannel' => [
'description' => 'Android app的channelId,需要与app中的channelId能对应上。'."\n"
.'- 设置NotificationChannel参数,具体用途请参见[常见问题:Android 8.0以上设备通知接收不到](~~67398~~)。'."\n"
.'- 因OPPO通知私信通道的channel_id与app的channelId相同,故OPPO通道推送时,channel_id取此值。'."\n"
.'- 华为、FCM、阿里云自有通道推送中,channel_id取此值。',
'type' => 'string',
'required' => false,
'example' => '1',
],
'AndroidNotificationHuaweiChannel' => [
'description' => '设置Huawei通知消息分类importance参数,决定用户设备消息通知行为,取值如下:'."\n"
."\n"
.'- LOW:资讯营销类消息'."\n"
.'- NORMAL:服务与通讯类消息'."\n"
."\n"
.'>- 当前华为通道建议使用AndroidMessageHuaweiCategory进行通知分类,可不再使用AndroidNotificationHuaweiChannel。'."\n"
.'>- 需要在Huawei平台申请,[申请链接](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#section893184112272)。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'LOW' => 'LOW',
'NORMAL' => 'NORMAL',
],
'example' => 'LOW',
],
'AndroidNotificationHonorChannel' => [
'description' => '设置荣耀通知消息分类importance参数,决定用户设备消息通知行为,取值如下:'."\n"
."\n"
.'- LOW:资讯营销类消息'."\n"
."\n"
.'- NORMAL:服务与通讯类消息'."\n"
."\n"
.'需要在荣耀平台申请,[申请链接](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' => 'string',
'required' => false,
'enumValueTitles' => [
'LOW' => 'LOW',
'NORMAL' => 'NORMAL',
],
'example' => 'LOW',
],
'AndroidNotificationXiaomiChannel' => [
'description' => '设置小米通知类型的channelId,需要在小米平台申请,详见:[申请链接](https://dev.mi.com/console/doc/detail?pId=2422#_4)。'."\n"
.'>- 小米通道单个应用最多可申请8个channel,请提前做好规划。',
'type' => 'string',
'required' => false,
'example' => 'michannel',
],
'AndroidNotificationVivoChannel' => [
'description' => '设置vivo通知消息分类,取值为:'."\n"
."\n"
.'- 0:运营类消息(默认)'."\n"
.'- 1:系统类消息'."\n"
."\n"
.'>- 当前vivo通道建议使用AndroidMessageVivoCategory进行通知分类,可不再使用AndroidNotificationVivoChannel。'."\n"
.'>- 需要在vivo平台申请,详见:[申请链接](https://dev.vivo.com.cn/documentCenter/doc/359)。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'0',
'1',
],
'example' => '0',
],
'AndroidNotificationGroup' => [
'description' => '消息分组,同一组消息在通知栏里只显示最新一条和当前该组接受到的消息总数目,不会展示所有消息也无法展开。当前支持:'."\n"
."\n"
.'- 华为'."\n"
.'- 荣耀'."\n"
.'- 自有通道',
'type' => 'string',
'required' => false,
'example' => 'group-1',
],
'AndroidNotificationThreadId' => [
'description' => '消息分组,同一组消息在通知栏里折叠展示,可展开,不同组通知分开展示。当前支持:'."\n"
."\n"
.'- 自有通道 安卓 SDK3.9.2 及以上',
'type' => 'string',
'required' => false,
'example' => 'thread-1',
],
'AndroidExtParameters' => [
'description' => '设定通知的扩展属性。当推送类型PushType设置为MESSAGE消息类型时,该属性不生效。'."\n"
."\n"
.'该参数要以JSON map的格式传入,否则会解析出错。',
'type' => 'string',
'required' => false,
'example' => '{"key1":"value1","api_name":"PushNoticeToAndroidRequest"}',
],
'AndroidMessageHuaweiUrgency' => [
'description' => '华为通道透传消息投递优先级,取值如下:'."\n"
."\n"
.'- HIGH'."\n"
."\n"
.'- NORMAL'."\n"
."\n"
.'需要申请权限,具体请参见:[申请链接](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/faq-0000001050042183#section037425218509)。'."\n",
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'HIGH' => 'HIGH',
'NORMAL' => 'NORMAL',
],
'example' => 'HIGH',
],
'AndroidMessageHuaweiCategory' => [
'description' => '作用一:完成[自分类权益申请](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835?#section3410731125514)后,用于标识消息类型,确定[消息提醒方式](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#ZH-CN_TOPIC_0000001149358835__p3850133955718),对特定类型消息加快发送,取值请参考华为推送官方文档的[消息分类标准](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835#section1076611477914),填写文档表格中的“云端通知category取值”或“本地通知category取值”。'."\n"
."\n"
.'作用二:[申请特殊权限](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/faq-0000001050042183#section037425218509)后,用于标识高优先级透传场景,取值如下:'."\n"
.'- VOIP:音视频通话'."\n"
.'- PLAY_VOICE:语音播报'."\n"
."\n"
.'> 对于“云端通知category取值”为“不涉及”的一概走阿里云自有通道,对于“本地通知category取值”为“不涉及”的一概走华为通道。',
'type' => 'string',
'required' => false,
'example' => 'SUBSCRIPTION',
],
'AndroidMessageOppoCategory' => [
'description' => 'OPPO将消息分类:通讯与服务、内容与营销两个类别进行管理。'."\n"
."\n"
.'通讯与服务(需申请权限):'."\n"
.'- IM:即时聊天、音频、视频通话'."\n"
.'- ACCOUNT:个人账号与资产变化'."\n"
.'- DEVICE_REMINDER:个人设备提醒'."\n"
.'- ORDER:个人订单/物流状态变化'."\n"
.'- TODO:个人日程/待办'."\n"
.'- SUBSCRIPTION:个人订阅'."\n"
."\n"
.'内容与营销:'."\n"
.'- NEWS:新闻资讯'."\n"
.'- CONTENT:内容推荐'."\n"
.'- MARKETING:平台活动'."\n"
.'- SOCIAL:社交动态'."\n"
."\n"
.'详细请参考[OPUSH消息分类细则](https://open.oppomobile.com/new/developmentDoc/info?id=13189)',
'type' => 'string',
'required' => false,
'example' => 'MARKETING',
],
'AndroidMessageOppoNotifyLevel' => [
'description' => 'OPPO通道通知栏消息提醒等级。可取值为:'."\n"
.'- 1:通知栏'."\n"
.'- 2:通知栏、锁屏、铃声、振动(通讯与服务类消息默认通知级别)'."\n"
.'- 16:通知栏、锁屏、铃声、振动、横幅(需申请权限)'."\n"
."\n"
.'> 使用AndroidMessageOppoNotifyLevel参数时,必须同时传AndroidMessageOppoCategory参数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'AndroidMessageVivoCategory' => [
'description' => 'vivo将消息分为:系统消息、运营消息两个类别进行管理。 '."\n"
."\n"
.'系统消息:'."\n"
.'- IM:即时消息'."\n"
.'- ACCOUNT:账号与资产'."\n"
.'- TODO:日程待办'."\n"
.'- DEVICE_REMINDER:设备信息'."\n"
.'- ORDER:订单与物流'."\n"
.'- SUBSCRIPTION:订阅提醒'."\n"
."\n"
.'运营消息:'."\n"
.'- NEWS:新闻'."\n"
.'- CONTENT:内容推荐'."\n"
.'- MARKETING:运营活动'."\n"
.'- SOCIAL:社交动态'."\n"
.'> 详细请参考[分类说明](https://dev.vivo.com.cn/documentCenter/doc/359#s-ef3qugc3)',
'type' => 'string',
'required' => false,
'example' => 'TODO',
],
'AndroidTargetUserType' => [
'description' => '设置厂商通道通知类型:'."\n"
.'- **0**:正式通知(默认)。'."\n"
.'- **1**:测试通知。'."\n"
."\n"
.'>- 本参数配置后等价于同时配置AndroidHuaweiTargetUserType、AndroidHonorTargetUserType、AndroidVivoPushMode、AndroidOppoIntentEnv四个参数,具体厂商通道的对应参数能覆盖本参数。'."\n"
.'>- 当前支持:华为通道、荣耀通道、vivo通道、OPPO流体云。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'enum' => [
'0',
'1',
],
],
'AndroidHuaweiTargetUserType' => [
'description' => '设置华为通道通知类型:'."\n"
.'- **0**:正式通知(默认)。'."\n"
.'- **1**:测试通知。'."\n"
."\n"
.'> 每个应用每日可发送该测试通知500条且不受每日单设备推送数量上限要求。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => [
'0',
'1',
],
'example' => '1',
'enum' => [
'0',
'1',
],
],
'AndroidHonorTargetUserType' => [
'description' => '设置荣耀通道通知类型:'."\n"
.'- **0**:正式通知(默认)。'."\n"
.'- **1**:测试通知。'."\n"
."\n"
.'> 每个应用每日可发送该测试通知1000条且不受每日单设备推送数量上限要求。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'enum' => [
'0',
'1',
],
],
'AndroidVivoPushMode' => [
'description' => '设置vivo通道通知类型:'."\n"
.'- **0**:正式推送(默认)。'."\n"
.'- **1**:测试推送。'."\n"
."\n"
.'> 测试推送请事先在vivo控制台配置测试设备。测试设备RegId可在设备启动日志中搜索“onReceiveRegId regId”获得。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => [
'0',
'1',
],
'example' => '1',
'enum' => [
'0',
'1',
],
],
'AndroidOppoIntentEnv' => [
'description' => '设置OPPO流体云推送环境'."\n"
.'- **0**:正式环境(默认)。'."\n"
.'- **1**:测试环境。'."\n"
."\n"
.'> OPPO流体云测试环境需要参考[环境搭建](https://open.oppomobile.com/documentation/page/info?id=13590)在客户端搭建',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'enum' => [
'0',
'1',
],
],
'AndroidHuaweiBusinessType' => [
'description' => '设置华为快通知参数'."\n"
.'- **0**:发送华为普通通知(默认)。'."\n"
.'- **1**:发送华为快通知。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'enum' => [
'0',
'1',
],
],
'AndroidHuaweiReceiptId' => [
'description' => '华为通道回执ID,该回执ID可以在华为通道推送运营平台的回执参数配置中查看。'."\n"
."\n"
.'> 如果在华为通道推送运营平台配置的默认回执配置是阿里云回执,则无需提供,如果不是,建议优先在阿里云EMAS移动推送控制台中配置华为通道默认回执ID。',
'type' => 'string',
'required' => false,
'example' => 'RCP4C123456',
],
'AndroidVivoReceiptId' => [
'description' => 'vivo通道回执ID,该回执ID可以在vivo开放平台推送服务的应用信息中查看。'."\n"
."\n"
.'> 如果在vivo开放平台配置的默认回执配置是阿里云回执,则无需提供,如果不是,建议优先在阿里云EMAS移动推送控制台中配置vivo通道默认回执ID。',
'type' => 'string',
'required' => false,
'example' => '123',
],
'AndroidBadgeClass' => [
'description' => '角标设置应用入口Activity的全类名'."\n"
."\n"
.'> 仅华为/荣耀产商通道推送时有效',
'type' => 'string',
'required' => false,
'example' => 'com.alibaba.cloudpushdemo.bizactivity'."\n",
],
'AndroidBadgeAddNum' => [
'description' => '设置角标累加值,在原角标的基础上进行累加,取值范围[1~99]。'."\n"
.'> 仅华为/荣耀厂商通道推送时有效。AndroidBadgeAddNum 与 AndroidBadgeSetNum 同时存在时,以AndroidBadgeSetNum为准',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '1',
],
'AndroidBadgeSetNum' => [
'description' => '设置角标数字固定值,取值范围[0~99]。'."\n"
."\n"
.'> 厂商通道推送时仅华为、荣耀通道生效。 阿里云自有通道推送时仅华为机型、荣耀机型与vivo机型上生效。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '5',
'default' => '0',
],
'AndroidMusic' => [
'description' => '华为厂商通道通知声音。指定存放在客户端项目 app/src/main/res/raw/目录下的音频文件名,不需要携带文件格式后缀名。'."\n"
."\n"
.'若不设置,则使用默认铃声。',
'type' => 'string',
'required' => false,
'example' => 'alicloud_notification_sound',
],
'HarmonyRemind' => [
'description' => '推送类型为消息时设备不在线,则这条推送会使用辅助弹窗功能。默认值为false,仅当PushType=MESSAGE时生效。'."\n"
."\n"
.'如果消息转通知推送成功,收到通知是展示的数据为服务端设置的HarmonyRemindTitle和HarmonyRemindBody参数值。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
'HarmonyRemindTitle' => [
'description' => 'Harmony消息转通知时使用的Harmony通知标题,仅当HarmonyRemind为true时有效。',
'type' => 'string',
'required' => false,
'example' => '新消息',
],
'HarmonyRemindBody' => [
'description' => 'Harmony消息转通知时使用的Harmony通知内容,仅当HarmonyRemind为true时有效。',
'type' => 'string',
'required' => false,
'example' => '您有一条新消息,请查收',
],
'HarmonyCategory' => [
'description' => '通知消息类别。完成申请通知消息自分类权益后,用于标识消息类型,不同的通知消息类型影响消息展示和提醒方式。取值如下:'."\n"
."\n"
.'- IM:即时聊天'."\n"
.'- VOIP:音视频通话'."\n"
.'- SUBSCRIPTION:订阅'."\n"
.'- TRAVEL:出行'."\n"
.'- HEALTH:健康'."\n"
.'- WORK:工作事项提醒'."\n"
.'- ACCOUNT:账号动态'."\n"
.'- EXPRESS:订单&物流'."\n"
.'- FINANCE:财务'."\n"
.'- DEVICE_REMINDER:设备提醒'."\n"
.'- MAIL:邮件'."\n"
.'- CUSTOMER_SERVICE:客服消息'."\n"
.'- MARKETING:新闻、内容推荐、社交动态、产品促销、财经动态、生活资讯、调研、功能推荐、运营活动(仅对内容进行标识,不会加快消息发送),统称为资讯营销类消息'."\n"
."\n"
.'详情参见鸿蒙官网 [Notification.category](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section17371529101117)',
'type' => 'string',
'required' => false,
'example' => 'IM',
'enum' => [
'IM',
'VOIP',
'SUBSCRIPTION',
'TRAVEL',
'HEALTH',
'WORK',
'ACCOUNT',
'EXPRESS',
'FINANCE',
'DEVICE_REMINDER',
'MAIL',
'CUSTOMER_SERVICE',
'MARKETING',
],
],
'HarmonyNotificationSlotType' => [
'description' => '使用指定类型的通知渠道。仅在阿里云自有通道在线时有效。'."\n"
."\n"
.'- SOCIAL_COMMUNICATION: 社交通信。'."\n"
.'- SERVICE_INFORMATION: 服务提醒。'."\n"
.'- CONTENT_INFORMATION: 内容资讯。'."\n"
.'- CUSTOMER_SERVICE: 客服消息。该类型用于用户与商家之间的客服消息,需由用户主动发起。'."\n"
.'- OTHER_TYPES: 其他。'."\n"
."\n"
.'详情参见鸿蒙官网 [SlotType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/js-apis-notificationmanager-V5#slottype)',
'type' => 'string',
'required' => false,
'example' => 'SOCIAL_COMMUNICATION',
'enum' => [
'SOCIAL_COMMUNICATION',
'SERVICE_INFORMATION',
'CONTENT_INFORMATION',
'CUSTOMER_SERVICE',
'OTHER_TYPES',
],
],
'HarmonyNotifyId' => [
'description' => '每条消息在通知显示时的唯一标识。不携带时,推送服务自动为每条消息生成一个唯一标识;不同的通知消息可以拥有相同的notifyId,实现新消息覆盖旧消息功能。'."\n"
."\n"
.'详情参见鸿蒙官网 [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',
],
'HarmonyActionType' => [
'description' => '点击通知后动作。可取值:'."\n"
."\n"
.'- APP_HOME_PAGE:打开应用首页'."\n"
.'- APP_CUSTOM_PAGE:打开应用自定义页面',
'type' => 'string',
'required' => false,
'example' => 'APP_HOME_PAGE',
'enum' => [
'APP_HOME_PAGE',
'APP_CUSTOM_PAGE',
],
],
'HarmonyAction' => [
'description' => '应用内置页面ability对应的action。'."\n"
."\n"
.'><notice>当HarmonyActionType为APP_CUSTOM_PAGE时,字段HarmonyUri和HarmonyAction至少填写一个。></notice>'."\n"
."\n"
.'详情参见鸿蒙官网 [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',
],
'HarmonyUri' => [
'description' => '应用内置页面ability对应的uri。'."\n"
.'><notice>当HarmonyActionType为APP_CUSTOM_PAGE时,字段HarmonyUri和HarmonyAction至少填写一个。当存在多个Ability时,分别填写不同Ability的action和uri,优先使用action查找对应的应用内置页面。></notice>'."\n"
."\n"
.'详情参见鸿蒙官网 [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',
],
'HarmonyRenderStyle' => [
'description' => '通知消息样式:'."\n"
.'- NORMAL: 普通通知(默认值)'."\n"
.'- MULTI_LINE: 多行文本样式',
'type' => 'string',
'required' => false,
'example' => 'NORMAL',
'enum' => [
'NORMAL',
'MULTI_LINE',
],
],
'HarmonyImageUrl' => [
'description' => '通知右侧大图标URL,URL使用的协议必须是HTTPS协议。'."\n"
."\n"
.'> 支持图片格式为png、jpg、jpeg、heif、gif、bmp,图片长*宽<25000像素。'."\n"
."\n"
.'详情参见鸿蒙官网 [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',
],
'HarmonyInboxContent' => [
'description' => '多行文本样式的内容,当HarmonyRenderStyle为MULTI_LINE时,本字段必填,最多支持3条内容。',
'type' => 'string',
'required' => false,
'example' => '["1.content1","2.content2","3.content3"]'."\n",
],
'HarmonyExtParameters' => [
'description' => '设定通知的扩展属性。当推送类型PushType设置为MESSAGE消息类型时,该属性不生效。'."\n"
."\n"
.'该参数要以JSON map的格式传入,否则会解析出错。',
'type' => 'string',
'required' => false,
'example' => '{"key1":"value1","api_name":"PushNoticeToAndroidRequest"}'."\n",
],
'HarmonyTestMessage' => [
'description' => '测试消息标识:'."\n"
."\n"
.'- false:正常消息(默认值)'."\n"
.'- true:测试消息'."\n"
."\n"
.'详情参见鸿蒙官网 [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',
],
'HarmonyReceiptId' => [
'description' => '鸿蒙通道回执ID,该回执ID可以在鸿蒙通道推送运营平台的回执参数配置中查看。'."\n"
."\n"
.'> 如果在鸿蒙通道推送运营平台配置的默认回执配置是阿里云回执,则无需提供,如果不是,建议优先在阿里云EMAS移动推送控制台中配置鸿蒙通道默认回执ID。'."\n"
."\n"
.'详情参见鸿蒙官网 [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",
],
'HarmonyExtensionPush' => [
'description' => 'PushType为NOTICE时,是否为鸿蒙通知扩展消息。'."\n"
."\n"
.'- true:发送通知扩展消息'."\n"
.'- false:发送普通通知(默认值)'."\n"
."\n"
.'通知扩展消息需要先在鸿蒙侧申请权限才能发送,相关内容请参考鸿蒙文档[发送通知扩展消息](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/push-send-extend-noti-V5)。</br>'."\n"
.'鸿蒙SDK1.2.0版本开始支持。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'HarmonyExtensionExtraData' => [
'description' => '通知扩展消息的额外数据。</br>'."\n"
.'发送鸿蒙通知扩展消息时有效。</br>'."\n"
.'概念上等同鸿蒙通知扩展消息的extraData字段,具体定义参考[鸿蒙ExtensionPayload说明](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section161192514234)。</br>'."\n"
.'鸿蒙SDK1.2.0版本开始支持。',
'type' => 'string',
'required' => false,
'example' => '示例额外数据',
],
'HarmonyBadgeAddNum' => [
'description' => '鸿蒙应用角标累加数字。参考[鸿蒙角标addNum字段说明](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section266310382145)。</br>'."\n"
.'鸿蒙SDK1.2.0版本开始支持。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'HarmonyBadgeSetNum' => [
'description' => '鸿蒙应用角标设置数字。参考[鸿蒙角标setNum字段说明](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/push-scenariozed-api-request-param-V5#section266310382145)。</br>'."\n"
.'鸿蒙SDK1.2.0版本开始支持。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'SendSpeed' => [
'description' => '该参数已废弃。',
'type' => 'integer',
'format' => 'int32',
'deprecated' => true,
'required' => false,
'example' => '0',
],
'AndroidXiaoMiNotifyTitle' => [
'description' => '该参数已废弃,所有第三方辅助弹窗都由新参数**AndroidPopupTitle**统一支持。',
'type' => 'string',
'deprecated' => true,
'required' => false,
'example' => '无',
],
'AndroidXiaoMiNotifyBody' => [
'description' => '该参数已废弃,所有第三方辅助弹窗都由新参数**AndroidPopupBody**统一支持。',
'type' => 'string',
'deprecated' => true,
'required' => false,
'example' => '无',
],
'AndroidXiaoMiActivity' => [
'description' => '该参数已废弃,所有第三方辅助弹窗都由新参数**AndroidPopupActivity**统一支持。',
'type' => 'string',
'deprecated' => true,
'required' => false,
'example' => '无',
],
'AndroidMeizuNoticeMsgType' => [
'description' => '魅族消息类型'."\n"
."\n"
.'- 0 公信消息(默认)'."\n"
.'- 1 私信消息',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => [
'公信消息(默认)',
'私信消息',
],
'example' => '0',
'enum' => [
'0',
'1',
],
],
'AndroidOppoPrivateMsgTemplateId' => [
'title' => 'Oppo私信模板ID,已废弃,如需使用请使用Push接口,或升级MassPushV2',
'description' => 'OPPO 私信模板 ID'."\n"
."\n"
.'><warning>OPPO 私信模板功能已不再由 MaasPush 支持。如需使用该功能,请改用 Push、PushV2 或 MassPushV2 接口></warning>',
'type' => 'string',
'deprecated' => true,
'required' => false,
'example' => '687557242b1634hzef3zd5013',
],
'AndroidOppoPrivateTitleParameters' => [
'title' => 'Oppo私信模板title参数,已废弃,如需使用请使用Push接口,或升级MassPushV2',
'description' => 'OPPO 私信模版标题参数',
'type' => 'object',
'deprecated' => true,
'required' => false,
'additionalProperties' => [
'type' => 'string',
'description' => 'OPPO 私信模版标题中的变量名,变量值',
'example' => 'my_title',
],
],
'AndroidOppoPrivateContentParameters' => [
'title' => 'Oppo私信模板content参数,已废弃,如需使用请使用Push接口,或升级MassPushV2',
'description' => 'OPPO 私信模版内容参数',
'type' => 'object',
'deprecated' => true,
'required' => false,
'additionalProperties' => [
'type' => 'string',
'description' => 'OPPO 私信模版内容中的变量名,变量值',
'example' => 'my_content',
],
],
'HarmonyLiveViewPayload' => [
'description' => '鸿蒙实况窗数据结构 [LiveViewPayload](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V13/push-scenariozed-api-request-param-V13#section66881469306) 的 JSON 字符串,开发接入请参考文档[HarmonyOS 实况窗推送指南](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"
.'}',
],
'AndroidHuaweiLiveNotificationPayload' => [
'description' => '华为安卓实况窗数据结构 [LiveNotificationPayload](https://developer.huawei.com/consumer/cn/doc/HMSCore-References/rest-live-0000001562939968#ZH-CN_TOPIC_0000001700850537__p195121620102511) 的 JSON 字符串,开发接入请参考文档[华为实况窗推送指南](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"
.'}',
],
'AndroidOppoIntelligentIntent' => [
'description' => 'OPPO流体云的意图共享数据结构[IntelligentIntent](https://open.oppomobile.com/documentation/page/info?id=13565)的JSON字符串,开发接入请参考文档[OPPO流体云推送指南](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"
.'}',
],
'AndroidOppoDeleteIntentData' => [
'description' => 'OPPO流体云的意图删除数据结构[data](https://open.oppomobile.com/documentation/page/info?id=13578)的JSON字符串,当AndroidOppoIntelligentIntent参数已填写时此参数无效,开发接入请参考文档[OPPO流体云推送指南](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"
.'}',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 100,
],
],
[
'name' => 'IdempotentToken',
'in' => 'query',
'schema' => [
'description' => '用于防止API调用端重试造成服务端重复推送的一个幂等参数。15分钟内使用相同IdempotentToken进行调用时,只会进行一次推送,后续返回第一次成功推送的结果。'."\n"
."\n"
.'> '."\n"
.'> - 参数格式为标准36位UUID(8-4-4-4-12),每个有效字符是0-9 或 a-f 范围内的一个十六进制的数字,不区分大小写。'."\n"
.'> - 此参数仅用于避免重试造成的重复推送,无法避免并发调用造成的重复推送。',
'type' => 'string',
'required' => false,
'example' => 'c8016d13-6e76-410c-9bda-769383d11787',
'maxLength' => 36,
'minLength' => 36,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MessageId' => [
'description' => '批量消息ID列表,每个消息ID对应传入的PushTask的推送结果',
'type' => 'array',
'items' => [
'description' => '消息ID',
'type' => 'string',
'example' => '501030',
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Invalid%s.Format',
'errorMessage' => 'The specified %s format is invalid.',
],
[
'errorCode' => 'AccountDisabled',
'errorMessage' => 'Your account is not enabled.',
],
[
'errorCode' => 'FileNotExist',
'errorMessage' => 'The specified file does not exist.',
],
[
'errorCode' => 'IncorrectPassword',
'errorMessage' => 'The password is incorrect.',
],
[
'errorCode' => 'NotApnsCertificate',
'errorMessage' => 'The Certificate is not an APNs certificate.',
],
[
'errorCode' => 'PermissionDenied',
'errorMessage' => 'The specified AppKey is not authorized.',
],
[
'errorCode' => 'SendSpeedNotSupported',
'errorMessage' => 'SendSpeed is not supported for specified Target.',
],
[
'errorCode' => 'SmsProfileConfigFailed',
'errorMessage' => 'Failed to configure SMS profile.',
],
[
'errorCode' => 'SmsProfileGetFailed',
'errorMessage' => 'Failed to get SMS profile.',
],
[
'errorCode' => 'SmsRoleAuthorizeFailed',
'errorMessage' => 'Failed to authorize SMS role.',
],
[
'errorCode' => 'SmsRoleUnauthorized',
'errorMessage' => 'The SMS role is unauthorized.',
],
[
'errorCode' => 'TagsNumberBeyondLimit',
'errorMessage' => 'The number of tags bound to this app exceeds the limit.',
],
[
'errorCode' => 'Invalid%s.LengthExceed',
'errorMessage' => 'The specified %s length cannot be greater than %s.',
],
[
'errorCode' => 'Invalid%s.BytesExceed',
'errorMessage' => 'The specified %s exceeds the %s bytes limit.',
],
[
'errorCode' => 'Invalid%s.Empty',
'errorMessage' => 'The specified %s cannot be empty.',
],
[
'errorCode' => 'Invalid.Parameter',
'errorMessage' => 'The specified parameter is invalid: %s.',
],
[
'errorCode' => 'TargetNotSupported',
'errorMessage' => 'Target is not supported for batch push.',
],
],
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.',
],
[
'errorCode' => 'Timeout',
'errorMessage' => 'The request processing is timeout.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageIds\\": {\\n \\"MessageId\\": [\\n \\"501030\\"\\n ]\\n },\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","type":"json"}]',
'title' => '批量推送',
'description' => '**请确保在使用该接口前,已充分了解EMAS移动推送产品的[收费方式和价格](~~434638~~)。**'."\n"
."\n"
.'在某种业务场景中,可能需要在极短时间内大量向不同设备单推不同消息,在设备数、消息数极大时,会产生较高QPS,达到我们单来源IP的QPS限制,造成部分推送失败。'."\n"
."\n"
.'本接口针对此问题设计。它支持单次调用最大传入100个独立的推送任务,通过聚合请求的方式有效降低QPS,提高大量单推的稳定性和成功率。批量推送单账号限制每秒500次调用。'."\n"
."\n"
.'每个独立推送任务仅支持根据设备/账号/别名三类推送目标,且暂不支持短信融合配置。'."\n"
."\n"
.'> SDK需升级到3.11.0及以上版本。'."\n"
."\n"
.'## PushTask属性'."\n"
."\n\n"
.'- PushTask属性格式为:PushTask.N.Property。包含:'."\n"
.' - 推送目标(destination)'."\n"
.' - 推送配置(config)'."\n"
.' - iOS通知任务配置'."\n"
.' - Android通知任务配置'."\n"
.' - Android辅助弹窗功能配置'."\n"
.' - HarmonyOS通知任务配置 '."\n"
.' - 推送控制(push control)'."\n"
.'- 每一个PushTask表示一个独立推送任务,最大支持100个,推送相关配置,和Push接口一致。'."\n"
.'- PushTask.N.Target参数只支持DEVICE、ACCOUNT、ALIAS三种类型。'."\n"
.'- PushTask不支持短信联动配置。'."\n"
.'- 父节点和子节点的乘积不能超过10000,否则视为参数无效。',
'extraInfo' => '## Java示例代码'."\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"
.' // 推送目标'."\n"
.' pushTask.setTarget("DEVICE"); //推送目标: DEVICE:推送给设备; ACCOUNT:推送给指定账号,TAG:推送给自定义标签; ALIAS: 按别名推送; ALL: 全推'."\n"
.' pushTask.setTargetValue("device1,device2,device3"); //根据Target来设定,如Target=DEVICE, 则对应的值为设备id1,设备id2。多个值使用逗号分隔(账号与设备有一次最多100个的限制)。'."\n"
.' pushTask.setDeviceType("iOS"); // 设备类型deviceType, iOS设备: "iOS"; Android设备: "ANDROID"; 全部: "ALL", 这是默认值.'."\n"
.' // 推送配置'."\n"
.' pushTask.setPushType("MESSAGE"); // MESSAGE:表示消息(默认), NOTICE:表示通知'."\n"
.' pushTask.setTitle("Hello-" + i); // 消息的标题'."\n"
.' pushTask.setBody("PushRequest body" + i); // 消息的内容'."\n"
.' // 推送配置: iOS'."\n"
.' pushTask.setIOSBadge(5); // iOS应用图标右上角角标'."\n"
.' pushTask.setIOSMusic("default"); // iOS通知声音'."\n"
.' pushTask.setIOSApnsEnv("PRODUCT");//iOS的通知是通过APNs中心来发送的,需要填写对应的环境信息。\'DEV\': 表示开发环境 \'PRODUCT\': 表示生产环境'."\n"
.' pushTask.setIOSRemind(true); // 消息推送时设备不在线(既与移动推送的服务端的长连接通道不通),则这条推送会做为通知,通过苹果的APNs通道送达一次。注意:**离线消息转通知仅适用于`生产环境`**'."\n"
.' pushTask.setIOSRemindBody("PushRequest summary"); // iOS消息转通知时使用的iOS通知内容,仅当iOSApnsEnv=`PRODUCT` && iOSRemind为true时有效'."\n"
.' pushTask.setIOSExtParameters("{\\"k1\\":\\"ios\\",\\"k2\\":\\"v2\\"}"); //通知的扩展属性(注意 : 该参数要以json map的格式传入,否则会解析出错)'."\n"
.' // 推送配置: Android'."\n"
.' pushTask.setAndroidOpenType("ACTIVITY"); // 点击通知后动作 \'APPLICATION\': 打开应用 \'ACTIVITY\': 打开应用AndroidActivity \'URL\': 打开URL \'NONE\': 无跳转'."\n"
.' pushTask.setAndroidNotifyType("SOUND"); // 通知的提醒方式 ‘VIBRATE\': 振动 \'SOUND\': 声音 \'DEFAULT\': 声音和振动 \'NONE\': 不做处理,用户自定义'."\n"
.' pushTask.setAndroidOpenUrl("http://www.alibaba.com");'."\n"
.' pushTask.setAndroidMusic("alicloud_notification_sound"); // 华为厂商通道通知声音'."\n"
.' pushTask.setAndroidActivity("com.alibaba.push.PushActivity"); // Android收到推送后打开对应的ACTIVITY,仅当`AndroidOpenType="ACTIVITY"`有效'."\n"
.' pushTask.setAndroidPopupActivity("com.alibaba.push.PopupActivity"); //设置该参数后启动辅助弹窗功能, 此处指定通知点击后跳转的Activity(辅助弹窗的前提条件:1. 集成第三方辅助通道;2. StoreOffline参数设为true)'."\n"
.' pushTask.setAndroidPopupTitle("Popup Title"); //设置辅助弹窗通知的标题'."\n"
.' pushTask.setAndroidPopupBody("Popup Body"); //设置辅助弹窗通知的内容'."\n"
.' pushTask.setAndroidNotificationBarType(50); //Android自定义通知栏样式,取值:1-100'."\n"
.' pushTask.setAndroidNotificationBarPriority(2); //Android通知在通知栏展示时排列位置的优先级 -2 -1 0 1 2'."\n"
.' pushTask.setAndroidExtParameters("{\\"k1\\":\\"android\\",\\"k2\\":\\"v2\\"}"); //设定通知的扩展属性。(注意 : 该参数要以 json map 的格式传入,否则会解析出错)'."\n"
.' // 推送控制'."\n"
.' final Date pushDate = new Date(System.currentTimeMillis() + 3600 * 1000); //用于定时发送。不设置缺省是立即发送。时间格式按照ISO8601标准表示,并需要使用UTC时间,格式为`YYYY-MM-DDThh:mm:ssZ`。'."\n"
.' final String pushTime = ParameterHelper.getISO8601Time(pushDate);'."\n"
.' pushTask.setPushTime(pushTime); // 延后推送。可选,如果不设置表示立即推送'."\n"
.' pushTask.setStoreOffline(true); // 离线消息是否保存,若保存, 在推送时候,用户即使不在线,下一次上线则会收到'."\n"
.' final String expireTime = ParameterHelper.getISO8601Time(new Date(System.currentTimeMillis() + 12 * 3600 * 1000)); // 12小时后消息失效, 不会再发送'."\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"
.'```',
],
'ContinuouslyPush' => [
'summary' => '执行预定义的持续推送任务。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '23267207',
],
],
[
'name' => 'MessageId',
'in' => 'query',
'schema' => [
'description' => '消息ID。'."\n"
."\n"
.'调用Push接口,设置Target为TBD,调用后获得的MessageId。它代表了一个已经保存到推送系统的消息。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '500131',
],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => '推送目标:'."\n"
."\n"
.'- **DEVICE**:根据设备推送'."\n"
.'- **ACCOUNT**:根据账号推送'."\n"
.'- **ALIAS**:根据别名推送'."\n"
."\n"
.'持续推送只支持这3种目标类型。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'DEVICE',
'enum' => [
'DEVICE',
'ACCOUNT',
'ALIAS',
],
],
],
[
'name' => 'TargetValue',
'in' => 'query',
'schema' => [
'description' => '根据Target来设定,多个值使用逗号分隔,超过限制需要分多次推送。'."\n"
."\n"
.'- Target=DEVICE,值如`deviceid1,deviceid2`(最多支持1000个)。'."\n"
.'- Target=ACCOUNT,值如`account1,account2`(最多支持1000个)。'."\n"
.'- Target=ALIAS,值如`alias1,alias2`(最多支持1000个)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'a692961a92534047ad3625****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '标志一次推送的消息ID。',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '500131',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"MessageId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"RequestId\\": \\"500131\\"\\n}","errorExample":""},{"type":"xml","example":"\\n<ContinuouslyPushResponse>\\n <RequestId>9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC</RequestId> \\n <MessageId>500131</MessageId>\\n</ContinuouslyPushResponse>","errorExample":""}]',
'title' => '持续推送',
'description' => '本接口是用于解决[Push高级推送接口](~~2249916~~)中,无论是按设备推、按账号推、按别名推,在单次调用中都存在目标个数上限的问题。'."\n"
."\n"
.'- 使用持续推送意味着业务场景是要往大量设备上,发送同一条消息。这时候,应当合理调用持续推送接口,每次调用,聚合一组设备进行推送(目前按设备推、按账号推、按别名推,单次推送目标个数上限是1000)。我们会限制在同一个 MessageId 上推送的总次数为10000 。如确实需要更高限额,请联系技术支持评估具体场景。'."\n"
."\n"
.'- 使用这个接口前,需要调用Push接口,将Target设置为TBD(To Be Determined),填入消息内容,调用获得该消息在推送系统中的MessageId。然后,可以基于这个MessageId,重复调用此接口,指定不同的目标组,将此消息推送到这些目标上。'."\n"
."\n"
.'- 调用Push接口设置目标为TBD获得MessageId后,这个消息默认会在推送系统保存24个小时,过期之前,可以随时使用本接口进行指定目标推送。过期后不再允许推送。超出总次数上限后不再允许推送。'."\n"
."\n"
.'- 每次调用本接口指定设备时,消息都是立即推出,不支持设置定时推送。',
'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"
.'```',
],
'CompleteContinuouslyPush' => [
'summary' => '手动结束持续推送任务。',
'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' => 'AppKey信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'MessageId',
'in' => 'query',
'schema' => [
'description' => '消息ID。'."\n"
."\n"
.'调用Push接口,设置Target为TBD,调用后获得的MessageId。它代表了一个已经保存到推送系统的消息。',
'type' => 'string',
'required' => true,
'example' => '500131',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '标志一次推送的消息ID。',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '500131',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"MessageId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"RequestId\\": \\"500131\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\n<ContinuouslyPushResponse>\\n <RequestId>9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC</RequestId> \\n <MessageId>500131</MessageId>\\n</ContinuouslyPushResponse>","errorExample":""}]',
'title' => '完成持续推送任务',
'description' => '若不调用此接口以手动形式结束持续推送任务,持续推送任务将会在到达过期时间时自动结束。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
],
'CancelPush' => [
'summary' => '取消某次尚未执行的定时推送任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => 'AppKey信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'MessageId',
'in' => 'query',
'schema' => [
'description' => '某次推送任务的消息ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '501029',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>\\n<PushMessageToAndroidResponse>\\n <RequestId>9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC</RequestId>\\n</PushMessageToAndroidResponse>","errorExample":""}]',
'title' => '取消定时推送任务',
],
'PushV2' => [
'summary' => '高级推送接口V2。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '****530646',
],
],
[
'name' => 'IdempotentToken',
'in' => 'query',
'schema' => [
'description' => '用于防止API调用端重试造成服务端重复推送的一个幂等参数。15分钟内使用相同IdempotentToken进行调用时,只会进行一次推送,后续返回第一次成功推送的结果。'."\n"
."\n"
.'> '."\n"
.'> - 参数格式为标准36位UUID(8-4-4-4-12),每个有效字符是0-9 或 a-f 范围内的一个十六进制的数字,不区分大小写。'."\n"
.'> - 此参数仅用于避免重试造成的重复推送,无法避免并发调用造成的重复推送。',
'type' => 'string',
'required' => false,
'example' => 'c8016d13-6e76-****-9bda-769383d11787',
'maxLength' => 36,
'minLength' => 36,
],
],
[
'name' => 'PushTask',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '推送任务。',
'required' => true,
'$ref' => '#/components/schemas/PushTask',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '标志一次推送的消息ID。',
'type' => 'string',
'example' => '11747540****88320',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '159E4422-6624-****-8943-DFD98D34858C',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidPeriod.ExceedDays',
'errorMessage' => 'The period between specified EndTime and StartTime exceeds %s days.',
],
[
'errorCode' => 'Invalid%s.Format',
'errorMessage' => 'The specified %s format is invalid.',
],
[
'errorCode' => 'AccountDisabled',
'errorMessage' => 'Your account is not enabled.',
],
[
'errorCode' => 'FileNotExist',
'errorMessage' => 'The specified file does not exist.',
],
[
'errorCode' => 'IncorrectPassword',
'errorMessage' => 'The password is incorrect.',
],
[
'errorCode' => 'NotApnsCertificate',
'errorMessage' => 'The Certificate is not an APNs certificate.',
],
[
'errorCode' => 'PermissionDenied',
'errorMessage' => 'The specified AppKey is not authorized.',
],
[
'errorCode' => 'SendSpeedNotSupported',
'errorMessage' => 'SendSpeed is not supported for specified Target.',
],
[
'errorCode' => 'SmsProfileConfigFailed',
'errorMessage' => 'Failed to configure SMS profile.',
],
[
'errorCode' => 'SmsProfileGetFailed',
'errorMessage' => 'Failed to get SMS profile.',
],
[
'errorCode' => 'SmsRoleAuthorizeFailed',
'errorMessage' => 'Failed to authorize SMS role.',
],
[
'errorCode' => 'SmsRoleUnauthorized',
'errorMessage' => 'The SMS role is unauthorized.',
],
[
'errorCode' => 'TagsNumberBeyondLimit',
'errorMessage' => 'The number of tags bound to this app exceeds the limit.',
],
[
'errorCode' => 'Invalid%s.LengthExceed',
'errorMessage' => 'The specified %s length cannot be greater than %s.',
],
[
'errorCode' => 'Invalid%s.BytesExceed',
'errorMessage' => 'The specified %s exceeds the %s bytes limit.',
],
[
'errorCode' => 'Invalid%s.Empty',
'errorMessage' => 'The specified %s cannot be empty.',
],
[
'errorCode' => 'Invalid.Parameter',
'errorMessage' => 'The specified parameter is invalid: %s.',
],
[
'errorCode' => 'TargetNotSupported',
'errorMessage' => 'Target is not supported for batch push.',
],
],
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.',
],
[
'errorCode' => 'Timeout',
'errorMessage' => 'The request processing is timeout.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"11747540****88320\\",\\n \\"RequestId\\": \\"159E4422-6624-****-8943-DFD98D34858C\\"\\n}","type":"json"}]',
'title' => '高级推送',
'description' => '**请确保在使用该接口前,已充分了解EMAS移动推送产品的[收费方式和价格](~~434638~~)。**'."\n"
."\n"
.'本接口区分Android、iOS和HarmonyOS平台,对于不同平台的推送调用,需要传入平台对应的AppKey。',
'requestParamsDescription' => '请您阅读文档[PushV2接口接入指南](https://help.aliyun.com/document_detail/2986583.html)获取更多指导。',
],
'MassPushV2' => [
'summary' => '高级推送接口V2。',
'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信息',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '23267***',
],
],
[
'name' => 'IdempotentToken',
'in' => 'query',
'schema' => [
'description' => '用于防止API调用端重试造成服务端重复推送的一个幂等参数。15分钟内使用相同IdempotentToken进行调用时,只会进行一次推送,后续返回第一次成功推送的结果。'."\n"
."\n"
.'> '."\n"
.'> - 参数格式为标准36位UUID(8-4-4-4-12),每个有效字符是0-9 或 a-f 范围内的一个十六进制的数字,不区分大小写。'."\n"
.'> - 此参数仅用于避免重试造成的重复推送,无法避免并发调用造成的重复推送。',
'type' => 'string',
'required' => false,
'example' => 'c8016d13-6e76-****-9bda-769383d11787',
'maxLength' => 36,
'minLength' => 36,
],
],
[
'name' => 'PushTasks',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '批量推送任务',
'type' => 'array',
'items' => [
'description' => '推送任务',
'required' => false,
'$ref' => '#/components/schemas/PushTask',
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '159E4422-6624-****-8943-DFD98D34858C',
],
'MessageIds' => [
'description' => '消息ID列表',
'type' => 'array',
'items' => [
'description' => '消息ID',
'type' => 'string',
'example' => '1091371886864****',
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidPeriod.ExceedDays',
'errorMessage' => 'The period between specified EndTime and StartTime exceeds %s days.',
],
[
'errorCode' => 'Invalid%s.Format',
'errorMessage' => 'The specified %s format is invalid.',
],
[
'errorCode' => 'AccountDisabled',
'errorMessage' => 'Your account is not enabled.',
],
[
'errorCode' => 'FileNotExist',
'errorMessage' => 'The specified file does not exist.',
],
[
'errorCode' => 'IncorrectPassword',
'errorMessage' => 'The password is incorrect.',
],
[
'errorCode' => 'NotApnsCertificate',
'errorMessage' => 'The Certificate is not an APNs certificate.',
],
[
'errorCode' => 'PermissionDenied',
'errorMessage' => 'The specified AppKey is not authorized.',
],
[
'errorCode' => 'SendSpeedNotSupported',
'errorMessage' => 'SendSpeed is not supported for specified Target.',
],
[
'errorCode' => 'SmsProfileConfigFailed',
'errorMessage' => 'Failed to configure SMS profile.',
],
[
'errorCode' => 'SmsProfileGetFailed',
'errorMessage' => 'Failed to get SMS profile.',
],
[
'errorCode' => 'SmsRoleAuthorizeFailed',
'errorMessage' => 'Failed to authorize SMS role.',
],
[
'errorCode' => 'SmsRoleUnauthorized',
'errorMessage' => 'The SMS role is unauthorized.',
],
[
'errorCode' => 'TagsNumberBeyondLimit',
'errorMessage' => 'The number of tags bound to this app exceeds the limit.',
],
[
'errorCode' => 'Invalid%s.LengthExceed',
'errorMessage' => 'The specified %s length cannot be greater than %s.',
],
[
'errorCode' => 'Invalid%s.BytesExceed',
'errorMessage' => 'The specified %s exceeds the %s bytes limit.',
],
[
'errorCode' => 'Invalid%s.Empty',
'errorMessage' => 'The specified %s cannot be empty.',
],
[
'errorCode' => 'Invalid.Parameter',
'errorMessage' => 'The specified parameter is invalid: %s.',
],
[
'errorCode' => 'TargetNotSupported',
'errorMessage' => 'Target is not supported for batch push.',
],
],
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.',
],
[
'errorCode' => 'Timeout',
'errorMessage' => 'The request processing is timeout.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"159E4422-6624-****-8943-DFD98D34858C\\",\\n \\"MessageIds\\": [\\n \\"1091371886864****\\"\\n ]\\n}","type":"json"}]',
'title' => '批量推送',
'description' => '请确保在使用该接口前,已充分了解 EMAS 移动推送产品的[收费方式和价格](https://help.aliyun.com/document_detail/434638.html)。',
],
'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' => 'AppKey信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '1000000000',
'minimum' => '0',
'example' => '23267207',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
'Android' => [
'description' => '判断AppKey代表的是否是Android app:'."\n"
.'- true'."\n"
.'- false',
'type' => 'boolean',
'enumValueTitles' => [
'true' => 'true',
'false' => 'false',
],
'example' => 'false',
],
'IOS' => [
'description' => '判断AppKey代表的是否是iOS app:'."\n"
.'- true'."\n"
.'- false',
'type' => 'boolean',
'enumValueTitles' => [
'true' => 'true',
'false' => 'false',
],
'example' => 'true',
],
'ProductionCertInfo' => [
'description' => '访问生产环境的证书信息。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '证书状态,取值:'."\n"
."\n"
.'- **EXPIRED**:已过期'."\n"
.'- **NOT_CONFIGURED**:未配置'."\n"
.'- **NO_PASSWORD**:未配置密码'."\n"
.'- **OK**:正常'."\n"
.'- **REVOKED**:已撤销',
'type' => 'string',
'enumValueTitles' => [
'REVOKED' => 'REVOKED',
'NO_PASSWORD' => 'NO_PASSWORD',
'EXPIRED' => 'EXPIRED',
'NOT_CONFIGURED' => 'NOT_CONFIGURED',
'OK' => 'OK',
],
'example' => 'OK',
],
'ExipreTime' => [
'description' => '证书过期时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1764561600000',
],
],
],
'DevelopmentCertInfo' => [
'description' => '访问开发环境/沙箱环境的证书信息。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '证书状态,取值:'."\n"
."\n"
.'- **EXPIRED**:已过期'."\n"
.'- **NOT_CONFIGURED**:未配置'."\n"
.'- **NO_PASSWORD**:未配置密码'."\n"
.'- **OK**:正常'."\n"
.'- **REVOKED**:已撤销',
'type' => 'string',
'enumValueTitles' => [
'REVOKED' => 'REVOKED',
'NO_PASSWORD' => 'NO_PASSWORD',
'EXPIRED' => 'EXPIRED',
'NOT_CONFIGURED' => 'NOT_CONFIGURED',
'OK' => 'OK',
],
'example' => 'EXPIRED',
],
'ExipreTime' => [
'description' => '证书过期时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1470024000000',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Invalid%s.NotFound',
'errorMessage' => 'The specified %s is not found.',
],
[
'errorCode' => 'AccountDisabled',
'errorMessage' => 'Your account is not enabled.',
],
[
'errorCode' => 'PermissionDenied',
'errorMessage' => 'The specified AppKey is not authorized.',
],
],
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.',
],
],
],
'responseDemo' => '[{"type":"json","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}","errorExample":""}]',
'title' => '查询证书状态',
'summary' => '检测指定app的iOS证书过期时间及当前证书状态。',
'description' => '- 如果返回的ExpireTime大于当前时间戳,并不代表证书一定可用,还需检查Status是否为OK。'."\n"
.'- REVOKED来源于APNs服务器,如果证书处于REVOKED状态时,则对应环境中至少有一条推向APNs的推送失败。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryPushRecords' => [
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '333526247',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '查询的起始时间,UTC时间,ISO-8601格式,格式为YYYY-MM-DDThh:mm:ssZ。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2021-09-15T02:05:24Z',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '查询的结束时间,UTC时间,ISO-8601格式,格式为YYYY-MM-DDThh:mm:ssZ。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2021-09-29T06:24:58Z',
],
],
[
'name' => 'PushType',
'in' => 'query',
'schema' => [
'description' => '推送类型。取值:'."\n"
."\n"
.'- **MESSAGE**:表示消息。'."\n"
."\n"
.'- **NOTICE**:表示通知。',
'type' => 'string',
'required' => false,
'example' => 'NOTICE',
'enum' => [
'MESSAGE',
'NOTICE',
],
],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => '推送目标:'."\n"
."\n"
.'- **DEVICE**:根据设备推送。'."\n"
."\n"
.'- **ACCOUNT**:根据账号推送。'."\n"
."\n"
.'- **ALIAS**:根据别名推送。'."\n"
."\n"
.'- **TAG**:根据标签推送。'."\n"
."\n"
.'- **ALL**:推送给全部设备。'."\n"
."\n"
.'- **TBD**:初始化持续推送,推送目标由后续的ContinuouslyPush接口指定。',
'type' => 'string',
'required' => false,
'example' => 'DEVICE',
'enum' => [
'ACCOUNT',
'ALIAS',
'DEVICE',
'TAG',
'TBD',
'FILE',
'ALL',
],
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'description' => '推送来源。可取值:'."\n"
."\n"
.'- **API**:OpenAPI发起的推送,含OpenAPI平台控制台发起的推送。'."\n"
.'- **CONSOLE**:通过移动推送控制台推送。'."\n"
.'- **OpenAPIExplorer**:通过阿里云OpenAPI Explorer平台推送。',
'type' => 'string',
'required' => false,
'example' => 'API',
'enum' => [
'CONSOLE',
'API',
'OpenAPIExplorer',
],
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => '查询关键字,根据MessageId、Title、Body字段进行查询。系统对推送的title和body进行了中文分词,使用分词进行查询,非子字符串匹配查询。',
'type' => 'string',
'required' => false,
'example' => '统计数据测试通知805',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '废弃参数,不再使用。',
'type' => 'string',
'required' => false,
'example' => 'FFPpkmhCPm*****************xjk=',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页的条目数量,默认值为20, 最大为100。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '10',
'default' => '20',
],
],
[
'name' => 'Page',
'in' => 'query',
'schema' => [
'description' => '推送记录的当前页数, 默认为1,最大10000。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '10000',
'minimum' => '1',
'example' => '8',
'default' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => [
'description' => '废弃参数,不再使用。',
'type' => 'string',
'example' => 'i91D***********kXIh/dVBEQ==',
],
'PageSize' => [
'description' => '每页的条目数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9B24B396-249D-55E4-8CA1-66C9B50BB734',
],
'Total' => [
'description' => '记录总条数。',
'type' => 'integer',
'format' => 'int32',
'example' => '193',
],
'Page' => [
'description' => '推送记录的当前页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '11',
],
'PushInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PushInfo' => [
'description' => '具体通知/消息的详情。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '消息状态。可取值:'."\n"
."\n"
.'- **WAITING**:等待中。'."\n"
."\n"
.'- **SENT**:已推送。'."\n"
."\n"
.'- **CANCELED**:已取消。'."\n",
'type' => 'string',
'example' => 'SENT',
],
'MessageId' => [
'description' => '消息ID。',
'type' => 'string',
'example' => '510431',
],
'AppKey' => [
'description' => 'AppKey信息。',
'type' => 'integer',
'format' => 'int64',
'example' => '333526247',
],
'DeviceType' => [
'description' => '设备类型。取值:'."\n"
."\n"
.'- **ALL**:所有类型。'."\n"
."\n"
.'- **IOS**:iOS设备。'."\n"
."\n"
.'- **ANDROID**:Android设备。',
'type' => 'string',
'enumValueTitles' => [
'ALL' => 'ALL',
'IOS' => 'IOS',
'ANDROID' => 'ANDROID',
],
'example' => 'ANDROID',
],
'PushType' => [
'description' => '推送类型。取值:'."\n"
."\n"
.'- **MESSAGE**:消息。'."\n"
."\n"
.'- **NOTICE**:通知。',
'type' => 'string',
'enumValueTitles' => [
'MESSAGE' => 'MESSAGE',
'NOTICE' => 'NOTICE',
],
'example' => 'NOTICE',
],
'Body' => [
'description' => '推送的body字段。',
'type' => 'string',
'example' => 'abcd',
],
'Title' => [
'description' => '推送的title字段。',
'type' => 'string',
'example' => 'sssss',
],
'Source' => [
'description' => '推送源类型。可取值:'."\n"
."\n"
.'- **API**:OpenAPI发起的推送,含OpenAPI平台控制台发起的推送。'."\n"
."\n"
.'- **CONSOLE**:通过移动推送控制台推送。',
'type' => 'string',
'enumValueTitles' => [
'CONSOLE' => 'CONSOLE',
'API' => 'API',
],
'example' => 'DEVICE',
],
'PushTime' => [
'description' => '推送时间,UTC时间,ISO-8601格式, 格式为 YYYY-MM-DDThh:mm:ssZ。',
'type' => 'string',
'example' => '2021-09-15T02:05:24Z',
],
'Target' => [
'description' => '推送目标:'."\n"
."\n"
.'- **ACCOUNT**:根据账号推送。'."\n"
."\n"
.'- **ALIAS**:根据别名推送。'."\n"
."\n"
.'- **DEVICE**:根据设备推送。'."\n"
."\n"
.'- **TAG**:根据标签推送。'."\n"
."\n"
.'- **ALL**:推送给全部设备。'."\n"
."\n"
.'- **TBD**:初始化持续推送,推送目标由后续的ContinuouslyPush接口指定。',
'type' => 'string',
'example' => 'DEVICE',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccountDisabled',
'errorMessage' => 'Your account is not enabled.',
],
],
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.',
],
[
'errorCode' => 'Timeout',
'errorMessage' => 'The request processing is timeout.',
],
],
],
'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<QueryPushRecordsResponse>\\n <Page>1</Page>\\n <PageSize>20</PageSize>\\n <PushInfos>\\n <PushInfo>\\n <AppKey>23419851</AppKey>\\n <Body>云智能测试推送内容</Body>\\n <DeviceType>ANDROID</DeviceType>\\n <MessageId>60**************</MessageId>\\n <PushTime>2023-01-01T08:12:34Z</PushTime>\\n <PushType>NOTICE</PushType>\\n <Source>API</Source>\\n <Status>SENT</Status>\\n <Target>DEVICE</Target>\\n <Title>通知标题</Title>\\n </PushInfo>\\n </PushInfos>\\n <RequestId>DCA3F8E3-8D6A-5492-B059-48F56B022D8E</RequestId>\\n <Total>1</Total>\\n</QueryPushRecordsResponse>","errorExample":""}]',
'title' => '查询推送记录',
'summary' => '分页查询推送记录,并提供一些简单的筛选能力。',
],
'QueryDeviceStat' => [
'summary' => '查询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' => 'AppKey信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '查询的开始时间。时间格式按照ISO8601标准表示,并需要使用UTC时间,格式为YYYY-MM-DDThh:mm:ssZ。'."\n"
."\n"
.'> 统计开始日期为开始时间当天北京时间0点。',
'type' => 'string',
'required' => true,
'example' => '2016-07-28T00:00:00Z',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '查询的结束时间。时间格式按照ISO8601标准表示,并需要使用UTC时间,格式为YYYY-MM-DDThh:mm:ssZ。'."\n"
."\n"
.'> 统计结束日期为结束时间当天。',
'type' => 'string',
'required' => true,
'example' => '2016-07-29T00:00:00Z',
],
],
[
'name' => 'DeviceType',
'in' => 'query',
'schema' => [
'description' => '><notice>该参数仅对早期的安卓苹果双端应用类型有效,当您的应用为双端应用时,可以通过指定该参数为iOS或ANDROID分别查出两种类型的设备数。默认为查询ALL类型。></notice>'."\n"
."\n"
.'设备类型,取值范围为:'."\n"
."\n"
.'- **iOS**:iOS设备'."\n"
.'- **ANDROID**:Android设备'."\n"
.'- **ALL**:全部类型设备',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'ALL' => 'ALL',
'ANDROID' => 'ANDROID',
'iOS' => 'iOS',
],
'example' => 'iOS',
'enum' => [
'iOS',
'ANDROID',
'ALL',
],
],
],
[
'name' => 'QueryType',
'in' => 'query',
'schema' => [
'description' => '查询的是新增设备数还是历史累计设备数。可取值:'."\n"
."\n"
.'- **NEW**:新增设备'."\n"
.'- **TOTAL**:累计设备数',
'type' => 'string',
'required' => true,
'example' => 'TOTAL',
'enum' => [
'NEW',
'TOTAL',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
'AppDeviceStats' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AppDeviceStat' => [
'description' => '设备统计数据AppDeviceStat组成的数组。',
'type' => 'array',
'items' => [
'description' => '设备统计数据对象AppDeviceStat。',
'type' => 'object',
'properties' => [
'Time' => [
'description' => '截止时间。时间格式按照ISO8601标准表示,并使用UTC时间,格式为YYYY-MM-DDThh:mm:ssZ。',
'type' => 'string',
'example' => '2016-07-28T16:00:00Z',
],
'DeviceType' => [
'description' => '设备类型。',
'type' => 'string',
'example' => 'iOS',
],
'Count' => [
'description' => '设备数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<QueryDeviceStatResponse>\\n <RequestId>9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC</RequestId>\\n <AppDeviceStats>\\n <Time>2016-07-27T16:00:00Z</Time>\\n <DeviceType>iOS</DeviceType>\\n <Count>90</Count>\\n </AppDeviceStats>\\n <AppDeviceStats>\\n <Time>2016-07-28T16:00:00Z</Time>\\n <DeviceType>iOS</DeviceType>\\n <Count>100</Count>\\n </AppDeviceStats>\\n</QueryDeviceStatResponse>","errorExample":""}]',
'title' => '设备新增与留存',
'description' => '> 目前只支持返回天的数据,天维度最多支持查31天内数据,天以北京时间为准。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryUniqueDeviceStat' => [
'summary' => '查询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' => 'AppKey信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '查询的起始时间,ISO-8601格式,格式为 YYYY-MM-DDThh:mm:ssZ。',
'type' => 'string',
'required' => true,
'example' => '2016-07-25T00:00:00Z',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '查询的结束时间,ISO-8601格式,格式为 YYYY-MM-DDThh:mm:ssZ。',
'type' => 'string',
'required' => true,
'example' => '2016-07-26T00:00:00Z',
],
],
[
'name' => 'Granularity',
'in' => 'query',
'schema' => [
'description' => '按天或者按月查询。可取值:'."\n"
."\n"
.'- DAY:天'."\n"
.'- MONTH:月',
'type' => 'string',
'required' => true,
'example' => 'DAY',
'enum' => [
'DAY',
'MONTH',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
'AppDeviceStats' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AppDeviceStat' => [
'description' => '设备统计数据AppDeviceStat组成的数组。',
'type' => 'array',
'items' => [
'description' => '设备统计数据对象AppDeviceStat。',
'type' => 'object',
'properties' => [
'Time' => [
'description' => '时间片。',
'type' => 'string',
'example' => '2016-07-25T00:00:00Z',
],
'Count' => [
'description' => '去重设备数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\n<QueryUniqueDeviceStatResponse>\\n <RequestId>9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC</RequestId>\\n <AppDeviceStats>\\n <AppDeviceStat>\\n <Time>2016-07-25T00:00:00Z</Time>\\n <Count>100</Count>\\n </AppDeviceStat>\\n <AppDeviceStat>\\n <Time>2016-07-26T00:00:00Z</Time>\\n <Count>100</Count>\\n </AppDeviceStat>\\n </AppDeviceStats>\\n</QueryUniqueDeviceStatResponse>","errorExample":""}]',
'title' => '去重设备统计',
'description' => '> 目前只支持返回天的数据,天维度最多支持查31天内数据。去重设备统计是以月为周期计数,每个月月初都会清零重新计数。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDeviceInfo' => [
'summary' => '查询指定设备详细信息。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23419851',
],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => [
'description' => '设备在推送系统中的唯一标识,一次只能查询一个。',
'type' => 'string',
'required' => true,
'example' => 'a64ae296f3b04a58a05b30c9****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '6EEF262B-EA7D-41DC-89B9-20F3D1E28194',
],
'DeviceInfo' => [
'description' => '设备详情。',
'type' => 'object',
'properties' => [
'Account' => [
'description' => '设备绑定的账户。',
'type' => 'string',
'example' => '[email protected]',
],
'LastOnlineTime' => [
'description' => '最近一次上线时间。',
'type' => 'string',
'example' => '2018-03-27T02:19:40Z',
],
'PhoneNumber' => [
'description' => '手机号。',
'type' => 'string',
'example' => '133********',
],
'PushEnabled' => [
'description' => '是否开启推送功能。',
'type' => 'boolean',
'example' => 'true',
],
'DeviceType' => [
'description' => '设备类型。',
'type' => 'string',
'example' => 'iOS',
],
'DeviceId' => [
'description' => '设备ID。',
'type' => 'string',
'example' => 'a64ae296f3b04a58a05b30c95****',
],
'Online' => [
'description' => '是否在线。',
'type' => 'boolean',
'example' => 'false',
],
'Tags' => [
'description' => '设备绑定的标签。',
'type' => 'string',
'example' => 'test_tag,test_tag2',
],
'DeviceToken' => [
'description' => '设备令牌。',
'type' => 'string',
'example' => '5ecc7b4012aaa801b63******5543ccbda6b4930d09629e936e1ac4b762a7df',
],
'Alias' => [
'description' => '设备绑定的别名。',
'type' => 'string',
'example' => 'test_alias,test_alias2',
],
'Brand' => [
'description' => '设备品牌',
'type' => 'string',
'example' => 'HUAWEI',
],
'Model' => [
'description' => '设备型号',
'type' => 'string',
'example' => 'VOG-AL00',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6EEF262B-EA7D-41DC-89B9-20F3D1E28194\\",\\n \\"DeviceInfo\\": {\\n \\"Account\\": \\"[email protected]\\",\\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}","errorExample":""},{"type":"xml","example":"<QueryDeviceInfoResponse>\\n <RequestId>6EEF262B-EA7D-41DC-89B9-20F3D1E28194</RequestId>\\n <DeviceInfo>\\n <Account>[email protected]</Account>\\n <LastOnlineTime>2018-03-27T02:19:40Z</LastOnlineTime>\\n <PhoneNumber>133********</PhoneNumber>\\n <PushEnabled>true</PushEnabled>\\n <DeviceType>iOS</DeviceType>\\n <DeviceId>a64ae296f3b04a58a05b30c95****</DeviceId>\\n <Online>false</Online>\\n <Tags>test_tag,test_tag2</Tags>\\n <DeviceToken>5ecc7b4012aaa801b63******5543ccbda6b4930d09629e936e1ac4b762a7df</DeviceToken>\\n <Alias>test_alias,test_alias2</Alias>\\n </DeviceInfo>\\n</QueryDeviceInfoResponse>","errorExample":""}]',
'title' => '查询设备详情',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryPushStatByApp' => [
'summary' => '查询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' => 'AppKey信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '查询的起始时间,ISO-8601格式,格式为YYYY-MM-DDThh:mm:ssZ。',
'type' => 'string',
'required' => true,
'example' => '2016-07-25T00:00:00Z',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '查询的结束时间,ISO-8601格式,格式为YYYY-MM-DDThh:mm:ssZ。',
'type' => 'string',
'required' => true,
'example' => '2016-07-29T00:00:00Z',
],
],
[
'name' => 'Granularity',
'in' => 'query',
'schema' => [
'description' => '返回的数据粒度,目前只支持按天粒度查询 31 内天数据。取值:'."\n"
."\n"
.'- **DAY**:按天粒度查询。',
'type' => 'string',
'required' => true,
'example' => 'DAY',
'enum' => [
'DAY',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
'AppPushStats' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AppPushStat' => [
'description' => 'APP推送统计AppPushStat组成的数据,根据时间粒度返回数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Time' => [
'description' => '时间。',
'type' => 'string',
'example' => '2016-07-25T00:00:00Z',
],
'DeletedCount' => [
'description' => '通知在设备上被清除的数目。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'OpenedCount' => [
'description' => '通知在设备上被点击的数目。',
'type' => 'integer',
'format' => 'int64',
'example' => '30',
],
'SmsReceiveSuccessCount' => [
'description' => '可为空,短信复合推送成功收到的短信数目。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SmsSkipCount' => [
'description' => '可为空,短信复合推送跳过发送短信的数目,例如未绑手机号。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SmsReceiveFailedCount' => [
'description' => '可为空,短信复合推送发出但是手机未收到的短信数目。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SmsFailedCount' => [
'description' => '可为空,短信复合推送短信发送失败的数目,例如未开通对应服务、未授权通过、参数错误等。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ReceivedCount' => [
'description' => '实际送达到设备的数目。',
'type' => 'integer',
'format' => 'int64',
'example' => '60',
],
'SentCount' => [
'description' => '推送服务端实际发出的数目。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'SmsSentCount' => [
'description' => '可为空,短信复合推送发出的短信数目。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AcceptCount' => [
'description' => '推送服务端接收到的推送数目。',
'type' => 'integer',
'format' => 'int64',
'example' => '120',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\n<QueryPushStatByAppResponse>\\n <RequestId>9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC</RequestId>\\n <AppPushStats>\\n <AppPushStat>\\n <Time>2016-07-25T00:00:00Z</Time>\\n <AcceptCount>120</AcceptCount>\\n <SentCount>100</SentCount>\\n <ReceivedCount>60</ReceivedCount>\\n <OpenedCount>30</OpenedCount>\\n <DeletedCount>10</DeletedCount>\\n </AppPushStat>\\n <AppPushStat>\\n <time>2016-07-29T00:00:00Z</time>\\n <AcceptCount>120</AcceptCount>\\n <SentCount>100</SentCount>\\n <ReceivedCount>60</ReceivedCount>\\n <OpenedCount>30</OpenedCount>\\n <DeletedCount>10</DeletedCount>\\n </AppPushStat>\\n </AppPushStats>\\n</QueryPushStatByAppResponse>","errorExample":""}]',
'title' => 'App维度推送统计',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryPushStatByMsg' => [
'summary' => '查询消息维度的推送统计。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'MessageId',
'in' => 'query',
'schema' => [
'description' => '推送的消息ID,推送之后会返回该ID。'."\n"
.'> 推送数据隔天展示,不支持查询今日数据。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'enumValueTitles' => [],
'example' => '510427',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CF195C34-98FB-491A-98D7-19CBC1FA880B',
],
'PushStats' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PushStat' => [
'description' => '消息/通知的推送结果统计PushStat组成的数组。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '消息ID。',
'type' => 'string',
'example' => '510427',
],
'DeletedCount' => [
'description' => '通知在设备上被清除的数目。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'OpenedCount' => [
'description' => '通知在设备上被点击的数目。',
'type' => 'integer',
'format' => 'int64',
'example' => '30',
],
'SmsReceiveSuccessCount' => [
'description' => '(可为空)短信复合推送成功收到的短信数目。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SmsSkipCount' => [
'description' => '(可为空)短信复合推送跳过发送短信的数目,例如未绑手机号。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SmsReceiveFailedCount' => [
'description' => '(可为空)短信复合推送发出但是手机未收到的短信数目。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SmsFailedCount' => [
'description' => '(可为空)短信复合推送短信发送失败的数目,例如未开通对应服务、未授权通过、参数错误等。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ReceivedCount' => [
'description' => '实际送达到设备的数目。',
'type' => 'integer',
'format' => 'int64',
'example' => '60',
],
'SentCount' => [
'description' => '推送服务端实际发出的数目。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'SmsSentCount' => [
'description' => '(可为空)短信复合推送发出的短信数目。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AcceptCount' => [
'description' => '推送服务端接收到的推送数目。',
'type' => 'integer',
'format' => 'int64',
'example' => '120',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\n<QueryPushStatByMsgResponse>\\n <RequestId>9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC</RequestId>\\n <PushStats>\\n <PushStat>\\n <MessageId>510427</MessageId>\\n <AcceptCount>120</AcceptCount>\\n <SentCount>100</SentCount>\\n <ReceivedCount>60</ReceivedCount>\\n <OpenedCount>30</OpenedCount>\\n <DeletedCount>10</DeletedCount>\\n </PushStat>\\n </PushStats>\\n</QueryPushStatByMsgResponse>","errorExample":""}]',
'title' => '任务维度推送统计',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CheckDevices' => [
'summary' => '验证指定的一组设备的有效性。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23419851',
],
],
[
'name' => 'DeviceIds',
'in' => 'query',
'schema' => [
'description' => '设备在推送的唯一标识,32位,数字和小写字母组合,多个设备查询用“,”分隔,一次最多查100个。',
'type' => 'string',
'required' => true,
'example' => 'ae296f3b04a58a05b30c95f****,ae296f3b04a58a05b30c95f****,ae296f3b04a58a05b30c95f****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
'DeviceCheckInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DeviceCheckInfo' => [
'description' => '批量设备有效性检查结果。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DeviceId' => [
'description' => '设备ID。',
'type' => 'string',
'example' => 'ae296f3b04a58a05b30c95f****',
],
'Available' => [
'description' => '是否可用。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"DeviceCheckInfos\\": {\\n \\"DeviceCheckInfo\\": [\\n {\\n \\"DeviceId\\": \\"ae296f3b04a58a05b30c95f****\\",\\n \\"Available\\": true\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\n<CheckDevicesResponse>\\n <RequestId>9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC</RequestId>\\n <DeviceCheckInfos>\\n <DeviceCheckInfo>\\n <DeviceId>ae296f3b04a58a05b30c95f1****</DeviceId>\\n <Available>true</Available>\\n </DeviceCheckInfo>\\n <DeviceCheckInfo>\\n <DeviceId>ae296f3b04a58a05b30c95f1****</DeviceId>\\n <Available>true</Available>\\n </DeviceCheckInfo>\\n <DeviceCheckInfo>\\n <DeviceId>ae296f3b04a58a05b30c95f1****</DeviceId>\\n <Available>false</Available>\\n </DeviceCheckInfo>\\n </DeviceCheckInfos>\\n</CheckDevicesResponse>","errorExample":""}]',
'title' => '批量检查设备有效性',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'BindTag' => [
'summary' => '将TAG绑定到指定的目标(设备、账号或别名),TAG绑定在10分钟内生效。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'ClientKey',
'in' => 'query',
'schema' => [
'description' => '设备或account或alias,多个key用逗号分隔,最多支持1000个。',
'type' => 'string',
'required' => true,
'example' => 'e2ba19de97604f55b16557673****',
],
],
[
'name' => 'KeyType',
'in' => 'query',
'schema' => [
'description' => 'ClientKey的类型。可取值:'."\n"
."\n"
.'- **DEVICE**:设备'."\n"
.'- **ACCOUNT**:账号'."\n"
.'- **ALIAS**:别名',
'type' => 'string',
'required' => true,
'example' => 'DEVICE',
'enum' => [
'DEVICE',
'ACCOUNT',
'ALIAS',
],
],
],
[
'name' => 'TagName',
'in' => 'query',
'schema' => [
'description' => '绑定的标签,多个标签用英文逗号(,)分隔,单次最多绑定 10 个标签。'."\n"
.'标签名称不超过 128 个字符(中文计 1 个字符),每个应用最多创建 10,000 个标签,单个设备可绑定多个标签。'."\n"
."\n"
.'><notice>'."\n"
."\n"
.'不建议单个标签绑定超过 10 万台设备,否则推送处理时间会延长,影响响应速度。'."\n"
.'如需对大量设备推送,建议采用以下方式:'."\n"
."\n"
.'- 使用全推功能直接推送给所有设备'."\n"
.'- 将设备集合拆分到多个细粒度标签,分批调用推送接口'."\n"
."\n"
.'></notice>'."\n"
."\n"
.'> - 重复绑定相同标签时系统将自动去重'."\n"
.'> - 设备卸载应用后,相关标签会自动解绑(存在一定延迟)',
'type' => 'string',
'required' => true,
'example' => 'test_tag,test_tag2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '82FD0A09-5BB8-40FB-8221-9A11FE92D620',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccountDisabled',
'errorMessage' => 'Your account is not enabled.',
],
[
'errorCode' => 'Invalid%s.Format',
'errorMessage' => 'The specified %s format is invalid.',
],
[
'errorCode' => 'Invalid%s.NotFound',
'errorMessage' => 'The specified %s is not found.',
],
],
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.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"82FD0A09-5BB8-40FB-8221-9A11FE92D620\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\n<BindTagResponse>\\n <RequestId>82FD0A09-5BB8-40FB-8221-9A11FE92D620</RequestId>\\n</BindTagResponse>","errorExample":""}]',
'title' => '绑定标签',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UnbindTag' => [
'summary' => '解绑指定的TAG和其目标之间的关系。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'ClientKey',
'in' => 'query',
'schema' => [
'description' => '设备、账号或别名,多个key用逗号分隔,最多支持1000个。',
'type' => 'string',
'required' => true,
'example' => 'e2ba19de97604f55b16557673****',
],
],
[
'name' => 'KeyType',
'in' => 'query',
'schema' => [
'description' => 'ClientKey的类型。可取值:'."\n"
."\n"
.'- **DEVICE**:设备'."\n"
.'- **ACCOUNT**:账号'."\n"
.'- **ALIAS**:别名',
'type' => 'string',
'required' => true,
'example' => 'DEVICE',
'enum' => [
'DEVICE',
'ACCOUNT',
'ALIAS',
],
],
],
[
'name' => 'TagName',
'in' => 'query',
'schema' => [
'description' => '绑定的Tag,多个Tag用逗号分隔,系统总共支持1万个Tag,此接口一次最多能解绑10个Tag。长度限制:不大于128字符。',
'type' => 'string',
'required' => true,
'example' => 'test_tag1,test_tag2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '159E4422-6624-4750-8943-DFD98D34858C',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"159E4422-6624-4750-8943-DFD98D34858C\\"\\n}","type":"json"}]',
'title' => '解绑标签',
],
'RemoveTag' => [
'summary' => '删除app下的TAG。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'TagName',
'in' => 'query',
'schema' => [
'description' => '要删除的Tag名称。单次只能删除一个Tag。长度限制:不大于128字符。',
'type' => 'string',
'required' => true,
'example' => 'test_tag',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '23000F3C-0EFE-4C89-82EE-E04F42D37B3C',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"23000F3C-0EFE-4C89-82EE-E04F42D37B3C\\"\\n}","type":"json"}]',
'title' => '删除标签',
'description' => '标签删除需要一定的删除时间,这个时间根据绑定该标签的目标数而定,请勿在删除标签后短时间内重新创建同名标签,或批量删除标签后批量重新创建标签。建议同一个app删除和创建同一名称tag的间隔时间不小于5分钟,批量删除后创建tag建议间隔时间不小于删除数量×5分钟。',
],
'QueryTags' => [
'summary' => '查询指定对象(设备、账号或别名)的TAG列表。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'ClientKey',
'in' => 'query',
'schema' => [
'description' => '设备、账号或别名, 每次只能查询1个clientKey。',
'type' => 'string',
'required' => true,
'example' => 'e2ba19de97604f55b165576****',
],
],
[
'name' => 'KeyType',
'in' => 'query',
'schema' => [
'description' => 'ClientKey的类型。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
'ACCOUNT' => '账号',
'ALIAS' => '别名',
'DEVICE' => '设备',
],
'example' => 'DEVICE',
'enum' => [
'DEVICE',
'ACCOUNT',
'ALIAS',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D68AE5C6-8AAF-46C9-B627-3FDACD1A4168',
],
'TagInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagInfo' => [
'description' => 'Tag列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagName' => [
'description' => '绑定的Tag名称。',
'type' => 'string',
'example' => 'test_tag2',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D68AE5C6-8AAF-46C9-B627-3FDACD1A4168\\",\\n \\"TagInfos\\": {\\n \\"TagInfo\\": [\\n {\\n \\"TagName\\": \\"test_tag2\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\n<QueryTagsResponse>\\n <RequestId>1197FEB8-3644-4355-A96D-E332F45470EA</RequestId>\\n <TagInfos>\\n <TagInfo>\\n <TagName>test_tag2</TagName>\\n </TagInfo>\\n <TagInfo>\\n <TagName>test_tag1</TagName>\\n </TagInfo>\\n </TagInfos>\\n</QueryTagsResponse>","errorExample":""}]',
'title' => '查询标签列表',
],
'ListTags' => [
'summary' => '查询app的标签列表,最多返回100条记录。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '6EEF262B-EA7D-41DC-89B9-20F3D1E28194',
],
'TagInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagInfo' => [
'description' => 'Tag列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagName' => [
'description' => 'Tag名称。',
'type' => 'string',
'example' => 'test_tag2',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'Timeout',
'errorMessage' => 'The request processing is timeout.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.',
],
],
],
'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"}]',
'title' => '获取标签列表',
],
'BindAlias' => [
'summary' => '绑定设备和别名的关系。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => [
'description' => '设备在推送的唯一标识,32位,数字和小写字母组合。',
'type' => 'string',
'required' => true,
'example' => 'e2ba19de97604f55b16557673****',
],
],
[
'name' => 'AliasName',
'in' => 'query',
'schema' => [
'description' => '需要绑定的别名。'."\n"
."\n"
.'一次最多只能绑定10个,多个alias用逗号分隔,alias最长128个字节(中文算三个字节),一个设备最多绑定128个别名,一个别名最多允许绑定128个设备。',
'type' => 'string',
'required' => true,
'example' => 'test_alias',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '159E4422-6624-4750-8943-DFD98D34858C',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Invalid%s.Format',
'errorMessage' => 'The specified %s format is invalid.',
],
[
'errorCode' => 'Invalid%s.BytesExceed',
'errorMessage' => 'The specified %s exceeds the %s bytes limit.',
],
[
'errorCode' => 'AccountDisabled',
'errorMessage' => 'Your account is not enabled.',
],
[
'errorCode' => 'Invalid%s.NotFound',
'errorMessage' => 'The specified %s is not found.',
],
],
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.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"159E4422-6624-4750-8943-DFD98D34858C\\"\\n}","errorExample":""},{"type":"xml","example":"<BindAliasResponse>\\n <RequestId>159E4422-6624-4750-8943-DFD98D34858C</RequestId>\\n</BindAliasResponse>","errorExample":""}]',
'title' => '绑定别名',
'description' => '一次最多绑定10个别名,绑定之后立即生效。',
],
'UnbindAlias' => [
'summary' => '解绑别名,解绑立即生效。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => [
'description' => '设备在推送的唯一标识,32位,数字和小写字母组合。',
'type' => 'string',
'required' => true,
'example' => 'e2ba19de97604f55b16557673****',
],
],
[
'name' => 'AliasName',
'in' => 'query',
'schema' => [
'description' => '需要绑定的alias。'."\n"
."\n"
.'Alias支持128个字节(一个中文字符算3个字节),当“UnbindAll”为”false”时该字段必填,一次最多解绑10个,多个alias用逗号分隔。',
'type' => 'string',
'required' => false,
'example' => 'test_alias',
],
],
[
'name' => 'UnbindAll',
'in' => 'query',
'schema' => [
'description' => '是否全部解绑,默认为”false”。'."\n"
."\n"
.'如果值为”true”,则解绑一个设备当前绑定的所有别名;如果值为”false”,则解绑”AliasName”指定的别名。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '159E4422-6624-4750-8943-DFD98D34858C',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"159E4422-6624-4750-8943-DFD98D34858C\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\n<UnbindAliasResponse>\\n <RequestId>82FD0A09-5BB8-40FB-8221-9A11FE92D620</RequestId>\\n</UnbindAliasResponse>","errorExample":""}]',
'title' => '解绑别名',
],
'QueryAliases' => [
'summary' => '查询指定设备绑定的别名列表。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => [
'description' => '设备在推送的唯一标识,32位,数字和小写字母组合。',
'type' => 'string',
'required' => true,
'example' => 'e2ba19de97604f55b165576****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '159E4422-6624-4750-8943-DFD98D34858C',
],
'AliasInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AliasInfo' => [
'description' => '别名列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AliasName' => [
'description' => '别名名称。',
'type' => 'string',
'example' => 'test_alias1',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"159E4422-6624-4750-8943-DFD98D34858C\\",\\n \\"AliasInfos\\": {\\n \\"AliasInfo\\": [\\n {\\n \\"AliasName\\": \\"test_alias1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryAliasesResponse>\\n <RequestId>159E4422-6624-4750-8943-DFD98D34858C</RequestId>\\n <AliasInfos>\\n <AliasName>test_alias1</AliasName>\\n </AliasInfos>\\n</QueryAliasesResponse>","errorExample":""}]',
'title' => '查询别名',
],
'QueryDevicesByAlias' => [
'summary' => '通过别名查询对应的设备列表。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'Alias',
'in' => 'query',
'schema' => [
'description' => '别名,一次仅支持查询一个。',
'type' => 'string',
'required' => true,
'example' => 'test_alias',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DeviceIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DeviceId' => [
'description' => '设备ID列表。',
'type' => 'array',
'items' => [
'description' => '设备ID',
'type' => 'string',
'example' => 'f6e43770afb944a1a879b4613****',
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '6A9FD644-35A5-40E4-89B0-2021CAEDC1B4',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DeviceIds\\": {\\n \\"DeviceId\\": [\\n \\"f6e43770afb944a1a879b4613****\\"\\n ]\\n },\\n \\"RequestId\\": \\"6A9FD644-35A5-40E4-89B0-2021CAEDC1B4\\"\\n}","type":"json"}]',
'title' => '通过别名查询设备列表',
],
'QueryDevicesByAccount' => [
'summary' => '通过账户名称查询对应的设备列表。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'Account',
'in' => 'query',
'schema' => [
'description' => '账户名称,一次仅支持查询一个。',
'type' => 'string',
'required' => true,
'example' => 'test_account',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'A8A24108-2AD0-4F6E-81C7-A8A24C2C2AD0',
],
'DeviceIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DeviceId' => [
'description' => '设备ID列表。',
'type' => 'array',
'items' => [
'description' => '设备ID',
'type' => 'string',
'example' => 'f6e43770afb944a1a879b46130ZZ****',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccountLimitExceed',
'errorMessage' => 'The number of devices bound to the account exceeds 10000.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A8A24108-2AD0-4F6E-81C7-A8A24C2C2AD0\\",\\n \\"DeviceIds\\": {\\n \\"DeviceId\\": [\\n \\"f6e43770afb944a1a879b46130ZZ****\\"\\n ]\\n }\\n}","type":"json"}]',
'title' => '通过账户查询设备列表',
],
'BindPhone' => [
'summary' => '绑定设备与手机号的关系。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'enumValueTitles' => [],
'example' => '27725900',
],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => [
'description' => '设备的唯一标识,32位,数字和小写字母组合。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'eb5f741d83d04d34807d229999eefa52',
],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
'schema' => [
'description' => '电话号码。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => '1381111****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '0D1126F0-F8FF-513D-BAFA-F140447BDED4',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0D1126F0-F8FF-513D-BAFA-F140447BDED4\\"\\n}","errorExample":""},{"type":"xml","example":"<BindPhoneResponse>\\n <RequestId>0D1126F0-F8FF-513D-BAFA-F140447BDED4</RequestId>\\n</BindPhoneResponse>","errorExample":""}]',
'title' => '绑定手机号码',
],
'UnbindPhone' => [
'summary' => '解绑指定设备上已绑定的手机号码。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => [
'description' => '设备的唯一标识,32位,数字和小写字母组合。',
'type' => 'string',
'required' => true,
'example' => 'eb5f741d83d04d34807d229999eefa52',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '0D1126F0-F8FF-513D-BAFA-F140447BDED4',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0D1126F0-F8FF-513D-BAFA-F140447BDED4\\"\\n}","errorExample":""},{"type":"xml","example":"<UnbindPhoneResponse>\\n <RequestId>0D1126F0-F8FF-513D-BAFA-F140447BDED4</RequestId>\\n</UnbindPhoneResponse>","errorExample":""}]',
'title' => '解绑手机号码',
],
'PushMessageToiOS' => [
'summary' => '推送消息到iOS设备端,消息通过阿里云推送自有通道下发。设备上App接收到消息后,需要自行处理后续动作,比如实现业务行为,或者构造本地通知弹出等。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '24780725',
],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => '推送目标。可取值:'."\n"
."\n"
.'- **DEVICE**:根据设备推送'."\n"
.'- **ACCOUNT**:根据账号推送'."\n"
.'- **ALIAS**:根据别名推送'."\n"
.'- **TAG**:根据标签推送'."\n"
.'- **ALL**:推送给全部设备',
'type' => 'string',
'required' => true,
'example' => 'ALL',
'enum' => [
'ALL',
'DEVICE',
'ACCOUNT',
'ALIAS',
'TAG',
],
],
],
[
'name' => 'TargetValue',
'in' => 'query',
'schema' => [
'description' => '根据Target来设定,多个值使用逗号分隔,超过限制需要分多次推送。'."\n"
."\n"
.'- Target=DEVICE,值如`deviceid111,deviceid1111`(最多支持1000个)。'."\n"
.'- Target=ACCOUNT,值如`account111,account222`(最多支持1000个)。'."\n"
.'- Target=ALIAS,值如`alias111,alias222`(最多支持1000个)。'."\n"
.'- Target=TAG,支持单Tag和多Tag,格式请参见[标签格式](~~434847~~)。'."\n"
.'- Target=ALL,值为**all**。',
'type' => 'string',
'required' => true,
'example' => 'all',
],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => [
'description' => '发送的消息的标题。',
'type' => 'string',
'required' => true,
'example' => 'my title',
],
],
[
'name' => 'Body',
'in' => 'query',
'schema' => [
'description' => '发送的消息内容。',
'type' => 'string',
'required' => true,
'example' => 'my body',
],
],
[
'name' => 'StoreOffline',
'in' => 'query',
'schema' => [
'description' => '消息是否离线保存。StoreOffline默认设置为false。'."\n"
."\n"
.'若保存,在推送时候用户不在线,在过期时间(ExpireTime)内用户上线时会被再次发送。ExpireTime默认为72小时。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'JobKey',
'in' => 'query',
'schema' => [
'description' => '推送任务自定义标识,当JobKey不为空时,回执日志中会附带该字段。查看回执日志参见[回执日志](~~434651~~)。',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '标志一次推送的消息ID。',
'type' => 'string',
'example' => '501029',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"501029\\",\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","type":"json"}]',
'title' => '推送消息给iOS设备',
'description' => '**这个接口即将废弃,请使用具备更多推送能力的[高级推送接口](~~2249916~~),在该接口中指定推送平台`DeviceType`为`iOS`,推送类型`PushType`为`MESSAGE`,即可达到同样效果。**'."\n"
."\n"
.'**请确保在使用该接口前,以充分了解EMAS移动推送产品的[收费方式和价格](~~434638~~)。**'."\n"
."\n"
.'该接口默认只把消息发送给在线设备,若设备离线,则需要设置`StoreOffline`参数,推送系统会保存该消息,等到设备上线后再自动下发信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'PushNoticeToiOS' => [
'summary' => '推送通知到 iOS 设备端,通知通过苹果APNs通道下发,并直接在设备通知栏弹出。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => 'AppKey信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '24780725',
],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => '推送目标。可取值:'."\n"
."\n"
.'- **DEVICE**:根据设备推送'."\n"
.'- **ACCOUNT**:根据账号推送'."\n"
.'- **ALIAS**:根据别名推送'."\n"
.'- **TAG**:根据标签推送'."\n"
.'- **ALL**:推送给全部设备',
'type' => 'string',
'required' => true,
'example' => 'ALL',
'enum' => [
'ALL',
'DEVICE',
'ACCOUNT',
'ALIAS',
'TAG',
],
],
],
[
'name' => 'TargetValue',
'in' => 'query',
'schema' => [
'description' => '根据Target来设定,多个值使用逗号分隔,超过限制需要分多次推送。'."\n"
."\n"
.'- Target=DEVICE,值如`deviceid111,deviceid1111`(最多支持1000个)。'."\n"
.'- Target=ACCOUNT,值如`account111,account222`(最多支持1000个)。'."\n"
.'- Target=ALIAS,值如`alias111,alias222`(最多支持1000个)。'."\n"
.'- Target=TAG,支持单Tag和多Tag,格式请参见[标签格式](~~434847~~)。'."\n"
.'- Target=ALL,值为**ALL**。',
'type' => 'string',
'required' => true,
'example' => 'ALL',
],
],
[
'name' => 'ApnsEnv',
'in' => 'query',
'schema' => [
'description' => 'iOS的通知是通过APNS中心来发送的,需要填写对应的环境信息。'."\n"
.'- DEV:表示开发环境'."\n"
.'- PRODUCT:表示生产环境',
'type' => 'string',
'required' => true,
'example' => 'DEV',
'enum' => [
'DEV',
'PRODUCT',
],
],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => [
'description' => '推送的通知的标题。'."\n"
.'- iOS 10+通知显示标题。'."\n"
.'- iOS 8.2 <= iOS系统 < iOS 10:替换通知应用名称。',
'type' => 'string',
'required' => false,
'example' => 'title',
],
],
[
'name' => 'Body',
'in' => 'query',
'schema' => [
'description' => '推送的通知内容。',
'type' => 'string',
'required' => true,
'example' => 'Hello World',
],
],
[
'name' => 'JobKey',
'in' => 'query',
'schema' => [
'description' => '推送任务自定义标识,当JobKey不为空时,回执日志中会附带该字段。查看回执日志参见[回执日志](~~434651~~)。',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
[
'name' => 'ExtParameters',
'in' => 'query',
'schema' => [
'description' => '自定义的KV结构,开发者扩展用。'."\n"
."\n"
.'> 针对iOS设备,该参数要以JSON map的格式传入,否则会解析出错。',
'type' => 'string',
'required' => false,
'example' => '{"k1":"ios","k2":"v2"}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '标志一次推送的消息ID。',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '501029',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"RequestId\\": \\"501029\\"\\n}","type":"json"}]',
'title' => '推送通知给iOS设备',
'description' => '**这个接口即将废弃,请使用具备更多推送能力的[高级推送接口](~~2249916~~),在该接口中指定推送平台`DeviceType`为`iOS`,推送类型`PushType`为`NOTICE`,即可达到同样效果。**'."\n"
."\n"
.'**请确保在使用该接口前,以充分了解EMAS移动推送产品的[收费方式和价格](~~434638~~)。**',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'PushNoticeToAndroid' => [
'summary' => '推送通知到Android设备端,并直接在设备通知栏弹出。通知根据不同情况,可能会走阿里云自有通道,或者手机厂商通道下发。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => '推送目标。可取值:'."\n"
."\n"
.'- **DEVICE**:根据设备推送'."\n"
.'- **ACCOUNT**:根据账号推送'."\n"
.'- **ALIAS**:根据别名推送'."\n"
.'- **TAG**:根据标签推送'."\n"
.'- **ALL**:推送给全部设备',
'type' => 'string',
'required' => true,
'example' => 'ALL',
'enum' => [
'ALL',
'DEVICE',
'ACCOUNT',
'ALIAS',
'TAG',
],
],
],
[
'name' => 'TargetValue',
'in' => 'query',
'schema' => [
'description' => '根据Target来设定,多个值使用逗号分隔,超过限制需要分多次推送。'."\n"
."\n"
.'- Target=DEVICE,值如`deviceid111,deviceid1111`(最多支持1000个)。'."\n"
.'- Target=ACCOUNT,值如`account111,account222`(最多支持1000个)。'."\n"
.'- Target=ALIAS,值如`alias111,alias222`(最多支持1000个)。'."\n"
.'- Target=TAG,支持单Tag和多Tag,格式请参见[标签格式](~~434847~~)。'."\n"
.'- Target=ALL,值为**ALL**。',
'type' => 'string',
'required' => true,
'example' => 'ALL',
],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => [
'description' => '发送的通知标题。',
'type' => 'string',
'required' => true,
'example' => 'title',
],
],
[
'name' => 'Body',
'in' => 'query',
'schema' => [
'description' => '发送的通知内容。',
'type' => 'string',
'required' => true,
'example' => 'body',
],
],
[
'name' => 'StoreOffline',
'in' => 'query',
'schema' => [
'description' => '通知是否离线保存。StoreOffline默认设置为false。'."\n"
."\n"
.'若保存,在推送时候用户不在线,在过期时间(ExpireTime)内用户上线时会被再次发送。ExpireTime默认为72小时。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'JobKey',
'in' => 'query',
'schema' => [
'description' => '推送任务自定义标识,当JobKey不为空时,回执日志中会附带该字段。查看回执日志参见[回执日志](~~434651~~)。',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
[
'name' => 'ExtParameters',
'in' => 'query',
'schema' => [
'description' => '自定义的KV结构,供开发者扩展使用,针对Android设备。该参数要以JSON map的格式传入。',
'type' => 'string',
'required' => false,
'example' => '{"key1":"value1","api_name":"PushNoticeToAndroidRequest"}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '标志一次推送的消息ID。',
'type' => 'string',
'example' => '501029',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"501029\\",\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","type":"json"}]',
'title' => '推送通知给Android设备',
'description' => '**这个接口即将废弃,请使用具备更多推送能力的[高级推送接口](~~2249916~~),在该接口中指定推送平台`DeviceType`为`ANDROID`,推送类型`PushType`为`NOTICE`,即可达到同样效果。**'."\n"
."\n"
.'**请确保在使用该接口前,以充分了解EMAS移动推送产品的[收费方式和价格](~~434638~~)。**',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'PushMessageToAndroid' => [
'summary' => '推送消息到Android设备端,消息通过阿里云推送自有通道下发。设备上App接收到消息后,需要自行处理后续动作,比如实现业务行为,或者构造本地通知弹出等。',
'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信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => '推送目标。可取值:'."\n"
."\n"
.'- **DEVICE**:根据设备推送'."\n"
.'- **ACCOUNT**:根据账号推送'."\n"
.'- **ALIAS**:根据别名推送'."\n"
.'- **TAG**:根据标签推送'."\n"
.'- **ALL**:推送给全部设备',
'type' => 'string',
'required' => true,
'example' => 'ALL',
'enum' => [
'ALL',
'DEVICE',
'ACCOUNT',
'ALIAS',
'TAG',
],
],
],
[
'name' => 'TargetValue',
'in' => 'query',
'schema' => [
'description' => '根据Target来设定,多个值使用逗号分隔,超过限制需要分多次推送。'."\n"
."\n"
.'- Target=DEVICE,值如`deviceid111,deviceid1111`(最多支持1000个)。'."\n"
.'- Target=ACCOUNT,值如`account111,account222`(最多支持1000个)。'."\n"
.'- Target=ALIAS,值如`alias111,alias222`(最多支持1000个)。'."\n"
.'- Target=TAG,支持单Tag和多Tag,格式请参见[标签格式](~~434847~~)。'."\n"
.'- Target=ALL,值为**all**。',
'type' => 'string',
'required' => true,
'example' => 'all',
],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => [
'description' => '发送的消息的标题。',
'type' => 'string',
'required' => true,
'example' => 'my title',
],
],
[
'name' => 'Body',
'in' => 'query',
'schema' => [
'description' => '发送的消息内容。',
'type' => 'string',
'required' => true,
'example' => 'my body',
],
],
[
'name' => 'StoreOffline',
'in' => 'query',
'schema' => [
'description' => '消息是否离线保存。StoreOffline默认设置为false。'."\n"
."\n"
.'若保存,在推送时候用户不在线,在过期时间(ExpireTime)内用户上线时会被再次发送。ExpireTime默认为72小时。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'JobKey',
'in' => 'query',
'schema' => [
'description' => '推送任务自定义标识,当JobKey不为空时,回执日志中会附带该字段。查看回执日志参见[回执日志](~~434651~~)。',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '标志一次推送的消息ID。',
'type' => 'string',
'example' => '501029',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Invalid%s.Format',
'errorMessage' => 'The specified %s format is invalid.',
],
[
'errorCode' => 'Invalid%s.Empty',
'errorMessage' => 'The specified %s cannot be empty.',
],
[
'errorCode' => 'Invalid.Parameter',
'errorMessage' => 'The specified parameter is invalid: %s.',
],
],
500 => [
[
'errorCode' => 'Timeout',
'errorMessage' => 'The request processing is timeout.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"501029\\",\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","type":"json"}]',
'title' => '推送消息给Android设备',
'description' => '**这个接口即将废弃,请使用具备更多推送能力的[高级推送接口](~~2249916~~),在该接口中指定推送平台`DeviceType`为`ANDROID`,推送类型`PushType`为`MESSAGE`,即可达到同样效果。**'."\n"
."\n"
.'**请确保在使用该接口前,以充分了解EMAS移动推送产品的[收费方式和价格](~~434638~~)。**'."\n"
."\n"
.'该接口默认只把消息发送给在线设备,若设备离线,则需要设置`StoreOffline`参数,推送系统会保存该消息,等到设备上线后再自动下发信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CheckDevice' => [
'summary' => '验证指定设备的有效性。',
'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' => 'AppKey信息。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23419851',
],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => [
'description' => '设备在推送的唯一标识,32位,数字和小写字母组合。',
'type' => 'string',
'required' => true,
'example' => 'ae296f3b04a58a05b30c95f****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Available' => [
'description' => '是否可用。',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
],
],
],
],
'staticInfo' => [
'substitutions' => [
'Push::2016-08-01::CheckDevices',
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Available\\": true,\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\n<CheckDevicesResponse>\\n <RequestId>9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC</RequestId>\\n <DeviceCheckInfos>\\n <DeviceCheckInfo>\\n <DeviceId>ae296f3b04a58a05b30c95f1****</DeviceId>\\n <Available>true</Available>\\n </DeviceCheckInfo>\\n <DeviceCheckInfo>\\n <DeviceId>ae296f3b04a58a05b30c95f1****</DeviceId>\\n <Available>true</Available>\\n </DeviceCheckInfo>\\n <DeviceCheckInfo>\\n <DeviceId>ae296f3b04a58a05b30c95f1****</DeviceId>\\n <Available>false</Available>\\n </DeviceCheckInfo>\\n </DeviceCheckInfos>\\n</CheckDevicesResponse>","errorExample":""}]',
'title' => '验证设备有效性',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListSummaryApps' => [
'summary' => '查询云账号下所有app的列表。',
'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' => '请求ID。',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
'SummaryAppInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SummaryAppInfo' => [
'description' => 'app详情,SummaryAppInfo组成的集合。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AppKey' => [
'description' => 'AppKey信息。',
'type' => 'integer',
'format' => 'int64',
'example' => '23****07',
],
'AppName' => [
'description' => '应用的名称。',
'type' => 'string',
'example' => 'abc',
],
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'substitutions' => [
'Mhub::2017-08-25::ListApps',
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"SummaryAppInfos\\": {\\n \\"SummaryAppInfo\\": [\\n {\\n \\"AppKey\\": 0,\\n \\"AppName\\": \\"abc\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListSummaryAppsResponse>\\n <RequestId>9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC</RequestId>\\n <SummaryAppInfos>\\n <AppName>abc</AppName>\\n </SummaryAppInfos>\\n</ListSummaryAppsResponse>","errorExample":""}]',
'title' => '查询用户已创建的app列表',
],
],
'endpoints' => [
[
'regionId' => 'ap-northeast-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'ap-northeast-2-pop',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'ap-south-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-2',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-3',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-5',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-beijing',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-finance-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-finance-pop',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-gov-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-nu16-b01',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-chengdu',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-edge-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-fujian',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-haidian-cm12-c01',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-bj-b01',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-finance',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-prod-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-2',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-3',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-test-306',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong-finance-pop',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-huhehaote',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-north-2-gov-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-qingdao',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-qingdao-nebula',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-et15-b01',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-et2-b01',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-finance-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-inner',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-internal-test-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-finance-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-inner',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-st4-d01',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-su18-b01',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-wuhan',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-yushanfang',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-zhangbei-na61-b01',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-zhangjiakou',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-zhangjiakou-na62-a01',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-zhengzhou-nebula-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'eu-central-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'eu-west-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'eu-west-1-oxs',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'me-east-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'rus-west-1-pop',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'us-east-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'us-west-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
],
];
|