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
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'ROA', 'product' => 'LingMou', 'version' => '2025-05-27'],
'directories' => [
[
'children' => ['CreateBroadcastSticker', 'DeleteBroadcastSticker', 'ListBroadcastTemplates', 'GetBroadcastTemplate', 'CreateBroadcastVideoFromTemplate', 'ListBroadcastVideosById', 'CreateBroadcastAudio', 'ListBroadcastAudiosById'],
'type' => 'directory',
'title' => 'Digital human broadcasting',
],
[
'children' => [
'GetUploadPolicy',
[
'children' => ['CreateTTSVoiceCustom', 'GetTTSVoiceByIdCustom', 'ListPrivateTTSVoicesCustom'],
'type' => 'directory',
'title' => 'Voice',
],
[
'children' => ['ListTemplateMaterial', 'CreateTrainPicAvatar', 'ConfirmTrainPicAvatar', 'GetTrainPicAvatarStatus'],
'type' => 'directory',
'title' => 'Image-based digital human',
],
[
'children' => ['CreateBackgroundPic'],
'type' => 'directory',
'title' => 'Conversation background image',
],
[
'children' => ['CreateNoTrainPicAvatar'],
'type' => 'directory',
'title' => 'Training-free image-based digital human',
],
],
'type' => 'directory',
'title' => 'Digital human asset synthesis and management',
],
[
'children' => ['CreateChatConfig', 'CreateChatSession', 'CloseChatInstanceSessions', 'QueryChatInstanceSessions'],
'type' => 'directory',
'title' => 'Digital human conversation',
],
[
'children' => ['ListPublicBroadcastSceneTemplates', 'CopyBroadcastSceneFromTemplate'],
'type' => 'directory',
'title' => 'Others',
],
],
'components' => [
'schemas' => [
'BroadcastAudio' => [
'description' => 'The broadcast audio object.',
'type' => 'object',
'properties' => [
'id' => ['description' => 'The ID of the audio.', 'type' => 'string', 'title' => '', 'example' => 'M1Ju6XhHog_e-lSeb80Slp9g'],
'createTime' => ['description' => 'The time the audio was created.', 'type' => 'string', 'title' => '', 'example' => '2026-01-22T01:59:03'],
'modifiedTime' => ['description' => 'The time the audio was last modified.', 'type' => 'string', 'title' => '', 'example' => '2026-01-22T01:59:03'],
'name' => ['description' => 'The name of the audio.', 'type' => 'string', 'title' => '', 'example' => '播报音频'],
'status' => [
'description' => 'The status of the audio.',
'enumValueTitles' => ['SUCCESS' => 'Detection succeeded', 'PROCESSING' => 'Detecting', 'ERROR' => 'Detection failed'],
'type' => 'string',
'title' => '',
'example' => 'SUCCESS',
],
'audioLength' => ['description' => 'The duration of the audio in seconds.', 'type' => 'integer', 'title' => '', 'example' => '10', 'format' => 'int32'],
'errorCode' => ['description' => 'The error code. Returned only when `status=ERROR`.'."\n"
."\n"
.'**Possible values:**'."\n"
."\n"
.'- **DataInspectionFailed**: Content Moderation blocked the audio because it may contain sensitive content.'."\n"
."\n"
.'- **Audio.NoValidSpeech**: The audio contains no valid speech (for example, a silent audio file).', 'type' => 'string', 'title' => '', 'example' => 'DataInspectionFailed'],
],
'title' => '',
'example' => '',
],
'BroadcastScene' => [
'description' => 'Contains the properties of a broadcast scene.',
'type' => 'object',
'properties' => [
'createTime' => ['description' => 'Creation Time ', 'type' => 'string', 'example' => '2026-03-24T11:21:27.691732', 'title' => ''],
'modifiedTime' => ['description' => 'Updated At ', 'type' => 'string', 'example' => '2026-03-24T11:21:27.691732', 'title' => ''],
'name' => ['description' => 'Title ', 'type' => 'string', 'example' => '播报测试', 'title' => ''],
'ratio' => ['description' => 'Aspect ratio ', 'type' => 'string', 'example' => '9:16', 'title' => ''],
'status' => [
'enumValueTitles' => ['INIT' => 'Initialization ', 'SUCCESS' => 'Succeeded ', 'DRAFT' => 'Draft ', 'PROCESSING' => 'Generating ', 'ERROR' => 'Failed ', 'PREPROCESSED' => 'Pre-processing completed '],
'description' => 'Status ',
'type' => 'string',
'example' => 'DRAFT',
'title' => '',
],
'remainSeconds' => ['description' => 'Estimated generation time, in seconds. ', 'type' => 'integer', 'format' => 'int64', 'example' => '300', 'title' => ''],
'version' => ['description' => 'Version number. ', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'clipInfo' => ['description' => 'Video editing segment information ', 'type' => 'string', 'example' => '{}', 'title' => ''],
'previewURL' => ['description' => 'Preview video after training succeeds. ', 'type' => 'string', 'example' => 'https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/BS1CQEYXYQW4MQU2/preview.mp4', 'title' => ''],
'shortVideoURL' => ['description' => 'Video URL ', 'type' => 'string', 'example' => 'https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/BS1CQEYXYQW4MQU2/result.mp4', 'title' => ''],
'downloadURL' => ['description' => 'Video download URL ', 'type' => 'string', 'example' => 'https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/BS1CQEYXYQW4MQU2/result.mp4', 'title' => ''],
'coverURL' => ['description' => 'Thumbnail URL. ', 'type' => 'string', 'example' => 'https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/BS1CQEYXYQW4MQU2/cover.jpg', 'title' => ''],
'thumbnailURL' => ['description' => 'Thumbnail URL ', 'type' => 'string', 'example' => 'https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/BS1CQEYXYQW4MQU2/thumbnail.jpg', 'title' => ''],
'id' => ['description' => 'Template ID. ', 'type' => 'string', 'example' => 'BS1WgG5zb-N1GI8nId3r6wo8g', 'title' => ''],
],
'title' => '',
'example' => '',
],
'BroadcastSceneTemplate' => [
'description' => 'The broadcast scene template.',
'type' => 'object',
'properties' => [
'createTime' => ['description' => 'Creation Time. ', 'type' => 'string', 'example' => '2026-01-06T07:00:02Z', 'title' => ''],
'modifiedTime' => ['description' => 'Updated At. ', 'type' => 'string', 'example' => '2026-01-06T07:00:02Z', 'title' => ''],
'name' => ['description' => 'Broadcast template name. ', 'type' => 'string', 'example' => '播报测试', 'title' => ''],
'desc' => ['description' => 'Description. ', 'type' => 'string', 'example' => '视频描述', 'title' => ''],
'ratio' => ['description' => 'Template aspect ratio. ', 'type' => 'string', 'example' => '9:16', 'title' => ''],
'previewURL' => ['description' => 'Preview video after training succeeds. ', 'type' => 'string', 'example' => 'https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CSNSAsOIDZQU2/result.mp4', 'title' => ''],
'shortVideoURL' => ['description' => 'Video URL. ', 'type' => 'string', 'example' => 'https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CSNSAsOIDZQU2/result_preview.mp4', 'title' => ''],
'coverURL' => ['description' => 'Thumbnail URL. ', 'type' => 'string', 'example' => 'https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CSNSAsOIDZQU2/cover.jpg', 'title' => ''],
'thumbnailURL' => ['description' => 'Thumbnail URL. ', 'type' => 'string', 'example' => 'https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CSNSAsOIDZQU2/thumbnail.jpg', 'title' => ''],
'id' => ['description' => 'Template ID. ', 'type' => 'string', 'example' => 'BS1tneDiuOOjJmI2qOHGw1urA', 'title' => ''],
'tags' => [
'description' => 'Tag System. ',
'type' => 'array',
'items' => ['description' => 'Label information. ', 'type' => 'string', 'example' => 'AI,BROADCAST', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'BroadcastTemplate' => [
'description' => 'A broadcast template.',
'type' => 'object',
'properties' => [
'createTime' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', 'example' => '2025-11-28T10:11:28'],
'modifiedTime' => ['description' => 'The modification time.', 'type' => 'string', 'title' => '', 'example' => '2025-11-28T11:11:28'],
'name' => ['description' => 'The template name.', 'type' => 'string', 'title' => '', 'example' => '测试播报模板'],
'id' => ['description' => 'The template ID.', 'type' => 'string', 'title' => '', 'example' => 'BS1b2WNnRMu4ouRzT4clY9Jhg'],
'variables' => [
'description' => 'A list of dynamic variables.',
'type' => 'array',
'items' => ['description' => 'A dynamic variable.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/TemplateVariable'],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'BroadcastVideo' => [
'description' => 'Contains the details of a broadcast video.',
'type' => 'object',
'properties' => [
'id' => ['description' => 'The video ID.', 'type' => 'string', 'title' => '', 'example' => 'M1k3So6n9IlrDV69sr3jDa3g'],
'createTime' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', 'example' => '2025-11-28T13:40:33'],
'modifiedTime' => ['description' => 'The modification time.', 'type' => 'string', 'title' => '', 'example' => '2025-11-28T13:41:31'],
'name' => ['description' => 'The video name.', 'type' => 'string', 'title' => '', 'example' => '播报视频合成测试'],
'status' => [
'description' => 'The video status. The value can be:'."\n"
."\n"
.'- `PROCESSING`: The synthesis is in progress.'."\n"
."\n"
.'- `SUCCESS`: The synthesis was successful.'."\n"
."\n"
.'- `ERROR`: The synthesis failed.',
'enumValueTitles' => ['SUCCESS' => 'SUCCESS', 'PROCESSING' => 'PROCESSING', 'ERROR' => 'ERROR'],
'type' => 'string',
'title' => '',
'example' => 'SUCCESS',
],
'coverURL' => ['description' => 'The cover image URL.', 'type' => 'string', 'title' => '', 'example' => 'https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CQEYXYQW4MQU2/cover.jpg'],
'videoURL' => ['description' => 'The video URL.', 'type' => 'string', 'title' => '', 'example' => 'https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CQEYXYQW4MQU2/result.mp4'],
'captionURL' => ['description' => 'The subtitle file URL.', 'type' => 'string', 'title' => '', 'example' => 'https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CQEYXYQW4MQU2/result.srt'],
'alignmentFileURL' => ['description' => 'The subtitle alignment file URL.', 'type' => 'string', 'title' => '', 'example' => 'https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CQEYXYQW4MQU2/alignment.json'],
],
'title' => '',
'example' => '',
],
'ChatSessionInfo' => [
'description' => 'Session information of Lingmou digital human.',
'type' => 'object',
'properties' => [
'sessionId' => ['description' => 'Session ID', 'type' => 'string', 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', 'title' => ''],
'mainAccountId' => ['description' => 'Main Account ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567', 'title' => ''],
'createdAt' => ['description' => 'Creation Time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1755680969', 'title' => ''],
],
'title' => '',
'example' => '',
],
'TemplateVariable' => [
'description' => 'Represents a dynamic variable in a live streaming template.',
'type' => 'object',
'properties' => [
'name' => ['description' => 'Variable name. ', 'type' => 'string', 'example' => 'test', 'title' => ''],
'type' => [
'enumValueTitles' => ['voice' => 'voice', 'image' => 'image', 'text' => 'text', 'avatar' => 'avatar'],
'description' => 'Variable Type. '."\n"
."\n"
.'- text: Text '."\n"
.'- image: Image '."\n"
.'- avatar: Digital human '."\n"
.'- voice: Voice ',
'type' => 'string',
'example' => 'text',
'title' => '',
],
'properties' => ['description' => 'Variable properties (JSON struct), which vary by type. '."\n"
."\n"
.'> - Text variable: contains the `content` field. '."\n"
.'> - Image variable: contains the `resourceId` and `fit` fields. '."\n"
.'> - Digital human variable: contains the `resourceId` field. '."\n"
.'> - Voice variable: contains the `resourceId` field. ', 'type' => 'any', 'example' => '{'."\n"
.' "content": "待替换内容"'."\n"
.'}', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'apis' => [
'CloseChatInstanceSessions' => [
'summary' => 'Closes one or more sessions of a chat instance.',
'path' => '/openapi/chat/instances/{instanceId}/sessions/close',
'methods' => ['put'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarWE6ABK', 'FEATUREavatar8ULNZ9', 'FEATUREavatarIODFBA'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => 'The ID of the chat instance. You can find this ID on the order page.', 'type' => 'string', 'required' => false, 'example' => 'avatar_2dchat_public_cn-xxxxxxx', 'title' => ''],
],
[
'name' => 'sessionIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'The IDs of sessions to be closed.',
'type' => 'array',
'items' => ['description' => 'The ID of the session to be closed.', 'type' => 'string', 'required' => false, 'example' => '8C9F2D4E-7A6B-4F1C-9E53-0B2C8D3F9A4B', 'title' => ''],
'required' => false,
'example' => '["8C9F2D4E-7A6B-4F1C-9E53-0B2C8D3F9A4B"]',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response schema.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the POP request.', 'type' => 'string', 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8'],
'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
'message' => ['description' => 'The status message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'data' => [
'description' => 'The response data.',
'type' => 'array',
'items' => ['description' => 'Details of each successfully closed session, including the session ID, main account ID, and creation timestamp.', '$ref' => '#/components/schemas/ChatSessionInfo', 'example' => '{"sessionId": "20250311-41523E3C-1D27-5844-8EEF-194E4714096B", "mainAccountId": 1234567, "createdAt": 1755680457}', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"success\\": true,\\n \\"code\\": \\"SUCCESS\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"sessionId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"mainAccountId\\": 1234567,\\n \\"createdAt\\": 1755680969\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Shut down sessions under an instance',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'lingmou:CloseChatInstanceSessions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 5, 'regionId' => '*', 'api' => 'CloseChatInstanceSessions'],
],
],
],
'ConfirmTrainPicAvatar' => [
'summary' => 'Confirms the status of a digital human avatar.',
'path' => '/openapi/train/confirmTrainPicAvatar',
'methods' => ['put'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarWE6ABK', 'FEATUREavatar8ULNZ9', 'FEATUREavatarIODFBA'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'avatarId',
'in' => 'query',
'schema' => ['description' => 'The ID of the digital human avatar.', 'type' => 'string', 'required' => true, 'example' => 'M1_eTNYgO5lOys5g7ObvC_nw ', 'title' => ''],
],
[
'name' => 'status',
'in' => 'query',
'schema' => [
'description' => 'Specifies the confirmation status of the digital human avatar.',
'enumValueTitles' => ['CUSTOMER_REJECTED' => 'Rejected', 'CUSTOMER_CONFIRMED' => 'Confirmed'],
'type' => 'string',
'required' => true,
'example' => 'CUSTOMER_CONFIRMED',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response data.',
'title' => 'Result<Void>',
'type' => 'object',
'properties' => [
'success' => ['title' => 'Encapsulates whether the current request processing succeeded or failed', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True'],
'code' => ['title' => 'Result code', 'description' => 'The response code.', 'type' => 'string', 'example' => '200'],
'message' => ['title' => 'Error message returned when request processing fails', 'description' => 'The response message.', 'type' => 'string', 'example' => 'success'],
'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', 'title' => ''],
'httpStatusCode' => ['title' => 'Returned HTTP status code', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
'title' => 'Result confirmation.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ConfirmTrainPicAvatar'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'lingmou:ConfirmTrainPicAvatar',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CopyBroadcastSceneFromTemplate' => [
'summary' => 'Copies a broadcast template to create a private broadcast scene.',
'path' => '/openapi/customer/broadcast/template/scene/copyByTemplate',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarYF4CD3'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'The request body.',
'type' => 'object',
'properties' => [
'name' => ['title' => 'Broadcast Name', 'description' => 'The broadcast name.', 'type' => 'string', 'required' => true, 'example' => '播报视频合成测试'],
'ratio' => ['title' => 'Aspect ratio, such as 9:16 or 16:9', 'description' => 'The aspect ratio. Examples: 9:16 and 16:9.', 'type' => 'string', 'required' => true, 'example' => '9:16'],
'templateId' => ['title' => 'Template ID', 'description' => 'The template ID.', 'type' => 'string', 'required' => true, 'example' => 'BS1b2WNnRMu4ouRzT4clY9Jhg'],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Result<BroadcastSceneDTO>',
'type' => 'object',
'properties' => [
'data' => ['description' => 'The broadcast scene data.', '$ref' => '#/components/schemas/BroadcastScene', 'title' => '', 'example' => ''],
'success' => ['title' => 'Indicates whether the current request processing succeeded or failed', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True'],
'code' => ['title' => 'Result code', 'description' => 'The result code.', 'type' => 'string', 'example' => 'SUCCESS'],
'message' => ['title' => 'Error message returned when request processing fails', 'description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'SUCCESS'],
'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '435B4F80-8DEB-5CF6-AC86-395CB6CF28C9', 'title' => ''],
'httpStatusCode' => ['title' => 'Returned HTTP status code', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
'example' => '',
],
],
],
'title' => 'Copy broadcast scenario (from template)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CopyBroadcastSceneFromTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"createTime\\": \\"2026-03-24T11:21:27.691732\\",\\n \\"modifiedTime\\": \\"2026-03-24T11:21:27.691732\\",\\n \\"name\\": \\"播报测试\\",\\n \\"ratio\\": \\"9:16\\",\\n \\"status\\": \\"DRAFT\\",\\n \\"remainSeconds\\": 300,\\n \\"version\\": 0,\\n \\"clipInfo\\": \\"{}\\",\\n \\"previewURL\\": \\"https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/BS1CQEYXYQW4MQU2/preview.mp4\\",\\n \\"shortVideoURL\\": \\"https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/BS1CQEYXYQW4MQU2/result.mp4\\",\\n \\"downloadURL\\": \\"https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/BS1CQEYXYQW4MQU2/result.mp4\\",\\n \\"coverURL\\": \\"https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/BS1CQEYXYQW4MQU2/cover.jpg\\",\\n \\"thumbnailURL\\": \\"https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/BS1CQEYXYQW4MQU2/thumbnail.jpg\\",\\n \\"id\\": \\"BS1WgG5zb-N1GI8nId3r6wo8g\\"\\n },\\n \\"success\\": true,\\n \\"code\\": \\"SUCCESS\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"435B4F80-8DEB-5CF6-AC86-395CB6CF28C9\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
],
'CreateBackgroundPic' => [
'summary' => 'Creates a background material.',
'path' => '/openapi/chat/createBackgroundPic',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarWE6ABK', 'FEATUREavatar8ULNZ9', 'FEATUREavatarIODFBA'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ossKey',
'in' => 'query',
'schema' => ['description' => 'The key for the object in Object Storage Service (OSS).', 'type' => 'string', 'required' => false, 'example' => 'material/INPUT_CHAT_BACKGROUND_PIC/Mt.CN2VNOPRC5QU2', 'title' => ''],
],
[
'name' => 'filename',
'in' => 'query',
'schema' => ['description' => 'The filename.', 'type' => 'string', 'required' => false, 'example' => '1.jpg', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'data' => [
'description' => 'The data returned for the request.',
'type' => 'object',
'properties' => [
'id' => ['description' => 'The ID of the background material.', 'type' => 'string', 'example' => 'M1lhKArheOyYdeYybDFqS1-Q', 'title' => ''],
],
'title' => '',
'example' => '',
],
'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'message' => ['description' => 'The status message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', 'title' => ''],
'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create background material',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CreateBackgroundPic'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CreateBackgroundPic',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"id\\": \\"M1lhKArheOyYdeYybDFqS1-Q\\"\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
],
'CreateBroadcastAudio' => [
'path' => '/openapi/customer/broadcast/material/audio/create',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarYF4CD3'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'The request body.',
'type' => 'object',
'properties' => [
'ossKey' => ['description' => 'The object key for the file in OSS.', 'type' => 'string', 'required' => false, 'example' => 'material/INPUT_BROADCAST_INFER_AUDIO/Mt.CPRLVQRR27YU2', 'title' => ''],
'fileName' => ['description' => 'The file name.', 'type' => 'string', 'required' => false, 'example' => 'audio.mp3', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Result<AudioMaterialDTO>',
'type' => 'object',
'properties' => [
'data' => ['description' => 'The broadcast audio object.', '$ref' => '#/components/schemas/BroadcastAudio', 'title' => '', 'example' => ''],
'success' => ['title' => 'Indicates whether the current request processing succeeded or failed.', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True'],
'code' => ['title' => 'Result code', 'description' => 'The result code.', 'type' => 'string', 'example' => '200'],
'message' => ['title' => 'Error message returned when request processing fails.', 'description' => 'The result message. An error message is returned if the request fails.', 'type' => 'string', 'example' => 'SUCCESS'],
'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90C68329-A75C-5449-A928-4D0BAD7AA0FA', 'title' => ''],
'httpStatusCode' => ['title' => 'Returned HTTP status code.', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
'example' => '',
],
],
],
'title' => 'Create an audio announcement',
'summary' => 'Creates broadcast audio.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CreateBroadcastAudio',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"id\\": \\"M1Ju6XhHog_e-lSeb80Slp9g\\",\\n \\"createTime\\": \\"2026-01-22T01:59:03\\",\\n \\"modifiedTime\\": \\"2026-01-22T01:59:03\\",\\n \\"name\\": \\"播报音频\\",\\n \\"status\\": \\"SUCCESS\\",\\n \\"audioLength\\": 10,\\n \\"errorCode\\": \\"DataInspectionFailed\\"\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"90C68329-A75C-5449-A928-4D0BAD7AA0FA\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
],
'CreateBroadcastSticker' => [
'summary' => 'Create a broadcast sticker.',
'path' => '/openapi/customer/broadcast/material/sticker/create',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarYF4CD3'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'Request body.',
'type' => 'object',
'properties' => [
'ossKey' => ['description' => 'OSS file folder.', 'type' => 'string', 'required' => false, 'example' => 'material/INPUT_BROADCAST_STICKER/Mt.CPRLVQRR27YU2', 'title' => ''],
'fileName' => ['description' => 'File name.', 'type' => 'string', 'required' => false, 'example' => 'sticker.png', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Result<BroadcastStickerDTO>',
'title' => 'Result<BroadcastStickerDTO>',
'type' => 'object',
'properties' => [
'data' => [
'description' => 'Broadcast sticker.',
'type' => 'object',
'properties' => [
'id' => ['description' => 'Sticker ID.', 'title' => 'Encrypted ID to prevent traversal', 'type' => 'string', 'example' => 'M1lhKArheOyYdeYybDFqS1-Q'],
],
'title' => '',
'example' => '',
],
'success' => ['description' => 'Indicates whether the request succeeded.', 'title' => 'Encapsulates whether the current request processing result is successful or failed', 'type' => 'boolean', 'example' => 'True'],
'code' => ['description' => 'Status code.', 'title' => 'Result code', 'type' => 'string', 'example' => '200'],
'message' => ['description' => 'Description of the status code.', 'title' => 'Error message returned when request processing fails', 'type' => 'string', 'example' => 'SUCCESS'],
'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', 'title' => ''],
'httpStatusCode' => ['description' => 'HTTP response code.', 'title' => 'Returned HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"id\\": \\"M1lhKArheOyYdeYybDFqS1-Q\\"\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
'title' => 'Create broadcast sticker',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CreateBroadcastSticker'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CreateBroadcastSticker',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CreateBroadcastVideoFromTemplate' => [
'summary' => 'Synthesizes a video from a broadcast template.',
'path' => '/api/v1/amp/customer/broadcast/video/createFromTemplate',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarYF4CD3'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'The request body.',
'type' => 'object',
'properties' => [
'templateId' => ['description' => 'The ID of the broadcast template.'."\n"
."\n"
.'- Call [ListBroadcastTemplates](https://help.aliyun.com/zh/avatar/avatar-application/developer-reference/api-lingmou-2025-05-27-listbroadcasttemplates) to obtain the ID.', 'type' => 'string', 'required' => false, 'example' => 'BS1b2WNnRMu4ouRzT4clY9Jhg', 'title' => ''],
'name' => ['description' => 'The name of the video.', 'type' => 'string', 'required' => false, 'example' => '播报视频合成测试', 'title' => ''],
'videoOptions' => [
'description' => 'The video output options.',
'type' => 'object',
'properties' => [
'resolution' => [
'description' => 'The video resolution. The default value is `720p`.'."\n"
.'Valid values:'."\n"
."\n"
.'- 720p'."\n"
."\n"
.'- 1080p'."\n"
."\n"
.'- 2160p',
'enumValueTitles' => ['1080p' => '1080p', '720p' => '720p'],
'type' => 'string',
'required' => false,
'example' => '720p',
'title' => '',
],
'fps' => [
'description' => 'The video frame rate. The default value is `30` fps.'."\n"
.'Valid values:'."\n"
."\n"
.'- 15'."\n"
."\n"
.'- 30',
'enumValueTitles' => [15 => '15', 30 => '30'],
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '30',
'title' => '',
],
'watermark' => ['description' => 'Specifies whether to include a watermark. The default value is `True`.'."\n"
."\n"
.'- True: Include a watermark.'."\n"
."\n"
.'- False: Do not include a watermark.', 'type' => 'boolean', 'required' => false, 'example' => 'True', 'title' => ''],
'languageHints' => [
'description' => 'Specifies the target language for video synthesis to improve the output quality.'."\n"
.'Use this parameter when the pronunciation of numbers, abbreviations, or symbols, or the synthesis quality for non-primary languages does not meet your expectations. For example:'."\n"
."\n"
.'- A number is not pronounced as expected. For example, you want "110" in "hello, this is 110" to be pronounced as "one one zero" instead of the Chinese pronunciation "yāo yāo líng".'."\n"
."\n"
.'- A symbol is pronounced incorrectly. For example, "@" is pronounced as the Chinese pronunciation "ài tè" instead of "at".'."\n"
."\n"
.'- The synthesis quality for a non-primary language is poor or sounds unnatural.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- zh: Chinese'."\n"
."\n"
.'- en: English'."\n"
."\n"
.'- fr: French'."\n"
."\n"
.'- de: German'."\n"
."\n"
.'- ja: Japanese'."\n"
."\n"
.'- ko: Korean'."\n"
."\n"
.'- ru: Russian'."\n"
."\n"
.'- pt: Portuguese'."\n"
."\n"
.'- th: Thai'."\n"
."\n"
.'- id: Indonesian'."\n"
."\n"
.'- vi: Vietnamese'."\n"
."\n"
.'**Note**: This parameter is an array, but only the first element is processed. We recommend passing only one value.',
'type' => 'array',
'items' => ['description' => 'The target language.', 'type' => 'string', 'required' => false, 'example' => 'en', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
'mode' => ['description' => 'The export mode. The default value is ALL. Valid values:'."\n"
."\n"
.'- ALL: Exports all scene elements, including layers for the background, digital human, stickers, and captions. The output video format is MP4.'."\n"
."\n"
.'- ONLY\\_AVATAR: Exports only the digital human channel, removing the background, stickers, and captions. The output video format is WebM with an alpha channel. Note: This mode works only for digital humans that have a transparent background. Using this mode with a digital human created from a real-shot video returns an error.', 'type' => 'string', 'required' => false, 'example' => 'ALL', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'variables' => [
'description' => 'A list of dynamic variables in the broadcast template. You can use these variables to replace images, text, the global digital human, the global voice, or audio.',
'type' => 'array',
'items' => ['description' => 'A dynamic variable for the broadcast template.', '$ref' => '#/components/schemas/TemplateVariable', 'required' => false, 'title' => '', 'example' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Result\\<CustomerBroadcastVideoDTO>',
'title' => 'Result<CustomerBroadcastVideoDTO>',
'type' => 'object',
'properties' => [
'data' => ['description' => 'The broadcast video object.', '$ref' => '#/components/schemas/BroadcastVideo', 'example' => '{"sessionId": "20250311-41523E3C-1D27-5844-8EEF-194E4714096B", "mainAccountId": 1234567, "createdAt": 1755680457}', 'title' => ''],
'success' => ['title' => 'Encapsulates whether the current request processing succeeded or failed', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True'],
'code' => ['title' => 'Result code', 'description' => 'The status code.', 'type' => 'string', 'example' => 'SUCCESS'],
'message' => ['title' => 'Error message returned when request processing fails', 'description' => 'The description of the status code.', 'type' => 'string', 'example' => 'success'],
'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0EC3BA89-13F5-5766-A0BA-85096092A032', 'title' => ''],
'httpStatusCode' => ['title' => 'Returned HTTP status code', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"id\\": \\"M1k3So6n9IlrDV69sr3jDa3g\\",\\n \\"createTime\\": \\"2025-11-28T13:40:33\\",\\n \\"modifiedTime\\": \\"2025-11-28T13:41:31\\",\\n \\"name\\": \\"播报视频合成测试\\",\\n \\"status\\": \\"SUCCESS\\",\\n \\"coverURL\\": \\"https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CQEYXYQW4MQU2/cover.jpg\\",\\n \\"videoURL\\": \\"https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CQEYXYQW4MQU2/result.mp4\\",\\n \\"captionURL\\": \\"https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CQEYXYQW4MQU2/result.srt\\",\\n \\"alignmentFileURL\\": \\"https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CQEYXYQW4MQU2/alignment.json\\"\\n },\\n \\"success\\": true,\\n \\"code\\": \\"SUCCESS\\",\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"0EC3BA89-13F5-5766-A0BA-85096092A032\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
'title' => 'Create a broadcast video based on a template',
'description' => 'This operation synthesizes a video from a specified broadcast template.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CreateBroadcastVideoFromTemplate'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CreateBroadcastVideoFromTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CreateChatConfig' => [
'path' => '/openapi/chat/createChatConfig',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarWE6ABK', 'FEATUREavatar8ULNZ9', 'FEATUREavatarIODFBA'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'backgroundId',
'in' => 'query',
'schema' => ['description' => 'The ID of the background asset. This parameter is optional if the avatar has an opaque background.', 'type' => 'string', 'required' => false, 'example' => 'M1ONzwuILu-nPT7pvr6maKvQ', 'title' => ''],
],
[
'name' => 'avatarId',
'in' => 'query',
'schema' => ['description' => 'The avatar ID. This parameter is required.', 'type' => 'string', 'required' => false, 'example' => 'M1ONzwuILu-nPT7pvr6maKvQ', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => ['description' => 'The unique ID for the request.', 'type' => 'string', 'example' => '0EC3BA89-13F5-5766-A0BA-85096092A032', 'title' => ''],
'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'data' => [
'description' => 'The data returned for a successful request.',
'type' => 'object',
'properties' => [
'id' => ['description' => 'The unique ID of the created chat configuration.', 'type' => 'string', 'example' => 'C1RznvtlM-JO6HuPHqNC-Xxg', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create dialogue configuration',
'summary' => 'Creates a chat configuration.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CreateChatConfig'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CreateChatConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0EC3BA89-13F5-5766-A0BA-85096092A032\\",\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": \\"C1RznvtlM-JO6HuPHqNC-Xxg\\"\\n }\\n}","type":"json"}]',
],
'CreateChatSession' => [
'summary' => 'Create a real-time digital human session. ',
'path' => '/openapi/chat/init/{id}',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarWE6ABK', 'FEATUREavatar8ULNZ9', 'FEATUREavatarIODFBA'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'id',
'in' => 'path',
'schema' => ['description' => '即对话数字人的项目ID,通过灵眸控制台[对话互动](https://avatar.console.aliyun.com/lingmou/chat)页面点击对话项目右下角更多选项查看。', 'type' => 'string', 'required' => true, 'example' => 'C1gttTrdX7l98YCPck7Jr-iA', 'title' => ''],
],
[
'name' => 'license',
'in' => 'query',
'schema' => ['description' => '灵眸平台颁发的个人凭证(在使用端渲染数字人的场景下必填)。', 'type' => 'string', 'required' => false, 'example' => 'b9be4b25c2d38c409c376ffd2372be1', 'title' => ''],
],
[
'name' => 'platform',
'in' => 'query',
'schema' => [
'description' => '运行SDK的平台(在使用端渲染数字人的场景下必填)。',
'enumValueTitles' => ['Web' => 'Web', 'iOS' => 'iOS', 'Android' => 'Android'],
'type' => 'string',
'required' => false,
'example' => 'Web | Android | iOS',
'title' => '',
],
],
[
'name' => 'instanceId',
'in' => 'query',
'schema' => ['description' => '需要在[数字人实时交互服务](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.457876812ETi6y&commodityCode=avatar_2dchat_public_cn)购买完成对应的服务购买,当前有可用的服务时,前往阿里云-[我的订单](https://billing-cost.console.aliyun.com/order/list)页面对应订单详情下进行查询', 'type' => 'string', 'required' => true, 'example' => 'avatar_xxxxxx_public_cn-xxxx ', 'title' => ''],
],
[
'name' => 'appId',
'in' => 'query',
'schema' => ['description' => 'Valid appId attached to an instance of an audio-driven client-rendering type order ', 'title' => 'Valid appId attached to the order instance ', 'type' => 'string', 'example' => 'com.aliyun.xxxtest', 'required' => false],
],
[
'name' => 'deviceId',
'in' => 'query',
'schema' => ['description' => 'Valid deviceId attached to an instance of an audio-driven client-rendering type order ', 'title' => 'Valid deviceId attached to the order instance ', 'type' => 'string', 'example' => 'xzzx1SIcXGYSju3S', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', 'title' => ''],
'message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'success', 'title' => ''],
'httpStatusCode' => ['description' => 'http响应码', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
'sessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => '9827f4bd-5008-4d34-98fb-62598f3ad3b5', 'title' => ''],
'rtcParams' => [
'description' => 'RTC入参。',
'type' => 'object',
'properties' => [
'appId' => ['description' => '应用id。', 'type' => 'string', 'example' => '895cbf3b', 'title' => ''],
'avatarUserId' => ['description' => '数字人侧用户ID。', 'type' => 'string', 'example' => 'E7enIvjUos', 'title' => ''],
'channel' => ['description' => 'RTC通道ID。', 'type' => 'string', 'example' => 'pPltqR3FovNCK3hNQc8eHUL3Zt****', 'title' => ''],
'clientUserId' => ['description' => '客户端侧用户ID。', 'type' => 'string', 'example' => 'aw0tqpFlP4', 'title' => ''],
'gslb' => ['description' => 'RTC服务地址。', 'type' => 'string', 'example' => 'https://gw.rtn.aliyuncs.com', 'title' => ''],
'nonce' => ['description' => '随机串。', 'type' => 'string', 'example' => 'f8b0ef02c5da778f4488e2470c', 'title' => ''],
'serverUserId' => ['description' => '服务端侧用户ID。', 'type' => 'string', 'example' => 'YzZtSQP8QX', 'title' => ''],
'timestamp' => ['description' => '过期时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1560588594', 'title' => ''],
'token' => ['description' => '访问凭证token。', 'type' => 'string', 'example' => 'PtGgv2dM9F8tEuAtda50c0VNNFjn0WUbyTDPa1im4cUBE****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'avatarAssets' => [
'description' => '端渲染数字人资产信息。',
'type' => 'object',
'properties' => [
'url' => ['description' => '资产下载链接。', 'type' => 'string', 'example' => 'https://daily-avatar-property.oss-cn-beijing.aliyuncs.com/avatar-share-property/AVATAR_3D_TRADITIONAL/Mt.CNMU6BO4RBYU2/secret_assets_web.zip?Expires=1752637519&OSSAccessKeyId=STS.NZULzwLRx8thHDHQxem94****&Signature=Oni3%2Be8dY8Xrv3iRGDyzn7u****%3D&security-token=CAISzAJ1q6Ft5B2yfSjIr5ngB8DDoY1Zj7aDSmL5tXgwYbYYi5LPrDz2IHhMfnloB%2BEcsfU3nmxT6vkZlrp6SJtIXleCZtF94oxN9h2gb4fb4093DEHt08%2FLI3OaLjKm9u2wCryLYbGwU%2FOpbE%2B%2B5U0X6LDmdDKkckW4OJmS8%2FBOZcgWWQ%2FKBlgvRq0hRG1YpdQdKGHaONu0LxfumRCwNkdzvRdmgm4NgsbWgO%2Fks0KA1QSml7ZP%2B9WuesH0M%2FMBZskvD42Hu8VtbbfE3SJq7BxHybx7lqQs%2B02c5onHUwEPsk%2FZYrKOroYzc1RjAbM%2FErRY6fP8nOE9ovbUm5RXHpT05CrMOs62ZPdDoKOscIvBXr6yZaP7JmcGC6iQLG%2FznQkSc081IsK2C7Xq0pe54O3lg9Ab41ZGNYEjq%2BpCIUP%2Fs97dqXEelD2e%2Bh8UezDnKxqAAXuAiYRY7Ox3cf6h2MlmRsK5yywg45O%2FizjiK2k8Z8p6WeOA54W3pfbg6ElV4d8TMWCVZ7tuAbSgRCKBg3q5YYrdS2ENqDu6njIea1pxG4LT4ydGxDBkYpjwcUxutDd0aAhFjsypSK%2Feuk0%2FDCfKMrWzCmkr1AtPpcNfJ8LPj58qIA', 'title' => ''],
'md5' => ['description' => '资产MD5值。', 'type' => 'string', 'example' => '5B83BE2114489274BB88BADE7EBC****', 'title' => ''],
'secret' => ['description' => 'SDK使用的密钥。', 'type' => 'string', 'example' => 'J562PNqJBZDhzOQpLBgIcIW8+rHQoM7P6IONGMP7P5vGxrWLxT7VtRenFnMY+wg/zpA2qwpFBmJYO2rVexnlCQ2WE4kvYOH/OKmlTzpQddY34U5jS9KaS3b3ulpq4xnKDjWJ+sLZSRMhuPDdlq8ZPfcfEPhJhF3zPO8Hu4QOSu+D/pAIDJUoixOTo9Q14DXFKGFuuVRQOQ7f/VxJcoSLIWIusV917pLtph/IYBaLd27gzbrTZBEVD8qrucR+WOQPY1g67PGAdafkhJWrs/+coM7+5dc3HEUC+KgI9JN4X4Akelc94aJcy78RZ6tRdr73hBzN83/cMZdzt2hx******', 'title' => ''],
'type' => ['description' => '资产类型。', 'type' => 'string', 'example' => 'AVATAR_3D_TRADITIONAL', 'title' => ''],
'minRequiredVersion' => ['description' => '支持的SDK最低版本。', 'type' => 'string', 'example' => '0.0.1', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'code' => ['description' => '响应码。', 'type' => 'string', 'example' => '200', 'title' => ''],
'success' => [
'description' => '请求是否成功',
'enumValueTitles' => ['True' => 'True', 'False' => 'False'],
'type' => 'boolean',
'example' => 'True',
'title' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Creation of a real-time digital human session ',
'description' => 'Query active session information under the specified instance.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 5, 'regionId' => '*', 'api' => 'CreateChatSession'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CreateChatSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"message\\": \\"success\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"sessionId\\": \\"9827f4bd-5008-4d34-98fb-62598f3ad3b5\\",\\n \\"rtcParams\\": {\\n \\"appId\\": \\"895cbf3b\\",\\n \\"avatarUserId\\": \\"E7enIvjUos\\",\\n \\"channel\\": \\"pPltqR3FovNCK3hNQc8eHUL3Zt****\\",\\n \\"clientUserId\\": \\"aw0tqpFlP4\\",\\n \\"gslb\\": \\"https://gw.rtn.aliyuncs.com\\",\\n \\"nonce\\": \\"f8b0ef02c5da778f4488e2470c\\",\\n \\"serverUserId\\": \\"YzZtSQP8QX\\",\\n \\"timestamp\\": 1560588594,\\n \\"token\\": \\"PtGgv2dM9F8tEuAtda50c0VNNFjn0WUbyTDPa1im4cUBE****\\"\\n },\\n \\"avatarAssets\\": {\\n \\"url\\": \\"https://daily-avatar-property.oss-cn-beijing.aliyuncs.com/avatar-share-property/AVATAR_3D_TRADITIONAL/Mt.CNMU6BO4RBYU2/secret_assets_web.zip?Expires=1752637519&OSSAccessKeyId=STS.NZULzwLRx8thHDHQxem94****&Signature=Oni3%2Be8dY8Xrv3iRGDyzn7u****%3D&security-token=CAISzAJ1q6Ft5B2yfSjIr5ngB8DDoY1Zj7aDSmL5tXgwYbYYi5LPrDz2IHhMfnloB%2BEcsfU3nmxT6vkZlrp6SJtIXleCZtF94oxN9h2gb4fb4093DEHt08%2FLI3OaLjKm9u2wCryLYbGwU%2FOpbE%2B%2B5U0X6LDmdDKkckW4OJmS8%2FBOZcgWWQ%2FKBlgvRq0hRG1YpdQdKGHaONu0LxfumRCwNkdzvRdmgm4NgsbWgO%2Fks0KA1QSml7ZP%2B9WuesH0M%2FMBZskvD42Hu8VtbbfE3SJq7BxHybx7lqQs%2B02c5onHUwEPsk%2FZYrKOroYzc1RjAbM%2FErRY6fP8nOE9ovbUm5RXHpT05CrMOs62ZPdDoKOscIvBXr6yZaP7JmcGC6iQLG%2FznQkSc081IsK2C7Xq0pe54O3lg9Ab41ZGNYEjq%2BpCIUP%2Fs97dqXEelD2e%2Bh8UezDnKxqAAXuAiYRY7Ox3cf6h2MlmRsK5yywg45O%2FizjiK2k8Z8p6WeOA54W3pfbg6ElV4d8TMWCVZ7tuAbSgRCKBg3q5YYrdS2ENqDu6njIea1pxG4LT4ydGxDBkYpjwcUxutDd0aAhFjsypSK%2Feuk0%2FDCfKMrWzCmkr1AtPpcNfJ8LPj58qIA\\",\\n \\"md5\\": \\"5B83BE2114489274BB88BADE7EBC****\\",\\n \\"secret\\": \\"J562PNqJBZDhzOQpLBgIcIW8+rHQoM7P6IONGMP7P5vGxrWLxT7VtRenFnMY+wg/zpA2qwpFBmJYO2rVexnlCQ2WE4kvYOH/OKmlTzpQddY34U5jS9KaS3b3ulpq4xnKDjWJ+sLZSRMhuPDdlq8ZPfcfEPhJhF3zPO8Hu4QOSu+D/pAIDJUoixOTo9Q14DXFKGFuuVRQOQ7f/VxJcoSLIWIusV917pLtph/IYBaLd27gzbrTZBEVD8qrucR+WOQPY1g67PGAdafkhJWrs/+coM7+5dc3HEUC+KgI9JN4X4Akelc94aJcy78RZ6tRdr73hBzN83/cMZdzt2hx******\\",\\n \\"type\\": \\"AVATAR_3D_TRADITIONAL\\",\\n \\"minRequiredVersion\\": \\"0.0.1\\"\\n }\\n },\\n \\"code\\": \\"200\\",\\n \\"success\\": true\\n}","type":"json"}]',
'translator' => 'machine',
],
'CreateNoTrainPicAvatar' => [
'summary' => 'Create a no-training-required photo-based digital human.',
'path' => '/openapi/chat/createNoTrainPicAvatar',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarWE6ABK', 'FEATUREavatar8ULNZ9', 'FEATUREavatarIODFBA'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'name',
'in' => 'query',
'schema' => ['description' => 'Digital human Name.', 'title' => 'Digital human Name', 'type' => 'string', 'required' => false, 'example' => 'avatar'],
],
[
'name' => 'gender',
'in' => 'query',
'schema' => [
'enumValueTitles' => ['MALE' => 'MALE', 'FEMALE' => 'FEMALE'],
'description' => 'Gender.',
'title' => 'Gender',
'type' => 'string',
'required' => false,
'example' => 'FEMALE/MALE',
],
],
[
'name' => 'imageOssPath',
'in' => 'query',
'schema' => ['description' => 'The path of the uploaded image. This parameter is required.', 'title' => 'Path of the uploaded image', 'type' => 'string', 'required' => false, 'example' => 'material/INPUT_INFER_PIC/Mt.CPQX3T6E25QU2/2e81e20797954440aed4da4264eb7494.webp'],
],
[
'name' => 'expressiveness',
'in' => 'query',
'schema' => [
'enumValueTitles' => ['ENTHUSIASTIC' => 'ENTHUSIASTIC', 'NORMAL' => 'NORMAL'],
'description' => 'Expressiveness (enthusiastic/normal), which affects the degree of expressiveness of your digital human avatar.',
'title' => 'Expressiveness (Enthusiastic/Ordinary)',
'type' => 'string',
'required' => false,
'example' => 'NORMAL/ENTHUSIASTIC',
],
],
[
'name' => 'transparent',
'in' => 'query',
'schema' => ['description' => 'Background: transparent or solid color. Select transparent if you require background removal. Select solid color if you have already removed the background or wish to retain the original background in the image.', 'title' => 'Background: transparent/solid color', 'type' => 'boolean', 'required' => false, 'example' => 'true/false'],
],
[
'name' => 'jwtToken',
'in' => 'query',
'schema' => ['description' => 'JWT containing additional login authentication information. This parameter is deprecated.', 'title' => 'JWT containing additional login authentication information', 'type' => 'string', 'required' => false, 'example' => 'Token'],
],
[
'name' => 'generateAssets',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to generate assets. If you only want to perform image availability detection without generating assets, set this parameter to false.', 'type' => 'boolean', 'required' => false, 'example' => 'true/false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'title' => 'Result<Avatar>',
'type' => 'object',
'properties' => [
'data' => [
'description' => 'Response Result.',
'type' => 'object',
'properties' => [
'avatarId' => ['description' => 'Digital human ID.', 'type' => 'string', 'example' => 'M1ONzwuILu-nPT7pvr6maKvQ', 'title' => ''],
'pass' => ['description' => 'Whether Pass.', 'type' => 'boolean', 'example' => 'true/false', 'title' => ''],
],
'title' => '',
'example' => '',
],
'success' => ['description' => 'Whether the request succeeded.', 'title' => 'Used to encapsulate whether the current request processing succeeded or failed', 'type' => 'boolean', 'example' => 'True'],
'code' => [
'description' => 'Response code.',
'title' => 'Result code',
'type' => 'string',
'enumValueTitles' => [
'CONTENT_RISK' => 'CONTENT_RISK', 'MULTI_HUMAN_BODY' => 'MULTI_HUMAN_BODY', 'FACE_INCOMPLETE' => 'FACE_INCOMPLETE', 'NO_HUMAN_BODY' => 'NO_HUMAN_BODY', 'INVALID_FACE_ORIENTATION' => 'INVALID_FACE_ORIENTATION', 'DETECT_FAILED' => 'DETECT_FAILED', 'INVALID_PERSON_VAGUE' => 'INVALID_PERSON_VAGUE', 'INVALID_HUMAN_PROPORTION' => 'INVALID_HUMAN_PROPORTION', 'INVALID_BODY_ORIENTATION' => 'INVALID_BODY_ORIENTATION', 'DETECT_NOT_PASS' => 'DETECT_NOT_PASS',
'INVALID_IMAGE_SIZE' => 'INVALID_IMAGE_SIZE',
],
'example' => '200',
],
'message' => [
'description' => 'Status code Description.',
'title' => 'Error message returned when request processing fails',
'type' => 'string',
'enumValueTitles' => [
'CONTENT_RISK' => '您的图片涉及平台限制内容,请重新上传', 'MULTI_HUMAN_BODY' => '请上传单个形象图片', 'FACE_INCOMPLETE' => '请确保脸部完整', 'NO_HUMAN_BODY' => '未检测到人脸', 'INVALID_FACE_ORIENTATION' => '请确保脸部朝向正面', 'DETECT_FAILED' => '图像检测失败', 'INVALID_PERSON_VAGUE' => '请上传更清晰的照片', 'INVALID_HUMAN_PROPORTION' => '形象在照片中比例过大/过小', 'INVALID_BODY_ORIENTATION' => '请确保身体朝向正面', 'DETECT_NOT_PASS' => '图像检测不通过',
'INVALID_IMAGE_SIZE' => '图片大小不符合要求',
],
'example' => 'success',
],
'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8'."\n", 'title' => ''],
'httpStatusCode' => ['description' => 'HTTP response code.', 'title' => 'Returned httpStatusCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"avatarId\\": \\"M1ONzwuILu-nPT7pvr6maKvQ\\",\\n \\"pass\\": true\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\\\n\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
'title' => 'Create a no-training-required image-based digital human',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CreateNoTrainPicAvatar'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CreateNoTrainPicAvatar',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CreateTTSVoiceCustom' => [
'summary' => 'Create a TTS voice',
'path' => '/openapi/voice/createTTSVoiceCustom',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarWE6ABK', 'FEATUREavatar8ULNZ9', 'FEATUREavatarIODFBA'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'name',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => 'Voice name. ', 'required' => true, 'example' => 'TestTTSVoiceName', 'title' => ''],
],
[
'name' => 'gender',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => 'Gender (optional).'."\n"
."\n"
.'- FEMALE'."\n"
.'- MALE', 'required' => false, 'example' => 'FEMALE', 'title' => ''],
],
[
'name' => 'ossKey',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => 'OSS file key.', 'required' => true, 'example' => 'material/INPUT_TRAIN_AUDIO/Mt.CN2VNOPRC5QU2', 'title' => ''],
],
[
'name' => 'fileName',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => 'File name.', 'required' => true, 'example' => 'TestTTSVoiceName.mp3', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Result<TTSVoice>',
'description' => 'Result<TTSVoice>',
'type' => 'object',
'properties' => [
'data' => [
'description' => 'Returned data.',
'type' => 'object',
'properties' => [
'audioURL' => ['type' => 'string', 'description' => 'Audio file URL.', 'example' => 'https://xxx-aliyuncs.com/material/INPUT_TRAIN_AUDIO/Mt.CQEG75L4FWIU2/TestTTSVoiceName.mp3?Expires=1764262805&OSSAccessKeyId=LTAI5tK3WcKwKtAyaTSe*****&Signature=D%2Fld6gp9Zh6TsGRU9cd6GD2pFY0%3D', 'title' => ''],
'censorStatus' => ['type' => 'string', 'description' => 'Review Status. Enumeration values:'."\n"
.'- INIT'."\n"
.'- CHECKING'."\n"
.'- BLOCKED'."\n"
.'- PASS', 'example' => 'CHECKING', 'title' => ''],
'common' => ['type' => 'boolean', 'description' => 'Whether it is public resources.', 'example' => 'false', 'title' => ''],
'createTime' => ['type' => 'string', 'description' => 'Creation Time.', 'example' => '2024-10-10T07:48:31Z', 'title' => ''],
'description' => ['type' => 'string', 'description' => 'Description.', 'example' => 'This is a testTTSVoice。', 'title' => ''],
'errorDetail' => ['type' => 'string', 'description' => 'Error message.', 'example' => 'Error', 'title' => ''],
'gender' => ['type' => 'string', 'description' => 'Gender.', 'example' => 'FEMALE', 'title' => ''],
'id' => ['type' => 'string', 'description' => 'Voice ID.', 'example' => 'M1lhKArheOyYdeYybDFqS1-Q', 'title' => ''],
'language' => ['type' => 'string', 'description' => 'Language.', 'example' => 'zh', 'title' => ''],
'modifiedTime' => ['type' => 'string', 'description' => 'Updated At.', 'example' => '2024-10-10T07:48:31Z', 'title' => ''],
'name' => ['type' => 'string', 'description' => 'Voice Name.', 'example' => 'TestTTSVoiceName', 'title' => ''],
'pitchRate' => ['type' => 'number', 'description' => 'Pitch rate.', 'format' => 'float', 'example' => '100', 'title' => ''],
'remainSeconds' => ['type' => 'integer', 'description' => 'Estimated generation time.', 'format' => 'int64', 'example' => '100', 'title' => ''],
'speechRate' => ['type' => 'number', 'description' => 'Speech rate.', 'format' => 'float', 'example' => '100', 'title' => ''],
'status' => ['type' => 'string', 'description' => 'Voice material status:'."\n"
."\n"
.'- CREATED'."\n"
.'- PROCESSING'."\n"
.'- SUCCESS'."\n"
.'- ERROR'."\n"
.'- DELETED', 'example' => 'SUCCESS', 'title' => ''],
'text' => ['type' => 'string', 'description' => 'Text output content.', 'example' => '你好朋友!你还需要这款产品吗?', 'title' => ''],
'voiceKey' => ['type' => 'string', 'description' => 'Voice parameter.', 'example' => 'testTTSVoice', 'title' => ''],
],
'title' => '',
'example' => '',
],
'success' => ['type' => 'boolean', 'description' => 'Indicates whether the current request processing succeeded or failed.', 'title' => '', 'example' => 'True'],
'code' => [
'type' => 'string',
'description' => 'Result code',
'title' => '',
'enumValueTitles' => ['HA15110000000360' => '上传音频失败', 'HA15110000000010' => '名称长度非法', 'HA15110000000375' => '音色克隆数量超过限制', 'HA15110000000001' => '参数不合法', 'HA15110000000366' => '音频时长过短,请重新上传/录制', 'HA15110000000400' => '未登录或登录过期', 'HA15110000000367' => '音频时长过长,请重新上传/录制', 'HA15110000000501' => '名称包含平台限制词汇,请调整后重试', 'HA15110000000505' => '您的音频涉及平台限制内容,请重新上传'],
'example' => '200',
],
'message' => ['type' => 'string', 'description' => 'Error message returned when the request processing fails.', 'title' => '', 'example' => 'SUCCESS'],
'requestId' => ['type' => 'string', 'description' => 'Request ID.', 'example' => 'A7174E51-3523-5AEB-AE18-1D877FF22497', 'title' => ''],
'httpStatusCode' => ['type' => 'integer', 'description' => 'Returned HTTP status code.', 'format' => 'int32', 'title' => '', 'example' => '200'],
],
'example' => '',
],
],
],
'title' => 'Custom voice cloning',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CreateTTSVoiceCustom'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CreateTTSVoiceCustom',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"audioURL\\": \\"https://xxx-aliyuncs.com/material/INPUT_TRAIN_AUDIO/Mt.CQEG75L4FWIU2/TestTTSVoiceName.mp3?Expires=1764262805&OSSAccessKeyId=LTAI5tK3WcKwKtAyaTSe*****&Signature=D%2Fld6gp9Zh6TsGRU9cd6GD2pFY0%3D\\",\\n \\"censorStatus\\": \\"CHECKING\\",\\n \\"common\\": false,\\n \\"createTime\\": \\"2024-10-10T07:48:31Z\\",\\n \\"description\\": \\"This is a testTTSVoice。\\",\\n \\"errorDetail\\": \\"Error\\",\\n \\"gender\\": \\"FEMALE\\",\\n \\"id\\": \\"M1lhKArheOyYdeYybDFqS1-Q\\",\\n \\"language\\": \\"zh\\",\\n \\"modifiedTime\\": \\"2024-10-10T07:48:31Z\\",\\n \\"name\\": \\"TestTTSVoiceName\\",\\n \\"pitchRate\\": 100,\\n \\"remainSeconds\\": 100,\\n \\"speechRate\\": 100,\\n \\"status\\": \\"SUCCESS\\",\\n \\"text\\": \\"你好朋友!你还需要这款产品吗?\\",\\n \\"voiceKey\\": \\"testTTSVoice\\"\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"A7174E51-3523-5AEB-AE18-1D877FF22497\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
'translator' => 'machine',
],
'CreateTrainPicAvatar' => [
'summary' => 'Create a digital human trained with an image',
'path' => '/openapi/train/createTrainPicAvatar',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarWE6ABK', 'FEATUREavatar8ULNZ9', 'FEATUREavatarIODFBA'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'name',
'in' => 'query',
'schema' => ['description' => 'Name of the digital human trained with an image.', 'type' => 'string', 'required' => true, 'example' => '图片训练数字人', 'title' => ''],
],
[
'name' => 'imageOssPath',
'in' => 'query',
'schema' => ['description' => 'Image path.', 'type' => 'string', 'required' => true, 'example' => 'material/INPUT_TRAIN_PIC/Mt.CQEJ2DQ6BBYU2/2.jpg', 'title' => ''],
],
[
'name' => 'gender',
'in' => 'query',
'schema' => [
'enumValueTitles' => ['MALE' => 'Male', 'FEMALE' => 'Female'],
'description' => 'Gender.',
'type' => 'string',
'required' => true,
'example' => 'FEMALE',
'title' => '',
],
],
[
'name' => 'templateId',
'in' => 'query',
'schema' => ['description' => 'Action template ID.', 'title' => 'Action template ID', 'type' => 'string', 'required' => false, 'example' => 'M16vSG46Pby9HWOrFSZ7QaQA'],
],
[
'name' => 'transparent',
'in' => 'query',
'schema' => ['description' => 'Background: transparent or solid color.', 'title' => 'Background: transparent or solid color', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'generateAssets',
'in' => 'query',
'schema' => ['description' => 'Whether to generate assets.', 'title' => 'Whether to generate assets', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'bizType',
'in' => 'query',
'schema' => [
'enumValueTitles' => ['CHAT' => 'Chat', 'BROADCAST' => 'Broadcast'],
'description' => 'Business type. (Can be empty; default value is: BROADCAST if empty.)',
'type' => 'string',
'required' => false,
'example' => 'BROADCAST',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'title' => 'Result<CreateTrainPicAvatarDTO>',
'type' => 'object',
'properties' => [
'data' => [
'description' => 'Response data.',
'type' => 'object',
'properties' => [
'avatarId' => ['description' => 'Digital human ID.', 'type' => 'string', 'example' => 'M1AguofmMxaoUQsuSPQ3j0ng', 'title' => ''],
'pass' => ['description' => 'Whether it passed.', 'type' => 'boolean', 'example' => 'true :通过,false:不通过', 'title' => ''],
'expectedCompletionTime' => ['description' => 'Expected completion time (in seconds).', 'type' => 'integer', 'format' => 'int32', 'example' => '1200', 'title' => ''],
],
'title' => '',
'example' => '',
],
'success' => ['description' => 'Indicates whether the request succeeded.', 'title' => 'Used to encapsulate whether the current request processing succeeded or failed', 'type' => 'boolean', 'example' => 'True'],
'code' => [
'description' => 'Response code.',
'title' => 'Result code',
'type' => 'string',
'enumValueTitles' => [
'CONTENT_RISK' => 'CONTENT_RISK', 'MULTI_HUMAN_BODY' => 'MULTI_HUMAN_BODY', 'FACE_INCOMPLETE' => 'FACE_INCOMPLETE', 'NO_HUMAN_BODY' => 'NO_HUMAN_BODY', 'INVALID_FACE_ORIENTATION' => 'INVALID_FACE_ORIENTATION', 'DETECT_FAILED' => 'DETECT_FAILED', 'INVALID_PERSON_VAGUE' => 'INVALID_PERSON_VAGUE', 'INVALID_HUMAN_PROPORTION' => 'INVALID_HUMAN_PROPORTION', 'INVALID_BODY_ORIENTATION' => 'INVALID_BODY_ORIENTATION', 'DETECT_NOT_PASS' => 'DETECT_NOT_PASS',
'INVALID_IMAGE_SIZE' => 'INVALID_IMAGE_SIZE',
],
'example' => '200',
],
'message' => [
'description' => 'Description of the status code.',
'title' => 'Error message returned when request processing fails',
'type' => 'string',
'enumValueTitles' => [
'CONTENT_RISK' => '您的图片涉及平台限制内容,请重新上传', 'MULTI_HUMAN_BODY' => '请上传单个形象图片', 'FACE_INCOMPLETE' => '请确保脸部完整', 'NO_HUMAN_BODY' => '未检测到人脸', 'INVALID_FACE_ORIENTATION' => '请确保脸部朝向正面', 'DETECT_FAILED' => '图像检测失败', 'INVALID_PERSON_VAGUE' => '请上传更清晰的照片', 'INVALID_HUMAN_PROPORTION' => '形象在照片中比例过大/过小', 'INVALID_BODY_ORIENTATION' => '请确保身体朝向正面', 'DETECT_NOT_PASS' => '图像检测不通过',
'INVALID_IMAGE_SIZE' => '图片大小不符合要求',
],
'example' => 'success',
],
'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', 'title' => ''],
'httpStatusCode' => ['description' => 'HTTP response code.', 'title' => 'Returned HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"avatarId\\": \\"M1AguofmMxaoUQsuSPQ3j0ng\\",\\n \\"pass\\": true,\\n \\"expectedCompletionTime\\": 1200\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
'title' => 'Create a digital human trained with an image.',
'description' => '> **Invoke the API to create a digital human trained with an image. The image must be cropped to a 9:16 aspect ratio in advance.** ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CreateTrainPicAvatar'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CreateTrainPicAvatar',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'translator' => 'machine',
],
'DeleteBroadcastSticker' => [
'summary' => 'Deletes a broadcast sticker.',
'path' => '/openapi/broadcast/materials/stickers/{stickerId}',
'methods' => ['delete'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatar1PRWQW'],
],
'parameters' => [
[
'name' => 'stickerId',
'in' => 'path',
'schema' => ['description' => 'The ID of the broadcast sticker to delete.', 'type' => 'string', 'required' => true, 'example' => 'M1lhKArheOyYdeYybDFqS1-Q', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Result<Void>',
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'True'],
'code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'SUCCESS'],
'message' => ['description' => 'The description of the status code.', 'type' => 'string', 'title' => '', 'example' => 'success'],
'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90C68329-A75C-5449-A928-4D0BAD7AA0FA', 'title' => ''],
'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'],
],
'example' => '',
],
],
],
'title' => 'DeleteBroadcastSticker',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true,\\n \\"code\\": \\"SUCCESS\\",\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"90C68329-A75C-5449-A928-4D0BAD7AA0FA\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
],
'GetBroadcastTemplate' => [
'summary' => 'Query the details of a broadcast template.',
'path' => '/openapi/customer/broadcast/template/detail',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarYF4CD3'],
],
'parameters' => [
[
'name' => 'templateId',
'in' => 'query',
'schema' => ['description' => 'Template ID.', 'type' => 'string', 'required' => true, 'example' => 'BS1b2WNnRMu4ouRzT4clY9Jhg', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Result<BroadcastTemplateDTO>',
'title' => 'Result<BroadcastTemplateDTO>',
'type' => 'object',
'properties' => [
'data' => ['description' => 'Broadcast template.', '$ref' => '#/components/schemas/BroadcastTemplate', 'title' => '', 'example' => ''],
'success' => ['description' => 'Indicates whether the request succeeded.', 'title' => 'Indicates whether the current request processing result is successful or failed', 'type' => 'boolean', 'example' => 'True'],
'code' => ['description' => 'Status code.', 'title' => 'Result code', 'type' => 'string', 'example' => '200'],
'message' => ['description' => 'Description of the status code.', 'title' => 'Error message returned when the request fails', 'type' => 'string', 'example' => 'SUCCESS'],
'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', 'title' => ''],
'httpStatusCode' => ['description' => 'HTTP response code.', 'title' => 'Returned HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"createTime\\": \\"2025-11-28T10:11:28\\",\\n \\"modifiedTime\\": \\"2025-11-28T11:11:28\\",\\n \\"name\\": \\"测试播报模板\\",\\n \\"id\\": \\"BS1b2WNnRMu4ouRzT4clY9Jhg\\",\\n \\"variables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"type\\": \\"text\\",\\n \\"properties\\": \\"{\\\\n \\\\\\"content\\\\\\": \\\\\\"待替换内容\\\\\\"\\\\n}\\"\\n }\\n ]\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
'title' => 'Query the details of a broadcast template',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'GetBroadcastTemplate'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'lingmou:GetBroadcastTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GetTTSVoiceByIdCustom' => [
'summary' => 'After creating a custom voice, wait at least 1 minute before checking its status.',
'path' => '/openapi/voice/getTTSVoiceById',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarWE6ABK', 'FEATUREavatar8ULNZ9', 'FEATUREavatarIODFBA'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'voiceId',
'in' => 'query',
'schema' => ['description' => 'The voice ID.', 'type' => 'string', 'required' => false, 'example' => 'M1ScGtY****PBFEJHdUV1thQ', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Result<TTSVoiceMaterialDTO> ',
'type' => 'object',
'properties' => [
'data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'name' => ['description' => 'The voice name.', 'type' => 'string', 'example' => 'TestTTSVoiceName。', 'title' => ''],
'description' => ['description' => 'The voice description.', 'type' => 'string', 'example' => 'This is a testTTSVoice。', 'title' => ''],
'gender' => ['description' => 'The gender of the voice.', 'type' => 'string', 'example' => 'FEMALE', 'title' => ''],
'language' => ['description' => 'The language of the voice.', 'type' => 'string', 'example' => '中/英文。', 'title' => ''],
'audioURL' => ['description' => 'The URL of the audio file.', 'type' => 'string', 'example' => 'https://xxx-aliyuncs.com/material/INPUT_TTS_VOICE/Mt.CQEG75L4FWIU2/TestTTSVoiceName.mp3?Expires=1764262805&OSSAccessKeyId=LTAI5tK3WcKwKtAyaTSe*****&Signature=D%2Fld6gp9Zh6TsGRU9cd6GD2pFY0%3D', 'title' => ''],
'voiceKey' => ['description' => 'A unique identifier for the voice.', 'type' => 'string', 'example' => 'avatar-2464b55a65794e75a20fe07dde2*****', 'title' => ''],
'status' => ['description' => 'The status of the voice. Valid values:'."\n"
."\n"
.'- `CREATED`'."\n"
."\n"
.'- `PROCESSING`'."\n"
."\n"
.'- `SUCCESS`'."\n"
."\n"
.'- `ERROR`'."\n"
."\n"
.'- `DELETED`', 'type' => 'string', 'example' => 'SUCCESS。', 'title' => ''],
'censorStatus' => ['description' => 'The content moderation status. Valid values:'."\n"
."\n"
.'- `INIT`'."\n"
."\n"
.'- `CHECKING`'."\n"
."\n"
.'- `BLOCKED`'."\n"
."\n"
.'- `PASS`', 'type' => 'string', 'example' => 'CHECKING。', 'title' => ''],
'common' => ['description' => 'Indicates whether the voice is a public resource.', 'type' => 'boolean', 'example' => 'false。', 'title' => ''],
'remainSeconds' => ['description' => 'The estimated remaining generation time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100。', 'title' => ''],
'errorDetail' => [
'description' => 'The error details. This parameter is returned only when an error occurs.',
'enumValueTitles' => ['内部错误,请稍后再试' => 'Internal error. Please try again later.', '音色审核不通过' => 'Voice review failed.', '有效音频过短' => 'Valid audio is too short', '音色生成超时' => 'Voice generation timed out.', '音频为静音或非静音长度过短' => 'The audio is silent or the non-silent segment is too short.'],
'type' => 'string',
'example' => '有效音频过短。',
'title' => '',
],
'text' => ['description' => 'The text output.', 'type' => 'string', 'example' => '你好朋友!你还需要这款产品吗?', 'title' => ''],
'id' => ['title' => 'Encrypted ID to prevent traverse', 'description' => 'The encrypted ID. This prevents ID enumeration.', 'type' => 'string', 'example' => 'M1lhKArheOyYdeYyb*****'],
'createTime' => ['title' => 'Creation Time', 'description' => 'The time when the voice was created.', 'type' => 'string', 'example' => '2025-11-28T10:11:28'],
'modifiedTime' => ['title' => 'Last Update Time ', 'description' => 'The time when the voice was last updated.', 'type' => 'string', 'example' => '2025-11-28T13:41:31'],
'errorCode' => [
'title' => 'Error code.',
'description' => 'The error code. This parameter is returned only when an error occurs.',
'enumValueTitles' => ['Audio.AudioSilentError' => 'The audio is silent or the non-silent segment is too short.', 'Voice.Undeployed' => 'Voice review failed.', 'Voice.Timeout' => 'Voice generation timed out.', 'Audio.AudioShortError' => 'The valid audio segment is too short.', 'InternalError' => 'Internal error. Please try again later.'],
'type' => 'string',
'example' => 'Audio.AudioShortError',
],
],
'title' => '',
'example' => '',
],
'success' => ['title' => 'Indicates whether the current Request processing Succeeded or failed', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True。'],
'code' => ['title' => 'Result Code ', 'description' => 'The result code.', 'type' => 'string', 'example' => '200'],
'message' => ['title' => 'Error message returned when Request processing fails', 'description' => 'The message returned for the request. This parameter is returned only if the request fails.', 'type' => 'string', 'example' => 'SUCCESS'],
'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBD****', 'title' => ''],
'httpStatusCode' => ['title' => 'Returned httpStatusCode', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
'example' => '',
],
],
],
'title' => 'Custom Voice Single Voice Query',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'lingmou:GetTTSVoiceByIdCustom',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"name\\": \\"TestTTSVoiceName。\\",\\n \\"description\\": \\"This is a testTTSVoice。\\",\\n \\"gender\\": \\"FEMALE\\",\\n \\"language\\": \\"中/英文。\\",\\n \\"audioURL\\": \\"https://xxx-aliyuncs.com/material/INPUT_TTS_VOICE/Mt.CQEG75L4FWIU2/TestTTSVoiceName.mp3?Expires=1764262805&OSSAccessKeyId=LTAI5tK3WcKwKtAyaTSe*****&Signature=D%2Fld6gp9Zh6TsGRU9cd6GD2pFY0%3D\\",\\n \\"voiceKey\\": \\"avatar-2464b55a65794e75a20fe07dde2*****\\",\\n \\"status\\": \\"SUCCESS。\\",\\n \\"censorStatus\\": \\"CHECKING。\\",\\n \\"common\\": true,\\n \\"remainSeconds\\": 0,\\n \\"errorDetail\\": \\"有效音频过短。\\",\\n \\"text\\": \\"你好朋友!你还需要这款产品吗?\\",\\n \\"id\\": \\"M1lhKArheOyYdeYyb*****\\",\\n \\"createTime\\": \\"2025-11-28T10:11:28\\",\\n \\"modifiedTime\\": \\"2025-11-28T13:41:31\\",\\n \\"errorCode\\": \\"Audio.AudioShortError\\"\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBD****\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
],
'GetTrainPicAvatarStatus' => [
'summary' => 'Queries the training status of a photo avatar. Wait at least 20 minutes after submitting a training task before querying the status.',
'path' => '/openapi/train/getTrainPicAvatarStatus',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarWE6ABK', 'FEATUREavatar8ULNZ9', 'FEATUREavatarIODFBA'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'avatarId',
'in' => 'query',
'schema' => ['description' => 'The avatar ID.', 'type' => 'string', 'required' => true, 'example' => 'M1YJTNTH2yoLmLnzKdYHeGBg', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Result<GetTrainPicAvatarDTO>',
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'avatarId' => ['description' => 'The avatar ID.', 'type' => 'string', 'example' => 'M1YJTNTH2yoLmLnzKdYHeGBg', 'title' => ''],
'status' => [
'description' => 'The training status.',
'enumValueTitles' => ['COMPLETED ' => 'The training is completed.', 'EXPIRED' => 'The training task has expired.', 'PENDING_CONFIRM' => 'The training result is pending confirmation.', 'TRAIN_FAILED' => 'The training task has failed.', 'TRAINING ' => 'The training is in progress.'],
'type' => 'string',
'example' => 'TRAINING (训练中),TRAIN_FAILED(训练失败),PENDING_CONFIRM(结果确认), COMPLETED (已完成) ,EXPIRED(已过期)',
'title' => '',
],
'previewURL' => ['description' => 'The URL of the preview video. This parameter is returned only when the training is completed.', 'type' => 'string', 'example' => '//daily-avatar-property.oss-cn-beijing.aliyuncs.com/avatar-share-property/AVATAR_2D_PIC/Mt.CMTMRYX4TNIU2/retalking_output.mp4?Expires=1764327167&OSSAccessKeyId=LTAI5tBRPnF5JkRCidYA****&Signature=%2BH%2BSBpNDPiMQtPyl8vraEHMv9X8%3D', 'title' => ''],
],
'title' => '',
'example' => '',
],
'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'True'],
'code' => ['description' => 'The response code.', 'type' => 'string', 'title' => '', 'example' => '200'],
'message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'success'],
'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', 'title' => ''],
'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"avatarId\\": \\"M1YJTNTH2yoLmLnzKdYHeGBg\\",\\n \\"status\\": \\"TRAINING (训练中),TRAIN_FAILED(训练失败),PENDING_CONFIRM(结果确认), COMPLETED (已完成) ,EXPIRED(已过期)\\",\\n \\"previewURL\\": \\"//daily-avatar-property.oss-cn-beijing.aliyuncs.com/avatar-share-property/AVATAR_2D_PIC/Mt.CMTMRYX4TNIU2/retalking_output.mp4?Expires=1764327167&OSSAccessKeyId=LTAI5tBRPnF5JkRCidYA****&Signature=%2BH%2BSBpNDPiMQtPyl8vraEHMv9X8%3D\\"\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
'title' => 'Query the training status of the digital human by image.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'GetTrainPicAvatarStatus'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'lingmou:GetTrainPicAvatarStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GetUploadPolicy' => [
'summary' => 'Gets an upload credential for training-free dialog image assets.',
'path' => '/openapi/chat/getUploadPolicy',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarWE6ABK', 'FEATUREavatar8ULNZ9', 'FEATUREavatarIODFBA'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'type',
'in' => 'query',
'schema' => ['description' => 'The resource type. This parameter is required.'."\n"
.'Supported types:'."\n"
."\n"
.'- `INPUT_CHAT_BACKGROUND_PIC`: Use this type with `CreateBackgroundPic`.'."\n"
."\n"
.'- `INPUT_INFER_PIC`: Use this type with `CreateNoTrainPicAvatar`.'."\n"
."\n"
.'- `INPUT_TRAIN_PIC`: Use this type with `CreateTrainPicAvatar`.'."\n"
."\n"
.'- `INPUT_TRAIN_AUDIO`: Use this type with `CreateTTSVoiceCustom`.'."\n"
."\n"
.'- `INPUT_BROADCAST_STICKER`: Use this type with `CreateBroadcastSticker`.'."\n"
."\n"
.'Support for additional types is planned.', 'type' => 'string', 'required' => false, 'example' => 'INPUT_CHAT_BACKGROUND_PIC', 'title' => ''],
],
[
'name' => 'jwtToken',
'in' => 'query',
'schema' => ['title' => 'JWT containing additional login authentication information ', 'description' => 'A JWT that contains additional authentication information. This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => 'Token'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Response schema.',
'title' => 'Result<GetMaterialUploadPolicyResponseBodyData>',
'type' => 'object',
'properties' => [
'data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'ossKey' => ['description' => 'The object key in OSS.', 'type' => 'string', 'example' => 'material/INPUT_CHAT_BACKGROUND_PIC/Mt.CPQHBSWQS5QU2', 'title' => ''],
'ossPolicy' => [
'description' => 'The OSS upload credential.',
'type' => 'object',
'properties' => [
'accessId' => ['description' => 'The Access Key ID.', 'type' => 'string', 'example' => 'LTBI5123ADDJdsadCidYA8kw3', 'title' => ''],
'dir' => ['description' => 'The upload directory for the object.', 'type' => 'string', 'example' => 'material/INPUT_CHAT_BACKGROUND_PIC/Mt.CPQHBSWQS5QU2/', 'title' => ''],
'expire' => ['description' => 'The expiration time of the policy, specified as a Unix timestamp.', 'type' => 'string', 'example' => '1761551667', 'title' => ''],
'host' => ['description' => 'The OSS host endpoint.', 'type' => 'string', 'example' => 'daily-avatar-property.oss-cn-beijing.aliyuncs.com', 'title' => ''],
'policy' => ['description' => 'The Base64-encoded upload policy.', 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNS0wMi0yNVQwMzowMDoyNC4xNDNaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTM2ODcwOTEyMF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCJ0ZW1wXC8xNzQwNDQ4ODI0MTQxLnppcCJdXX0=', 'title' => ''],
'signature' => ['description' => 'The authentication signature, generated by signing the policy.', 'type' => 'string', 'example' => 'I2KcV3CFloyRr94WhefmVEuNiv0=', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'success' => ['title' => 'Used to encapsulate whether the current request processing result is Succeeded or failed.', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True'],
'code' => ['title' => 'Result code', 'description' => 'The response code.', 'type' => 'string', 'example' => '200'],
'message' => ['title' => 'Error message returned when request processing fails ', 'description' => 'A message describing the request status.', 'type' => 'string', 'example' => 'success'],
'requestId' => ['description' => 'The unique request ID. Use this ID for troubleshooting.', 'type' => 'string', 'example' => '90C68329-A75C-5449-A928-4D0BAD7AA0FA', 'title' => ''],
'httpStatusCode' => ['title' => 'Returned HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"ossKey\\": \\"material/INPUT_CHAT_BACKGROUND_PIC/Mt.CPQHBSWQS5QU2\\",\\n \\"ossPolicy\\": {\\n \\"accessId\\": \\"LTBI5123ADDJdsadCidYA8kw3\\",\\n \\"dir\\": \\"material/INPUT_CHAT_BACKGROUND_PIC/Mt.CPQHBSWQS5QU2/\\",\\n \\"expire\\": \\"1761551667\\",\\n \\"host\\": \\"daily-avatar-property.oss-cn-beijing.aliyuncs.com\\",\\n \\"policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyNS0wMi0yNVQwMzowMDoyNC4xNDNaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTM2ODcwOTEyMF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCJ0ZW1wXC8xNzQwNDQ4ODI0MTQxLnppcCJdXX0=\\",\\n \\"signature\\": \\"I2KcV3CFloyRr94WhefmVEuNiv0=\\"\\n }\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"90C68329-A75C-5449-A928-4D0BAD7AA0FA\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
'title' => 'Obtain upload credential ',
'responseParamsDescription' => 'The upload credential is valid for 4 hours.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'GetUploadPolicy'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'lingmou:GetUploadPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListBroadcastAudiosById' => [
'path' => '/openapi/customer/broadcast/material/audio/batchQuery',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarYF4CD3'],
],
'parameters' => [
[
'name' => 'audioIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'A list of audio IDs.',
'type' => 'array',
'items' => ['description' => 'An audio ID.', 'type' => 'string', 'required' => false, 'example' => 'M1k3So6n9IlrDV69sr3jDa3g', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Result<List<AudioMaterialDTO>>',
'type' => 'object',
'properties' => [
'data' => [
'description' => 'The response data.',
'type' => 'array',
'items' => ['description' => 'A broadcast audio object.', '$ref' => '#/components/schemas/BroadcastAudio', 'title' => '', 'example' => ''],
'title' => '',
'example' => '',
],
'success' => ['title' => 'Indicates whether the current Request processing Succeeded or failed.', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True'],
'code' => ['title' => 'Result code', 'description' => 'The result code.', 'type' => 'string', 'example' => '200'],
'message' => ['title' => 'Error message returned when the Request processing failed.', 'description' => 'The message returned for the request. A value of \'SUCCESS\' indicates the request was successful.', 'type' => 'string', 'example' => 'SUCCESS'],
'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0EC3BA89-13F5-5766-A0BA-85096092A032', 'title' => ''],
'httpStatusCode' => ['title' => 'Returned HTTP status code.', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
'example' => '',
],
],
],
'title' => 'Batch query broadcast audio by ID list',
'summary' => 'Retrieves a batch of broadcast audios using a list of audio IDs.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'lingmou:ListBroadcastAudiosById',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"id\\": \\"M1Ju6XhHog_e-lSeb80Slp9g\\",\\n \\"createTime\\": \\"2026-01-22T01:59:03\\",\\n \\"modifiedTime\\": \\"2026-01-22T01:59:03\\",\\n \\"name\\": \\"播报音频\\",\\n \\"status\\": \\"SUCCESS\\",\\n \\"audioLength\\": 10,\\n \\"errorCode\\": \\"DataInspectionFailed\\"\\n }\\n ],\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"0EC3BA89-13F5-5766-A0BA-85096092A032\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
],
'ListBroadcastTemplates' => [
'summary' => 'List broadcast templates.',
'path' => '/openapi/customer/broadcast/template/list',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarYF4CD3'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'page',
'in' => 'query',
'schema' => ['description' => 'The page number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'size',
'in' => 'query',
'schema' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'nextToken',
'in' => 'query',
'schema' => ['description' => 'Paging token value. You do not need to follow this.', 'type' => 'string', 'required' => false, 'example' => 'BS1b2WNnRMu4ouRzT4clY9Jhg', 'title' => ''],
],
[
'name' => 'maxResults',
'in' => 'query',
'schema' => ['description' => 'Maximum number of return results. You do not need to follow this.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'ListResult<BroadcastTemplateDTO>',
'title' => 'ListResult<BroadcastTemplateDTO>',
'type' => 'object',
'properties' => [
'data' => [
'description' => 'List of broadcast templates.',
'type' => 'array',
'items' => ['description' => 'Broadcast template.', '$ref' => '#/components/schemas/BroadcastTemplate', 'title' => '', 'example' => ''],
'title' => '',
'example' => '',
],
'nextToken' => ['description' => 'Paging token value. You do not need to follow this.', 'type' => 'string', 'example' => 'BS1b2WNnRMu4ouRzT4clY9Jhk', 'title' => ''],
'maxResults' => ['description' => 'Maximum number of return results. You do not need to follow this.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'page' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'size' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'success' => ['description' => 'Indicates whether the request succeeded.', 'title' => 'Encapsulates whether the current request processing result is Succeeded or failed', 'type' => 'boolean', 'example' => 'True'],
'code' => ['description' => 'Status code.', 'title' => 'Result code', 'type' => 'string', 'example' => 'SUCCESS'],
'message' => ['description' => 'Description of the status code.', 'title' => 'Error message returned when request processing failed', 'type' => 'string', 'example' => 'SUCCESS'],
'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', 'title' => ''],
'httpStatusCode' => ['description' => 'HTTP response code.', 'title' => 'Returned httpStatusCode', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"createTime\\": \\"2025-11-28T10:11:28\\",\\n \\"modifiedTime\\": \\"2025-11-28T11:11:28\\",\\n \\"name\\": \\"测试播报模板\\",\\n \\"id\\": \\"BS1b2WNnRMu4ouRzT4clY9Jhg\\",\\n \\"variables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"type\\": \\"text\\",\\n \\"properties\\": \\"{\\\\n \\\\\\"content\\\\\\": \\\\\\"待替换内容\\\\\\"\\\\n}\\"\\n }\\n ]\\n }\\n ],\\n \\"nextToken\\": \\"BS1b2WNnRMu4ouRzT4clY9Jhk\\",\\n \\"maxResults\\": 20,\\n \\"page\\": 1,\\n \\"size\\": 20,\\n \\"success\\": true,\\n \\"code\\": \\"SUCCESS\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
'title' => 'List broadcast templates',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ListBroadcastTemplates'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'lingmou:ListBroadcastTemplates',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListBroadcastVideosById' => [
'summary' => 'Batch query broadcast videos by ID list.',
'path' => '/api/v1/amp/customer/broadcast/video/batchQuery',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarYF4CD3'],
],
'parameters' => [
[
'name' => 'videoIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'List of video IDs.',
'type' => 'array',
'items' => ['description' => 'Video ID', 'type' => 'string', 'required' => false, 'example' => 'M1k3So6n9IlrDV69sr3jDa3g', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Result<List<CustomerBroadcastVideoDTO>>',
'title' => 'Result<List<CustomerBroadcastVideoDTO>>',
'type' => 'object',
'properties' => [
'data' => [
'description' => 'Response data.',
'type' => 'array',
'items' => ['description' => 'Broadcast video.', '$ref' => '#/components/schemas/BroadcastVideo', 'title' => '', 'example' => ''],
'title' => '',
'example' => '',
],
'success' => ['description' => 'Indicates whether the request succeeded.', 'title' => 'Indicates whether the current request processing result is Succeeded or failed', 'type' => 'boolean', 'example' => 'True'],
'code' => ['description' => 'Status code.', 'title' => 'Result code', 'type' => 'string', 'example' => '200'],
'message' => ['description' => 'Description of the status code.', 'title' => 'Error message returned when request processing fails', 'type' => 'string', 'example' => 'SUCCESS'],
'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', 'title' => ''],
'httpStatusCode' => ['description' => 'HTTP response code.', 'title' => 'Returned HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
'example' => '',
],
],
],
'title' => 'Batch query broadcast videos by ID list',
'responseParamsDescription' => '除特殊说明外,返回参数中文件URL有效加签时间均为8小时',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ListBroadcastVideosById'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'lingmou:ListBroadcastVideosById',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"id\\": \\"M1k3So6n9IlrDV69sr3jDa3g\\",\\n \\"createTime\\": \\"2025-11-28T13:40:33\\",\\n \\"modifiedTime\\": \\"2025-11-28T13:41:31\\",\\n \\"name\\": \\"播报视频合成测试\\",\\n \\"status\\": \\"SUCCESS\\",\\n \\"coverURL\\": \\"https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CQEYXYQW4MQU2/cover.jpg\\",\\n \\"videoURL\\": \\"https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CQEYXYQW4MQU2/result.mp4\\",\\n \\"captionURL\\": \\"https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CQEYXYQW4MQU2/result.srt\\",\\n \\"alignmentFileURL\\": \\"https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CQEYXYQW4MQU2/alignment.json\\"\\n }\\n ],\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
'translator' => 'machine',
],
'ListPrivateTTSVoicesCustom' => [
'summary' => 'View your own voice list. For newly added custom voices, we recommend that you wait at least 1 minute after creation before performing a query. ',
'path' => '/openapi/voice/listPrivateTTSVoicesCustom',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarWE6ABK', 'FEATUREavatar8ULNZ9', 'FEATUREavatarIODFBA'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'name',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => 'Title', 'title' => '', 'required' => false, 'example' => '2D测试数字人'],
],
[
'name' => 'pageIndex',
'in' => 'query',
'schema' => ['type' => 'integer', 'description' => 'Page index.', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '1'],
],
[
'name' => 'pageSize',
'in' => 'query',
'schema' => ['type' => 'integer', 'description' => 'Number of data entries per page.', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '10'],
],
[
'name' => 'nextToken',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => 'Paging cursor.', 'required' => false, 'example' => 'Q45algIClks=', 'title' => ''],
],
[
'name' => 'maxResults',
'in' => 'query',
'schema' => ['type' => 'integer', 'description' => 'Page size.'."\n"
."\n"
.'> When paging, the response includes the quantity. To retrieve subsequent pages, use the same parameters as the initial page. The default value is 100 if not specified.', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Result<ListData<TTSVoiceMaterialDTO>>',
'description' => 'Result<ListData<TTSVoiceMaterialDTO>>',
'type' => 'object',
'properties' => [
'data' => [
'description' => 'Response Result. ',
'type' => 'object',
'properties' => [
'data' => [
'description' => 'Response Result. ',
'type' => 'array',
'items' => [
'description' => 'Data. ',
'type' => 'object',
'properties' => [
'name' => ['type' => 'string', 'description' => 'Voice name.', 'example' => 'TestTTSVoice', 'title' => ''],
'description' => ['type' => 'string', 'description' => 'Description.', 'example' => 'Optional for WH managernif no issue will be cancel', 'title' => ''],
'gender' => ['type' => 'string', 'description' => 'Gender. '."\n"
.'- FEMALE '."\n"
.'- MALE ', 'example' => 'FEMALE', 'title' => ''],
'language' => ['type' => 'string', 'description' => 'Language.', 'example' => 'ZH_CN', 'title' => ''],
'audioURL' => ['type' => 'string', 'description' => 'Audio file URL.', 'example' => 'https://xxx-aliyuncs.com/material/INPUT_TRAIN_AUDIO/Mt.CQEG75L4FWIU2/TestTTSVoiceName.mp3?Expires=1764262805&OSSAccessKeyId=LTAI5tK3WcKwKtAyaTSe*****&Signature=D%2Fld6gp9Zh6TsGRU9cd6GD2pFY0%3D', 'title' => ''],
'voiceKey' => ['type' => 'string', 'description' => 'Voice parameter. ', 'example' => 'TestTTSVoice', 'title' => ''],
'status' => ['type' => 'string', 'description' => 'Material status:'."\n"
."\n"
.'- CREATED'."\n"
.'- PROCESSING'."\n"
.'- SUCCESS'."\n"
.'- ERROR'."\n"
.'- DELETED', 'example' => 'SUCCESS', 'title' => ''],
'censorStatus' => ['type' => 'string', 'description' => 'Review Status. Status enumeration values: '."\n"
.'- INIT '."\n"
.'- CHECKING '."\n"
.'- BLOCKED '."\n"
.'- PASS', 'example' => 'PASS', 'title' => ''],
'common' => ['type' => 'boolean', 'description' => 'Whether it is a public resource.', 'example' => 'false', 'title' => ''],
'remainSeconds' => ['type' => 'integer', 'description' => 'Estimated generation time. ', 'format' => 'int64', 'example' => '100', 'title' => ''],
'errorDetail' => [
'enumValueTitles' => ['Audio.AudioSilentError' => '音频为静音或非静音长度过短', 'Voice.Undeployed' => '音色审核不通过', 'Voice.Timeout' => 'Voice.Timeout', 'Audio.AudioShortError' => '有效音频过短', 'InternalError' => '内部错误,请稍后再试'],
'type' => 'string',
'description' => 'Error message.',
'example' => '有效音频过短',
'title' => '',
],
'text' => ['type' => 'string', 'description' => 'Generated text', 'example' => '机器学习需要提供一个应用程序接口,以便大家使用。机器学习需要提供一个应用程序接口,以便大家使用。机器学习需要提供一个应用程序接口,以便大家使用。', 'title' => ''],
'id' => ['type' => 'string', 'description' => 'Encrypted ID to prevent traversal', 'title' => '', 'example' => 'M1lhKArheOyYdeYybDFqS1-Q'],
'createTime' => ['type' => 'string', 'description' => 'Creation Time', 'title' => '', 'example' => '2024-04-15T09:42:15Z'],
'modifiedTime' => ['type' => 'string', 'description' => 'Last Update Time ', 'title' => '', 'example' => '2024-04-15T09:42:15Z'],
'errorCode' => [
'title' => '错误码。',
'description' => '错误码。',
'enumValueTitles' => ['Audio.AudioSilentError' => '音频为静音或非静音长度过短', 'Voice.Undeployed' => '音色审核不通过', 'Voice.Timeout' => '音色生成超时', 'Audio.AudioShortError' => '有效音频过短', 'InternalError' => '内部错误,请稍后再试'],
'type' => 'string',
'example' => 'Audio.AudioShortError',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'total' => ['type' => 'integer', 'description' => 'Total number of records. ', 'format' => 'int64', 'example' => '20', 'title' => ''],
'page' => ['type' => 'integer', 'description' => 'Page number.', 'format' => 'int32', 'example' => '1', 'title' => ''],
'size' => ['type' => 'integer', 'description' => 'Number of data entries per page.', 'format' => 'int32', 'example' => '20', 'title' => ''],
'pages' => ['type' => 'integer', 'description' => 'Total number of pages. ', 'format' => 'int32', 'example' => '16', 'title' => ''],
],
'title' => '',
'example' => '',
],
'success' => ['type' => 'boolean', 'description' => 'Indicates whether the current request processing succeeded or failed.', 'title' => '', 'example' => 'True'],
'code' => ['type' => 'string', 'description' => 'Result code ', 'title' => '', 'example' => '200'],
'message' => ['type' => 'string', 'description' => 'Error message returned when the request processing fails.', 'title' => '', 'example' => 'SUCCESS'],
'requestId' => ['type' => 'string', 'description' => 'Request ID.', 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', 'title' => ''],
'httpStatusCode' => ['type' => 'integer', 'description' => 'Returned HTTP status code.', 'format' => 'int32', 'title' => '', 'example' => '200'],
'nextToken' => ['type' => 'string', 'description' => 'Paging cursor.', 'example' => 'qht-fc2-test', 'title' => ''],
'maxResults' => ['type' => 'integer', 'description' => 'Maximum number of returned results.', 'format' => 'int32', 'example' => '20', 'title' => ''],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"data\\": [\\n {\\n \\"name\\": \\"TestTTSVoice\\",\\n \\"description\\": \\"Optional for WH managernif no issue will be cancel\\",\\n \\"gender\\": \\"FEMALE\\",\\n \\"language\\": \\"ZH_CN\\",\\n \\"audioURL\\": \\"https://xxx-aliyuncs.com/material/INPUT_TRAIN_AUDIO/Mt.CQEG75L4FWIU2/TestTTSVoiceName.mp3?Expires=1764262805&OSSAccessKeyId=LTAI5tK3WcKwKtAyaTSe*****&Signature=D%2Fld6gp9Zh6TsGRU9cd6GD2pFY0%3D\\",\\n \\"voiceKey\\": \\"TestTTSVoice\\",\\n \\"status\\": \\"SUCCESS\\",\\n \\"censorStatus\\": \\"PASS\\",\\n \\"common\\": false,\\n \\"remainSeconds\\": 100,\\n \\"errorDetail\\": \\"有效音频过短\\",\\n \\"text\\": \\"机器学习需要提供一个应用程序接口,以便大家使用。机器学习需要提供一个应用程序接口,以便大家使用。机器学习需要提供一个应用程序接口,以便大家使用。\\",\\n \\"id\\": \\"M1lhKArheOyYdeYybDFqS1-Q\\",\\n \\"createTime\\": \\"2024-04-15T09:42:15Z\\",\\n \\"modifiedTime\\": \\"2024-04-15T09:42:15Z\\",\\n \\"errorCode\\": \\"Audio.AudioShortError\\"\\n }\\n ],\\n \\"total\\": 20,\\n \\"page\\": 1,\\n \\"size\\": 20,\\n \\"pages\\": 16\\n },\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200,\\n \\"nextToken\\": \\"qht-fc2-test\\",\\n \\"maxResults\\": 20\\n}","type":"json"}]',
'title' => 'Custom Voice Query',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ListPrivateTTSVoicesCustom'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'lingmou:ListPrivateTTSVoicesCustom',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'translator' => 'machine',
],
'ListPublicBroadcastSceneTemplates' => [
'path' => '/openapi/customer/broadcast/template/scene/listPublic',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarYF4CD3'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'tags',
'in' => 'query',
'schema' => ['title' => 'Tag filter parameter', 'description' => 'The parameter for filtering by tags.', 'type' => 'string', 'required' => false, 'example' => 'AI,BROADCAST'],
],
[
'name' => 'page',
'in' => 'query',
'schema' => ['title' => 'Pagination parameter indicating which page to retrieve. Default value is 1.', 'description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
'name' => 'size',
'in' => 'query',
'schema' => ['title' => 'Page size. Default value: 20 ', 'description' => 'The page size. The default value is 20.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'],
],
[
'name' => 'nextToken',
'in' => 'query',
'schema' => ['title' => 'Paging token value. You do not need to follow this. ', 'description' => 'The token that marks the start of the next page of results. To get the next page, set this parameter to the `nextToken` value from the previous response.', 'type' => 'string', 'required' => false, 'example' => 'BS1b2WNnRMu4ouRzT4clY9Jhg'],
],
[
'name' => 'maxResults',
'in' => 'query',
'schema' => ['title' => 'Maximum number of return results. You do not need to follow this. ', 'description' => 'The maximum number of results to return in a single call.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The data returned for the request.',
'title' => 'ListResult<BroadcastSceneTemplateDTO> ',
'type' => 'object',
'properties' => [
'data' => [
'description' => 'The list of broadcast templates.',
'type' => 'array',
'items' => ['description' => 'The broadcast template.', '$ref' => '#/components/schemas/BroadcastSceneTemplate', 'title' => '', 'example' => ''],
'title' => '',
'example' => '',
],
'nextToken' => ['description' => 'The token for the next page of results. This parameter is omitted when all results have been returned.', 'type' => 'string', 'example' => ' '."\n"
.'BS1b2WNnRMu4ouRzT4clY9Jhg', 'title' => ''],
'maxResults' => ['description' => 'The maximum number of results returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'success' => ['title' => 'Indicates whether the current request processing succeeded or failed ', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True'],
'code' => ['title' => 'Result code ', 'description' => 'The result code.', 'type' => 'string', 'example' => 'SUCCESS'],
'message' => ['title' => 'Error message returned when the request processing fails ', 'description' => 'The result message. A value of "SUCCESS" is returned for a successful request. An error message is returned for a failed request.', 'type' => 'string', 'example' => 'SUCCESS'],
'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', 'title' => ''],
'httpStatusCode' => ['title' => 'Returned HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
'example' => '',
],
],
],
'title' => 'List public broadcast templates ',
'summary' => 'Lists the public broadcast scene templates.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'lingmou:ListPublicBroadcastSceneTemplates',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"createTime\\": \\"2026-01-06T07:00:02Z\\",\\n \\"modifiedTime\\": \\"2026-01-06T07:00:02Z\\",\\n \\"name\\": \\"播报测试\\",\\n \\"desc\\": \\"视频描述\\",\\n \\"ratio\\": \\"9:16\\",\\n \\"previewURL\\": \\"https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CSNSAsOIDZQU2/result.mp4\\",\\n \\"shortVideoURL\\": \\"https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CSNSAsOIDZQU2/result_preview.mp4\\",\\n \\"coverURL\\": \\"https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CSNSAsOIDZQU2/cover.jpg\\",\\n \\"thumbnailURL\\": \\"https://online-avatar-property.oss-cn-beijing.aliyuncs.com/aigc_material/OUTPUT_BROADCAST_SHORT_VIDEO/Mt.CSNSAsOIDZQU2/thumbnail.jpg\\",\\n \\"id\\": \\"BS1tneDiuOOjJmI2qOHGw1urA\\",\\n \\"tags\\": [\\n \\"AI,BROADCAST\\"\\n ]\\n }\\n ],\\n \\"nextToken\\": \\"\\\\t\\\\nBS1b2WNnRMu4ouRzT4clY9Jhg\\",\\n \\"maxResults\\": 20,\\n \\"success\\": true,\\n \\"code\\": \\"SUCCESS\\",\\n \\"message\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]',
],
'ListTemplateMaterial' => [
'summary' => 'Retrieves a list of template materials.',
'path' => '/openapi/train/listTemplateMaterial',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarWE6ABK', 'FEATUREavatar8ULNZ9', 'FEATUREavatarIODFBA'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'page',
'in' => 'query',
'schema' => ['description' => 'The page number. Starts from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'size',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''],
],
[
'name' => 'maxResults',
'in' => 'query',
'schema' => ['description' => 'Reserved.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'nextToken',
'in' => 'query',
'schema' => ['description' => 'Reserved.', 'type' => 'string', 'required' => false, 'example' => 'M1Ti7gfj7VGDQgD588hxReiw ', 'title' => ''],
],
[
'name' => 'templateIds',
'in' => 'query',
'schema' => ['description' => 'One or more template IDs, separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => 'M1Ti7gfj7VGDQgD588hxReiw,M1j9tcbkh9YtBw7BdOYlDusQ', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListResult<ListPageTemplateMaterialDTO>',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'data' => [
'description' => 'The list of template materials.',
'type' => 'array',
'items' => [
'description' => 'A template material object.',
'type' => 'object',
'properties' => [
'templateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => 'M1Ti7gfj7VGDQgD588hxReiw ', 'title' => ''],
'templateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => '模版测试', 'title' => ''],
'templateURL' => ['description' => 'The template video URL.', 'type' => 'string', 'example' => '//daily-avatar-property.oss-cn-beijing.aliyuncs.com/material/INPUT_TRAIN_TEMPLATE_UGC_BODY/Mt.CNYEA3CV25QU2/%E5%BA%95%E6%9D%BF3%E6%9B%BF%E6%8D%A2.mp4?Expires=1764326111&OSSAccessKeyId=LTAI5tBRPnF5JkRCidYA****&Signature=3WU2%2FV2XDaQdt00lkAInK6yr9uk%3D', 'title' => ''],
'bizType' => ['description' => 'The business type of the template.', 'type' => 'string', 'example' => 'BROADCAST', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'page' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'size' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'True'."\n"],
'code' => ['description' => 'The response code.', 'type' => 'string', 'title' => '', 'example' => '200'],
'message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'success'],
'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8', 'title' => ''],
'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'],
'nextToken' => ['description' => 'Reserved.', 'type' => 'string', 'example' => ' '."\n"
.'M1Ti7gfj7VGDQgD588hxReiw', 'title' => ''],
'maxResults' => ['description' => 'Reserved.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"templateId\\": \\"M1Ti7gfj7VGDQgD588hxReiw\\\\t\\",\\n \\"templateName\\": \\"模版测试\\",\\n \\"templateURL\\": \\"//daily-avatar-property.oss-cn-beijing.aliyuncs.com/material/INPUT_TRAIN_TEMPLATE_UGC_BODY/Mt.CNYEA3CV25QU2/%E5%BA%95%E6%9D%BF3%E6%9B%BF%E6%8D%A2.mp4?Expires=1764326111&OSSAccessKeyId=LTAI5tBRPnF5JkRCidYA****&Signature=3WU2%2FV2XDaQdt00lkAInK6yr9uk%3D\\",\\n \\"bizType\\": \\"BROADCAST\\"\\n }\\n ],\\n \\"totalCount\\": 100,\\n \\"total\\": 100,\\n \\"page\\": 1,\\n \\"size\\": 20,\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"httpStatusCode\\": 200,\\n \\"nextToken\\": \\"\\\\t\\\\nM1Ti7gfj7VGDQgD588hxReiw\\",\\n \\"maxResults\\": 20\\n}","type":"json"}]',
'title' => 'Paged query for baseboard Material. ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ListTemplateMaterial'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'lingmou:ListTemplateMaterial',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'QueryChatInstanceSessions' => [
'summary' => 'Queries the sessions of a chat instance.',
'path' => '/openapi/chat/instances/{instanceId}/sessions',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREavatarWE6ABK', 'FEATUREavatar8ULNZ9', 'FEATUREavatarIODFBA'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'instanceId',
'in' => 'path',
'schema' => ['description' => 'The ID of the chat instance. You can find the instance ID on the order page.', 'type' => 'string', 'required' => false, 'example' => 'avatar_2dchat_public_cn-xxxxxxx', 'title' => ''],
],
[
'name' => 'sessionIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'A list of session IDs.',
'type' => 'array',
'items' => ['description' => 'A session ID.', 'type' => 'string', 'required' => false, 'example' => '8C9F2D4E-7A6B-4F1C-9E53-0B2C8D3F9A4B', 'title' => ''],
'required' => false,
'example' => '["8C9F2D4E-7A6B-4F1C-9E53-0B2C8D3F9A4B"] ',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the POP request.', 'type' => 'string', 'example' => '7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8'],
'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'message' => ['description' => 'The description of the response code.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'httpStatusCode' => ['description' => 'The HTTP response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'data' => [
'description' => 'The response data.',
'type' => 'array',
'items' => ['description' => 'An object containing information about an active session, including the session ID, the main account ID, and the creation timestamp.', '$ref' => '#/components/schemas/ChatSessionInfo', 'example' => '{"sessionId": "7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8", "createdAt": 1755680969, "mainAccountId": 1234567}', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"success\\": true,\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"sessionId\\": \\"7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8\\",\\n \\"mainAccountId\\": 1234567,\\n \\"createdAt\\": 1755680969\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Query Active Sessions Under an Instance',
'description' => 'Retrieves information about active sessions for a specified instance.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryChatInstanceSessions'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'lingmou:QueryChatInstanceSessions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
],
'endpoints' => [
['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'lingmou.cn-beijing.aliyuncs.com', 'endpoint' => 'lingmou.cn-beijing.aliyuncs.com', 'vpc' => 'lingmou-vpc.cn-beijing.aliyuncs.com'],
],
'errorCodes' => [],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 5, 'regionId' => '*', 'api' => 'CloseChatInstanceSessions'],
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CreateTTSVoiceCustom'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryChatInstanceSessions'],
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CreateBackgroundPic'],
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'GetBroadcastTemplate'],
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CreateChatConfig'],
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ListPrivateTTSVoicesCustom'],
['threshold' => '5', 'countWindow' => 5, 'regionId' => '*', 'api' => 'CreateChatSession'],
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'GetTrainPicAvatarStatus'],
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ListBroadcastVideosById'],
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CreateTrainPicAvatar'],
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ListTemplateMaterial'],
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'GetUploadPolicy'],
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CreateBroadcastSticker'],
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CreateNoTrainPicAvatar'],
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ConfirmTrainPicAvatar'],
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ListBroadcastTemplates'],
['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CreateBroadcastVideoFromTemplate'],
],
],
'ram' => [
'productCode' => 'LingMou',
'productName' => 'digitized virtual human',
'ramCodes' => ['lingmou'],
'ramLevel' => 'OPERATION',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'CreateTTSVoiceCustom',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CreateTTSVoiceCustom',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetTrainPicAvatarStatus',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'lingmou:GetTrainPicAvatarStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteBroadcastSticker',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'lingmou:DeleteBroadcastSticker',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateBroadcastVideoFromTemplate',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CreateBroadcastVideoFromTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTemplateMaterial',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'lingmou:ListTemplateMaterial',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetBroadcastTemplate',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'lingmou:GetBroadcastTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetTTSVoiceByIdCustom',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'lingmou:GetTTSVoiceByIdCustom',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CloseChatInstanceSessions',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'lingmou:CloseChatInstanceSessions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateNoTrainPicAvatar',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CreateNoTrainPicAvatar',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListBroadcastVideosById',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'lingmou:ListBroadcastVideosById',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetUploadPolicy',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'lingmou:GetUploadPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ConfirmTrainPicAvatar',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'lingmou:ConfirmTrainPicAvatar',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListBroadcastAudiosById',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'lingmou:ListBroadcastAudiosById',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateChatConfig',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CreateChatConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateBroadcastSticker',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CreateBroadcastSticker',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateChatSession',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CreateChatSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListPrivateTTSVoicesCustom',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'lingmou:ListPrivateTTSVoicesCustom',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListPublicBroadcastSceneTemplates',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'lingmou:ListPublicBroadcastSceneTemplates',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListBroadcastTemplates',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'lingmou:ListBroadcastTemplates',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateBackgroundPic',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CreateBackgroundPic',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CopyBroadcastSceneFromTemplate',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CopyBroadcastSceneFromTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateBroadcastAudio',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CreateBroadcastAudio',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateTrainPicAvatar',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'lingmou:CreateTrainPicAvatar',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryChatInstanceSessions',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'lingmou:QueryChatInstanceSessions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'LingMou', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [],
],
];
|