1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
12396
12397
12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
12706
12707
12708
12709
12710
12711
12712
12713
12714
12715
12716
12717
12718
12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779
12780
12781
12782
12783
12784
12785
12786
12787
12788
12789
12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
12850
12851
12852
12853
12854
12855
12856
12857
12858
12859
12860
12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
12871
12872
12873
12874
12875
12876
12877
12878
12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
13004
13005
13006
13007
13008
13009
13010
13011
13012
13013
13014
13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
13083
13084
13085
13086
13087
13088
13089
13090
13091
13092
13093
13094
13095
13096
13097
13098
13099
13100
13101
13102
13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160
13161
13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
13206
13207
13208
13209
13210
13211
13212
13213
13214
13215
13216
13217
13218
13219
13220
13221
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
13280
13281
13282
13283
13284
13285
13286
13287
13288
13289
13290
13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
13351
13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
13394
13395
13396
13397
13398
13399
13400
13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
13470
13471
13472
13473
13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
13555
13556
13557
13558
13559
13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
13573
13574
13575
13576
13577
13578
13579
13580
13581
13582
13583
13584
13585
13586
13587
13588
13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
13608
13609
13610
13611
13612
13613
13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
13631
13632
13633
13634
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
13657
13658
13659
13660
13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
13674
13675
13676
13677
13678
13679
13680
13681
13682
13683
13684
13685
13686
13687
13688
13689
13690
13691
13692
13693
13694
13695
13696
13697
13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
13735
13736
13737
13738
13739
13740
13741
13742
13743
13744
13745
13746
13747
13748
13749
13750
13751
13752
13753
13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
13765
13766
13767
13768
13769
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
13780
13781
13782
13783
13784
13785
13786
13787
13788
13789
13790
13791
13792
13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
13821
13822
13823
13824
13825
13826
13827
13828
13829
13830
13831
13832
13833
13834
13835
13836
13837
13838
13839
13840
13841
13842
13843
13844
13845
13846
13847
13848
13849
13850
13851
13852
13853
13854
13855
13856
13857
13858
13859
13860
13861
13862
13863
13864
13865
13866
13867
13868
13869
13870
13871
13872
13873
13874
13875
13876
13877
13878
13879
13880
13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
13894
13895
13896
13897
13898
13899
13900
13901
13902
13903
13904
13905
13906
13907
13908
13909
13910
13911
13912
13913
13914
13915
13916
13917
13918
13919
13920
13921
13922
13923
13924
13925
13926
13927
13928
13929
13930
13931
13932
13933
13934
13935
13936
13937
13938
13939
13940
13941
13942
13943
13944
13945
13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963
13964
13965
13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
13978
13979
13980
13981
13982
13983
13984
13985
13986
13987
13988
13989
13990
13991
13992
13993
13994
13995
13996
13997
13998
13999
14000
14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
14024
14025
14026
14027
14028
14029
14030
14031
14032
14033
14034
14035
14036
14037
14038
14039
14040
14041
14042
14043
14044
14045
14046
14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
14058
14059
14060
14061
14062
14063
14064
14065
14066
14067
14068
14069
14070
14071
14072
14073
14074
14075
14076
14077
14078
14079
14080
14081
14082
14083
14084
14085
14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
14096
14097
14098
14099
14100
14101
14102
14103
14104
14105
14106
14107
14108
14109
14110
14111
14112
14113
14114
14115
14116
14117
14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
14137
14138
14139
14140
14141
14142
14143
14144
14145
14146
14147
14148
14149
14150
14151
14152
14153
14154
14155
14156
14157
14158
14159
14160
14161
14162
14163
14164
14165
14166
14167
14168
14169
14170
14171
14172
14173
14174
14175
14176
14177
14178
14179
14180
14181
14182
14183
14184
14185
14186
14187
14188
14189
14190
14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
14206
14207
14208
14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
14220
14221
14222
14223
14224
14225
14226
14227
14228
14229
14230
14231
14232
14233
14234
14235
14236
14237
14238
14239
14240
14241
14242
14243
14244
14245
14246
14247
14248
14249
14250
14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
14264
14265
14266
14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
14277
14278
14279
14280
14281
14282
14283
14284
14285
14286
14287
14288
14289
14290
14291
14292
14293
14294
14295
14296
14297
14298
14299
14300
14301
14302
14303
14304
14305
14306
14307
14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
14322
14323
14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
14349
14350
14351
14352
14353
14354
14355
14356
14357
14358
14359
14360
14361
14362
14363
14364
14365
14366
14367
14368
14369
14370
14371
14372
14373
14374
14375
14376
14377
14378
14379
14380
14381
14382
14383
14384
14385
14386
14387
14388
14389
14390
14391
14392
14393
14394
14395
14396
14397
14398
14399
14400
14401
14402
14403
14404
14405
14406
14407
14408
14409
14410
14411
14412
14413
14414
14415
14416
14417
14418
14419
14420
14421
14422
14423
14424
14425
14426
14427
14428
14429
14430
14431
14432
14433
14434
14435
14436
14437
14438
14439
14440
14441
14442
14443
14444
14445
14446
14447
14448
14449
14450
14451
14452
14453
14454
14455
14456
14457
14458
14459
14460
14461
14462
14463
14464
14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
14485
14486
14487
14488
14489
14490
14491
14492
14493
14494
14495
14496
14497
14498
14499
14500
14501
14502
14503
14504
14505
14506
14507
14508
14509
14510
14511
14512
14513
14514
14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
14529
14530
14531
14532
14533
14534
14535
14536
14537
14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
14549
14550
14551
14552
14553
14554
14555
14556
14557
14558
14559
14560
14561
14562
14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
14573
14574
14575
14576
14577
14578
14579
14580
14581
14582
14583
14584
14585
14586
14587
14588
14589
14590
14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
14604
14605
14606
14607
14608
14609
14610
14611
14612
14613
14614
14615
14616
14617
14618
14619
14620
14621
14622
14623
14624
14625
14626
14627
14628
14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
14645
14646
14647
14648
14649
14650
14651
14652
14653
14654
14655
14656
14657
14658
14659
14660
14661
14662
14663
14664
14665
14666
14667
14668
14669
14670
14671
14672
14673
14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
14684
14685
14686
14687
14688
14689
14690
14691
14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
14708
14709
14710
14711
14712
14713
14714
14715
14716
14717
14718
14719
14720
14721
14722
14723
14724
14725
14726
14727
14728
14729
14730
14731
14732
14733
14734
14735
14736
14737
14738
14739
14740
14741
14742
14743
14744
14745
14746
14747
14748
14749
14750
14751
14752
14753
14754
14755
14756
14757
14758
14759
14760
14761
14762
14763
14764
14765
14766
14767
14768
14769
14770
14771
14772
14773
14774
14775
14776
14777
14778
14779
14780
14781
14782
14783
14784
14785
14786
14787
14788
14789
14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
14811
14812
14813
14814
14815
14816
14817
14818
14819
14820
14821
14822
14823
14824
14825
14826
14827
14828
14829
14830
14831
14832
14833
14834
14835
14836
14837
14838
14839
14840
14841
14842
14843
14844
14845
14846
14847
14848
14849
14850
14851
14852
14853
14854
14855
14856
14857
14858
14859
14860
14861
14862
14863
14864
14865
14866
14867
14868
14869
14870
14871
14872
14873
14874
14875
14876
14877
14878
14879
14880
14881
14882
14883
14884
14885
14886
14887
14888
14889
14890
14891
14892
14893
14894
14895
14896
14897
14898
14899
14900
14901
14902
14903
14904
14905
14906
14907
14908
14909
14910
14911
14912
14913
14914
14915
14916
14917
14918
14919
14920
14921
14922
14923
14924
14925
14926
14927
14928
14929
14930
14931
14932
14933
14934
14935
14936
14937
14938
14939
14940
14941
14942
14943
14944
14945
14946
14947
14948
14949
14950
14951
14952
14953
14954
14955
14956
14957
14958
14959
14960
14961
14962
14963
14964
14965
14966
14967
14968
14969
14970
14971
14972
14973
14974
14975
14976
14977
14978
14979
14980
14981
14982
14983
14984
14985
14986
14987
14988
14989
14990
14991
14992
14993
14994
14995
14996
14997
14998
14999
15000
15001
15002
15003
15004
15005
15006
15007
15008
15009
15010
15011
15012
15013
15014
15015
15016
15017
15018
15019
15020
15021
15022
15023
15024
15025
15026
15027
15028
15029
15030
15031
15032
15033
15034
15035
15036
15037
15038
15039
15040
15041
15042
15043
15044
15045
15046
15047
15048
15049
15050
15051
15052
15053
15054
15055
15056
15057
15058
15059
15060
15061
15062
15063
15064
15065
15066
15067
15068
15069
15070
15071
15072
15073
15074
15075
15076
15077
15078
15079
15080
15081
15082
15083
15084
15085
15086
15087
15088
15089
15090
15091
15092
15093
15094
15095
15096
15097
15098
15099
15100
15101
15102
15103
15104
15105
15106
15107
15108
15109
15110
15111
15112
15113
15114
15115
15116
15117
15118
15119
15120
15121
15122
15123
15124
15125
15126
15127
15128
15129
15130
15131
15132
15133
15134
15135
15136
15137
15138
15139
15140
15141
15142
15143
15144
15145
15146
15147
15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
15159
15160
15161
15162
15163
15164
15165
15166
15167
15168
15169
15170
15171
15172
15173
15174
15175
15176
15177
15178
15179
15180
15181
15182
15183
15184
15185
15186
15187
15188
15189
15190
15191
15192
15193
15194
15195
15196
15197
15198
15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
15210
15211
15212
15213
15214
15215
15216
15217
15218
15219
15220
15221
15222
15223
15224
15225
15226
15227
15228
15229
15230
15231
15232
15233
15234
15235
15236
15237
15238
15239
15240
15241
15242
15243
15244
15245
15246
15247
15248
15249
15250
15251
15252
15253
15254
15255
15256
15257
15258
15259
15260
15261
15262
15263
15264
15265
15266
15267
15268
15269
15270
15271
15272
15273
15274
15275
15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
15290
15291
15292
15293
15294
15295
15296
15297
15298
15299
15300
15301
15302
15303
15304
15305
15306
15307
15308
15309
15310
15311
15312
15313
15314
15315
15316
15317
15318
15319
15320
15321
15322
15323
15324
15325
15326
15327
15328
15329
15330
15331
15332
15333
15334
15335
15336
15337
15338
15339
15340
15341
15342
15343
15344
15345
15346
15347
15348
15349
15350
15351
15352
15353
15354
15355
15356
15357
15358
15359
15360
15361
15362
15363
15364
15365
15366
15367
15368
15369
15370
15371
15372
15373
15374
15375
15376
15377
15378
15379
15380
15381
15382
15383
15384
15385
15386
15387
15388
15389
15390
15391
15392
15393
15394
15395
15396
15397
15398
15399
15400
15401
15402
15403
15404
15405
15406
15407
15408
15409
15410
15411
15412
15413
15414
15415
15416
15417
15418
15419
15420
15421
15422
15423
15424
15425
15426
15427
15428
15429
15430
15431
15432
15433
15434
15435
15436
15437
15438
15439
15440
15441
15442
15443
15444
15445
15446
15447
15448
15449
15450
15451
15452
15453
15454
15455
15456
15457
15458
15459
15460
15461
15462
15463
15464
15465
15466
15467
15468
15469
15470
15471
15472
15473
15474
15475
15476
15477
15478
15479
15480
15481
15482
15483
15484
15485
15486
15487
15488
15489
15490
15491
15492
15493
15494
15495
15496
15497
15498
15499
15500
15501
15502
15503
15504
15505
15506
15507
15508
15509
15510
15511
15512
15513
15514
15515
15516
15517
15518
15519
15520
15521
15522
15523
15524
15525
15526
15527
15528
15529
15530
15531
15532
15533
15534
15535
15536
15537
15538
15539
15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
15555
15556
15557
15558
15559
15560
15561
15562
15563
15564
15565
15566
15567
15568
15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
15589
15590
15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
15610
15611
15612
15613
15614
15615
15616
15617
15618
15619
15620
15621
15622
15623
15624
15625
15626
15627
15628
15629
15630
15631
15632
15633
15634
15635
15636
15637
15638
15639
15640
15641
15642
15643
15644
15645
15646
15647
15648
15649
15650
15651
15652
15653
15654
15655
15656
15657
15658
15659
15660
15661
15662
15663
15664
15665
15666
15667
15668
15669
15670
15671
15672
15673
15674
15675
15676
15677
15678
15679
15680
15681
15682
15683
15684
15685
15686
15687
15688
15689
15690
15691
15692
15693
15694
15695
15696
15697
15698
15699
15700
15701
15702
15703
15704
15705
15706
15707
15708
15709
15710
15711
15712
15713
15714
15715
15716
15717
15718
15719
15720
15721
15722
15723
15724
15725
15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
15742
15743
15744
15745
15746
15747
15748
15749
15750
15751
15752
15753
15754
15755
15756
15757
15758
15759
15760
15761
15762
15763
15764
15765
15766
15767
15768
15769
15770
15771
15772
15773
15774
15775
15776
15777
15778
15779
15780
15781
15782
15783
15784
15785
15786
15787
15788
15789
15790
15791
15792
15793
15794
15795
15796
15797
15798
15799
15800
15801
15802
15803
15804
15805
15806
15807
15808
15809
15810
15811
15812
15813
15814
15815
15816
15817
15818
15819
15820
15821
15822
15823
15824
15825
15826
15827
15828
15829
15830
15831
15832
15833
15834
15835
15836
15837
15838
15839
15840
15841
15842
15843
15844
15845
15846
15847
15848
15849
15850
15851
15852
15853
15854
15855
15856
15857
15858
15859
15860
15861
15862
15863
15864
15865
15866
15867
15868
15869
15870
15871
15872
15873
15874
15875
15876
15877
15878
15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
15892
15893
15894
15895
15896
15897
15898
15899
15900
15901
15902
15903
15904
15905
15906
15907
15908
15909
15910
15911
15912
15913
15914
15915
15916
15917
15918
15919
15920
15921
15922
15923
15924
15925
15926
15927
15928
15929
15930
15931
15932
15933
15934
15935
15936
15937
15938
15939
15940
15941
15942
15943
15944
15945
15946
15947
15948
15949
15950
15951
15952
15953
15954
15955
15956
15957
15958
15959
15960
15961
15962
15963
15964
15965
15966
15967
15968
15969
15970
15971
15972
15973
15974
15975
15976
15977
15978
15979
15980
15981
15982
15983
15984
15985
15986
15987
15988
15989
15990
15991
15992
15993
15994
15995
15996
15997
15998
15999
16000
16001
16002
16003
16004
16005
16006
16007
16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
16024
16025
16026
16027
16028
16029
16030
16031
16032
16033
16034
16035
16036
16037
16038
16039
16040
16041
16042
16043
16044
16045
16046
16047
16048
16049
16050
16051
16052
16053
16054
16055
16056
16057
16058
16059
16060
16061
16062
16063
16064
16065
16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
16079
16080
16081
16082
16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
16110
16111
16112
16113
16114
16115
16116
16117
16118
16119
16120
16121
16122
16123
16124
16125
16126
16127
16128
16129
16130
16131
16132
16133
16134
16135
16136
16137
16138
16139
16140
16141
16142
16143
16144
16145
16146
16147
16148
16149
16150
16151
16152
16153
16154
16155
16156
16157
16158
16159
16160
16161
16162
16163
16164
16165
16166
16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
16177
16178
16179
16180
16181
16182
16183
16184
16185
16186
16187
16188
16189
16190
16191
16192
16193
16194
16195
16196
16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
16210
16211
16212
16213
16214
16215
16216
16217
16218
16219
16220
16221
16222
16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
16238
16239
16240
16241
16242
16243
16244
16245
16246
16247
16248
16249
16250
16251
16252
16253
16254
16255
16256
16257
16258
16259
16260
16261
16262
16263
16264
16265
16266
16267
16268
16269
16270
16271
16272
16273
16274
16275
16276
16277
16278
16279
16280
16281
16282
16283
16284
16285
16286
16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
16305
16306
16307
16308
16309
16310
16311
16312
16313
16314
16315
16316
16317
16318
16319
16320
16321
16322
16323
16324
16325
16326
16327
16328
16329
16330
16331
16332
16333
16334
16335
16336
16337
16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
16349
16350
16351
16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
16369
16370
16371
16372
16373
16374
16375
16376
16377
16378
16379
16380
16381
16382
16383
16384
16385
16386
16387
16388
16389
16390
16391
16392
16393
16394
16395
16396
16397
16398
16399
16400
16401
16402
16403
16404
16405
16406
16407
16408
16409
16410
16411
16412
16413
16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
16424
16425
16426
16427
16428
16429
16430
16431
16432
16433
16434
16435
16436
16437
16438
16439
16440
16441
16442
16443
16444
16445
16446
16447
16448
16449
16450
16451
16452
16453
16454
16455
16456
16457
16458
16459
16460
16461
16462
16463
16464
16465
16466
16467
16468
16469
16470
16471
16472
16473
16474
16475
16476
16477
16478
16479
16480
16481
16482
16483
16484
16485
16486
16487
16488
16489
16490
16491
16492
16493
16494
16495
16496
16497
16498
16499
16500
16501
16502
16503
16504
16505
16506
16507
16508
16509
16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
16522
16523
16524
16525
16526
16527
16528
16529
16530
16531
16532
16533
16534
16535
16536
16537
16538
16539
16540
16541
16542
16543
16544
16545
16546
16547
16548
16549
16550
16551
16552
16553
16554
16555
16556
16557
16558
16559
16560
16561
16562
16563
16564
16565
16566
16567
16568
16569
16570
16571
16572
16573
16574
16575
16576
16577
16578
16579
16580
16581
16582
16583
16584
16585
16586
16587
16588
16589
16590
16591
16592
16593
16594
16595
16596
16597
16598
16599
16600
16601
16602
16603
16604
16605
16606
16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
16619
16620
16621
16622
16623
16624
16625
16626
16627
16628
16629
16630
16631
16632
16633
16634
16635
16636
16637
16638
16639
16640
16641
16642
16643
16644
16645
16646
16647
16648
16649
16650
16651
16652
16653
16654
16655
16656
16657
16658
16659
16660
16661
16662
16663
16664
16665
16666
16667
16668
16669
16670
16671
16672
16673
16674
16675
16676
16677
16678
16679
16680
16681
16682
16683
16684
16685
16686
16687
16688
16689
16690
16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
16704
16705
16706
16707
16708
16709
16710
16711
16712
16713
16714
16715
16716
16717
16718
16719
16720
16721
16722
16723
16724
16725
16726
16727
16728
16729
16730
16731
16732
16733
16734
16735
16736
16737
16738
16739
16740
16741
16742
16743
16744
16745
16746
16747
16748
16749
16750
16751
16752
16753
16754
16755
16756
16757
16758
16759
16760
16761
16762
16763
16764
16765
16766
16767
16768
16769
16770
16771
16772
16773
16774
16775
16776
16777
16778
16779
16780
16781
16782
16783
16784
16785
16786
16787
16788
16789
16790
16791
16792
16793
16794
16795
16796
16797
16798
16799
16800
16801
16802
16803
16804
16805
16806
16807
16808
16809
16810
16811
16812
16813
16814
16815
16816
16817
16818
16819
16820
16821
16822
16823
16824
16825
16826
16827
16828
16829
16830
16831
16832
16833
16834
16835
16836
16837
16838
16839
16840
16841
16842
16843
16844
16845
16846
16847
16848
16849
16850
16851
16852
16853
16854
16855
16856
16857
16858
16859
16860
16861
16862
16863
16864
16865
16866
16867
16868
16869
16870
16871
16872
16873
16874
16875
16876
16877
16878
16879
16880
16881
16882
16883
16884
16885
16886
16887
16888
16889
16890
16891
16892
16893
16894
16895
16896
16897
16898
16899
16900
16901
16902
16903
16904
16905
16906
16907
16908
16909
16910
16911
16912
16913
16914
16915
16916
16917
16918
16919
16920
16921
16922
16923
16924
16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
16940
16941
16942
16943
16944
16945
16946
16947
16948
16949
16950
16951
16952
16953
16954
16955
16956
16957
16958
16959
16960
16961
16962
16963
16964
16965
16966
16967
16968
16969
16970
16971
16972
16973
16974
16975
16976
16977
16978
16979
16980
16981
16982
16983
16984
16985
16986
16987
16988
16989
16990
16991
16992
16993
16994
16995
16996
16997
16998
16999
17000
17001
17002
17003
17004
17005
17006
17007
17008
17009
17010
17011
17012
17013
17014
17015
17016
17017
17018
17019
17020
17021
17022
17023
17024
17025
17026
17027
17028
17029
17030
17031
17032
17033
17034
17035
17036
17037
17038
17039
17040
17041
17042
17043
17044
17045
17046
17047
17048
17049
17050
17051
17052
17053
17054
17055
17056
17057
17058
17059
17060
17061
17062
17063
17064
17065
17066
17067
17068
17069
17070
17071
17072
17073
17074
17075
17076
17077
17078
17079
17080
17081
17082
17083
17084
17085
17086
17087
17088
17089
17090
17091
17092
17093
17094
17095
17096
17097
17098
17099
17100
17101
17102
17103
17104
17105
17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
17127
17128
17129
17130
17131
17132
17133
17134
17135
17136
17137
17138
17139
17140
17141
17142
17143
17144
17145
17146
17147
17148
17149
17150
17151
17152
17153
17154
17155
17156
17157
17158
17159
17160
17161
17162
17163
17164
17165
17166
17167
17168
17169
17170
17171
17172
17173
17174
17175
17176
17177
17178
17179
17180
17181
17182
17183
17184
17185
17186
17187
17188
17189
17190
17191
17192
17193
17194
17195
17196
17197
17198
17199
17200
17201
17202
17203
17204
17205
17206
17207
17208
17209
17210
17211
17212
17213
17214
17215
17216
17217
17218
17219
17220
17221
17222
17223
17224
17225
17226
17227
17228
17229
17230
17231
17232
17233
17234
17235
17236
17237
17238
17239
17240
17241
17242
17243
17244
17245
17246
17247
17248
17249
17250
17251
17252
17253
17254
17255
17256
17257
17258
17259
17260
17261
17262
17263
17264
17265
17266
17267
17268
17269
17270
17271
17272
17273
17274
17275
17276
17277
17278
17279
17280
17281
17282
17283
17284
17285
17286
17287
17288
17289
17290
17291
17292
17293
17294
17295
17296
17297
17298
17299
17300
17301
17302
17303
17304
17305
17306
17307
17308
17309
17310
17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
17325
17326
17327
17328
17329
17330
17331
17332
17333
17334
17335
17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
17349
17350
17351
17352
17353
17354
17355
17356
17357
17358
17359
17360
17361
17362
17363
17364
17365
17366
17367
17368
17369
17370
17371
17372
17373
17374
17375
17376
17377
17378
17379
17380
17381
17382
17383
17384
17385
17386
17387
17388
17389
17390
17391
17392
17393
17394
17395
17396
17397
17398
17399
17400
17401
17402
17403
17404
17405
17406
17407
17408
17409
17410
17411
17412
17413
17414
17415
17416
17417
17418
17419
17420
17421
17422
17423
17424
17425
17426
17427
17428
17429
17430
17431
17432
17433
17434
17435
17436
17437
17438
17439
17440
17441
17442
17443
17444
17445
17446
17447
17448
17449
17450
17451
17452
17453
17454
17455
17456
17457
17458
17459
17460
17461
17462
17463
17464
17465
17466
17467
17468
17469
17470
17471
17472
17473
17474
17475
17476
17477
17478
17479
17480
17481
17482
17483
17484
17485
17486
17487
17488
17489
17490
17491
17492
17493
17494
17495
17496
17497
17498
17499
17500
17501
17502
17503
17504
17505
17506
17507
17508
17509
17510
17511
17512
17513
17514
17515
17516
17517
17518
17519
17520
17521
17522
17523
17524
17525
17526
17527
17528
17529
17530
17531
17532
17533
17534
17535
17536
17537
17538
17539
17540
17541
17542
17543
17544
17545
17546
17547
17548
17549
17550
17551
17552
17553
17554
17555
17556
17557
17558
17559
17560
17561
17562
17563
17564
17565
17566
17567
17568
17569
17570
17571
17572
17573
17574
17575
17576
17577
17578
17579
17580
17581
17582
17583
17584
17585
17586
17587
17588
17589
17590
17591
17592
17593
17594
17595
17596
17597
17598
17599
17600
17601
17602
17603
17604
17605
17606
17607
17608
17609
17610
17611
17612
17613
17614
17615
17616
17617
17618
17619
17620
17621
17622
17623
17624
17625
17626
17627
17628
17629
17630
17631
17632
17633
17634
17635
17636
17637
17638
17639
17640
17641
17642
17643
17644
17645
17646
17647
17648
17649
17650
17651
17652
17653
17654
17655
17656
17657
17658
17659
17660
17661
17662
17663
17664
17665
17666
17667
17668
17669
17670
17671
17672
17673
17674
17675
17676
17677
17678
17679
17680
17681
17682
17683
17684
17685
17686
17687
17688
17689
17690
17691
17692
17693
17694
17695
17696
17697
17698
17699
17700
17701
17702
17703
17704
17705
17706
17707
17708
17709
17710
17711
17712
17713
17714
17715
17716
17717
17718
17719
17720
17721
17722
17723
17724
17725
17726
17727
17728
17729
17730
17731
17732
17733
17734
17735
17736
17737
17738
17739
17740
17741
17742
17743
17744
17745
17746
17747
17748
17749
17750
17751
17752
17753
17754
17755
17756
17757
17758
17759
17760
17761
17762
17763
17764
17765
17766
17767
17768
17769
17770
17771
17772
17773
17774
17775
17776
17777
17778
17779
17780
17781
17782
17783
17784
17785
17786
17787
17788
17789
17790
17791
17792
17793
17794
17795
17796
17797
17798
17799
17800
17801
17802
17803
17804
17805
17806
17807
17808
17809
17810
17811
17812
17813
17814
17815
17816
17817
17818
17819
17820
17821
17822
17823
17824
17825
17826
17827
17828
17829
17830
17831
17832
17833
17834
17835
17836
17837
17838
17839
17840
17841
17842
17843
17844
17845
17846
17847
17848
17849
17850
17851
17852
17853
17854
17855
17856
17857
17858
17859
17860
17861
17862
17863
17864
17865
17866
17867
17868
17869
17870
17871
17872
17873
17874
17875
17876
17877
17878
17879
17880
17881
17882
17883
17884
17885
17886
17887
17888
17889
17890
17891
17892
17893
17894
17895
17896
17897
17898
17899
17900
17901
17902
17903
17904
17905
17906
17907
17908
17909
17910
17911
17912
17913
17914
17915
17916
17917
17918
17919
17920
17921
17922
17923
17924
17925
17926
17927
17928
17929
17930
17931
17932
17933
17934
17935
17936
17937
17938
17939
17940
17941
17942
17943
17944
17945
17946
17947
17948
17949
17950
17951
17952
17953
17954
17955
17956
17957
17958
17959
17960
17961
17962
17963
17964
17965
17966
17967
17968
17969
17970
17971
17972
17973
17974
17975
17976
17977
17978
17979
17980
17981
17982
17983
17984
17985
17986
17987
17988
17989
17990
17991
17992
17993
17994
17995
17996
17997
17998
17999
18000
18001
18002
18003
18004
18005
18006
18007
18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
18040
18041
18042
18043
18044
18045
18046
18047
18048
18049
18050
18051
18052
18053
18054
18055
18056
18057
18058
18059
18060
18061
18062
18063
18064
18065
18066
18067
18068
18069
18070
18071
18072
18073
18074
18075
18076
18077
18078
18079
18080
18081
18082
18083
18084
18085
18086
18087
18088
18089
18090
18091
18092
18093
18094
18095
18096
18097
18098
18099
18100
18101
18102
18103
18104
18105
18106
18107
18108
18109
18110
18111
18112
18113
18114
18115
18116
18117
18118
18119
18120
18121
18122
18123
18124
18125
18126
18127
18128
18129
18130
18131
18132
18133
18134
18135
18136
18137
18138
18139
18140
18141
18142
18143
18144
18145
18146
18147
18148
18149
18150
18151
18152
18153
18154
18155
18156
18157
18158
18159
18160
18161
18162
18163
18164
18165
18166
18167
18168
18169
18170
18171
18172
18173
18174
18175
18176
18177
18178
18179
18180
18181
18182
18183
18184
18185
18186
18187
18188
18189
18190
18191
18192
18193
18194
18195
18196
18197
18198
18199
18200
18201
18202
18203
18204
18205
18206
18207
18208
18209
18210
18211
18212
18213
18214
18215
18216
18217
18218
18219
18220
18221
18222
18223
18224
18225
18226
18227
18228
18229
18230
18231
18232
18233
18234
18235
18236
18237
18238
18239
18240
18241
18242
18243
18244
18245
18246
18247
18248
18249
18250
18251
18252
18253
18254
18255
18256
18257
18258
18259
18260
18261
18262
18263
18264
18265
18266
18267
18268
18269
18270
18271
18272
18273
18274
18275
18276
18277
18278
18279
18280
18281
18282
18283
18284
18285
18286
18287
18288
18289
18290
18291
18292
18293
18294
18295
18296
18297
18298
18299
18300
18301
18302
18303
18304
18305
18306
18307
18308
18309
18310
18311
18312
18313
18314
18315
18316
18317
18318
18319
18320
18321
18322
18323
18324
18325
18326
18327
18328
18329
18330
18331
18332
18333
18334
18335
18336
18337
18338
18339
18340
18341
18342
18343
18344
18345
18346
18347
18348
18349
18350
18351
18352
18353
18354
18355
18356
18357
18358
18359
18360
18361
18362
18363
18364
18365
18366
18367
18368
18369
18370
18371
18372
18373
18374
18375
18376
18377
18378
18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
18391
18392
18393
18394
18395
18396
18397
18398
18399
18400
18401
18402
18403
18404
18405
18406
18407
18408
18409
18410
18411
18412
18413
18414
18415
18416
18417
18418
18419
18420
18421
18422
18423
18424
18425
18426
18427
18428
18429
18430
18431
18432
18433
18434
18435
18436
18437
18438
18439
18440
18441
18442
18443
18444
18445
18446
18447
18448
18449
18450
18451
18452
18453
18454
18455
18456
18457
18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
18473
18474
18475
18476
18477
18478
18479
18480
18481
18482
18483
18484
18485
18486
18487
18488
18489
18490
18491
18492
18493
18494
18495
18496
18497
18498
18499
18500
18501
18502
18503
18504
18505
18506
18507
18508
18509
18510
18511
18512
18513
18514
18515
18516
18517
18518
18519
18520
18521
18522
18523
18524
18525
18526
18527
18528
18529
18530
18531
18532
18533
18534
18535
18536
18537
18538
18539
18540
18541
18542
18543
18544
18545
18546
18547
18548
18549
18550
18551
18552
18553
18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
18585
18586
18587
18588
18589
18590
18591
18592
18593
18594
18595
18596
18597
18598
18599
18600
18601
18602
18603
18604
18605
18606
18607
18608
18609
18610
18611
18612
18613
18614
18615
18616
18617
18618
18619
18620
18621
18622
18623
18624
18625
18626
18627
18628
18629
18630
18631
18632
18633
18634
18635
18636
18637
18638
18639
18640
18641
18642
18643
18644
18645
18646
18647
18648
18649
18650
18651
18652
18653
18654
18655
18656
18657
18658
18659
18660
18661
18662
18663
18664
18665
18666
18667
18668
18669
18670
18671
18672
18673
18674
18675
18676
18677
18678
18679
18680
18681
18682
18683
18684
18685
18686
18687
18688
18689
18690
18691
18692
18693
18694
18695
18696
18697
18698
18699
18700
18701
18702
18703
18704
18705
18706
18707
18708
18709
18710
18711
18712
18713
18714
18715
18716
18717
18718
18719
18720
18721
18722
18723
18724
18725
18726
18727
18728
18729
18730
18731
18732
18733
18734
18735
18736
18737
18738
18739
18740
18741
18742
18743
18744
18745
18746
18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
18763
18764
18765
18766
18767
18768
18769
18770
18771
18772
18773
18774
18775
18776
18777
18778
18779
18780
18781
18782
18783
18784
18785
18786
18787
18788
18789
18790
18791
18792
18793
18794
18795
18796
18797
18798
18799
18800
18801
18802
18803
18804
18805
18806
18807
18808
18809
18810
18811
18812
18813
18814
18815
18816
18817
18818
18819
18820
18821
18822
18823
18824
18825
18826
18827
18828
18829
18830
18831
18832
18833
18834
18835
18836
18837
18838
18839
18840
18841
18842
18843
18844
18845
18846
18847
18848
18849
18850
18851
18852
18853
18854
18855
18856
18857
18858
18859
18860
18861
18862
18863
18864
18865
18866
18867
18868
18869
18870
18871
18872
18873
18874
18875
18876
18877
18878
18879
18880
18881
18882
18883
18884
18885
18886
18887
18888
18889
18890
18891
18892
18893
18894
18895
18896
18897
18898
18899
18900
18901
18902
18903
18904
18905
18906
18907
18908
18909
18910
18911
18912
18913
18914
18915
18916
18917
18918
18919
18920
18921
18922
18923
18924
18925
18926
18927
18928
18929
18930
18931
18932
18933
18934
18935
18936
18937
18938
18939
18940
18941
18942
18943
18944
18945
18946
18947
18948
18949
18950
18951
18952
18953
18954
18955
18956
18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
18983
18984
18985
18986
18987
18988
18989
18990
18991
18992
18993
18994
18995
18996
18997
18998
18999
19000
19001
19002
19003
19004
19005
19006
19007
19008
19009
19010
19011
19012
19013
19014
19015
19016
19017
19018
19019
19020
19021
19022
19023
19024
19025
19026
19027
19028
19029
19030
19031
19032
19033
19034
19035
19036
19037
19038
19039
19040
19041
19042
19043
19044
19045
19046
19047
19048
19049
19050
19051
19052
19053
19054
19055
19056
19057
19058
19059
19060
19061
19062
19063
19064
19065
19066
19067
19068
19069
19070
19071
19072
19073
19074
19075
19076
19077
19078
19079
19080
19081
19082
19083
19084
19085
19086
19087
19088
19089
19090
19091
19092
19093
19094
19095
19096
19097
19098
19099
19100
19101
19102
19103
19104
19105
19106
19107
19108
19109
19110
19111
19112
19113
19114
19115
19116
19117
19118
19119
19120
19121
19122
19123
19124
19125
19126
19127
19128
19129
19130
19131
19132
19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
19155
19156
19157
19158
19159
19160
19161
19162
19163
19164
19165
19166
19167
19168
19169
19170
19171
19172
19173
19174
19175
19176
19177
19178
19179
19180
19181
19182
19183
19184
19185
19186
19187
19188
19189
19190
19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
19203
19204
19205
19206
19207
19208
19209
19210
19211
19212
19213
19214
19215
19216
19217
19218
19219
19220
19221
19222
19223
19224
19225
19226
19227
19228
19229
19230
19231
19232
19233
19234
19235
19236
19237
19238
19239
19240
19241
19242
19243
19244
19245
19246
19247
19248
19249
19250
19251
19252
19253
19254
19255
19256
19257
19258
19259
19260
19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
19277
19278
19279
19280
19281
19282
19283
19284
19285
19286
19287
19288
19289
19290
19291
19292
19293
19294
19295
19296
19297
19298
19299
19300
19301
19302
19303
19304
19305
19306
19307
19308
19309
19310
19311
19312
19313
19314
19315
19316
19317
19318
19319
19320
19321
19322
19323
19324
19325
19326
19327
19328
19329
19330
19331
19332
19333
19334
19335
19336
19337
19338
19339
19340
19341
19342
19343
19344
19345
19346
19347
19348
19349
19350
19351
19352
19353
19354
19355
19356
19357
19358
19359
19360
19361
19362
19363
19364
19365
19366
19367
19368
19369
19370
19371
19372
19373
19374
19375
19376
19377
19378
19379
19380
19381
19382
19383
19384
19385
19386
19387
19388
19389
19390
19391
19392
19393
19394
19395
19396
19397
19398
19399
19400
19401
19402
19403
19404
19405
19406
19407
19408
19409
19410
19411
19412
19413
19414
19415
19416
19417
19418
19419
19420
19421
19422
19423
19424
19425
19426
19427
19428
19429
19430
19431
19432
19433
19434
19435
19436
19437
19438
19439
19440
19441
19442
19443
19444
19445
19446
19447
19448
19449
19450
19451
19452
19453
19454
19455
19456
19457
19458
19459
19460
19461
19462
19463
19464
19465
19466
19467
19468
19469
19470
19471
19472
19473
19474
19475
19476
19477
19478
19479
19480
19481
19482
19483
19484
19485
19486
19487
19488
19489
19490
19491
19492
19493
19494
19495
19496
19497
19498
19499
19500
19501
19502
19503
19504
19505
19506
19507
19508
19509
19510
19511
19512
19513
19514
19515
19516
19517
19518
19519
19520
19521
19522
19523
19524
19525
19526
19527
19528
19529
19530
19531
19532
19533
19534
19535
19536
19537
19538
19539
19540
19541
19542
19543
19544
19545
19546
19547
19548
19549
19550
19551
19552
19553
19554
19555
19556
19557
19558
19559
19560
19561
19562
19563
19564
19565
19566
19567
19568
19569
19570
19571
19572
19573
19574
19575
19576
19577
19578
19579
19580
19581
19582
19583
19584
19585
19586
19587
19588
19589
19590
19591
19592
19593
19594
19595
19596
19597
19598
19599
19600
19601
19602
19603
19604
19605
19606
19607
19608
19609
19610
19611
19612
19613
19614
19615
19616
19617
19618
19619
19620
19621
19622
19623
19624
19625
19626
19627
19628
19629
19630
19631
19632
19633
19634
19635
19636
19637
19638
19639
19640
19641
19642
19643
19644
19645
19646
19647
19648
19649
19650
19651
19652
19653
19654
19655
19656
19657
19658
19659
19660
19661
19662
19663
19664
19665
19666
19667
19668
19669
19670
19671
19672
19673
19674
19675
19676
19677
19678
19679
19680
19681
19682
19683
19684
19685
19686
19687
19688
19689
19690
19691
19692
19693
19694
19695
19696
19697
19698
19699
19700
19701
19702
19703
19704
19705
19706
19707
19708
19709
19710
19711
19712
19713
19714
19715
19716
19717
19718
19719
19720
19721
19722
19723
19724
19725
19726
19727
19728
19729
19730
19731
19732
19733
19734
19735
19736
19737
19738
19739
19740
19741
19742
19743
19744
19745
19746
19747
19748
19749
19750
19751
19752
19753
19754
19755
19756
19757
19758
19759
19760
19761
19762
19763
19764
19765
19766
19767
19768
19769
19770
19771
19772
19773
19774
19775
19776
19777
19778
19779
19780
19781
19782
19783
19784
19785
19786
19787
19788
19789
19790
19791
19792
19793
19794
19795
19796
19797
19798
19799
19800
19801
19802
19803
19804
19805
19806
19807
19808
19809
19810
19811
19812
19813
19814
19815
19816
19817
19818
19819
19820
19821
19822
19823
19824
19825
19826
19827
19828
19829
19830
19831
19832
19833
19834
19835
19836
19837
19838
19839
19840
19841
19842
19843
19844
19845
19846
19847
19848
19849
19850
19851
19852
19853
19854
19855
19856
19857
19858
19859
19860
19861
19862
19863
19864
19865
19866
19867
19868
19869
19870
19871
19872
19873
19874
19875
19876
19877
19878
19879
19880
19881
19882
19883
19884
19885
19886
19887
19888
19889
19890
19891
19892
19893
19894
19895
19896
19897
19898
19899
19900
19901
19902
19903
19904
19905
19906
19907
19908
19909
19910
19911
19912
19913
19914
19915
19916
19917
19918
19919
19920
19921
19922
19923
19924
19925
19926
19927
19928
19929
19930
19931
19932
19933
19934
19935
19936
19937
19938
19939
19940
19941
19942
19943
19944
19945
19946
19947
19948
19949
19950
19951
19952
19953
19954
19955
19956
19957
19958
19959
19960
19961
19962
19963
19964
19965
19966
19967
19968
19969
19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
19982
19983
19984
19985
19986
19987
19988
19989
19990
19991
19992
19993
19994
19995
19996
19997
19998
19999
20000
20001
20002
20003
20004
20005
20006
20007
20008
20009
20010
20011
20012
20013
20014
20015
20016
20017
20018
20019
20020
20021
20022
20023
20024
20025
20026
20027
20028
20029
20030
20031
20032
20033
20034
20035
20036
20037
20038
20039
20040
20041
20042
20043
20044
20045
20046
20047
20048
20049
20050
20051
20052
20053
20054
20055
20056
20057
20058
20059
20060
20061
20062
20063
20064
20065
20066
20067
20068
20069
20070
20071
20072
20073
20074
20075
20076
20077
20078
20079
20080
20081
20082
20083
20084
20085
20086
20087
20088
20089
20090
20091
20092
20093
20094
20095
20096
20097
20098
20099
20100
20101
20102
20103
20104
20105
20106
20107
20108
20109
20110
20111
20112
20113
20114
20115
20116
20117
20118
20119
20120
20121
20122
20123
20124
20125
20126
20127
20128
20129
20130
20131
20132
20133
20134
20135
20136
20137
20138
20139
20140
20141
20142
20143
20144
20145
20146
20147
20148
20149
20150
20151
20152
20153
20154
20155
20156
20157
20158
20159
20160
20161
20162
20163
20164
20165
20166
20167
20168
20169
20170
20171
20172
20173
20174
20175
20176
20177
20178
20179
20180
20181
20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
20213
20214
20215
20216
20217
20218
20219
20220
20221
20222
20223
20224
20225
20226
20227
20228
20229
20230
20231
20232
20233
20234
20235
20236
20237
20238
20239
20240
20241
20242
20243
20244
20245
20246
20247
20248
20249
20250
20251
20252
20253
20254
20255
20256
20257
20258
20259
20260
20261
20262
20263
20264
20265
20266
20267
20268
20269
20270
20271
20272
20273
20274
20275
20276
20277
20278
20279
20280
20281
20282
20283
20284
20285
20286
20287
20288
20289
20290
20291
20292
20293
20294
20295
20296
20297
20298
20299
20300
20301
20302
20303
20304
20305
20306
20307
20308
20309
20310
20311
20312
20313
20314
20315
20316
20317
20318
20319
20320
20321
20322
20323
20324
20325
20326
20327
20328
20329
20330
20331
20332
20333
20334
20335
20336
20337
20338
20339
20340
20341
20342
20343
20344
20345
20346
20347
20348
20349
20350
20351
20352
20353
20354
20355
20356
20357
20358
20359
20360
20361
20362
20363
20364
20365
20366
20367
20368
20369
20370
20371
20372
20373
20374
20375
20376
20377
20378
20379
20380
20381
20382
20383
20384
20385
20386
20387
20388
20389
20390
20391
20392
20393
20394
20395
20396
20397
20398
20399
20400
20401
20402
20403
20404
20405
20406
20407
20408
20409
20410
20411
20412
20413
20414
20415
20416
20417
20418
20419
20420
20421
20422
20423
20424
20425
20426
20427
20428
20429
20430
20431
20432
20433
20434
20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
20469
20470
20471
20472
20473
20474
20475
20476
20477
20478
20479
20480
20481
20482
20483
20484
20485
20486
20487
20488
20489
20490
20491
20492
20493
20494
20495
20496
20497
20498
20499
20500
20501
20502
20503
20504
20505
20506
20507
20508
20509
20510
20511
20512
20513
20514
20515
20516
20517
20518
20519
20520
20521
20522
20523
20524
20525
20526
20527
20528
20529
20530
20531
20532
20533
20534
20535
20536
20537
20538
20539
20540
20541
20542
20543
20544
20545
20546
20547
20548
20549
20550
20551
20552
20553
20554
20555
20556
20557
20558
20559
20560
20561
20562
20563
20564
20565
20566
20567
20568
20569
20570
20571
20572
20573
20574
20575
20576
20577
20578
20579
20580
20581
20582
20583
20584
20585
20586
20587
20588
20589
20590
20591
20592
20593
20594
20595
20596
20597
20598
20599
20600
20601
20602
20603
20604
20605
20606
20607
20608
20609
20610
20611
20612
20613
20614
20615
20616
20617
20618
20619
20620
20621
20622
20623
20624
20625
20626
20627
20628
20629
20630
20631
20632
20633
20634
20635
20636
20637
20638
20639
20640
20641
20642
20643
20644
20645
20646
20647
20648
20649
20650
20651
20652
20653
20654
20655
20656
20657
20658
20659
20660
20661
20662
20663
20664
20665
20666
20667
20668
20669
20670
20671
20672
20673
20674
20675
20676
20677
20678
20679
20680
20681
20682
20683
20684
20685
20686
20687
20688
20689
20690
20691
20692
20693
20694
20695
20696
20697
20698
20699
20700
20701
20702
20703
20704
20705
20706
20707
20708
20709
20710
20711
20712
20713
20714
20715
20716
20717
20718
20719
20720
20721
20722
20723
20724
20725
20726
20727
20728
20729
20730
20731
20732
20733
20734
20735
20736
20737
20738
20739
20740
20741
20742
20743
20744
20745
20746
20747
20748
20749
20750
20751
20752
20753
20754
20755
20756
20757
20758
20759
20760
20761
20762
20763
20764
20765
20766
20767
20768
20769
20770
20771
20772
20773
20774
20775
20776
20777
20778
20779
20780
20781
20782
20783
20784
20785
20786
20787
20788
20789
20790
20791
20792
20793
20794
20795
20796
20797
20798
20799
20800
20801
20802
20803
20804
20805
20806
20807
20808
20809
20810
20811
20812
20813
20814
20815
20816
20817
20818
20819
20820
20821
20822
20823
20824
20825
20826
20827
20828
20829
20830
20831
20832
20833
20834
20835
20836
20837
20838
20839
20840
20841
20842
20843
20844
20845
20846
20847
20848
20849
20850
20851
20852
20853
20854
20855
20856
20857
20858
20859
20860
20861
20862
20863
20864
20865
20866
20867
20868
20869
20870
20871
20872
20873
20874
20875
20876
20877
20878
20879
20880
20881
20882
20883
20884
20885
20886
20887
20888
20889
20890
20891
20892
20893
20894
20895
20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
20917
20918
20919
20920
20921
20922
20923
20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
21077
21078
21079
21080
21081
21082
21083
21084
21085
21086
21087
21088
21089
21090
21091
21092
21093
21094
21095
21096
21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
21115
21116
21117
21118
21119
21120
21121
21122
21123
21124
21125
21126
21127
21128
21129
21130
21131
21132
21133
21134
21135
21136
21137
21138
21139
21140
21141
21142
21143
21144
21145
21146
21147
21148
21149
21150
21151
21152
21153
21154
21155
21156
21157
21158
21159
21160
21161
21162
21163
21164
21165
21166
21167
21168
21169
21170
21171
21172
21173
21174
21175
21176
21177
21178
21179
21180
21181
21182
21183
21184
21185
21186
21187
21188
21189
21190
21191
21192
21193
21194
21195
21196
21197
21198
21199
21200
21201
21202
21203
21204
21205
21206
21207
21208
21209
21210
21211
21212
21213
21214
21215
21216
21217
21218
21219
21220
21221
21222
21223
21224
21225
21226
21227
21228
21229
21230
21231
21232
21233
21234
21235
21236
21237
21238
21239
21240
21241
21242
21243
21244
21245
21246
21247
21248
21249
21250
21251
21252
21253
21254
21255
21256
21257
21258
21259
21260
21261
21262
21263
21264
21265
21266
21267
21268
21269
21270
21271
21272
21273
21274
21275
21276
21277
21278
21279
21280
21281
21282
21283
21284
21285
21286
21287
21288
21289
21290
21291
21292
21293
21294
21295
21296
21297
21298
21299
21300
21301
21302
21303
21304
21305
21306
21307
21308
21309
21310
21311
21312
21313
21314
21315
21316
21317
21318
21319
21320
21321
21322
21323
21324
21325
21326
21327
21328
21329
21330
21331
21332
21333
21334
21335
21336
21337
21338
21339
21340
21341
21342
21343
21344
21345
21346
21347
21348
21349
21350
21351
21352
21353
21354
21355
21356
21357
21358
21359
21360
21361
21362
21363
21364
21365
21366
21367
21368
21369
21370
21371
21372
21373
21374
21375
21376
21377
21378
21379
21380
21381
21382
21383
21384
21385
21386
21387
21388
21389
21390
21391
21392
21393
21394
21395
21396
21397
21398
21399
21400
21401
21402
21403
21404
21405
21406
21407
21408
21409
21410
21411
21412
21413
21414
21415
21416
21417
21418
21419
21420
21421
21422
21423
21424
21425
21426
21427
21428
21429
21430
21431
21432
21433
21434
21435
21436
21437
21438
21439
21440
21441
21442
21443
21444
21445
21446
21447
21448
21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
21476
21477
21478
21479
21480
21481
21482
21483
21484
21485
21486
21487
21488
21489
21490
21491
21492
21493
21494
21495
21496
21497
21498
21499
21500
21501
21502
21503
21504
21505
21506
21507
21508
21509
21510
21511
21512
21513
21514
21515
21516
21517
21518
21519
21520
21521
21522
21523
21524
21525
21526
21527
21528
21529
21530
21531
21532
21533
21534
21535
21536
21537
21538
21539
21540
21541
21542
21543
21544
21545
21546
21547
21548
21549
21550
21551
21552
21553
21554
21555
21556
21557
21558
21559
21560
21561
21562
21563
21564
21565
21566
21567
21568
21569
21570
21571
21572
21573
21574
21575
21576
21577
21578
21579
21580
21581
21582
21583
21584
21585
21586
21587
21588
21589
21590
21591
21592
21593
21594
21595
21596
21597
21598
21599
21600
21601
21602
21603
21604
21605
21606
21607
21608
21609
21610
21611
21612
21613
21614
21615
21616
21617
21618
21619
21620
21621
21622
21623
21624
21625
21626
21627
21628
21629
21630
21631
21632
21633
21634
21635
21636
21637
21638
21639
21640
21641
21642
21643
21644
21645
21646
21647
21648
21649
21650
21651
21652
21653
21654
21655
21656
21657
21658
21659
21660
21661
21662
21663
21664
21665
21666
21667
21668
21669
21670
21671
21672
21673
21674
21675
21676
21677
21678
21679
21680
21681
21682
21683
21684
21685
21686
21687
21688
21689
21690
21691
21692
21693
21694
21695
21696
21697
21698
21699
21700
21701
21702
21703
21704
21705
21706
21707
21708
21709
21710
21711
21712
21713
21714
21715
21716
21717
21718
21719
21720
21721
21722
21723
21724
21725
21726
21727
21728
21729
21730
21731
21732
21733
21734
21735
21736
21737
21738
21739
21740
21741
21742
21743
21744
21745
21746
21747
21748
21749
21750
21751
21752
21753
21754
21755
21756
21757
21758
21759
21760
21761
21762
21763
21764
21765
21766
21767
21768
21769
21770
21771
21772
21773
21774
21775
21776
21777
21778
21779
21780
21781
21782
21783
21784
21785
21786
21787
21788
21789
21790
21791
21792
21793
21794
21795
21796
21797
21798
21799
21800
21801
21802
21803
21804
21805
21806
21807
21808
21809
21810
21811
21812
21813
21814
21815
21816
21817
21818
21819
21820
21821
21822
21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
21872
21873
21874
21875
21876
21877
21878
21879
21880
21881
21882
21883
21884
21885
21886
21887
21888
21889
21890
21891
21892
21893
21894
21895
21896
21897
21898
21899
21900
21901
21902
21903
21904
21905
21906
21907
21908
21909
21910
21911
21912
21913
21914
21915
21916
21917
21918
21919
21920
21921
21922
21923
21924
21925
21926
21927
21928
21929
21930
21931
21932
21933
21934
21935
21936
21937
21938
21939
21940
21941
21942
21943
21944
21945
21946
21947
21948
21949
21950
21951
21952
21953
21954
21955
21956
21957
21958
21959
21960
21961
21962
21963
21964
21965
21966
21967
21968
21969
21970
21971
21972
21973
21974
21975
21976
21977
21978
21979
21980
21981
21982
21983
21984
21985
21986
21987
21988
21989
21990
21991
21992
21993
21994
21995
21996
21997
21998
21999
22000
22001
22002
22003
22004
22005
22006
22007
22008
22009
22010
22011
22012
22013
22014
22015
22016
22017
22018
22019
22020
22021
22022
22023
22024
22025
22026
22027
22028
22029
22030
22031
22032
22033
22034
22035
22036
22037
22038
22039
22040
22041
22042
22043
22044
22045
22046
22047
22048
22049
22050
22051
22052
22053
22054
22055
22056
22057
22058
22059
22060
22061
22062
22063
22064
22065
22066
22067
22068
22069
22070
22071
22072
22073
22074
22075
22076
22077
22078
22079
22080
22081
22082
22083
22084
22085
22086
22087
22088
22089
22090
22091
22092
22093
22094
22095
22096
22097
22098
22099
22100
22101
22102
22103
22104
22105
22106
22107
22108
22109
22110
22111
22112
22113
22114
22115
22116
22117
22118
22119
22120
22121
22122
22123
22124
22125
22126
22127
22128
22129
22130
22131
22132
22133
22134
22135
22136
22137
22138
22139
22140
22141
22142
22143
22144
22145
22146
22147
22148
22149
22150
22151
22152
22153
22154
22155
22156
22157
22158
22159
22160
22161
22162
22163
22164
22165
22166
22167
22168
22169
22170
22171
22172
22173
22174
22175
22176
22177
22178
22179
22180
22181
22182
22183
22184
22185
22186
22187
22188
22189
22190
22191
22192
22193
22194
22195
22196
22197
22198
22199
22200
22201
22202
22203
22204
22205
22206
22207
22208
22209
22210
22211
22212
22213
22214
22215
22216
22217
22218
22219
22220
22221
22222
22223
22224
22225
22226
22227
22228
22229
22230
22231
22232
22233
22234
22235
22236
22237
22238
22239
22240
22241
22242
22243
22244
22245
22246
22247
22248
22249
22250
22251
22252
22253
22254
22255
22256
22257
22258
22259
22260
22261
22262
22263
22264
22265
22266
22267
22268
22269
22270
22271
22272
22273
22274
22275
22276
22277
22278
22279
22280
22281
22282
22283
22284
22285
22286
22287
22288
22289
22290
22291
22292
22293
22294
22295
22296
22297
22298
22299
22300
22301
22302
22303
22304
22305
22306
22307
22308
22309
22310
22311
22312
22313
22314
22315
22316
22317
22318
22319
22320
22321
22322
22323
22324
22325
22326
22327
22328
22329
22330
22331
22332
22333
22334
22335
22336
22337
22338
22339
22340
22341
22342
22343
22344
22345
22346
22347
22348
22349
22350
22351
22352
22353
22354
22355
22356
22357
22358
22359
22360
22361
22362
22363
22364
22365
22366
22367
22368
22369
22370
22371
22372
22373
22374
22375
22376
22377
22378
22379
22380
22381
22382
22383
22384
22385
22386
22387
22388
22389
22390
22391
22392
22393
22394
22395
22396
22397
22398
22399
22400
22401
22402
22403
22404
22405
22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
22447
22448
22449
22450
22451
22452
22453
22454
22455
22456
22457
22458
22459
22460
22461
22462
22463
22464
22465
22466
22467
22468
22469
22470
22471
22472
22473
22474
22475
22476
22477
22478
22479
22480
22481
22482
22483
22484
22485
22486
22487
22488
22489
22490
22491
22492
22493
22494
22495
22496
22497
22498
22499
22500
22501
22502
22503
22504
22505
22506
22507
22508
22509
22510
22511
22512
22513
22514
22515
22516
22517
22518
22519
22520
22521
22522
22523
22524
22525
22526
22527
22528
22529
22530
22531
22532
22533
22534
22535
22536
22537
22538
22539
22540
22541
22542
22543
22544
22545
22546
22547
22548
22549
22550
22551
22552
22553
22554
22555
22556
22557
22558
22559
22560
22561
22562
22563
22564
22565
22566
22567
22568
22569
22570
22571
22572
22573
22574
22575
22576
22577
22578
22579
22580
22581
22582
22583
22584
22585
22586
22587
22588
22589
22590
22591
22592
22593
22594
22595
22596
22597
22598
22599
22600
22601
22602
22603
22604
22605
22606
22607
22608
22609
22610
22611
22612
22613
22614
22615
22616
22617
22618
22619
22620
22621
22622
22623
22624
22625
22626
22627
22628
22629
22630
22631
22632
22633
22634
22635
22636
22637
22638
22639
22640
22641
22642
22643
22644
22645
22646
22647
22648
22649
22650
22651
22652
22653
22654
22655
22656
22657
22658
22659
22660
22661
22662
22663
22664
22665
22666
22667
22668
22669
22670
22671
22672
22673
22674
22675
22676
22677
22678
22679
22680
22681
22682
22683
22684
22685
22686
22687
22688
22689
22690
22691
22692
22693
22694
22695
22696
22697
22698
22699
22700
22701
22702
22703
22704
22705
22706
22707
22708
22709
22710
22711
22712
22713
22714
22715
22716
22717
22718
22719
22720
22721
22722
22723
22724
22725
22726
22727
22728
22729
22730
22731
22732
22733
22734
22735
22736
22737
22738
22739
22740
22741
22742
22743
22744
22745
22746
22747
22748
22749
22750
22751
22752
22753
22754
22755
22756
22757
22758
22759
22760
22761
22762
22763
22764
22765
22766
22767
22768
22769
22770
22771
22772
22773
22774
22775
22776
22777
22778
22779
22780
22781
22782
22783
22784
22785
22786
22787
22788
22789
22790
22791
22792
22793
22794
22795
22796
22797
22798
22799
22800
22801
22802
22803
22804
22805
22806
22807
22808
22809
22810
22811
22812
22813
22814
22815
22816
22817
22818
22819
22820
22821
22822
22823
22824
22825
22826
22827
22828
22829
22830
22831
22832
22833
22834
22835
22836
22837
22838
22839
22840
22841
22842
22843
22844
22845
22846
22847
22848
22849
22850
22851
22852
22853
22854
22855
22856
22857
22858
22859
22860
22861
22862
22863
22864
22865
22866
22867
22868
22869
22870
22871
22872
22873
22874
22875
22876
22877
22878
22879
22880
22881
22882
22883
22884
22885
22886
22887
22888
22889
22890
22891
22892
22893
22894
22895
22896
22897
22898
22899
22900
22901
22902
22903
22904
22905
22906
22907
22908
22909
22910
22911
22912
22913
22914
22915
22916
22917
22918
22919
22920
22921
22922
22923
22924
22925
22926
22927
22928
22929
22930
22931
22932
22933
22934
22935
22936
22937
22938
22939
22940
22941
22942
22943
22944
22945
22946
22947
22948
22949
22950
22951
22952
22953
22954
22955
22956
22957
22958
22959
22960
22961
22962
22963
22964
22965
22966
22967
22968
22969
22970
22971
22972
22973
22974
22975
22976
22977
22978
22979
22980
22981
22982
22983
22984
22985
22986
22987
22988
22989
22990
22991
22992
22993
22994
22995
22996
22997
22998
22999
23000
23001
23002
23003
23004
23005
23006
23007
23008
23009
23010
23011
23012
23013
23014
23015
23016
23017
23018
23019
23020
23021
23022
23023
23024
23025
23026
23027
23028
23029
23030
23031
23032
23033
23034
23035
23036
23037
23038
23039
23040
23041
23042
23043
23044
23045
23046
23047
23048
23049
23050
23051
23052
23053
23054
23055
23056
23057
23058
23059
23060
23061
23062
23063
23064
23065
23066
23067
23068
23069
23070
23071
23072
23073
23074
23075
23076
23077
23078
23079
23080
23081
23082
23083
23084
23085
23086
23087
23088
23089
23090
23091
23092
23093
23094
23095
23096
23097
23098
23099
23100
23101
23102
23103
23104
23105
23106
23107
23108
23109
23110
23111
23112
23113
23114
23115
23116
23117
23118
23119
23120
23121
23122
23123
23124
23125
23126
23127
23128
23129
23130
23131
23132
23133
23134
23135
23136
23137
23138
23139
23140
23141
23142
23143
23144
23145
23146
23147
23148
23149
23150
23151
23152
23153
23154
23155
23156
23157
23158
23159
23160
23161
23162
23163
23164
23165
23166
23167
23168
23169
23170
23171
23172
23173
23174
23175
23176
23177
23178
23179
23180
23181
23182
23183
23184
23185
23186
23187
23188
23189
23190
23191
23192
23193
23194
23195
23196
23197
23198
23199
23200
23201
23202
23203
23204
23205
23206
23207
23208
23209
23210
23211
23212
23213
23214
23215
23216
23217
23218
23219
23220
23221
23222
23223
23224
23225
23226
23227
23228
23229
23230
23231
23232
23233
23234
23235
23236
23237
23238
23239
23240
23241
23242
23243
23244
23245
23246
23247
23248
23249
23250
23251
23252
23253
23254
23255
23256
23257
23258
23259
23260
23261
23262
23263
23264
23265
23266
23267
23268
23269
23270
23271
23272
23273
23274
23275
23276
23277
23278
23279
23280
23281
23282
23283
23284
23285
23286
23287
23288
23289
23290
23291
23292
23293
23294
23295
23296
23297
23298
23299
23300
23301
23302
23303
23304
23305
23306
23307
23308
23309
23310
23311
23312
23313
23314
23315
23316
23317
23318
23319
23320
23321
23322
23323
23324
23325
23326
23327
23328
23329
23330
23331
23332
23333
23334
23335
23336
23337
23338
23339
23340
23341
23342
23343
23344
23345
23346
23347
23348
23349
23350
23351
23352
23353
23354
23355
23356
23357
23358
23359
23360
23361
23362
23363
23364
23365
23366
23367
23368
23369
23370
23371
23372
23373
23374
23375
23376
23377
23378
23379
23380
23381
23382
23383
23384
23385
23386
23387
23388
23389
23390
23391
23392
23393
23394
23395
23396
23397
23398
23399
23400
23401
23402
23403
23404
23405
23406
23407
23408
23409
23410
23411
23412
23413
23414
23415
23416
23417
23418
23419
23420
23421
23422
23423
23424
23425
23426
23427
23428
23429
23430
23431
23432
23433
23434
23435
23436
23437
23438
23439
23440
23441
23442
23443
23444
23445
23446
23447
23448
23449
23450
23451
23452
23453
23454
23455
23456
23457
23458
23459
23460
23461
23462
23463
23464
23465
23466
23467
23468
23469
23470
23471
23472
23473
23474
23475
23476
23477
23478
23479
23480
23481
23482
23483
23484
23485
23486
23487
23488
23489
23490
23491
23492
23493
23494
23495
23496
23497
23498
23499
23500
23501
23502
23503
23504
23505
23506
23507
23508
23509
23510
23511
23512
23513
23514
23515
23516
23517
23518
23519
23520
23521
23522
23523
23524
23525
23526
23527
23528
23529
23530
23531
23532
23533
23534
23535
23536
23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
23555
23556
23557
23558
23559
23560
23561
23562
23563
23564
23565
23566
23567
23568
23569
23570
23571
23572
23573
23574
23575
23576
23577
23578
23579
23580
23581
23582
23583
23584
23585
23586
23587
23588
23589
23590
23591
23592
23593
23594
23595
23596
23597
23598
23599
23600
23601
23602
23603
23604
23605
23606
23607
23608
23609
23610
23611
23612
23613
23614
23615
23616
23617
23618
23619
23620
23621
23622
23623
23624
23625
23626
23627
23628
23629
23630
23631
23632
23633
23634
23635
23636
23637
23638
23639
23640
23641
23642
23643
23644
23645
23646
23647
23648
23649
23650
23651
23652
23653
23654
23655
23656
23657
23658
23659
23660
23661
23662
23663
23664
23665
23666
23667
23668
23669
23670
23671
23672
23673
23674
23675
23676
23677
23678
23679
23680
23681
23682
23683
23684
23685
23686
23687
23688
23689
23690
23691
23692
23693
23694
23695
23696
23697
23698
23699
23700
23701
23702
23703
23704
23705
23706
23707
23708
23709
23710
23711
23712
23713
23714
23715
23716
23717
23718
23719
23720
23721
23722
23723
23724
23725
23726
23727
23728
23729
23730
23731
23732
23733
23734
23735
23736
23737
23738
23739
23740
23741
23742
23743
23744
23745
23746
23747
23748
23749
23750
23751
23752
23753
23754
23755
23756
23757
23758
23759
23760
23761
23762
23763
23764
23765
23766
23767
23768
23769
23770
23771
23772
23773
23774
23775
23776
23777
23778
23779
23780
23781
23782
23783
23784
23785
23786
23787
23788
23789
23790
23791
23792
23793
23794
23795
23796
23797
23798
23799
23800
23801
23802
23803
23804
23805
23806
23807
23808
23809
23810
23811
23812
23813
23814
23815
23816
23817
23818
23819
23820
23821
23822
23823
23824
23825
23826
23827
23828
23829
23830
23831
23832
23833
23834
23835
23836
23837
23838
23839
23840
23841
23842
23843
23844
23845
23846
23847
23848
23849
23850
23851
23852
23853
23854
23855
23856
23857
23858
23859
23860
23861
23862
23863
23864
23865
23866
23867
23868
23869
23870
23871
23872
23873
23874
23875
23876
23877
23878
23879
23880
23881
23882
23883
23884
23885
23886
23887
23888
23889
23890
23891
23892
23893
23894
23895
23896
23897
23898
23899
23900
23901
23902
23903
23904
23905
23906
23907
23908
23909
23910
23911
23912
23913
23914
23915
23916
23917
23918
23919
23920
23921
23922
23923
23924
23925
23926
23927
23928
23929
23930
23931
23932
23933
23934
23935
23936
23937
23938
23939
23940
23941
23942
23943
23944
23945
23946
23947
23948
23949
23950
23951
23952
23953
23954
23955
23956
23957
23958
23959
23960
23961
23962
23963
23964
23965
23966
23967
23968
23969
23970
23971
23972
23973
23974
23975
23976
23977
23978
23979
23980
23981
23982
23983
23984
23985
23986
23987
23988
23989
23990
23991
23992
23993
23994
23995
23996
23997
23998
23999
24000
24001
24002
24003
24004
24005
24006
24007
24008
24009
24010
24011
24012
24013
24014
24015
24016
24017
24018
24019
24020
24021
24022
24023
24024
24025
24026
24027
24028
24029
24030
24031
24032
24033
24034
24035
24036
24037
24038
24039
24040
24041
24042
24043
24044
24045
24046
24047
24048
24049
24050
24051
24052
24053
24054
24055
24056
24057
24058
24059
24060
24061
24062
24063
24064
24065
24066
24067
24068
24069
24070
24071
24072
24073
24074
24075
24076
24077
24078
24079
24080
24081
24082
24083
24084
24085
24086
24087
24088
24089
24090
24091
24092
24093
24094
24095
24096
24097
24098
24099
24100
24101
24102
24103
24104
24105
24106
24107
24108
24109
24110
24111
24112
24113
24114
24115
24116
24117
24118
24119
24120
24121
24122
24123
24124
24125
24126
24127
24128
24129
24130
24131
24132
24133
24134
24135
24136
24137
24138
24139
24140
24141
24142
24143
24144
24145
24146
24147
24148
24149
24150
24151
24152
24153
24154
24155
24156
24157
24158
24159
24160
24161
24162
24163
24164
24165
24166
24167
24168
24169
24170
24171
24172
24173
24174
24175
24176
24177
24178
24179
24180
24181
24182
24183
24184
24185
24186
24187
24188
24189
24190
24191
24192
24193
24194
24195
24196
24197
24198
24199
24200
24201
24202
24203
24204
24205
24206
24207
24208
24209
24210
24211
24212
24213
24214
24215
24216
24217
24218
24219
24220
24221
24222
24223
24224
24225
24226
24227
24228
24229
24230
24231
24232
24233
24234
24235
24236
24237
24238
24239
24240
24241
24242
24243
24244
24245
24246
24247
24248
24249
24250
24251
24252
24253
24254
24255
24256
24257
24258
24259
24260
24261
24262
24263
24264
24265
24266
24267
24268
24269
24270
24271
24272
24273
24274
24275
24276
24277
24278
24279
24280
24281
24282
24283
24284
24285
24286
24287
24288
24289
24290
24291
24292
24293
24294
24295
24296
24297
24298
24299
24300
24301
24302
24303
24304
24305
24306
24307
24308
24309
24310
24311
24312
24313
24314
24315
24316
24317
24318
24319
24320
24321
24322
24323
24324
24325
24326
24327
24328
24329
24330
24331
24332
24333
24334
24335
24336
24337
24338
24339
24340
24341
24342
24343
24344
24345
24346
24347
24348
24349
24350
24351
24352
24353
24354
24355
24356
24357
24358
24359
24360
24361
24362
24363
24364
24365
24366
24367
24368
24369
24370
24371
24372
24373
24374
24375
24376
24377
24378
24379
24380
24381
24382
24383
24384
24385
24386
24387
24388
24389
24390
24391
24392
24393
24394
24395
24396
24397
24398
24399
24400
24401
24402
24403
24404
24405
24406
24407
24408
24409
24410
24411
24412
24413
24414
24415
24416
24417
24418
24419
24420
24421
24422
24423
24424
24425
24426
24427
24428
24429
24430
24431
24432
24433
24434
24435
24436
24437
24438
24439
24440
24441
24442
24443
24444
24445
24446
24447
24448
24449
24450
24451
24452
24453
24454
24455
24456
24457
24458
24459
24460
24461
24462
24463
24464
24465
24466
24467
24468
24469
24470
24471
24472
24473
24474
24475
24476
24477
24478
24479
24480
24481
24482
24483
24484
24485
24486
24487
24488
24489
24490
24491
24492
24493
24494
24495
24496
24497
24498
24499
24500
24501
24502
24503
24504
24505
24506
24507
24508
24509
24510
24511
24512
24513
24514
24515
24516
24517
24518
24519
24520
24521
24522
24523
24524
24525
24526
24527
24528
24529
24530
24531
24532
24533
24534
24535
24536
24537
24538
24539
24540
24541
24542
24543
24544
24545
24546
24547
24548
24549
24550
24551
24552
24553
24554
24555
24556
24557
24558
24559
24560
24561
24562
24563
24564
24565
24566
24567
24568
24569
24570
24571
24572
24573
24574
24575
24576
24577
24578
24579
24580
24581
24582
24583
24584
24585
24586
24587
24588
24589
24590
24591
24592
24593
24594
24595
24596
24597
24598
24599
24600
24601
24602
24603
24604
24605
24606
24607
24608
24609
24610
24611
24612
24613
24614
24615
24616
24617
24618
24619
24620
24621
24622
24623
24624
24625
24626
24627
24628
24629
24630
24631
24632
24633
24634
24635
24636
24637
24638
24639
24640
24641
24642
24643
24644
24645
24646
24647
24648
24649
24650
24651
24652
24653
24654
24655
24656
24657
24658
24659
24660
24661
24662
24663
24664
24665
24666
24667
24668
24669
24670
24671
24672
24673
24674
24675
24676
24677
24678
24679
24680
24681
24682
24683
24684
24685
24686
24687
24688
24689
24690
24691
24692
24693
24694
24695
24696
24697
24698
24699
24700
24701
24702
24703
24704
24705
24706
24707
24708
24709
24710
24711
24712
24713
24714
24715
24716
24717
24718
24719
24720
24721
24722
24723
24724
24725
24726
24727
24728
24729
24730
24731
24732
24733
24734
24735
24736
24737
24738
24739
24740
24741
24742
24743
24744
24745
24746
24747
24748
24749
24750
24751
24752
24753
24754
24755
24756
24757
24758
24759
24760
24761
24762
24763
24764
24765
24766
24767
24768
24769
24770
24771
24772
24773
24774
24775
24776
24777
24778
24779
24780
24781
24782
24783
24784
24785
24786
24787
24788
24789
24790
24791
24792
24793
24794
24795
24796
24797
24798
24799
24800
24801
24802
24803
24804
24805
24806
24807
24808
24809
24810
24811
24812
24813
24814
24815
24816
24817
24818
24819
24820
24821
24822
24823
24824
24825
24826
24827
24828
24829
24830
24831
24832
24833
24834
24835
24836
24837
24838
24839
24840
24841
24842
24843
24844
24845
24846
24847
24848
24849
24850
24851
24852
24853
24854
24855
24856
24857
24858
24859
24860
24861
24862
24863
24864
24865
24866
24867
24868
24869
24870
24871
24872
24873
24874
24875
24876
24877
24878
24879
24880
24881
24882
24883
24884
24885
24886
24887
24888
24889
24890
24891
24892
24893
24894
24895
24896
24897
24898
24899
24900
24901
24902
24903
24904
24905
24906
24907
24908
24909
24910
24911
24912
24913
24914
24915
24916
24917
24918
24919
24920
24921
24922
24923
24924
24925
24926
24927
24928
24929
24930
24931
24932
24933
24934
24935
24936
24937
24938
24939
24940
24941
24942
24943
24944
24945
24946
24947
24948
24949
24950
24951
24952
24953
24954
24955
24956
24957
24958
24959
24960
24961
24962
24963
24964
24965
24966
24967
24968
24969
24970
24971
24972
24973
24974
24975
24976
24977
24978
24979
24980
24981
24982
24983
24984
24985
24986
24987
24988
24989
24990
24991
24992
24993
24994
24995
24996
24997
24998
24999
25000
25001
25002
25003
25004
25005
25006
25007
25008
25009
25010
25011
25012
25013
25014
25015
25016
25017
25018
25019
25020
25021
25022
25023
25024
25025
25026
25027
25028
25029
25030
25031
25032
25033
25034
25035
25036
25037
25038
25039
25040
25041
25042
25043
25044
25045
25046
25047
25048
25049
25050
25051
25052
25053
25054
25055
25056
25057
25058
25059
25060
25061
25062
25063
25064
25065
25066
25067
25068
25069
25070
25071
25072
25073
25074
25075
25076
25077
25078
25079
25080
25081
25082
25083
25084
25085
25086
25087
25088
25089
25090
25091
25092
25093
25094
25095
25096
25097
25098
25099
25100
25101
25102
25103
25104
25105
25106
25107
25108
25109
25110
25111
25112
25113
25114
25115
25116
25117
25118
25119
25120
25121
25122
25123
25124
25125
25126
25127
25128
25129
25130
25131
25132
25133
25134
25135
25136
25137
25138
25139
25140
25141
25142
25143
25144
25145
25146
25147
25148
25149
25150
25151
25152
25153
25154
25155
25156
25157
25158
25159
25160
25161
25162
25163
25164
25165
25166
25167
25168
25169
25170
25171
25172
25173
25174
25175
25176
25177
25178
25179
25180
25181
25182
25183
25184
25185
25186
25187
25188
25189
25190
25191
25192
25193
25194
25195
25196
25197
25198
25199
25200
25201
25202
25203
25204
25205
25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
25254
25255
25256
25257
25258
25259
25260
25261
25262
25263
25264
25265
25266
25267
25268
25269
25270
25271
25272
25273
25274
25275
25276
25277
25278
25279
25280
25281
25282
25283
25284
25285
25286
25287
25288
25289
25290
25291
25292
25293
25294
25295
25296
25297
25298
25299
25300
25301
25302
25303
25304
25305
25306
25307
25308
25309
25310
25311
25312
25313
25314
25315
25316
25317
25318
25319
25320
25321
25322
25323
25324
25325
25326
25327
25328
25329
25330
25331
25332
25333
25334
25335
25336
25337
25338
25339
25340
25341
25342
25343
25344
25345
25346
25347
25348
25349
25350
25351
25352
25353
25354
25355
25356
25357
25358
25359
25360
25361
25362
25363
25364
25365
25366
25367
25368
25369
25370
25371
25372
25373
25374
25375
25376
25377
25378
25379
25380
25381
25382
25383
25384
25385
25386
25387
25388
25389
25390
25391
25392
25393
25394
25395
25396
25397
25398
25399
25400
25401
25402
25403
25404
25405
25406
25407
25408
25409
25410
25411
25412
25413
25414
25415
25416
25417
25418
25419
25420
25421
25422
25423
25424
25425
25426
25427
25428
25429
25430
25431
25432
25433
25434
25435
25436
25437
25438
25439
25440
25441
25442
25443
25444
25445
25446
25447
25448
25449
25450
25451
25452
25453
25454
25455
25456
25457
25458
25459
25460
25461
25462
25463
25464
25465
25466
25467
25468
25469
25470
25471
25472
25473
25474
25475
25476
25477
25478
25479
25480
25481
25482
25483
25484
25485
25486
25487
25488
25489
25490
25491
25492
25493
25494
25495
25496
25497
25498
25499
25500
25501
25502
25503
25504
25505
25506
25507
25508
25509
25510
25511
25512
25513
25514
25515
25516
25517
25518
25519
25520
25521
25522
25523
25524
25525
25526
25527
25528
25529
25530
25531
25532
25533
25534
25535
25536
25537
25538
25539
25540
25541
25542
25543
25544
25545
25546
25547
25548
25549
25550
25551
25552
25553
25554
25555
25556
25557
25558
25559
25560
25561
25562
25563
25564
25565
25566
25567
25568
25569
25570
25571
25572
25573
25574
25575
25576
25577
25578
25579
25580
25581
25582
25583
25584
25585
25586
25587
25588
25589
25590
25591
25592
25593
25594
25595
25596
25597
25598
25599
25600
25601
25602
25603
25604
25605
25606
25607
25608
25609
25610
25611
25612
25613
25614
25615
25616
25617
25618
25619
25620
25621
25622
25623
25624
25625
25626
25627
25628
25629
25630
25631
25632
25633
25634
25635
25636
25637
25638
25639
25640
25641
25642
25643
25644
25645
25646
25647
25648
25649
25650
25651
25652
25653
25654
25655
25656
25657
25658
25659
25660
25661
25662
25663
25664
25665
25666
25667
25668
25669
25670
25671
25672
25673
25674
25675
25676
25677
25678
25679
25680
25681
25682
25683
25684
25685
25686
25687
25688
25689
25690
25691
25692
25693
25694
25695
25696
25697
25698
25699
25700
25701
25702
25703
25704
25705
25706
25707
25708
25709
25710
25711
25712
25713
25714
25715
25716
25717
25718
25719
25720
25721
25722
25723
25724
25725
25726
25727
25728
25729
25730
25731
25732
25733
25734
25735
25736
25737
25738
25739
25740
25741
25742
25743
25744
25745
25746
25747
25748
25749
25750
25751
25752
25753
25754
25755
25756
25757
25758
25759
25760
25761
25762
25763
25764
25765
25766
25767
25768
25769
25770
25771
25772
25773
25774
25775
25776
25777
25778
25779
25780
25781
25782
25783
25784
25785
25786
25787
25788
25789
25790
25791
25792
25793
25794
25795
25796
25797
25798
25799
25800
25801
25802
25803
25804
25805
25806
25807
25808
25809
25810
25811
25812
25813
25814
25815
25816
25817
25818
25819
25820
25821
25822
25823
25824
25825
25826
25827
25828
25829
25830
25831
25832
25833
25834
25835
25836
25837
25838
25839
25840
25841
25842
25843
25844
25845
25846
25847
25848
25849
25850
25851
25852
25853
25854
25855
25856
25857
25858
25859
25860
25861
25862
25863
25864
25865
25866
25867
25868
25869
25870
25871
25872
25873
25874
25875
25876
25877
25878
25879
25880
25881
25882
25883
25884
25885
25886
25887
25888
25889
25890
25891
25892
25893
25894
25895
25896
25897
25898
25899
25900
25901
25902
25903
25904
25905
25906
25907
25908
25909
25910
25911
25912
25913
25914
25915
25916
25917
25918
25919
25920
25921
25922
25923
25924
25925
25926
25927
25928
25929
25930
25931
25932
25933
25934
25935
25936
25937
25938
25939
25940
25941
25942
25943
25944
25945
25946
25947
25948
25949
25950
25951
25952
25953
25954
25955
25956
25957
25958
25959
25960
25961
25962
25963
25964
25965
25966
25967
25968
25969
25970
25971
25972
25973
25974
25975
25976
25977
25978
25979
25980
25981
25982
25983
25984
25985
25986
25987
25988
25989
25990
25991
25992
25993
25994
25995
25996
25997
25998
25999
26000
26001
26002
26003
26004
26005
26006
26007
26008
26009
26010
26011
26012
26013
26014
26015
26016
26017
26018
26019
26020
26021
26022
26023
26024
26025
26026
26027
26028
26029
26030
26031
26032
26033
26034
26035
26036
26037
26038
26039
26040
26041
26042
26043
26044
26045
26046
26047
26048
26049
26050
26051
26052
26053
26054
26055
26056
26057
26058
26059
26060
26061
26062
26063
26064
26065
26066
26067
26068
26069
26070
26071
26072
26073
26074
26075
26076
26077
26078
26079
26080
26081
26082
26083
26084
26085
26086
26087
26088
26089
26090
26091
26092
26093
26094
26095
26096
26097
26098
26099
26100
26101
26102
26103
26104
26105
26106
26107
26108
26109
26110
26111
26112
26113
26114
26115
26116
26117
26118
26119
26120
26121
26122
26123
26124
26125
26126
26127
26128
26129
26130
26131
26132
26133
26134
26135
26136
26137
26138
26139
26140
26141
26142
26143
26144
26145
26146
26147
26148
26149
26150
26151
26152
26153
26154
26155
26156
26157
26158
26159
26160
26161
26162
26163
26164
26165
26166
26167
26168
26169
26170
26171
26172
26173
26174
26175
26176
26177
26178
26179
26180
26181
26182
26183
26184
26185
26186
26187
26188
26189
26190
26191
26192
26193
26194
26195
26196
26197
26198
26199
26200
26201
26202
26203
26204
26205
26206
26207
26208
26209
26210
26211
26212
26213
26214
26215
26216
26217
26218
26219
26220
26221
26222
26223
26224
26225
26226
26227
26228
26229
26230
26231
26232
26233
26234
26235
26236
26237
26238
26239
26240
26241
26242
26243
26244
26245
26246
26247
26248
26249
26250
26251
26252
26253
26254
26255
26256
26257
26258
26259
26260
26261
26262
26263
26264
26265
26266
26267
26268
26269
26270
26271
26272
26273
26274
26275
26276
26277
26278
26279
26280
26281
26282
26283
26284
26285
26286
26287
26288
26289
26290
26291
26292
26293
26294
26295
26296
26297
26298
26299
26300
26301
26302
26303
26304
26305
26306
26307
26308
26309
26310
26311
26312
26313
26314
26315
26316
26317
26318
26319
26320
26321
26322
26323
26324
26325
26326
26327
26328
26329
26330
26331
26332
26333
26334
26335
26336
26337
26338
26339
26340
26341
26342
26343
26344
26345
26346
26347
26348
26349
26350
26351
26352
26353
26354
26355
26356
26357
26358
26359
26360
26361
26362
26363
26364
26365
26366
26367
26368
26369
26370
26371
26372
26373
26374
26375
26376
26377
26378
26379
26380
26381
26382
26383
26384
26385
26386
26387
26388
26389
26390
26391
26392
26393
26394
26395
26396
26397
26398
26399
26400
26401
26402
26403
26404
26405
26406
26407
26408
26409
26410
26411
26412
26413
26414
26415
26416
26417
26418
26419
26420
26421
26422
26423
26424
26425
26426
26427
26428
26429
26430
26431
26432
26433
26434
26435
26436
26437
26438
26439
26440
26441
26442
26443
26444
26445
26446
26447
26448
26449
26450
26451
26452
26453
26454
26455
26456
26457
26458
26459
26460
26461
26462
26463
26464
26465
26466
26467
26468
26469
26470
26471
26472
26473
26474
26475
26476
26477
26478
26479
26480
26481
26482
26483
26484
26485
26486
26487
26488
26489
26490
26491
26492
26493
26494
26495
26496
26497
26498
26499
26500
26501
26502
26503
26504
26505
26506
26507
26508
26509
26510
26511
26512
26513
26514
26515
26516
26517
26518
26519
26520
26521
26522
26523
26524
26525
26526
26527
26528
26529
26530
26531
26532
26533
26534
26535
26536
26537
26538
26539
26540
26541
26542
26543
26544
26545
26546
26547
26548
26549
26550
26551
26552
26553
26554
26555
26556
26557
26558
26559
26560
26561
26562
26563
26564
26565
26566
26567
26568
26569
26570
26571
26572
26573
26574
26575
26576
26577
26578
26579
26580
26581
26582
26583
26584
26585
26586
26587
26588
26589
26590
26591
26592
26593
26594
26595
26596
26597
26598
26599
26600
26601
26602
26603
26604
26605
26606
26607
26608
26609
26610
26611
26612
26613
26614
26615
26616
26617
26618
26619
26620
26621
26622
26623
26624
26625
26626
26627
26628
26629
26630
26631
26632
26633
26634
26635
26636
26637
26638
26639
26640
26641
26642
26643
26644
26645
26646
26647
26648
26649
26650
26651
26652
26653
26654
26655
26656
26657
26658
26659
26660
26661
26662
26663
26664
26665
26666
26667
26668
26669
26670
26671
26672
26673
26674
26675
26676
26677
26678
26679
26680
26681
26682
26683
26684
26685
26686
26687
26688
26689
26690
26691
26692
26693
26694
26695
26696
26697
26698
26699
26700
26701
26702
26703
26704
26705
26706
26707
26708
26709
26710
26711
26712
26713
26714
26715
26716
26717
26718
26719
26720
26721
26722
26723
26724
26725
26726
26727
26728
26729
26730
26731
26732
26733
26734
26735
26736
26737
26738
26739
26740
26741
26742
26743
26744
26745
26746
26747
26748
26749
26750
26751
26752
26753
26754
26755
26756
26757
26758
26759
26760
26761
26762
26763
26764
26765
26766
26767
26768
26769
26770
26771
26772
26773
26774
26775
26776
26777
26778
26779
26780
26781
26782
26783
26784
26785
26786
26787
26788
26789
26790
26791
26792
26793
26794
26795
26796
26797
26798
26799
26800
26801
26802
26803
26804
26805
26806
26807
26808
26809
26810
26811
26812
26813
26814
26815
26816
26817
26818
26819
26820
26821
26822
26823
26824
26825
26826
26827
26828
26829
26830
26831
26832
26833
26834
26835
26836
26837
26838
26839
26840
26841
26842
26843
26844
26845
26846
26847
26848
26849
26850
26851
26852
26853
26854
26855
26856
26857
26858
26859
26860
26861
26862
26863
26864
26865
26866
26867
26868
26869
26870
26871
26872
26873
26874
26875
26876
26877
26878
26879
26880
26881
26882
26883
26884
26885
26886
26887
26888
26889
26890
26891
26892
26893
26894
26895
26896
26897
26898
26899
26900
26901
26902
26903
26904
26905
26906
26907
26908
26909
26910
26911
26912
26913
26914
26915
26916
26917
26918
26919
26920
26921
26922
26923
26924
26925
26926
26927
26928
26929
26930
26931
26932
26933
26934
26935
26936
26937
26938
26939
26940
26941
26942
26943
26944
26945
26946
26947
26948
26949
26950
26951
26952
26953
26954
26955
26956
26957
26958
26959
26960
26961
26962
26963
26964
26965
26966
26967
26968
26969
26970
26971
26972
26973
26974
26975
26976
26977
26978
26979
26980
26981
26982
26983
26984
26985
26986
26987
26988
26989
26990
26991
26992
26993
26994
26995
26996
26997
26998
26999
27000
27001
27002
27003
27004
27005
27006
27007
27008
27009
27010
27011
27012
27013
27014
27015
27016
27017
27018
27019
27020
27021
27022
27023
27024
27025
27026
27027
27028
27029
27030
27031
27032
27033
27034
27035
27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
27072
27073
27074
27075
27076
27077
27078
27079
27080
27081
27082
27083
27084
27085
27086
27087
27088
27089
27090
27091
27092
27093
27094
27095
27096
27097
27098
27099
27100
27101
27102
27103
27104
27105
27106
27107
27108
27109
27110
27111
27112
27113
27114
27115
27116
27117
27118
27119
27120
27121
27122
27123
27124
27125
27126
27127
27128
27129
27130
27131
27132
27133
27134
27135
27136
27137
27138
27139
27140
27141
27142
27143
27144
27145
27146
27147
27148
27149
27150
27151
27152
27153
27154
27155
27156
27157
27158
27159
27160
27161
27162
27163
27164
27165
27166
27167
27168
27169
27170
27171
27172
27173
27174
27175
27176
27177
27178
27179
27180
27181
27182
27183
27184
27185
27186
27187
27188
27189
27190
27191
27192
27193
27194
27195
27196
27197
27198
27199
27200
27201
27202
27203
27204
27205
27206
27207
27208
27209
27210
27211
27212
27213
27214
27215
27216
27217
27218
27219
27220
27221
27222
27223
27224
27225
27226
27227
27228
27229
27230
27231
27232
27233
27234
27235
27236
27237
27238
27239
27240
27241
27242
27243
27244
27245
27246
27247
27248
27249
27250
27251
27252
27253
27254
27255
27256
27257
27258
27259
27260
27261
27262
27263
27264
27265
27266
27267
27268
27269
27270
27271
27272
27273
27274
27275
27276
27277
27278
27279
27280
27281
27282
27283
27284
27285
27286
27287
27288
27289
27290
27291
27292
27293
27294
27295
27296
27297
27298
27299
27300
27301
27302
27303
27304
27305
27306
27307
27308
27309
27310
27311
27312
27313
27314
27315
27316
27317
27318
27319
27320
27321
27322
27323
27324
27325
27326
27327
27328
27329
27330
27331
27332
27333
27334
27335
27336
27337
27338
27339
27340
27341
27342
27343
27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
27382
27383
27384
27385
27386
27387
27388
27389
27390
27391
27392
27393
27394
27395
27396
27397
27398
27399
27400
27401
27402
27403
27404
27405
27406
27407
27408
27409
27410
27411
27412
27413
27414
27415
27416
27417
27418
27419
27420
27421
27422
27423
27424
27425
27426
27427
27428
27429
27430
27431
27432
27433
27434
27435
27436
27437
27438
27439
27440
27441
27442
27443
27444
27445
27446
27447
27448
27449
27450
27451
27452
27453
27454
27455
27456
27457
27458
27459
27460
27461
27462
27463
27464
27465
27466
27467
27468
27469
27470
27471
27472
27473
27474
27475
27476
27477
27478
27479
27480
27481
27482
27483
27484
27485
27486
27487
27488
27489
27490
27491
27492
27493
27494
27495
27496
27497
27498
27499
27500
27501
27502
27503
27504
27505
27506
27507
27508
27509
27510
27511
27512
27513
27514
27515
27516
27517
27518
27519
27520
27521
27522
27523
27524
27525
27526
27527
27528
27529
27530
27531
27532
27533
27534
27535
27536
27537
27538
27539
27540
27541
27542
27543
27544
27545
27546
27547
27548
27549
27550
27551
27552
27553
27554
27555
27556
27557
27558
27559
27560
27561
27562
27563
27564
27565
27566
27567
27568
27569
27570
27571
27572
27573
27574
27575
27576
27577
27578
27579
27580
27581
27582
27583
27584
27585
27586
27587
27588
27589
27590
27591
27592
27593
27594
27595
27596
27597
27598
27599
27600
27601
27602
27603
27604
27605
27606
27607
27608
27609
27610
27611
27612
27613
27614
27615
27616
27617
27618
27619
27620
27621
27622
27623
27624
27625
27626
27627
27628
27629
27630
27631
27632
27633
27634
27635
27636
27637
27638
27639
27640
27641
27642
27643
27644
27645
27646
27647
27648
27649
27650
27651
27652
27653
27654
27655
27656
27657
27658
27659
27660
27661
27662
27663
27664
27665
27666
27667
27668
27669
27670
27671
27672
27673
27674
27675
27676
27677
27678
27679
27680
27681
27682
27683
27684
27685
27686
27687
27688
27689
27690
27691
27692
27693
27694
27695
27696
27697
27698
27699
27700
27701
27702
27703
27704
27705
27706
27707
27708
27709
27710
27711
27712
27713
27714
27715
27716
27717
27718
27719
27720
27721
27722
27723
27724
27725
27726
27727
27728
27729
27730
27731
27732
27733
27734
27735
27736
27737
27738
27739
27740
27741
27742
27743
27744
27745
27746
27747
27748
27749
27750
27751
27752
27753
27754
27755
27756
27757
27758
27759
27760
27761
27762
27763
27764
27765
27766
27767
27768
27769
27770
27771
27772
27773
27774
27775
27776
27777
27778
27779
27780
27781
27782
27783
27784
27785
27786
27787
27788
27789
27790
27791
27792
27793
27794
27795
27796
27797
27798
27799
27800
27801
27802
27803
27804
27805
27806
27807
27808
27809
27810
27811
27812
27813
27814
27815
27816
27817
27818
27819
27820
27821
27822
27823
27824
27825
27826
27827
27828
27829
27830
27831
27832
27833
27834
27835
27836
27837
27838
27839
27840
27841
27842
27843
27844
27845
27846
27847
27848
27849
27850
27851
27852
27853
27854
27855
27856
27857
27858
27859
27860
27861
27862
27863
27864
27865
27866
27867
27868
27869
27870
27871
27872
27873
27874
27875
27876
27877
27878
27879
27880
27881
27882
27883
27884
27885
27886
27887
27888
27889
27890
27891
27892
27893
27894
27895
27896
27897
27898
27899
27900
27901
27902
27903
27904
27905
27906
27907
27908
27909
27910
27911
27912
27913
27914
27915
27916
27917
27918
27919
27920
27921
27922
27923
27924
27925
27926
27927
27928
27929
27930
27931
27932
27933
27934
27935
27936
27937
27938
27939
27940
27941
27942
27943
27944
27945
27946
27947
27948
27949
27950
27951
27952
27953
27954
27955
27956
27957
27958
27959
27960
27961
27962
27963
27964
27965
27966
27967
27968
27969
27970
27971
27972
27973
27974
27975
27976
27977
27978
27979
27980
27981
27982
27983
27984
27985
27986
27987
27988
27989
27990
27991
27992
27993
27994
27995
27996
27997
27998
27999
28000
28001
28002
28003
28004
28005
28006
28007
28008
28009
28010
28011
28012
28013
28014
28015
28016
28017
28018
28019
28020
28021
28022
28023
28024
28025
28026
28027
28028
28029
28030
28031
28032
28033
28034
28035
28036
28037
28038
28039
28040
28041
28042
28043
28044
28045
28046
28047
28048
28049
28050
28051
28052
28053
28054
28055
28056
28057
28058
28059
28060
28061
28062
28063
28064
28065
28066
28067
28068
28069
28070
28071
28072
28073
28074
28075
28076
28077
28078
28079
28080
28081
28082
28083
28084
28085
28086
28087
28088
28089
28090
28091
28092
28093
28094
28095
28096
28097
28098
28099
28100
28101
28102
28103
28104
28105
28106
28107
28108
28109
28110
28111
28112
28113
28114
28115
28116
28117
28118
28119
28120
28121
28122
28123
28124
28125
28126
28127
28128
28129
28130
28131
28132
28133
28134
28135
28136
28137
28138
28139
28140
28141
28142
28143
28144
28145
28146
28147
28148
28149
28150
28151
28152
28153
28154
28155
28156
28157
28158
28159
28160
28161
28162
28163
28164
28165
28166
28167
28168
28169
28170
28171
28172
28173
28174
28175
28176
28177
28178
28179
28180
28181
28182
28183
28184
28185
28186
28187
28188
28189
28190
28191
28192
28193
28194
28195
28196
28197
28198
28199
28200
28201
28202
28203
28204
28205
28206
28207
28208
28209
28210
28211
28212
28213
28214
28215
28216
28217
28218
28219
28220
28221
28222
28223
28224
28225
28226
28227
28228
28229
28230
28231
28232
28233
28234
28235
28236
28237
28238
28239
28240
28241
28242
28243
28244
28245
28246
28247
28248
28249
28250
28251
28252
28253
28254
28255
28256
28257
28258
28259
28260
28261
28262
28263
28264
28265
28266
28267
28268
28269
28270
28271
28272
28273
28274
28275
28276
28277
28278
28279
28280
28281
28282
28283
28284
28285
28286
28287
28288
28289
28290
28291
28292
28293
28294
28295
28296
28297
28298
28299
28300
28301
28302
28303
28304
28305
28306
28307
28308
28309
28310
28311
28312
28313
28314
28315
28316
28317
28318
28319
28320
28321
28322
28323
28324
28325
28326
28327
28328
28329
28330
28331
28332
28333
28334
28335
28336
28337
28338
28339
28340
28341
28342
28343
28344
28345
28346
28347
28348
28349
28350
28351
28352
28353
28354
28355
28356
28357
28358
28359
28360
28361
28362
28363
28364
28365
28366
28367
28368
28369
28370
28371
28372
28373
28374
28375
28376
28377
28378
28379
28380
28381
28382
28383
28384
28385
28386
28387
28388
28389
28390
28391
28392
28393
28394
28395
28396
28397
28398
28399
28400
28401
28402
28403
28404
28405
28406
28407
28408
28409
28410
28411
28412
28413
28414
28415
28416
28417
28418
28419
28420
28421
28422
28423
28424
28425
28426
28427
28428
28429
28430
28431
28432
28433
28434
28435
28436
28437
28438
28439
28440
28441
28442
28443
28444
28445
28446
28447
28448
28449
28450
28451
28452
28453
28454
28455
28456
28457
28458
28459
28460
28461
28462
28463
28464
28465
28466
28467
28468
28469
28470
28471
28472
28473
28474
28475
28476
28477
28478
28479
28480
28481
28482
28483
28484
28485
28486
28487
28488
28489
28490
28491
28492
28493
28494
28495
28496
28497
28498
28499
28500
28501
28502
28503
28504
28505
28506
28507
28508
28509
28510
28511
28512
28513
28514
28515
28516
28517
28518
28519
28520
28521
28522
28523
28524
28525
28526
28527
28528
28529
28530
28531
28532
28533
28534
28535
28536
28537
28538
28539
28540
28541
28542
28543
28544
28545
28546
28547
28548
28549
28550
28551
28552
28553
28554
28555
28556
28557
28558
28559
28560
28561
28562
28563
28564
28565
28566
28567
28568
28569
28570
28571
28572
28573
28574
28575
28576
28577
28578
28579
28580
28581
28582
28583
28584
28585
28586
28587
28588
28589
28590
28591
28592
28593
28594
28595
28596
28597
28598
28599
28600
28601
28602
28603
28604
28605
28606
28607
28608
28609
28610
28611
28612
28613
28614
28615
28616
28617
28618
28619
28620
28621
28622
28623
28624
28625
28626
28627
28628
28629
28630
28631
28632
28633
28634
28635
28636
28637
28638
28639
28640
28641
28642
28643
28644
28645
28646
28647
28648
28649
28650
28651
28652
28653
28654
28655
28656
28657
28658
28659
28660
28661
28662
28663
28664
28665
28666
28667
28668
28669
28670
28671
28672
28673
28674
28675
28676
28677
28678
28679
28680
28681
28682
28683
28684
28685
28686
28687
28688
28689
28690
28691
28692
28693
28694
28695
28696
28697
28698
28699
28700
28701
28702
28703
28704
28705
28706
28707
28708
28709
28710
28711
28712
28713
28714
28715
28716
28717
28718
28719
28720
28721
28722
28723
28724
28725
28726
28727
28728
28729
28730
28731
28732
28733
28734
28735
28736
28737
28738
28739
28740
28741
28742
28743
28744
28745
28746
28747
28748
28749
28750
28751
28752
28753
28754
28755
28756
28757
28758
28759
28760
28761
28762
28763
28764
28765
28766
28767
28768
28769
28770
28771
28772
28773
28774
28775
28776
28777
28778
28779
28780
28781
28782
28783
28784
28785
28786
28787
28788
28789
28790
28791
28792
28793
28794
28795
28796
28797
28798
28799
28800
28801
28802
28803
28804
28805
28806
28807
28808
28809
28810
28811
28812
28813
28814
28815
28816
28817
28818
28819
28820
28821
28822
28823
28824
28825
28826
28827
28828
28829
28830
28831
28832
28833
28834
28835
28836
28837
28838
28839
28840
28841
28842
28843
28844
28845
28846
28847
28848
28849
28850
28851
28852
28853
28854
28855
28856
28857
28858
28859
28860
28861
28862
28863
28864
28865
28866
28867
28868
28869
28870
28871
28872
28873
28874
28875
28876
28877
28878
28879
28880
28881
28882
28883
28884
28885
28886
28887
28888
28889
28890
28891
28892
28893
28894
28895
28896
28897
28898
28899
28900
28901
28902
28903
28904
28905
28906
28907
28908
28909
28910
28911
28912
28913
28914
28915
28916
28917
28918
28919
28920
28921
28922
28923
28924
28925
28926
28927
28928
28929
28930
28931
28932
28933
28934
28935
28936
28937
28938
28939
28940
28941
28942
28943
28944
28945
28946
28947
28948
28949
28950
28951
28952
28953
28954
28955
28956
28957
28958
28959
28960
28961
28962
28963
28964
28965
28966
28967
28968
28969
28970
28971
28972
28973
28974
28975
28976
28977
28978
28979
28980
28981
28982
28983
28984
28985
28986
28987
28988
28989
28990
28991
28992
28993
28994
28995
28996
28997
28998
28999
29000
29001
29002
29003
29004
29005
29006
29007
29008
29009
29010
29011
29012
29013
29014
29015
29016
29017
29018
29019
29020
29021
29022
29023
29024
29025
29026
29027
29028
29029
29030
29031
29032
29033
29034
29035
29036
29037
29038
29039
29040
29041
29042
29043
29044
29045
29046
29047
29048
29049
29050
29051
29052
29053
29054
29055
29056
29057
29058
29059
29060
29061
29062
29063
29064
29065
29066
29067
29068
29069
29070
29071
29072
29073
29074
29075
29076
29077
29078
29079
29080
29081
29082
29083
29084
29085
29086
29087
29088
29089
29090
29091
29092
29093
29094
29095
29096
29097
29098
29099
29100
29101
29102
29103
29104
29105
29106
29107
29108
29109
29110
29111
29112
29113
29114
29115
29116
29117
29118
29119
29120
29121
29122
29123
29124
29125
29126
29127
29128
29129
29130
29131
29132
29133
29134
29135
29136
29137
29138
29139
29140
29141
29142
29143
29144
29145
29146
29147
29148
29149
29150
29151
29152
29153
29154
29155
29156
29157
29158
29159
29160
29161
29162
29163
29164
29165
29166
29167
29168
29169
29170
29171
29172
29173
29174
29175
29176
29177
29178
29179
29180
29181
29182
29183
29184
29185
29186
29187
29188
29189
29190
29191
29192
29193
29194
29195
29196
29197
29198
29199
29200
29201
29202
29203
29204
29205
29206
29207
29208
29209
29210
29211
29212
29213
29214
29215
29216
29217
29218
29219
29220
29221
29222
29223
29224
29225
29226
29227
29228
29229
29230
29231
29232
29233
29234
29235
29236
29237
29238
29239
29240
29241
29242
29243
29244
29245
29246
29247
29248
29249
29250
29251
29252
29253
29254
29255
29256
29257
29258
29259
29260
29261
29262
29263
29264
29265
29266
29267
29268
29269
29270
29271
29272
29273
29274
29275
29276
29277
29278
29279
29280
29281
29282
29283
29284
29285
29286
29287
29288
29289
29290
29291
29292
29293
29294
29295
29296
29297
29298
29299
29300
29301
29302
29303
29304
29305
29306
29307
29308
29309
29310
29311
29312
29313
29314
29315
29316
29317
29318
29319
29320
29321
29322
29323
29324
29325
29326
29327
29328
29329
29330
29331
29332
29333
29334
29335
29336
29337
29338
29339
29340
29341
29342
29343
29344
29345
29346
29347
29348
29349
29350
29351
29352
29353
29354
29355
29356
29357
29358
29359
29360
29361
29362
29363
29364
29365
29366
29367
29368
29369
29370
29371
29372
29373
29374
29375
29376
29377
29378
29379
29380
29381
29382
29383
29384
29385
29386
29387
29388
29389
29390
29391
29392
29393
29394
29395
29396
29397
29398
29399
29400
29401
29402
29403
29404
29405
29406
29407
29408
29409
29410
29411
29412
29413
29414
29415
29416
29417
29418
29419
29420
29421
29422
29423
29424
29425
29426
29427
29428
29429
29430
29431
29432
29433
29434
29435
29436
29437
29438
29439
29440
29441
29442
29443
29444
29445
29446
29447
29448
29449
29450
29451
29452
29453
29454
29455
29456
29457
29458
29459
29460
29461
29462
29463
29464
29465
29466
29467
29468
29469
29470
29471
29472
29473
29474
29475
29476
29477
29478
29479
29480
29481
29482
29483
29484
29485
29486
29487
29488
29489
29490
29491
29492
29493
29494
29495
29496
29497
29498
29499
29500
29501
29502
29503
29504
29505
29506
29507
29508
29509
29510
29511
29512
29513
29514
29515
29516
29517
29518
29519
29520
29521
29522
29523
29524
29525
29526
29527
29528
29529
29530
29531
29532
29533
29534
29535
29536
29537
29538
29539
29540
29541
29542
29543
29544
29545
29546
29547
29548
29549
29550
29551
29552
29553
29554
29555
29556
29557
29558
29559
29560
29561
29562
29563
29564
29565
29566
29567
29568
29569
29570
29571
29572
29573
29574
29575
29576
29577
29578
29579
29580
29581
29582
29583
29584
29585
29586
29587
29588
29589
29590
29591
29592
29593
29594
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'CCC', 'version' => '2020-07-01'],
'directories' => [
[
'children' => ['ListPrivilegesOfUser'],
'type' => 'directory',
'title' => '权限',
'id' => 346786,
],
[
'children' => ['ListInstancesOfUser', 'ModifyInstance'],
'type' => 'directory',
'title' => '实例',
'id' => 346789,
],
[
'children' => ['AddPersonalNumbersToUser', 'AddPhoneNumbers', 'AddPhoneNumberToSkillGroups', 'ListOutboundNumbersOfUser', 'ListPersonalNumbersOfUser', 'ListPhoneNumbers', 'ListPhoneNumbersOfSkillGroup', 'ListUnassignedNumbers', 'ModifyPhoneNumber', 'ImportCorpNumbers', 'RemovePersonalNumbersFromUser', 'RemovePhoneNumberFromSkillGroups', 'RemovePhoneNumbers', 'RemovePhoneNumbersFromSkillGroup'],
'type' => 'directory',
'title' => '号码',
'id' => 346796,
],
[
'children' => ['AddNumbersToSkillGroup', 'AddUsersToSkillGroup', 'GetSkillGroup', 'ListBriefSkillGroups', 'ListSkillGroups', 'ListSkillLevelsOfUser', 'ModifySkillGroup', 'ModifySkillLevelsOfUser', 'RemoveSkillGroupsFromUser'],
'type' => 'directory',
'title' => '技能组',
'id' => 346822,
],
[
'children' => ['ImportRamUsers', 'ChangeVisibility', 'AddSkillGroupsToUser', 'AssignUsers', 'ChangeWorkMode', 'ImportAdmins', 'ListDevices', 'ListRamUsers', 'ListUserLevelsOfSkillGroup', 'ModifyUserLevelsOfSkillGroup', 'RegisterDevice', 'RegisterDevices', 'RemoveUsersFromSkillGroup', 'ResetAgentState', 'UnregisterDevice'],
'type' => 'directory',
'title' => '坐席',
'id' => 346834,
],
[
'children' => [
'BargeInCall', 'BlindTransfer', 'CancelAttendedTransfer', 'CoachCall', 'CompleteAttendedTransfer', 'EndConference', 'GetNumberLocation', 'InitiateAttendedTransfer', 'InterceptCall', 'LaunchAuthentication', 'LaunchSurvey', 'MonitorCall', 'MuteCall', 'PickOutboundNumbers', 'PollUserStatus', 'ReadyForService', 'RedialCall', 'ReleaseCall', 'RetrieveCall', 'SaveRTCStatsV2',
'SaveTerminalLog', 'SaveWebRtcInfo', 'SaveWebRTCStats', 'SendDtmfSignaling', 'SignInGroup', 'SignOutGroup', 'StartBack2BackCall', 'StartConference', 'StartPredictiveCall', 'StartPrivacyCall', 'SwitchToConference', 'TakeBreak', 'UnmuteCall',
],
'type' => 'directory',
'title' => '话务',
'id' => 346856,
],
[
'children' => ['ModifyCampaignNumbers', 'AbortCampaign', 'AddCases', 'AppendCases', 'CreateCampaign', 'GetCampaign', 'GetCaseFileUploadUrl', 'GetHistoricalCampaignReport', 'GetRealtimeCampaignStats', 'ListAttempts', 'ListCampaigns', 'ListCampaignTrendingReport', 'ListCases', 'PauseCampaign', 'ResumeCampaign', 'UpdateCampaign', 'SubmitCampaign'],
'type' => 'directory',
'title' => '预测式外呼',
'id' => 346893,
],
[
'children' => [
'GetIvrTrackingSummary', 'ListIntervalAgentSkillGroupReport', 'ListHistoricalAgentSkillGroupReport', 'GetConversationDetail', 'GetHistoricalCallerReport', 'GetHistoricalInstanceReport', 'GetInstanceTrendingReport', 'GetRealtimeInstanceStates', 'ListAgentStateLogs', 'ListCallDetailRecordsV2', 'ListHistoricalAgentReport', 'ListHistoricalSkillGroupReport', 'ListIntervalAgentReport', 'ListIntervalInstanceReport', 'ListIntervalSkillGroupReport', 'ListIvrTrackingDetails', 'ListRealtimeAgentStates', 'ListRealtimeSkillGroupStates', 'ListRecentCallDetailRecords', 'ListAgentStates',
'ListAgentSummaryReportsSinceMidnight', 'ListLegacyAgentEventLogs', 'ListLegacyAgentStatusLogs', 'ListLegacyQueueEventLogs', 'ListSkillGroupStates', 'ListSkillGroupSummaryReportsSinceMidnight', 'ListVoicemails', 'ListGroupChatMessages',
],
'type' => 'directory',
'title' => '报表',
'id' => 346911,
],
[
'children' => ['RestoreArchivedRecordings', 'GetMonoRecording', 'GetMultiChannelRecording', 'GetVoicemailRecording', 'GetEarlyMediaRecording', 'ListMultiChannelRecordings', 'ListMonoRecordings'],
'type' => 'directory',
'title' => '录音',
'id' => 346975,
],
[
'children' => ['CreateAudioFile', 'DeleteAudioFile', 'GetAudioFile', 'GetAudioFileDownloadUrl', 'GetAudioFileUploadParameters', 'ListAudioFiles', 'ModifyAudioFile'],
'type' => 'directory',
'title' => '音频',
'id' => 346942,
],
[
'children' => ['GetLoginDetails', 'GetTurnCredentials', 'GetTurnServerList', 'ListConfigItems', 'UpdateConfigItems'],
'type' => 'directory',
'title' => '配置',
'id' => 346950,
],
[
'children' => ['ProcessCustomIMCallback', 'CreateChatMediaUrl', 'ListVisitorChatMessages', 'GetChatRoutingProfile', 'UpdateChatRoutingProfile', 'GetChatMediaUrl', 'ListWaitingChats', 'ClaimChat', 'ReleaseChat', 'StartChat', 'RejectChat', 'GetVisitorLoginDetails', 'AcceptChat'],
'type' => 'directory',
'title' => 'IM',
'id' => 346998,
],
[
'children' => ['FinishTicketTask', 'UpdateTicket', 'GetTicket', 'ListCommonTicketFields', 'TerminateTicket', 'GetTicketSummaryReport', 'ResubmitTicket', 'DeleteTicketTemplate', 'RejectTicket', 'DisableTicketTemplate', 'WithdrawTicket', 'ListTicketTasks', 'ListTickets', 'TransferTicketTask', 'EnableTicketTemplate', 'AddTicketTask', 'ListTicketTemplates', 'ListCategories', 'GetTicketTemplate'],
'type' => 'directory',
'title' => '工单',
'id' => 347012,
],
[
'children' => ['AddBlacklistCallTagging', 'CreateCallTags', 'CreateCustomCallTagging', 'DeleteCallTag', 'DeleteCustomCallTagging', 'ExportCustomCallTagging', 'ImportCustomCallTagging', 'ListBlacklistCallTaggings', 'ListCallTags', 'ListCustomCallTagging', 'ModifyCustomCallTagging', 'RemoveBlacklistCallTagging'],
'type' => 'directory',
'title' => '呼入控制',
'id' => 346956,
],
[
'children' => ['ExportDoNotCallNumbers', 'GetDoNotCallFileUploadParameters', 'ImportDoNotCallNumbers', 'ListDoNotCallNumbers', 'RemoveDoNotCallNumbers'],
'type' => 'directory',
'title' => '外呼控制',
'id' => 346969,
],
[
'children' => ['ListFlashSmsSettings', 'ListFlashSmsApplications', 'ListFlashSmsTemplates', 'ListSmsMetadata'],
'type' => 'directory',
'title' => '短信',
'id' => 347034,
],
[
'children' => ['ExportContactFlow', 'ImportContactFlow', 'CreateContactFlow', 'ListContactFlows', 'GetContactFlow', 'StartEditContactFlow', 'CommitContactFlow', 'PublishContactFlow', 'DiscardEditingContactFlow', 'DeleteContactFlow'],
'type' => 'directory',
'title' => 'IVR',
'id' => 346811,
],
[
'children' => ['DeleteSchemaProperty', 'DisableSchemaProperty', 'EnableSchemaProperty', 'GetDocumentUploadParameters', 'UpdateSchemaProperty', 'SaveDocument', 'DeleteDocuments', 'ImportDocuments', 'AddSchemaProperty'],
'type' => 'directory',
'title' => '客户',
'id' => 346983,
],
[
'children' => ['GetSummaryTemplate', 'UpdateCallSummary', 'CreateCallSummary', 'ListCallSummaries', 'AnalyzeConversation', 'AddFeedback'],
'type' => 'directory',
'title' => '坐席辅助',
'id' => 347039,
],
[
'children' => ['GetUploadAudioDataParams'],
'type' => 'directory',
'title' => '质检',
'id' => 347046,
],
[
'children' => [
'ListFeedbacks', 'AnswerCall', 'ClaimCall', 'CreateInstance', 'CreateSchema', 'CreateSkillGroup', 'CreateTicket', 'CreateUser', 'DeleteDocument', 'DeleteInstance', 'DeleteSchema', 'DeleteSkillGroup', 'DeleteTicket', 'GetCallDetailRecord', 'GetInstance', 'GetSchema', 'GetUser', 'HoldCall', 'ListCallDetailRecords', 'ListDocuments',
'ListInstances', 'ListNotificationRecords', 'ListRoles', 'ListUsers', 'MakeCall', 'ModifyUser', 'RemoveUsers', 'ResetUserPassword', 'UpdateSubscription',
],
'type' => 'directory',
'title' => '其他',
'id' => 347048,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AbortCampaign' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccQFUGXR'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'ccc-test',
],
],
[
'name' => 'CampaignId',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应参数。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE315'],
'Code' => ['title' => 'code', 'description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['title' => 'message', 'description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'],
],
],
],
],
'title' => '终止预测式外呼活动',
'summary' => '调用AbortCampaign终止指定实例下指定活动ID对应的预测式外呼活动。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AbortCampaign'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<AbortCampaignResponse>\\n <RequestId>7CC6523B-0E51-1B62-8DA5-6A9831CAE315</RequestId>\\n <Code>OK</Code>\\n <Message>无</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n</AbortCampaignResponse>","errorExample":""}]',
],
'AcceptChat' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '话务ID。', 'type' => 'string', 'required' => true, 'example' => 'chat-65382141036853491'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''],
['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid.', 'description' => ''],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
409 => [
['errorCode' => 'AlreadyExists.SkillGroup', 'errorMessage' => 'The skill group %s already exists in instance %s.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2263B273-AC1B-44EB-BA98-87F2322C6780\\"\\n}","type":"json"}]',
'title' => '接受聊天',
'summary' => '调用AcceptChat接受指定实例下指定话务ID对应的聊天。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'AddBlacklistCallTagging' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => ['description' => '电话号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1764590****'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。号码为加密号码(带有*),需要填写JobId,非加密号码,不需要填写该字段。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6582589278232****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
['errorCode' => 'LimitExceed.CallTagsPerNumber', 'errorMessage' => 'The total number of call tag of numbers exceeds the limit %s.', 'description' => '号码标签数量超出单个呼入号码标记的上线阈值。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.CustomCallTagging', 'errorMessage' => 'Custom call tagging %s does not exist in instance %s.', 'description' => '呼入号码标记不存在。'],
],
500 => [
['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'],
],
],
'title' => '添加号码黑名标签',
'summary' => '对指定号码添加黑名单标签,可结合IVR设置,防止其频繁呼入骚扰。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","type":"json"}]',
],
'AddCases' => [
'summary' => '调用AddCases添加外呼名单到指定实例下指定ID对应的预测式外呼活动。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccQFUGXR'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CampaignId',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => 'c58b9719-3bc3-441d-a4d3-fc0309ef7066'."\n"],
],
[
'name' => 'CaseList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '外呼名单列表。',
'type' => 'array',
'items' => [
'description' => '外呼名单。',
'type' => 'object',
'properties' => [
'ReferenceId' => ['description' => '业务ID,客户业务系统标识,用于集成场景。'."\n"
."\n", 'type' => 'string', 'required' => false, 'example' => '01'],
'PhoneNumber' => ['description' => '联系人电话号码。', 'type' => 'string', 'required' => false, 'example' => '188888****'],
'CustomVariables' => ['description' => '客户自定义变量,格式为JSON对象,对象最多包含10个属性,每个属性的名称和值均由客户自定义。', 'type' => 'string', 'required' => false, 'example' => '{"name":"customer","客户标签":"tag"}'."\n"],
'MaskedCallee' => ['description' => '脱敏后的被叫号码,如果该字段不为空,表示需要对被叫号码脱敏,脱敏规则由客户自行定义,只需将脱敏后的被叫号码填入即可,使用脱敏被叫会导致某些场景下看到的是脱敏后的被叫号码,无法查看真实被叫号码。', 'type' => 'string', 'required' => false, 'example' => '166******66'],
'Caller' => ['description' => '主叫号码,该字段指定号码后,对应联系人将会使用对应的号码进行外呼,不再随机选择号码。', 'type' => 'string', 'required' => false, 'example' => '185022xxxx'],
],
'required' => false,
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '41298961-CAD7-5270-9378-FFD69F153144'],
'Code' => ['title' => 'code', 'description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'],
'Message' => ['title' => 'message', 'description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'],
],
],
],
],
'title' => '添加预测式外呼名单',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddCases'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"41298961-CAD7-5270-9378-FFD69F153144\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
],
'AddFeedback' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => 'AI任务ID。', 'type' => 'string', 'required' => false, 'example' => 'f780ade8-****-458b-b067-63077946a570'],
],
[
'name' => 'TaskName',
'in' => 'query',
'schema' => ['description' => '任务类型。'."\n"
.'- Abstract:fields(字段抽取)'."\n"
.'- Abstract:keywords(热词)'."\n"
.'- Abstract:title_summary(小结)', 'type' => 'string', 'required' => false, 'example' => 'Abstract:fields'."\n"],
],
[
'name' => 'Feedback',
'in' => 'query',
'schema' => ['description' => '用户回流的数据。', 'type' => 'string', 'required' => false, 'example' => '{"问题描述":"客户询问沙发生产周期并尝试加快", "客服方案":"订单确认,建议联系在线客服", "完成度判断":"否"}'."\n"],
],
[
'name' => 'Rating',
'in' => 'query',
'schema' => ['description' => '评价:'."\n"
.'- thumbsDown:点踩。 '."\n"
.'- thumbsUp:点赞。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'thumbsUp'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C81FD1A5-4B99-470A-A527-D80150228784'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
500 => [
['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"C81FD1A5-4B99-470A-A527-D80150228784\\"\\n}","type":"json"}]',
'title' => 'AI总结打分',
'summary' => '使用AddFeedback接口对AI功能进行评价打分。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'AddNumbersToSkillGroup' => [
'summary' => '调用AddNumbersToSkillGroup添加一个或多个号码到同一个技能组下。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'],
],
[
'name' => 'NumberList',
'in' => 'query',
'schema' => ['description' => '号码列表,请确保号码已在当前实例下。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '["0103182****","0102387****"]'],
],
[
'name' => 'InstNumberGroupIdList',
'in' => 'query',
'schema' => ['description' => '号码集合列表', 'type' => 'string', 'required' => false, 'example' => '["38f5b191-b764-45b8-bd93-4b65f839e13a"]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的技能组ID。'],
],
],
'title' => '添加多个号码到技能组',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-07T07:21:05.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddNumbersToSkillGroup'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]',
],
'AddPersonalNumbersToUser' => [
'summary' => '调用AddPersonalNumbersToUser添加一个或多个个人外呼号码到指定实例下的指定坐席。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'NumberList',
'in' => 'query',
'schema' => ['description' => '待添加的号码列表,要求号码可被UserId对应的坐席绑定,如果不清楚坐席可绑定哪些号码,请参考ListPersonalNumbersOfUser接口。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["0101234****","0105678****"]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'Data' => [
'description' => '添加失败的号码列表。',
'type' => 'array',
'items' => ['description' => '号码', 'type' => 'string', 'example' => '0101234****'],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '添加多个号码到坐席',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPersonalNumbersToUser'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": [\\n \\"0101234****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>[\\"0100xxxx009\\"]</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'AddPhoneNumberToSkillGroups' => [
'summary' => '调用AddPhoneNumberToSkillGroups将号码关联到指定实例下的一个或多个技能组。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => ['description' => '号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0101234****'],
],
[
'name' => 'SkillGroupIdList',
'in' => 'query',
'schema' => ['description' => '技能组ID列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '添加号码到多个技能组',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPhoneNumberToSkillGroups'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]',
],
'AddPhoneNumbers' => [
'summary' => '调用AddPhoneNumbers添加一个或多个号码到指定实例下。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'ContactFlowId',
'in' => 'query',
'schema' => ['description' => '绑定的IVR联系流ID,仅当号码用途包含呼入时,该参数才有效,非必填,默认为空。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dDMD_0mif4hv'],
],
[
'name' => 'Usage',
'in' => 'query',
'schema' => [
'description' => '号码的用途,注意,如果传入的号码为400号码,则用途只能填Inbound。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['Outbound' => '呼出', 'Inbound' => '呼入', 'Bidirection' => '呼入和呼出'],
'example' => 'Bidirection',
],
],
[
'name' => 'NumberList',
'in' => 'query',
'schema' => ['description' => '待添加的号码列表。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["0101234****", "0105678****"]'],
],
[
'name' => 'NumberGroupId',
'in' => 'query',
'schema' => ['description' => '号码组ID,在云联络中心控制台可以看到号码分组信息,非必填,默认为空。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2cb77c29-5f60-4b90-b21e-9d2ba9833f14'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '添加失败的号码列表。',
'type' => 'array',
'items' => ['description' => '号码。', 'type' => 'string', 'example' => '0101234****'],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'],
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '添加号码',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPhoneNumbers'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": [\\n \\"0101234****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>无</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'AddSchemaProperty' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'parameters' => [
[
'name' => 'SchemaId',
'in' => 'formData',
'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'],
],
[
'name' => 'Property',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '字段',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '名称', 'type' => 'string', 'required' => false, 'example' => 'name'],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'required' => false, 'example' => '-'],
'Name' => ['description' => '名称', 'type' => 'string', 'required' => true, 'example' => 'name'],
'DataType' => ['description' => '数据类型', 'type' => 'string', 'required' => true, 'example' => 'string'],
'Pattern' => ['description' => '正则表达式校验规则', 'type' => 'string', 'required' => false, 'example' => '*'],
'PatternErrorMessage' => ['description' => '正则表达式校验错误提示信息', 'type' => 'string', 'required' => false, 'example' => '格式错误'],
'MinLength' => ['description' => '最小长度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'MaxLength' => ['description' => '最大长度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
'Minimum' => ['description' => '数字最小值', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1'],
'Maximum' => ['description' => '数字最大值', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1'],
'Required' => ['description' => '是否必填', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
'Disabled' => ['description' => '是否被禁用', 'type' => 'boolean', 'required' => false, 'example' => 'False'],
'Array' => ['description' => '是否是数组', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
'ReadOnly' => ['description' => '是否只读', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'EditorType' => ['description' => '编辑器类型', 'type' => 'string', 'required' => false, 'example' => 'textbox'],
'Attributes' => ['description' => '扩展属性', 'type' => 'string', 'required' => false, 'example' => '{\\"newName\\":\\"小桔充电-demo\\",\\"appId\\":\\"69FRKB4193W8BYP0\\"}'],
'DisplayOrder' => ['description' => '列表展示顺序', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
'required' => false,
],
],
[
'name' => 'RequestId',
'in' => 'formData',
'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'AddSchemaPropertyResponse',
'description' => 'AddSchemaPropertyResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'BF268B34-09C2-43FD-BAC4-5D31EA633111'],
'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BF268B34-09C2-43FD-BAC4-5D31EA633111\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '添加Schema字段',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'AddSkillGroupsToUser' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccPBOQGO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'SkillLevelList',
'in' => 'query',
'schema' => ['description' => '技能组的技能等级列表,格式为JSON数组的字符串,数组元素是一个对象,包含两个字段:skillGroupId和skillLevel,skillGroupId填写要添加的技能组ID,skillLevel填写要添加的技能等级,取值范围1-10,值越小,业务能力越强,单位时间内能处理更多的通话。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"skillGroupId":"test1@ccc-test","skillLevel":5},{"skillGroupId":"test2@ccc-test","skillLevel":5}]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA7F9545-8312-4190-9BD0-63144B3F1ACC'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
],
403 => [
['errorCode' => 'Permission.SkillGroup', 'errorMessage' => 'You have no permission to access skill group(s) %s.', 'description' => '您无权访问这些技能组。'],
],
[
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的技能组ID。'],
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
],
'title' => '添加多个技能组到坐席',
'summary' => '调用AddSkillGroupsToUser添加一个或多个技能组到指定实例下的指定坐席。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddSkillGroupsToUser'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA7F9545-8312-4190-9BD0-63144B3F1ACC\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA7F9545-8312-4190-9BD0-63144B3F1ACC</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Code>OK</Code>","errorExample":""}]',
],
'AddTicketTask' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'TicketId',
'in' => 'query',
'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => true, 'example' => '3d26b90a-c5d2-4b09-8219-********'],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '工单流程节点ID。', 'type' => 'string', 'required' => true, 'example' => '3b8c672f-48f6-45f5-bf41-9d4cb2b4a716'],
],
[
'name' => 'Assignee',
'in' => 'query',
'schema' => ['description' => '加签指派的处理人。', 'type' => 'string', 'required' => true, 'example' => 'assignee@ccc-test'],
],
[
'name' => 'Comment',
'in' => 'query',
'schema' => ['description' => '处理意见。', 'type' => 'string', 'required' => true, 'example' => '请assignee处理。'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'Position',
'in' => 'query',
'schema' => ['description' => '加签位置。'."\n"
.'- Before: 在我之前'."\n"
.'- After: 在我之后', 'type' => 'string', 'required' => false, 'example' => 'After'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'AddAssigneeToTicketTaskResponse',
'description' => 'AddAssigneeToTicketTaskResponse',
'type' => 'object',
'properties' => [
'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B06B3244-1B44-481B-90C4-F2F92E59D6B5'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"B06B3244-1B44-481B-90C4-F2F92E59D6B5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '工单加签',
'summary' => '使用AddTicketTask进行加签操作,添加处理人。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'AddUsersToSkillGroup' => [
'summary' => '调用AddUsersToSkillGroup添加一个或多个坐席到同一个技能组。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccPBOQGO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test1@ccc-test'],
],
[
'name' => 'UserSkillLevelList',
'in' => 'query',
'schema' => ['description' => '坐席技能组等级列表,格式为JSON数组的字符串,数组元素是一个对象,包含两个字段,userId和skillLevel,userId为待添加的坐席ID,skillLevel为该坐席加入技能组后的技能等级,技能等级为1-10,值越小,服务能力越强,单位时间内能处理更多的通话。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"userId":"agent1@ccc-test","skillLevel":10},{"userId":"agent2@ccc-test","skillLevel":10}]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的技能组ID。'],
],
],
'title' => '添加多个坐席到技能组',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddUsersToSkillGroup'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]',
],
'AnalyzeConversation' => [
'summary' => '分析指定的文字通话内容,提取摘要类相关信息,比如标题,关键词、小结以及其他指定的信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeNodes' => ['FEATUREccc5HY0NN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '云联络中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => false, 'example' => 'job-10963442671187****'],
],
[
'name' => 'TaskListJson',
'in' => 'query',
'schema' => ['description' => '分析的任务类型列表。其内容可以是:'."\n"
.'- title:标题'."\n"
.'- summary:小结'."\n"
.'- keywords:关键词'."\n"
.'- fields:字段'."\n"
."\n"
.'目前仅summary和title可同时传递,其他的参数只能单独传递。', 'type' => 'string', 'required' => false, 'example' => '["keywords"]'],
],
[
'name' => 'FieldListJson',
'in' => 'query',
'schema' => ['description' => '当TaskListJson参数为fields, 此参数指定要提取的字段内容。', 'type' => 'string', 'required' => false, 'example' => '['."\n"
.' {'."\n"
.' "code": "OrderNo",'."\n"
.' "name": "订单号",'."\n"
.' "description": "订单号"'."\n"
.' },'."\n"
.' {'."\n"
.' "code": "ProductName",'."\n"
.' "name": "商品名称",'."\n"
.' "description": "商品名称"'."\n"
.' }'."\n"
.']'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID,可用于接口的日志查询', 'type' => 'string', 'example' => '9F766284-F103-4298-8EC5-19F9F9BE5522'],
'Data' => ['description' => '返回结果。根据分析任务的不同,返回的内容也不相同。', 'type' => 'string', 'example' => '{'."\n"
.' "订单号": "1234",'."\n"
.' "商品名称": "笔记本"'."\n"
.'}'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
500 => [
['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '分析对话内容',
'description' => '此接口可用于在线会话以及语音会话。当用于语音会话时,需要实现开启语音实时转写的功能。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"9F766284-F103-4298-8EC5-19F9F9BE5522\\",\\n \\"Data\\": \\"{\\\\n \\\\\\"订单号\\\\\\": \\\\\\"1234\\\\\\",\\\\n \\\\\\"商品名称\\\\\\": \\\\\\"笔记本\\\\\\"\\\\n}\\"\\n}","type":"json"}]',
],
'AnswerCall' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-65382141036853491'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'ContextId' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '103655'],
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'Index' => ['description' => 'Channel在通话过程中创建的顺序。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'ANSWERED',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'SkillGroupId' => ['description' => '话务通道关联的技能组ID,呼入场景下,关联的技能组ID由IVR中转人工模块配置的技能组决定,呼出场景下,关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'INBOUND',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'],
'ChannelVariables' => ['description' => '随路数据', 'type' => 'string', 'example' => 'a=b;c=d;'],
],
],
],
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'INBOUND',
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'TALKING',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidOperation', 'errorMessage' => 'The operation is not allowed in current state.', 'description' => ''],
],
404 => [
['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'],
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103655,\\n \\"CallContext\\": {\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"INBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"ChannelVariables\\": \\"a=b;c=d;\\"\\n }\\n ],\\n \\"CallType\\": \\"INBOUND\\"\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <AssociatedData/>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
'title' => '接听通话',
'summary' => '调用AnswerCall接听指定实例下指定通话ID对应的通话。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-02-05T03:20:14.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-10-26T07:15:58.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-06-05T23:22:12.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-12-21T04:35:33.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AnswerCall'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'AppendCases' => [
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccQFUGXR'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CampaignId',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '78cf6864-9a22-4ea8-a59d-5adc2d747b0e'],
],
[
'name' => 'body',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '外呼名单列表,Body参数。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ReferenceId' => ['description' => '业务ID,客户业务系统标识,用于集成场景。'."\n"
."\n", 'type' => 'string', 'required' => false, 'example' => '01'],
'PhoneNumber' => ['description' => '联系人电话号码。', 'type' => 'string', 'required' => false, 'example' => '188888****'],
'CustomVariables' => ['description' => '客户自定义变量,格式为JSON对象,对象最多包含10个属性,每个属性的名称和值均由客户自定义。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "name": "customer",'."\n"
.' "客户标签": "tag"'."\n"
.'}'],
'MaskedCallee' => ['description' => '脱敏后的被叫号码,如果该字段不为空,表示需要对被叫号码脱敏,脱敏规则由客户自行定义,只需将脱敏后的被叫号码填入即可,使用脱敏被叫会导致某些场景下看到的是脱敏后的被叫号码,无法查看真实被叫号码。', 'type' => 'string', 'required' => false, 'example' => '071*****801'],
'Caller' => ['description' => '主叫号码,该字段若不为空,外呼式会优先使用传入的号码作为主叫发起呼叫;该字段若为空,系统会自动选取主叫发起呼叫。', 'type' => 'string', 'required' => false, 'example' => '01012345678'],
'AgentId' => ['description' => '坐席ID,指定的转接坐席,该字段不为空,系统会将该电话转至对应坐席;该字段若为空,系统会分配给技能组中的空闲坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E'],
'Code' => ['title' => 'code', 'description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['title' => 'message', 'description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'],
'Data' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ReferenceId' => ['type' => 'string', 'description' => ''],
'PhoneNumber' => ['type' => 'string', 'description' => ''],
'CustomVariables' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
'description' => '',
],
],
],
],
],
'title' => '追加预测式外呼名单',
'summary' => '添加外呼名单到指定实例下指定ID对应的预测式外呼活动。',
'changeSet' => [
['createdAt' => '2025-11-13T08:46:17.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AppendCases'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"ReferenceId\\": \\"\\",\\n \\"PhoneNumber\\": \\"\\",\\n \\"CustomVariables\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
],
'AssignUsers' => [
'summary' => '调用AssignUsers将一个或多个RAM账户导入到指定实例中,成功导入后,RAM账户将以坐席的形式存在于实例中。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'RoleId',
'in' => 'query',
'schema' => ['description' => '角色ID,坐席导入成功后在实例中的角色,包括管理员、技能组组长和坐席三种角色。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Agent@ccc-test'],
],
[
'name' => 'SkillLevelList',
'in' => 'query',
'schema' => ['description' => '技能组的技能等级列表,格式为JSON数组的字符串,数组元素是一个对象,包含两个字段:skillGroupId和skillLevel,skillGroupId填写坐席想要关联的技能组ID,skillLevel填写坐席在该技能组的技能等级,取值范围1-10,值越小,业务能力越强,单位时间内能处理更多的通话。', 'type' => 'string', 'required' => false, 'example' => '[{"skillGroupId":"skillgroup@ccc-test","skillLevel":5}]'],
],
[
'name' => 'RamIdList',
'in' => 'query',
'schema' => ['description' => '待添加的RAM用户ID列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["28036411123456****","29234301123456****"]'],
],
[
'name' => 'WorkMode',
'in' => 'query',
'schema' => [
'description' => '工作模式。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
],
[
'name' => 'Async',
'in' => 'query',
'schema' => ['type' => 'boolean', 'default' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Data' => ['description' => '数据,内容与工作流ID相同。', 'type' => 'string', 'example' => '1ca2b084-6f0a-454b-9851-29768a9a5832'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'WorkflowId' => ['description' => '工作流ID。', 'type' => 'string', 'example' => '1ca2b084-6f0a-454b-9851-29768a9a5832'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'],
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'staticInfo' => [
'substitutions' => ['CCC::2020-07-01::ImportRamUsers'],
],
'title' => '导入多个坐席',
'description' => '拥有RAM权限的账号可以到RAM控制台查询阿里云主账号下管理的所有RAM子账号,RAM控制台地址:https://ram.console.aliyun.com/users',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssignUsers'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"1ca2b084-6f0a-454b-9851-29768a9a5832\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Code\\": \\"OK\\",\\n \\"WorkflowId\\": \\"1ca2b084-6f0a-454b-9851-29768a9a5832\\",\\n \\"Message\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>1ca2b084-6f0a-454b-9851-29768a9a5832</Data>\\n<WorkflowId>1ca2b084-6f0a-454b-9851-29768a9a5832</WorkflowId>\\n<Sync>无</Sync>\\n<Code>OK</Code>","errorExample":""}]',
],
'BargeInCall' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '发起强插的坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'],
],
[
'name' => 'BargedUserId',
'in' => 'query',
'schema' => ['description' => '被强插的座席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent2@ccc-test'],
],
[
'name' => 'TimeoutSeconds',
'in' => 'query',
'schema' => ['description' => '强插超时时间,经过指定的时间强插仍未成功,则取消强插,正常情况下,强插操作会马上成功,设置超时时间是为了防止异常发生,此字段选填,默认30,单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '0', 'example' => '60'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'BARGE',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'Index' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'ANSWERED',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'],
'example' => 'MONITORING',
],
'SkillGroupId' => ['description' => '话务通道关联的技能组ID,呼入场景下,关联的技能组ID由IVR中转人工模块配置的技能组决定,呼出场景下,关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'BARGE',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'TALKING',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'InvalidOperation.DeviceState', 'errorMessage' => 'The operation is not allowed. Device state (%s) does not meet expectations (%s).', 'description' => '非法操作。 设备状态不符合预期。'],
['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作,用户状态不符合预期。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'],
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
],
'title' => '强插通话',
'summary' => '调用BargeInCall强行插入指定实例下指定通话ID对应的正在通话中的通话,强插成功后,通话将由原来的双方通话变成三人会议。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-10-26T08:13:48.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BargeInCall'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"BARGE\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"BARGE\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>10</Index>\\n <SkillGroupId>skg-test1@ccc-test</SkillGroupId>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'BlindTransfer' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '发起直接转接的坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ACC-YUNBS-1.0.10-****'],
],
[
'name' => 'Transferor',
'in' => 'query',
'schema' => ['description' => '转接发起方,当场景是直接转接到外部号码时,用此参数指定的号码作为主叫,转内部坐席或技能组时,此参数无效,发起方由UserId指定。', 'type' => 'string', 'required' => false, 'example' => '08314325****'],
],
[
'name' => 'Transferee',
'in' => 'query',
'schema' => ['description' => '被转接方,可以是坐席ID或技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'TimeoutSeconds',
'in' => 'query',
'schema' => ['description' => '直接转接超时时间,超过指定时间被转接方没有接起通话,则挂断通话,此字段选填,默认30,单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '120', 'minimum' => '3', 'example' => '60'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'],
],
[
'name' => 'CallPriority',
'in' => 'query',
'schema' => ['description' => '转接到技能组队列时的排队优先级,取值范围0-9,0优先级最高,9最低。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'],
],
[
'name' => 'StrategyName',
'in' => 'query',
'schema' => ['description' => '转接到技能组队列时的座席分配策略名称。', 'type' => 'string', 'required' => false, 'example' => 'MOST_IDLE,MOST_SKILLED,MOST_ACQUAINTED,CUSTOMIZED等'],
],
[
'name' => 'StrategyParams',
'in' => 'query',
'schema' => ['description' => '转接到技能组队列时的座席分配策略参数。', 'type' => 'string', 'required' => false, 'example' => '当分配策略为CUSTOMIZED时,本参数的内容为如下格式:'."\n"
.' {'."\n"
.' "functionId": "512fed64-e379-400f-a1a5-14d5730xxxxx",'."\n"
.' "functionName": "routing-strategy-test-2"'."\n"
.'}'],
],
[
'name' => 'TransfereeType',
'in' => 'query',
'schema' => ['description' => '转接目的类型,可选值为AGENT,SKILL_GROUP,IVR和EXTERNAL_NUMBER。如果此参数不传,则系统会根据转接的目标号码的格式进行判断,如果发现有判不准确的情况,则需要指定此参数。', 'type' => 'string', 'required' => false, 'example' => 'SKILL_GROUP'],
],
[
'name' => 'ContactFlowVariables',
'in' => 'query',
'schema' => ['description' => '传递给联系流的变量,选填,这里配置的变量,可以在IVR流程中拿到并使用,格式为JSON字符串格式的键值对集合。', 'type' => 'string', 'required' => false, 'example' => '{"name":"王先生","time":"19点20分","address":"某某中心"}'],
],
[
'name' => 'RoutingType',
'in' => 'query',
'schema' => ['description' => '话务分配类型,可选参数为自动分配(Automatic)或者手动分配(Manual)。如果此参数为空,则默认为自动分配的方式,这也是当前系统的默认行为。选择手动分配方式时,需要您自己配合调用ClaimCall等接口把电话分给指定的座席。', 'type' => 'string', 'required' => false, 'example' => 'Manual'],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => ['description' => '随路数据,主要用于扩展需求,普通用户无需关心。', 'type' => 'string', 'required' => false, 'example' => '5295578135#WAEtqY5U&Biz_Package_Rexian_Zhuanjieanquanyungaojie_2527'],
],
[
'name' => 'QueuingTimeoutSeconds',
'in' => 'query',
'schema' => ['description' => '当转接目标是技能组队列时排队超时时间,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
[
'name' => 'QueuingOverflowThreshold',
'in' => 'query',
'schema' => ['description' => '当转接目标是技能组队列时排队溢出阈值。默认值为0,表示不溢出。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => false, 'example' => 'ee914df4-82bf-4919-bcb3-9cb8aa437f35'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'ContextId' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '103654'],
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道',
'type' => 'object',
'properties' => [
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'ANSWERED',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'],
'example' => 'MONITORING',
],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'TALKING',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Invalid', 'errorMessage' => 'The parameter %s is invalid. %s.', 'description' => '该参数无效。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'],
],
],
'title' => '直接转接通话',
'summary' => '直接转接通话到其他坐席或某个技能组队列或外部号码,直接转接也叫盲转或单步转。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-10-28T02:30:26.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-04-01T09:23:01.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-11-07T07:21:07.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-04-25T07:33:48.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-04-12T02:15:28.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-12-21T09:15:55.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BlindTransfer'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103654,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <AssociatedData/>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'CancelAttendedTransfer' => [
'summary' => '调用CancelAttendedTransfer取消咨询转接,在发起咨询转接后,完成咨询转接前,均可调用该接口取消咨询转接,即使被转接方已经接通,也可以取消。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'ContextId' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '103656'],
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'Index' => ['description' => '系统自增ID,客户不用关注。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'ANSWERED',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'],
'example' => 'MONITORING',
],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'CONSULTANT',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'TALKING',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''],
['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作,用户状态不符合预期。'],
],
404 => [
['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'],
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'],
],
],
'title' => '取消咨询转移',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-10-26T08:13:48.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelAttendedTransfer'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103656,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"CONSULTANT\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>10</Index>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ChangeVisibility' => [
'summary' => '修改隐身状态(等同于仅外呼场景)。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'szpczf'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'example' => 'sam@szpczf'],
],
[
'name' => 'Invisible',
'in' => 'query',
'schema' => ['description' => '是否切换为隐身状态。隐身状态和仅外呼含义一致。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => 'Internal service issue. Detail:.'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '24BE19E8-BF7D-4992-A35E-15EBA874F2E5'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '座席分机号。'."\n", 'type' => 'string', 'example' => '8001****'],
'WorkMode' => ['description' => '工作模式。', 'type' => 'string', 'example' => 'ON_SITE'],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'Yealink SIP-T23G 44.84.203.6'],
'JobId' => ['description' => '通话ID,如果该字段有值,说明坐席当前处于通话过程中。', 'type' => 'string', 'example' => 'job-330557290544431104'],
'UserId' => ['description' => '座席ID。', 'type' => 'string', 'example' => 'sam@szpczf'],
'BreakCode' => ['description' => '小休代码。', 'type' => 'string', 'example' => '会议'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'szpczf'],
'OutboundScenario' => ['description' => '坐席是否为仅外呼状态。', 'type' => 'boolean', 'example' => 'False'],
'UserState' => ['description' => '用户状态。', 'type' => 'string', 'example' => 'Ready'],
'SignedSkillGroupIdList' => [
'description' => '技能组ID。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''],
['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作,用户状态不符合预期。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Internal service issue. Detail:.\\",\\n \\"RequestId\\": \\"24BE19E8-BF7D-4992-A35E-15EBA874F2E5\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"Yealink SIP-T23G 44.84.203.6\\",\\n \\"JobId\\": \\"job-330557290544431104\\",\\n \\"UserId\\": \\"sam@szpczf\\",\\n \\"BreakCode\\": \\"会议\\",\\n \\"InstanceId\\": \\"szpczf\\",\\n \\"OutboundScenario\\": true,\\n \\"UserState\\": \\"Ready\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup@ccc-test\\"\\n ]\\n }\\n}","type":"json"}]',
'title' => '修改座席可见性',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ChangeWorkMode' => [
'summary' => '调用ChangeWorkMode改变坐席的工作模式。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID,不填默认使用当前RAM账号映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'required' => false, 'example' => 'ACC-YUNBS-1.0.10-****'],
],
[
'name' => 'WorkMode',
'in' => 'query',
'schema' => [
'description' => '工作模式。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
],
[
'name' => 'SignedSkillGroupIdList',
'in' => 'query',
'schema' => ['description' => '需要签入的技能组列表。当修改工作模式到场外模式时,可以通过此参数指定场外座席需要签入的技能组列表。', 'type' => 'string', 'required' => false, 'example' => '["online-1@ccc-test","online-2@ccc-test","online-3@ccc-test","skg-default@ccc-test"]'],
],
[
'name' => 'Mobile',
'in' => 'query',
'schema' => ['description' => '坐席的个人电话号码,该号码在场外模式下会用到,坐席可以使用该号码进行场外模式接听。', 'type' => 'string', 'required' => false, 'example' => '1382114****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => '87731ED1-6224-48A5-99E3-6237FF9B1C00'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。'."\n",
'type' => 'object',
'properties' => [
'Extension' => ['description' => '座席分机号。'."\n", 'type' => 'string', 'example' => '8001****'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'JobId' => ['description' => '通话ID,如果该字段有值,说明坐席当前处于通话过程中。'."\n", 'type' => 'string', 'example' => '无'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休码包括:Warm-up'."\n"
.'(坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否开启了仅外呼模式。'."\n", 'type' => 'boolean', 'example' => 'false'],
'UserState' => [
'description' => '座席状态。'."\n",
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'OFFLINE',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
],
'title' => '改变坐席工作模式',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-11-28T07:08:39.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeWorkMode'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"87731ED1-6224-48A5-99E3-6237FF9B1C00\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"无\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"OFFLINE\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup@ccc-test\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>87731ED1-6224-48A5-99E3-6237FF9B1C00</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <Extension>80011474</Extension>\\n <UserState>OFFLINE</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-bs990cd82101cc000176af19ec8e</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>无</JobId>\\n <SignedSkillGroupIdList>[\\"skill-group@ccc-test\\"]</SignedSkillGroupIdList>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ClaimCall' => [
'summary' => '调用接口ClaimCall把一个电话分配给一个坐席。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '调用者坐席ID。', 'type' => 'string', 'required' => false, 'example' => 'invoker@ccc-test'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '话务ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '待分配电话的技能组ID。', 'type' => 'string', 'required' => false, 'example' => 'test_sg_****@ccc-test'],
],
[
'name' => 'CandidateUserListJson',
'in' => 'query',
'schema' => ['description' => '可以认领此电话的座席及对应的技能组列表', 'type' => 'string', 'required' => false, 'example' => '['."\n"
.'{'."\n"
.'"f0": "zeren001@report-test-2",'."\n"
.'"f1": "desktop-voip-box@report-test-2"'."\n"
.'}'."\n"
.']'],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => ['description' => '调度专用唯一业务ID,后续事件通知携带此标志', 'type' => 'string', 'required' => false, 'example' => 'tags'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '93CDC17E-3E8A-48F2-99E5-FA2E238DE8B4'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'example' => 'ccc-test'],
'ChannelContexts' => [
'description' => '话务通道上下文。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'],
'ChannelState' => ['description' => '话务通道的状态。', 'type' => 'string', 'example' => 'ANSWERED'],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'invoker@ccc-test'],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609225718295'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '无'],
'CallType' => ['description' => '话务通道的通话类型。', 'type' => 'string', 'example' => 'OUTBOUND'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6573574060089****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'],
'UserExtension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8059****'],
'ChannelVariables' => ['description' => '随路数据。', 'type' => 'string', 'example' => 'a=b;c=d;'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '分机号。', 'type' => 'string', 'example' => '0830019****'],
'WorkMode' => ['description' => '工作模式。', 'type' => 'string', 'example' => 'ON_SITE'],
'DeviceId' => ['description' => '设备ID。', 'type' => 'string', 'example' => 'device-xxxx'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6573574060089****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'user@ccc-test'],
'BreakCode' => ['description' => '小休状态码。', 'type' => 'string', 'example' => 'Customized'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '是否为场外模式。', 'type' => 'boolean', 'example' => 'false'],
'UserState' => ['description' => '坐席状态。', 'type' => 'string', 'example' => 'Dialing'],
'SignedSkillGroupIdList' => [
'description' => '签入的技能组列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skill@ccc-test'],
],
],
],
'ContextId' => ['description' => '上下文ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '分配电话',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"93CDC17E-3E8A-48F2-99E5-FA2E238DE8B4\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"invoker@ccc-test\\",\\n \\"Timestamp\\": 1609225718295,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8059****\\",\\n \\"ChannelVariables\\": \\"a=b;c=d;\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"0830019****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"device-xxxx\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"UserId\\": \\"user@ccc-test\\",\\n \\"BreakCode\\": \\"Customized\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"Dialing\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skill@ccc-test\\"\\n ]\\n },\\n \\"ContextId\\": 123456\\n }\\n}","type":"json"}]',
],
'ClaimChat' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '按技能组ID过滤。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '话务ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'chat-65382141036853491'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'ContextId' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789'],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为 Unix 时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'."\n"],
'WorkMode' => ['description' => '工作模式。Chat场景无需关心。'."\n"
."\n"
.'枚举值:'."\n"
.'- ON_SITE:场内模式。'."\n"
.'- OFF_SITE:场外模式。'."\n"
.'- OFFICE_PHONE:办公电话模式。', 'type' => 'string', 'example' => 'ON_SITE'],
'DeviceId' => ['description' => '设备 ID。', 'type' => 'string', 'example' => 'CCC-169.254.165.2-browser125.0.0-bs48b41903450e6c8'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'userId@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,格式为 Unix 时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => 'false'],
'BreakCode' => ['description' => '小休状态码。', 'type' => 'string', 'example' => 'Warm-up'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '仅外呼场景。Chat业务无需关心。', 'type' => 'boolean', 'example' => 'false'],
'DeviceState' => ['description' => '设备状态。', 'type' => 'string', 'example' => 'ONLINE'],
'Mobile' => ['description' => '坐席的个人电话号码。Chat场景无需关心。', 'type' => 'string', 'example' => '18******102'],
'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'chat-65382141036853491'."\n"],
'UserState' => ['description' => '座席状态。'."\n"
."\n"
.'枚举值:'."\n"
.'- READY:空闲。'."\n"
.'- WORKING:话后处理中。'."\n"
.'- BREAK:小休。'."\n"
.'- OFFLINE:离线。'."\n"
.'- TALKING:聊天中。'."\n"
.'- RINGING:聊天进线中。', 'type' => 'string', 'example' => 'TALKING'],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组 ID 列表。',
'type' => 'array',
'items' => ['description' => '技能组 ID。', 'type' => 'string', 'example' => 'skg-default@ccc-test'],
],
],
],
'ChatContexts' => [
'description' => '会话上下文环境。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'chat-65382141036853491'."\n"],
'ChatType' => ['description' => '会话类型。', 'type' => 'string', 'example' => 'INBOUND'],
'CallVariables' => ['description' => '随路数据。', 'type' => 'string', 'example' => '无'],
'AccessChannelId' => ['description' => '网络业务渠道ID。', 'type' => 'string', 'example' => '226****-cbb6-****-8fea-1e71baf7bfa7'],
'AccessChannelType' => ['description' => '网络业务渠道类型。', 'type' => 'string', 'example' => 'Web'],
'AccessChannelName' => ['description' => '网络业务渠道名字。', 'type' => 'string', 'example' => '测试渠道'],
'BeingAssigned' => ['description' => '会话是否已分配坐席。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''],
],
404 => [
['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'],
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 123456789,\\n \\"UserContext\\": {\\n \\"Heartbeat\\": 1609136956378,\\n \\"Extension\\": \\"8032****\\\\n\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"CCC-169.254.165.2-browser125.0.0-bs48b41903450e6c8\\",\\n \\"UserId\\": \\"userId@ccc-test\\",\\n \\"Reserved\\": 0,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"ONLINE\\",\\n \\"Mobile\\": \\"18******102\\",\\n \\"JobId\\": \\"chat-65382141036853491\\\\n\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skg-default@ccc-test\\"\\n ]\\n },\\n \\"ChatContexts\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"chat-65382141036853491\\\\n\\",\\n \\"ChatType\\": \\"INBOUND\\",\\n \\"CallVariables\\": \\"无\\",\\n \\"AccessChannelId\\": \\"226****-cbb6-****-8fea-1e71baf7bfa7\\",\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"AccessChannelName\\": \\"测试渠道\\",\\n \\"BeingAssigned\\": true\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '认领聊天',
'summary' => '调用ClaimChat认领指定实例下指定话务ID对应的聊天。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'CoachCall' => [
'summary' => '调用CoachCall辅导指定实例下指定通话ID对应的通话中的指定坐席,辅导过程中被辅导坐席可以听到辅导者的声音,客户无法听到辅导者的声音。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '发起辅导的坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-65382141036853491'],
],
[
'name' => 'CoachedUserId',
'in' => 'query',
'schema' => ['description' => '被辅导的坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'coached-agent@ccc-test'],
],
[
'name' => 'TimeoutSeconds',
'in' => 'query',
'schema' => ['description' => '辅导超时时间,超过指定时间辅导没有建立,则取消辅导操作,此字段选填,默认30,单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '0', 'example' => '30'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'COACH',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'Index' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'ANSWERED',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'],
'example' => 'COACHING',
],
'SkillGroupId' => ['description' => '话务通道关联的技能组ID,呼入场景下,关联的技能组ID由IVR中转人工模块配置的技能组决定,呼出场景下,关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'COACH',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956370'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'DeviceState' => [
'description' => 'SIP话机设备的状态,如果未注册SIP话机,则状态为UNREGISTERED(未注册),如过SIP话机注册过但是不在线,则状态为OFFLINE(离线),如果SIP话机注册过并且在线则为ONLINE(在线)。',
'type' => 'string',
'enumValueTitles' => ['UNREGISTERED' => '未注册', 'OFFLINE' => '离线', 'ONLINE' => '在线'],
'example' => 'UNREGISTERED',
],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'TALKING',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidOperation.DeviceState', 'errorMessage' => 'The operation is not allowed. Device state (%s) does not meet expectations (%s).', 'description' => '非法操作。 设备状态不符合预期。'],
['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作,用户状态不符合预期。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'UserBusy', 'errorMessage' => 'The user %s you called was busy. Please try again later.', 'description' => '您呼叫的用户正忙,请稍后再试。'],
],
403 => [
['errorCode' => 'Permission.Common', 'errorMessage' => 'You have no permission to access. %s', 'description' => '您无权进行访问。'],
],
[
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'],
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
],
'title' => '辅导通话',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-01-11T08:11:36.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CoachCall'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"COACH\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"COACHING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"COACH\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956370,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"UNREGISTERED\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>1</Index>\\n <AssociatedData>无</AssociatedData>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <ChannelId>ch:user:139xxxx0501->8032xxxx:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>COACHING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>8032xxxx</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <BreakCode>Warm-up</BreakCode>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <Uri>无</Uri>\\n <Extension>8032xxxx</Extension>\\n <DeviceState>UNREGISTERED</DeviceState>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <JobId>job-65382141036853491</JobId>\\n <WorkMode>ON_SITE</WorkMode>\\n <Reserved>1609136956370</Reserved>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'CommitContactFlow' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccTPIKHY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'ContactFlowId',
'in' => 'query',
'schema' => ['description' => '联系流ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7d706489-d06d-4a92-8666-8c9dba2c5cb1'],
],
[
'name' => 'Definition',
'in' => 'query',
'schema' => ['description' => 'IVR的定义。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"activities":[{"type":"INCOMING_CALL","id":"e98f0d47","name":"开始","properties":{"position":{"x":263,"y":164}},"events":[{"event":"complete","next":"2d3ad2c2","edgeId":"41f7dbd0"}],"nodeIndex":0},{"type":"HANGUP","id":"bd4f37e2","name":"挂机","properties":{"position":{"x":765,"y":185}},"events":[{"event":"complete","next":null}],"nodeIndex":999},{"type":"PLAY_SAY","id":"2d3ad2c2","name":"放音","properties":{"say":"您好,欢迎来到云联络中心。","audioResourceId":"","position":{"x":485.5,"y":153.5},"audioType":"tts","audioInterrupt":false},"events":[{"event":"complete","next":"bd4f37e2","edgeId":"e1af4f1f"}],"nodeIndex":1}],"description":""}'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '版本描述。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'DraftId',
'in' => 'query',
'schema' => ['description' => '草稿ID,当前联系流对应的草稿版本ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b28f74ca-5846-4496-8bbd-34fb1750798c'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '937617D5-01E9-5A39-B52D-15D5C143260C'],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '提交联系流',
'summary' => '提交联系流。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"937617D5-01E9-5A39-B52D-15D5C143260C\\"\\n}","type":"json"}]',
],
'CompleteAttendedTransfer' => [
'summary' => '调用CompleteAttendedTransfer完成咨询转。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '发起咨询转接的坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'ContextId' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '103652'],
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'Index' => ['description' => '系统自增ID,客户不用关注。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'ANSWERED',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'],
'example' => 'MONITORING',
],
'SkillGroupId' => ['description' => '话务通道关联的技能组ID,呼入场景下,关联的技能组ID由IVR中转人工模块配置的技能组决定,呼出场景下,关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'."\n"],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'],
'JobId' => ['description' => '在呼叫状态时的通话ID。', 'type' => 'string', 'example' => 'job-65382141036853491'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'TALKING',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''],
['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作,用户状态不符合预期。'],
],
404 => [
['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'],
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'],
],
],
'title' => '完成咨询转接',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-10-26T08:13:48.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CompleteAttendedTransfer'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103652,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\\\n\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-65382141036853491\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>10</Index>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'CreateAudioFile' => [
'summary' => '调用CreateAudioFile在指定实例下创建一个音频资源,创建好的音频资源可以在实例中应用,比如在IVR放音时可以选择创建好的音频文件。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccKYIENB'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '音频展示名,长度为1-32的字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '欢迎语'],
],
[
'name' => 'AudioFileName',
'in' => 'query',
'schema' => ['description' => '音频文件名称,长度为1-32个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-file.wav'],
],
[
'name' => 'OssFileKey',
'in' => 'query',
'schema' => ['description' => 'OSS文件的Key,由GetAudioFileUploadParameters接口返回。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test/test-file.wav'],
],
[
'name' => 'Usage',
'in' => 'query',
'schema' => ['description' => '音频文件用途,默认为General(用于IVR等场景), 其他可选值为HoldMusic(通话保持等待音)。', 'type' => 'string', 'required' => false, 'example' => 'General'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => ['description' => '数据,音频资源的ID,唯一标识一个音频资源。', 'type' => 'string', 'example' => '2301b83f-1f9f-491e-9f97-2f832ed92f0b'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '94E29B9B-DBC6-5951-B3DD-C85C1BDF20ED'],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '创建音频文件',
'changeSet' => [
['createdAt' => '2023-11-22T01:05:25.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAudioFile'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"2301b83f-1f9f-491e-9f97-2f832ed92f0b\\",\\n \\"RequestId\\": \\"94E29B9B-DBC6-5951-B3DD-C85C1BDF20ED\\"\\n}","type":"json"}]',
],
'CreateCallSummary' => [
'summary' => '使用CreateCallSummary创建会话小结。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'CustomerId',
'in' => 'query',
'schema' => ['title' => '客户ID', 'description' => '客户ID', 'type' => 'string', 'required' => false, 'example' => '51e155ce-3747-*****-b402-13c69597b920'],
],
[
'name' => 'Context',
'in' => 'query',
'schema' => ['title' => 'summary信息', 'description' => 'summary信息', 'type' => 'string', 'required' => false, 'example' => '{"summaryTitle":"标题","summaryContent":"内容","keywords":"关键信息"}'],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => ['title' => '会话ID', 'description' => '会话ID', 'type' => 'string', 'required' => false, 'example' => 'job-522327189435260928'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'CreateTicketResponse',
'description' => 'CreateTicketResponse',
'type' => 'object',
'properties' => [
'Data' => ['description' => '数据,小结ID。', 'type' => 'string', 'example' => 'c58b9719-3bc3-441d-a4d3-fc0309ef7066'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8707EB29-BAED-4302-B999-40BA61877437'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '创建会话小结',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"c58b9719-3bc3-441d-a4d3-fc0309ef7066\\",\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
],
'CreateCallTags' => [
'summary' => '调用CreateCallTags在指定实例下创建多个号码标签。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CallTagNameList',
'in' => 'query',
'schema' => ['description' => '号码标签名称列表,格式为JSON数组的字符串,数组元素是待创建的号码标签名称,号码标签名称的长度要求1-10个字符。', 'type' => 'string', 'required' => true, 'example' => '["TagA","TagB"]'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => [
'description' => '创建失败的号码标签列表。',
'type' => 'array',
'items' => [
'description' => '创建失败的号码标签信息。',
'type' => 'object',
'properties' => [
'Item' => ['description' => '创建失败的号码标签的名称。', 'type' => 'string', 'example' => 'TagC'],
'Reason' => [
'description' => '号码标签创建失败原因。',
'type' => 'string',
'enumValueTitles' => ['CALL_TAG_NAME_DUPLICATED' => '传入的列表中存在重复项', 'CALL_TAG_NAME_INSERT_DUPLICATED' => '后台写入号码标签时存在重复项', 'CALL_TAG_NAME_ILLEGAL' => '传入的列表中存在格式不合法的号码标签'],
'example' => 'CALL_TAG_NAME_DUPLICATED',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'LimitExceed.CallTagsPerInstance', 'errorMessage' => 'The total number of call tag of the instance exceeds the limit %s.', 'description' => '号码标签数量超出单个实例的上限阈值。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
500 => [
['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'],
],
],
'title' => '创建多个号码标签',
'changeSet' => [
['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCallTags'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"Item\\": \\"TagC\\",\\n \\"Reason\\": \\"CALL_TAG_NAME_DUPLICATED\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<Message>无</Message>\\n<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Item>TagA</Item>\\n <Reason>CUSTOM_NUMBER_DUPLICATED</Reason>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'CreateCampaign' => [
'summary' => '调用CreateCampaign在指定实例下创建预测式外呼活动。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccQFUGXR'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CaseList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '预测式外呼名单列表,不能与CaseFileKey(从文件导入)同时使用,文件导入和列表导入只能选择一种。'."\n",
'type' => 'array',
'items' => [
'description' => '预测式外呼名单。',
'type' => 'object',
'properties' => [
'ReferenceId' => ['description' => '业务ID,客户业务系统标识,用于集成场景。', 'type' => 'string', 'required' => false, 'example' => '01'],
'PhoneNumber' => ['description' => '联系人电话号码。', 'type' => 'string', 'required' => false, 'example' => '1888888888'],
'CustomVariables' => ['description' => '客户自定义变量,格式为JSON对象,对象最多包含10个属性,每个属性的名称和值均由客户自定义。', 'type' => 'string', 'required' => false, 'example' => '{"name":"customer","客户标签":"tag"}'],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'QueueId',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动关联的技能组ID。', 'type' => 'string', 'required' => true, 'example' => 'skillgroup@ccc-test'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动名称。', 'type' => 'string', 'required' => true, 'example' => 'test-campaign'],
],
[
'name' => 'CaseFileKey',
'in' => 'query',
'schema' => ['description' => '预测式外呼名单文件,是一个OSS对象的Key,通过GetCaseFileUploadUrl接口获取。', 'type' => 'string', 'required' => false, 'example' => 'ccc-test/namelist.csv'],
],
[
'name' => 'ContactFlowId',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动关联的联系流ID。', 'type' => 'string', 'required' => true, 'example' => 'c1f2bc75-422e-43c7-9c9d9d95633a'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动开始时间,格式为Unix时间戳,单位毫秒。', 'type' => 'string', 'required' => true, 'example' => '1634140800000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动结束时间,格式为Unix时间戳,单位毫秒。', 'type' => 'string', 'required' => true, 'example' => '1634313600000'],
],
[
'name' => 'CallableTime',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动的可外呼时段,格式为JSON对象,对象包含两个属性,beginTime和EndTime,例如:[{"beginTime":"00:00:00","endTime":"23:00:00" }]。', 'type' => 'string', 'required' => true, 'example' => '[{"beginTime":"00:00:00","endTime":"23:00:00" }]'],
],
[
'name' => 'StrategyType',
'in' => 'query',
'schema' => [
'description' => '预测式外呼活动的策略模式。'."\n",
'type' => 'string',
'required' => true,
'enumValueTitles' => ['PACING' => '固定比例外呼,外呼数量=空闲坐席*比例。', 'PID' => '系统基于PID控制策略,自动调整外呼电话数量。'],
'example' => 'PACING',
'enum' => ['SP', 'PID', 'PACING', 'ASAP', 'CUSTOMIZED'],
],
],
[
'name' => 'StrategyParameters',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动的策略参数,PID策略下的格式参数示例:{"abandonRate":"5","historicalConnectedRate":"35"},PACING策略下的格式参数示例:{"ratio":1}。abandonRate表示期望呼损率,historicalConnectedRate表示历史参考接通率,ratio表示固定外呼比例。', 'type' => 'string', 'required' => true, 'example' => '{"ratio":1}'],
],
[
'name' => 'MaxAttemptCount',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动的最大尝试次数,表示当活动的号码呼叫失败时,最多重呼几次。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
[
'name' => 'MinAttemptInterval',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动的最小重呼间隔,表示失败重呼时的最小间隔,单位分钟。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
[
'name' => 'Simulation',
'in' => 'query',
'schema' => ['description' => '是否是模拟活动,用于测试,普通客户无需关心。', 'type' => 'boolean', 'required' => false, 'example' => '无', 'default' => 'false'],
],
[
'name' => 'SimulationParameters',
'in' => 'query',
'schema' => ['description' => '模拟参数,用于测试,普通客户无需关心。', 'type' => 'string', 'required' => false, 'example' => '无'],
],
[
'name' => 'ExecutingUntilTimeout',
'in' => 'query',
'schema' => ['description' => '是否在活动到期前保持执行状态。默认值fasle,当活动的所有联系人都呼叫完成后,活动会自动变为已完成状态;如果为True,当活动的所有联系人都呼叫完成后,活动不会自动变成已完成状态,仍是执行中状态,可以继续像活动中追加联系人,进而继续进行拨打,直到任务到期或手动终止。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'FlashSmsParameters',
'in' => 'query',
'schema' => ['title' => '闪信参数', 'description' => '闪信参数', 'type' => 'string', 'required' => false, 'example' => '{"applicationId":"08e6b63a-****-****-****-689a288cdbb5","templateId":"325"}'],
],
[
'name' => 'NumberList',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '主叫号码列表',
'description' => '主叫号码列表',
'type' => 'array',
'items' => ['title' => '号码', 'description' => '号码', 'type' => 'string', 'required' => false, 'example' => '01012345678'],
'required' => false,
],
],
[
'name' => 'InstGroupId',
'in' => 'query',
'schema' => ['title' => '号码集合ID', 'description' => '号码集合ID', 'type' => 'string', 'required' => false, 'example' => '0d368091-2c70-4d26-979a-6997ddc9c34f'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE315'],
'Data' => ['title' => 'campaign id', 'description' => '预测式外呼活动ID。', 'type' => 'string', 'example' => 'c58b9719-3bc3-441d-a4d3-fc0309ef7066'],
'Code' => ['title' => 'code', 'description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['title' => 'message', 'description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\",\\n \\"Data\\": \\"c58b9719-3bc3-441d-a4d3-fc0309ef7066\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"<CreateCampaignResponse>\\n <RequestId>7CC6523B-0E51-1B62-8DA5-6A9831CAE315</RequestId>\\n <CampaignId>6badb397-a8b5-40b6-21019d382a09</CampaignId>\\n <Code>OK</Code>\\n <Message>无</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n</CreateCampaignResponse>","errorExample":""}]',
'title' => '创建预测式外呼活动',
'changeSet' => [
['createdAt' => '2021-12-21T04:35:33.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCampaign'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'CreateChatMediaUrl' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '263385',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'MimeType',
'in' => 'formData',
'schema' => ['title' => 'media id', 'description' => 'media id', 'type' => 'string', 'required' => true, 'example' => 'jpg'],
],
[
'name' => 'RequestId',
'in' => 'formData',
'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '9F766284-F103-4298-8EC5-19F9F9BE5522'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '云联络中心实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'GetChatMediaUrlResponse',
'description' => 'GetChatMediaUrlResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'MediaId' => ['description' => '媒体ID。', 'type' => 'string', 'example' => '$iAHNCNQCo21wMwMGBAAFAAbaACOEAaQhIH6TAqogDGyb-qD2Hbj0A88AAAGRLKYVnwTOACwwYwcACM8AAAGRLRPynQ'],
'Url' => ['description' => '文件url', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/namelist.csv?Expires=1642067227&OSSAccessKeyId=****&Signature=****'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'],
'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '[\'OFFLINE\', \'BREAK,READY,WORKING\']'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"MediaId\\": \\"$iAHNCNQCo21wMwMGBAAFAAbaACOEAaQhIH6TAqogDGyb-qD2Hbj0A88AAAGRLKYVnwTOACwwYwcACM8AAAGRLRPynQ\\",\\n \\"Url\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/namelist.csv?Expires=1642067227&OSSAccessKeyId=****&Signature=****\\"\\n },\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"[\'OFFLINE\', \'BREAK,READY,WORKING\']\\"\\n ]\\n}","type":"json"}]',
'title' => '获取媒体文件上传地址',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'CreateContactFlow' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '联系流名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '默认流程'],
],
[
'name' => 'Definition',
'in' => 'query',
'schema' => ['description' => 'IVR的内容。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"activities":[{"type":"INCOMING_CALL","id":"e98f0d47","name":"开始","properties":{"position":{"x":263,"y":164}},"events":[{"event":"complete","next":"2d3ad2c2","edgeId":"41f7dbd0"}],"nodeIndex":0},{"type":"HANGUP","id":"bd4f37e2","name":"挂机","properties":{"position":{"x":765,"y":185}},"events":[{"event":"complete","next":null}],"nodeIndex":999},{"type":"PLAY_SAY","id":"2d3ad2c2","name":"放音","properties":{"say":"您好,欢迎来到云联络中心。","audioResourceId":"","position":{"x":485.5,"y":153.5},"audioType":"tts","audioInterrupt":false},"events":[{"event":"complete","next":"bd4f37e2","edgeId":"e1af4f1f"}],"nodeIndex":1}],"description":""}'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '版本描述。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['description' => '流程类型。 '."\n"
.'主流程:MAIN\\_FLOW '."\n"
.'子流程:SUB\\_FLOW '."\n"
.'满意度流程:SURVEY\\_FLOW', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MAIN_FLOW'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'Data' => ['description' => 'IVR联系流ID。', 'type' => 'string', 'example' => '78128960-bb00-4ddc-8e82-923a8c5bd22d'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5'],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"78128960-bb00-4ddc-8e82-923a8c5bd22d\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\"\\n}","type":"json"}]',
'title' => '创建联系流',
'summary' => '创建一个IVR流程。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateContactFlow'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'CreateCustomCallTagging' => [
'summary' => '调用CreateCustomCallTagging在指定实例下创建一个或多个呼入号码标记。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CustomNumberList',
'in' => 'query',
'schema' => ['description' => '呼入控制标记列表,格式为JSON数组的字符串,要求数组元素个数范围为1-10000。数组的元素是一个对象,包括以下属性:number(格式要求为4-32位的数字)、description、callTagNameList,其中callTagNameList是一个数组,元素是号码标签,(确保号码标签是已创建的号码标签)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"number":"1312121****","description":"王先生","callTagNameList":["TagA"]},{"number":"1388888****","description":"张先生","callTagNameList":["TagB"]}]'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => [
'description' => '创建失败的呼入号码标记列表。',
'type' => 'array',
'items' => [
'description' => '创建失败的呼入号码标记信息。',
'type' => 'object',
'properties' => [
'Item' => ['description' => '创建失败的呼入号码标记的号码。', 'type' => 'string', 'example' => '1312121****'],
'Reason' => [
'description' => '呼入号码标记创建失败原因。',
'type' => 'string',
'enumValueTitles' => ['CUSTOM_NUMBER_ILLEGAL' => '传入的列表中存在格式不合法的号码', 'CUSTOM_NUMBER_DUPLICATED' => '传入的列表中存在重复的号码', 'CUSTOM_NUMBER_ALREADY_EXISTS' => '传入的列表中存在已创建的号码标记', 'CUSTOM_NUMBER_TAG_NOT_EXIST' => '传入的列表中存在未创建的号码标签', 'CUSTOM_NUMBER_INSERT_DUPLICATED' => '后台写入呼入号码标记时存在重复项', 'CUSTOM_NUMBER_TOO_MANY_TAGS' => '传入的列表中存在超出号码标签个数上限的号码'],
'example' => 'CUSTOM_NUMBER_DUPLICATED',
],
],
'enumValueTitles' => [],
],
],
],
'enumValueTitles' => [],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.RamId', 'errorMessage' => 'RAM user %s does not exist.', 'description' => '指定的RAM用户不存在。'],
],
409 => [
['errorCode' => 'AlreadyExists.CustomNumber', 'errorMessage' => 'Custom number already exists.', 'description' => '呼入号码标记已存在。'],
],
500 => [
['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'],
],
],
'staticInfo' => [
'substitutions' => ['CCC::2020-07-01::CreateCustomCallTaggings'],
],
'title' => '创建多个呼入号码标记',
'changeSet' => [
['createdAt' => '2022-02-24T14:31:19.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomCallTagging'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"Item\\": \\"1312121****\\",\\n \\"Reason\\": \\"CUSTOM_NUMBER_DUPLICATED\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<Message>无</Message>\\n<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Item>TagA</Item>\\n <Reason>CUSTOM_NUMBER_DUPLICATED</Reason>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'CreateInstance' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeNodes' => ['FEATUREcccTMAX45'],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '实例名称,长度4-32个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试实例'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '实例的描述,长度不超过256个字符。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '云联络中心的测试实例。'],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => ['description' => '云联络中心实例的二级域名,即实例ID,全局唯一。长度为4-48个字符,仅可包含大小写英文字母、数字、下划线(_)和短横线(-)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'NumberList',
'in' => 'query',
'schema' => ['description' => '待创建的云联络中心实例的号码列表,要求当前账户拥有号码使用权且号码未被其他实例使用。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["0830011xxxx", "0830312xxxx"]'],
],
[
'name' => 'AdminRamIdList',
'in' => 'query',
'schema' => ['description' => '作为该云联络中心实例管理员的RAM ID列表,成功创建后,该列表下的RAM ID将自动以管理员的身份导入到新创建的实例中。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["24861380681070****","105980354482****"]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => ['description' => '数据,返回的是后台创建实例的工作流的ID。', 'type' => 'string', 'example' => '75c1346c-1dc2-4ed8-973f-edf8b1e5fe77'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5'],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.Number', 'errorMessage' => 'The specified number %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的号码。'],
],
409 => [
['errorCode' => 'AlreadyExists.InstanceId', 'errorMessage' => 'The instance %s already exists.', 'description' => '云联络中心实例已存在。'],
],
],
'title' => '创建实例',
'summary' => '调用CreateInstance创建一个云联络中心实例。',
'changeSet' => [
['createdAt' => '2025-10-28T09:55:19.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"75c1346c-1dc2-4ed8-973f-edf8b1e5fe77\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\"\\n}","type":"json"}]',
],
'CreateSchema' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => false, 'example' => 'profile'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '信息描述', 'type' => 'string', 'required' => false, 'example' => '-'],
],
[
'name' => 'Properties',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '字段列表',
'type' => 'array',
'items' => [
'description' => '字段列表',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '坐席展示名。', 'type' => 'string', 'required' => false, 'example' => '显示名称'],
'Description' => ['description' => '版本描述。', 'type' => 'string', 'required' => false, 'example' => '-'],
'Name' => ['description' => '名称。', 'type' => 'string', 'required' => true, 'example' => 'name'],
'DataType' => ['description' => '数据类型', 'type' => 'string', 'required' => true, 'example' => 'string'],
'Pattern' => ['description' => '正则表达式校验规则', 'type' => 'string', 'required' => false, 'example' => '*'],
'PatternErrorMessage' => ['description' => '正则表达式校验错误提示信息', 'type' => 'string', 'required' => false, 'example' => '错误的格式'],
'MinLength' => ['description' => '最小长度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'MaxLength' => ['description' => '最大长度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
'Minimum' => ['description' => '数字最小值', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1'],
'Maximum' => ['description' => '数字最大值', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1'],
'Required' => ['description' => '是否必填', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
'Disabled' => ['description' => '是否被禁用', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
'Array' => ['description' => '是否是数组', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
'ReadOnly' => ['description' => '是否只读', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'EditorType' => ['description' => '编辑器类型', 'type' => 'string', 'required' => false, 'example' => 'textbox'],
'Attributes' => ['description' => '扩展属性', 'type' => 'string', 'required' => false, 'example' => '{\'Clusters\': {\'Description\': \'The list of clusters.\'}, \'ClusterIds\': {\'Description\': \'The list of cluster IDs.\'}}'],
'DisplayOrder' => ['description' => '列表展示顺序', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'RequestId',
'in' => 'formData',
'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'CreateSchemaResponse',
'description' => 'CreateSchemaResponse',
'type' => 'object',
'properties' => [
'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '1ca2b084-6f0a-454b-9851-29768a9a5832'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9F766284-F103-4298-8EC5-19F9F9BE5522'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"1ca2b084-6f0a-454b-9851-29768a9a5832\\",\\n \\"RequestId\\": \\"9F766284-F103-4298-8EC5-19F9F9BE5522\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '创建Schema',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'CreateSkillGroup' => [
'summary' => '调用CreateSkillGroup在指定实例下创建一个技能组。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccPBOQGO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '技能组名称,长度为1-64个字符,可以包含数字、字母、下划线(_)、短横线(-),必须以字母开头。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup'],
],
[
'name' => 'DisplayName',
'in' => 'query',
'schema' => ['description' => '技能组展示名,长度为1-64个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试技能组'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '技能组的描述,非必填,不填默认为空。', 'type' => 'string', 'required' => false, 'example' => '云联络中心的测试技能组。'],
],
[
'name' => 'MediaType',
'in' => 'query',
'schema' => ['description' => '媒体类型,默认是语音(AUDIO), 其他可选参数包括CHAT和VIDEO。', 'type' => 'string', 'required' => false, 'example' => 'CHAT'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Description' => ['description' => '技能组的描述。', 'type' => 'string', 'example' => '云联络中心的测试技能组。'],
'Name' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'],
'SkillGroupId' => ['description' => '技能组ID,格式为:技能组名称@实例ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'MediaType' => ['description' => '媒体类型,默认是语音(AUDIO), 其他可选参数包括CHAT和VIDEO。', 'type' => 'string', 'example' => 'VIDEO'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
409 => [
['errorCode' => 'AlreadyExists.SkillGroupId', 'errorMessage' => 'Skill group %s already exists in instance %s.', 'description' => '云联络中心实例中已经存在指定的技能组。'],
],
500 => [
['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'],
],
],
'title' => '创建技能组',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-06T05:44:50.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSkillGroup'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"Name\\": \\"skillgroup\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"MediaType\\": \\"VIDEO\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Description>测试</Description>\\n <InstanceId>ccc-test</InstanceId>\\n <SkillGroupId>skg-test@ccc-test</SkillGroupId>\\n <Name>test</Name>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'CreateTicket' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => ['description' => '工单模板ID。', 'type' => 'string', 'required' => false, 'example' => 'e9e4c76c-948d-4a6e-9ce2-9da0f5967a73'],
],
[
'name' => 'CustomerId',
'in' => 'query',
'schema' => ['description' => '客户ID,云联络中心客户资料中的客户ID。', 'type' => 'string', 'required' => false, 'example' => '51e155ce-3747-4f21-b402-13c69597b920'],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => ['description' => '工单标题。', 'type' => 'string', 'required' => false, 'example' => '售后工单。'],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => ['description' => '工单来源。', 'type' => 'string', 'required' => false, 'example' => 'CHAT'],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => false, 'example' => 'job-38860977107324****'],
],
[
'name' => 'Context',
'in' => 'query',
'schema' => ['description' => '工单字段信息。', 'type' => 'string', 'required' => false, 'example' => '{"productName":"玩具1"}'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A450574A-337F-43E2-BC59-9C6594C994C6'],
'Data' => ['description' => '返回数据,工单ID。', 'type' => 'string', 'example' => '3d26b90a-c5d2-4b09-8219-60cda1******'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''],
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"A450574A-337F-43E2-BC59-9C6594C994C6\\",\\n \\"Data\\": \\"3d26b90a-c5d2-4b09-8219-60cda1******\\"\\n}","type":"json"}]',
'title' => '创建工单',
'summary' => '使用CreateTicket创建工单。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'CreateUser' => [
'summary' => '调用CreateUser在指定实例下创建一个新的坐席。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'LoginName',
'in' => 'query',
'schema' => ['description' => '坐席登录名,长度为4-64个字符,可包含英文大小写字母、数字、英文句点“.”、下划线“_”或短划线“-”。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent'],
],
[
'name' => 'DisplayName',
'in' => 'query',
'schema' => ['description' => '坐席展示名,长度为1-128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '坐席小王', 'maxLength' => 500, 'minLength' => 0],
],
[
'name' => 'Mobile',
'in' => 'query',
'schema' => ['description' => '坐席的个人电话号码,该号码在场外模式下会用到,坐席可以使用该号码进行场外模式接听。', 'type' => 'string', 'required' => false, 'example' => '1382114****'],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => ['description' => '坐席邮箱地址,坐席创建成功后会发送邮件到该邮箱,邮件中包含云联络中心登录地址,以及RAM账户的用户名和密码,请妥善保管。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com'],
],
[
'name' => 'WorkMode',
'in' => 'query',
'schema' => [
'description' => '工作模式。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
],
[
'name' => 'RoleId',
'in' => 'query',
'schema' => ['description' => '角色ID,格式为:角色@实例ID,包含三种角色:Admin(管理员)、Manager(技能组组长)、Agent(坐席)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Agent@ccc-test'],
],
[
'name' => 'SkillLevelList',
'in' => 'query',
'schema' => ['description' => '技能组的技能等级列表,格式为JSON数组的字符串,数组元素最大为100个,数组元素是一个对象,包含两个字段:skillGroupId和skillLevel,skillGroupId填写要添加的技能组ID,skillLevel填写要添加的技能等级,取值范围1-10,值越小,业务能力越强,单位时间内能处理更多的通话。', 'type' => 'string', 'required' => false, 'example' => '[{"skillGroupId":"skillgroup1@ccc-test","skillLevel":1},{"skillGroupId":"skillgroup2@ccc-test","skillLevel":10}]'],
],
[
'name' => 'ResetPassword',
'in' => 'query',
'schema' => ['description' => '首次登录时是否需要重置密码,如果为true,则在首次登录RAM账户时会提示重置密码,否则不提示。默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'DisplayId',
'in' => 'query',
'schema' => ['description' => '坐席的工号,客户可根据需要自行设置。', 'type' => 'string', 'required' => false, 'example' => '1001'],
],
[
'name' => 'AvatarUrl',
'in' => 'query',
'schema' => ['description' => '坐席头像地址。', 'type' => 'string', 'required' => false, 'example' => 'http://abc.com/sam.jpg'],
],
[
'name' => 'Nickname',
'in' => 'query',
'schema' => ['description' => '座席昵称。', 'type' => 'string', 'required' => false, 'example' => '老王'],
],
[
'name' => 'NeedEmailNotification',
'in' => 'query',
'schema' => ['title' => '是否需要邮件通知。'."\n"
.'- true: 发送'."\n"
.'- false: 不发送', 'description' => '是否需要邮件通知。'."\n"
.'- true: 发送'."\n"
.'- false: 不发送', 'type' => 'string', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '坐席展示名。', 'type' => 'string', 'example' => '坐席小王'],
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => 'username@example.com'],
'LoginName' => ['description' => '坐席登录名。', 'type' => 'string', 'example' => 'agent'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1382114****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'AvatarUrl' => ['description' => '坐席头像地址。', 'type' => 'string', 'example' => 'http://abc.com/sam.jpg'],
'Nickname' => ['description' => '座席昵称。', 'type' => 'string', 'example' => '老王。'],
],
],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'],
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
],
403 => [
['errorCode' => 'Permission.StsToken', 'errorMessage' => 'You have no permission to access sts token %s.', 'description' => '您无权访问STS Token。'],
],
[
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.RoleId', 'errorMessage' => 'Role %s does not exist.', 'description' => '指定的角色不存在。'],
],
409 => [
['errorCode' => 'AlreadyExists.User', 'errorMessage' => 'User %s already exists in instance %s.', 'description' => '云联络中心实例下已存在指定的用户。'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"Extension\\": \\"8032****\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"AvatarUrl\\": \\"http://abc.com/sam.jpg\\",\\n \\"Nickname\\": \\"老王。\\"\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <Extension>8032****</Extension>\\n <LoginName>user-test-1</LoginName>\\n <Email>1886666****@163.com</Email>\\n <UserId>user-test-1@ccc-test</UserId>\\n <DisplayName>云呼测试1</DisplayName>\\n <Mobile>1382114****</Mobile>\\n <WorkMode>ON_SITE</WorkMode>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
'title' => '创建坐席',
'description' => '创建坐席实际上就是创建一个RAM子账户,云联络中心的坐席与RAM子账户是相互映射的,所以创建时传入的参数就和创建RAM账户时类似,比如:LoginName就是RAM账号的登录名,Email就是创建RAM账号时预留的邮箱,该邮箱会接收到带有RAM账户初始登录密码的邮件。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-12-22T03:22:03.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-11-07T07:21:07.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2021-12-21T09:15:55.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUser'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'DeleteAudioFile' => [
'summary' => '调用DeleteAudioFile删除指定实例下指定音频资源ID对应的音频文件。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'AudioResourceId',
'in' => 'query',
'schema' => ['description' => '音频资源ID,音频文件的唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd5cd7a94-3b6a-47d2-b7fd-0b1cd839bf77'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FB77821C-912F-57FF-8834-6336A6479093'],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '删除音频文件',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAudioFile'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"FB77821C-912F-57FF-8834-6336A6479093\\"\\n}","type":"json"}]',
],
'DeleteCallTag' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'TagName',
'in' => 'query',
'schema' => ['description' => '号码标签名称,请确保传入的标签是已创建的号码标签。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TagA'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
500 => [
['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'],
],
],
'title' => '删除号码标签',
'summary' => '调用DeleteCallTag删除指定实例下的号码标签。',
'changeSet' => [
['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCallTag'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>无</Message>\\n<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]',
],
'DeleteContactFlow' => [
'summary' => '删除指定联系流。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccTPIKHY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'ContactFlowId',
'in' => 'query',
'schema' => ['description' => '联系流ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0f87c997-b0c1-41d4-9e9e-1b791de6ad1f'],
],
[
'name' => 'Force',
'in' => 'query',
'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '07511949-6DC4-5D0B-8FA8-FF8FA29B4217'],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '删除联系流',
'changeSet' => [
['createdAt' => '2025-06-18T03:18:59.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteContactFlow'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"07511949-6DC4-5D0B-8FA8-FF8FA29B4217\\"\\n}","type":"json"}]',
],
'DeleteCustomCallTagging' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ' ccc-test'],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => ['description' => '号码呼入标记的号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1312121****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
500 => [
['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'],
],
],
'title' => '删除呼入号码标记',
'summary' => '调用DeleteCustomCallTagging删除指定实例下指定号码对应的呼入号码标记。',
'changeSet' => [
['createdAt' => '2022-02-24T14:31:19.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomCallTagging'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>无</Message>\\n<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]',
],
'DeleteDocument' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'parameters' => [
[
'name' => 'SchemaId',
'in' => 'formData',
'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'],
],
[
'name' => 'DocumentId',
'in' => 'formData',
'schema' => ['description' => '文档ID', 'type' => 'string', 'required' => true, 'example' => 'xxx'],
],
[
'name' => 'RequestId',
'in' => 'formData',
'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE '],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'd278629c-c687-4aa3-b044-4fe9b012****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'DeleteDocumentResponse',
'description' => 'DeleteDocumentResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8707EB29-BAED-4302-B999-40BA61877437'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息'."\n"
."\n", 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '删除文档',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'DeleteDocuments' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'parameters' => [
[
'name' => 'SchemaId',
'in' => 'formData',
'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'],
],
[
'name' => 'DocumentIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '文档id列表',
'type' => 'array',
'items' => ['description' => '文档id', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
'required' => false,
],
],
[
'name' => 'RequestId',
'in' => 'formData',
'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'DeleteDocumentsResponse',
'description' => 'DeleteDocumentsResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A450574A-337F-43E2-BC59-9C6594C994C6'],
'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '参数信息。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A450574A-337F-43E2-BC59-9C6594C994C6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '删除文档(批量)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'DeleteInstance' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '251524',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => ['description' => '返回结果,删除任务ID。', 'type' => 'string', 'example' => 'b7feb007-994a-497f-8934-2f0c6f89867c'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"b7feb007-994a-497f-8934-2f0c6f89867c\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '删除实例',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'DeleteSchema' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'parameters' => [
[
'name' => 'SchemaId',
'in' => 'formData',
'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'],
],
[
'name' => 'RequestId',
'in' => 'formData',
'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'DeleteSchemaResponse',
'description' => 'DeleteSchemaResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '678F7002-CA01-4ABF-A112-585AFBDF3A3B'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"678F7002-CA01-4ABF-A112-585AFBDF3A3B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '删除Schema',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'DeleteSchemaProperty' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'parameters' => [
[
'name' => 'SchemaId',
'in' => 'formData',
'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'],
],
[
'name' => 'PropertyName',
'in' => 'formData',
'schema' => ['description' => '字段名', 'type' => 'string', 'required' => true, 'example' => 'name'],
],
[
'name' => 'RequestId',
'in' => 'formData',
'schema' => ['description' => '请求ID', 'type' => 'string', 'required' => false, 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'DeleteSchemaPropertyResponse',
'description' => 'DeleteSchemaPropertyResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'],
'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'User 244715989906081477 does not exist in instance worldfirst01.'],
'Params' => [
'description' => '错误参数信息',
'type' => 'array',
'items' => ['description' => '错误参数', 'type' => 'string', 'example' => 'id格式错误'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"User 244715989906081477 does not exist in instance worldfirst01.\\",\\n \\"Params\\": [\\n \\"id格式错误\\"\\n ]\\n}","type":"json"}]',
'title' => '删除Scheme字段',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'DeleteSkillGroup' => [
'summary' => '调用DeleteSkillGroup删除指定实例下指定技能组ID对应的技能组。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccPBOQGO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'],
],
[
'name' => 'Force',
'in' => 'query',
'schema' => ['description' => '是否强制删除,如果技能组关联了号码或坐席,需要启用强制删除标志才能删除成功。', 'type' => 'boolean', 'required' => false, 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'example' => 'true', 'default' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
['errorCode' => 'InUse.SkillGroup', 'errorMessage' => 'Skill group %s is in use now.', 'description' => '技能组正在被使用,该状态表明技能组可能关联着号码或坐席。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '删除技能组',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSkillGroup'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]',
],
'DeleteTicket' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'TicketId',
'in' => 'query',
'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => false, 'example' => '3d26b90a-c5d2-4b09-8219-********'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'DeleteTicketResponse',
'description' => 'DeleteTicketResponse',
'type' => 'object',
'properties' => [
'Data' => ['description' => '响应数据。', 'type' => 'any', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"2263B273-AC1B-44EB-BA98-87F2322C6780\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '删除工单',
'summary' => '通过DeleteTicket删除指定工单。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'DeleteTicketTemplate' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => ['description' => '工单模板ID。', 'type' => 'string', 'required' => false, 'example' => '**43c2671b-8939-4223-***-6bd187905cc8_1717664210492'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'DeleteTicketTemplateResponse',
'description' => 'DeleteTicketTemplateResponse',
'type' => 'object',
'properties' => [
'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '01B12EE4-6AF2-4730-8B78-EC15F4E5C025'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"01B12EE4-6AF2-4730-8B78-EC15F4E5C025\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '删除工单模板',
'summary' => '使用DeleteTicketTemplate删除指定工单模板。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'DisableSchemaProperty' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'parameters' => [
[
'name' => 'SchemaId',
'in' => 'formData',
'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'],
],
[
'name' => 'PropertyName',
'in' => 'formData',
'schema' => ['description' => '字段名', 'type' => 'string', 'required' => true, 'example' => 'name'],
],
[
'name' => 'RequestId',
'in' => 'formData',
'schema' => ['description' => '请求ID', 'type' => 'string', 'required' => false, 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'DisableSchemaPropertyResponse',
'description' => 'DisableSchemaPropertyResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71'],
'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '附加信息', 'type' => 'string', 'example' => 'User 244715989906081477 does not exist in instance worldfirst01.'],
'Params' => [
'description' => '参数信息。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '[\'userId\']'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"User 244715989906081477 does not exist in instance worldfirst01.\\",\\n \\"Params\\": [\\n \\"[\'userId\']\\"\\n ]\\n}","type":"json"}]',
'title' => '禁用Schema字段',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'DisableTicketTemplate' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => ['description' => '工单模板ID。', 'type' => 'string', 'required' => false, 'example' => '43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'DisableTicketTemplateResponse',
'description' => 'DisableTicketTemplateResponse',
'type' => 'object',
'properties' => [
'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '下线工单模板',
'summary' => '使用DisableTicketTemplate进行工单模板的下线操作,下线状态的模板在新建工单时不能被选中。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'DiscardEditingContactFlow' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'ContactFlowId',
'in' => 'query',
'schema' => ['description' => '联系流ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3ff4e021-fd63-4572-ad8c-10ed69972965'],
],
[
'name' => 'DraftId',
'in' => 'query',
'schema' => ['description' => '草稿ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0aa493d6-58eb-4290-9ba2-e1c2c615b46b'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CB72B537-B531-598F-9617-A636FB8040C0'],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"CB72B537-B531-598F-9617-A636FB8040C0\\"\\n}","type":"json"}]',
'title' => '撤销联系流编辑',
'summary' => '撤销联系流编辑,丢弃对应草稿。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DiscardEditingContactFlow'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'EnableSchemaProperty' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'parameters' => [
[
'name' => 'SchemaId',
'in' => 'formData',
'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'],
],
[
'name' => 'PropertyName',
'in' => 'formData',
'schema' => ['description' => '字段名', 'type' => 'string', 'required' => true, 'example' => 'name'],
],
[
'name' => 'RequestId',
'in' => 'formData',
'schema' => ['description' => '请求ID', 'type' => 'string', 'required' => false, 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'EnableSchemaPropertyResponse',
'description' => 'EnableSchemaPropertyResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5'],
'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => 'The operation is not allowed. User state (READY) does not meet expectations (OFFLINE).'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '[\'wudi@zcwlwhkf\']'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"The operation is not allowed. User state (READY) does not meet expectations (OFFLINE).\\",\\n \\"Params\\": [\\n \\"[\'wudi@zcwlwhkf\']\\"\\n ]\\n}","type":"json"}]',
'title' => '启用Schema字段',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'EnableTicketTemplate' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => ['description' => '工单模板ID。', 'type' => 'string', 'required' => false, 'example' => '43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'EnableTicketTemplateResponse',
'description' => 'EnableTicketTemplateResponse',
'type' => 'object',
'properties' => [
'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '上线工单模板',
'summary' => '使用EnableTicketTemplate上线工单模板,上线中状态的工单模板,可以用于创建工单。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'EndConference' => [
'summary' => '调用EndConference使指定坐席退出指定实例下指定通话ID对应的通话,该通话必须处于会议状态。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '需要退出会议的坐席ID,选填,不填默认为当前RAM账户映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'example' => 'job-6538214103685****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'CREATED',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '8001****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:131888****->8001****:1609225718294:job-65700074013925376'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'DeviceState' => [
'description' => 'SIP话机设备的状态,如果未注册SIP话机,则状态为UNREGISTERED(未注册),如过SIP话机注册过但是不在线,则状态为OFFLINE(离线),如果SIP话机注册过并且在线则为ONLINE(在线)。',
'type' => 'string',
'enumValueTitles' => ['UNREGISTERED' => '未注册', 'OFFLINE' => '离线', 'ONLINE' => '在线'],
'example' => 'UNREGISTERED',
],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'TALKING',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
'ContextId' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '103655'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '退出会议',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EndConference'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"0630E5DF-CEB0-445B-8626-D5C7481181C3\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609225718294:job-65700074013925376\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"DeviceState\\": \\"UNREGISTERED\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n },\\n \\"ContextId\\": 103655\\n }\\n}","type":"json"}]',
],
'ExportContactFlow' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '251084',
'abilityTreeNodes' => ['FEATUREcccTPIKHY'],
],
'parameters' => [
[
'name' => 'FlowId',
'in' => 'formData',
'schema' => ['description' => 'IVR联系流ID。', 'type' => 'string', 'required' => true, 'example' => 'lc-uf61xdtm0mf73k'],
],
[
'name' => 'RequestId',
'in' => 'formData',
'schema' => ['description' => '请求ID', 'type' => 'string', 'required' => false, 'example' => 'AF9834D8-6D09-4A1B-BADB-B019D9D444C8'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ExportFlowResponse',
'description' => 'ExportFlowResponse',
'type' => 'object',
'properties' => [
'FlowPackageData' => ['description' => '数据', 'type' => 'string', 'example' => '{}'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE '],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FlowPackageData\\": \\"{}\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\\\t\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '导出IVR流程',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ExportCustomCallTagging' => [
'summary' => '调用ExportCustomCallTagging导出指定实例下的全部呼入号码标记。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'Data' => ['description' => '数据,导出结果所在的OSS的下载链接,链接有效期为24小时。', 'type' => 'string', 'example' => 'http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/tagging.xlsx ?Expires=1610910578&OSSAccessKeyId=****&Signature=****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F
'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'staticInfo' => [
'substitutions' => ['CCC::2020-07-01::ExportCustomCallTaggings'],
],
'title' => '导出呼入号码标记',
'changeSet' => [
['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportCustomCallTagging'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/tagging.xlsx ?Expires=1610910578&OSSAccessKeyId=****&Signature=****\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F
\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F
</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/tagging.xlsx ?Expires=1610910578&OSSAccessKeyId=KZEA4GDDtCg431rmXTiEhr1q&Signature=4bXjOtUYgXl2z9iWpk3tXxS8SGY%3D</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ExportDoNotCallNumbers' => [
'summary' => '调用ExportDoNotCallNumbers导出指定实例下指定搜索条件过滤后的禁止外呼号码列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SearchPattern',
'in' => 'query',
'schema' => ['description' => '根据号码或者备注进行模糊匹配,非必填,默认为空,为空表示不过滤。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RemarkA'],
],
[
'name' => 'Scope',
'in' => 'query',
'schema' => [
'description' => '应用范围,包括SYSTEM和INSTANCE,分别对应系统级禁止外呼和客户自定义禁止外呼,SYSTEM是关联实例所属的阿里云主账号的,INSTANCE只和当前实例关联,非必填,默认值INSTANCE。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['SYSTEM' => '系统级禁止外呼配置', 'INSTANCE' => '实例级禁止外呼配置'],
'example' => 'INSTANCE',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => ['description' => '数据,导出结果的OSS下载链接,链接有效期24小时。', 'type' => 'string', 'example' => 'https://****.oss-cn-shanghai.aliyuncs.com/ccc-test/blacklist.xlsx?Expires=3294624578&OSSAccessKeyId=****&Signature=****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'Params' => [
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '导出禁止外呼号码',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-06T05:44:50.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportDoNotCallNumbers'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"https://****.oss-cn-shanghai.aliyuncs.com/ccc-test/blacklist.xlsx?Expires=3294624578&OSSAccessKeyId=****&Signature=****\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/temp/blacklist/export/157724711549xxxx/ccc-test/Tue%20Mar%2015%2010%3A14%3A48%20CST%202022/blacklist.xlsx?Expires=3294624578&OSSAccessKeyId=XXXX&Signature=XXXX</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'FinishTicketTask' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'TicketId',
'in' => 'query',
'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => false, 'example' => 'f2c6722b-cd13-442d-bf10-22a07c70d6d5'],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '节点ID。', 'type' => 'string', 'required' => false, 'example' => 'b52a34dc-f514-4600-9c39-3cf657167c97'],
],
[
'name' => 'Comment',
'in' => 'query',
'schema' => ['description' => '处理意见。', 'type' => 'string', 'required' => true, 'example' => '同意'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'FinishTicketTaskResponse',
'description' => 'FinishTicketTaskResponse',
'type' => 'object',
'properties' => [
'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '工单处理',
'summary' => '使用FinishTicketTask对工单进行处理。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'GetAudioFile' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccKYIENB'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'AudioResourceId',
'in' => 'query',
'schema' => ['description' => '音频资源ID,音频文件的唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c1a06b46-302a-4c6e-928b-a43c0df485cf'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => 'EEE26562-D921-5CB2-AE49-E4C45A42D432'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => [
'description' => '音频文件数据。',
'type' => 'object',
'properties' => [
'AudioFileName' => ['description' => '音频文件名称。', 'type' => 'string', 'example' => 'test-file.wav'],
'OssFileKey' => ['description' => '音频资源文件在OSS中的Key。', 'type' => 'string', 'example' => 'ccc-test/test-file.wav'],
'UpdatedTime' => ['description' => '音频资源的最后修改时间。', 'type' => 'string', 'example' => '2021-07-14 10:48:43.0'],
'AudioResourceId' => ['description' => '音频资源ID,音频文件的唯一标识。', 'type' => 'string', 'example' => 'c1a06b46-302a-4c6e-928b-a43c0df485cf'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Name' => ['description' => '音频展示名。', 'type' => 'string', 'example' => '欢迎语'."\n"],
'CreatedTime' => ['description' => '音频资源的创建时间。', 'type' => 'string', 'example' => '2021-07-14 10:48:43.0'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取音频文件',
'summary' => '调用GetAudioFile获取指定实例下指定音频资源ID对应的音频文件信息。',
'changeSet' => [
['createdAt' => '2022-06-30T02:20:46.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAudioFile'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"EEE26562-D921-5CB2-AE49-E4C45A42D432\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"AudioFileName\\": \\"test-file.wav\\",\\n \\"OssFileKey\\": \\"ccc-test/test-file.wav\\",\\n \\"UpdatedTime\\": \\"2021-07-14 10:48:43.0\\",\\n \\"AudioResourceId\\": \\"c1a06b46-302a-4c6e-928b-a43c0df485cf\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"欢迎语\\\\n\\",\\n \\"CreatedTime\\": \\"2021-07-14 10:48:43.0\\"\\n }\\n}","type":"json"}]',
],
'GetAudioFileDownloadUrl' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'AudioResourceId',
'in' => 'query',
'schema' => ['description' => '音频资源ID,唯一标识一个音频文件。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acc300c4-75c9-41ba-ba5e-2a365c96c248'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => ['description' => '数据,音频资源文件的OSS下载链接,请注意,下载链接的有效期为24小时,请勿长期存储该链接。', 'type' => 'string', 'example' => 'https://****.oss-cn-shanghai.aliyuncs.com/ccc-test/****.wav?Expires=1656472158&OSSAccessKeyId=****&Signature=****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"https://****.oss-cn-shanghai.aliyuncs.com/ccc-test/****.wav?Expires=1656472158&OSSAccessKeyId=****&Signature=****\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\"\\n}","type":"json"}]',
'title' => '获取音频文件下载链接',
'summary' => '调用GetAudioFileDownloadUrl获取指定实例下指定音频资源的OSS下载链接。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAudioFileDownloadUrl'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'GetAudioFileUploadParameters' => [
'summary' => '调用GetAudioFileUploadParameters获取音频文件上传参数,创建音频文件时,需要先调用该接口拿到上传参数,然后再调用CreateAudioFile创建音频文件。该接口通常由云联络中心提供的公有云默认CRM系统调用,不建议集成客户调用该接口,因为需要在页面上操作上传文件,上传完成后,才能调用GetAudioFileUploadParameters接口。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccKYIENB'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'AudioFileName',
'in' => 'query',
'schema' => ['description' => '音频文件名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-file.wav'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C81FD1A5-4B99-470A-A527-D80150228784'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'FilePath' => ['description' => 'OSS文件的Key。', 'type' => 'string', 'example' => 'ccc-test/test-file.wav'],
'Signature' => ['description' => '文件上传临时凭证的签名信息,用于上传时验证合法性。', 'type' => 'string', 'example' => 'HIyClras8IcVlbTV7RIJWJbU****'],
'Host' => ['description' => 'OSS的接入域名。', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com'],
'Policy' => ['description' => '签名策略。', 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyMi0wNi0yOVQwMDoyOTowMC42NTRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiYXVkaW8vMTU3NzI0NzExNTQ5MDQwMS9seS1vbmxpbmUvMjAyMjA2MjkwNzI5MDAvIl1d****'],
'ExpireTime' => ['description' => '过期时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '1647313420'],
'AccessKeyId' => ['description' => '签名使用的AccessKeyId。', 'type' => 'string', 'example' => '****'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取音频文件上传参数',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAudioFileUploadParameters'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"C81FD1A5-4B99-470A-A527-D80150228784\\",\\n \\"Data\\": {\\n \\"FilePath\\": \\"ccc-test/test-file.wav\\",\\n \\"Signature\\": \\"HIyClras8IcVlbTV7RIJWJbU****\\",\\n \\"Host\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyMi0wNi0yOVQwMDoyOTowMC42NTRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiYXVkaW8vMTU3NzI0NzExNTQ5MDQwMS9seS1vbmxpbmUvMjAyMjA2MjkwNzI5MDAvIl1d****\\",\\n \\"ExpireTime\\": 1647313420,\\n \\"AccessKeyId\\": \\"****\\"\\n }\\n}","type":"json"}]',
],
'GetCallDetailRecord' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc5HY0NN'],
],
'parameters' => [
[
'name' => 'ContactId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-10963442671187****'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'ReleaseInitiator' => [
'description' => '挂断方。',
'type' => 'string',
'enumValueTitles' => ['agent ' => '坐席', 'customer ' => '客户'],
'example' => 'customer',
],
'ContactDisposition' => [
'description' => '电话结束原因,注意:语音邮箱、转人工失败、排队超时、排队溢出、IVR异常的挂断原因需要客户配置挂断原因节点才能体现出来,如果没有配置且IVR中无转人工模块,这时候的挂断原因默认为IVR放弃。',
'type' => 'string',
'enumValueTitles' => [
'AbandonedInQueue' => '排队放弃', 'NoAnswer' => '客户未接', 'QueuingTimeout' => '排队超时', 'Voicemail' => '转语音邮箱', 'QueuingFailed' => '转人工失败', 'QueuingOverflow' => '排队溢出', 'AbandonedInVoiceNavigator' => '智能导航中放弃', 'Success' => '正常结束', 'IVRException' => 'IVR系统异常', 'AbandonedInRing' => '振铃放弃',
'AbandonedInIVR' => 'IVR放弃', 'Reject' => '客户拒接', 'ForwardToOutsideNumber' => '转外线',
],
'example' => 'Success',
],
'ContactType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => ['INBOUND' => '呼入', 'CONFERENCE' => '会议', 'INTERNAL' => '内部呼叫', 'PRIVACY_DIAL' => '加密通话', 'OUTBOUND' => '呼出', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼'],
'example' => 'OUTBOUND',
],
'AgentIds' => ['description' => '坐席ID列表,表示通话流经的坐席,多个值用逗号分隔。', 'type' => 'string', 'example' => 'agent1@ccc-test,agent2@ccc-test'],
'CallDuration' => ['description' => '通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
'RecordingReady' => ['description' => '录音是否已经生成,若通话还没有建立,返回false。', 'type' => 'boolean', 'example' => 'true'],
'EstablishedTime' => ['description' => '通话建立的时间,如果通话没有建立,此值为空,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532458000000'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'SatisfactionSurveyOffered' => ['description' => '是否发送了满意度调查。', 'type' => 'boolean', 'example' => 'true'],
'CalledNumber' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '1332315****'],
'AgentNames' => ['description' => '坐席名称列表,表示通话流经的坐席,多个值用逗号隔开。', 'type' => 'string', 'example' => 'agent1,agent2'],
'Satisfaction' => ['description' => '满意度结果,满意度的取值及含义由客户自定义。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'StartTime' => ['description' => '通话开始时间,呼入从进入IVR开始,呼出从开始接通计算,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532458000000'],
'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-10963442671187****'],
'SatisfactionSurveyChannel' => [
'description' => '发起满意度调查的渠道。',
'type' => 'string',
'enumValueTitles' => ['IVR' => '语音满意度', 'SMS' => '短信满意度'],
'example' => 'IVR',
],
'ReleaseTime' => ['description' => '通话结束时间,以参与通话的所有对象中最后一个挂断的时间为准,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532458000000'],
'CallingNumber' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '0533128****'],
'SkillGroupNames' => ['description' => '参与通话的座席所属的技能组名称,多个技能组以逗号分隔。', 'type' => 'string', 'example' => '测试技能组'],
'SkillGroupIds' => ['description' => '参与通话的座席所属的技能组ID,多个技能组以逗号分隔。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'AgentEvents' => [
'description' => '坐席事件列表。',
'type' => 'array',
'items' => [
'description' => '坐席事件。',
'type' => 'object',
'properties' => [
'AgentName' => ['description' => '坐席名称。', 'type' => 'string', 'example' => '坐席小王'],
'AgentId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'EventSequence' => [
'description' => '事件序列。',
'type' => 'array',
'items' => [
'description' => '事件。',
'type' => 'object',
'properties' => [
'Event' => [
'description' => '事件类型。',
'type' => 'string',
'enumValueTitles' => [
'Released' => '挂机', 'BlindTransfer' => '直接转接', 'Coaching' => '辅导', 'Barging' => '强插', 'Consulting' => '咨询转接', 'Ringing' => '振铃', 'StartConference' => '开始会议', 'Established' => '通话建立', 'Dialing' => '拨号', 'Intercepting' => '强拆',
'Monitoring' => '监控',
],
'example' => 'Dialing',
],
'EventTime' => ['description' => '事件发生时间戳,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000'],
'Duration' => ['description' => '时间的持续时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
],
],
],
],
],
],
'IvrEvents' => [
'description' => 'IVR事件列表。',
'type' => 'array',
'items' => [
'description' => 'IVR事件。',
'type' => 'object',
'properties' => [
'FlowId' => ['description' => 'IVR联系流ID。', 'type' => 'string', 'example' => 'edaf2eaa-8f88-44ca-812e-41b3cd2b7a90'],
'EventSequence' => [
'description' => '事件序列。',
'type' => 'array',
'items' => [
'description' => '事件。',
'type' => 'object',
'properties' => [
'Event' => [
'description' => '事件类型。',
'type' => 'string',
'enumValueTitles' => ['Route2IVR' => '进入IVR', 'Abandoned' => 'IVR中放弃'],
'example' => 'Route2IVR',
],
'EventTime' => ['description' => '事件发生时间戳,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000'],
],
],
],
'FlowType' => [
'description' => '联系流类型。',
'type' => 'string',
'enumValueTitles' => ['SURVEY_FLOW' => '满意度流程', 'MAIN_FLOW' => '主流程'],
'example' => 'MAIN_FLOW',
],
],
],
],
'QueueEvents' => [
'description' => '队列事件列表。',
'type' => 'array',
'items' => [
'description' => '队列事件。',
'type' => 'object',
'properties' => [
'QueueId' => ['description' => '队列ID,如果是技能组队列,则为技能组ID,如果是坐席个人队列,则为坐席ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'QueueName' => ['description' => '队列名称。', 'type' => 'string', 'example' => '测试技能组'],
'FlowId' => ['description' => '联系流ID。', 'type' => 'string', 'example' => 'edaf2eaa-8f88-44ca-812e-41b3cd2b7a90'],
'QueueType' => [
'description' => '队列类型。',
'type' => 'integer',
'format' => 'int32',
'enumValueTitles' => [1 => '技能组', '坐席'],
'example' => '1',
],
'EventSequence' => [
'description' => '事件序列。',
'type' => 'array',
'items' => [
'description' => '事件。',
'type' => 'object',
'properties' => [
'Event' => [
'description' => '事件类型。',
'type' => 'string',
'enumValueTitles' => ['AssignAgent' => '分配坐席', 'GiveUp' => '振铃放弃', 'Enqueue' => '进队列', 'QueueingOverflow' => '排队溢出', 'Abandoned' => '队列放弃', 'QueueingTimeout' => '排队超时'],
'example' => 'Enqueue',
],
'EventTime' => ['description' => '事件发生时间戳,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000'],
],
],
],
],
],
],
'CustomerEvents' => [
'description' => '客户事件列表。',
'type' => 'array',
'items' => [
'description' => '客户事件。',
'type' => 'object',
'properties' => [
'CustomerId' => ['description' => '客户ID,通常为客户号码。', 'type' => 'string', 'example' => '1332315****'],
'EventSequence' => [
'description' => '事件序列。',
'type' => 'array',
'items' => [
'description' => '事件。',
'type' => 'object',
'properties' => [
'Event' => [
'description' => '事件类型。',
'type' => 'string',
'enumValueTitles' => ['established' => '通话建立', 'ringing' => '振铃', 'released' => '挂机'],
'example' => 'Released',
],
'EventTime' => ['description' => '事件发生时间戳,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532458000000'],
],
],
],
],
],
],
'CallerLocation' => ['description' => '主叫号码的归属地信息。', 'type' => 'string', 'example' => ' 山东省-淄博'],
'CalleeLocation' => ['description' => '被叫号码的归属地信息。', 'type' => 'string', 'example' => '河北省-唐山'],
'EarlyMediaState' => [
'description' => '早媒体状态,指通话在早媒体阶段发生异常,此时通常是呼叫客户的阶段,发生异常会导致呼叫客户失败,因此该状态是根据早媒体的状态分析出来的可能的未接通原因。',
'type' => 'string',
'enumValueTitles' => ['NoAnswer' => '无人接听', 'OutOfService' => '停机', 'NotExist' => '空号', 'Restricted' => '呼叫受限', 'Busy' => '占线', 'NotConnected' => '无法接通', 'PowerOff' => '关机'],
'example' => 'NotConnected',
],
'ReleaseReason' => ['description' => '通话结束原因,一般是 SipCode加文字描述格式.', 'type' => 'string', 'example' => '200 - OK'],
'AnalyticsReportReady' => ['type' => 'boolean', 'description' => ''],
'AnalyticsReport' => [
'type' => 'object',
'properties' => [
'ProblemSolving' => [
'type' => 'object',
'properties' => [
'TaskId' => ['type' => 'string', 'description' => ''],
'Success' => ['type' => 'boolean', 'description' => ''],
'Solved' => ['type' => 'boolean', 'description' => ''],
'Problem' => ['type' => 'string', 'description' => ''],
'Solution' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
'Emotion' => [
'type' => 'object',
'properties' => [
'TaskId' => ['type' => 'string', 'description' => ''],
'Success' => ['type' => 'boolean', 'description' => ''],
'Type' => ['type' => 'string', 'description' => ''],
'Confidence' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
'Remark' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
'Satisfaction' => [
'type' => 'object',
'properties' => [
'TaskId' => ['type' => 'string', 'description' => ''],
'Success' => ['type' => 'boolean', 'description' => ''],
'SatisfactionDescription' => ['type' => 'string', 'description' => ''],
'Remark' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
'TodoList' => [
'type' => 'object',
'properties' => [
'TaskId' => ['type' => 'string', 'description' => ''],
'Success' => ['type' => 'boolean', 'description' => ''],
'Tasks' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => ''],
'description' => '',
],
],
'description' => '',
],
],
'description' => '',
],
'OutsideNumberReleaseReason' => ['type' => 'string', 'description' => ''],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
],
'title' => '获取通话详情',
'summary' => '调用GetCallDetailRecord获取指定实例下指定通话ID对应的通话的详情。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-06-12T11:54:29.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-10-14T06:47:33.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-03-03T08:33:16.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-02-23T06:53:06.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-09-08T02:42:38.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCallDetailRecord'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"Data\\": {\\n \\"ReleaseInitiator\\": \\"customer\\",\\n \\"ContactDisposition\\": \\"Success\\",\\n \\"ContactType\\": \\"OUTBOUND\\",\\n \\"AgentIds\\": \\"agent1@ccc-test,agent2@ccc-test\\",\\n \\"CallDuration\\": 50,\\n \\"RecordingReady\\": true,\\n \\"EstablishedTime\\": 1532458000000,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"SatisfactionSurveyOffered\\": true,\\n \\"CalledNumber\\": \\"1332315****\\",\\n \\"AgentNames\\": \\"agent1,agent2\\",\\n \\"Satisfaction\\": 1,\\n \\"StartTime\\": 1532458000000,\\n \\"ContactId\\": \\"job-10963442671187****\\",\\n \\"SatisfactionSurveyChannel\\": \\"IVR\\",\\n \\"ReleaseTime\\": 1532458000000,\\n \\"CallingNumber\\": \\"0533128****\\",\\n \\"SkillGroupNames\\": \\"测试技能组\\",\\n \\"SkillGroupIds\\": \\"skillgroup@ccc-test\\",\\n \\"AgentEvents\\": [\\n {\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"EventSequence\\": [\\n {\\n \\"Event\\": \\"Dialing\\",\\n \\"EventTime\\": 1604639129000,\\n \\"Duration\\": 3\\n }\\n ]\\n }\\n ],\\n \\"IvrEvents\\": [\\n {\\n \\"FlowId\\": \\"edaf2eaa-8f88-44ca-812e-41b3cd2b7a90\\",\\n \\"EventSequence\\": [\\n {\\n \\"Event\\": \\"Route2IVR\\",\\n \\"EventTime\\": 1604639129000\\n }\\n ],\\n \\"FlowType\\": \\"MAIN_FLOW\\"\\n }\\n ],\\n \\"QueueEvents\\": [\\n {\\n \\"QueueId\\": \\"skillgroup@ccc-test\\",\\n \\"QueueName\\": \\"测试技能组\\",\\n \\"FlowId\\": \\"edaf2eaa-8f88-44ca-812e-41b3cd2b7a90\\",\\n \\"QueueType\\": 1,\\n \\"EventSequence\\": [\\n {\\n \\"Event\\": \\"Enqueue\\",\\n \\"EventTime\\": 1604639129000\\n }\\n ]\\n }\\n ],\\n \\"CustomerEvents\\": [\\n {\\n \\"CustomerId\\": \\"1332315****\\",\\n \\"EventSequence\\": [\\n {\\n \\"Event\\": \\"Released\\",\\n \\"EventTime\\": 1532458000000\\n }\\n ]\\n }\\n ],\\n \\"CallerLocation\\": \\" 山东省-淄博\\",\\n \\"CalleeLocation\\": \\"河北省-唐山\\",\\n \\"EarlyMediaState\\": \\"NotConnected\\",\\n \\"ReleaseReason\\": \\"200 - OK\\",\\n \\"AnalyticsReportReady\\": true,\\n \\"AnalyticsReport\\": {\\n \\"ProblemSolving\\": {\\n \\"TaskId\\": \\"\\",\\n \\"Success\\": true,\\n \\"Solved\\": true,\\n \\"Problem\\": \\"\\",\\n \\"Solution\\": \\"\\"\\n },\\n \\"Emotion\\": {\\n \\"TaskId\\": \\"\\",\\n \\"Success\\": true,\\n \\"Type\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Remark\\": \\"\\"\\n },\\n \\"Satisfaction\\": {\\n \\"TaskId\\": \\"\\",\\n \\"Success\\": true,\\n \\"SatisfactionDescription\\": \\"\\",\\n \\"Remark\\": \\"\\"\\n },\\n \\"TodoList\\": {\\n \\"TaskId\\": \\"\\",\\n \\"Success\\": true,\\n \\"Tasks\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"OutsideNumberReleaseReason\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>7BEEA660-A45A-45E3-98CC-AFC65E715C23</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <SkillGroupIds>skg-default@ccc-test</SkillGroupIds>\\n <CalledNumber>133xxxx2315</CalledNumber>\\n <ContactType>Outbound</ContactType>\\n <InstanceId>ccc-test</InstanceId>\\n <ContactDisposition>Success</ContactDisposition>\\n <ReleaseInitiator>customer</ReleaseInitiator>\\n <Satisfaction>1</Satisfaction>\\n <EarlyMediaState>NotConnected</EarlyMediaState>\\n <StartTime>1532458000000</StartTime>\\n <ContactId>job-109634426711871319</ContactId>\\n <CallDuration>50</CallDuration>\\n <CallingNumber>053xxxx3128</CallingNumber>\\n <CalleeLocation>北京</CalleeLocation>\\n <ReleaseTime>1532458000000</ReleaseTime>\\n <RecordingReady>true</RecordingReady>\\n <SkillGroupNames>默认技能组</SkillGroupNames>\\n <SatisfactionSurveyChannel>语音</SatisfactionSurveyChannel>\\n <SatisfactionSurveyOffered>true</SatisfactionSurveyOffered>\\n <AgentIds>user-test@ccc-test\\t</AgentIds>\\n <EstablishedTime>1532458000000</EstablishedTime>\\n <CallerLocation>北京</CallerLocation>\\n <AgentNames>云呼测试坐席</AgentNames>\\n <AgentEvents>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <AgentId>user-test@ccc-test</AgentId>\\n <AgentName>测试坐席\\t</AgentName>\\n <EventSequence>\\n <EventTime>1604639129000</EventTime>\\n <Event>Dialing</Event>\\n </EventSequence>\\n </AgentEvents>\\n <QueueEvents>\\n <FlowId>edaf2eaa-8f88-44ca-812e-41b3cd2b7a90</FlowId>\\n <QueueId>skg-default@ccc-test</QueueId>\\n <QueueName>Defalut</QueueName>\\n <QueueType>1</QueueType>\\n <EventSequence>\\n <EventTime>1604639129000</EventTime>\\n <Event>Enqueue</Event>\\n </EventSequence>\\n </QueueEvents>\\n <CustomerEvents>\\n <CustomerId>133xxxx2315</CustomerId>\\n <EventSequence>\\n <EventTime>1532458000000</EventTime>\\n <Event>Released</Event>\\n </EventSequence>\\n </CustomerEvents>\\n <IvrEvents>\\n <FlowId>edaf2eaa-8f88-44ca-812e-41b3cd2b7a90</FlowId>\\n <FlowType>MAIN_FLOW</FlowType>\\n <EventSequence>\\n <EventTime>1604639129000</EventTime>\\n <Event>Route2IVR</Event>\\n </EventSequence>\\n </IvrEvents>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'GetCampaign' => [
'summary' => '调用GetCampaign获取指定实例下指定ID对应的预测式外呼活动。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccQFUGXR'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CampaignId',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
'description' => '数据',
'type' => 'object',
'properties' => [
'ActualEndTime' => ['description' => '预测式外呼活动实际结束时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634008800000'],
'ActualStartTime' => ['description' => '预测式外呼活动实际开始时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634000460000'],
'CasesAborted' => ['description' => '取消呼叫的联系人数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CasesUncompleted' => ['description' => '未完呼叫的联系人数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CasesConnected' => ['description' => '已接通的联系人数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '40'],
'MaxAttemptCount' => ['description' => '预测式外呼活动的最大尝试次数,表示当活动的号码呼叫失败时,最多重呼几次。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'MinAttemptInterval' => ['description' => '预测式外呼活动的最小重呼间隔,表示失败重呼时的最小间隔,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Name' => ['description' => '预测式外呼活动名称。', 'type' => 'string', 'example' => 'test-campaign'],
'PlanedEndTime' => ['description' => '预测式外呼活动计划结束时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634054400000'],
'PlanedStartTime' => ['description' => '预测式外呼活动计划开始时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1633968000000'],
'QueueName' => ['description' => '关联的技能组名称。', 'type' => 'string', 'example' => '测试技能组'],
'TotalCases' => ['description' => '联系人总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'State' => [
'description' => '预测式外呼活动状态。',
'type' => 'string',
'enumValueTitles' => ['Draft' => '草稿', 'Completed' => '已完成', 'Executing' => '执行中', 'Pending' => '待执行', 'Aborted' => '已取消', 'Paused' => '已暂停'],
'example' => 'Completed',
],
'CampaignId' => ['title' => 'id', 'description' => '预测式外呼活动ID。', 'type' => 'string', 'example' => '6badb397-a8b5-40b6-21019d382a09'],
'StrategyType' => [
'description' => '预测式外呼活动的策略模式。',
'type' => 'string',
'enumValueTitles' => ['PACING' => '固定比例外呼,外呼数量 = 空闲坐席 * 比例', 'PID' => '系统基于PID控制策略,自动调整外呼电话数量'],
'example' => 'PACING',
],
'StrategyParameters' => ['description' => '预测式外呼活动的策略参数,PID策略下的格式参数示例:{"abandonRate":"5","historicalConnectedRate":"35"},PACING策略下的格式参数示例:{"ratio":1}。abandonRate表示期望呼损率,historicalConnectedRate表示历史参考接通率,ratio表示固定外呼比例。', 'type' => 'string', 'example' => '{"ratio":1}'],
'QueueId' => ['description' => '关联的技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Simulation' => ['description' => '是否为模拟活动,用于测试,普通客户无需关心。', 'type' => 'boolean', 'example' => 'false'],
'SimulationParameters' => ['description' => '模拟活动参数,用于测试,普通客户无需关心。', 'type' => 'string', 'example' => '无'],
'CasesUncompletedAfterAttempted' => ['description' => '尝试呼叫过但未接通,且未达到最大尝试次数的联系人数量。即经过重试后呼叫成功的联系人。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'CasesUncompletedAfterAttempt' => ['type' => 'string', 'description' => ''],
'CompletionRate' => ['type' => 'number', 'format' => 'float', 'description' => ''],
'ContactFlowId' => ['type' => 'string', 'description' => ''],
],
],
],
'description' => '',
],
],
],
'title' => '获取预测式外呼活动',
'changeSet' => [
['createdAt' => '2024-06-06T11:38:12.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCampaign'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"ActualEndTime\\": 1634008800000,\\n \\"ActualStartTime\\": 1634000460000,\\n \\"CasesAborted\\": 0,\\n \\"CasesUncompleted\\": 0,\\n \\"CasesConnected\\": 40,\\n \\"MaxAttemptCount\\": 1,\\n \\"MinAttemptInterval\\": 1,\\n \\"Name\\": \\"test-campaign\\",\\n \\"PlanedEndTime\\": 1634054400000,\\n \\"PlanedStartTime\\": 1633968000000,\\n \\"QueueName\\": \\"测试技能组\\",\\n \\"TotalCases\\": 100,\\n \\"State\\": \\"Completed\\",\\n \\"CampaignId\\": \\"6badb397-a8b5-40b6-21019d382a09\\",\\n \\"StrategyType\\": \\"PACING\\",\\n \\"StrategyParameters\\": \\"{\\\\\\"ratio\\\\\\":1}\\",\\n \\"QueueId\\": \\"skillgroup@ccc-test\\",\\n \\"Simulation\\": false,\\n \\"SimulationParameters\\": \\"无\\",\\n \\"CasesUncompletedAfterAttempted\\": 1,\\n \\"CasesUncompletedAfterAttempt\\": \\"\\",\\n \\"CompletionRate\\": 0,\\n \\"ContactFlowId\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'GetCaseFileUploadUrl' => [
'summary' => '调用GetCaseFileUploadUrl获取指定实例下预测式外呼名单文件的OSS上传参数,当使用文件导入的方式创建预测式外呼活动时,需要先调用此接口拿到文件上传参数,然后再调用CreateCampaign接口。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccQFUGXR'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动名单文件名称,名称的格式要求为英文大小写字母,文件格式要求csv格式。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'case.csv'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'Url' => ['description' => '用于上传文件的预签名的OSS文件上传链接,有效期为一小时。', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/namelist.csv?Expires=1642067227&OSSAccessKeyId=****&Signature=****'],
'CaseFileKey' => ['description' => 'OSS文件的Key。', 'type' => 'string', 'example' => 'ccc-test/namelist.csv'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取预测式外呼名单上传参数',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCaseFileUploadUrl'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"Url\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/namelist.csv?Expires=1642067227&OSSAccessKeyId=****&Signature=****\\",\\n \\"CaseFileKey\\": \\"ccc-test/namelist.csv\\"\\n },\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\"\\n}","type":"json"}]',
],
'GetChatMediaUrl' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'MediaId',
'in' => 'formData',
'schema' => ['title' => 'media id', 'description' => 'media id', 'type' => 'string', 'required' => true, 'example' => '$iAHNCNQCo3dhdgMGBAAFAAbaACOEAaQhIEeoAqpjjBl42N6o_kg7A88AAAGRIRRuBgTOACrxHgcACM8AAAGRIYJLBQ'],
],
[
'name' => 'RequestId',
'in' => 'formData',
'schema' => ['description' => '请求ID', 'type' => 'string', 'required' => false, 'example' => '8707EB29-BAED-4302-B999-40BA61877437'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'GetChatMediaUrlResponse',
'description' => 'GetChatMediaUrlResponse',
'type' => 'object',
'properties' => [
'Data' => ['description' => '返回数据结果。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息'."\n"
."\n", 'type' => 'string', 'example' => 'Internal service issue. Detail:.'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '[\'OFFLINE\', \'READY,RINGING,TALKING\']'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Internal service issue. Detail:.\\",\\n \\"Params\\": [\\n \\"[\'OFFLINE\', \'READY,RINGING,TALKING\']\\"\\n ]\\n}","type":"json"}]',
'title' => '获取聊天消息媒体文件访问URL',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'GetChatRoutingProfile' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30C7D235-DDCF-4C7F-A462-5E2598252C2B'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'RoutingType' => ['description' => '话务分配类型。'."\n"
.'- 自动分配(Automatic)。'."\n"
.'- 手动分配(Manual)。', 'type' => 'string', 'example' => 'Automatic'],
'AgentConcurrencySettings' => ['description' => '坐席会话并发配置。'."\n"
.'- AllowExceedingLimitWhenTransferring,转接时是否允许超出上限,向其他坐席转接会话时,允许超出对方上限数量,但最多不能超过30个。'."\n"
.'- AllowExceedingLimitWhenClaiming,认领时是否允许超出上限,坐席从队列中主动认领会话时,允许超出上限数量,但最多不能超过30个。'."\n"
.'- ConcurrencyLimit,允许坐席同时处理的网络业务会话数量。'."\n"
.'- Enabled,是否启用该配置。', 'type' => 'string', 'example' => '{'."\n"
.' "AllowExceedingLimitWhenTransferring": false,'."\n"
.' "ConcurrencyLimit": 4,'."\n"
.' "AllowExceedingLimitWhenClaiming": true,'."\n"
.' "Enabled": true'."\n"
.'}'],
'DistributionSettings' => ['description' => '坐席会话分配配置。'."\n"
.'- AgentRingTimeoutSeconds,坐席处理超时限制。'."\n"
.'- MaxNumberOfConversationsAgentCanMiss,允许坐席最多连续未响应的会话数量。'."\n"
.'- PostAgentMissingConversionsAction,坐席连续未响应超过设置的数量后,系统设置的作息状态,如小休Break, 隐身Invisible,保持不变Nothing;'."\n"
.'- Enabled,是否启用。', 'type' => 'string', 'example' => '{'."\n"
.' "AgentRingTimeoutSeconds": 30,'."\n"
.' "Enabled": true,'."\n"
.' "MaxNumberOfConversationsAgentCanMiss": 5,'."\n"
.' "PostAgentMissingConversionsAction": "Nothing"'."\n"
.'}'],
'ChatSettings' => ['description' => '会话配置。'."\n"
.'- IdleChatTimeoutSeconds,会话自动结束时间,特定时间内未收到客户响应,则系统结束会话,单位秒。', 'type' => 'string', 'example' => '{"IdleChatTimeoutSeconds":300}'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"30C7D235-DDCF-4C7F-A462-5E2598252C2B\\",\\n \\"Data\\": {\\n \\"RoutingType\\": \\"Automatic\\",\\n \\"AgentConcurrencySettings\\": \\"{\\\\n \\\\\\"AllowExceedingLimitWhenTransferring\\\\\\": false,\\\\n \\\\\\"ConcurrencyLimit\\\\\\": 4,\\\\n \\\\\\"AllowExceedingLimitWhenClaiming\\\\\\": true,\\\\n \\\\\\"Enabled\\\\\\": true\\\\n}\\",\\n \\"DistributionSettings\\": \\"{\\\\n \\\\\\"AgentRingTimeoutSeconds\\\\\\": 30,\\\\n \\\\\\"Enabled\\\\\\": true,\\\\n \\\\\\"MaxNumberOfConversationsAgentCanMiss\\\\\\": 5,\\\\n \\\\\\"PostAgentMissingConversionsAction\\\\\\": \\\\\\"Nothing\\\\\\"\\\\n}\\",\\n \\"ChatSettings\\": \\"{\\\\\\"IdleChatTimeoutSeconds\\\\\\":300}\\"\\n }\\n}","type":"json"}]',
'title' => '获取会话转接配置',
'summary' => '使用GetChatRoutingProfile获取会话转接配置。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'GetContactFlow' => [
'summary' => '获取指定联系流。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccTPIKHY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'ContactFlowId',
'in' => 'query',
'schema' => ['description' => '联系流ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '274601be-a6d5-4429-bcef-32b51d031c6e'],
],
[
'name' => 'DraftId',
'in' => 'query',
'schema' => ['description' => '草稿ID,当前联系流对应的可编辑草稿版本ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '566399d7-5558-447c-a72f-9be2768b6a82'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '流程类型: '."\n"
.'MAIN\\_FLOW(主流程) '."\n"
.'SUB\\_FLOW(子流程) '."\n"
.'SURVEY\\_FLOW(满意度流程)', 'type' => 'string', 'example' => 'MAIN_FLOW'],
'Definition' => ['description' => 'IVR的内容。', 'type' => 'string', 'example' => '{"activities":[{"type":"INCOMING_CALL","id":"e98f0d47","name":"开始","properties":{"position":{"x":263,"y":164}},"events":[{"event":"complete","next":"2d3ad2c2","edgeId":"41f7dbd0"}],"nodeIndex":0},{"type":"HANGUP","id":"bd4f37e2","name":"挂机","properties":{"position":{"x":765,"y":185}},"events":[{"event":"complete","next":null}],"nodeIndex":999},{"type":"PLAY_SAY","id":"2d3ad2c2","name":"放音","properties":{"say":"您好,欢迎来到云联络中心。","audioResourceId":"","position":{"x":485.5,"y":153.5},"audioType":"tts","audioInterrupt":false},"events":[{"event":"complete","next":"bd4f37e2","edgeId":"e1af4f1f"}],"nodeIndex":1}],"description":""}'],
'DraftId' => ['description' => '草稿ID,当前联系流对应的可编辑草稿版本ID。', 'type' => 'string', 'example' => '566399d7-5558-447c-a72f-9be2768b6a82'."\n"],
'Description' => ['description' => '版本描述。', 'type' => 'string', 'example' => '1.0'."\n"],
'UpdatedTime' => ['description' => '上次修改的时间。', 'type' => 'string', 'example' => '2021-07-14 10:48:43.0'],
'Editor' => ['description' => '此草稿的当前编辑者的坐席登录名。', 'type' => 'string', 'example' => 'editor-xxx'],
'Published' => ['description' => '是否已发布 True:已发布:False:未发布', 'type' => 'boolean', 'example' => 'False'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Name' => ['description' => 'IVR名称。', 'type' => 'string', 'example' => '欢迎语'],
'ContactFlowId' => ['description' => '联系流ID。', 'type' => 'string', 'example' => '274601be-a6d5-4429-bcef-32b51d031c6e'."\n"],
'CreatedTime' => ['description' => '联系流程草稿创建时间。', 'type' => 'string', 'example' => '2021-07-14 10:48:43.0'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取指定联系流',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetContactFlow'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2263B273-AC1B-44EB-BA98-87F2322C6780\\",\\n \\"Data\\": {\\n \\"Type\\": \\"MAIN_FLOW\\",\\n \\"Definition\\": \\"{\\\\\\"activities\\\\\\":[{\\\\\\"type\\\\\\":\\\\\\"INCOMING_CALL\\\\\\",\\\\\\"id\\\\\\":\\\\\\"e98f0d47\\\\\\",\\\\\\"name\\\\\\":\\\\\\"开始\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":263,\\\\\\"y\\\\\\":164}},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":\\\\\\"2d3ad2c2\\\\\\",\\\\\\"edgeId\\\\\\":\\\\\\"41f7dbd0\\\\\\"}],\\\\\\"nodeIndex\\\\\\":0},{\\\\\\"type\\\\\\":\\\\\\"HANGUP\\\\\\",\\\\\\"id\\\\\\":\\\\\\"bd4f37e2\\\\\\",\\\\\\"name\\\\\\":\\\\\\"挂机\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":765,\\\\\\"y\\\\\\":185}},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":null}],\\\\\\"nodeIndex\\\\\\":999},{\\\\\\"type\\\\\\":\\\\\\"PLAY_SAY\\\\\\",\\\\\\"id\\\\\\":\\\\\\"2d3ad2c2\\\\\\",\\\\\\"name\\\\\\":\\\\\\"放音\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"say\\\\\\":\\\\\\"您好,欢迎来到云联络中心。\\\\\\",\\\\\\"audioResourceId\\\\\\":\\\\\\"\\\\\\",\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":485.5,\\\\\\"y\\\\\\":153.5},\\\\\\"audioType\\\\\\":\\\\\\"tts\\\\\\",\\\\\\"audioInterrupt\\\\\\":false},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":\\\\\\"bd4f37e2\\\\\\",\\\\\\"edgeId\\\\\\":\\\\\\"e1af4f1f\\\\\\"}],\\\\\\"nodeIndex\\\\\\":1}],\\\\\\"description\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"DraftId\\": \\"566399d7-5558-447c-a72f-9be2768b6a82\\\\n\\",\\n \\"Description\\": \\"1.0\\\\n\\",\\n \\"UpdatedTime\\": \\"2021-07-14 10:48:43.0\\",\\n \\"Editor\\": \\"editor-xxx\\",\\n \\"Published\\": true,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"欢迎语\\",\\n \\"ContactFlowId\\": \\"274601be-a6d5-4429-bcef-32b51d031c6e\\\\n\\",\\n \\"CreatedTime\\": \\"2021-07-14 10:48:43.0\\"\\n }\\n}","type":"json"}]',
],
'GetConversationDetail' => [
'summary' => '调用GetConversationDetail获取指定实例下指定通话ID对应的通话的对话详情,注意,实例及技能组需要开通质检推送才能获取到对话详情。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '136495',
'abilityTreeNodes' => ['FEATUREccc5HY0NN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'example' => 'job-25884193037652****'],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => ['title' => '坐席ID。', 'description' => '坐席ID。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7E407F9B-A278-52A0-B193-3EE5471D7A87'],
'Phrases' => [
'description' => '对话列表。',
'type' => 'array',
'items' => [
'description' => '对话信息。',
'type' => 'object',
'properties' => [
'Identity' => ['description' => '角色标识,系统内部使用,主要用于判断角色,客户无需关心。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Role' => [
'description' => '角色。',
'type' => 'string',
'enumValueTitles' => ['客服' => '客服', '客户' => '客户'],
'example' => '客服',
],
'Begin' => ['description' => '句子开始时间相对会话开始时间的偏移量,单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '240'],
'End' => ['description' => '句子结束时间相对会话开始时间的偏移量,单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '1280'],
'Words' => ['description' => '对话文本内容。', 'type' => 'string', 'example' => '欢迎致电云联络中心'],
'Finished' => ['description' => '是否完结', 'type' => 'boolean', 'example' => 'false'],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"7E407F9B-A278-52A0-B193-3EE5471D7A87\\",\\n \\"Phrases\\": [\\n {\\n \\"Identity\\": \\"agent@ccc-test\\",\\n \\"Role\\": \\"客服\\",\\n \\"Begin\\": 240,\\n \\"End\\": 1280,\\n \\"Words\\": \\"欢迎致电云联络中心\\",\\n \\"Finished\\": false\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取对话详情',
'changeSet' => [
['createdAt' => '2024-12-12T15:20:46.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConversationDetail'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'GetDoNotCallFileUploadParameters' => [
'summary' => '调用GetDoNotCallFileUploadParameters获取禁呼文件的上传参数,当通过文件导入禁止外呼号码时,需要先调用此接口将禁呼号码文件上传到云联络中心的公共OSS空间,之后再调用ImportDoNotCallNumbers执行导入。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccTMAX45'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => ['description' => '禁止外呼号码文件的名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'blacklist.xlsx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'FilePath' => ['description' => 'OSS文件的Key。', 'type' => 'string', 'example' => 'ccc-test/blacklist.xlsx'],
'Signature' => ['description' => '文件上传临时凭证的签名信息,用于上传时验证合法性。', 'type' => 'string', 'example' => 'zi31STIMtIfa/UN2l+6lww****'],
'Host' => ['description' => 'OSS的接入域名。', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com'],
'Policy' => ['description' => '签名策略。', 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyMi0wMy0xNVQwMzowMzo0MC4zMTJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwidGVtcC9ibGFja2xpc3QvaW1wb3J0LzE1NzcyNDcxMTU0OTA0MDEvY2NjVjIta216LzIwMjIE1MTAwMzQwLyJd****'],
'ExpireTime' => ['description' => '过期时间,格式为Unix时间戳,单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '1647313420'],
'AccessKeyId' => ['description' => '签名使用的accessKeyId。', 'type' => 'string', 'example' => '****'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取禁呼文件上传参数',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDoNotCallFileUploadParameters'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"FilePath\\": \\"ccc-test/blacklist.xlsx\\",\\n \\"Signature\\": \\"zi31STIMtIfa/UN2l+6lww****\\",\\n \\"Host\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyMi0wMy0xNVQwMzowMzo0MC4zMTJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwidGVtcC9ibGFja2xpc3QvaW1wb3J0LzE1NzcyNDcxMTU0OTA0MDEvY2NjVjIta216LzIwMjIE1MTAwMzQwLyJd****\\",\\n \\"ExpireTime\\": 1647313420,\\n \\"AccessKeyId\\": \\"****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Policy>eyJleHBpcmF0aW9uIjoiMjAyMi0wMy0xNVQwMzowMzo0MC4zMTJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwidGVtcC9ibGFja2xpc3QvaW1wb3J0LzE1NzcyNDcxMTU0OTA0MDEvY2NjVjIta216LzIwMjIE1MTAwMzQwLyJdXX0=</Policy>\\n <FilePath>temp/blacklist/import/157724711549xxxx/ccc-test/20220315100340/blacklist.xlsx</FilePath>\\n <AccessKeyId>LTAI4GDDtCgcY8HmXTiExxxx</AccessKeyId>\\n <Signature>zi31STIMtIfa/UN2l+6lwwe9o=</Signature>\\n <Host>https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com</Host>\\n <ExpireTime>1647313420</ExpireTime>\\n</Data>\\n<Code>OK</Code>\\n<Success>true</Success>","errorExample":""}]',
],
'GetDocumentUploadParameters' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'parameters' => [
[
'name' => 'FileName',
'in' => 'formData',
'schema' => ['description' => '文件名称。', 'type' => 'string', 'required' => true, 'example' => 'blacklist.xlsx'],
],
[
'name' => 'RequestId',
'in' => 'formData',
'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '24BE19E8-BF7D-4992-A35E-15EBA874F2E5'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'GetTempAttachmentUploadUrlResponse',
'description' => 'GetTempAttachmentUploadUrlResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'AccessKeyId' => ['title' => '签名使用的accessKeyId', 'description' => '签名使用的accessKeyId', 'type' => 'string', 'example' => '****'],
'Policy' => ['title' => '签名策略', 'description' => '签名策略', 'type' => 'string', 'example' => 'Permit'],
'Signature' => ['title' => '签名', 'description' => '签名', 'type' => 'string', 'example' => 'zi31STIMtIfa/UN2l+6lww****'],
'FilePath' => ['title' => 'oss文件路径', 'description' => 'oss文件路径', 'type' => 'string', 'example' => 'ccc-test/blacklist.xlsx'],
'Host' => ['title' => 'oss host', 'description' => 'oss host', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com'],
'ExpireTime' => ['title' => '到期时间', 'description' => '到期时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1647313420'],
],
],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71'],
'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"AccessKeyId\\": \\"****\\",\\n \\"Policy\\": \\"Permit\\",\\n \\"Signature\\": \\"zi31STIMtIfa/UN2l+6lww****\\",\\n \\"FilePath\\": \\"ccc-test/blacklist.xlsx\\",\\n \\"Host\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com\\",\\n \\"ExpireTime\\": 1647313420\\n },\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '获取导入Document上传地址',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'GetEarlyMediaRecording' => [
'summary' => '获取指定实例下的通话早媒体音频。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccKYIENB'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103689****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'FileUrl' => ['description' => '录音文件的OSS下载地址,注意下载地址的过期时间,下载地址的有效期为1天。', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2022/06/voicemail.job-054ded02****.wav?Expires=1656074923&OSSAccessKeyId=****&Signature=****'],
'FileName' => ['description' => '录音文件名称。', 'type' => 'string', 'example' => 'job-6538214103689****-earlyMedia.wav'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取通话早媒体音频',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEarlyMediaRecording'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2022/06/voicemail.job-054ded02****.wav?Expires=1656074923&OSSAccessKeyId=****&Signature=****\\",\\n \\"FileName\\": \\"job-6538214103689****-earlyMedia.wav\\"\\n }\\n}","type":"json"}]',
],
'GetHistoricalCallerReport' => [
'summary' => '调用GetHistoricalCallerReport获取指定实例下指定来电号码的历史呼入报表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => ['description' => '来电号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1900000****'],
],
[
'name' => 'StopTime',
'in' => 'query',
'schema' => ['description' => '查询的结束时间戳,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '4102416000000', 'minimum' => '0', 'example' => '1646928000000'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查询的开始时间戳,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '4102416000000', 'minimum' => '0', 'example' => '1646841600000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'LastCallingTime' => ['description' => '最近一次来电时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1646917200000'],
'TotalCalls' => ['description' => '该号码在查询时间段的总来电次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'],
['errorCode' => 'Parameter.Invalid', 'errorMessage' => 'The parameter %s is invalid. %s.', 'description' => '该参数无效。'],
],
500 => [
['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'],
],
],
'title' => '获取历史来电报表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoricalCallerReport'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"LastCallingTime\\": 1646917200000,\\n \\"TotalCalls\\": 10\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <LastCallingTime>1646917200000</LastCallingTime>\\n <TotalCalls>10</TotalCalls>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'GetHistoricalCampaignReport' => [
'summary' => '调用GetHistoricalCampaignReport接口获取指定实例下指定ID对应的预测式外呼活动的历史数据报表。',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccQFUGXR'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CampaignId',
'in' => 'query',
'schema' => ['title' => '活动ID', 'description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '4fc85829-f6fc-476e-9c0d-c350184e36f1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E3A847C1-9800-57DF-9172-2CDDC026388D'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'CallsConnected' => ['description' => '已接通数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
'CallsDialed' => ['description' => '已呼叫次数,包括重呼次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsAbandoned' => ['description' => '已呼损数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'ConnectedRate' => ['description' => '已废弃,请参考AnswerRate。', 'type' => 'number', 'format' => 'float', 'example' => '0.50'],
'AnswerRate' => ['description' => '接通率,单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0.50'],
'AbandonedRate' => ['description' => '已废弃,请参考AbandonRate。', 'type' => 'number', 'format' => 'float', 'example' => '0.10'],
'AbandonRate' => ['description' => '呼损率,计算方式为:已呼损数量/总数。', 'type' => 'number', 'format' => 'float', 'example' => '0.10'],
'OccupancyRate' => ['description' => '坐席利用率,计算方式为:(总通话时长+总话后处理时长)/总坐席在线时长,总坐席在线时长表示该活动关联的技能组下的所有坐席的在线时长。', 'type' => 'number', 'format' => 'float', 'example' => '0.50'],
],
],
],
],
],
],
'title' => '获取预测式外呼活动历史数据报表',
'changeSet' => [
['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoricalCampaignReport'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"E3A847C1-9800-57DF-9172-2CDDC026388D\\",\\n \\"Data\\": {\\n \\"CallsConnected\\": 50,\\n \\"CallsDialed\\": 100,\\n \\"CallsAbandoned\\": 5,\\n \\"ConnectedRate\\": 0.5,\\n \\"AnswerRate\\": 0.5,\\n \\"AbandonedRate\\": 0.1,\\n \\"AbandonRate\\": 0.1,\\n \\"OccupancyRate\\": 0.5\\n }\\n}","type":"json"}]',
],
'GetHistoricalInstanceReport' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '获取的历史数据的起始时间,格式为Unix时间戳,单位毫秒,非必填,默认为当天的0时,最早为当前时间往前180天,统计的时间精度为小时,向前取整,闭区间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532448000000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '获取的历史数据的终止时间,格式为Unix时间戳,单位毫秒,非必填,默认为当前时间,统计的时间精度为小时,向后取整,开区间。例如:开始时间为11:12:20,结束时间为11:45:50,则对齐后的入参时间范围为[11:00:00,12:00:00) ,即大于等于11点,小于12点。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532707199000'],
],
[
'name' => 'MediaType',
'in' => 'query',
'schema' => ['description' => '媒体类型,默认是语音(Audio), 其他可选参数包括Chat和Video.', 'type' => 'string', 'required' => false, 'example' => 'VIDEO'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'Inbound' => [
'description' => '呼入数据。',
'type' => 'object',
'properties' => [
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。计算公式为: TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsVoicemail' => ['description' => '转语音信箱的通话数量,当通话进入了IVR中配置的语音信箱模块,计数加1。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxAbandonedInIVRTime' => ['description' => '最大IVR放弃时长,单位秒。IVR放弃的定义是客户在IVR交互过程中挂机,不包括排队状态下客户挂机,不包括通话分配坐席后坐席振铃过程中客户挂机。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsHandled' => ['description' => '应答量,即被坐席应答的通话数量,若一通电话被多个坐席应答,只算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsIVRException' => ['description' => '发生IVR异常的通话数量,判定条件是IVR进入了挂机原因节点且挂机原因节点设置的挂机原因为转人工失败,此时计数加1。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAbandonedInIVR' => ['description' => 'IVR放弃量,即电话进入IVR流程之后在IVR环节客户挂机的数量,判断依据为通话详情的挂断原因为IVR放弃。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalHoldTime' => ['description' => '总通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxAbandonTime' => ['description' => '最大放弃时长,单位秒。放弃的定义是通话进入IVR后,坐席接起前,客户发起挂机。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageAbandonTime' => ['description' => '平均放弃时长,单位秒。计算公式为:TotalAbandonTime/CallsAbandoned。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsRinged' => ['description' => '座席振铃的电话数量,若一通电话分配给多个座席并产生了振铃,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsQueuingFailed' => ['description' => '队列失败量,即电话进入队列之后在排队环节客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AbandonRate' => ['description' => '放弃率。计算公式为:CallsAbandoned/CallsOffered(由于放弃事件与分配事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxAbandonedInRingTime' => ['description' => '最大振铃放弃时长,单位秒。振铃放弃的定义是通话分配到坐席后,坐席正在振铃,此时客户挂机。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsBlindTransferred' => ['description' => '直接转接量,即发生直接转接的电话数量。若一通电话发起多次转接,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageAbandonedInIVRTime' => ['description' => '平均IVR放弃时长,单位秒。计算公式为:TotalAbandonedInIVRTime/CallsAbandonedInIVR。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageAbandonedInQueueTime' => ['description' => '平均排队放弃时长,单位秒。计算公式为:TotalAbandonedInQueueTime/CallsAbandonedInQueue。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'MaxWaitTime' => ['description' => '最大等待时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为:TotalTalkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsAttendedTransferred' => ['description' => '咨询转接量,即发生咨询转接的电话数量。若一通电话发起多次转接,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalAbandonedInIVRTime' => ['description' => '总IVR放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsQueuingOverflow' => ['description' => '队列溢出的通话数量,队列溢出指通话在IVR排队时队列溢出。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAbandonedInRing' => ['description' => '振铃放弃量,即坐席振铃过程中发生客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalAbandonedInRingTime' => ['description' => '总振铃放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWaitTime' => ['description' => '平均等待时长,平均每通电话的坐席接起前等待时长。计算公式为: TotalWaitTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为: TotalWorkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsQueued' => ['description' => '进入队列的电话数量,若一通电话多次进入队列,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageAbandonedInRingTime' => ['description' => '平均振铃放弃时长,单位秒。计算公式为:TotalAbandonedInRingTime/CallsAbandonedInRing。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsAbandoned' => ['description' => '放弃量。计算公式为:CallsAbandonedInIVR+CallsAbandonedInQueue+CallsAbandonedInRing。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxAbandonedInQueueTime' => ['description' => '最大排队放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAbandonedInVoiceNavigator' => ['description' => '通话在智能导航模块放弃的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalWaitTime' => ['description' => '总等待时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalAbandonTime' => ['description' => '总放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsOffered' => ['description' => '呼入到云联络中心的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsQueuingTimeout' => ['description' => '在排队阶段超时的通话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ServiceLevel20' => ['description' => '20S服务水平,等待时长小于等于20秒的电话数量/CallsQueued。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsForwardToOutsideNumber' => ['description' => '发生转外线的通话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsHold' => ['description' => '保持量,即发生通话保持的电话数量。若一通电话保持多次,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'HandleRate' => ['description' => '应答率。计算公式为:CallsHandled/CallsOffered(由于应答事件与分配事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsAbandonedInQueue' => ['description' => '队列放弃量,即电话进入队列之后在排队环节客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalAbandonedInQueueTime' => ['description' => '总排队放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsCausedIVRException' => ['description' => '导致IVR异常的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsToVoicemail' => ['description' => '进入语音信箱的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'ServiceLevel15' => ['description' => '15秒服务水平。', 'type' => 'number', 'format' => 'float', 'example' => '0.78'],
'ServiceLevel30' => ['description' => '30秒服务水平。', 'type' => 'number', 'format' => 'float', 'example' => '0.9'],
'TotalMessagesSent' => ['description' => 'Chat会话中总消息发送量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'TotalMessagesSentByAgent' => ['description' => 'Chat会话中坐席发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'],
'TotalMessagesSentByCustomer' => ['description' => 'Chat会话中客户发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
'AverageFirstResponseTime' => ['description' => 'Chat会话平均首次响应时长,单位为秒。', 'type' => 'number', 'format' => 'float', 'example' => '12'],
'AccessChannelTypeDetailList' => [
'description' => '各渠道的统计数据。',
'type' => 'array',
'items' => [
'description' => '渠道的统计数据。',
'type' => 'object',
'properties' => [
'AccessChannelType' => ['description' => '渠道类型。', 'type' => 'string', 'example' => 'Web'],
'CallsOffered' => ['description' => '分配的会话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
],
],
],
'AverageResponseTime' => ['description' => 'Chat会话平均响应时长。', 'type' => 'number', 'format' => 'float', 'example' => '15'],
],
],
'Outbound' => [
'description' => '呼出指标。',
'type' => 'object',
'properties' => [
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。计算公式为: TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalDialingTime' => ['description' => '总拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalHoldTime' => ['description' => '总通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为:TotalWorkTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsRinged' => ['description' => '坐席振铃的电话数量,若一通电话分配给多个坐席并产生了振铃,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxDialingTime' => ['description' => '最大拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsBlindTransferred' => ['description' => '直接转接量,即发生直接转接的电话数量。若一通电话发起多次转接,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AnswerRate' => ['description' => '接通率,计算公式为:CallsAnswered/CallsDialed(由于接听事件与应答事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为:TotalTalkTime/CallsAnswered。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsAttendedTransferred' => ['description' => '咨询转接量,即发生咨询转接的电话数量。若一通电话发起多次转接,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsHold' => ['description' => '保持量,即发生通话保持的电话数量。若一通电话保持多次,算一次。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageDialingTime' => ['description' => '平均拨号时长,单位秒。计算公式为:TotalDialingTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
],
],
'Overall' => [
'description' => '整体指标。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalLoggedInTime' => ['description' => '总登录时长,单位秒。不包含小休时长。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'OccupancyRate' => ['description' => '座席利用率,计算公式为: (TotalworkTime + TotalTalkTime ) / TotalLoggedInTime。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageBreakTime' => ['description' => '平均小休时长,单位秒。计算公式为:TotalBreakTime/小休次数。小休次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalHoldTime' => ['description' => '总保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'MaxBreakTime' => ['description' => '最大小休时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为:TotalWorkTime/TotalCalls。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为: TotalTalkTime/(CallsAnswered+CallsHandled)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxReadyTime' => ['description' => '最大就绪时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageReadyTime' => ['description' => '平均就绪时长,单位秒。计算公式为:TotalReadyTime/就绪次数,就绪次数暂不对外暴露。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/(呼入CallsHold+呼出CallsHold)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalReadyTime' => ['description' => '总就绪时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalBreakTime' => ['description' => '总小休时长,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalCalls' => ['description' => '总电话量。计算公式为:CallsOffered + CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxLoggedInAgents' => ['description' => '此时间范围内最多同时登录的座席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '102'],
],
],
'Internal' => [
'description' => '内部呼叫指标。',
'type' => 'object',
'properties' => [
'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
],
'title' => '获取历史实例数据报表',
'summary' => '调用GetHistoricalInstanceReport获取指定实例的历史数据报表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-22T01:05:26.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoricalInstanceReport'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": {\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsVoicemail\\": 0,\\n \\"MaxAbandonedInIVRTime\\": 100,\\n \\"CallsHandled\\": 0,\\n \\"CallsIVRException\\": 0,\\n \\"CallsAbandonedInIVR\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"MaxAbandonTime\\": 0,\\n \\"AverageAbandonTime\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsQueuingFailed\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"AbandonRate\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxAbandonedInRingTime\\": 0,\\n \\"CallsBlindTransferred\\": 0,\\n \\"AverageAbandonedInIVRTime\\": 0,\\n \\"AverageAbandonedInQueueTime\\": 0,\\n \\"MaxWaitTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"CallsAttendedTransferred\\": 0,\\n \\"TotalAbandonedInIVRTime\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"TotalAbandonedInRingTime\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"AverageWaitTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"CallsQueued\\": 0,\\n \\"AverageAbandonedInRingTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"MaxAbandonedInQueueTime\\": 0,\\n \\"CallsAbandonedInVoiceNavigator\\": 0,\\n \\"TotalWaitTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalAbandonTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"CallsForwardToOutsideNumber\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"CallsAbandonedInQueue\\": 0,\\n \\"TotalAbandonedInQueueTime\\": 0,\\n \\"CallsCausedIVRException\\": 0,\\n \\"CallsToVoicemail\\": 3,\\n \\"ServiceLevel15\\": 0.78,\\n \\"ServiceLevel30\\": 0.9,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 8,\\n \\"TotalMessagesSentByCustomer\\": 4,\\n \\"AverageFirstResponseTime\\": 12,\\n \\"AccessChannelTypeDetailList\\": [\\n {\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"CallsOffered\\": 5\\n }\\n ],\\n \\"AverageResponseTime\\": 15\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"CallsBlindTransferred\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsAttendedTransferred\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 0\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"TotalLoggedInTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 0,\\n \\"MaxLoggedInAgents\\": 102\\n },\\n \\"Internal\\": {\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>943D8EF3-3321-471F-A104-51C96FCA94D6</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Inbound>\\n <ServiceLevel20>0</ServiceLevel20>\\n <CallsAbandonedInQueue>0</CallsAbandonedInQueue>\\n <TotalWorkTime>0</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <CallsRinged>0</CallsRinged>\\n <MaxAbandonedInIVRTime>0</MaxAbandonedInIVRTime>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>0</MaxRingTime>\\n <CallsOffered>0</CallsOffered>\\n <CallsAbandoned>0</CallsAbandoned>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <MaxAbandonedInRingTime>0</MaxAbandonedInRingTime>\\n <TotalRingTime>0</TotalRingTime>\\n <HandleRate>0</HandleRate>\\n <TotalAbandonedInIVRTime>0</TotalAbandonedInIVRTime>\\n <AverageAbandonedInQueueTime>0</AverageAbandonedInQueueTime>\\n <TotalTalkTime>0</TotalTalkTime>\\n <AverageWaitTime>0</AverageWaitTime>\\n <TotalAbandonedInRingTime>0</TotalAbandonedInRingTime>\\n <CallsQueued>0</CallsQueued>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <AverageAbandonedInIVRTime>0</AverageAbandonedInIVRTime>\\n <TotalAbandonTime>0</TotalAbandonTime>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n <CallsBlindTransferred>0</CallsBlindTransferred>\\n <CallsAbandonedInIVR>0</CallsAbandonedInIVR>\\n <MaxAbandonedInQueueTime>0</MaxAbandonedInQueueTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <CallsAbandonedInRing>0</CallsAbandonedInRing>\\n <CallsHandled>0</CallsHandled>\\n <MaxWaitTime>0</MaxWaitTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <CallsAttendedTransferred>0</CallsAttendedTransferred>\\n <MaxAbandonTime>0</MaxAbandonTime>\\n <AverageRingTime>0</AverageRingTime>\\n <TotalWaitTime>0</TotalWaitTime>\\n <AverageAbandonTime>0</AverageAbandonTime>\\n <AverageAbandonedInRingTime>0</AverageAbandonedInRingTime>\\n <TotalAbandonedInQueueTime>0</TotalAbandonedInQueueTime>\\n <AverageWorkTime>0</AverageWorkTime>\\n <MaxWorkTime>0</MaxWorkTime>\\n <AbandonRate>0</AbandonRate>\\n </Inbound>\\n <Outbound>\\n <TotalDialingTime>0</TotalDialingTime>\\n <TotalWorkTime>0</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <CallsRinged>0</CallsRinged>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>0</MaxRingTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <TotalRingTime>0</TotalRingTime>\\n <AverageDialingTime>0</AverageDialingTime>\\n <CallsAnswered>0</CallsAnswered>\\n <TotalTalkTime>0</TotalTalkTime>\\n <CallsDialed>0</CallsDialed>\\n <MaxDialingTime>0</MaxDialingTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n <AnswerRate>0</AnswerRate>\\n <CallsBlindTransferred>0</CallsBlindTransferred>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <CallsAttendedTransferred>0</CallsAttendedTransferred>\\n <AverageRingTime>0</AverageRingTime>\\n <AverageWorkTime>0</AverageWorkTime>\\n <MaxWorkTime>0</MaxWorkTime>\\n </Outbound>\\n <Overall>\\n <TotalReadyTime>0</TotalReadyTime>\\n <TotalCalls>0</TotalCalls>\\n <TotalBreakTime>0</TotalBreakTime>\\n <TotalWorkTime>0</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <AverageHoldTime>0</AverageHoldTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <AverageBreakTime>0</AverageBreakTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <TotalTalkTime>0</TotalTalkTime>\\n <AverageReadyTime>0</AverageReadyTime>\\n <TotalLoggedInTime>0</TotalLoggedInTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <MaxReadyTime>0</MaxReadyTime>\\n <AverageWorkTime>0</AverageWorkTime>\\n <MaxWorkTime>0</MaxWorkTime>\\n <MaxBreakTime>0</MaxBreakTime>\\n <OccupancyRate>0</OccupancyRate>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n </Overall>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'GetInstance' => [
'summary' => '调用GetInstance获取指定实例ID所对应的云联络中心实例的详细信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccTMAX45'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '实例状态。',
'type' => 'string',
'enumValueTitles' => ['RELEASED' => '已释放', 'RUNNING' => '正常运行中', 'STOPPED' => '已停服', 'CREATING' => '创建中'],
'example' => 'RUNNING',
],
'ConsoleUrl' => ['description' => '云联络中心实例的网址,用于访问云联络中心实例的主页面,由云联络中心的特定网址加上实例ID组成。', 'type' => 'string', 'example' => 'https://ccc-v2.aliyun.com/#/workbench/ccc-test'],
'Description' => ['description' => '实例的描述。', 'type' => 'string', 'example' => '云联络中心的测试实例。'],
'AliyunUid' => ['description' => '实例所属的阿里云账户ID。', 'type' => 'string', 'example' => '157123456789****'],
'Name' => ['description' => '实例名称。', 'type' => 'string', 'example' => '测试实例'],
'DomainName' => ['description' => '实例的域名,全局唯一。', 'type' => 'string', 'example' => 'ccc-test'],
'Id' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'."\n"],
'AdminList' => [
'description' => '管理员列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '管理员的名称。', 'type' => 'string', 'example' => '管理员'],
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'LoginName' => ['description' => '坐席登录名。', 'type' => 'string', 'example' => 'agent'],
'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => 'username@example.com'],
'WorkMode' => [
'description' => '工作模式。'."\n",
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1382114****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'RoleName' => [
'description' => '角色名称。',
'type' => 'string',
'enumValueTitles' => ['Agent' => '坐席', 'Manager' => '技能组组长', 'Admin' => '管理员'],
'example' => 'Admin',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'RoleId' => ['description' => '角色ID,格式为:角色@实例ID。', 'type' => 'string', 'example' => 'Admin@ccc-test'],
],
'description' => '',
],
],
'NumberList' => [
'description' => '号码列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Active' => ['description' => '是否可用。', 'type' => 'boolean', 'example' => 'true'],
'UserId' => ['description' => '坐席ID。如果此参数不为空,说明该号码是座席个人外呼号码。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '0830011****'],
'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '乐山'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Usage' => [
'description' => '号码用途。',
'type' => 'string',
'enumValueTitles' => ['Outbound' => '呼出', 'Inbound' => '呼入', 'Bidirection' => '呼入及呼出'],
'example' => 'Bidirection',
],
'ContactFlowId' => ['description' => '该电话号码所关联的联系流ID(IVR)。', 'type' => 'string', 'example' => '2ec7a58f-3243-4815-bb21-97b480b95f5e'],
'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '四川'],
'SkillGroups' => [
'description' => '号码所关联的技能组列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '技能组展示名。', 'type' => 'string', 'example' => '测试技能组'],
'Description' => ['description' => '技能组描述。', 'type' => 'string', 'example' => '云联络中心的测试技能组。'],
'PhoneNumberCount' => ['description' => '技能组关联的号码数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'UserCount' => ['description' => '技能组关联的坐席数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Name' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'ChatbotBusinessUnit' => [
'type' => 'object',
'properties' => [
'UnitId' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'UnitKey' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
'AgentType' => ['type' => 'string', 'description' => ''],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"Data\\": {\\n \\"Status\\": \\"RUNNING\\",\\n \\"ConsoleUrl\\": \\"https://ccc-v2.aliyun.com/#/workbench/ccc-test\\",\\n \\"Description\\": \\"云联络中心的测试实例。\\",\\n \\"AliyunUid\\": \\"157123456789****\\",\\n \\"Name\\": \\"测试实例\\",\\n \\"DomainName\\": \\"ccc-test\\",\\n \\"Id\\": \\"ccc-test\\\\n\\",\\n \\"AdminList\\": [\\n {\\n \\"DisplayName\\": \\"管理员\\",\\n \\"Extension\\": \\"8032****\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\"\\n }\\n ],\\n \\"NumberList\\": [\\n {\\n \\"Active\\": true,\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Number\\": \\"0830011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"ContactFlowId\\": \\"2ec7a58f-3243-4815-bb21-97b480b95f5e\\",\\n \\"Province\\": \\"四川\\",\\n \\"SkillGroups\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"PhoneNumberCount\\": 1,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"UserCount\\": 3,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"skillgroup\\"\\n }\\n ]\\n }\\n ],\\n \\"ChatbotBusinessUnit\\": {\\n \\"UnitId\\": 0,\\n \\"UnitKey\\": \\"\\"\\n },\\n \\"AgentType\\": \\"\\"\\n }\\n}","type":"json"}]',
'title' => '获取实例',
'changeSet' => [
['createdAt' => '2025-10-16T07:13:16.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'GetInstanceTrendingReport' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间戳,默认是当天开始时间,最早为当前时间往前180天,开始和截止时间间隔不能超过7天,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1604639129000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '截止时间戳,默认是当前时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1604725528000'],
],
[
'name' => 'MediaType',
'in' => 'query',
'schema' => ['description' => '媒体类型,默认是语音(Audio), 其他可选参数包括Chat和Video.', 'type' => 'string', 'required' => false, 'example' => 'Audio'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'Inbound' => [
'description' => '呼入指标。',
'type' => 'array',
'items' => [
'description' => '呼入指标分段统计数据。',
'type' => 'object',
'properties' => [
'StatsTime' => ['description' => '分段统计的开始时间点,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000'],
'CallsQueued' => ['description' => '进入队列的电话数,如果一个电话多次进队列,算一通。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAbandonedInRing' => ['description' => '振铃放弃量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsHandled' => ['description' => '座席应答电话数。一通电话分给多个座席,算一通。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalCalls' => ['description' => '总进线量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAbandonedInIVR' => ['description' => 'IVR放弃量,即电话进入IVR流程之后在IVR环节放弃。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAbandonedInQueue' => ['description' => '队列放弃量,即电话进入技能组之后在排队环节放弃。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
],
],
],
'Outbound' => [
'description' => '呼出指标。',
'type' => 'array',
'items' => [
'description' => '呼出指标分段统计数据。',
'type' => 'object',
'properties' => [
'StatsTime' => ['description' => '分段统计的开始时间点,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000'],
'CallsAnswered' => ['description' => '外呼接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalCalls' => ['description' => '总外呼量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
],
],
],
'Overall' => [
'description' => '整体指标。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StatsTime' => ['description' => '分段统计的开始时间点,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000'],
'MaxLoggedInAgents' => ['description' => '此时间范围内最多同时登录的座席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '102'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
],
'title' => '获取实例趋势报表',
'summary' => '调用GetInstanceTrendingReport获取指定实例的变化趋势报表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-07T07:21:05.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceTrendingReport'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": {\\n \\"Inbound\\": [\\n {\\n \\"StatsTime\\": 1604639129000,\\n \\"CallsQueued\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalCalls\\": 0,\\n \\"CallsAbandonedInIVR\\": 0,\\n \\"CallsAbandonedInQueue\\": 0\\n }\\n ],\\n \\"Outbound\\": [\\n {\\n \\"StatsTime\\": 1604639129000,\\n \\"CallsAnswered\\": 0,\\n \\"TotalCalls\\": 0\\n }\\n ],\\n \\"Overall\\": [\\n {\\n \\"StatsTime\\": 1604639129000,\\n \\"MaxLoggedInAgents\\": 102\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>943D8EF3-3321-471F-A104-51C96FCA94D6</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Inbound>\\n <TotalCalls>0</TotalCalls>\\n <CallsAbandonedInQueue>0</CallsAbandonedInQueue>\\n <CallsQueued>0</CallsQueued>\\n <CallsAbandonedInRing>0</CallsAbandonedInRing>\\n <CallsHandled>0</CallsHandled>\\n <StatsTime>1604639129000</StatsTime>\\n <CallsAbandonedInIVR>0</CallsAbandonedInIVR>\\n </Inbound>\\n <Outbound>\\n <CallsAnswered>0</CallsAnswered>\\n <TotalCalls>0</TotalCalls>\\n <StatsTime>1604639129000</StatsTime>\\n </Outbound>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'GetIvrTrackingSummary' => [
'summary' => '获取IVR轨迹小结',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccKJSOHN'],
],
'parameters' => [
[
'name' => 'ContactId',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'example' => 'job-489361145506897920'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0f7ad007-ab50-4b3d-a87a-56864eb40dab'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Unknown error code \'NoPermission.Recording\'. Reason: null'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE '],
'Data' => ['description' => '返回数据结果。', 'type' => 'string', 'example' => '无'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'],
],
500 => [
['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Unknown error code \'NoPermission.Recording\'. Reason: null\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\\\t\\",\\n \\"Data\\": \\"无\\"\\n}","type":"json"}]',
'title' => '获取IVR轨迹总结',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'GetLoginDetails' => [
'summary' => '调用GetLoginDetails获取坐席的登录信息,包括坐席基本信息、服务器地址信息、鉴权信息等,该接口只允许自己调用,管理员无权替他人调用。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBRR180'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID,非必填,不填则默认使用当前RAM账户映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
[
'name' => 'ChatDeviceId',
'in' => 'query',
'schema' => ['description' => 'Chat设备ID。', 'type' => 'string', 'required' => false, 'example' => '4c51c9116c36537cb850dc1081d745df'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F1A4774A-F28B-5C40-AEF6-D88D2DD6C7E4'],
'Params' => [
'description' => '响应参数',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '登录信息数据。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '坐席展示名。', 'type' => 'string', 'example' => '坐席小王'],
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8001****'],
'Signature' => ['description' => '签名信息,使用非对称加密算法生成,注册SIP服务器时需要使用该信息进行鉴权。', 'type' => 'string', 'example' => 'zi31STIMtIfa/UN2l+6lww****'],
'SipServerUrl' => ['description' => 'SIP注册服务器地址,坐席需要以SIP用户的身份注册到服务器上才能进行话务操作。', 'type' => 'string', 'example' => 'sh-sip-ccc.aliyuncs.com:443'],
'DeviceId' => ['description' => '如果座席注册了SIP话机,则此参数是SIP话机设备的设备ID,否则为空。', 'type' => 'string', 'example' => 'Yealink SIP-T23G 44.84.XX.XX'],
'AgentServerUrl' => ['description' => '坐席数据推送服务器地址,连接成功后,服务器会推送坐席状态数据到坐席工作台。', 'type' => 'string', 'example' => 'sh-wss-ccc.aliyuncs.com'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'UserKey' => ['description' => '签名数据,用于生成签名信息,由于该签名机制不支持中文,所以目前都使用UserKey2进行签名。', 'type' => 'string', 'example' => '坐席@aliyun:802001:1656406628862'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'UserKey2' => ['description' => '签名数据,用于生成签名信息,由于UserKey不支持中文签名,因此新增了UserKey2。', 'type' => 'string', 'example' => '802001:1656406628862"'],
'Signature2' => ['description' => '签名信息,使用非对称加密算法生成,注册SIP服务器时需要使用该信息进行鉴权。', 'type' => 'string', 'example' => 'zi31STIMtIfa/UN2l+6lww****'],
'DeviceExt' => ['description' => 'SIP设备分机号,使用SIP话机时需要用到该字段。', 'type' => 'string', 'example' => '8033****'],
'DeviceState' => [
'description' => 'SIP设备状态。',
'type' => 'string',
'enumValueTitles' => ['UNREGISTERED' => '未注册', 'ONLINE' => '在线', 'OFFLINE' => '离线'],
'example' => 'OFFLINE',
],
'ChatUserId' => ['description' => 'Chat会话设备ID。', 'type' => 'string', 'example' => 'A-8000100x'],
'ChatDeviceId' => ['description' => 'Chat设备ID。', 'type' => 'string', 'example' => '4c51c9116c36537cb850dc1081d745df'],
'ChatLoginToken' => ['description' => 'Chat会话登录令牌。', 'type' => 'string', 'example' => '{"accessToken":"oauth_cloud_key:4xxx0=","accessTokenExpiredTime":864xxxx,"refreshToken":"oauth_cloud_key:Paxxxx=="}'],
'ChatAppId' => ['description' => 'Chat会话应用ID。', 'type' => 'string', 'example' => '7pjxxx'],
'ChatAppKey' => ['description' => 'Chat会话应用密钥。', 'type' => 'string', 'example' => '955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0'],
'ChatServerUrl' => ['description' => 'Chat会话服务器地址。', 'type' => 'string', 'example' => 'wss://wss.im.dingtalk.cn'],
'Nickname' => ['description' => '坐席昵称', 'type' => 'string', 'example' => '老王'],
'AvatarUrl' => ['description' => '坐席头像地址。', 'type' => 'string', 'example' => 'http://abc.com/sam.jpb'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
],
'title' => '获取登录信息',
'changeSet' => [
['createdAt' => '2023-11-07T07:21:07.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2022-01-19T00:08:15.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-12-22T06:05:17.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLoginDetails'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"F1A4774A-F28B-5C40-AEF6-D88D2DD6C7E4\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"Extension\\": \\"8001****\\",\\n \\"Signature\\": \\"zi31STIMtIfa/UN2l+6lww****\\",\\n \\"SipServerUrl\\": \\"sh-sip-ccc.aliyuncs.com:443\\",\\n \\"DeviceId\\": \\"Yealink SIP-T23G 44.84.XX.XX\\",\\n \\"AgentServerUrl\\": \\"sh-wss-ccc.aliyuncs.com\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"UserKey\\": \\"坐席@aliyun:802001:1656406628862\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"UserKey2\\": \\"802001:1656406628862\\\\\\"\\",\\n \\"Signature2\\": \\"zi31STIMtIfa/UN2l+6lww****\\",\\n \\"DeviceExt\\": \\"8033****\\",\\n \\"DeviceState\\": \\"OFFLINE\\",\\n \\"ChatUserId\\": \\"A-8000100x\\",\\n \\"ChatDeviceId\\": \\"4c51c9116c36537cb850dc1081d745df\\",\\n \\"ChatLoginToken\\": \\"{\\\\\\"accessToken\\\\\\":\\\\\\"oauth_cloud_key:4xxx0=\\\\\\",\\\\\\"accessTokenExpiredTime\\\\\\":864xxxx,\\\\\\"refreshToken\\\\\\":\\\\\\"oauth_cloud_key:Paxxxx==\\\\\\"}\\",\\n \\"ChatAppId\\": \\"7pjxxx\\",\\n \\"ChatAppKey\\": \\"955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0\\",\\n \\"ChatServerUrl\\": \\"wss://wss.im.dingtalk.cn\\",\\n \\"Nickname\\": \\"老王\\",\\n \\"AvatarUrl\\": \\"http://abc.com/sam.jpb\\"\\n }\\n}","type":"json"}]',
],
'GetMonoRecording' => [
'summary' => '调用GetMonoRecording获取指定实例下指定通话的单轨录音,单轨录音只有一个音轨,坐席侧和客户侧的录音合并到了同一个音轨上,格式为WAV。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccKYIENB'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103689****'],
],
[
'name' => 'ExpireSeconds',
'in' => 'query',
'schema' => ['description' => '过期时间,单位秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'FileUrl' => ['description' => '录音文件的OSS下载地址,注意下载地址的过期时间,下载地址的有效期为1天。', 'type' => 'string', 'example' => 'http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record/job-6538214103689****.wav?Expires=1610910578&OSSAccessKeyId=****&Signature=****'],
'FileName' => ['description' => '录音文件名称。', 'type' => 'string', 'example' => 'job-6538214103689****.wav'],
'Duration' => ['description' => '录音时长,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '30000'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取单轨录音',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-06-05T09:01:48.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '400', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMonoRecording'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record/job-6538214103689****.wav?Expires=1610910578&OSSAccessKeyId=****&Signature=****\\",\\n \\"FileName\\": \\"job-6538214103689****.wav\\",\\n \\"Duration\\": 30000\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <FileUrl>http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record/job-65382141036893491.wav?Expires=1610910578&OSSAccessKeyId=XXXX&Signature=XXXX</FileUrl>\\n <FileName>job-65382141036893491.wav</FileName>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'GetMultiChannelRecording' => [
'summary' => '调用GetMultiChannelRecording获取指定实例下指定通话的多轨录音,多轨录音中坐席和客户的录音分布在不同的声道上,每次播放时只能单个声道播放,也就是只能听到其中一方的声音,格式为MKV。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccKYIENB'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103689****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'FileUrl' => ['description' => '录音文件的OSS下载地址,注意下载地址的过期时间,下载地址的有效期为1天。', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2021/04/job-6538214103689****.mkv?Expires=1617435462&OSSAccessKeyId=****&Signature=****'],
'FileName' => ['description' => '录音文件名称。', 'type' => 'string', 'example' => 'job-6538214103689****.mkv'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取多轨录音',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMultiChannelRecording'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2021/04/job-6538214103689****.mkv?Expires=1617435462&OSSAccessKeyId=****&Signature=****\\",\\n \\"FileName\\": \\"job-6538214103689****.mkv\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <FileUrl>http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record/job-65382141036893491.mkv?Expires=1610910578&OSSAccessKeyId=XXXX&Signature=XXXX</FileUrl>\\n <FileName>job-65382141036893491.mkv</FileName>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'GetNumberLocation' => [
'summary' => '调用接口GetNumberLocation获取号码归属地信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => ['description' => '待查询的号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1312121****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '584AA2E3-9AC4-561B-BC8D-C74BA11B1387'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '1312121****'],
'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '北京'],
'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '北京'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取号码归属地信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNumberLocation'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"584AA2E3-9AC4-561B-BC8D-C74BA11B1387\\",\\n \\"Data\\": {\\n \\"Number\\": \\"1312121****\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\"\\n }\\n}","type":"json"}]',
],
'GetRealtimeCampaignStats' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccQFUGXR'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'."\n"],
],
[
'name' => 'QueueId',
'in' => 'query',
'schema' => ['title' => '活动ID', 'description' => '预测式外呼活动ID。'."\n"
."\n", 'type' => 'string', 'required' => true, 'example' => 'skillgroup@ccc-test'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '42970829-E2C8-515A-8F42-5A6B59F852A7'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'LoggedInAgents' => ['description' => '在线坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'ReadyAgents' => ['description' => '空闲坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'BreakingAgents' => ['description' => '小休坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'TalkingAgents' => ['description' => '通话中坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
'WorkingAgents' => ['description' => '话后处理坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'Caps' => ['description' => '每秒并发呼叫量,并发指同时呼叫。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'TotalAgents' => ['description' => '所有坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'OutboundScenarioReadyAgents' => ['description' => '处于仅外呼模式且在空闲状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'OutboundScenarioBreakingAgents' => ['description' => '处于仅外呼模式且在小休状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'OutboundScenarioTalkingAgents' => ['description' => '处于仅外呼模式且在通话中状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'OutboundScenarioWorkingAgents' => ['description' => '处于仅外呼模式且在话后处理状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
],
],
],
],
'title' => '获取预测式外呼活动实时坐席状态',
'summary' => '调用GetRealtimeCampaignStats获取指定实例下指定ID对应的预测式外呼活动的实时坐席状态数据。',
'changeSet' => [
['createdAt' => '2023-11-07T07:21:06.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRealtimeCampaignStats'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"42970829-E2C8-515A-8F42-5A6B59F852A7\\",\\n \\"Data\\": {\\n \\"LoggedInAgents\\": 10,\\n \\"ReadyAgents\\": 3,\\n \\"BreakingAgents\\": 1,\\n \\"TalkingAgents\\": 4,\\n \\"WorkingAgents\\": 2,\\n \\"Caps\\": 5,\\n \\"TotalAgents\\": 10,\\n \\"OutboundScenarioReadyAgents\\": 1,\\n \\"OutboundScenarioBreakingAgents\\": 1,\\n \\"OutboundScenarioTalkingAgents\\": 1,\\n \\"OutboundScenarioWorkingAgents\\": 1\\n }\\n}","type":"json"}]',
],
'GetRealtimeInstanceStates' => [
'summary' => '调用GetRealtimeInstanceStates获取指定实例的实时状态。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccTMAX45'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'MediaType',
'in' => 'query',
'schema' => [
'description' => '媒体类型,默认是语音(AUDIO)。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['ALL' => '全部', 'VIDEO' => '视频', 'CHAT' => '聊天', 'AUDIO' => '语音'],
'example' => 'AUDIO',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'WorkingAgents' => ['description' => '处于话后处理状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'LongestWaitingTime' => ['description' => '当前正在排队的来电的最大排队等待时长。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'LoggedInAgents' => ['description' => '在线坐席数量(包括就绪,小休,通话等非下线状态的坐席)。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalAgents' => ['description' => '总坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'WaitingCalls' => ['description' => '当前正在排队的来电的个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'BreakingAgents' => ['description' => '处于小休状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TalkingAgents' => ['description' => '处于通话状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'InteractiveCalls' => ['description' => '正在IVR中交互的电话的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ReadyAgents' => ['description' => '处于就绪状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'BreakCodeDetailList' => [
'description' => '各个小休码次数分布列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BreakCode' => ['description' => '小休码。', 'type' => 'string', 'example' => '默认'],
'Count' => ['description' => '小休次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
],
'title' => '获取实时实例状态',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-07T07:21:06.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRealtimeInstanceStates'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": {\\n \\"WorkingAgents\\": 0,\\n \\"LongestWaitingTime\\": 0,\\n \\"LoggedInAgents\\": 0,\\n \\"TotalAgents\\": 0,\\n \\"WaitingCalls\\": 0,\\n \\"BreakingAgents\\": 0,\\n \\"TalkingAgents\\": 0,\\n \\"InteractiveCalls\\": 0,\\n \\"ReadyAgents\\": 0,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"默认\\",\\n \\"Count\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>943D8EF3-3321-471F-A104-51C96FCA94D6</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <BreakingAgents>0</BreakingAgents>\\n <TalkingAgents>0</TalkingAgents>\\n <InstanceId>ccc-test</InstanceId>\\n <LoggedInAgents>0</LoggedInAgents>\\n <ReadyAgents>0</ReadyAgents>\\n <WaitingCalls>0</WaitingCalls>\\n <LongestCall>0</LongestCall>\\n <TotalAgents>0</TotalAgents>\\n <InteractiveCalls>0</InteractiveCalls>\\n <WorkingAgents>0</WorkingAgents>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'GetSchema' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'parameters' => [
[
'name' => 'SchemaId',
'in' => 'formData',
'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'],
],
[
'name' => 'RequestId',
'in' => 'formData',
'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'GetSchemaResponse',
'description' => 'GetSchemaResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => '5e0964fd-951c-4e45-b518-d09d4d2db8ca'],
'Id' => ['description' => 'schema id', 'type' => 'string', 'example' => 'profile'],
'Description' => ['description' => '描述', 'type' => 'string', 'example' => '客户profile'],
'Properties' => [
'description' => '字段列表',
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'DisplayName' => ['type' => 'string', 'description' => '显示名称', 'example' => '姓名'],
'Description' => ['type' => 'string', 'description' => '描述', 'example' => 'name'],
'Name' => ['type' => 'string', 'description' => '名称', 'example' => 'name'],
'DataType' => ['type' => 'string', 'example' => 'string', 'description' => '数据类型'],
'Pattern' => ['type' => 'string', 'example' => '^', 'description' => '正则表达式校验规则'],
'PatternErrorMessage' => ['type' => 'string', 'example' => '不是有效的email地址', 'description' => '正则表达式校验错误提示信息'],
'MinLength' => ['type' => 'integer', 'format' => 'int32', 'description' => '最小长度', 'example' => '1'],
'MaxLength' => ['type' => 'integer', 'format' => 'int32', 'description' => '最大长度', 'example' => '10'],
'Minimum' => ['type' => 'number', 'format' => 'double', 'description' => '数字最小值', 'example' => '1'],
'Maximum' => ['type' => 'number', 'format' => 'double', 'example' => '10', 'description' => '数字最大值'],
'Required' => ['type' => 'boolean', 'description' => '是否必填', 'example' => 'false'],
'System' => ['type' => 'boolean', 'example' => 'false', 'description' => '是否是系统字段'],
'Disabled' => ['type' => 'boolean', 'description' => '是否被禁用', 'example' => 'false'],
'Array' => ['type' => 'boolean', 'description' => '是否是数组', 'example' => 'false'],
'ReadOnly' => ['type' => 'boolean', 'description' => '是否只读', 'example' => 'false'],
'EditorType' => ['type' => 'string', 'description' => '编辑器类型', 'example' => 'textbox'],
'Attributes' => ['type' => 'string', 'description' => '扩展属性', 'example' => '{}'],
'DisplayOrder' => ['type' => 'integer', 'format' => 'int32', 'description' => '列表展示顺序', 'example' => '1'],
'CreatedTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '创建时间', 'example' => '2021-07-14 10:48:43.0'],
'UpdatedTime' => ['type' => 'integer', 'format' => 'int64', 'example' => '2021-07-14 10:48:43.0', 'description' => '更新时间'],
'Creator' => ['type' => 'string', 'description' => '创建者', 'example' => 'tom'],
],
'description' => '字段',
],
],
'CreatedTime' => ['description' => '创建时间。'."\n", 'type' => 'string', 'example' => '2021-07-14 10:48:43.0'],
'UpdatedTime' => ['description' => '上次修改的时间。', 'type' => 'string', 'example' => '2021-07-14 10:48:43.0'],
'Deleted' => ['description' => '是否被删除', 'type' => 'boolean', 'example' => 'false'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '19D09CCC-F298-4124-849A-AFA217819011'],
'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'Service abnormal, the instance 0418 is ceased.'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"5e0964fd-951c-4e45-b518-d09d4d2db8ca\\",\\n \\"Id\\": \\"profile\\",\\n \\"Description\\": \\"客户profile\\",\\n \\"Properties\\": {\\n \\"key\\": {\\n \\"DisplayName\\": \\"姓名\\",\\n \\"Description\\": \\"name\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"string\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 10,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 0,\\n \\"UpdatedTime\\": 0,\\n \\"Creator\\": \\"tom\\"\\n }\\n },\\n \\"CreatedTime\\": \\"2021-07-14 10:48:43.0\\",\\n \\"UpdatedTime\\": \\"2021-07-14 10:48:43.0\\",\\n \\"Deleted\\": false\\n },\\n \\"RequestId\\": \\"19D09CCC-F298-4124-849A-AFA217819011\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Service abnormal, the instance 0418 is ceased.\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '获取Schema',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'GetSkillGroup' => [
'summary' => '调用GetSkillGroup获取指定实例下指定技能组ID对应的技能组的信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccPBOQGO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '技能组ID,格式为:技能组名称@实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CF1C21B9-2D49-4B54-880F-FBE248C16903'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '技能组展示名。', 'type' => 'string', 'example' => '测试技能组'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Name' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'],
'Description' => ['description' => '技能组的描述。', 'type' => 'string', 'example' => '云联络中心的测试技能组。'],
'SkillGroupId' => ['description' => '技能组ID,格式为:技能组名称@实例ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'MediaType' => ['description' => '媒体类型,默认是语音(AUDIO), 其他可选参数包括CHAT和VIDEO。', 'type' => 'string', 'example' => 'VIDEO'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取技能组',
'changeSet' => [
['createdAt' => '2023-11-06T05:44:50.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroup'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"CF1C21B9-2D49-4B54-880F-FBE248C16903\\",\\n \\"Data\\": {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"skillgroup\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"MediaType\\": \\"VIDEO\\"\\n }\\n}","type":"json"}]',
],
'GetSummaryTemplate' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => ['description' => '模板ID。', 'type' => 'string', 'required' => true, 'example' => '43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'GetSummaryTemplateResponse',
'description' => 'GetSummaryTemplateResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'TemplateId' => ['description' => '模板ID。', 'type' => 'string', 'example' => '43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492'."\n"],
'CategoryId' => ['description' => '小结类目ID。', 'type' => 'string', 'example' => '8939-4223-86d0-6bd187905cc8'],
'Name' => ['description' => '模板名称。', 'type' => 'string', 'example' => '测试模板'],
'State' => ['description' => '状态码。'."\n"
."\n"
.'- Enabled 启用中'."\n"
.'- Disabled 已禁用', 'type' => 'string', 'example' => 'Enabled'],
'Editor' => ['description' => '模板编辑人。', 'type' => 'string', 'example' => 'editor-xxx@ccc-test'],
'PropertyList' => [
'description' => '模板字段列表。',
'type' => 'array',
'items' => [
'description' => '字段定义。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '显示名称。', 'type' => 'string', 'example' => 'DisplayName-A'],
'Description' => ['description' => '字段描述。', 'type' => 'string', 'example' => 'Description-xxxx'],
'Name' => ['description' => '字段名称。', 'type' => 'string', 'example' => 'Name-A'],
'DataType' => ['description' => '数据类型'."\n"
.'。', 'type' => 'string', 'example' => 'string'."\n"],
'Pattern' => ['description' => '正则表达式校验规则。', 'type' => 'string', 'example' => '^'],
'PatternErrorMessage' => ['description' => '正则表达式校验错误提示信息。', 'type' => 'string', 'example' => '不是有效的email地址'."\n"],
'MinLength' => ['description' => '最小长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'MaxLength' => ['description' => '最大长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'Minimum' => ['description' => '数字最小值。', 'type' => 'number', 'format' => 'double', 'example' => '1'],
'Maximum' => ['description' => '数字最大值。', 'type' => 'number', 'format' => 'double', 'example' => '10'],
'Required' => ['description' => '是否必填。', 'type' => 'boolean', 'example' => 'false'],
'System' => ['description' => '是否是系统字段。', 'type' => 'boolean', 'example' => 'false'],
'Disabled' => ['description' => '是否被禁用。', 'type' => 'boolean', 'example' => 'false'],
'Array' => ['description' => '是否是数组。', 'type' => 'boolean', 'example' => 'false'],
'ReadOnly' => ['description' => '是否只读。', 'type' => 'boolean', 'example' => 'false'],
'EditorType' => ['description' => '编辑器类型。', 'type' => 'string', 'example' => 'textbox'],
'Attributes' => ['description' => '扩展属性。', 'type' => 'string', 'example' => '{}'],
'DisplayOrder' => ['description' => '列表展示顺序。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'CreatedTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1717664210000'],
'UpdatedTime' => ['description' => '更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1717664210000'],
'Creator' => ['description' => '创建者。', 'type' => 'string', 'example' => 'cretor-xxx@ccc-test'."\n"],
],
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30C7D235-DDCF-4C7F-A462-5E2598252C2B'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TemplateId\\": \\"43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492\\\\n\\",\\n \\"CategoryId\\": \\"8939-4223-86d0-6bd187905cc8\\",\\n \\"Name\\": \\"测试模板\\",\\n \\"State\\": \\"Enabled\\",\\n \\"Editor\\": \\"editor-xxx@ccc-test\\",\\n \\"PropertyList\\": [\\n {\\n \\"DisplayName\\": \\"DisplayName-A\\",\\n \\"Description\\": \\"Description-xxxx\\",\\n \\"Name\\": \\"Name-A\\",\\n \\"DataType\\": \\"string\\\\n\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\\\n\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 30,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 1717664210000,\\n \\"UpdatedTime\\": 1717664210000,\\n \\"Creator\\": \\"cretor-xxx@ccc-test\\\\n\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"30C7D235-DDCF-4C7F-A462-5E2598252C2B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '获取会话小结模板',
'summary' => '使用GetSummaryTemplate获取会话小结模板内容。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'GetTicket' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'TicketId',
'in' => 'query',
'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => true, 'example' => '3d26b90a-c5d2-4b09-8219-********'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'DescribeTicketResponse',
'description' => 'DescribeTicketResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'TicketId' => ['description' => '工单ID。', 'type' => 'string', 'example' => 'b3a6a131-359e-46bd-9bc5-1f5cb0ea093f'],
'TemplateId' => ['description' => '工单模板ID。', 'type' => 'string', 'example' => 'ccc-test_43c2671b-8939-4223-86d0-6bd187905cc8_*****0666238'],
'TemplateVersion' => ['description' => '工单模板版本。', 'type' => 'string', 'example' => '0'],
'Title' => ['description' => '工单标题。', 'type' => 'string', 'example' => '售后工单'],
'Context' => ['description' => '工单字段信息。', 'type' => 'string', 'example' => '{"productName":"商品A"}'],
'Assignee' => ['description' => '处理人ID。', 'type' => 'string', 'example' => 'agent1@ccc-test'],
'AssigneeName' => ['description' => '处理人名称。', 'type' => 'string', 'example' => '坐席A'],
'Creator' => ['description' => '创建人ID。', 'type' => 'string', 'example' => 'creator@ccc-test'."\n"],
'CreatorName' => ['description' => '创建者名称', 'type' => 'string', 'example' => '坐席B'],
'CategoryId' => ['description' => '工单类目ID。', 'type' => 'string', 'example' => '8939-4223-86d0-6bd187905cc8'],
'CategoryName' => ['description' => '工单类目名称。', 'type' => 'string', 'example' => '售后类目'],
'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'job-399383842187575296'],
'StartTime' => ['description' => '工单处理开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620259200000'],
'EndTime' => ['description' => '工单处理完成时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1687846259999'],
'CreatedTime' => ['description' => '工单创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620259200000'],
'UpdatedTime' => ['description' => '最近一次更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1693793208075'],
'CurrentTaskId' => ['description' => '当前节点ID。', 'type' => 'string', 'example' => '912f0b78-6639-4a93-ae18-0d832885c27e'],
'CurrentTaskName' => ['description' => '当前节点名称。', 'type' => 'string', 'example' => '节点1'],
'CurrentTaskStartTime' => ['description' => '当前节点开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1693793208075'],
'Source' => ['description' => '工单来源。'."\n"
.'- AUDIO: 语音业务。'."\n"
.'- CHAT: 网络业务。'."\n"
.'- Console:工单控制台创建。', 'type' => 'string', 'example' => 'Audio'],
'CustomerId' => ['description' => '客户ID,云联络中心客户资料中的客户ID。', 'type' => 'string', 'example' => '4223-86d0-6bd187905-891798749'],
'State' => ['description' => '工单状态。'."\n"
.'- Processing(处理中)'."\n"
.'- Withdrawal(已撤回)'."\n"
.'- Rejected(已退回)'."\n"
.'- Closed(已关单)', 'type' => 'string', 'example' => 'Processing'],
'CloseCode' => ['description' => '关单原因。'."\n"
.'- Completed(处理完成)'."\n"
.'- Terminated(取消)', 'type' => 'string', 'example' => 'Completed'],
'Comment' => ['description' => '处理意见。', 'type' => 'string', 'example' => '无'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BF268B34-09C2-43FD-BAC4-5D31EA633111'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TicketId\\": \\"b3a6a131-359e-46bd-9bc5-1f5cb0ea093f\\",\\n \\"TemplateId\\": \\"ccc-test_43c2671b-8939-4223-86d0-6bd187905cc8_*****0666238\\",\\n \\"TemplateVersion\\": \\"0\\",\\n \\"Title\\": \\"售后工单\\",\\n \\"Context\\": \\"{\\\\\\"productName\\\\\\":\\\\\\"商品A\\\\\\"}\\",\\n \\"Assignee\\": \\"agent1@ccc-test\\",\\n \\"AssigneeName\\": \\"坐席A\\",\\n \\"Creator\\": \\"creator@ccc-test\\\\n\\",\\n \\"CreatorName\\": \\"坐席B\\",\\n \\"CategoryId\\": \\"8939-4223-86d0-6bd187905cc8\\",\\n \\"CategoryName\\": \\"售后类目\\",\\n \\"JobId\\": \\"job-399383842187575296\\",\\n \\"StartTime\\": 1620259200000,\\n \\"EndTime\\": 1687846259999,\\n \\"CreatedTime\\": 1620259200000,\\n \\"UpdatedTime\\": 1693793208075,\\n \\"CurrentTaskId\\": \\"912f0b78-6639-4a93-ae18-0d832885c27e\\",\\n \\"CurrentTaskName\\": \\"节点1\\",\\n \\"CurrentTaskStartTime\\": 1693793208075,\\n \\"Source\\": \\"Audio\\",\\n \\"CustomerId\\": \\"4223-86d0-6bd187905-891798749\\",\\n \\"State\\": \\"Processing\\",\\n \\"CloseCode\\": \\"Completed\\",\\n \\"Comment\\": \\"无\\"\\n },\\n \\"RequestId\\": \\"BF268B34-09C2-43FD-BAC4-5D31EA633111\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '获取工单',
'summary' => '使用GetTicket获取指定工单信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'GetTicketSummaryReport' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'State',
'in' => 'query',
'schema' => ['description' => '工单状态。'."\n"
.'- Processing(处理中)'."\n"
.'- Withdrawal(已撤回)'."\n"
.'- Rejected(已退回)'."\n"
.'- Closed(已关单)', 'type' => 'string', 'required' => false, 'example' => '无'],
],
[
'name' => 'CategoryId',
'in' => 'query',
'schema' => ['description' => '工单类目ID。', 'type' => 'string', 'required' => false, 'example' => '43c2671b-***-***-86d0-6bd187905cc8'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,基于工单创建时间过滤。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1716998400000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,基于工单创建时间过滤。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1719590399999'],
],
[
'name' => 'Creator',
'in' => 'query',
'schema' => ['description' => '创建人ID。', 'type' => 'string', 'required' => false, 'example' => 'creator@ccc-test'],
],
[
'name' => 'Assignee',
'in' => 'query',
'schema' => ['description' => '处理者ID(坐席ID或技能组ID)。', 'type' => 'string', 'required' => false, 'example' => 'assignee@ccc-test'."\n"],
],
[
'name' => 'AssigneeType',
'in' => 'query',
'schema' => ['description' => '处理者类型。'."\n"
.'- Agent(坐席)'."\n"
.'- SkillGroup(技能组)', 'type' => 'string', 'required' => false, 'example' => 'Agent'],
],
[
'name' => 'Participant',
'in' => 'query',
'schema' => ['description' => '参与人ID。', 'type' => 'string', 'required' => false, 'example' => 'participant@ccc-test'."\n"],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页参数。默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EAF3C248-E123-441B-A545-B6CD02E98EED'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'TicketsCreated' => ['description' => '工单创建数量。', 'type' => 'string', 'example' => '10'],
'TicketsParticipated' => ['description' => '工单已处理数量。', 'type' => 'string', 'example' => '5'],
'TicketsAssigned' => ['description' => '工单待处理数量。', 'type' => 'string', 'example' => '3'],
],
],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EAF3C248-E123-441B-A545-B6CD02E98EED\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"TicketsCreated\\": \\"10\\",\\n \\"TicketsParticipated\\": \\"5\\",\\n \\"TicketsAssigned\\": \\"3\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
'title' => '获取工单处理数据',
'summary' => '使用GetTicketSummaryReport获取工单状态统计数据。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'GetTicketTemplate' => [
'summary' => '使用GetTicketTemplate获取工单模板定义信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccFSWXV5'],
],
'parameters' => [
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => ['description' => '模板ID。', 'type' => 'string', 'required' => false, 'example' => '4ca2e2-c8d19b82c-d7ce393ac8197d3ab'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'TemplateVersion',
'in' => 'query',
'schema' => ['description' => '模板版本。', 'type' => 'string', 'required' => false, 'example' => '1703517780627'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'GetTicketTemplateResponse',
'description' => 'GetTicketTemplateResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'TemplateId' => ['description' => '模板ID。', 'type' => 'string', 'example' => '4ca2e2-c8d19b82c-d7ce393ac8197d3ab'."\n"],
'Name' => ['description' => '模板名称。', 'type' => 'string', 'example' => '测试模板。'."\n"
."\n"],
'State' => ['description' => '状态码。', 'type' => 'string', 'example' => 'Enabled'],
'Editor' => ['description' => '模板编辑人。', 'type' => 'string', 'example' => 'editor-xxx@ccc-test'],
'CategoryId' => ['description' => '工单类目ID。', 'type' => 'string', 'example' => '43c2671b-****-4223-86d0-6bd187905cc8'],
'TicketFields' => [
'description' => '模板字段列表。',
'type' => 'array',
'items' => [
'description' => '模板字段。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '显示名称。', 'type' => 'string', 'example' => '姓名'],
'Description' => ['description' => '描述。', 'type' => 'string', 'example' => '姓名描述'],
'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'name'],
'DataType' => ['description' => '数据类型'."\n"
.'。', 'type' => 'string', 'example' => 'string'],
'Pattern' => ['description' => '正则表达式校验规则。', 'type' => 'string', 'example' => '^'],
'PatternErrorMessage' => ['description' => '正则表达式校验错误提示信息。', 'type' => 'string', 'example' => '不是有效的email地址'."\n"],
'MinLength' => ['description' => '最小长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'MaxLength' => ['description' => '最大长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'Minimum' => ['description' => '数字最小值。', 'type' => 'number', 'format' => 'double', 'example' => '1'],
'Maximum' => ['description' => '数字最大值。', 'type' => 'number', 'format' => 'double', 'example' => '10'],
'Required' => ['description' => '是否必填。', 'type' => 'boolean', 'example' => 'false'],
'System' => ['description' => '是否是系统字段。', 'type' => 'boolean', 'example' => 'false'],
'Disabled' => ['description' => '是否被禁用。', 'type' => 'boolean', 'example' => 'false'],
'Array' => ['description' => '是否是数组。', 'type' => 'boolean', 'example' => 'false'],
'ReadOnly' => ['description' => '是否只读。', 'type' => 'boolean', 'example' => 'false'],
'EditorType' => ['description' => '编辑器类型。', 'type' => 'string', 'example' => 'textbox'],
'Attributes' => ['description' => '扩展属性。', 'type' => 'string', 'example' => '{}'],
'DisplayOrder' => ['description' => '列表展示顺序。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'CreatedTime' => ['description' => '创建时间。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1717664210000'],
'UpdatedTime' => ['description' => '更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1717664210000'],
'Creator' => ['description' => '创建者。', 'type' => 'string', 'example' => 'creator@cccV2-kmz'],
],
],
],
'ProcessDefinition' => ['description' => '流程信息。', 'type' => 'string', 'example' => '[{\\"id\\":\\"TICKET_START\\",\\"name\\":\\"开始\\",\\"nodeIndex\\":0,\\"properties\\":{\\"position\\":{\\"x\\":250,\\"y\\":200}},\\"type\\":\\"TICKET_START\\",\\"events\\":[{\\"edgeId\\":\\"8bd07339\\",\\"sourceAnchor\\":0,\\"next\\":\\"APPROVAL__JNBSSREc\\",\\"targetAnchor\\":0}]},{\\"id\\":\\"TICKET_FINISH\\",\\"name\\":\\"结束\\",\\"nodeIndex\\":9999,\\"properties\\":{\\"position\\":{\\"x\\":767,\\"y\\":206}},\\"type\\":\\"TICKET_FINISH\\",\\"events\\":[]},{\\"id\\":\\"APPROVAL__JNBSSREc\\",\\"name\\":\\"流程节点\\",\\"nodeIndex\\":1,\\"properties\\":{\\"skillGroupId\\":\\"chat001@cccV2-kmz\\",\\"position\\":{\\"x\\":537,\\"y\\":164.5}},\\"type\\":\\"APPROVAL\\",\\"events\\":[{\\"edgeId\\":\\"74031613\\",\\"sourceAnchor\\":1,\\"next\\":\\"TICKET_FINISH\\",\\"targetAnchor\\":0}]}]'],
'UpdatedTime' => ['description' => '上次修改的时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1717664210000'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BF268B34-09C2-43FD-BAC4-5D31EA633111'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取工单模板',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TemplateId\\": \\"4ca2e2-c8d19b82c-d7ce393ac8197d3ab\\\\n\\",\\n \\"Name\\": \\"测试模板。\\\\n\\\\n\\",\\n \\"State\\": \\"Enabled\\",\\n \\"Editor\\": \\"editor-xxx@ccc-test\\",\\n \\"CategoryId\\": \\"43c2671b-****-4223-86d0-6bd187905cc8\\",\\n \\"TicketFields\\": [\\n {\\n \\"DisplayName\\": \\"姓名\\",\\n \\"Description\\": \\"姓名描述\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"string\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\\\n\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 30,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 1717664210000,\\n \\"UpdatedTime\\": 1717664210000,\\n \\"Creator\\": \\"creator@cccV2-kmz\\"\\n }\\n ],\\n \\"ProcessDefinition\\": \\"[{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_START\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"开始\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nodeIndex\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"position\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":250,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":200}},\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_START\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"events\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"edgeId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"8bd07339\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sourceAnchor\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"next\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"APPROVAL__JNBSSREc\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"targetAnchor\\\\\\\\\\\\\\":0}]},{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_FINISH\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"结束\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nodeIndex\\\\\\\\\\\\\\":9999,\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"position\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":767,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":206}},\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_FINISH\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"events\\\\\\\\\\\\\\":[]},{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"APPROVAL__JNBSSREc\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"流程节点\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nodeIndex\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"skillGroupId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"chat001@cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"position\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":537,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":164.5}},\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"APPROVAL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"events\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"edgeId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"74031613\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sourceAnchor\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"next\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_FINISH\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"targetAnchor\\\\\\\\\\\\\\":0}]}]\\",\\n \\"UpdatedTime\\": 1717664210000\\n },\\n \\"RequestId\\": \\"BF268B34-09C2-43FD-BAC4-5D31EA633111\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
],
'GetTurnCredentials' => [
'summary' => '调用GetTurnCredentials获取云联络中心前置接入点的连接凭证信息,主要包括鉴权需要用到的用户名和密码,通过前置接入点接入云联络中心可以有效提高网络质量和稳定性。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccTMAX45'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID,非必填,不填则默认使用当前RAM账户映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'UserName' => ['description' => '用户名。', 'type' => 'string', 'example' => '1602585817:****'],
'Password' => ['description' => '密码。', 'type' => 'string', 'example' => 'M0NQNG/uRUrfIxW7er/S9gKX****'],
],
],
'Params' => [
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
500 => [
['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'],
],
],
'title' => '获取接入点凭证',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-06T05:44:49.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTurnCredentials'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"UserName\\": \\"1602585817:****\\",\\n \\"Password\\": \\"M0NQNG/uRUrfIxW7er/S9gKX****\\"\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserName>1602585817:null</UserName>\\n <Password>M0NQNG/uRUrfIxW7er/S9gKXsT0=</Password>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'GetTurnServerList' => [
'summary' => '调用GetTurnServerList获取云联络中心的前置接入点列表,通过前置接入点接入云联络中心可以有效提高网络质量和网络稳定性。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccTMAX45'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string'],
'Message' => ['description' => '响应信息。', 'type' => 'string'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string'],
'Data' => ['description' => '数据,前置接入点服务器信息列表。', 'type' => 'string', 'example' => '['."\n"
.' {'."\n"
.' "region":"hangzhou",'."\n"
.' "name":"杭州",'."\n"
.' "domain":"turn-hz-ecs.ccc.aliyuncs.com",'."\n"
.' "cidr":"172.31.XX.XX/28"'."\n"
.' },'."\n"
.' {'."\n"
.' "region":"qingdao",'."\n"
.' "name":"青岛",'."\n"
.' "domain":"turn-qd-ecs.ccc.aliyuncs.com",'."\n"
.' "cidr":"172.31.XX.XX/28"'."\n"
.' },'."\n"
.' {'."\n"
.' "region":"shanghai",'."\n"
.' "name":"上海",'."\n"
.' "domain":"turn-sh-ecs.ccc.aliyuncs.com",'."\n"
.' "cidr":"172.31.XX.XX/28"'."\n"
.' },'."\n"
.' {'."\n"
.' "region":"chengdu",'."\n"
.' "name":"成都",'."\n"
.' "domain":"turn-cd-ecs.ccc.aliyuncs.com",'."\n"
.' "cidr":"172.31.XX.XX/28"'."\n"
.' },'."\n"
.' {'."\n"
.' "region":"beijing",'."\n"
.' "name":"北京",'."\n"
.' "domain":"turn-bj-ecs.ccc.aliyuncs.com",'."\n"
.' "cidr":"172.31.XX.XX/28"'."\n"
.' },'."\n"
.' {'."\n"
.' "region":"huanan",'."\n"
.' "name":"深圳",'."\n"
.' "domain":"turn-sz-ecs.ccc.aliyuncs.com",'."\n"
.' "cidr":"172.31.XX.XX/28"'."\n"
.' },'."\n"
.' {'."\n"
.' "region":"zhangbei",'."\n"
.' "name":"张北",'."\n"
.' "domain":"turn-zb-ecs.ccc.aliyuncs.com",'."\n"
.' "cidr":"172.31.XX.XX/28"'."\n"
.' }'."\n"
.']'],
'Params' => [
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取接入点列表',
'changeSet' => [
['createdAt' => '2023-11-06T05:44:49.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTurnServerList'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"[\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"hangzhou\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"杭州\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-hz-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"qingdao\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"青岛\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-qd-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"shanghai\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"上海\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-sh-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"chengdu\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"成都\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-cd-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"beijing\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"北京\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-bj-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"huanan\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"深圳\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-sz-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"zhangbei\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"张北\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-zb-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t}\\\\n]\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
],
'GetUploadAudioDataParams' => [
'summary' => '获取离线质检音频文件相关参数。一般情况下,如果客户在云联络中心中配置了质检功能,则需要离线质检的音频文件和相应的参数会自动传递给智能质检;只有当客户没有在云联络中心中配置质检功能,并且希望自己把云联络中心的录音推送给质检时才需要调用此接口获取推送质检录音的相关参数。',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '云联络中心实例ID', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test'],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'example' => 'job-38860977107324****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID,可用于接口的日志查询', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'],
'Data' => [
'description' => '数据。'."\n",
'type' => 'object',
'properties' => [
'ParamsStr' => ['description' => '离线质检音频文件相关参数', 'type' => 'string', 'example' => '{'."\n"
.' "autoSplit": 1,'."\n"
.' "appKey": ****,'."\n"
.' "sampleRate": 8,'."\n"
.' "callList": ['."\n"
.' {'."\n"
.' "callId": "job-46686139435843****",'."\n"
.' "validTimes": ['."\n"
.' {'."\n"
.' "begin_time": 0,'."\n"
.' "end_time": 30720,'."\n"
.' "speaker_id": "张**"'."\n"
.' }'."\n"
.' ],'."\n"
.' "resolveType": "ali-ACC",'."\n"
.' "instance": "c****",'."\n"
.' "callee": "153****",'."\n"
.' "accUid": 105****967,'."\n"
.' "callStartTime": 1704870035381,'."\n"
.' "customerServiceName": "张**",'."\n"
.' "tid": "2ccd8732-62ed-****b9",'."\n"
.' "callType": 1,'."\n"
.' "skillGroupUUID": "skg-default@c****",'."\n"
.' "caller": "2023****",'."\n"
.' "customerServicePhone": "80****54",'."\n"
.' "channels": ['."\n"
.' {'."\n"
.' "speaker_id": "张**",'."\n"
.' "channel_key": "ch-user-153****-80****54-1704870030317-job-46686139435843****"'."\n"
.' }'."\n"
.' ],'."\n"
.' "sourceType": 1,'."\n"
.' "channelKey": "ch-user-153****-80****54-1704870030317-job-46686139435843****",'."\n"
.' "skillGroupName": "金****",'."\n"
.' "voiceFileUrl": "https://ccc-***.oss-cn-****.aliyuncs.com/ccc-****/c****/2024/01/job-46686139435843****.mkv?Expires=****&OSSAccessKeyId=****&Signature=****",'."\n"
.' "skillGroupId": 0,'."\n"
.' "customerServiceId": 203242802****'."\n"
.' }'."\n"
.' ]'."\n"
.'}'],
],
],
],
'description' => '',
],
],
],
'title' => '获取离线质检音频相关参数',
'changeSet' => [
['createdAt' => '2022-08-24T07:34:47.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUploadAudioDataParams'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Data\\": {\\n \\"ParamsStr\\": \\"{\\\\n \\\\\\"autoSplit\\\\\\": 1,\\\\n \\\\\\"appKey\\\\\\": ****,\\\\n \\\\\\"sampleRate\\\\\\": 8,\\\\n \\\\\\"callList\\\\\\": [\\\\n {\\\\n \\\\\\"callId\\\\\\": \\\\\\"job-46686139435843****\\\\\\",\\\\n \\\\\\"validTimes\\\\\\": [\\\\n {\\\\n \\\\\\"begin_time\\\\\\": 0,\\\\n \\\\\\"end_time\\\\\\": 30720,\\\\n \\\\\\"speaker_id\\\\\\": \\\\\\"张**\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"resolveType\\\\\\": \\\\\\"ali-ACC\\\\\\",\\\\n \\\\\\"instance\\\\\\": \\\\\\"c****\\\\\\",\\\\n \\\\\\"callee\\\\\\": \\\\\\"153****\\\\\\",\\\\n \\\\\\"accUid\\\\\\": 105****967,\\\\n \\\\\\"callStartTime\\\\\\": 1704870035381,\\\\n \\\\\\"customerServiceName\\\\\\": \\\\\\"张**\\\\\\",\\\\n \\\\\\"tid\\\\\\": \\\\\\"2ccd8732-62ed-****b9\\\\\\",\\\\n \\\\\\"callType\\\\\\": 1,\\\\n \\\\\\"skillGroupUUID\\\\\\": \\\\\\"skg-default@c****\\\\\\",\\\\n \\\\\\"caller\\\\\\": \\\\\\"2023****\\\\\\",\\\\n \\\\\\"customerServicePhone\\\\\\": \\\\\\"80****54\\\\\\",\\\\n \\\\\\"channels\\\\\\": [\\\\n {\\\\n \\\\\\"speaker_id\\\\\\": \\\\\\"张**\\\\\\",\\\\n \\\\\\"channel_key\\\\\\": \\\\\\"ch-user-153****-80****54-1704870030317-job-46686139435843****\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"sourceType\\\\\\": 1,\\\\n \\\\\\"channelKey\\\\\\": \\\\\\"ch-user-153****-80****54-1704870030317-job-46686139435843****\\\\\\",\\\\n \\\\\\"skillGroupName\\\\\\": \\\\\\"金****\\\\\\",\\\\n \\\\\\"voiceFileUrl\\\\\\": \\\\\\"https://ccc-***.oss-cn-****.aliyuncs.com/ccc-****/c****/2024/01/job-46686139435843****.mkv?Expires=****&OSSAccessKeyId=****&Signature=****\\\\\\",\\\\n \\\\\\"skillGroupId\\\\\\": 0,\\\\n \\\\\\"customerServiceId\\\\\\": 203242802****\\\\n }\\\\n ]\\\\n}\\"\\n }\\n}","type":"json"}]',
],
'GetUser' => [
'summary' => '调用GetUser获取指定实例下指定坐席ID对应的坐席信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID,选填,UserId和Extension任选一个填写即可。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
[
'name' => 'Extension',
'in' => 'query',
'schema' => ['description' => '坐席分机号,选填,UserId和Extension任选一个填写即可。', 'type' => 'string', 'required' => false, 'example' => '8003****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '坐席展示名。', 'type' => 'string', 'example' => '坐席小王'],
'DisplayId' => ['description' => '坐席的工号。', 'type' => 'string', 'example' => '1001'],
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8003****'],
'LoginName' => ['description' => '坐席登录名。', 'type' => 'string', 'example' => 'agent'],
'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => 'username@example.com'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1391234****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'RoleName' => [
'description' => '角色名称。',
'type' => 'string',
'enumValueTitles' => ['Agent' => '坐席', 'Admin' => '管理员', 'Manager' => '技能组组长'],
'example' => 'Admin',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'RoleId' => ['description' => '角色ID,格式为:角色@实例ID。', 'type' => 'string', 'example' => 'Admin@ccc-test'],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'DeviceExt' => ['description' => 'SIP话机分机号,如果座席注册了SIP话机,则此参数为SIP话机设备的分机号。', 'type' => 'string', 'example' => '8033****'],
'DeviceState' => [
'description' => 'SIP话机设备的状态,如果未注册SIP话机,则状态为UNREGISTERED(未注册),如果SIP话机注册过但是不在线,则状态为OFFLINE(离线),如果SIP话机注册过并且在线则为ONLINE(在线)。',
'type' => 'string',
'enumValueTitles' => ['UNREGISTERED' => '未注册', 'OFFLINE' => '离线', 'ONLINE' => '在线'],
'example' => 'OFFLINE',
],
'Nickname' => ['description' => '坐席昵称', 'type' => 'string', 'example' => '阿云'],
'AvatarUrl' => ['description' => '坐席头像地址。', 'type' => 'string', 'example' => 'http://xxx.com/xxx.jpg'],
],
],
'Params' => [
'description' => '扩展参数',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取坐席',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-07T07:21:06.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-01-19T00:08:15.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-01-19T00:08:15.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUser'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"DisplayId\\": \\"1001\\",\\n \\"Extension\\": \\"8003****\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1391234****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"DeviceExt\\": \\"8033****\\",\\n \\"DeviceState\\": \\"OFFLINE\\",\\n \\"Nickname\\": \\"阿云\\",\\n \\"AvatarUrl\\": \\"http://xxx.com/xxx.jpg\\"\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <Extension>80xxxx91</Extension>\\n <LoginName>user-test</LoginName>\\n <DeviceState>OFFLINE</DeviceState>\\n <RoleName>Admin</RoleName>\\n <Email>user-test@aliyun-cc.com</Email>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>Yealink SIP-T23G 44.84.203.6</DeviceId>\\n <UserId>user-test@ccc-test</UserId>\\n <DisplayName>测试用户</DisplayName>\\n <DeviceExt>80xxxx33</DeviceExt>\\n <RoleId>Admin@ccc-test</RoleId>\\n <Mobile>139xxxx1234</Mobile>\\n <WorkMode>ON_SITE</WorkMode>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'GetVisitorLoginDetails' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ccc-test'],
],
[
'name' => 'VisitorId',
'in' => 'query',
'schema' => ['description' => '访客ID。', 'type' => 'string', 'required' => true, 'example' => 'fcd020fe-d8e4-40e5-8c77-1a272a174a7d'],
],
[
'name' => 'ChatDeviceId',
'in' => 'query',
'schema' => ['description' => 'Chat设备ID。', 'type' => 'string', 'required' => true, 'example' => '4c51c9116c36537cb850dc1081d745df'],
],
[
'name' => 'Token',
'in' => 'query',
'schema' => ['description' => '网络业务的渠道Token。', 'type' => 'string', 'required' => false, 'example' => '9XYGTGWtq2wFi_Bpg7aUnIoYi_vG_rO3b***YtsxbHRHrYHlz1LDBLJAyZcLxieRQR4h_6AnWvTjJeNU5jgxzO*****bHwej7WgWrmA'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '19D09CCC-F298-4124-849A-AFA217819011'],
'Params' => [
'description' => '参数信息。',
'type' => 'array',
'items' => ['description' => '参数列表。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'ChatLoginToken' => ['description' => 'Chat会话登录令牌。', 'type' => 'string', 'example' => '{"accessToken":"oauth_cloud_key:+4oJXUAFSWxGD2YuRW4V/oUN0/8qJGNc0I*********n1E3DOr3Q3lX00ZnTpyqRi8Y6hYoLYA7n2ZkWuv485hVtXeSgnIQkKxXPbMgwoLxWaK//lI5Dn/mb4YuDifigv+ZyFzc+07vxm9ZFu/NjA==","accessTokenExpiredTime":86400000,"refreshToken":"oauth_cloud_key:/U+8UueDmpeUszhXC+SWow4pNLZp2C***********U/377BNXF+Mjo1lFgDk6GtEjNNoJpapX2mHH8GcRke2+yKQs/w4gAN9xSMn543Ciung+93pXV6IpQGbEVlu"}'],
'ChatUserId' => ['description' => '访客的身份ID。', 'type' => 'string', 'example' => 'dac9c001****a15684ea91a81317'],
'ChatDeviceId' => ['description' => 'Chat设备ID。', 'type' => 'string', 'example' => '4c51c9116c36537cb850dc1081d745df'],
'ChatServerUrl' => ['description' => 'Chat会话服务器地址。', 'type' => 'string', 'example' => 'wss://wss.im.dingtalk.cn'],
'ChatAppKey' => ['description' => 'Chat会话应用密钥。', 'type' => 'string', 'example' => '955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0'],
'ChatAppId' => ['description' => 'Chat会话应用ID。', 'type' => 'string', 'example' => '7pjxxx'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"19D09CCC-F298-4124-849A-AFA217819011\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ChatLoginToken\\": \\"{\\\\\\"accessToken\\\\\\":\\\\\\"oauth_cloud_key:+4oJXUAFSWxGD2YuRW4V/oUN0/8qJGNc0I*********n1E3DOr3Q3lX00ZnTpyqRi8Y6hYoLYA7n2ZkWuv485hVtXeSgnIQkKxXPbMgwoLxWaK//lI5Dn/mb4YuDifigv+ZyFzc+07vxm9ZFu/NjA==\\\\\\",\\\\\\"accessTokenExpiredTime\\\\\\":86400000,\\\\\\"refreshToken\\\\\\":\\\\\\"oauth_cloud_key:/U+8UueDmpeUszhXC+SWow4pNLZp2C***********U/377BNXF+Mjo1lFgDk6GtEjNNoJpapX2mHH8GcRke2+yKQs/w4gAN9xSMn543Ciung+93pXV6IpQGbEVlu\\\\\\"}\\",\\n \\"ChatUserId\\": \\"dac9c001****a15684ea91a81317\\",\\n \\"ChatDeviceId\\": \\"4c51c9116c36537cb850dc1081d745df\\",\\n \\"ChatServerUrl\\": \\"wss://wss.im.dingtalk.cn\\",\\n \\"ChatAppKey\\": \\"955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0\\",\\n \\"ChatAppId\\": \\"7pjxxx\\"\\n }\\n}","type":"json"}]',
'title' => '获取访客登录信息',
'summary' => '调用GeVisitortLoginDetails获取网络业务访客的登录信息,服务器地址信息、鉴权信息等。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'GetVoicemailRecording' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccKYIENB'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => ['description' => '通话ID,请确保该通话ID存在语音信箱留言,否则返回结果将没有数据。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-12515239414412****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'FileUrl' => ['description' => '录音文件的OSS下载地址,注意下载地址的过期时间,下载地址的有效期为1天。', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2022/06/voicemail.job-054ded02****.wav?Expires=1656074923&OSSAccessKeyId=****&Signature=****'],
'FileName' => ['description' => '录音文件名字。', 'type' => 'string', 'example' => 'voicemail.job-054ded02****.wav'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取语音信箱录音',
'summary' => '调用GetVoicemailRecording获取指定实例下指定通话的语音信箱留言的录音,录音为单轨录音,格式为WAV。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVoicemailRecording'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2022/06/voicemail.job-054ded02****.wav?Expires=1656074923&OSSAccessKeyId=****&Signature=****\\",\\n \\"FileName\\": \\"voicemail.job-054ded02****.wav\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetVoicemailRecordingResponse>\\n <Code>OK</Code>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Message>无</Message>\\n <RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n <Data>\\n <FileUrl>http://xxxx</FileUrl>\\n <FileName>abc</FileName>\\n </Data>\\n</GetVoicemailRecordingResponse>","errorExample":""}]',
],
'HoldCall' => [
'summary' => '调用HoldCall保持指定实例下指定通话ID对应的通话,通话被保持后,将暂时被挂起,此时被保持方会听到保持音乐。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '座席端提供的唯一ID,用来表示一个座席工作台,一个座席可以有多个不同类型的座席台,比如浏览器,iOS, Android等, 但是在同一时间,只能有一个生效。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ACC-YUNBS-1.0.10-****'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '话务ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6582589278232****'],
],
[
'name' => 'ChannelId',
'in' => 'query',
'schema' => ['description' => '待保持的通道ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ch:customer:010123****->1318888****:1609255715825:job-6582589278232****'],
],
[
'name' => 'Music',
'in' => 'query',
'schema' => ['description' => '通话保持音乐的名称,非必填,默认为空。', 'type' => 'string', 'required' => false, 'example' => '无'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '174F7777-2F6C-4F10-B889-C698E26C1AE0'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'CallContext' => [
'description' => '话务上下文环境。'."\n",
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '通话类型。'."\n",
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。'."\n", 'type' => 'string', 'example' => 'job-6582589278232****'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。'."\n", 'type' => 'string', 'example' => '1390501****'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'ANSWERED',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '8001****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'SkillGroupId' => ['description' => '话务通道关联的技能组ID,呼入场景下,关联的技能组ID由IVR中转人工模块配置的技能组决定,呼出场景下,关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609255716900'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'],
'CallType' => [
'description' => '话务通道的通话类型。'."\n",
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6582589278232****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '1318888****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8001****'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。'."\n",
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8001****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609255716908'],
'WorkMode' => [
'description' => '工作模式。'."\n",
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609255715822'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1390000****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6582589278232****'],
'UserState' => [
'description' => '座席状态。'."\n",
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'TALKING',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''],
['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作,用户状态不符合预期。'],
],
404 => [
['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'],
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'],
],
],
'title' => '保持通话',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-10-26T08:13:47.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'HoldCall'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"174F7777-2F6C-4F10-B889-C698E26C1AE0\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6582589278232****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609255716900,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6582589278232****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8001****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609255716908,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609255715822,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"job-6582589278232****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>174F7777-2F6C-4F10-B889-C698E26C1AE0</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <CallContext>\\n <InstanceId>无</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65825892782321664</JobId>\\n <ChannelContexts>\\n <Destination>8001****</Destination>\\n <ChannelState>ANSWERED</ChannelState>\\n <ReleaseReason>无</ReleaseReason>\\n <Originator>1318888****</Originator>\\n <ReleaseInitiator>无</ReleaseInitiator>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>8001****</UserExtension>\\n <CallType>OUTBOUND</CallType>\\n <AssociatedData>无</AssociatedData>\\n <SkillGroupId>skill-group@ccc-test</SkillGroupId>\\n <ChannelId>ch:user:1318888****->8001****:1609255715825:job-65825892782321664</ChannelId>\\n <Timestamp>1609255716900</Timestamp>\\n <JobId>job-65825892782321664</JobId>\\n </ChannelContexts>\\n </CallContext>\\n <UserContext>\\n <Extension>8001****</Extension>\\n <UserState>TALKING</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <BreakCode>Warm-up</BreakCode>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-bs990cd82101cc000176af19ec8e</DeviceId>\\n <Heartbeat>1609255716908</Heartbeat>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>1390000****</Mobile>\\n <JobId>job-65825892782321664</JobId>\\n <WorkMode>ON_SITE</WorkMode>\\n <Reserved>1609255715822</Reserved>\\n <SignedSkillGroupIdList>[\\"skill-group@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ImportAdmins' => [
'summary' => '导入一个或多个管理员到指定实例下,调用者需要拥有AliyunCCCFullAccess的权限,可以在RAM控制台进行授权。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'RamIdList',
'in' => 'query',
'schema' => ['description' => '阿里云RAM账户的UID列表,格式为JSON数组的字符串,数组元素最多20个。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["26972543893791****"]'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应数据',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CDB5C94-ACFB-59B5-85FE-C1DAF8049C63'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => [
'description' => '数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'RoleId' => ['description' => '角色ID。', 'type' => 'string', 'example' => 'Admin@ccc-test'],
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8021****'],
'RamId' => ['description' => '阿里云RAM账户的UID。', 'type' => 'string', 'example' => '26972543893791****'],
],
'description' => '',
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'],
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1CDB5C94-ACFB-59B5-85FE-C1DAF8049C63\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\",\\n \\"Extension\\": \\"8021****\\",\\n \\"RamId\\": \\"26972543893791****\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '导入多个管理员',
'changeSet' => [
['createdAt' => '2022-04-19T12:16:06.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportAdmins'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ImportContactFlow' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '251083',
'abilityTreeNodes' => ['FEATUREcccTPIKHY'],
],
'parameters' => [
[
'name' => 'FlowPackageData',
'in' => 'formData',
'schema' => ['description' => '数据', 'type' => 'string', 'required' => true, 'example' => '{}'],
],
[
'name' => 'RequestId',
'in' => 'formData',
'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE '],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ImportFlowResponse',
'description' => 'ImportFlowResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '27DD30C4-CAE2-481A-97CC-D3C54625341D'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27DD30C4-CAE2-481A-97CC-D3C54625341D\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '导入IVR流程',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ImportCorpNumbers' => [
'summary' => '导入自有线路号码,首次导入前,需联系云联络中心-售后技术支持进行加白。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'NumberList',
'in' => 'query',
'schema' => ['description' => '号码列表', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[\'029xxxxxx\']'],
],
[
'name' => 'TagList',
'in' => 'query',
'schema' => ['description' => '业务标签', 'type' => 'string', 'required' => false, 'example' => '无'],
],
[
'name' => 'Province',
'in' => 'query',
'schema' => ['description' => '省份', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '陕西'],
],
[
'name' => 'City',
'in' => 'query',
'schema' => ['description' => '城市', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '西安'],
],
[
'name' => 'Provider',
'in' => 'query',
'schema' => ['description' => '线路信息', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxx通信-陕西线路'],
],
[
'name' => 'CorpName',
'in' => 'query',
'schema' => ['description' => '企业名称', 'type' => 'string', 'required' => false, 'example' => 'xxx公司'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '错误码', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'C42981C7-93D9-55CD-B078-784F8522E0E1'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
],
],
'title' => '导入自有线路号码',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportCorpNumbers'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"C42981C7-93D9-55CD-B078-784F8522E0E1\\"\\n}","type":"json"}]',
],
'ImportCustomCallTagging' => [
'summary' => '调用ImportCustomCallTagging导入多个呼入号码标记到指定实例中。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'FilePath',
'in' => 'query',
'schema' => ['description' => '呼入号码标记文件的OSS对象的ObjectKey。OSS配置的是云呼的客户公共存储空间,您可以通过云呼叫中心的呼入控制页面上传呼入号码标记文件到客户公共存储空间,上传成功后,调用该接口就会从OSS中读取文件内容,然后批量导入。该接口不建议直接调用,建议通过云呼叫中心提供的公有云默认CRM系统操作。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'temp/ImportCustomCallTagging.xlsx'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n", 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'Data' => [
'description' => '创建失败的呼入号码标记列表。',
'type' => 'array',
'items' => [
'description' => '创建失败的呼入号码标记信息。',
'type' => 'object',
'properties' => [
'Item' => ['description' => '创建失败的呼入号码标记的号码。', 'type' => 'string', 'example' => '1312121****'],
'Reason' => [
'description' => '呼入号码标记创建失败原因。',
'type' => 'string',
'enumValueTitles' => ['CUSTOM_NUMBER_ILLEGAL' => '传入的列表中存在格式不合法的号码', 'CUSTOM_NUMBER_DUPLICATED' => '传入的列表中存在重复的号码', 'CUSTOM_NUMBER_ALREADY_EXISTS' => '传入的列表中存在已创建的号码标记', 'CUSTOM_NUMBER_TAG_NOT_EXIST' => '传入的列表中存在未创建的号码标签', 'CUSTOM_NUMBER_INSERT_DUPLICATED' => '后台写入呼入号码标记时存在重复项', 'CUSTOM_NUMBER_TOO_MANY_TAGS' => '传入的列表中存在超出号码标签个数上限的号码'],
'example' => 'CUSTOM_NUMBER_DUPLICATED',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
['errorCode' => 'Parameter.InvalidFileContent', 'errorMessage' => 'The content or format of the file (%s) is invalid.', 'description' => '参数错误,传入的文件内容无效。'],
],
404 => [
['errorCode' => 'NotExists.RamId', 'errorMessage' => 'RAM user %s does not exist.', 'description' => '指定的RAM用户不存在。'],
['errorCode' => 'NotExists.UserResourceFileKey', 'errorMessage' => 'User resource file key %s does not exist.', 'description' => 'OSS用户资源文件的Key不存在。'],
],
500 => [
['errorCode' => 'InternalService.OSS', 'errorMessage' => 'An internal OSS service error occurred. %s', 'description' => '内部OSS服务错误。'],
['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'],
],
],
'staticInfo' => [
'substitutions' => ['CCC::2020-07-01::ImportCustomCallTaggings'],
],
'title' => '导入呼入号码标记',
'changeSet' => [
['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportCustomCallTagging'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"Item\\": \\"1312121****\\",\\n \\"Reason\\": \\"CUSTOM_NUMBER_DUPLICATED\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<Message>无</Message>\\n<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Item>TagA</Item>\\n <Reason>CUSTOM_NUMBER_DUPLICATED</Reason>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ImportDoNotCallNumbers' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'NumberList',
'in' => 'query',
'schema' => ['description' => '禁止外呼号码列表,格式为JSON数组的字符串,数组元素是禁呼号码。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '["1900000****","1312121****"]'],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => ['description' => '禁呼号码的备注信息。', 'type' => 'string', 'required' => false, 'example' => '测试'],
],
[
'name' => 'FilePath',
'in' => 'query',
'schema' => ['description' => 'OSS文件的Key,可从GetDoNotCallFileUploadParameters接口返回值中获取,仅在文件上传方式导入时需要填写此参数。', 'type' => 'string', 'required' => false, 'example' => 'temp/blacklist/import/15772471154xxxx/ccc-test/20220315100340/blacklist.xlsx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'Params' => [
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '导入禁止外呼号码',
'summary' => '调用ImportDoNotCallNumbers向指定实例下导入一个或多个禁止外呼号码,导入方式包括手动录入和文件上传两种方式。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-06T05:44:49.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportDoNotCallNumbers'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Code>OK</Code>","errorExample":""}]',
],
'ImportDocuments' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'SchemaId',
'in' => 'formData',
'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'],
],
[
'name' => 'OssFileKey',
'in' => 'formData',
'schema' => ['description' => 'OSS文件的Key', 'type' => 'string', 'required' => true, 'example' => 'ccc-test/test-file.wav'],
],
[
'name' => 'RequestId',
'in' => 'formData',
'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ImportDocumentsResponse',
'description' => 'ImportDocumentsResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '01B12EE4-6AF2-4730-8B78-EC15F4E5C025'],
'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01B12EE4-6AF2-4730-8B78-EC15F4E5C025\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '导入文档',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ImportRamUsers' => [
'summary' => '将RAM中已存在的子账号导入为联络中心坐席。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'RoleId',
'in' => 'query',
'schema' => ['description' => '角色ID,坐席导入成功后在实例中的角色,包括管理员、技能组组长和坐席三种角色。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Agent@ccc-test'."\n"],
],
[
'name' => 'SkillLevelList',
'in' => 'query',
'schema' => ['description' => '技能组的技能等级列表,格式为JSON数组的字符串,数组元素是一个对象,包含两个字段:skillGroupId和skillLevel,skillGroupId填写坐席想要关联的技能组ID,skillLevel填写坐席在该技能组的技能等级,取值范围1-10,值越小,业务能力越强,单位时间内能处理更多的通话。', 'type' => 'string', 'required' => false, 'example' => '[{"skillGroupId":"skillgroup@ccc-test","skillLevel":5}]'."\n"],
],
[
'name' => 'RamIdList',
'in' => 'query',
'schema' => ['description' => '待添加的RAM用户ID列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["28036411123456****","29234301123456****"]'."\n"],
],
[
'name' => 'WorkMode',
'in' => 'query',
'schema' => ['description' => '工作模式。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ON_SITE'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Data' => ['description' => '数据,导入执行ID。', 'type' => 'string', 'example' => '1ca2b084-6f0a-454b-9851-29768a9a5832'."\n"],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'],
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '从RAM中导入坐席',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"1ca2b084-6f0a-454b-9851-29768a9a5832\\\\n\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","type":"json"}]',
],
'InitiateAttendedTransfer' => [
'summary' => '咨询转接通话到其他坐席或某个技能组队列或外部号码,咨询转接也叫关注转或双步转。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '发起咨询转接的坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ACC-YUNBS-1.0.10-****'],
],
[
'name' => 'Transferor',
'in' => 'query',
'schema' => ['description' => '转接发起方,当场景是咨询转接到外部号码时,用此参数指定的号码作为主叫,转内部坐席或技能组时,此参数无效,发起方由UserId指定。', 'type' => 'string', 'required' => false, 'example' => '无'],
],
[
'name' => 'Transferee',
'in' => 'query',
'schema' => ['description' => '被转接方,可以是坐席ID或技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent2@ccc-test'],
],
[
'name' => 'TimeoutSeconds',
'in' => 'query',
'schema' => ['description' => '咨询转接超时时间,超过指定时间被转接方没有接起通话,则挂断通话,此字段选填,默认30,单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'],
],
[
'name' => 'CallPriority',
'in' => 'query',
'schema' => ['description' => '转接到技能组队列时的排队优先级,取值范围0-9,0优先级最高,9最低。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'],
],
[
'name' => 'StrategyName',
'in' => 'query',
'schema' => ['description' => '转接到技能组队列时的座席分配策略名称。', 'type' => 'string', 'required' => false, 'example' => 'MOST_IDLE,MOST_SKILLED,MOST_ACQUAINTED,CUSTOMIZED等'],
],
[
'name' => 'StrategyParams',
'in' => 'query',
'schema' => ['description' => '转接到技能组队列时的座席分配策略参数。', 'type' => 'string', 'required' => false, 'example' => '当分配策略为CUSTOMIZED时,本参数的内容为如下格式:'."\n"
.' {'."\n"
.' "functionId": "512fed64-e379-400f-a1a5-14d5730xxxxx",'."\n"
.' "functionName": "routing-strategy-test-2"'."\n"
.'}'],
],
[
'name' => 'TransfereeType',
'in' => 'query',
'schema' => [
'description' => '转接目的类型,可选值为AGENT,SKILL_GROUP和EXTERNAL。如果此参数不传,则系统会根据转接的目标号码的格式进行判断,如果发现有判不准确的情况,则需要指定此参数。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['AGENT' => '座席', 'EXTERNAL' => '外部号码', 'SKILL_GROUP' => '技能组'],
'example' => 'SKILL_GROUP',
],
],
[
'name' => 'RoutingType',
'in' => 'query',
'schema' => [
'description' => '话务分配类型,可选参数为自动分配(Automatic)或者手动分配(Manual)。如果此参数为空,则默认为自动分配的方式,这也是当前系统的默认行为。选择手动分配方式时,需要您自己配合调用ClaimCall等接口把电话分给指定的座席。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Manual' => '手动分配', 'Automatic' => '自动分配'],
'example' => 'Automatic',
],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => ['description' => '随路数据,主要用于扩展需求,普通用户无需关心。', 'type' => 'string', 'required' => false, 'example' => 'a=b'],
],
[
'name' => 'QueuingTimeoutSeconds',
'in' => 'query',
'schema' => ['description' => '当转接目标是技能组队列时排队超时时间,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
[
'name' => 'QueuingOverflowThreshold',
'in' => 'query',
'schema' => ['description' => '当转接目标是技能组队列时排队溢出阈值。默认值为0,表示不溢出。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'ContextId' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '103655'],
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'Index' => ['description' => '记录这个Channel在通话过程中创建的顺序。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'ANSWERED',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'],
'example' => 'MONITORING',
],
'SkillGroupId' => ['description' => '话务通道关联的技能组ID,呼入场景下,关联的技能组ID由IVR中转人工模块配置的技能组决定,呼出场景下,关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'],
'CallType' => ['description' => '话务通道的通话类型。', 'type' => 'string', 'example' => 'OUTBOUND'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelId' => ['description' => '通道ID。', 'type' => 'string', 'example' => 'ch:user:139xxxx0501->80326034:1609138902226:job-6538214103685****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'TALKING',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''],
['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作,用户状态不符合预期。'],
],
404 => [
['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'],
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'],
],
],
'title' => '发起咨询转接',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-04-01T09:23:01.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-10-26T08:13:47.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-04-25T07:33:48.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-04-12T02:15:28.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitiateAttendedTransfer'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103655,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:139xxxx0501->80326034:1609138902226:job-6538214103685****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>10</Index>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'InterceptCall' => [
'summary' => '调用InterceptCall强行拆开指定实例下指定通话ID对应的通话,通话必须处于监听状态,且由监听者发起强拆,强拆成功后,原本与客户通话的坐席会被挂断,发起强拆的坐席代替原坐席继续与客户通话。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '发起强拆的坐席。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'],
],
[
'name' => 'InterceptedUserId',
'in' => 'query',
'schema' => ['description' => '被强拆的座席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent2@ccc-test'],
],
[
'name' => 'TimeoutSeconds',
'in' => 'query',
'schema' => ['description' => '强拆超时时间,经过指定的时间强拆仍未成功,则取消强拆,正常情况下,强拆操作会马上成功,设置超时时间是为了防止异常发生,此字段选填,默认30,单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '0', 'example' => '60'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'INTERCEPT',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'Index' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'ANSWERED',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'],
'example' => '无',
],
'SkillGroupId' => ['description' => '话务通道关联的技能组ID,呼入场景下,关联的技能组ID由IVR中转人工模块配置的技能组决定,呼出场景下,关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'INTERCEPT',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'TALKING',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''],
['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作,用户状态不符合预期。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'],
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'],
],
],
'title' => '强拆通话',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-06T05:44:49.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InterceptCall'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"INTERCEPT\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"无\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"INTERCEPT\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>10</Index>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'LaunchAuthentication' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccTPIKHY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '发起核身的坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ACC-YUNBS-1.0.10-****'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'],
],
[
'name' => 'ContactFlowId',
'in' => 'query',
'schema' => ['description' => 'IVR核身流程的联系流ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'af145gfc-1108-4d55-8fca-f719bd512ebb'],
],
[
'name' => 'ContactFlowVariables',
'in' => 'query',
'schema' => ['description' => '传递给联系流的变量,选填,这里配置的变量,可以在IVR流程中拿到并使用,格式为JSON字符串格式的键值对集合。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "customerID": "208880281831****",'."\n"
.' "operateType": "cipherCode",'."\n"
.' "taskId": "1234567890",'."\n"
.' "crmOther": "123"'."\n"
.'}'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '呼叫类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'Index' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'ANSWERED',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'],
'example' => 'MONITORING',
],
'SkillGroupId' => ['description' => '话务通道关联的技能组ID,呼入场景下,关联的技能组ID由IVR中转人工模块配置的技能组决定,呼出场景下,关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'TALKING',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
404 => [
['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'],
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'],
],
],
'title' => '发起IVR核身',
'summary' => '调用LaunchAuthentication使通话临时转入指定的IVR流程,调用此接口后,会在通话过程中进入IVR交互环节,通用用于核身操作。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-10-26T08:13:47.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LaunchAuthentication'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>10</Index>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'LaunchSurvey' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc3I1HSP'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '发起满意度的坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6580466654649****'],
],
[
'name' => 'ContactFlowId',
'in' => 'query',
'schema' => ['description' => 'IVR满意度流程的联系流ID,请确保填入的联系流ID是可用的满意度调查流程。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '4685b65a-eb8f-11ec-8ea0-0242ac120002'],
],
[
'name' => 'ContactFlowVariables',
'in' => 'query',
'schema' => ['description' => '传递给联系流的变量,这里配置的变量,可以在IVR流程中拿到并使用,格式为JSON字符串格式的键值对集合,非必填,默认为空。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "customerID": "208880281831****",'."\n"
.' "operateType": "cipherCode",'."\n"
.' "taskId": "1234567890",'."\n"
.' "crmOther": "123"'."\n"
.'}'],
],
[
'name' => 'SurveyChannel',
'in' => 'query',
'schema' => [
'description' => '满意度采集渠道,非必填,默认为语音满意度。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['IVR' => '语音满意度', 'SMS' => '短信满意度'],
'example' => 'IVR',
],
],
[
'name' => 'SmsMetadataId',
'in' => 'query',
'schema' => ['description' => '短信满意度配置ID,只有收集渠道为SMS时才需要填写此参数,非必填,默认为空。', 'type' => 'string', 'required' => false, 'example' => '4685b65a-eb8f-11ec-8ea0-0242ac120002'],
],
[
'name' => 'SurveyTemplateId',
'in' => 'query',
'schema' => ['description' => '满意度调查模版ID', 'type' => 'string', 'required' => false, 'example' => '19dc793c-9a01-4cb0-b7d5-fcb5431bab6b'],
],
[
'name' => 'SurveyTemplateVariables',
'in' => 'query',
'schema' => ['description' => '满意度调查配置', 'type' => 'string', 'required' => false, 'example' => '[]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => 'AF1E5957-5276-48FF-A6E6-347166A4ADCD'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'CallContext' => [
'description' => '话务上下文环境。'."\n",
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。'."\n", 'type' => 'string', 'example' => 'job-6580466654649****'],
'ChannelContexts' => [
'description' => '话务通道列表。'."\n",
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'Index' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '无'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'ANSWERED',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1318888****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'],
'example' => 'MONITORING',
],
'SkillGroupId' => ['description' => '话务通道关联的技能组ID,呼入场景下,关联的技能组ID由IVR中转人工模块配置的技能组决定,呼出场景下,关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609250655922'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '无'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6580466654649****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8001****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '1318888****'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。'."\n",
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8001****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609250656122'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609250655090'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1390000****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6580466654649****'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'TALKING',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
'ContextId' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '102323'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
404 => [
['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'],
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'],
],
],
'title' => '发起满意度调查',
'summary' => '调用LaunchSurvey发送满意度调查,该操作会导致挂机,如果是语音满意度,客户会在坐席挂机后进入IVR满意度调查流程,并在IVR流程中完成满意度采集。如果是短信满意度,则通话结束,客户收到满意度调查短信。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-08-13T06:54:43.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-06-21T06:40:16.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-10-26T08:13:47.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-12-22T03:36:07.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LaunchSurvey'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"AF1E5957-5276-48FF-A6E6-347166A4ADCD\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6580466654649****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1318888****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609250655922,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6580466654649****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8001****\\",\\n \\"Originator\\": \\"1318888****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609250656122,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609250655090,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"job-6580466654649****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n },\\n \\"ContextId\\": 102323\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>AF1E5957-5276-48FF-A6E6-347166A4ADCD</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <ContextId>123456789</ContextId>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65804666546491392</JobId>\\n <ChannelContexts>\\n <Destination>1318888****</Destination>\\n <ChannelState>ANSWERED</ChannelState>\\n <ReleaseInitiator>无</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>1</Index>\\n <AssociatedData>无</AssociatedData>\\n <SkillGroupId>skill-group@ccc-test</SkillGroupId>\\n <ChannelId>ch-user-1917047****-80154160-1655094662943-job-d4a3d2f1-7d8b-40a4-bd3d-3cc20842c620</ChannelId>\\n <Timestamp>1609250655922</Timestamp>\\n <ReleaseReason>无</ReleaseReason>\\n <Originator>1318888****</Originator>\\n <ChannelFlags>[]</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>8001****</UserExtension>\\n <JobId>job-65804666546491392</JobId>\\n </ChannelContexts>\\n </CallContext>\\n <UserContext>\\n <Extension>8001****</Extension>\\n <UserState>TALKING</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <BreakCode>default</BreakCode>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-bs3b5f22c6d78f000176aebe9471</DeviceId>\\n <Heartbeat>1609250656122</Heartbeat>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>1390000****</Mobile>\\n <JobId>job-65804666546491392</JobId>\\n <WorkMode>ON_SITE</WorkMode>\\n <Reserved>1609250655090</Reserved>\\n <SignedSkillGroupIdList>[\\"skill-group@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListAgentStateLogs' => [
'summary' => '调用ListAgentStateLogs获取指定实例下指定坐席的状态日志列表。注意本接口即将过期,请使用替代接口ListRealtimeAgentStates。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccSART34'],
],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间戳,默认是当天开始时间,最早为当前日期之前的180天,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1620230400000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '截止时间戳,默认是当前时间,EndTime和StartTime的时间差不能超过7天,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1620273600000'],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'],
'Data' => [
'description' => '数据。',
'type' => 'array',
'items' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'StartTime' => ['description' => '状态开始时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620259200000'],
'StateCode' => [
'description' => '子状态,状态码的补充说明,某些坐席状态由State和StateCode共同标识,例如:监听场景,状态为Talking,子状态为Monitoring。',
'type' => 'string',
'enumValueTitles' => ['Monitored' => '被监听', 'Consulted' => '被咨询', 'Consulting' => '咨询中', 'Conference' => '会议', 'Monitoring' => '监听中'],
'example' => 'CHECK_IN_BREAK',
],
'Duration' => ['description' => '状态持续时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '32'],
'State' => [
'description' => '状态码。',
'type' => 'string',
'enumValueTitles' => ['Ready' => '空闲', 'Talking' => '通话', 'ACW' => '话后处理', 'Ringing' => '振铃', 'Break' => '小休', 'Offline' => '下线', 'Dialing' => '拨号'],
'example' => 'Break',
],
'OutboundScenario' => ['description' => '坐席是否为仅外呼状态。', 'type' => 'boolean', 'example' => 'false'],
'BreakCode' => ['description' => '小休码。', 'type' => 'string', 'example' => '会议'],
'WorkMode' => ['description' => '工作模式。', 'type' => 'string', 'example' => 'ON_SITE'],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
],
'title' => '获取坐席状态日志列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-05-10T07:29:41.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgentStateLogs'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": [\\n {\\n \\"StartTime\\": 1620259200000,\\n \\"StateCode\\": \\"CHECK_IN_BREAK\\",\\n \\"Duration\\": 32,\\n \\"State\\": \\"Break\\",\\n \\"OutboundScenario\\": false,\\n \\"BreakCode\\": \\"会议\\",\\n \\"WorkMode\\": \\"ON_SITE\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>943D8EF3-3321-471F-A104-51C96FCA94D6</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <State>Break</State>\\n <StateCode>CHECK_IN_BREAK</StateCode>\\n <StartTime>1620259200000</StartTime>\\n <OutboundScenario>false</OutboundScenario>\\n <Duration>5903871</Duration>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListAgentStates' => [
'summary' => '调用ListAgentStates获取指定实例下按指定条件过滤后的坐席状态列表,该接口仅对特定用户开放,其他客户不建议调用。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccSART34'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '按技能组ID过滤。', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test'],
],
[
'name' => 'AgentIds',
'in' => 'query',
'schema' => ['description' => '按坐席ID列表过滤。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
[
'name' => 'State',
'in' => 'query',
'schema' => [
'description' => '按坐席状态过滤,只能按单个状态过滤。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Ready' => '空闲', 'Talking' => '通话', 'ACW' => '话后处理', 'Break' => '小休', 'Ringing' => '振铃', 'Offline' => '下线', 'Dialing' => '拨号'],
'example' => 'Ready',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-300。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
[
'name' => 'ExcludeOfflineUsers',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => '过滤掉离线坐席,固定为true,暂不支持false。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-300。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'],
'List' => [
'description' => '列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LoginName' => ['description' => '座席登录名。', 'type' => 'string', 'example' => 'agent'],
'Dn' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8030****'],
'StateDuration' => ['description' => '坐席状态持续时长。', 'type' => 'string', 'example' => '10'],
'State' => [
'description' => '坐席状态。',
'type' => 'string',
'enumValueTitles' => ['Ready' => '空闲', 'Talking' => '通话', 'ACW' => '话后处理', 'Ringing' => '振铃', 'Break' => '小休', 'Offline' => '下线', 'Dialing' => '拨号'],
'example' => 'Ready',
],
'AgentId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'AgentName' => ['description' => '座席名称。', 'type' => 'string', 'example' => '坐席小王'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'BreakCode' => [
'description' => '小休码。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'staticInfo' => [
'substitutions' => ['CCC::2020-07-01::ListRealtimeAgentStates'],
],
'title' => '获取坐席状态列表',
'changeSet' => [
['createdAt' => '2022-07-01T13:16:03.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-06-29T14:26:34.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgentStates'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"LoginName\\": \\"agent\\",\\n \\"Dn\\": \\"8030****\\",\\n \\"StateDuration\\": \\"10\\",\\n \\"State\\": \\"Ready\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"OutboundScenario\\": false\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListAgentSummaryReportsSinceMidnight' => [
'summary' => '调用ListAgentSummaryReportsSinceMidnight获取指定实例下按指定条件过滤后的坐席历史数据报表,统计的是从当天0时开始,到当前时间为止的数据。该接口仅对特定用户开放,其他客户不建议调用。',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '按技能组ID过滤。', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test'],
],
[
'name' => 'AgentIds',
'in' => 'query',
'schema' => ['description' => '按坐席ID列表过滤,范围0-100 。'."\n"
."\n"
.'> 如果坐席ID列表不为空,则直接按照坐席ID列表进行查询,此时pageSize和pageNumber参数无效,数据直接返回,如:请求参数:pageNumber = 3 则响应参数中pageNumber = 3 。', 'type' => 'string', 'required' => false, 'example' => '["agent1@ccc-test", "agent2@ccc-test"]'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100,非必填,默认1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100,非必填,默认10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '27DD30C4-CAE2-481A-97CC-D3C54625341D'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'PagedAgentSummaryReport' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'List' => [
'description' => '坐席概览数据列表。',
'type' => 'array',
'items' => [
'description' => '坐席概览数据。',
'type' => 'object',
'properties' => [
'LoginName' => ['description' => '座席登录名。', 'type' => 'string', 'example' => 'agent'],
'AgentId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'AgentName' => ['description' => '坐席名称。', 'type' => 'string', 'example' => '坐席小王。'],
'SkillGroupNames' => ['description' => '座席所属技能组名称列表,格式为JSON数组的字符串,数组元素是技能组名称。', 'type' => 'string', 'example' => '["测试技能组1","测试技能组2"]'],
'Timestamp' => ['description' => '统计打点时刻。', 'type' => 'string', 'example' => '2018-09-13 00:00:00'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'SkillGroupIds' => ['description' => '座席所属技能组ID列表,格式为JSON数组的字符串,数组元素为技能组ID。', 'type' => 'string', 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]'."\n"],
'Overall' => [
'description' => '整体指标。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalLoggedInTime' => ['description' => '总登录时长,不包含小休时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'OccupancyRate' => ['description' => '座席利用率,计算公式为:(TotalworkTime+TotalTalkTime)/TotalLoggedInTime。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,计算公式为:TotalWorkTime/TotalCalls,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,计算公式为:TotalTalkTime/(CallsAnswered+CallsHandled),单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageReadyTime' => ['description' => '平均就绪时长,计算公式为:TotalReadyTime/就绪次数。就绪次数为非接口统计字段,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxReadyTime' => ['description' => '最大就绪时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '37'],
'OneTransferCalls' => ['description' => '直接转接的通话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalReadyTime' => ['description' => '总就绪时长,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalBreakTime' => ['description' => '总小休时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalCalls' => ['description' => '总电话量,计算公式为:CallsOffered+CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
],
],
'Inbound' => [
'description' => '呼入指标。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsOffered' => ['description' => '分配量,即分配给此坐席的电话次数,包括其他坐席盲转和咨询转给此坐席的电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageRingTime' => ['description' => '平均振铃时长,计算公式为:TotalRingTime/CallsRinged,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsHandled' => ['description' => '应答量,即坐席应答的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ServiceLevel20' => ['description' => '20秒应答率,单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'HandleRate' => ['description' => '应答率。计算公式为:CallsHandled/CallsOffered(由于应答事件与分配事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
],
],
'Outbound' => [
'description' => '呼出指标。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxDialingTime' => ['description' => '最大拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsDialed' => ['description' => '电话拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAnswered' => ['description' => '电话接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AnswerRate' => ['description' => '接通率,计算公式为:CallsAnswered/CallsDialed(由于接听事件与应答事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'string', 'example' => '0'],
'TotalDialingTime' => ['description' => '总拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageDialingTime' => ['description' => '平均拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
],
],
],
],
],
],
],
],
'description' => '',
],
],
],
'staticInfo' => [
'substitutions' => ['CCC::2020-07-01::ListHistoricalAgentReport'],
],
'title' => '获取坐席概览数据列表',
'changeSet' => [
['createdAt' => '2022-02-28T02:23:24.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgentSummaryReportsSinceMidnight'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"27DD30C4-CAE2-481A-97CC-D3C54625341D\\",\\n \\"Success\\": true,\\n \\"PagedAgentSummaryReport\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"List\\": [\\n {\\n \\"LoginName\\": \\"agent\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"AgentName\\": \\"坐席小王。\\",\\n \\"SkillGroupNames\\": \\"[\\\\\\"测试技能组1\\\\\\",\\\\\\"测试技能组2\\\\\\"]\\",\\n \\"Timestamp\\": \\"2018-09-13 00:00:00\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"SkillGroupIds\\": \\"[\\\\\\"skillgroup1@ccc-test\\\\\\",\\\\\\"skillgroup2@ccc-test\\\\\\"]\\\\n\\",\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"TotalLoggedInTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"MaxReadyTime\\": 37,\\n \\"OneTransferCalls\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"TotalCalls\\": 0\\n },\\n \\"Inbound\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0\\n },\\n \\"Outbound\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": \\"0\\",\\n \\"TotalDialingTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"AverageDialingTime\\": 0\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListAttempts' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccQFUGXR'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CampaignId',
'in' => 'query',
'schema' => ['title' => '活动ID', 'description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['title' => '开始时间', 'description' => '开始时间,非必填,不填默认为预测式外呼活动的开始时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1634115688291'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['title' => '结束时间', 'description' => '结束时间,非必填,不填默认为预测式外呼活动的结束时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1634115698291'],
],
[
'name' => 'QueueId',
'in' => 'query',
'schema' => ['title' => '队列ID', 'description' => '按技能组ID过滤,非必填,默认为空,为空表示不过滤。', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test'],
],
[
'name' => 'CaseId',
'in' => 'query',
'schema' => ['title' => 'CaseID', 'description' => '系统生成的联系人ID,客户无需关心。', 'type' => 'string', 'required' => true, 'example' => '60ecb1a2-4480-4d01-bede-c5b7655bfadf'],
],
[
'name' => 'AttemptId',
'in' => 'query',
'schema' => ['title' => '记录ID', 'description' => '呼叫记录ID,和通话ID取值一样。', 'type' => 'string', 'required' => false, 'example' => 'job-16976964500325****'],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => ['title' => '话务ID', 'description' => '按通话ID过滤,非必填,默认为空。', 'type' => 'string', 'required' => false, 'example' => 'job-16976964500325****'],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => ['title' => '坐席ID', 'description' => '按坐席ID过滤,非必填,默认为空。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
[
'name' => 'Caller',
'in' => 'query',
'schema' => ['title' => '主叫', 'description' => '按主叫号码过滤,非必填,默认为空。', 'type' => 'string', 'required' => false, 'example' => '05711234****'],
],
[
'name' => 'Callee',
'in' => 'query',
'schema' => ['title' => '被叫', 'description' => '按被叫号码过滤,非必填,默认为空。', 'type' => 'string', 'required' => false, 'example' => '1888888****'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '页码', 'description' => '分页页码,大小取决于PageNumber和PageSize的乘积,两个参数相乘不能大于10000。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '页大小', 'description' => '分页大小,大小取决于PageNumber和PageSize的乘积,两个参数相乘不能大于10000。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100'],
],
[
'name' => 'Criteria',
'in' => 'query',
'schema' => ['description' => '扩展查询条件。JSON格式,目前支持caseIds,支持caseIds批量查询。', 'type' => 'string', 'required' => false, 'example' => '{"caseIds":["964f05a7-fc15-4a05-93a6-cd7421c4459e","5e2d508b-0df6-4077-8099-d3fff51ea6d0","da037029-8c83-4270-a90e-e7734be76af6"]}'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE315'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageNumber' => ['description' => '分页页码,大小取决于PageNumber和PageSize的乘积,两个参数相乘不能大于10000。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,大小取决于PageNumber和PageSize的乘积,两个参数相乘不能大于10000。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'List' => [
'description' => '联系人拨打记录列表。',
'type' => 'array',
'items' => [
'description' => '联系人拨打记录。',
'type' => 'object',
'properties' => [
'AttemptId' => ['description' => '呼叫ID。', 'type' => 'string', 'example' => 'job-1704342174816****'],
'ContactId' => ['description' => '通话ID', 'type' => 'string', 'example' => 'job-1704342174816****'],
'CaseId' => ['description' => '系统生成的联系人ID,客户无需关心。', 'type' => 'string', 'example' => '21d194a7-60b7-4824-932b-48ed03a83704'],
'CampaignId' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'example' => '083046e3-5822-4cda-9b84-04f2a02eb605'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'QueueId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Caller' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '05711234****'],
'Callee' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '1888888****'],
'AgentId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'DialTime' => ['description' => '发起拨号的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634196283974'],
'DialDuration' => ['description' => '拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '2734'],
'CustomerEstablishedTime' => ['description' => '客户接通的时刻,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634196286708'],
'CustomerReleasedTime' => ['description' => '客户挂机时刻,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634196317888'],
'EnterIvrTime' => ['description' => '转接进入IVR时刻,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634196286740'],
'IvrDuration' => ['description' => 'IVR中时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1049'],
'EnqueueTime' => ['description' => '进入队列时刻,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634196287789'],
'QueueDuration' => ['description' => '排队时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '80'],
'AssignAgentTime' => ['description' => '分配坐席时刻,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634196287869'],
'AgentRingDuration' => ['description' => '坐席振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '23'],
'AgentEstablishedTime' => ['description' => '坐席接听时刻,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1632883592732'],
],
],
],
],
],
],
],
],
],
'title' => '获取联系人拨打记录列表',
'summary' => '调用ListAttempts获取指定实例下指定预测式外呼活动的联系人拨打记录列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAttempts'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"List\\": [\\n {\\n \\"AttemptId\\": \\"job-1704342174816****\\",\\n \\"ContactId\\": \\"job-1704342174816****\\",\\n \\"CaseId\\": \\"21d194a7-60b7-4824-932b-48ed03a83704\\",\\n \\"CampaignId\\": \\"083046e3-5822-4cda-9b84-04f2a02eb605\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"QueueId\\": \\"skillgroup@ccc-test\\",\\n \\"Caller\\": \\"05711234****\\",\\n \\"Callee\\": \\"1888888****\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"DialTime\\": 1634196283974,\\n \\"DialDuration\\": 2734,\\n \\"CustomerEstablishedTime\\": 1634196286708,\\n \\"CustomerReleasedTime\\": 1634196317888,\\n \\"EnterIvrTime\\": 1634196286740,\\n \\"IvrDuration\\": 1049,\\n \\"EnqueueTime\\": 1634196287789,\\n \\"QueueDuration\\": 80,\\n \\"AssignAgentTime\\": 1634196287869,\\n \\"AgentRingDuration\\": 23,\\n \\"AgentEstablishedTime\\": 1632883592732\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListAudioFiles' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccKYIENB'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => 'Converting(转换中) '."\n"
.'Completed(转换完成) '."\n"
.'Failed(转换失败) '."\n"
.'参数不传,查询所有状态。', 'type' => 'string', 'required' => false, 'example' => 'Completed'],
],
[
'name' => 'Usage',
'in' => 'query',
'schema' => ['description' => '音频文件用途,默认为General(用于IVR等场景), 其他可选值为HoldMusic(通话保持等待音)。', 'type' => 'string', 'required' => false, 'example' => 'General'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '53223330-EBF1-586B-A2CB-93C3B711FDA0'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'List' => [
'description' => '音频文件列表。',
'type' => 'array',
'items' => [
'description' => '音频文件信息。',
'type' => 'object',
'properties' => [
'AudioFileName' => ['description' => '音频文件名称。', 'type' => 'string', 'example' => 'test-file.wav'],
'OssFileKey' => ['description' => '音频资源文件在OSS中的Key。', 'type' => 'string', 'example' => 'ccc-test/test-file.wav'],
'UpdatedTime' => ['description' => '音频资源的最后修改时间。', 'type' => 'string', 'example' => '2021-03-08 15:34:49.0'],
'AudioResourceId' => ['description' => '音频资源ID,音频文件的唯一标识。', 'type' => 'string', 'example' => 'd5cd7a94-3b6a-47d2-b7fd-0b1cd839bf77'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Name' => ['description' => '音频资源的展示名。', 'type' => 'string', 'example' => '欢迎语'],
'CreatedTime' => ['description' => '音频资源的创建时间。', 'type' => 'string', 'example' => '2021-03-05 17:35:45.0'],
'Status' => ['description' => '音频文件状态。', 'type' => 'string', 'example' => 'Completed'],
'Usage' => ['description' => '音频文件用途,默认为General(用于IVR等场景), 其他可选值为HoldMusic(通话保持等待音)。', 'type' => 'string', 'example' => 'General'],
'AuditResult' => ['description' => '音频内容风险审核结果。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
500 => [
['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'],
],
],
'title' => '获取音频文件列表',
'summary' => '调用ListAudioFiles获取指定实例下的音频文件列表。',
'changeSet' => [
['createdAt' => '2023-11-17T01:12:03.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2022-06-30T02:20:46.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAudioFiles'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"53223330-EBF1-586B-A2CB-93C3B711FDA0\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"AudioFileName\\": \\"test-file.wav\\",\\n \\"OssFileKey\\": \\"ccc-test/test-file.wav\\",\\n \\"UpdatedTime\\": \\"2021-03-08 15:34:49.0\\",\\n \\"AudioResourceId\\": \\"d5cd7a94-3b6a-47d2-b7fd-0b1cd839bf77\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"欢迎语\\",\\n \\"CreatedTime\\": \\"2021-03-05 17:35:45.0\\",\\n \\"Status\\": \\"Completed\\",\\n \\"Usage\\": \\"General\\",\\n \\"AuditResult\\": \\"无\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListBlacklistCallTaggings' => [
'summary' => '批量查询指定号码黑名单打标状态。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'NumberList',
'in' => 'query',
'schema' => ['description' => '待查询黑名单打标状态的号码列表,号码为加密号码(带有***),需要带jobId字段,反之不需要。', 'type' => 'string', 'required' => true, 'example' => '[{"number":"1521083xxxx","jobId":"job-481841171213393920"}]'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '032C73C4-3A6F-4502-872B-4F5B41161C6E'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => [
'description' => '数据。',
'type' => 'array',
'items' => [
'description' => '号码黑名单打标信息。',
'type' => 'object',
'properties' => [
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-481841171213393920'],
'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '1521083xxxx'],
'Blacklisted' => ['description' => '是否有黑名单打标。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
['errorCode' => 'LimitExceed.CallTagsPerNumber', 'errorMessage' => 'The total number of call tag of numbers exceeds the limit %s.', 'description' => '号码标签数量超出单个呼入号码标记的上线阈值。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.CustomCallTagging', 'errorMessage' => 'Custom call tagging %s does not exist in instance %s.', 'description' => '呼入号码标记不存在。'],
],
500 => [
['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'],
],
],
'title' => '获取号码黑名单打标状态',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"032C73C4-3A6F-4502-872B-4F5B41161C6E\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"JobId\\": \\"job-481841171213393920\\",\\n \\"Number\\": \\"1521083xxxx\\",\\n \\"Blacklisted\\": true\\n }\\n ]\\n}","type":"json"}]',
],
'ListBriefSkillGroups' => [
'summary' => '调用ListBriefSkillGroups获取指定实例下的技能组概要信息列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SearchPattern',
'in' => 'query',
'schema' => ['description' => '根据技能组名称或技能组展示名进行模糊匹配,非必填,默认为空,为空表示不过滤。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'skillgroup'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'MediaType',
'in' => 'query',
'schema' => ['description' => '媒体类型,默认是语音(AUDIO), 其他可选参数包括CHAT和 VIDEO。', 'type' => 'string', 'required' => false, 'example' => 'CHAT'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => '3969FC68-CEC2-4398-B76A-60D2F7EDEBAF'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'List' => [
'description' => '技能组概要信息列表。'."\n",
'type' => 'array',
'items' => [
'description' => '技能组',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '技能组展示名。', 'type' => 'string', 'example' => '测试技能组'],
'Description' => ['description' => '技能组的描述。', 'type' => 'string', 'example' => '云联络中心的测试技能组。'],
'PhoneNumberCount' => ['description' => '技能组关联的号码数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'],
'UserCount' => ['description' => '技能组关联的坐席数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'MediaType' => ['description' => '媒体类型,默认是语音(AUDIO), 其他可选参数包括CHAT和VIDEO。', 'type' => 'string', 'example' => 'VIDEO'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取技能组概要列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-17T01:12:03.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBriefSkillGroups'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"3969FC68-CEC2-4398-B76A-60D2F7EDEBAF\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"PhoneNumberCount\\": 1,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"UserCount\\": 10,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"MediaType\\": \\"VIDEO\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>3969FC68-CEC2-4398-B76A-60D2F7EDEBAF</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <SkillGroupName>测试技能组</SkillGroupName>\\n <Description>测试技能组</Description>\\n <PhoneNumberCount>1</PhoneNumberCount>\\n <InstanceId>ccc-test</InstanceId>\\n <UserCount>1</UserCount>\\n <DisplayName>测试技能组</DisplayName>\\n <SkillGroupId>test@ccc-test</SkillGroupId>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListCallDetailRecords' => [
'summary' => '调用ListCallDetailRecords获取指定实例下指定搜索条件过滤后的通话详情列表。接口不再迭代更新,建议优先使用ListCallDetailRecordsV2接口。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc5HY0NN'],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '100'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '获取的历史数据的起始时间,默认为当天的0时,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532448000000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '获取的历史数据的终止时间,默认为当前时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532707199000'],
],
[
'name' => 'ContactType',
'in' => 'query',
'schema' => [
'description' => '按通话类型过滤。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Outbound' => '呼出', 'Back2Back' => '双呼', 'PrivacyDial' => '加密通话', 'Internal' => '内部呼叫', 'Predictive' => '预测式外呼', 'Inbound' => '呼入', 'Conference' => '会议'],
'example' => 'Outbound',
],
],
[
'name' => 'ContactDisposition',
'in' => 'query',
'schema' => [
'description' => '按挂断类型过滤,注意:语音邮箱、转人工失败、排队超时、排队溢出、IVR异常的挂断原因需要客户配置挂断原因节点才能体现出来,如果没有配置且IVR中无转人工模块,这时候的挂断原因默认为IVR放弃。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'AbandonedInQueue' => '排队放弃', 'NoAnswer' => '客户未接', 'QueuingTimeout' => '排队超时', 'Voicemail' => '转语音邮箱', 'QueuingFailed' => '转人工失败', 'QueuingOverflow' => '排队溢出', 'AbandonedInVoiceNavigator' => '智能导航中放弃', 'Success' => '正常结束', 'IVRException' => 'IVR异常', 'AbandonedInRing' => '振铃放弃',
'AbandonedInIVR' => 'IVR放弃', 'Reject' => '客户拒接', 'ForwardToOutsideNumber' => '转外线',
],
'example' => 'Success',
],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => ['description' => '通过指定的contactId来查询某一通电话的记录,contactId可以通过软电话SDK发生通话时获取到。如果传入该参数,则自动忽略其他查询参数。', 'type' => 'string', 'required' => false, 'example' => 'job-12515239414412****'],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => ['description' => '按坐席ID过滤。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '按技能组ID过滤。', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test'],
],
[
'name' => 'SortOrder',
'in' => 'query',
'schema' => [
'description' => '排序方式,非必填,默认为降序。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['ASC' => '升序', 'DESC' => '降序'],
'example' => 'DESC',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'OrderByField',
'in' => 'query',
'schema' => [
'description' => '排序字段,非必填,默认为startTime(通话开始时间)。'."\n",
'type' => 'string',
'required' => false,
'enumValueTitles' => ['callDuration' => '通话时长', 'ringTime' => '响铃时长', 'talkTime' => '通话时长', 'dialingTime' => '拨号时长', 'startTime' => '通话开始时间', 'ivrTime' => 'IVR时长', 'queueTime' => '排队时长'],
'example' => 'startTime',
],
],
[
'name' => 'Criteria',
'in' => 'query',
'schema' => ['description' => '根据主叫或被叫号码模糊查询,格式为JSON字符串,仅包含一个字段phoneNumber,填主叫或被叫号码的全部或者一部分。', 'type' => 'string', 'required' => false, 'example' => '{"phoneNumber":"0735"}'],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => ['description' => '按主叫号码过滤。', 'type' => 'string', 'required' => false, 'example' => '07353988****'],
],
[
'name' => 'CalledNumber',
'in' => 'query',
'schema' => ['description' => '按被叫号码过滤。', 'type' => 'string', 'required' => false, 'example' => '1320523****'],
],
[
'name' => 'SatisfactionList',
'in' => 'query',
'schema' => ['description' => '按满意度列表过滤,多个满意度结果使用英文逗号隔开。', 'type' => 'string', 'required' => false, 'example' => '["1","3"]'],
],
[
'name' => 'SatisfactionSurveyChannel',
'in' => 'query',
'schema' => [
'description' => '按满意度调查渠道过滤。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['IVR' => '语音满意度', 'SMS' => '短信满意度'],
'example' => 'IVR',
],
],
[
'name' => 'SatisfactionDescriptionList',
'in' => 'query',
'schema' => ['description' => '按满意度描述列表过滤,描述内容由客户自定义。', 'type' => 'string', 'required' => false, 'example' => '["满意","一般"]'],
],
[
'name' => 'EarlyMediaStateList',
'in' => 'query',
'schema' => [
'description' => '按未接通原因列表过滤。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['NoAnswer' => '无人接听', 'OutOfService' => '停机', 'NotExist' => '空号', 'Restricted' => '呼叫受限', 'Busy' => '占线', 'NotConnected' => '无法接通', 'PowerOff' => '关机'],
'example' => '["NotConnected","NoAnswer"]',
],
],
[
'name' => 'ContactDispositionList',
'in' => 'query',
'schema' => [
'description' => '按挂断原因列表过滤。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'AbandonedInQueue' => '排队放弃', 'NoAnswer' => '客户未接', 'QueuingTimeout' => '排队超时', 'Voicemail' => '转语音邮箱', 'QueuingFailed' => '转人工失败', 'QueuingOverflow' => '排队溢出', 'AbandonedInVoiceNavigator' => '智能导航中放弃', 'Success' => '正常结束', 'IVRException' => 'IVR异常', 'AbandonedInRing' => '振铃放弃',
'AbandonedInIVR' => 'IVR放弃', 'Reject' => '客户拒接', 'ForwardToOutsideNumber' => '转外线',
],
'example' => '["Success","NoAnswer"]',
],
],
[
'name' => 'ContactTypeList',
'in' => 'query',
'schema' => [
'description' => '按通话类型列表过滤。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Outbound' => '呼出', 'Back2Back' => '双呼', 'PrivacyDial' => '加密通话', 'Internal' => '内部呼叫', 'Predictive' => '预测式外呼', 'Inbound' => '呼入', 'Conference' => '会议'],
'example' => '["Internal","Inbound"]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数,只有PageNumber为1才会返回真实数值,其他都是0。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'],
'List' => [
'description' => '通话记录列表。',
'type' => 'array',
'items' => [
'description' => '通话记录。',
'type' => 'object',
'properties' => [
'ContactDisposition' => [
'description' => '通话结束原因。',
'type' => 'string',
'enumValueTitles' => [
'AbandonedInQueue' => '排队放弃', 'NoAnswer' => '客户未接', 'QueuingTimeout' => '排队超时', 'Voicemail' => '转语音邮箱', 'QueuingFailed' => '转人工失败', 'QueuingOverflow' => '排队溢出', 'AbandonedInVoiceNavigator' => '智能导航中放弃', 'Success' => '正常结束', 'IVRException' => 'IVR异常', 'AbandonedInRing' => '振铃放弃',
'AbandonedInIVR' => 'IVR放弃', 'Reject' => '客户拒接', 'ForwardToOutsideNumber' => '转外线',
],
'example' => 'Success',
],
'ContactType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => ['Outbound' => '呼出', 'Back2Back' => '双呼', 'PrivacyDial' => '加密通话', 'Internal' => '内部呼叫', 'Predictive' => '预测式外呼', 'Inbound' => '呼入', 'Conference' => '会议'],
'example' => 'Outbound',
],
'EstablishedTime' => ['description' => '通话建立的时间,如果通话没有建立,此值为空,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532448000000'],
'CalledNumber' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '1332315****'],
'AdditionalBroker' => ['description' => '附加中间号码,双呼场景下可能用到。', 'type' => 'string', 'example' => '0533128****'],
'SatisfactionIndex' => ['description' => '满意度,即满意度按键数字(1位数字)的值。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'SatisfactionSurveyChannel' => [
'description' => '满意度调查渠道。',
'type' => 'string',
'enumValueTitles' => ['IVR' => '语音满意度', 'SMS' => '短信满意度'],
'example' => 'IVR',
],
'ReleaseTime' => ['description' => '通话结束时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532707199000'],
'WaitTime' => ['description' => '客户等待时长,即QueueTime+RingTime,若客户等待期间放弃,则为0,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'SkillGroupNames' => ['description' => '参与通话的座席所属的技能组名称,多个技能组以英文逗号分隔。', 'type' => 'string', 'example' => '测试技能组'],
'IvrTime' => ['description' => 'IVR时长,即从开始进入IVR到开始进入转人工队列(或客户放弃)之间的时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'],
'SatisfactionDescription' => ['description' => '满意度描述,对应于满意度IVR中满意度模块的配置,客户自行定义。', 'type' => 'string', 'example' => '满意'],
'ReleaseInitiator' => [
'description' => '挂断方。',
'type' => 'string',
'enumValueTitles' => ['agent' => '坐席', 'customer' => '客户'],
'example' => 'customer',
],
'AgentIds' => ['description' => '坐席ID列表,多个值用逗号分隔。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'CallDuration' => ['description' => '通话时长,呼入从通话进入IVR开始计时,呼出从接通开始计时,单位秒。', 'type' => 'string', 'example' => '30'],
'RecordingReady' => ['description' => '录音是否已经生成,若通话没有建立,则返回false。', 'type' => 'boolean', 'example' => 'true'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'RingTime' => ['description' => '振铃时长,即从坐席振铃到坐席接起(或客户放弃)之间的时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'SatisfactionSurveyOffered' => ['description' => '是否发起了满意度调查。', 'type' => 'boolean', 'example' => 'true'],
'AgentNames' => ['description' => '通话涉及到的坐席名称列表,多个坐席之间使用英文逗号隔开。', 'type' => 'string', 'example' => '坐席小王'],
'StartTime' => ['description' => '通话开始时间,内呼从进入IVR开始,外呼从拨号开始计算,格式为Unix字符串,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532448000000'],
'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-12515239414412****'],
'RecordingDuration' => ['description' => '录音时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'CallingNumber' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '0533128****'],
'QueueTime' => ['description' => '排队时长,即从开始进入转人工队列到坐席开始振铃(或客户放弃,队列超时,队列溢出)之间的时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'Broker' => ['description' => '中间号码。', 'type' => 'string', 'example' => '0533127****'],
'SkillGroupIds' => ['description' => '参与通话的座席所属的技能组ID,多个技能组以逗号分隔。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'CallerLocation' => ['description' => '主叫归属地。', 'type' => 'string', 'example' => '北京市-北京'],
'CalleeLocation' => ['description' => '被叫归属地。', 'type' => 'string', 'example' => '山东省-济南'],
'EarlyMediaState' => [
'description' => '未接通原因。',
'type' => 'string',
'enumValueTitles' => ['NoAnswer' => '无人接听', 'OutOfService' => '停机', 'NotExist' => '空号', 'Restricted' => '呼叫受限', 'Busy' => '占线', 'NotConnected' => '无法接通', 'PowerOff' => '关机'],
'example' => 'NotConnected',
],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '486:USER_BUSY'],
'DialingTime' => ['description' => '拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TalkTime' => ['description' => '通话时间,单位为秒', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'HeldTime' => ['description' => '保持时间,单位为秒', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'CallIds' => ['description' => '通信底层SIP协议中Call-Id字段,如果需要获取号码提供商侧的通话ID可以从这个字段获取。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'."\n"],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'],
],
500 => [
['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'],
],
],
'title' => '获取通话详情列表',
'description' => '为了保证查询效率,返回数据中的TotalCount字段,只会在查询第一页时赋值,查询其他页时返回0。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-07-29T10:25:36.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-10-09T15:22:40.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-03-20T06:35:11.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-12-07T10:56:27.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-10-14T06:47:33.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-09-08T02:42:38.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallDetailRecords'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"ContactDisposition\\": \\"Success\\",\\n \\"ContactType\\": \\"Outbound\\",\\n \\"EstablishedTime\\": 1532448000000,\\n \\"CalledNumber\\": \\"1332315****\\",\\n \\"AdditionalBroker\\": \\"0533128****\\",\\n \\"SatisfactionIndex\\": 1,\\n \\"SatisfactionSurveyChannel\\": \\"IVR\\",\\n \\"ReleaseTime\\": 1532707199000,\\n \\"WaitTime\\": 5,\\n \\"SkillGroupNames\\": \\"测试技能组\\",\\n \\"IvrTime\\": 8,\\n \\"SatisfactionDescription\\": \\"满意\\",\\n \\"ReleaseInitiator\\": \\"customer\\",\\n \\"AgentIds\\": \\"agent@ccc-test\\",\\n \\"CallDuration\\": \\"30\\",\\n \\"RecordingReady\\": true,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RingTime\\": 5,\\n \\"SatisfactionSurveyOffered\\": true,\\n \\"AgentNames\\": \\"坐席小王\\",\\n \\"StartTime\\": 1532448000000,\\n \\"ContactId\\": \\"job-12515239414412****\\",\\n \\"RecordingDuration\\": 10,\\n \\"CallingNumber\\": \\"0533128****\\",\\n \\"QueueTime\\": 0,\\n \\"Broker\\": \\"0533127****\\",\\n \\"SkillGroupIds\\": \\"skillgroup@ccc-test\\",\\n \\"CallerLocation\\": \\"北京市-北京\\",\\n \\"CalleeLocation\\": \\"山东省-济南\\",\\n \\"EarlyMediaState\\": \\"NotConnected\\",\\n \\"ReleaseReason\\": \\"486:USER_BUSY\\",\\n \\"DialingTime\\": 0,\\n \\"TalkTime\\": 0,\\n \\"HeldTime\\": 12,\\n \\"CallIds\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\\\n\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>11</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <IvrTime>8</IvrTime>\\n <CalledNumber>133xxxx2315</CalledNumber>\\n <ContactType>Outbound</ContactType>\\n <ContactDisposition>Success</ContactDisposition>\\n <SatisfactionIndex>1</SatisfactionIndex>\\n <ContactId>job-125152394144124921</ContactId>\\n <CallingNumber>053xxxx3128</CallingNumber>\\n <RecordingReady>true</RecordingReady>\\n <SkillGroupNames>默认技能组</SkillGroupNames>\\n <SatisfactionSurveyOffered>true</SatisfactionSurveyOffered>\\n <QueueTime>0</QueueTime>\\n <EstablishedTime>1532448000000</EstablishedTime>\\n <SkillGroupIds>skg-default@ccc-test</SkillGroupIds>\\n <Broker>053xxxx3127</Broker>\\n <InstanceId>ccc-test</InstanceId>\\n <ReleaseInitiator>agent</ReleaseInitiator>\\n <EarlyMediaState>NotConnected</EarlyMediaState>\\n <StartTime>1532448000000</StartTime>\\n <RingTime>5</RingTime>\\n <CallDuration>30</CallDuration>\\n <CalleeLocation>北京</CalleeLocation>\\n <ReleaseTime>1532707199000</ReleaseTime>\\n <SatisfactionSurveyChannel>IVR</SatisfactionSurveyChannel>\\n <AgentIds>user-test@ccc-test</AgentIds>\\n <SatisfactionDescription>满意</SatisfactionDescription>\\n <AdditionalBroker>053xxxx3128</AdditionalBroker>\\n <CallerLocation>北京</CallerLocation>\\n <WaitTime>5</WaitTime>\\n <AgentNames>云呼测试坐席</AgentNames>\\n <RecordingDuration>10</RecordingDuration>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListCallDetailRecordsV2' => [
'summary' => '获取指定实例下指定搜索条件过滤后的通话详情列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc5HY0NN'],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '100'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '获取的历史数据的起始时间,默认为当天的 0 时,格式为 Unix 时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1657853640015'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '获取的历史数据的终止时间,默认为当前时间,格式为 Unix 时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1657879880010'],
],
[
'name' => 'SortOrder',
'in' => 'query',
'schema' => ['description' => '排序方式,默认为降序。'."\n"
."\n"
.'枚举值:'."\n"
."\n"
.'ASC:升序。'."\n"
."\n"
.'DESC:降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'OrderByField',
'in' => 'query',
'schema' => ['description' => '排序字段,非必填,默认为 startTime(通话开始时间)。'."\n"
."\n"
.'枚举值:'."\n"
."\n"
.'startTime:通话开始时间。', 'type' => 'string', 'required' => false, 'example' => 'startTime'],
],
[
'name' => 'SearchPattern',
'in' => 'query',
'schema' => ['description' => '自定义查询文本,遵循Lucene查询语法。'."\n"
."\n"
.'支持查询字段和查询类型列表:'."\n"
."\n"
.'accessChannelUserId: 访客ID,支持精准查询和模糊查询。'."\n"
."\n"
.'accessChannelName: 渠道名称,支持精准查询和模糊查询。'."\n"
."\n"
.'text: 会话文本,支持模糊查询。', 'type' => 'string', 'required' => false, 'example' => 'text:请稍后 AND accessChannelUserId:af1a0-afaa-5086e2946e0b* AND accessChannelName:专属开发渠道*'],
],
[
'name' => 'MediaType',
'in' => 'query',
'schema' => ['description' => '媒体类型。'."\n"
."\n"
.'枚举值:'."\n"
."\n"
.'AUDIO:语音。'."\n"
."\n"
.'VIDEO:视频。'."\n"
."\n"
.'CHAT: 消息。'."\n"
."\n"
.'ALL: 所有。', 'type' => 'string', 'required' => false, 'example' => 'AUDIO'],
],
[
'name' => 'ContactIdList',
'in' => 'query',
'schema' => ['description' => '通话ID列表。', 'type' => 'string', 'required' => false, 'example' => '["job-123456789","job-234567891"]'],
],
[
'name' => 'ContactTypeList',
'in' => 'query',
'schema' => ['description' => '按通话类型列表过滤。'."\n"
."\n"
.'枚举值:'."\n"
."\n"
.'OUTBOUND:呼出。'."\n"
."\n"
.'BACK2BACK:双呼。'."\n"
."\n"
.'PRIVACY_DIAL:加密通话。'."\n"
."\n"
.'INTERNAL:内部呼叫。'."\n"
."\n"
.'PREDICTIVE:预测式外呼。'."\n"
."\n"
.'INBOUND:呼入。'."\n"
."\n"
.'CONFERENCE:会议。', 'type' => 'string', 'required' => false, 'example' => '["INBOUND","OUTBOUND"]'],
],
[
'name' => 'ContactDispositionList',
'in' => 'query',
'schema' => ['description' => '按挂断原因列表过滤。'."\n"
."\n"
.'枚举值:'."\n"
."\n"
.'AbandonedInQueue:排队放弃。'."\n"
."\n"
.'NoAnswer:客户未接。'."\n"
."\n"
.'QueuingTimeout:排队超时。'."\n"
."\n"
.'Voicemail:转语音邮箱。'."\n"
."\n"
.'QueuingFailed:转人工失败。'."\n"
."\n"
.'QueuingOverflow:排队溢出。'."\n"
."\n"
.'AbandonedInVoiceNavigator:智能导航中放弃。'."\n"
."\n"
.'Success:正常结束。'."\n"
."\n"
.'IVRException:IVR异常。'."\n"
."\n"
.'AbandonedInRing:振铃放弃。'."\n"
."\n"
.'AbandonedInIVR:IVR放弃。'."\n"
."\n"
.'Reject:客户拒接。'."\n"
."\n"
.'ForwardToOutsideNumber:转外线。', 'type' => 'string', 'required' => false, 'example' => '["Success","NoAnswer"]'],
],
[
'name' => 'EarlyMediaStateList',
'in' => 'query',
'schema' => ['description' => '按未接通原因列表过滤。'."\n"
."\n"
.'枚举值:'."\n"
."\n"
.'NoAnswer:无人接听。'."\n"
."\n"
.'OutOfService:停机。'."\n"
."\n"
.'NotExist:空号。'."\n"
."\n"
.'Restricted:呼叫受限。'."\n"
."\n"
.'Busy:占线。'."\n"
."\n"
.'NotConnected:无法接通。'."\n"
."\n"
.'PowerOff:关机。', 'type' => 'string', 'required' => false, 'example' => '["NotConnected","NoAnswer"]'],
],
[
'name' => 'SatisfactionSurveyChannel',
'in' => 'query',
'schema' => ['description' => '满意度调查渠道。'."\n"
."\n"
.'枚举值:'."\n"
."\n"
.'IVR:语音满意度。'."\n"
."\n"
.'SMS:短信满意度。'."\n"
."\n"
.'CHAT: 消息满意度。', 'type' => 'string', 'required' => false, 'example' => 'IVR'],
],
[
'name' => 'SatisfactionRateList',
'in' => 'query',
'schema' => ['description' => '按满意度列表过滤,多个满意度结果使用英文逗号隔开。'."\n"
."\n"
.'枚举值:'."\n"
."\n"
.'-2:未发送。'."\n"
."\n"
.'-1:未评价。'."\n"
."\n"
.'其他正数:自定义满意度评价数值。', 'type' => 'string', 'required' => false, 'example' => '["-1","3"]'."\n"
.'[">2"]'."\n"
.'["<3"]'],
],
[
'name' => 'SatisfactionDescriptionList',
'in' => 'query',
'schema' => ['description' => '按满意度描述列表过滤,描述内容由客户自定义。', 'type' => 'string', 'required' => false, 'example' => '["满意","一般"]'],
],
[
'name' => 'SkillGroupIdList',
'in' => 'query',
'schema' => ['description' => '坐席所属技能组ID列表。', 'type' => 'string', 'required' => false, 'example' => '['."\n"
.' "skg1@ccc-test",'."\n"
.' "skg2@ccc-test"'."\n"
.']'],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
[
'name' => 'FirstAgentId',
'in' => 'query',
'schema' => ['description' => '首个参与通话的坐席ID。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => ['description' => '主叫号码。', 'type' => 'string', 'required' => false, 'example' => '191***9993'],
],
[
'name' => 'CalledNumber',
'in' => 'query',
'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => false, 'example' => '191***9993'],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => ['description' => '电话号码。', 'type' => 'string', 'required' => false, 'example' => '191***9993'],
],
[
'name' => 'Broker',
'in' => 'query',
'schema' => ['description' => '中间号码,需要是实例下可用的外呼号码,双呼时会使用该号码先后呼叫主叫和被叫。', 'type' => 'string', 'required' => false, 'example' => '021****4972'],
],
[
'name' => 'AccessChannelTypeList',
'in' => 'query',
'schema' => ['description' => '访客渠道类型列表。'."\n"
."\n"
.'枚举列表:'."\n"
."\n"
.'Web: 网页。'."\n"
."\n"
.'DingTalkServiceWindow:钉钉服务窗。'."\n"
."\n"
.'AliMe:对话机器人。'."\n"
."\n"
.'DingTalkRobot:钉钉机器人。', 'type' => 'string', 'required' => false, 'example' => '["Web","AliMe"]'],
],
[
'name' => 'ReleaseInitiatorList',
'in' => 'query',
'schema' => ['description' => '挂断方', 'type' => 'string', 'required' => false, 'example' => '[\\"AGENT\\"]'],
],
[
'name' => 'ReleaseReasonList',
'in' => 'query',
'schema' => ['description' => '挂断原因', 'type' => 'string', 'required' => false, 'example' => '[\\"VisitorInitiatedClosure\\",\\"AgentInitiatedClosure\\"]'],
],
[
'name' => 'AnalyticsReportReady',
'in' => 'query',
'schema' => ['description' => 'AI话后分析报告是否已完成', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '01B12EE4-6AF2-4730-8B78-EC15F4E5C025'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'List' => [
'description' => '通话记录列表。',
'type' => 'array',
'items' => [
'description' => '通话记录。',
'type' => 'object',
'properties' => [
'ContactDisposition' => ['description' => '通话结束原因,枚举列表见ContactDispositionList查询参数。', 'type' => 'string', 'example' => 'Success'],
'ContactType' => ['description' => '通话类型,枚举列表见ContactTypeList查询参数。', 'type' => 'string', 'example' => 'OUTBOUND'],
'EstablishedTime' => ['description' => '通话建立的时间,如果通话没有建立,此值为空,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532448000000'],
'CalledNumber' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '1332315****'],
'AdditionalBroker' => ['description' => '附加中间号码,双呼场景下可能用到。', 'type' => 'string', 'example' => '0533128****'],
'SatisfactionIndex' => ['description' => '满意度,即满意度按键数字(1位数字)的值。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'SatisfactionSurveyChannel' => ['description' => '满意度调查渠道。', 'type' => 'string', 'example' => 'IVR'],
'ReleaseTime' => ['description' => '通话结束时间,格式为 Unix 时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532707199000'],
'WaitTime' => ['description' => '客户等待时长,即 QueueTime+RingTime,若客户等待期间放弃,则为 0,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'SkillGroupNames' => ['description' => '参与通话的座席所属的技能组名称,多个技能组以英文逗号分隔。', 'type' => 'string', 'example' => '测试技能组1,测试技能组2'],
'IvrTime' => ['description' => 'IVR时长,即从开始进入IVR到开始进入转人工队列(或客户放弃)之间的时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'],
'SatisfactionDescription' => ['description' => '满意度描述,对应于满意度IVR中满意度模块的配置,客户自行定义。', 'type' => 'string', 'example' => '满意'],
'ReleaseInitiator' => ['description' => '挂断方。'."\n"
."\n"
.'枚举值:'."\n"
."\n"
.'agent:坐席。'."\n"
."\n"
.'customer:客户。', 'type' => 'string', 'example' => 'customer'],
'AgentIds' => ['description' => '坐席ID列表,多个值用逗号分隔。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'CallDuration' => ['description' => '通话时长,呼入从通话进入IVR开始计时,呼出从接通开始计时,单位秒。', 'type' => 'string', 'example' => '16'],
'RecordingReady' => ['description' => '录音是否已经生成。若通话没有建立,则返回false。', 'type' => 'boolean', 'example' => 'true'],
'InstanceId' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'RingTime' => ['description' => '振铃时长,即从坐席振铃到坐席接起(或客户放弃)之间的时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'SatisfactionSurveyOffered' => ['description' => '是否发送了满意度。', 'type' => 'boolean', 'example' => 'true'],
'AgentNames' => ['description' => '通话涉及到的坐席名称列表,多个坐席之间使用英文逗号隔开。', 'type' => 'string', 'example' => '云呼测试坐席'],
'StartTime' => ['description' => '通话开始时间,内呼从进入 IVR 开始,外呼从拨号开始计算,格式为 Unix 字符串,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1631440860000'],
'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-2255019651513856'],
'RecordingDuration' => ['description' => '录音时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'CallingNumber' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '0533128****'],
'QueueTime' => ['description' => '排队时长,即从开始进入转人工队列到坐席开始振铃(或客户放弃,队列超时,队列溢出)之间的时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'Broker' => ['description' => '中间号码。', 'type' => 'string', 'example' => '053xxxx3127'],
'SkillGroupIds' => ['description' => '参与通话的座席所属的技能组ID,多个技能组以逗号分隔。', 'type' => 'string', 'example' => 'skg-default@ccc-test'],
'CallerLocation' => ['description' => '主叫归属地。', 'type' => 'string', 'example' => '北京市-北京'],
'CalleeLocation' => ['description' => '被叫归属地。', 'type' => 'string', 'example' => '山东省-济南'],
'EarlyMediaState' => ['description' => '早媒体状态。', 'type' => 'string', 'example' => 'NotConnected'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '486:USER_BUSY'],
'DialingTime' => ['description' => '拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TalkTime' => ['description' => '通话时间,单位为秒', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'HeldTime' => ['description' => '保持时间,单位为秒', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'EarlyMediaText' => ['description' => '早媒体文本。', 'type' => 'string', 'example' => '正在通话中'],
'OffSiteAgentIds' => ['description' => '参与通话的场外坐席ID列表,多个坐席之间使用英文逗号隔开。', 'type' => 'string', 'example' => 'skg-default@ccc-test'],
'OffsiteAgentDestinationNumbers' => ['description' => '分配的坐席是场外坐席时,呼叫的场外坐席号码。', 'type' => 'string', 'example' => '80312348'],
'MessagesSent' => ['description' => '消息总量,MediaType为CHAT时有值。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'MessagesSentByCustomer' => ['description' => '客户发送消息总数,MediaType为CHAT时有值。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'MessagesSentByAgent' => ['description' => '坐席发送消息总数,MediaType为CHAT时有值。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'FirstResponseTime' => ['description' => '坐席首次回复客户消息花费的时长,MediaType为CHAT时有值。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'MediaType' => ['description' => '媒体类型。'."\n"
."\n"
.'枚举列表:'."\n"
."\n"
.'AUDIO:语音。'."\n"
."\n"
.'CHAT:消息。'."\n"
."\n"
.'VIDEO:视频。', 'type' => 'string', 'example' => 'CHAT'],
'TransferCount' => ['description' => '转接次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'AccessChannelType' => ['description' => '渠道类型,MediaType为CHAT时有值。', 'type' => 'string', 'example' => 'Web'],
'AccessChannelName' => ['description' => '渠道名称,MediaType为CHAT时有值。', 'type' => 'string', 'example' => '测试渠道'],
'AccessChannelUserId' => ['description' => '访客ID,MediaType为CHAT时有值。', 'type' => 'string', 'example' => 'test-user-id'],
'AccessChannelUserName' => ['description' => '访客名称,MediaType为CHAT时有值。', 'type' => 'string', 'example' => '测试访客'],
'ClientIpAddress' => ['description' => '访客客户端地址,MediaType为CHAT时有值。', 'type' => 'string', 'example' => '10.100.2.1'],
'ClientLocation' => ['description' => '访客客户端归属地,MediaType为CHAT时有值。', 'type' => 'string', 'example' => '---'],
'ClientUserAgent' => ['description' => '访客客户端信息,MediaType为CHAT时有值。', 'type' => 'string', 'example' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36'],
'ClientAppName' => ['description' => '访客客户端名称,MediaType为CHAT时有值。', 'type' => 'string', 'example' => '未知'],
'OffsiteAgentOriginatorNumbers' => ['description' => '分配的坐席是场外坐席时,发起呼叫场外坐席的号码。', 'type' => 'string', 'example' => '0101257****'],
'CallIds' => ['description' => 'SIP协议的CallId列表。', 'type' => 'string', 'example' => 'dxxx1sdf,xkkwwwa'],
'AnalyticsReportReady' => ['description' => 'AI话后分析报告是否完工。', 'type' => 'boolean', 'example' => 'true'],
'AnalyticsReport' => [
'description' => '话后分析报告。',
'type' => 'object',
'properties' => [
'ProblemSolving' => [
'description' => '问题完结情况',
'type' => 'object',
'properties' => [
'TaskId' => ['description' => '任务Id。', 'type' => 'string', 'example' => '8bf18b7a10064b29a75946a8d5b8469a'],
'Success' => ['description' => '是否调用成功。'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'false'],
'Solved' => ['description' => '是否解决。', 'type' => 'boolean', 'example' => 'true'],
'Problem' => ['description' => '问题描述。', 'type' => 'string', 'example' => '告警问题'],
'Solution' => ['description' => '解决方案。', 'type' => 'string', 'example' => '富化服务自动关闭原始告警'],
],
],
'Emotion' => [
'description' => '情绪分析。',
'type' => 'object',
'properties' => [
'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '0ff07fe35670423089dbdf12766d962f'],
'Success' => ['description' => '是否调用成功。'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Type' => ['description' => '情绪类型。', 'type' => 'string', 'example' => '中性'],
'Confidence' => ['description' => '置信度。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
'Remark' => ['description' => '情绪详细分析备注。', 'type' => 'string', 'example' => '客户没情绪变化'],
],
],
'Satisfaction' => [
'description' => '满意度分析。',
'type' => 'object',
'properties' => [
'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => 'cb67479ce28243b28ff39948feaa0806'],
'Success' => ['description' => '是否调用成功。'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'SatisfactionDescription' => ['description' => '满意度描述。', 'type' => 'string', 'example' => '满意'],
'Remark' => ['description' => '满意度分析详情备注。', 'type' => 'string', 'example' => '客户表示满意'],
],
],
'TodoList' => [
'description' => '待办事情。',
'type' => 'object',
'properties' => [
'TaskId' => ['description' => '任务ID。'."\n", 'type' => 'string', 'example' => 'cb67479ce28243b28ff39948feaa0806'],
'Success' => ['description' => '是否调用成功。'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Tasks' => [
'description' => '待办事项。',
'type' => 'array',
'items' => ['description' => '待办事项描述。', 'type' => 'string', 'example' => '回访'],
],
],
],
],
],
'OutsideNumberReleaseReason' => ['description' => '转外线时挂断原因', 'type' => 'string', 'example' => 'NoAnswer'],
'SummaryIndex' => [
'description' => '小结索引',
'type' => 'object',
'properties' => [
'Keywords' => ['description' => '关键词', 'type' => 'string', 'example' => '客服'],
],
],
'VoicebotOriginatorNumber' => ['description' => '从智能外呼转接过来时携带的外呼主叫号码', 'type' => 'string', 'example' => '021xxxxxxx'],
'VoicebotDestinationNumber' => ['description' => '从智能外呼转接过来时携带的外呼被叫号码', 'type' => 'string', 'example' => '134xxxxxx'],
'OffsiteAgentReleaseReason' => ['description' => '分配的最后一个场外坐席挂断原因', 'type' => 'string', 'example' => 'IVRException'],
'OutsideNumberDestinationNumber' => ['description' => '转外线的被叫号码', 'type' => 'string', 'example' => '134xxxxxx'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'],
],
500 => [
['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"01B12EE4-6AF2-4730-8B78-EC15F4E5C025\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"ContactDisposition\\": \\"Success\\",\\n \\"ContactType\\": \\"OUTBOUND\\",\\n \\"EstablishedTime\\": 1532448000000,\\n \\"CalledNumber\\": \\"1332315****\\",\\n \\"AdditionalBroker\\": \\"0533128****\\",\\n \\"SatisfactionIndex\\": 1,\\n \\"SatisfactionSurveyChannel\\": \\"IVR\\",\\n \\"ReleaseTime\\": 1532707199000,\\n \\"WaitTime\\": 5,\\n \\"SkillGroupNames\\": \\"测试技能组1,测试技能组2\\",\\n \\"IvrTime\\": 8,\\n \\"SatisfactionDescription\\": \\"满意\\",\\n \\"ReleaseInitiator\\": \\"customer\\",\\n \\"AgentIds\\": \\"agent@ccc-test\\",\\n \\"CallDuration\\": \\"16\\",\\n \\"RecordingReady\\": true,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RingTime\\": 5,\\n \\"SatisfactionSurveyOffered\\": true,\\n \\"AgentNames\\": \\"云呼测试坐席\\",\\n \\"StartTime\\": 1631440860000,\\n \\"ContactId\\": \\"job-2255019651513856\\",\\n \\"RecordingDuration\\": 10,\\n \\"CallingNumber\\": \\"0533128****\\",\\n \\"QueueTime\\": 0,\\n \\"Broker\\": \\"053xxxx3127\\",\\n \\"SkillGroupIds\\": \\"skg-default@ccc-test\\",\\n \\"CallerLocation\\": \\"北京市-北京\\",\\n \\"CalleeLocation\\": \\"山东省-济南\\",\\n \\"EarlyMediaState\\": \\"NotConnected\\",\\n \\"ReleaseReason\\": \\"486:USER_BUSY\\",\\n \\"DialingTime\\": 0,\\n \\"TalkTime\\": 0,\\n \\"HeldTime\\": 12,\\n \\"EarlyMediaText\\": \\"正在通话中\\",\\n \\"OffSiteAgentIds\\": \\"skg-default@ccc-test\\",\\n \\"OffsiteAgentDestinationNumbers\\": \\"80312348\\",\\n \\"MessagesSent\\": 10,\\n \\"MessagesSentByCustomer\\": 5,\\n \\"MessagesSentByAgent\\": 5,\\n \\"FirstResponseTime\\": 10,\\n \\"MediaType\\": \\"CHAT\\",\\n \\"TransferCount\\": 1,\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"AccessChannelName\\": \\"测试渠道\\",\\n \\"AccessChannelUserId\\": \\"test-user-id\\",\\n \\"AccessChannelUserName\\": \\"测试访客\\",\\n \\"ClientIpAddress\\": \\"10.100.2.1\\",\\n \\"ClientLocation\\": \\"---\\",\\n \\"ClientUserAgent\\": \\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36\\",\\n \\"ClientAppName\\": \\"未知\\",\\n \\"OffsiteAgentOriginatorNumbers\\": \\"0101257****\\",\\n \\"CallIds\\": \\"dxxx1sdf,xkkwwwa\\",\\n \\"AnalyticsReportReady\\": true,\\n \\"AnalyticsReport\\": {\\n \\"ProblemSolving\\": {\\n \\"TaskId\\": \\"8bf18b7a10064b29a75946a8d5b8469a\\",\\n \\"Success\\": false,\\n \\"Solved\\": true,\\n \\"Problem\\": \\"告警问题\\",\\n \\"Solution\\": \\"富化服务自动关闭原始告警\\"\\n },\\n \\"Emotion\\": {\\n \\"TaskId\\": \\"0ff07fe35670423089dbdf12766d962f\\",\\n \\"Success\\": true,\\n \\"Type\\": \\"中性\\",\\n \\"Confidence\\": 50,\\n \\"Remark\\": \\"客户没情绪变化\\"\\n },\\n \\"Satisfaction\\": {\\n \\"TaskId\\": \\"cb67479ce28243b28ff39948feaa0806\\",\\n \\"Success\\": true,\\n \\"SatisfactionDescription\\": \\"满意\\",\\n \\"Remark\\": \\"客户表示满意\\"\\n },\\n \\"TodoList\\": {\\n \\"TaskId\\": \\"cb67479ce28243b28ff39948feaa0806\\",\\n \\"Success\\": true,\\n \\"Tasks\\": [\\n \\"回访\\"\\n ]\\n }\\n },\\n \\"OutsideNumberReleaseReason\\": \\"NoAnswer\\",\\n \\"SummaryIndex\\": {\\n \\"Keywords\\": \\"客服\\"\\n },\\n \\"VoicebotOriginatorNumber\\": \\"021xxxxxxx\\",\\n \\"VoicebotDestinationNumber\\": \\"134xxxxxx\\",\\n \\"OffsiteAgentReleaseReason\\": \\"IVRException\\",\\n \\"OutsideNumberDestinationNumber\\": \\"134xxxxxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取通话详情列表',
'description' => 'ListCallDetailRecordsV2用来替代ListCallDetailRecords接口,后续新增字段和查询条件会在ListCallDetailRecordsV2持续优化。另外为了保证查询效率,返回数据中的 TotalCount 字段,只会在查询第一页时赋值,查询其他页时返回 0。',
'changeSet' => [
['createdAt' => '2025-07-15T12:01:46.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-06-12T11:54:29.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-09-06T02:26:17.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ListCallSummaries' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'ContactIdList',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '通话ID列表',
'description' => '通话ID列表。',
'type' => 'array',
'items' => ['description' => '通话ID。', 'type' => 'string', 'required' => false, 'example' => 'job-544789******759424'],
'required' => false,
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListCallSummariesResponse',
'description' => 'ListCallSummariesResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TicketId' => ['title' => '小结ID', 'description' => '小结ID。', 'type' => 'string', 'example' => 'ac0dd304-****-****-****-4a90010f0d38'],
'ContactId' => ['title' => '通话ID', 'description' => '通话ID。', 'type' => 'string', 'example' => 'job-544789******759424'],
'Context' => ['title' => 'summary信息', 'description' => '小结信息。', 'type' => 'string', 'example' => '{'."\n"
.' "_sys_field_config": ['."\n"
.' {'."\n"
.' "Array": false,'."\n"
.' "Required": true,'."\n"
.' "DisplayName": "主题",'."\n"
.' "Attributes": "{}",'."\n"
.' "DataType": "TEXT",'."\n"
.' "EditorType": "TEXT",'."\n"
.' "MaxLength": 30,'."\n"
.' "System": true,'."\n"
.' "Name": "summaryTitle"'."\n"
.' },'."\n"
.' {'."\n"
.' "Array": false,'."\n"
.' "DisplayName": "小结",'."\n"
.' "Attributes": "{}",'."\n"
.' "DataType": "TEXT",'."\n"
.' "EditorType": "TEXTAREA",'."\n"
.' "MaxLength": 1000,'."\n"
.' "System": true,'."\n"
.' "Name": "summaryContent"'."\n"
.' },'."\n"
.' {'."\n"
.' "Array": true,'."\n"
.' "DisplayName": "标签",'."\n"
.' "Attributes": "{}",'."\n"
.' "DataType": "TEXT",'."\n"
.' "EditorType": "SELECT",'."\n"
.' "System": true,'."\n"
.' "Name": "keywords"'."\n"
.' }'."\n"
.' ],'."\n"
.' "summaryContent": "小结内容",'."\n"
.' "creator": "creator@ccc-test",'."\n"
.' "bizType": "Summary",'."\n"
.' "keywords": ['."\n"
.' "标签1"'."\n"
.' ],'."\n"
.' "source": "Console",'."\n"
.' "summaryTitle": "测试会话小结",'."\n"
.' "instanceId": "ccc-test",'."\n"
.' "externalInput": "{\\"summaryTitle\\":\\"测试会话小结\\",\\"summaryContent\\":\\"小结内容\\",\\"keywords\\":[\\"标签1\\"],\\"_sys_field_config\\":[{\\"DisplayName\\":\\"主题\\",\\"Name\\":\\"summaryTitle\\",\\"Required\\":true,\\"EditorType\\":\\"TEXT\\",\\"Array\\":false,\\"DataType\\":\\"TEXT\\",\\"System\\":true,\\"MaxLength\\":30,\\"Attributes\\":\\"{}\\"},{\\"DisplayName\\":\\"小结\\",\\"Name\\":\\"summaryContent\\",\\"EditorType\\":\\"TEXTAREA\\",\\"Array\\":false,\\"DataType\\":\\"TEXT\\",\\"System\\":true,\\"MaxLength\\":1000,\\"Attributes\\":\\"{}\\"},{\\"DisplayName\\":\\"标签\\",\\"Name\\":\\"keywords\\",\\"EditorType\\":\\"SELECT\\",\\"Array\\":true,\\"DataType\\":\\"TEXT\\",\\"System\\":true,\\"Attributes\\":\\"{}\\"}]}",'."\n"
.' "templateName": "Summary-Ticket",'."\n"
.' "bizId": "job-544789******759424",'."\n"
.' "ticketStartTime": 1723449513735,'."\n"
.' "ticketId": "ac0dd304-****-****-****-4a90010f0d38",'."\n"
.' "definitionId": "Summary-Ticket:2:6881f43a-****-11ee-*****-6eb35a90a7a6"'."\n"
.'}'],
'CreatedTime' => ['title' => '创建时间', 'description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1723449513735'],
'Creator' => ['title' => '创建人', 'description' => '创建人。', 'type' => 'string', 'example' => 'creator@ccc-test'],
'Editor' => ['description' => '编辑人。', 'type' => 'string', 'example' => 'editor@ccc-test'],
],
'description' => '',
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '932579BC-811A-503D-B322-4C2E57087CAA'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"TicketId\\": \\"ac0dd304-****-****-****-4a90010f0d38\\",\\n \\"ContactId\\": \\"job-544789******759424\\",\\n \\"Context\\": \\"{\\\\n \\\\\\"_sys_field_config\\\\\\": [\\\\n {\\\\n \\\\\\"Array\\\\\\": false,\\\\n \\\\\\"Required\\\\\\": true,\\\\n \\\\\\"DisplayName\\\\\\": \\\\\\"主题\\\\\\",\\\\n \\\\\\"Attributes\\\\\\": \\\\\\"{}\\\\\\",\\\\n \\\\\\"DataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"EditorType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"MaxLength\\\\\\": 30,\\\\n \\\\\\"System\\\\\\": true,\\\\n \\\\\\"Name\\\\\\": \\\\\\"summaryTitle\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"Array\\\\\\": false,\\\\n \\\\\\"DisplayName\\\\\\": \\\\\\"小结\\\\\\",\\\\n \\\\\\"Attributes\\\\\\": \\\\\\"{}\\\\\\",\\\\n \\\\\\"DataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"EditorType\\\\\\": \\\\\\"TEXTAREA\\\\\\",\\\\n \\\\\\"MaxLength\\\\\\": 1000,\\\\n \\\\\\"System\\\\\\": true,\\\\n \\\\\\"Name\\\\\\": \\\\\\"summaryContent\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"Array\\\\\\": true,\\\\n \\\\\\"DisplayName\\\\\\": \\\\\\"标签\\\\\\",\\\\n \\\\\\"Attributes\\\\\\": \\\\\\"{}\\\\\\",\\\\n \\\\\\"DataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"EditorType\\\\\\": \\\\\\"SELECT\\\\\\",\\\\n \\\\\\"System\\\\\\": true,\\\\n \\\\\\"Name\\\\\\": \\\\\\"keywords\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"summaryContent\\\\\\": \\\\\\"小结内容\\\\\\",\\\\n \\\\\\"creator\\\\\\": \\\\\\"creator@ccc-test\\\\\\",\\\\n \\\\\\"bizType\\\\\\": \\\\\\"Summary\\\\\\",\\\\n \\\\\\"keywords\\\\\\": [\\\\n \\\\\\"标签1\\\\\\"\\\\n ],\\\\n \\\\\\"source\\\\\\": \\\\\\"Console\\\\\\",\\\\n \\\\\\"summaryTitle\\\\\\": \\\\\\"测试会话小结\\\\\\",\\\\n \\\\\\"instanceId\\\\\\": \\\\\\"ccc-test\\\\\\",\\\\n \\\\\\"externalInput\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"summaryTitle\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"测试会话小结\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"summaryContent\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"小结内容\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"keywords\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"标签1\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"_sys_field_config\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"DisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"主题\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"summaryTitle\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Required\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"EditorType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Array\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"DataType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"System\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"MaxLength\\\\\\\\\\\\\\":30,\\\\\\\\\\\\\\"Attributes\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{}\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"DisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"小结\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"summaryContent\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"EditorType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXTAREA\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Array\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"DataType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"System\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"MaxLength\\\\\\\\\\\\\\":1000,\\\\\\\\\\\\\\"Attributes\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{}\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"DisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"标签\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"keywords\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"EditorType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SELECT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Array\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"DataType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"System\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"Attributes\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{}\\\\\\\\\\\\\\"}]}\\\\\\",\\\\n \\\\\\"templateName\\\\\\": \\\\\\"Summary-Ticket\\\\\\",\\\\n \\\\\\"bizId\\\\\\": \\\\\\"job-544789******759424\\\\\\",\\\\n \\\\\\"ticketStartTime\\\\\\": 1723449513735,\\\\n \\\\\\"ticketId\\\\\\": \\\\\\"ac0dd304-****-****-****-4a90010f0d38\\\\\\",\\\\n \\\\\\"definitionId\\\\\\": \\\\\\"Summary-Ticket:2:6881f43a-****-11ee-*****-6eb35a90a7a6\\\\\\"\\\\n}\\",\\n \\"CreatedTime\\": 1723449513735,\\n \\"Creator\\": \\"creator@ccc-test\\",\\n \\"Editor\\": \\"editor@ccc-test\\"\\n }\\n ],\\n \\"RequestId\\": \\"932579BC-811A-503D-B322-4C2E57087CAA\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '获取会话小结',
'summary' => '使用ListCallSummaries接口获取会话小结。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ListCallTags' => [
'summary' => '调用ListCallTags获取指定实例下的所有号码标签。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'List' => [
'description' => '号码标签列表。'."\n"
."\n",
'type' => 'array',
'items' => [
'description' => '号码标签。',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'TagName' => ['description' => '号码标签名称。', 'type' => 'string', 'example' => 'TagA'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
500 => [
['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'],
],
],
'title' => '获取号码标签列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallTags'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TagName\\": \\"TagA\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message>无</Message>\\n<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <TagName>TagA</TagName>\\n <InstanceId>ccc-test</InstanceId>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListCampaignTrendingReport' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccQFUGXR'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CampaignId',
'in' => 'query',
'schema' => ['title' => '活动ID', 'description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['title' => '开始时间', 'description' => '开始时间,非必填,默认为预测式外呼活动的开始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2021-10-14 00:00:00'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['title' => '结束时间', 'description' => '结束时间,非必填,默认为预测式外呼活动的结束时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2021-10-14 20:59:59'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0'],
'Data' => [
'description' => '统计打点数据列表。',
'type' => 'array',
'items' => [
'description' => '统计打点数据。',
'type' => 'object',
'properties' => [
'Datetime' => ['description' => '分段统计的打点时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634037840000'],
'Concurrency' => ['description' => '呼叫并发量,即同时在外呼的通话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'TalkAgents' => ['description' => '已废弃,请参考TalkAgents。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ReadyAgents' => ['description' => '空闲坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'WorkAgents' => ['description' => '已废弃,请参考WorkingAgents。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'LoggedInAgents' => ['description' => '上线的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'BreakAgents' => ['description' => '小休坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'StatsTime' => ['description' => '统计打点时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000'],
'TalkingAgents' => ['description' => '处于通话状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
'WorkingAgents' => ['description' => '处于话后处理状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'BreakingAgents' => ['description' => '处于小休状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'OutboundScenarioReadyAgents' => ['description' => '处于仅外呼模式且在空闲状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'OutboundScenarioBreakingAgents' => ['description' => '处于仅外呼模式且在小休状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'OutboundScenarioTalkingAgents' => ['description' => '处于仅外呼模式且在通话中状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'OutboundScenarioWorkingAgents' => ['description' => '处于仅外呼模式且在话后处理状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
],
],
],
],
],
],
],
'title' => '获取预测式外呼活动趋势报表',
'summary' => '获取指定实例下指定ID对应的预测式外呼活动的趋势报表。',
'changeSet' => [
['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCampaignTrendingReport'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0\\",\\n \\"Data\\": [\\n {\\n \\"Datetime\\": 1634037840000,\\n \\"Concurrency\\": 1,\\n \\"TalkAgents\\": 0,\\n \\"ReadyAgents\\": 2,\\n \\"WorkAgents\\": 0,\\n \\"LoggedInAgents\\": 2,\\n \\"BreakAgents\\": 0,\\n \\"StatsTime\\": 1604639129000,\\n \\"TalkingAgents\\": 4,\\n \\"WorkingAgents\\": 0,\\n \\"BreakingAgents\\": 1,\\n \\"OutboundScenarioReadyAgents\\": 1,\\n \\"OutboundScenarioBreakingAgents\\": 2,\\n \\"OutboundScenarioTalkingAgents\\": 1,\\n \\"OutboundScenarioWorkingAgents\\": 2\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListCampaignTrendingReportResponse>\\n <Code>OK</Code>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Message>无</Message>\\n <RequestId>6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0</RequestId>\\n <Data>\\n <Datetime>1634037840000</Datetime>\\n <Concurrency>1</Concurrency>\\n <TalkAgents>0</TalkAgents>\\n <ReadyAgents>2</ReadyAgents>\\n <WorkAgents>0</WorkAgents>\\n <LoggedInAgents>2</LoggedInAgents>\\n <BreakAgents>0</BreakAgents>\\n </Data>\\n</ListCampaignTrendingReportResponse>","errorExample":""}]',
],
'ListCampaigns' => [
'summary' => '调用ListCampaigns获取指定实例下的预测式外呼活动列表。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccQFUGXR'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'State',
'in' => 'query',
'schema' => [
'description' => '按预测式外呼活动状态过滤,非必填,默认为空。'."\n",
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Draft' => '草稿', 'Completed' => '已完成', 'Executing' => '执行中', 'Pending' => '待执行', 'Aborted' => '已终止', 'Paused' => 'Paused'],
'example' => 'Draft',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '按预测式外呼活动名称过滤,不支持模糊匹配,非必填,默认为空,表示不过滤。', 'type' => 'string', 'required' => false, 'example' => 'test-campaign'],
],
[
'name' => 'PlanedStartTimeFrom',
'in' => 'query',
'schema' => ['description' => '外呼活动计划开始时间,非必填,默认查询所有时间范围。', 'type' => 'string', 'required' => false, 'example' => '1780243200000'],
],
[
'name' => 'PlanedStartTimeTo',
'in' => 'query',
'schema' => ['description' => '外呼活动计划结束时间,非必填,默认查询所有时间范围。', 'type' => 'string', 'required' => false, 'example' => '1781798399000'],
],
[
'name' => 'ActualStartTimeFrom',
'in' => 'query',
'schema' => ['description' => '外呼活动实际开始时间,非必填,默认查询所有时间范围。', 'type' => 'string', 'required' => false, 'example' => '1780329600000'],
],
[
'name' => 'ActualStartTimeTo',
'in' => 'query',
'schema' => ['description' => '外呼活动实际结束时间,非必填,默认查询所有时间范围。', 'type' => 'string', 'required' => false, 'example' => '1781625600000'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10'],
],
[
'name' => 'QueueId',
'in' => 'query',
'schema' => ['description' => '按技能组ID过滤,非必填,默认为空,表示不过滤。', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'List' => [
'description' => '预测式外呼活动列表。',
'type' => 'array',
'items' => [
'description' => '预测式外呼活动信息。',
'type' => 'object',
'properties' => [
'ActualEndTime' => ['description' => '预测式外呼活动实际结束时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634008800000'],
'ActualStartTime' => ['description' => '预测式外呼活动实际开始时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634000460000'],
'CasesAborted' => ['description' => '预测式外呼活动的止呼数量,止呼指取消呼叫联系人。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CasesUncompleted' => ['description' => '预测式外呼活动的未完成数量,未完成指未接通且未达到最大重试次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CasesConnected' => ['description' => '预测式外呼活动的接通数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '40'],
'MaxAttemptCount' => ['description' => '预测式外呼活动的最大尝试次数,表示当活动的号码呼叫失败时,最多重呼几次。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'MinAttemptInterval' => ['description' => '预测式外呼活动的最小重呼间隔,表示失败重呼时的最小间隔,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Name' => ['description' => '预测式外呼活动名称。', 'type' => 'string', 'example' => 'test-campaign'],
'PlanedEndTime' => ['description' => '预测式外呼活动计划结束时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634054400000'],
'PlanedStartTime' => ['description' => '预测式外呼活动计划开始时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1633968000000'],
'QueueName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => '测试技能组'],
'TotalCases' => ['description' => '号码总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'State' => [
'title' => 'state',
'description' => '预测式外呼活动状态。',
'type' => 'string',
'enumValueTitles' => ['Draft' => '草稿', 'Completed' => '已完成', 'Executing' => '执行中', 'Pending' => '待执行', 'Aborted' => '已终止', 'Paused' => '已暂停'],
'example' => 'Completed',
],
'CampaignId' => ['title' => 'id', 'description' => '预测式外呼活动ID。', 'type' => 'string', 'example' => '6badb397-a8b5-40b6-21019d382a09'],
'StrategyType' => [
'description' => '预测式外呼活动的策略模式。',
'type' => 'string',
'enumValueTitles' => ['PACING' => '固定比例外呼,外呼数量=空闲坐席*比例。', 'PID' => '系统基于PID控制策略,自动调整外呼电话数量。'],
'example' => 'PACING',
],
'StrategyParameters' => ['description' => '预测式外呼活动的策略参数,PID策略下的格式参数示例:{"abandonRate":"5","historicalConnectedRate":"35"},PACING策略下的格式参数示例:{"ratio":1}。abandonRate表示期望呼损率,historicalConnectedRate表示历史参考接通率,ratio表示固定外呼比例。', 'type' => 'string', 'example' => '{"ratio":1}'],
'QueueId' => ['description' => '关联的技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Simulation' => ['description' => '是否为模拟活动。', 'type' => 'boolean', 'example' => 'false'],
'CompletionRate' => ['description' => '完成率,参数已废弃,可以使用(TotalCases-CasesUnCompleted) / TotalCases计算得出', 'type' => 'number', 'format' => 'float', 'example' => '无'],
'ContactFlowId' => ['description' => '号码关联的IVR联系流ID。', 'type' => 'string', 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek'],
],
],
],
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"ActualEndTime\\": 1634008800000,\\n \\"ActualStartTime\\": 1634000460000,\\n \\"CasesAborted\\": 0,\\n \\"CasesUncompleted\\": 0,\\n \\"CasesConnected\\": 40,\\n \\"MaxAttemptCount\\": 1,\\n \\"MinAttemptInterval\\": 1,\\n \\"Name\\": \\"test-campaign\\",\\n \\"PlanedEndTime\\": 1634054400000,\\n \\"PlanedStartTime\\": 1633968000000,\\n \\"QueueName\\": \\"测试技能组\\",\\n \\"TotalCases\\": 100,\\n \\"State\\": \\"Completed\\",\\n \\"CampaignId\\": \\"6badb397-a8b5-40b6-21019d382a09\\",\\n \\"StrategyType\\": \\"PACING\\",\\n \\"StrategyParameters\\": \\"{\\\\\\"ratio\\\\\\":1}\\",\\n \\"QueueId\\": \\"skillgroup@ccc-test\\",\\n \\"Simulation\\": false,\\n \\"CompletionRate\\": 0,\\n \\"ContactFlowId\\": \\"a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListCampaignsResponse>\\n <RequestId>6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0</RequestId>\\n <Message>无</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>\\n <List>\\n <ActualEndTime>1634008800000</ActualEndTime>\\n <ActualStartTime>1634000460000</ActualStartTime>\\n <CasesAborted>0</CasesAborted>\\n <CasesUncompleted>0</CasesUncompleted>\\n <CasesConnected>40</CasesConnected>\\n <CompletedRate>100</CompletedRate>\\n <MaxAttemptCount>1</MaxAttemptCount>\\n <MinAttemptInterval>1</MinAttemptInterval>\\n <Name>test-campalgn</Name>\\n <PlanedEndTime>1634054400000</PlanedEndTime>\\n <PlanedStartTime>1633968000000</PlanedStartTime>\\n <QueueName>默认技能组</QueueName>\\n <TotalCases>100</TotalCases>\\n <State>Completed</State>\\n <CampaignId>6badb397-a8b5-40b6-21019d382a09</CampaignId>\\n <StrategyType>PACING</StrategyType>\\n <StrategyParameters>{\\"ratio\\":1}</StrategyParameters>\\n <QueueId>skg-default@report-test-2</QueueId>\\n <Simulation>false</Simulation>\\n </List>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>1</TotalCount>\\n </Data>\\n <Code>OK</Code>\\n <Success>true</Success>\\n</ListCampaignsResponse>","errorExample":""}]',
'title' => '获取预测式外呼活动列表',
'changeSet' => [
['createdAt' => '2024-06-06T11:38:12.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-11-17T01:12:02.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCampaigns'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ListCases' => [
'summary' => '调用ListCases获取指定实例下指定ID对应的预测式外呼活动的外呼名单执行详情列表。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccQFUGXR'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CampaignId',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09'],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
'schema' => ['description' => '按电话号码过滤,不支持模糊匹配,非必填,默认为空。', 'type' => 'string', 'required' => false, 'example' => '无'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100'],
],
[
'name' => 'State',
'in' => 'query',
'schema' => ['description' => 'Pending(待拨打) '."\n"
.'Executing(拨打中) '."\n"
.'Connected(联系成功) '."\n"
.'Failed(联系失败) '."\n"
.'Aborted(止呼, 取消呼叫) '."\n"
.'Forbidden(规则禁止呼叫,比如黑名单)', 'type' => 'string', 'required' => false, 'example' => 'Pending'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE316'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
'title' => 'data',
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'List' => [
'description' => '联系人名单执行详情列表。',
'type' => 'array',
'items' => [
'description' => '联系人名单执行详情。',
'type' => 'object',
'properties' => [
'AbandonType' => [
'description' => '通话被放弃的类型,即未成功接通的原因。',
'type' => 'string',
'enumValueTitles' => ['NA' => '未放弃', 'IVR' => 'IVR交互阶段', 'Ringing' => '坐席振铃阶段', 'Queuing' => '排队阶段'],
'example' => 'NA',
],
'AttemptCount' => ['description' => '已尝试次数,对该联系人的总呼叫次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'FailureReason' => [
'description' => '外呼失败原因。',
'type' => 'string',
'enumValueTitles' => [
'AbandonedInQueue' => '排队放弃', 'AbandonedInRing' => '振铃放弃', 'AbandonedInIVR' => 'IVR放弃', 'NoAnswer' => '客户未接', 'QueuingTimeout' => '排队超时', 'Reject' => '客户拒接', 'Voicemail' => '转语音邮箱', 'QueuingFailed' => '转人工失败', 'QueuingOverflow' => '排队溢出', 'AbandonedInVoiceNavigator' => '智能导航中放弃',
'IVRException' => 'IVR异常', 'ForwardToOutsideNumber' => '转外线',
],
'example' => '无',
],
'PhoneNumber' => ['description' => '电话号码。', 'type' => 'string', 'example' => '1888888****'],
'State' => [
'description' => '状态。',
'type' => 'string',
'enumValueTitles' => ['Connected' => '联系成功', 'Failed' => '联系失败', 'Executing' => '拨打中', 'Pending' => '待拨打', 'Aborted' => '已止呼'],
'example' => 'Connected',
],
'CaseId' => ['description' => '系统生成的联系人ID,客户无需关心。', 'type' => 'string', 'example' => '60ecb1a2-4480-4d01-bede-c5b7655bfadf'],
'CustomVariables' => ['description' => '客户自定义变量,格式为JSON对象,对象最多包含10个属性,每个属性的名称和值均由客户自定义,客户在创建预测式外呼活动时可以设置。', 'type' => 'string', 'example' => '{"name":"yy","客戶标签":"tag-yy"}'],
'AbandonPhase' => ['description' => '通话被放弃的阶段。 '."\n"
.' - IVR(IVR交互阶段) '."\n"
.' - Queuing(排队阶段) '."\n"
.' - Ringing(坐席振铃阶段)', 'type' => 'string', 'example' => 'Ringing'],
],
],
],
],
],
],
'description' => '',
],
],
],
'title' => '获取预测式外呼名单列表',
'changeSet' => [
['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCases'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE316\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"AbandonType\\": \\"NA\\",\\n \\"AttemptCount\\": 1,\\n \\"FailureReason\\": \\"无\\",\\n \\"PhoneNumber\\": \\"1888888****\\",\\n \\"State\\": \\"Connected\\",\\n \\"CaseId\\": \\"60ecb1a2-4480-4d01-bede-c5b7655bfadf\\",\\n \\"CustomVariables\\": \\"{\\\\\\"name\\\\\\":\\\\\\"yy\\\\\\",\\\\\\"客戶标签\\\\\\":\\\\\\"tag-yy\\\\\\"}\\",\\n \\"AbandonPhase\\": \\"Ringing\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListCasesResponse>\\n <RequestId>7CC6523B-0E51-1B62-8DA5-6A9831CAE316</RequestId>\\n <Message>无</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>\\n <List>\\n <AbandonType>NA</AbandonType>\\n <AttemptCount>1</AttemptCount>\\n <ExpandInfo>待删除</ExpandInfo>\\n <FailureReason>无</FailureReason>\\n <PhoneNumber>18888888888</PhoneNumber>\\n <State>Connected</State>\\n <CaseId>60ecb1a2-4480-4d01-bede-c5b7655bfadf</CaseId>\\n <CustomVariables>{\\"name\\":\\"yy\\",\\"客戶标签\\":\\"tag-yy\\"}</CustomVariables>\\n </List>\\n <PageNumber>1</PageNumber>\\n <PageSize>100</PageSize>\\n <TotalCount>1</TotalCount>\\n </Data>\\n <Code>OK</Code>\\n <Success>true</Success>\\n</ListCasesResponse>","errorExample":""}]',
],
'ListCategories' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '类目类别。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Ticket' => 'Ticket'],
'example' => 'Ticket',
],
],
[
'name' => 'CategoryId',
'in' => 'query',
'schema' => ['description' => '工单类目ID。指定类目ID,返回对应ID的子类目信息,不指定返回实例下类目的信息。', 'type' => 'string', 'required' => false, 'example' => '43c2671b-***-***-86d0-6bd187905cc8'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListCategoriesResponse',
'description' => 'ListCategoriesResponse',
'type' => 'object',
'properties' => [
'Data' => ['description' => '数据。类目节点信息,JSON字符传形式。', 'type' => 'string', 'example' => '[{\\"categoryId\\":\\"43c2671b-8939-4223-****-6bd187905cc8\\",\\"childCategoryList\\":[{\\"categoryId\\":\\"120816ad-4392-4edf-****-6d053d5cfa5a\\",\\"childCategoryList\\":[],\\"deleted\\":0,\\"editor\\":\\"283277706217028904\\",\\"editorName\\":\\"283277706217028904\\",\\"instanceId\\":\\"cccV2-kmz\\",\\"itemCount\\":0,\\"level\\":2,\\"name\\":\\"客户反馈\\",\\"parentCategoryId\\":\\"43c2671b-8939-****-86d0-6bd187905cc8\\",\\"type\\":\\"Ticket\\"}],\\"deleted\\":0,\\"editor\\":\\"283277706217028904\\",\\"editorName\\":\\"283277706217028904\\",\\"instanceId\\":\\"cccV2-kmz\\",\\"itemCount\\":10,\\"level\\":1,\\"name\\":\\"测试一01类目\\",\\"type\\":\\"Ticket\\"},{\\"categoryId\\":\\"4948fcd0-2972-****-81c6-1a00927e1802\\",\\"childCategoryList\\":[],\\"deleted\\":0,\\"editor\\":\\"283277706217028904\\",\\"editorName\\":\\"283277706217028904\\",\\"instanceId\\":\\"cccV2-kmz\\",\\"itemCount\\":0,\\"level\\":1,\\"name\\":\\"生产环境验证\\",\\"type\\":\\"Ticket\\"},{\\"categoryId\\":\\"c426bd7f-9661-47c3-****-2508f1a32f66\\",\\"childCategoryList\\":[],\\"deleted\\":0,\\"editor\\":\\"269801834095770945\\",\\"editorName\\":\\"269801834095770945\\",\\"instanceId\\":\\"cccV2-kmz\\",\\"itemCount\\":4,\\"level\\":1,\\"name\\":\\"测试环境测试\\",\\"type\\":\\"Ticket\\"}]'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"[{\\\\\\\\\\\\\\"categoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"43c2671b-8939-4223-****-6bd187905cc8\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"childCategoryList\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"categoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"120816ad-4392-4edf-****-6d053d5cfa5a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"childCategoryList\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"deleted\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"editor\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"editorName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"itemCount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"客户反馈\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parentCategoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"43c2671b-8939-****-86d0-6bd187905cc8\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Ticket\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"deleted\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"editor\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"editorName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"itemCount\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"测试一01类目\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Ticket\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"categoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4948fcd0-2972-****-81c6-1a00927e1802\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"childCategoryList\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"deleted\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"editor\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"editorName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"itemCount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"生产环境验证\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Ticket\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"categoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"c426bd7f-9661-47c3-****-2508f1a32f66\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"childCategoryList\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"deleted\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"editor\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"269801834095770945\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"editorName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"269801834095770945\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"itemCount\\\\\\\\\\\\\\":4,\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"测试环境测试\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Ticket\\\\\\\\\\\\\\"}]\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '获取类目',
'summary' => '使用ListCategories获取类目信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ListCommonTicketFields' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'GetSchemaResponse',
'description' => 'GetSchemaResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Id' => ['description' => 'Schema ID。', 'type' => 'string', 'example' => 'ticketing'],
'Properties' => [
'description' => '字段列表。',
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'DisplayName' => ['type' => 'string', 'description' => '显示名称。', 'example' => '姓名'],
'Description' => ['type' => 'string', 'description' => '描述。', 'example' => 'name'],
'Name' => ['type' => 'string', 'description' => '名称。', 'example' => 'name'],
'DataType' => ['type' => 'string', 'example' => 'string', 'description' => '数据类型。'],
'Pattern' => ['type' => 'string', 'example' => '^', 'description' => '正则表达式校验规则。'],
'PatternErrorMessage' => ['type' => 'string', 'example' => '不是有效的email地址', 'description' => '正则表达式校验错误提示信息。'],
'MinLength' => ['type' => 'integer', 'format' => 'int32', 'description' => '最小长度。', 'example' => '1'],
'MaxLength' => ['type' => 'integer', 'format' => 'int32', 'description' => '最大长度。', 'example' => '10'],
'Minimum' => ['type' => 'number', 'format' => 'double', 'description' => '数字最小值。', 'example' => '1'],
'Maximum' => ['type' => 'number', 'format' => 'double', 'example' => '10', 'description' => '数字最大值。'],
'Required' => ['type' => 'boolean', 'description' => '是否必填。', 'example' => 'false'],
'System' => ['type' => 'boolean', 'example' => 'false', 'description' => '是否是系统字段。'],
'Disabled' => ['type' => 'boolean', 'description' => '是否被禁用。', 'example' => 'false'],
'Array' => ['type' => 'boolean', 'description' => '是否是数组。', 'example' => 'false'],
'ReadOnly' => ['type' => 'boolean', 'description' => '是否只读。', 'example' => 'false'],
'EditorType' => ['type' => 'string', 'description' => '编辑器类型。', 'example' => 'textbox'],
'Attributes' => ['type' => 'string', 'description' => '扩展属性。', 'example' => '{}'."\n"],
'DisplayOrder' => ['type' => 'integer', 'format' => 'int32', 'description' => '列表展示顺序。', 'example' => '1'],
'CreatedTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '创建时间。', 'example' => '1703517780627'],
'UpdatedTime' => ['type' => 'integer', 'format' => 'int64', 'example' => '1716211430928', 'description' => '更新时间。'],
'Creator' => ['type' => 'string', 'description' => '创建者。', 'example' => 'creator@ccc-test'],
],
'description' => '字段。',
],
],
'CreatedTime' => ['description' => '创建时间。'."\n", 'type' => 'string', 'example' => '1703517780627'],
'UpdatedTime' => ['description' => '上次修改的时间。', 'type' => 'string', 'example' => '1716211430928'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30C7D235-DDCF-4C7F-A462-5E2598252C2B'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Id\\": \\"ticketing\\",\\n \\"Properties\\": {\\n \\"key\\": {\\n \\"DisplayName\\": \\"姓名\\",\\n \\"Description\\": \\"name\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"string\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 10,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\\\n\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 1703517780627,\\n \\"UpdatedTime\\": 1716211430928,\\n \\"Creator\\": \\"creator@ccc-test\\"\\n }\\n },\\n \\"CreatedTime\\": \\"1703517780627\\",\\n \\"UpdatedTime\\": \\"1716211430928\\"\\n },\\n \\"RequestId\\": \\"30C7D235-DDCF-4C7F-A462-5E2598252C2B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '获取工单字段定义',
'summary' => '使用ListCommonTicketFields获取实例下定义的工单字段类型。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ListConfigItems' => [
'summary' => '调用ListConfigItems获取指定实例下的配置信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccTMAX45'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'ObjectId',
'in' => 'query',
'schema' => ['description' => '配置信息所属的对象的ID,可以是阿里云主账号ID、实例ID、技能组ID、坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'ObjectType',
'in' => 'query',
'schema' => [
'description' => ' 配置信息所属对象的类型。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['INSTANCE' => '实例级别的配置', 'USER' => '座席自身的配置', 'SKILL_GROUP' => '技能组级别的配置', 'ALIYUN_UID' => '主账号级别的配置'],
'example' => 'INSTANCE',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
'description' => '',
],
'Data' => [
'description' => '配置项列表。',
'type' => 'array',
'items' => [
'description' => '配置项。',
'type' => 'object',
'properties' => [
'ObjectId' => ['description' => '配置信息所属的对象的ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Value' => ['description' => '配置项的值。', 'type' => 'string', 'example' => '100'],
'ObjectType' => ['description' => '配置信息所属对象的类型。', 'type' => 'string', 'example' => 'INSTANCE'],
'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'example' => 'ccc-test'],
'Name' => [
'description' => '配置项名称,配置项名称包含系统定义和客户自定义两种,系统定义包括是否允许坐席挂机、是否自动接听、久振未接时长等,这部分配置项名称是固定的,值可以由客户自定义,除此之外,配置项名称也支持客户自定义,客户可以根据需要添加配置项。',
'type' => 'string',
'enumValueTitles' => ['AllowAudioDownload' => '是否允许坐席下载录音,取值:0(不允许)、1(允许)。', 'RecordingStorageSetting' => '实例录音存储配置。', 'AllowChooseSignedSkillGroup' => '坐席上线前是否手动选择签入的技能组,取值:0(自动签入所属的全部技能组)、1(手动选择签入的技能组)。', 'AgentRingingTimeoutSeconds' => '坐席久振未接超时时长配置,取值范围为5-90,单位秒。', 'ShowCalledID' => '坐席来电显示,取值:-1(隐藏全部来电号码)、0(隐藏部分来电号码)、1(显示完整来电号码)。', 'ShowCalleeID' => '坐席外呼显示,取值:-1(隐藏全部外呼号码)、0(隐藏部分外呼号码)、1(显示完整外呼号码)。', 'AllowHangup' => '坐席呼入挂机方式,取值:0(不允许坐席挂机)、1(允许坐席挂机)。', 'AutoAnswerCall' => '坐席接听来电方式,取值:-1(手动接听)、n(振铃n秒后接听)。'],
'example' => 'config-item',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
403 => [
['errorCode' => 'Permission.Unauthorized', 'errorMessage' => 'You are not authorized to perform this action. %s privileges are required.', 'description' => '您无权执行此操作。 必须具有指定权限。'],
],
[
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取配置项列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConfigItems'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": [\\n {\\n \\"ObjectId\\": \\"ccc-test\\",\\n \\"Value\\": \\"100\\",\\n \\"ObjectType\\": \\"INSTANCE\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"config-item\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <Value>1</Value>\\n <ObjectType>INSTANCE</ObjectType>\\n <ObjectId>ccc-test</ObjectId>\\n <InstanceId>ccc-test</InstanceId>\\n <Name>test-item</Name>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListContactFlows' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '按IVR流程类型过滤,非必填,默认为空,为空表示不过滤。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['SURVEY_FLOW' => '满意度流程', 'SUB_FLOW' => '子流程', 'MAIN_FLOW' => '主流程'],
'example' => 'MAIN_FLOW',
],
],
[
'name' => 'SortOrder',
'in' => 'query',
'schema' => ['description' => '排序方向。取值范围:'."\n"
.'- **ASC**:升序'."\n"
.'- **DESC**(默认值):降序', 'type' => 'string', 'required' => false, 'example' => 'DESC'],
],
[
'name' => 'OrderByField',
'in' => 'query',
'schema' => ['description' => '排序字段。', 'type' => 'string', 'required' => false, 'example' => 'updatedTime'],
],
[
'name' => 'SearchPattern',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'List' => [
'description' => '联系流列表。'."\n"
."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'description' => 'IVR联系流类型。',
'type' => 'string',
'enumValueTitles' => ['SURVEY_FLOW' => '满意度流程', 'SUB_FLOW' => '子流程', 'MAIN_FLOW' => '主流程'],
'example' => 'MAIN_FLOW',
],
'Definition' => ['description' => 'IVR的内容,由后台解析,客户无需关心。', 'type' => 'string', 'example' => '{"activities":[{"type":"INCOMING_CALL","id":"e98f0d47","name":"开始","properties":{"position":{"x":263,"y":164}},"events":[{"event":"complete","next":"2d3ad2c2","edgeId":"41f7dbd0"}],"nodeIndex":0},{"type":"HANGUP","id":"bd4f37e2","name":"挂机","properties":{"position":{"x":765,"y":185}},"events":[{"event":"complete","next":null}],"nodeIndex":999},{"type":"PLAY_SAY","id":"2d3ad2c2","name":"放音","properties":{"say":"您好,欢迎来到云联络中心。","audioResourceId":"","position":{"x":485.5,"y":153.5},"audioType":"tts","audioInterrupt":false},"events":[{"event":"complete","next":"bd4f37e2","edgeId":"e1af4f1f"}],"nodeIndex":1}],"description":""}'],
'DraftId' => ['description' => '草稿ID,当IVR流程处于未发布状态时返回此字段。', 'type' => 'string', 'example' => 'db07c0bb-6b1f-47d2-b37e-2451c617562d'],
'Description' => ['description' => '版本描述。', 'type' => 'string', 'example' => '1.0'],
'UpdatedTime' => ['description' => '上次修改的时间。', 'type' => 'string', 'example' => '2021-03-08 15:34:49.0'],
'Editor' => ['description' => '此草稿的当前编辑者的坐席登录名。', 'type' => 'string', 'example' => 'ccc-test'],
'Published' => ['description' => '是否发布过。', 'type' => 'boolean', 'example' => 'true'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Name' => ['description' => 'IVR联系流名称。', 'type' => 'string', 'example' => '默认流程'],
'ContactFlowId' => ['description' => 'IVR联系流ID。', 'type' => 'string', 'example' => '78128960-bb00-4ddc-8e82-923a8c5bd22d'],
'CreatedTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-03-05 17:35:45.0'],
'NumberList' => [
'description' => 'IVR联系流绑定的号码列表。',
'type' => 'array',
'items' => ['description' => '号码', 'type' => 'string', 'example' => '400289****'],
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取联系流列表',
'summary' => '调用ListContactFlows获取指定实例下的IVR联系流列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-06-18T03:18:59.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-11-06T05:44:49.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListContactFlows'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Type\\": \\"MAIN_FLOW\\",\\n \\"Definition\\": \\"{\\\\\\"activities\\\\\\":[{\\\\\\"type\\\\\\":\\\\\\"INCOMING_CALL\\\\\\",\\\\\\"id\\\\\\":\\\\\\"e98f0d47\\\\\\",\\\\\\"name\\\\\\":\\\\\\"开始\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":263,\\\\\\"y\\\\\\":164}},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":\\\\\\"2d3ad2c2\\\\\\",\\\\\\"edgeId\\\\\\":\\\\\\"41f7dbd0\\\\\\"}],\\\\\\"nodeIndex\\\\\\":0},{\\\\\\"type\\\\\\":\\\\\\"HANGUP\\\\\\",\\\\\\"id\\\\\\":\\\\\\"bd4f37e2\\\\\\",\\\\\\"name\\\\\\":\\\\\\"挂机\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":765,\\\\\\"y\\\\\\":185}},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":null}],\\\\\\"nodeIndex\\\\\\":999},{\\\\\\"type\\\\\\":\\\\\\"PLAY_SAY\\\\\\",\\\\\\"id\\\\\\":\\\\\\"2d3ad2c2\\\\\\",\\\\\\"name\\\\\\":\\\\\\"放音\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"say\\\\\\":\\\\\\"您好,欢迎来到云联络中心。\\\\\\",\\\\\\"audioResourceId\\\\\\":\\\\\\"\\\\\\",\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":485.5,\\\\\\"y\\\\\\":153.5},\\\\\\"audioType\\\\\\":\\\\\\"tts\\\\\\",\\\\\\"audioInterrupt\\\\\\":false},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":\\\\\\"bd4f37e2\\\\\\",\\\\\\"edgeId\\\\\\":\\\\\\"e1af4f1f\\\\\\"}],\\\\\\"nodeIndex\\\\\\":1}],\\\\\\"description\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"DraftId\\": \\"db07c0bb-6b1f-47d2-b37e-2451c617562d\\",\\n \\"Description\\": \\"1.0\\",\\n \\"UpdatedTime\\": \\"2021-03-08 15:34:49.0\\",\\n \\"Editor\\": \\"ccc-test\\",\\n \\"Published\\": true,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"默认流程\\",\\n \\"ContactFlowId\\": \\"78128960-bb00-4ddc-8e82-923a8c5bd22d\\",\\n \\"CreatedTime\\": \\"2021-03-05 17:35:45.0\\",\\n \\"NumberList\\": [\\n \\"400289****\\"\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Type>MAIN_FLOW</Type>\\n <Description>1.0</Description>\\n <CreatedTime>2021-03-05 17:35:45.0</CreatedTime>\\n <InstanceId>ccc-test</InstanceId>\\n <ContactFlowId>78128960-bb00-4ddc-8e82-923a8c5bd22d</ContactFlowId>\\n <Definition>{\\"activities\\":[{\\"type\\":\\"INCOMING_CALL\\",\\"id\\":\\"e98f0d47\\",\\"name\\":\\"开始\\",\\"properties\\":{\\"position\\":{\\"x\\":263,\\"y\\":164}},\\"events\\":[{\\"event\\":\\"complete\\",\\"next\\":\\"2d3ad2c2\\",\\"edgeId\\":\\"41f7dbd0\\"}],\\"nodeIndex\\":0},{\\"type\\":\\"HANGUP\\",\\"id\\":\\"bd4f37e2\\",\\"name\\":\\"挂机\\",\\"properties\\":{\\"position\\":{\\"x\\":765,\\"y\\":185}},\\"events\\":[{\\"event\\":\\"complete\\",\\"next\\":null}],\\"nodeIndex\\":999},{\\"type\\":\\"PLAY_SAY\\",\\"id\\":\\"2d3ad2c2\\",\\"name\\":\\"放音\\",\\"properties\\":{\\"say\\":\\"您好,欢迎来到阿里云呼叫中心。\\",\\"audioResourceId\\":\\"\\",\\"position\\":{\\"x\\":485.5,\\"y\\":153.5},\\"audioType\\":\\"tts\\",\\"audioInterrupt\\":false},\\"events\\":[{\\"event\\":\\"complete\\",\\"next\\":\\"bd4f37e2\\",\\"edgeId\\":\\"e1af4f1f\\"}],\\"nodeIndex\\":1}],\\"description\\":\\"\\"}</Definition>\\n <Published>true</Published>\\n <UpdatedTime>2021-03-08 15:34:49.0</UpdatedTime>\\n <DraftId>db07c0bb-6b1f-47d2-b37e-2451c617562d</DraftId>\\n <Editor>ccc-test</Editor>\\n <Name>测试IVR</Name>\\n <NumberList>[\\"400xxxx289\\"]</NumberList>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListCustomCallTagging' => [
'summary' => '调用ListCustomCallTagging获取指定实例下的呼入号码标记列表。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'SearchPattern',
'in' => 'query',
'schema' => ['description' => '根据号码或描述进行模糊匹配,非必填,默认为空,为空表示不过滤。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1312121****'],
],
[
'name' => 'CallTagNameList',
'in' => 'query',
'schema' => ['description' => '按号码标签名称列表过滤,非必填,默认为空,表示不过滤。格式为JSON数组的字符串,数组元素是号码标签名称。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["TagA"]'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'Data' => [
'description' => '数据。'."\n",
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'List' => [
'description' => '呼入号码标记列表。',
'type' => 'array',
'items' => [
'description' => '呼入号码标记信息。',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Number' => ['description' => '呼入号码标记的号码。', 'type' => 'string', 'example' => '1312121****'],
'Description' => ['description' => '呼入号码标记的描述。', 'type' => 'string', 'example' => '王先生'],
'Creator' => ['description' => '创建者。', 'type' => 'string', 'example' => 'agent'],
'UpdateTime' => ['description' => '最后一次更新时间。', 'type' => 'string', 'example' => '2020-07-05 00:00:00.0'],
'CallTagList' => [
'description' => '号码标签列表。',
'type' => 'array',
'items' => [
'description' => '号码标签信息。',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'TagName' => ['description' => '号码标签名称。', 'type' => 'string', 'example' => 'TagA'],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
500 => [
['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'],
],
],
'staticInfo' => [
'substitutions' => ['CCC::2020-07-01::ListCustomCallTaggings'],
],
'title' => '获取呼入号码标记列表',
'changeSet' => [
['createdAt' => '2024-01-29T09:14:13.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-02-24T14:31:19.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomCallTagging'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Number\\": \\"1312121****\\",\\n \\"Description\\": \\"王先生\\",\\n \\"Creator\\": \\"agent\\",\\n \\"UpdateTime\\": \\"2020-07-05 00:00:00.0\\",\\n \\"CallTagList\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TagName\\": \\"TagA\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message>无</Message>\\n<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Description>TagA</Description>\\n <Number>083xxxx0011</Number>\\n <InstanceId>ccc-test</InstanceId>\\n <UpdateTime>2020-07-05 00:00:00.0</UpdateTime>\\n <Creator>user-test</Creator>\\n <CallTagList>\\n <TagName>TagA</TagName>\\n <InstanceId>ccc-test</InstanceId>\\n </CallTagList>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListDevices' => [
'summary' => '获取指定实例下指定坐席的设备列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '设备列表。',
'type' => 'array',
'items' => [
'description' => '设备信息。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'Expires' => ['description' => '设备注册过期时间,格式为Unix时间戳,单位毫秒,如果设备过期未重新注册,则会导致设备离线。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609118499750'],
'Contact' => ['description' => '设备地址信息。', 'type' => 'string', 'example' => 'sip:8032****@33.89.XX.XX:64189;transport=tcp;registering_acc=18_134_23_4'],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'CallId' => ['description' => '设备发起的注册信令中的Call ID。', 'type' => 'string', 'example' => 'd7b818c3-8d3a-732f-bc9e-1782wa16****'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'DeviceType' => ['description' => '设备类型', 'type' => 'string', 'example' => 'CHAT'],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
403 => [
['errorCode' => 'Permission.User', 'errorMessage' => 'You have no permission to access user(s) %s.', 'description' => '您无权访问这些用户。'],
],
[
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取设备列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-06T05:44:49.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDevices'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": [\\n {\\n \\"Extension\\": \\"8032****\\",\\n \\"Expires\\": 1609118499750,\\n \\"Contact\\": \\"sip:8032****@33.89.XX.XX:64189;transport=tcp;registering_acc=18_134_23_4\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"CallId\\": \\"d7b818c3-8d3a-732f-bc9e-1782wa16****\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"DeviceType\\": \\"CHAT\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <Extension>80326034</Extension>\\n <InstanceId>ccc-test</InstanceId>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>BS-2020-09-01-11:11:11.888-192_168_12_123</DeviceId>\\n <CallId>561d53be3fa11c4700a40ce8592ef880@0:0:0:0:0:0:0:0</CallId>\\n <Expires>1609118499750</Expires>\\n <Contact>sip:80326034@33.89.9.338:64189;transport=tcp;registering_acc=18_134_23_4</Contact>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListDoNotCallNumbers' => [
'summary' => '获取指定实例下指定搜索条件过滤后的禁止外呼号码列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SearchPattern',
'in' => 'query',
'schema' => ['description' => '根据电话号码或备注进行模糊匹配,非必填,默认为空,为空表示不过滤。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RemarkA'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'Scope',
'in' => 'query',
'schema' => [
'description' => '应用范围,包括SYSTEM和INSTANCE,分别对应系统级禁止外呼和客户自定义禁止外呼,SYSTEM是关联实例所属的阿里云主账号的,INSTANCE只和当前实例关联,非必填,默认值INSTANCE。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['SYSTEM' => '系统级禁止外呼配置', 'INSTANCE' => '实例级禁止外呼配置'],
'example' => 'INSTANCE',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'List' => [
'description' => '禁止外呼号码列表。',
'type' => 'array',
'items' => [
'description' => '禁止外呼号码信息。',
'type' => 'object',
'properties' => [
'Number' => ['description' => '电话号码。', 'type' => 'string', 'example' => '1900000****'],
'Scope' => [
'description' => '应用范围。',
'type' => 'string',
'enumValueTitles' => ['SYSTEM' => '系统级禁止外呼配置', 'INSTANCE' => '实例级禁止外呼配置'],
'example' => 'INSTANCE',
],
'Remark' => ['description' => '备注。', 'type' => 'string', 'example' => '测试'],
'CreateTime' => ['description' => '禁止外呼号码配置的创建时间,格式为Unix时间戳,单位毫秒。(废弃)', 'type' => 'integer', 'format' => 'int64', 'example' => '1626962425000'],
'Creator' => ['description' => '创建人,创建该记录的坐席的坐席登录名。', 'type' => 'string', 'example' => 'agent'],
'CreatedTime' => ['description' => '禁止外呼号码配置的创建时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1631440860000'],
],
],
],
],
],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Number\\": \\"1900000****\\",\\n \\"Scope\\": \\"INSTANCE\\",\\n \\"Remark\\": \\"测试\\",\\n \\"CreateTime\\": 1626962425000,\\n \\"Creator\\": \\"agent\\",\\n \\"CreatedTime\\": 1631440860000\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Scope>INSTANCE</Scope>\\n <Number>190xxxx0000</Number>\\n <CreateTime>1626962425000</CreateTime>\\n <Creator>user-test</Creator>\\n <Remark>RemarkA</Remark>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
'title' => '获取禁止外呼号码列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'ramActions' => [],
],
'ListDocuments' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'parameters' => [
[
'name' => 'SchemaId',
'in' => 'formData',
'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'],
],
[
'name' => 'SearchPattern',
'in' => 'formData',
'schema' => ['description' => '搜索条件表达式', 'type' => 'string', 'required' => false, 'example' => '支持Lucene搜索语法'],
],
[
'name' => 'Sorts',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '自定义排序值',
'type' => 'array',
'items' => [
'description' => '自定义排序值',
'type' => 'object',
'properties' => [
'PropertyName' => ['description' => '字段名', 'type' => 'string', 'required' => false, 'example' => 'name'],
'Order' => ['description' => '排序顺序。取值:'."\n"
."\n"
.'- ASC(默认值):升序。'."\n"
.'- DESC:降序。', 'type' => 'string', 'required' => false, 'example' => 'desc'],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'NextPageToken',
'in' => 'formData',
'schema' => ['description' => '下一个分页token', 'type' => 'string', 'required' => false, 'example' => 'eyJ0YWJsZUlkIjoiY2Y2MTQxYjA5NDY0NDUxMzk5YjFjMTA5YTMxZWNkMzEiLCJ0b2tlbiI6IjAwMDAwMDAwMDAwNzAzNzcifQ=='],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
'name' => 'RequestId',
'in' => 'formData',
'schema' => ['description' => '请求ID', 'type' => 'string', 'required' => false, 'example' => 'EAF3C248-E123-441B-A545-B6CD02E98EED'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListDocumentsResponse',
'description' => 'ListDocumentsResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'Schema' => [
'description' => 'scheme',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => '87b12784-8ce2-40b6-b21f-c49cb3b5501e'],
'Id' => ['description' => 'schame id', 'type' => 'string', 'example' => 'profile'],
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => '-'],
'Properties' => [
'description' => '字段列表',
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'DisplayName' => ['type' => 'string', 'description' => '字段名称', 'example' => 'name'],
'Description' => ['type' => 'string', 'example' => '-', 'description' => '描述'],
'Name' => ['type' => 'string', 'description' => '名称', 'example' => 'name'],
'DataType' => ['type' => 'string', 'example' => 'string', 'description' => '数据类型'],
'Pattern' => ['type' => 'string', 'example' => '*', 'description' => '正则表达式'],
'PatternErrorMessage' => ['type' => 'string', 'example' => '格式错误', 'description' => '正则表达式错误提示'],
'MinLength' => ['type' => 'integer', 'format' => 'int32', 'description' => '最小长度', 'example' => '1'],
'MaxLength' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '最大长度'],
'Minimum' => ['type' => 'number', 'format' => 'double', 'description' => '最小值', 'example' => '1'],
'Maximum' => ['type' => 'number', 'format' => 'double', 'description' => '最大值', 'example' => '1'],
'Required' => ['type' => 'boolean', 'description' => '是否必填', 'example' => 'false'],
'System' => ['type' => 'boolean', 'example' => 'false', 'description' => '是否系统字段'],
'Disabled' => ['type' => 'boolean', 'example' => 'false', 'description' => '是否禁用'],
'Array' => ['type' => 'boolean', 'description' => '是否是数组', 'example' => 'false'],
'ReadOnly' => ['type' => 'boolean', 'description' => '是否只读', 'example' => 'false'],
'EditorType' => ['type' => 'string', 'example' => 'textbox', 'description' => '编辑器类型'],
'Attributes' => ['type' => 'string', 'description' => '扩展属性', 'example' => '{}'],
'DisplayOrder' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '显示顺序'],
'CreatedTime' => ['type' => 'integer', 'format' => 'int64', 'example' => '2020-10-14T09:53:53Z', 'description' => '创建时间'],
'UpdatedTime' => ['type' => 'integer', 'format' => 'int64', 'example' => '2020-10-14T09:53:53Z', 'description' => '更新时间'],
'Creator' => ['type' => 'string', 'description' => '创建者', 'example' => 'tom'],
],
'description' => '字段',
],
],
'CreatedTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2020-10-14T09:53:53Z'],
'UpdatedTime' => ['description' => '更新时间', 'type' => 'string', 'example' => '2020-10-14T09:53:53Z'."\n"],
'Deleted' => ['description' => '是否被删除', 'type' => 'boolean', 'example' => 'false'],
],
],
'Documents' => [
'description' => '文档列表',
'type' => 'array',
'items' => ['description' => '文档内容', 'type' => 'object', 'example' => '{}'],
],
'TotalCount' => ['description' => '总条目数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'NextPageToken' => ['description' => '下一页标识。', 'type' => 'string', 'example' => '54d1a616d95a4a01ba58967a9115b649'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'],
'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Schema\\": {\\n \\"InstanceId\\": \\"87b12784-8ce2-40b6-b21f-c49cb3b5501e\\",\\n \\"Id\\": \\"profile\\",\\n \\"Description\\": \\"-\\",\\n \\"Properties\\": {\\n \\"key\\": {\\n \\"DisplayName\\": \\"name\\",\\n \\"Description\\": \\"-\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"string\\",\\n \\"Pattern\\": \\"*\\",\\n \\"PatternErrorMessage\\": \\"格式错误\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 1,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 1,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 0,\\n \\"UpdatedTime\\": 0,\\n \\"Creator\\": \\"tom\\"\\n }\\n },\\n \\"CreatedTime\\": \\"2020-10-14T09:53:53Z\\",\\n \\"UpdatedTime\\": \\"2020-10-14T09:53:53Z\\\\n\\",\\n \\"Deleted\\": false\\n },\\n \\"Documents\\": [\\n {}\\n ],\\n \\"TotalCount\\": 1,\\n \\"NextPageToken\\": \\"54d1a616d95a4a01ba58967a9115b649\\"\\n },\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '获取文档列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ListFeedbacks' => [
'summary' => '查询反馈记录。',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => false, 'example' => 'ccc-test'."\n"],
],
[
'name' => 'TaskIdList',
'in' => 'query',
'schema' => ['description' => '任务ID列表', 'type' => 'string', 'required' => false, 'example' => '["20251216-8B9B7B02-16FE-54BE-942A-F59DE0656032"]'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '26E54929-CA86-1035-9B42-0C8F291BB027'],
'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => [
'description' => '返回的数据集合',
'type' => 'array',
'items' => [
'description' => '返回的数据元素',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '20251216-8B9B7B02-16FE-54BE-942A-F59DE0656032'],
'TaskName' => ['description' => '任务名称。', 'type' => 'string', 'example' => 'PostCallAnalyzer:solution'],
'UserResponse' => ['description' => '用户反馈的数据', 'type' => 'string', 'example' => 'xxxxxxx'],
'UserRating' => ['description' => '用户对此任务的评分', 'type' => 'integer', 'format' => 'int32', 'example' => '-1'],
'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-25920271311543****'],
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExist.Instance', 'errorMessage' => 'Call center instance %s does not exist.', 'description' => '云联络中心实例%s不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"26E54929-CA86-1035-9B42-0C8F291BB027\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TaskId\\": \\"20251216-8B9B7B02-16FE-54BE-942A-F59DE0656032\\",\\n \\"TaskName\\": \\"PostCallAnalyzer:solution\\",\\n \\"UserResponse\\": \\"xxxxxxx\\",\\n \\"UserRating\\": -1,\\n \\"ContactId\\": \\"job-25920271311543****\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询反馈记录',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ListFlashSmsApplications' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'ProviderId',
'in' => 'query',
'schema' => ['description' => '闪信供应商ID。', 'type' => 'string', 'required' => false, 'example' => 'Uincall'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '闪信配置名称。', 'type' => 'string', 'required' => false, 'example' => '闪信'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '云联络中心实例ID', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListFlashSmsMetadataResponse',
'description' => 'ListFlashSmsApplicationResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'List' => [
'description' => '闪信配置列表。',
'type' => 'array',
'items' => [
'description' => '闪信配置。',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'ProviderId' => ['description' => '闪信供应商ID。', 'type' => 'string', 'example' => 'Uincall'],
'ApplicationId' => ['description' => '注册ID。', 'type' => 'string', 'example' => '71b396fa-***********-bd80e070b7c0'],
'Name' => ['description' => '配置名称。', 'type' => 'string', 'example' => '闪信配置'],
'Value' => ['description' => '配置内容。', 'type' => 'string', 'example' => '{"user":"600******_dev","pwd":"85abf3**********f494e","account":"6004******"}'],
],
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ProviderId\\": \\"Uincall\\",\\n \\"ApplicationId\\": \\"71b396fa-***********-bd80e070b7c0\\",\\n \\"Name\\": \\"闪信配置\\",\\n \\"Value\\": \\"{\\\\\\"user\\\\\\":\\\\\\"600******_dev\\\\\\",\\\\\\"pwd\\\\\\":\\\\\\"85abf3**********f494e\\\\\\",\\\\\\"account\\\\\\":\\\\\\"6004******\\\\\\"}\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '获取闪信配置信息',
'summary' => '使用ListFlashSmsApplication获取第三方闪信配置信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ListFlashSmsSettings' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'SkillGroupName',
'in' => 'query',
'schema' => ['description' => '技能组名称。', 'type' => 'string', 'required' => false, 'example' => '闪信测试技能组'],
],
[
'name' => 'SkillGroupIdList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '坐席所属技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID列表。', 'type' => 'string', 'required' => false, 'example' => '["skillgroup1@ccc-test"]'],
'required' => false,
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListFlashSmsSettingsResponse',
'description' => 'ListFlashSmsSettingsResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总数。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageNumber' => ['description' => '分页序号。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'List' => [
'description' => '配置列表。',
'type' => 'array',
'items' => [
'description' => '配置。',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
'Enabled' => ['description' => '该技能组闪信是否处于启用状态。'."\n"
."\n"
.'- **true**:启用状态。'."\n"
."\n"
.'- **false**:停用状态。', 'type' => 'boolean', 'example' => 'true'],
'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => '闪信测试技能组'],
],
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup1@ccc-test\\",\\n \\"Enabled\\": true,\\n \\"SkillGroupName\\": \\"闪信测试技能组\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '获取闪信坐技能组配置',
'summary' => '使用ListFlashSmsSettings接口获取指定技能组闪信相关配置。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ListFlashSmsTemplates' => [
'summary' => '使用ListFlashSmsTemplates获取闪信模板信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccIPHVDY'],
],
'parameters' => [
[
'name' => 'ProviderId',
'in' => 'query',
'schema' => ['description' => '闪信供应商ID。', 'type' => 'string', 'required' => false, 'example' => 'Uincall'],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => '闪信配置ID。', 'type' => 'string', 'required' => false, 'example' => '71b396fa-1*********-70b7c0'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListFlashSmsTemplatesResponse',
'description' => 'ListFlashSmsTemplatesResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '数据。',
'type' => 'array',
'items' => [
'description' => '闪信模板',
'type' => 'object',
'properties' => [
'TemplateId' => ['description' => '模板ID。', 'type' => 'string', 'example' => '1715*****38'],
'TemplateName' => ['description' => '模板名称。', 'type' => 'string', 'example' => '测试模板'],
'TemplateDetails' => ['type' => 'string', 'description' => ''],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"TemplateId\\": \\"1715*****38\\",\\n \\"TemplateName\\": \\"测试模板\\",\\n \\"TemplateDetails\\": \\"\\"\\n }\\n ],\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '获取闪信模板信息',
'changeSet' => [
['createdAt' => '2025-07-02T08:46:22.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ListGroupChatMessages' => [
'summary' => '查询Chat消息记录。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '话务ID。', 'type' => 'string', 'required' => false, 'example' => 'chat-65382141036853491'],
],
[
'name' => 'SortOrder',
'in' => 'query',
'schema' => ['description' => '排序方式,默认为降序。'."\n"
."\n"
.'枚举值:'."\n"
."\n"
.'ASC:升序。'."\n"
."\n"
.'DESC:降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '云联络中心实例。', 'type' => 'string', 'required' => false, 'example' => 'ccc-test'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'NextPageToken',
'in' => 'query',
'schema' => ['description' => '下一页标识,32位UUID。请求第一页时,NextPageToken为空;请求后续文件时需传入前一页查询结果中的NextPageToken值。', 'type' => 'string', 'required' => false, 'example' => 'b2ad450b116e4f8396e58108acf5c020'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780'],
'HttpStatusCode' => ['description' => 'HTTP请求返回的响应状态码,200表示请求成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'Messages' => [
'description' => '消息列表。',
'type' => 'array',
'items' => [
'description' => '消息体。',
'type' => 'object',
'properties' => [
'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'chat-65382141036853491'],
'SenderId' => ['description' => '消息发送者用户ID。', 'type' => 'string', 'example' => '64bb4ececc34fc5ec1ca1153'],
'SenderType' => ['description' => '发送方类型。'."\n"
."\n"
.'枚举值'."\n"
.'- **ADMIN**:系统'."\n"
.'- **CUSTOMER**:访客'."\n"
.'- **AGENT**:坐席', 'type' => 'string', 'example' => 'CUSTOMER'],
'Timestamp' => ['description' => '消息时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1696126980371'],
'Content' => ['description' => '内容信息。', 'type' => 'string', 'example' => '{"variables":{},"text":"<p>好的,不客气</p>","contentType":"Text","subContentType":"richtext"}'],
'SenderName' => ['description' => '发送者名称。', 'type' => 'string', 'example' => 'test-agent@test-instanceId'],
'SenderAvatarUrl' => ['description' => '发送者头像地址。', 'type' => 'string', 'example' => 'http://xxxxx.com'],
'Recalled' => ['description' => '是否被撤回。', 'type' => 'boolean', 'example' => 'false'],
],
],
],
'NextPageToken' => ['description' => '下一页标识。', 'type' => 'string', 'example' => '54d1a616d95a4a01ba58967a9115b649'],
],
],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Permission.Unauthorized', 'errorMessage' => 'You are not authorized to perform this action. %s privileges are required.', 'description' => '您无权执行此操作。 必须具有指定权限。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2263B273-AC1B-44EB-BA98-87F2322C6780\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Messages\\": [\\n {\\n \\"JobId\\": \\"chat-65382141036853491\\",\\n \\"SenderId\\": \\"64bb4ececc34fc5ec1ca1153\\",\\n \\"SenderType\\": \\"CUSTOMER\\",\\n \\"Timestamp\\": 1696126980371,\\n \\"Content\\": \\"{\\\\\\"variables\\\\\\":{},\\\\\\"text\\\\\\":\\\\\\"<p>好的,不客气</p>\\\\\\",\\\\\\"contentType\\\\\\":\\\\\\"Text\\\\\\",\\\\\\"subContentType\\\\\\":\\\\\\"richtext\\\\\\"}\\",\\n \\"SenderName\\": \\"test-agent@test-instanceId\\",\\n \\"SenderAvatarUrl\\": \\"http://xxxxx.com\\",\\n \\"Recalled\\": false\\n }\\n ],\\n \\"NextPageToken\\": \\"54d1a616d95a4a01ba58967a9115b649\\"\\n }\\n}","type":"json"}]',
'title' => '查询消息列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ListHistoricalAgentReport' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '100'],
],
[
'name' => 'AgentIdList',
'in' => 'formData',
'schema' => ['description' => '坐席ID列表,范围0-100 。'."\n"
."\n"
.'> 如果坐席ID列表不为空,则直接按照坐席ID列表进行查询,此时pageSize和pageNumber参数无效,数据直接返回,如:请求参数:pageNumber = 3 则响应参数中pageNumber = 3 。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["agent1@ccc-test", "agent2@ccc-test"]'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '获取的历史数据的起始时间,默认为当天的0时,最早为当前时间往前180天。统计的时间精度为小时,向前取整,闭区间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532448000000'],
],
[
'name' => 'StopTime',
'in' => 'query',
'schema' => ['description' => '获取的历史数据的终止时间,默认为当前时间。统计的时间精度为小时,向后取整,开区间。例如:开始时间为 11:12:20,结束时间为 11:45:50,则对齐后的入参时间范围为 [11:00:00, 12:00:00) ,即大于等于11点,小于12点,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532707199000'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'MediaType',
'in' => 'query',
'schema' => ['description' => '媒体类型,默认是语音(Audio), 其他可选参数包括Chat和Video.', 'type' => 'string', 'required' => false, 'example' => 'VIDEO'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => false, 'example' => 'wwtest@test_yunhu'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'List' => [
'description' => '坐席历史数据列表。',
'type' => 'array',
'items' => [
'description' => '坐席历史数据。',
'type' => 'object',
'properties' => [
'AgentName' => ['description' => '坐席姓名。', 'type' => 'string', 'example' => '坐席小王'],
'AgentId' => ['description' => '座席ID。', 'type' => 'string', 'example' => 'agent1@ccc-test'],
'DisplayId' => ['description' => '坐席工号。', 'type' => 'string', 'example' => '001'],
'Inbound' => [
'description' => '呼入数据。',
'type' => 'object',
'properties' => [
'AverageRingTime' => ['description' => '平均振铃时长,计算公式为:TotalRingTime/CallsRinged,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsHandled' => ['description' => '应答量,即坐席应答的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAttendedTransferOut' => ['description' => '咨询转出量。若一通电话多次转出给其他坐席,每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalHoldTime' => ['description' => '总通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,计算公式为:TotalWorkTime/CallsHandled,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsBlindTransferIn' => ['description' => '直接转入量,若一通电话多次转入给该坐席,每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsRinged' => ['description' => '坐席振铃的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAttendedTransferIn' => ['description' => '咨询转入量,若一通电话多次转入给该坐席,每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsBlindTransferOut' => ['description' => '直接转出量,若一通电话多次转出给其他坐席,每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsOffered' => ['description' => '分配量,即分配给此坐席的电话次数,包括其他坐席盲转和咨询转给此坐席的电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,计算公式为:TotalTalkTime/CallsHandled,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsHold' => ['description' => '保持量,即发生通话保持的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'HandleRate' => ['description' => '应答率。计算公式为:CallsHandled/CallsOffered(由于应答事件与分配事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageHoldTime' => ['description' => '平均通话保持时长,计算公式为:TotalHoldTime/CallsHold,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AccessChannelTypeDetails' => [
'description' => '各渠道的统计数据。',
'type' => 'array',
'items' => [
'description' => '渠道的统计数据。',
'type' => 'object',
'properties' => [
'AccessChannelType' => ['description' => '渠道类型。', 'type' => 'string', 'example' => 'Web'],
'CallsOffered' => ['description' => '分配的会话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
],
],
],
'AverageFirstResponseTime' => ['description' => 'Chat会话平均首次响应时长,单位为秒。', 'type' => 'number', 'format' => 'float', 'example' => '10'],
'AverageResponseTime' => ['description' => 'Chat会话平均响应时长。', 'type' => 'number', 'format' => 'float', 'example' => '12'],
'ServiceLevel15' => ['description' => '15秒服务水平。', 'type' => 'number', 'format' => 'float', 'example' => '0.85'],
'TotalMessagesSent' => ['description' => 'Chat会话中总消息发送量。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'],
'TotalMessagesSentByAgent' => ['description' => 'Chat会话中坐席发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
'TotalMessagesSentByCustomer' => ['description' => 'Chat会话中客户发送的总消息量。', 'type' => 'string', 'example' => '9'],
],
],
'Outbound' => [
'description' => '呼出数据。',
'type' => 'object',
'properties' => [
'AverageRingTime' => ['description' => '平均振铃时长,计算公式为: TotalRingTime/CallsRinged,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAttendedTransferOut' => ['description' => '咨询转出量,若一通电话多次转出给其他坐席,每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalDialingTime' => ['description' => '总拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalHoldTime' => ['description' => '总通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,计算公式为:TotalWorkTime/CallsDialed,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsBlindTransferIn' => ['description' => '直接转入量,若一通电话多次转入给该坐席,每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsRinged' => ['description' => '坐席振铃的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAttendedTransferIn' => ['description' => '咨询转入量,若一通电话多次转入给该坐席,每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsBlindTransferOut' => ['description' => '直接转出量,若一通电话多次转出给其他坐席,每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxDialingTime' => ['description' => '最大拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AnswerRate' => ['description' => '接通率,计算公式为:CallsAnswered/CallsDialed(由于接听事件与应答事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,计算公式为:TotalTalkTime/CallsAnswered,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsHold' => ['description' => '保持量,即发生通话保持的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageHoldTime' => ['description' => '平均通话保持时长,计算公式为:TotalHoldTime/CallsHold,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageDialingTime' => ['description' => '平均拨号时长,计算公式为:TotalDialingTime/CallsDialed,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
],
],
'Overall' => [
'description' => '整体数据。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalLoggedInTime' => ['description' => '总登录时长,不包含小休时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'OccupancyRate' => ['description' => '座席利用率,计算公式为:(TotalworkTime+TotalTalkTime)/TotalLoggedInTime。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageBreakTime' => ['description' => '平均小休时长,计算公式为:TotalBreakTime/小休次数,小休次数为非接口统计字段,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalHoldTime' => ['description' => '总保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'MaxBreakTime' => ['description' => '最大小休时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,计算公式为:TotalWorkTime/TotalCalls,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,计算公式为:TotalTalkTime/(CallsAnswered+CallsHandled),单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxReadyTime' => ['description' => '最大就绪时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageReadyTime' => ['description' => '平均就绪时长,计算公式为:TotalReadyTime/就绪次数。就绪次数为非接口统计字段,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/(呼入CallsHold+呼出CallsHold)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalReadyTime' => ['description' => '总就绪时长,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalBreakTime' => ['description' => '总小休时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalCalls' => ['description' => '总电话量,计算公式为:CallsOffered+CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalOnSiteOnlineTime' => ['description' => '总场内在线时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用,请使用TotalOnSiteLoggedInTime代替此参数'],
'TotalOffSiteOnlineTime' => ['description' => '总场外在线时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用,请使用TotalOffSiteLoggedInTime代替此参数'],
'TotalOfficePhoneOnlineTime' => ['description' => '总办公电话模式在线时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用,请使用TotalOfficePhoneLoggedInTime代替此参数'],
'BreakCodeDetailList' => [
'description' => '各类型小休统计数据。',
'type' => 'array',
'items' => [
'description' => '小休统计数据',
'type' => 'object',
'properties' => [
'BreakCode' => ['description' => '小休类型代码。', 'type' => 'string', 'example' => '会议'],
'Count' => ['description' => '此类型小休的发生次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Duration' => ['description' => '此类型小休的总计发生时长,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'],
],
],
],
'FirstCheckInTime' => ['description' => '最早签入时间,格式是unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1686030515000'],
'LastCheckOutTime' => ['description' => '最后签出时间,格式是unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1686030515000'],
'TotalOutboundScenarioTime' => ['description' => '总仅外呼在线时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用,请使用TotalOutboundScenarioLoggedInTime代替此参数'],
'TotalOutboundScenarioReadyTime' => ['description' => '总仅外呼空闲时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalOfficePhoneLoggedInTime' => ['description' => '总办公电话模式在线时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '3600'],
'TotalOffSiteLoggedInTime' => ['description' => '总场外在线时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalOnSiteLoggedInTime' => ['description' => '总场内在线时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalOutboundScenarioLoggedInTime' => ['description' => '总仅外呼在线时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
],
'SkillGroupIds' => ['description' => '座席所属技能组ID列表,格式为JSON数组的字符串,数组元素为技能组ID。', 'type' => 'string', 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]'],
'SkillGroupNames' => ['description' => '座席所属技能组名称列表,格式为JSON数组的字符串,数组元素是技能组名称。', 'type' => 'string', 'example' => '["测试技能组1","测试技能组2"]'],
'Back2Back' => [
'description' => '双呼指标。',
'type' => 'object',
'properties' => [
'CallsDialed' => ['description' => '拨号量。', 'type' => 'string', 'example' => '100'],
'AnswerRate' => ['description' => '接通率,计算公式为:CallsAnswered/CallsDialed(由于接听事件与应答事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'string', 'example' => '0.6'],
'CallsAnswered' => ['description' => '接通量。', 'type' => 'string', 'example' => '100'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'string', 'example' => '100'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'string', 'example' => '100'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。', 'type' => 'string', 'example' => '100'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'string', 'example' => '100'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'string', 'example' => '100'],
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。', 'type' => 'string', 'example' => '100'],
'TotalCustomerRingTime' => ['description' => '总客户侧振岭时长,单位秒。', 'type' => 'string', 'example' => '100'],
'MaxCustomerRingTime' => ['description' => '最大客户侧振铃时长,单位秒。', 'type' => 'string', 'example' => '100'],
'AverageCustomerRingTime' => ['description' => '平均客户侧振铃时长,单位秒', 'type' => 'string', 'example' => '100'],
'CallsAgentHandled' => ['description' => '坐席接听电话数量。', 'type' => 'string', 'example' => '10'],
'AgentHandleRate' => ['description' => '坐席应答率。', 'type' => 'string', 'example' => '1'],
'CallsCustomerAnswered' => ['description' => '客户接听电话数量。', 'type' => 'string', 'example' => '7'],
'CustomerAnswerRate' => ['description' => '客户接通率。', 'type' => 'string', 'example' => '0.7'],
],
],
'Internal' => [
'description' => '内部呼叫指标。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsOffered' => ['description' => '电话呼入数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsHandled' => ['description' => '电话应答数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsTalked' => ['description' => '参与通话次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
],
'title' => '获取坐席历史数据报表',
'summary' => '调用ListHistoricalAgentReport获取指定实例下的一个或多个坐席的历史数据报表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-22T01:05:25.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2023-05-23T11:59:01.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-07-04T11:50:02.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHistoricalAgentReport'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"AgentId\\": \\"agent1@ccc-test\\",\\n \\"DisplayId\\": \\"001\\",\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AccessChannelTypeDetails\\": [\\n {\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"CallsOffered\\": 3\\n }\\n ],\\n \\"AverageFirstResponseTime\\": 10,\\n \\"AverageResponseTime\\": 12,\\n \\"ServiceLevel15\\": 0.85,\\n \\"TotalMessagesSent\\": 16,\\n \\"TotalMessagesSentByAgent\\": 7,\\n \\"TotalMessagesSentByCustomer\\": \\"9\\"\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 0\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"TotalLoggedInTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 0,\\n \\"TotalOnSiteOnlineTime\\": 0,\\n \\"TotalOffSiteOnlineTime\\": 0,\\n \\"TotalOfficePhoneOnlineTime\\": 0,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"会议\\",\\n \\"Count\\": 3,\\n \\"Duration\\": 120\\n }\\n ],\\n \\"FirstCheckInTime\\": 1686030515000,\\n \\"LastCheckOutTime\\": 1686030515000,\\n \\"TotalOutboundScenarioTime\\": 0,\\n \\"TotalOutboundScenarioReadyTime\\": 100,\\n \\"TotalOfficePhoneLoggedInTime\\": 3600,\\n \\"TotalOffSiteLoggedInTime\\": 100,\\n \\"TotalOnSiteLoggedInTime\\": 100,\\n \\"TotalOutboundScenarioLoggedInTime\\": 100\\n },\\n \\"SkillGroupIds\\": \\"[\\\\\\"skillgroup1@ccc-test\\\\\\",\\\\\\"skillgroup2@ccc-test\\\\\\"]\\",\\n \\"SkillGroupNames\\": \\"[\\\\\\"测试技能组1\\\\\\",\\\\\\"测试技能组2\\\\\\"]\\",\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": \\"100\\",\\n \\"AnswerRate\\": \\"0.6\\",\\n \\"CallsAnswered\\": \\"100\\",\\n \\"TotalTalkTime\\": \\"100\\",\\n \\"MaxTalkTime\\": \\"100\\",\\n \\"AverageTalkTime\\": \\"100\\",\\n \\"TotalRingTime\\": \\"100\\",\\n \\"MaxRingTime\\": \\"100\\",\\n \\"AverageRingTime\\": \\"100\\",\\n \\"TotalCustomerRingTime\\": \\"100\\",\\n \\"MaxCustomerRingTime\\": \\"100\\",\\n \\"AverageCustomerRingTime\\": \\"100\\",\\n \\"CallsAgentHandled\\": \\"10\\",\\n \\"AgentHandleRate\\": \\"1\\",\\n \\"CallsCustomerAnswered\\": \\"7\\",\\n \\"CustomerAnswerRate\\": \\"0.7\\"\\n },\\n \\"Internal\\": {\\n \\"TotalTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"CallsTalked\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>10</TotalCount>\\n <PageSize>100</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <DisplayId>8001xxxx</DisplayId>\\n <AgentId>user-test@ccc-test</AgentId>\\n <AgentName>云呼测试坐席</AgentName>\\n <Inbound>\\n <TotalWorkTime>0</TotalWorkTime>\\n <CallsRinged>0</CallsRinged>\\n <TotalHoldTime>0</TotalHoldTime>\\n <AverageHoldTime>0</AverageHoldTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <CallsOffered>0</CallsOffered>\\n <MaxRingTime>0</MaxRingTime>\\n <CallsHold>0</CallsHold>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHandled>0</CallsHandled>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <TotalRingTime>0</TotalRingTime>\\n <HandleRate>0</HandleRate>\\n <CallsAttendedTransferIn>0</CallsAttendedTransferIn>\\n <TotalTalkTime>0</TotalTalkTime>\\n <AverageRingTime>0</AverageRingTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <CallsBlindTransferOut>0</CallsBlindTransferOut>\\n <AverageWorkTime>0</AverageWorkTime>\\n <CallsAttendedTransferOut>0</CallsAttendedTransferOut>\\n <CallsBlindTransferIn>0</CallsBlindTransferIn>\\n <MaxWorkTime>0</MaxWorkTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n <MaxHoldTime>0</MaxHoldTime>\\n </Inbound>\\n <Outbound>\\n <TotalDialingTime>0</TotalDialingTime>\\n <TotalWorkTime>0</TotalWorkTime>\\n <CallsRinged>0</CallsRinged>\\n <TotalHoldTime>0</TotalHoldTime>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>0</MaxRingTime>\\n <CallsHold>0</CallsHold>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <TotalRingTime>0</TotalRingTime>\\n <AverageDialingTime>0</AverageDialingTime>\\n <CallsAnswered>0</CallsAnswered>\\n <TotalTalkTime>0</TotalTalkTime>\\n <CallsDialed>0</CallsDialed>\\n <MaxDialingTime>0</MaxDialingTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <CallsAttendedTransferOut>0</CallsAttendedTransferOut>\\n <AverageTalkTime>0</AverageTalkTime>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AnswerRate>0</AnswerRate>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <CallsAttendedTransferIn>0</CallsAttendedTransferIn>\\n <AverageRingTime>0</AverageRingTime>\\n <CallsBlindTransferOut>0</CallsBlindTransferOut>\\n <AverageWorkTime>0</AverageWorkTime>\\n <CallsBlindTransferIn>0</CallsBlindTransferIn>\\n <MaxWorkTime>0</MaxWorkTime>\\n </Outbound>\\n <Overall>\\n <TotalReadyTime>0</TotalReadyTime>\\n <TotalCalls>0</TotalCalls>\\n <TotalBreakTime>0</TotalBreakTime>\\n <TotalWorkTime>0</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <AverageHoldTime>0</AverageHoldTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <AverageBreakTime>0</AverageBreakTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <TotalTalkTime>0</TotalTalkTime>\\n <AverageReadyTime>0</AverageReadyTime>\\n <TotalLoggedInTime>0</TotalLoggedInTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <MaxReadyTime>0</MaxReadyTime>\\n <AverageWorkTime>0</AverageWorkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <MaxBreakTime>0</MaxBreakTime>\\n <MaxWorkTime>0</MaxWorkTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n <MaxHoldTime>0</MaxHoldTime>\\n <OccupancyRate>0</OccupancyRate>\\n </Overall>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListHistoricalAgentSkillGroupReport' => [
'summary' => '调用ListHistoricalAgentSkillGroupReport获取指定实例下的一个或多个坐席的历史分组数据报表。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccSI864G'],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'AgentIdList',
'in' => 'formData',
'schema' => ['description' => '坐席ID列表,列表大小0-100。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["agent1@ccc-test", "agent2@ccc-test"]'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间戳,默认为当天的0时。统计的时间精度为小时,向前取整,闭区间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1634140800000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '获取的历史数据的终止时间,格式为Unix时间戳,单位毫秒,非必填,默认为当前时间,统计的时间精度为小时,向后取整,开区间。例如:开始时间为11:12:20,结束时间为11:45:50,则对齐后的入参时间范围为[11:00:00,12:00:00) ,即大于等于11点,小于12点。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1620273600000'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'."\n"],
],
[
'name' => 'SkillGroupIdList',
'in' => 'query',
'schema' => ['description' => '技能组ID列表,列表大小0-100。', 'type' => 'string', 'required' => false, 'example' => '['."\n"
.' "skg1@ccc-test",'."\n"
.' "skg2@ccc-test"'."\n"
.']'],
],
[
'name' => 'MediaType',
'in' => 'query',
'schema' => ['description' => '媒体类型,默认是语音(Audio), 其他可选参数包括Chat和Video.', 'type' => 'string', 'required' => false, 'example' => 'VIDEO'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'Data' => [
'description' => '分组坐席历史数据列表。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数,只有PageNumber为1时才有数据,其他情况都是0。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'],
'List' => [
'description' => '分组坐席历史数据列表。',
'type' => 'array',
'items' => [
'description' => '分组坐席历史数据。',
'type' => 'object',
'properties' => [
'AgentName' => ['description' => '坐席姓名。', 'type' => 'string', 'example' => '云呼测试坐席'],
'AgentId' => ['description' => '座席ID。', 'type' => 'string', 'example' => 'agent1@ccc-test'],
'DisplayId' => ['description' => '坐席的工号。', 'type' => 'string', 'example' => '1001'],
'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'Default'],
'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
'Inbound' => [
'description' => '呼入指标。',
'type' => 'object',
'properties' => [
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。计算公式为: TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'CallsHandled' => ['description' => '应答量,即坐席应答的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsAttendedTransferOut' => ['description' => '咨询转出量。若一通电话多次转出给其他坐席,每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalHoldTime' => ['description' => '总通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为: TotalWorkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'CallsBlindTransferIn' => ['description' => '直接转入量。若一通电话多次转入给该坐席,每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'CallsRinged' => ['description' => '坐席振铃的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsAttendedTransferIn' => ['description' => '咨询转入量。若一通电话多次转入给该坐席,每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsBlindTransferOut' => ['description' => '直接转出量。若一通电话多次转出给其他坐席,每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsOffered' => ['description' => '分配量,即分配给此坐席的电话次数, 包括其他坐席盲转和咨询转给此坐席的电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为: TotalTalkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'],
'CallsHold' => ['description' => '保持量,即发生通话保持的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'HandleRate' => ['description' => '应答率。计算公式为:CallsHandled/CallsOffered(由于应答事件与分配事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'TotalMessagesSent' => ['description' => 'Chat会话中总消息发送量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'TotalMessagesSentByAgent' => ['description' => 'Chat会话中坐席发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'],
'TotalMessagesSentByCustomer' => ['description' => 'Chat会话中客户发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'],
'AverageFirstResponseTime' => ['description' => 'Chat会话平均首次响应时长,单位为秒。', 'type' => 'number', 'format' => 'float', 'example' => '8'],
'AverageResponseTime' => ['description' => 'Chat会话平均响应时长。', 'type' => 'number', 'format' => 'float', 'example' => '9'],
],
],
'Outbound' => [
'description' => '呼出指标。',
'type' => 'object',
'properties' => [
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsAttendedTransferOut' => ['description' => '咨询转出量。若一通电话多次转出给其他坐席,每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalDialingTime' => ['description' => '总拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalHoldTime' => ['description' => '总通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为:TotalWorkTime/CallsDialed', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'CallsBlindTransferIn' => ['description' => '直接转入量。若一通电话多次转入给该坐席,每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '1.4'],
'CallsRinged' => ['description' => '坐席振铃的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsAttendedTransferIn' => ['description' => '咨询转入量。若一通电话多次转入给该坐席,每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsBlindTransferOut' => ['description' => '直接转出量。若一通电话多次转出给其他坐席,每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxDialingTime' => ['description' => '最大拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AnswerRate' => ['description' => '接通率,计算公式为:CallsAnswered/CallsDialed(由于接听事件与应答事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为:TotalTalkTime/CallsAnswered。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'],
'CallsHold' => ['description' => '保持量,即发生通话保持的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'AverageDialingTime' => ['description' => '平均拨号时长,单位秒。计算公式为:TotalDialingTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
],
],
'Overall' => [
'description' => '整体指标。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalLoggedInTime' => ['description' => '总登录时长,单位秒。'."\n"
.'_注意:不含离线和小休时长_', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'OccupancyRate' => ['description' => '座席利用率。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageBreakTime' => ['description' => '平均小休时长,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'TotalHoldTime' => ['description' => '总保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'],
'MaxBreakTime' => ['description' => '最大小休时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为:TotalWorkTime/TotalCalls。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为: TotalTalkTime/(CallsAnswered+CallsHandled)。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '1.4'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxReadyTime' => ['description' => '最大就绪时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageReadyTime' => ['description' => '平均就绪时长,单位秒。计算公式为:TotalReadyTime/就绪次数。就绪次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/(呼入CallsHold+呼出CallsHold)。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'TotalReadyTime' => ['description' => '总就绪时长,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalBreakTime' => ['description' => '总小休时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalCalls' => ['description' => '总电话量。计算公式为:CallsOffered + CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'BreakCodeDetailList' => [
'description' => '小休详情列表。',
'type' => 'array',
'items' => [
'description' => '小休详情。',
'type' => 'object',
'properties' => [
'BreakCode' => ['description' => '小休码。', 'type' => 'string', 'example' => '开会'],
'Count' => ['description' => '次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Duration' => ['description' => '时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
],
],
'FirstCheckInTime' => ['description' => '最早签入时间,格式是unix时间戳,单位到毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1686030515000'],
'LastCheckOutTime' => ['description' => '最后签出时间,格式是unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1686030515000'],
'TotalOutboundScenarioTime' => ['description' => '总仅外呼在线时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalOutboundScenarioReadyTime' => ['description' => '总仅外呼空闲时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalOutboundScenarioLoggedInTime' => ['description' => '总仅外呼在线时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'],
'TotalOfficePhoneLoggedInTime' => ['description' => '总办公电话在线时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'],
'TotalOffSiteLggedInTime' => ['description' => '总场外在线时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'],
'TotalOnSiteLoggedInTime' => ['description' => '总场内在线时长,单位秒。', 'type' => 'string', 'example' => '120'],
],
],
'Internal' => [
'description' => '内部呼叫指标。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsOffered' => ['description' => '电话呼入数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsHandled' => ['description' => '电话应答数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsTalk' => ['description' => '坐席参与的通话次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsTalked' => ['description' => '参与通话次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
],
],
'Back2Back' => [
'description' => '双呼指标。',
'type' => 'object',
'properties' => [
'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AnswerRate' => ['description' => '接通率,计算公式为:CallsAnswered/CallsDialed(由于接听事件与应答事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0.6'],
'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AgentAnswerRate' => ['description' => '坐席侧应答率。', 'type' => 'number', 'format' => 'float', 'example' => '已弃用,请使用AgentHandleRate代替此参数'],
'CallsCustomerHandled' => ['description' => '客户侧接起次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用,请使用CallsCustomerAnswered代替此参数'],
'CustomerHandleRate' => ['description' => '客户侧接起率。', 'type' => 'number', 'format' => 'float', 'example' => '已弃用,请使用CustomerAnswerRate代替此参数'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'TotalCustomerRingTime' => ['description' => '总客户侧振岭时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxCustomerRingTime' => ['description' => '最大客户侧振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageCustomerRingTime' => ['description' => '平均客户侧振铃时长,单位秒', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'AgentHandleRate' => ['description' => '坐席应答率。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'],
'CallsCustomerAnswered' => ['description' => '客户接听电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CustomerAnswerRate' => ['description' => '客户接通率。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'],
'CallsAgentHandled' => ['description' => '坐席接听电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取分组坐席历史数据报表',
'changeSet' => [
['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHistoricalAgentSkillGroupReport'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"AgentName\\": \\"云呼测试坐席\\",\\n \\"AgentId\\": \\"agent1@ccc-test\\",\\n \\"DisplayId\\": \\"1001\\",\\n \\"SkillGroupName\\": \\"Default\\",\\n \\"SkillGroupId\\": \\"skillgroup1@ccc-test\\",\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"TotalWorkTime\\": 100,\\n \\"CallsAttendedTransferOut\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"CallsBlindTransferIn\\": 100,\\n \\"SatisfactionIndex\\": 100,\\n \\"CallsRinged\\": 100,\\n \\"CallsAttendedTransferIn\\": 100,\\n \\"CallsBlindTransferOut\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 0.5,\\n \\"CallsHold\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"HandleRate\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 6,\\n \\"TotalMessagesSentByCustomer\\": 6,\\n \\"AverageFirstResponseTime\\": 8,\\n \\"AverageResponseTime\\": 9\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"TotalWorkTime\\": 100,\\n \\"CallsAttendedTransferOut\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalDialingTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"CallsBlindTransferIn\\": 100,\\n \\"SatisfactionIndex\\": 1.4,\\n \\"CallsRinged\\": 100,\\n \\"CallsAttendedTransferIn\\": 100,\\n \\"CallsBlindTransferOut\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxDialingTime\\": 100,\\n \\"AnswerRate\\": 0.5,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 0.5,\\n \\"CallsHold\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"AverageDialingTime\\": 100\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 100,\\n \\"TotalLoggedInTime\\": 100,\\n \\"OccupancyRate\\": 0.5,\\n \\"TotalWorkTime\\": 100,\\n \\"MaxHoldTime\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"AverageBreakTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"SatisfactionRate\\": 0.5,\\n \\"MaxBreakTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionIndex\\": 1.4,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"MaxReadyTime\\": 100,\\n \\"AverageReadyTime\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"TotalReadyTime\\": 100,\\n \\"TotalBreakTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"TotalCalls\\": 100,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"开会\\",\\n \\"Count\\": 1,\\n \\"Duration\\": 100\\n }\\n ],\\n \\"FirstCheckInTime\\": 1686030515000,\\n \\"LastCheckOutTime\\": 1686030515000,\\n \\"TotalOutboundScenarioTime\\": 100,\\n \\"TotalOutboundScenarioReadyTime\\": 100,\\n \\"TotalOutboundScenarioLoggedInTime\\": 120,\\n \\"TotalOfficePhoneLoggedInTime\\": 120,\\n \\"TotalOffSiteLggedInTime\\": 120,\\n \\"TotalOnSiteLoggedInTime\\": \\"120\\"\\n },\\n \\"Internal\\": {\\n \\"TotalTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"CallsTalk\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"CallsTalked\\": 5\\n },\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": 100,\\n \\"AnswerRate\\": 0.6,\\n \\"CallsAnswered\\": 100,\\n \\"AgentAnswerRate\\": 0,\\n \\"CallsCustomerHandled\\": 0,\\n \\"CustomerHandleRate\\": 0,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"AgentHandleRate\\": 0.5,\\n \\"CallsCustomerAnswered\\": 100,\\n \\"CustomerAnswerRate\\": 0.5,\\n \\"CallsAgentHandled\\": 100\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListHistoricalSkillGroupReport' => [
'summary' => '调用ListHistoricalSkillGroupReport获取指定实例下的一个或多个技能组的历史数据报表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccOQKOLI'],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '100'],
],
[
'name' => 'SkillGroupIdList',
'in' => 'formData',
'schema' => ['description' => '待查询的技能组ID列表,格式为JSON数组的字符串,数组元素为技能组ID,非必填,默认为空,表示查询当前分页下的所有技能组。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["skillgroup1@ccc-test", "skillgroup2@ccc-test2"]'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '获取的历史数据的起始时间,格式为Unix时间戳,单位毫秒,非必填,默认为当天的0时,最早为当前时间往前180天,统计的时间精度为小时,向前取整,闭区间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532448000000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '获取的历史数据的终止时间,格式为Unix时间戳,单位毫秒,非必填,默认为当前时间,统计的时间精度为小时,向后取整,开区间。例如:开始时间为11:12:20,结束时间为11:45:50,则对齐后的入参时间范围为[11:00:00, 12:00:00) ,即大于等于11点,小于12点。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532707199000'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'MediaType',
'in' => 'query',
'schema' => ['description' => '媒体类型,默认是语音(Audio), 其他可选参数包括Chat和Video.', 'type' => 'string', 'required' => false, 'example' => 'VIDEO'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'List' => [
'description' => '技能组历史数据列表。',
'type' => 'array',
'items' => [
'description' => '技能组历史数据。',
'type' => 'object',
'properties' => [
'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'],
'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Inbound' => [
'description' => '呼入指标。',
'type' => 'object',
'properties' => [
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。计算公式为: TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '5'],
'CallsOverflow' => ['description' => '溢出量,即发生队列(技能组)溢出的电话数量。若一通电话多次进入同一队列,每次溢出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAbandonedInRing' => ['description' => '振铃放弃量,即坐席振铃中客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsHandled' => ['description' => '应答量,即坐席应答的次数。一通电话每次进入队列后,若被多个坐席应答,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '85'],
'TotalAbandonedInRingTime' => ['description' => '总振铃放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'CallsAttendedTransferOut' => ['description' => '咨询转出量,即由该技能组发起的咨询转接到其他技能组的电话数量,同一技能组内坐席间的转接不计数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWaitTime' => ['description' => '平均等待时长,平均每通电话的坐席接起前等待时长。计算公式为:TotalWaitTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '5'],
'TotalHoldTime' => ['description' => '总通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxAbandonTime' => ['description' => '最大放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为: TotalWorkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '13'],
'CallsQueued' => ['description' => '呼入场景进入队列(技能组)的电话数量,若一通电话多次进入同一队列,每次进入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
'CallsBlindTransferIn' => ['description' => '直接转入量,即由其他技能组发起的直接转接到该技能组的电话数量,同一技能组内坐席间的转接不计数。若一个坐席同时签入多个技能组,则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组,每次转接算一次。下同。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageAbandonedInRingTime' => ['description' => '平均振铃放弃时长,单位秒。计算公式为: TotalAbandonedInRingTime/CallsAbandonedInRing。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageAbandonTime' => ['description' => '平均放弃时长,单位秒。计算公式为:TotalAbandonTime/CallsAbandoned。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsRinged' => ['description' => '坐席振铃的电话数量,一通电话每次进入队列后,若分配给多个座席并产生了振铃,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
'CallsBlindTransferOut' => ['description' => '直接转出量,即由该技能组发起的直接转接到其他技能组的电话数量,同一技能组内坐席间的转接不计数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAttendedTransferIn' => ['description' => '咨询转入量,即由其他技能组发起的咨询转接到该技能组的电话数量,同一技能组内坐席间的转接不计数。若一个坐席同时迁入多个技能组,则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组,每次转接算一次。下同。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAbandoned' => ['description' => '放弃量。计算公式为:CallsAbandonedInQueue+CallsAbandonedInRing。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxAbandonedInQueueTime' => ['description' => '最大排队放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalWaitTime' => ['description' => '总等待时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '34'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '32'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'AbandonRate' => ['description' => '放弃率。计算公式为:CallsAbandoned/CallsOffered(由于放弃事件与分配事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '447'],
'TotalAbandonTime' => ['description' => '总放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsOffered' => ['description' => '分配量,即分配给该技能组的电话数量,包括通过队列分配的电话数量和通过转接(咨询转接和直接转接)分配的电话数量。计算公式为:CallsQueued+CallsBlindTransferIn+CallsAttentandedTransferIn。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
'MaxAbandonedInRingTime' => ['description' => '最大振铃放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWaitTime' => ['description' => '最大等待时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '13'],
'AverageAbandonedInQueueTime' => ['description' => '平均排队放弃时长,单位秒。计算公式为: TotalAbandonedInQueueTime/CallsAbandonedInQueue。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'ServiceLevel20' => ['description' => '20秒服务水平,等待时长小于等于20秒的电话数量/CallsQueued。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为: TotalTalkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '64'],
'CallsHold' => ['description' => '保持量,即发生通话保持的次数。一通电话每次进入队列后,若发生多次通话保持,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'HandleRate' => ['description' => '应答率。计算公式为:CallsHandled/CallsOffered(由于应答事件与分配事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'CallsTimeout' => ['description' => '超时量,即发生队列(技能组)超时的电话数量。若一通电话多次进入同一队列,每次超时算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalAbandonedInQueueTime' => ['description' => '总排队放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAbandonedInQueue' => ['description' => '队列放弃量,即电话进入队列之后在排队环节客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsQueuingTimeout' => ['description' => '在排队阶段超时的通话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsQueuingOverflow' => ['description' => '队列溢出的通话数量,队列溢出指通话在IVR排队时队列溢出。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AccessChannelTypeDetails' => [
'description' => '各渠道的统计数据。',
'type' => 'array',
'items' => [
'description' => '各渠道的统计数据。',
'type' => 'object',
'properties' => [
'AccessChannelType' => ['description' => '渠道类型。', 'type' => 'string', 'example' => 'Web'],
'CallsOffered' => ['description' => '分配的会话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
],
],
],
'AverageFirstResponseTime' => ['description' => 'Chat会话平均首次响应时长,单位为秒。', 'type' => 'number', 'format' => 'float', 'example' => '6'],
'AverageResponseTime' => ['description' => 'Chat会话平均响应时长。', 'type' => 'number', 'format' => 'float', 'example' => '8'],
'CallsQueuingFailed' => ['description' => '队列失败量,即电话进入队列之后在排队环节客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ServiceLevel15' => ['description' => '15秒服务水平。', 'type' => 'number', 'format' => 'float', 'example' => '0.7'],
'ServiceLevel30' => ['description' => '30秒服务水平。', 'type' => 'number', 'format' => 'float', 'example' => '0.9'],
'TotalMessagesSent' => ['description' => 'Chat会话中总消息发送量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'TotalMessagesSentByAgent' => ['description' => 'Chat会话中坐席发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '9'],
'TotalMessagesSentByCustomer' => ['description' => 'Chat会话中客户发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
],
],
'Outbound' => [
'description' => '呼出指标。',
'type' => 'object',
'properties' => [
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。计算公式为: TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'],
'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '9'],
'CallsAttendedTransferOut' => ['description' => '咨询转出量,即由该技能组发起的咨询转接到其他技能组的电话数量,同一技能组内坐席间的转接不计数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalDialingTime' => ['description' => '总拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '218'],
'TotalHoldTime' => ['description' => '总通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为:TotalWorkTime/CallsDialed', 'type' => 'number', 'format' => 'float', 'example' => '2'],
'CallsBlindTransferIn' => ['description' => '直接转入量,即由其他技能组发起的直接转接到该技能组的电话数量,同一技能组内坐席间的转接不计数。若一个坐席同时签入多个技能组,则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组,每次转接算一次。下同。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsRinged' => ['description' => '坐席振铃的电话数量,一通电话每次进入队列后,若分配给多个座席并产生了振铃,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAttendedTransferIn' => ['description' => '咨询转入量,即由其他技能组发起的咨询转接到该技能组的电话数量,同一技能组内坐席间的转接不计数。若一个坐席同时迁入多个技能组,则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组,每次转接算一次。下同。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsBlindTransferOut' => ['description' => '直接转出量,即由该技能组发起的直接转接到其他技能组的电话数量,同一技能组内坐席间的转接不计数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'MaxDialingTime' => ['description' => '最大拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'AnswerRate' => ['description' => '接通率,计算公式为:CallsAnswered/CallsDialed(由于接听事件与应答事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为:TotalTalkTime/CallsAnswered。', 'type' => 'number', 'format' => 'float', 'example' => '3'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsHold' => ['description' => '保持量,即发生通话保持的电话数量。一通电话在转出当前技能组之前,若发生多次通话保持,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageDialingTime' => ['description' => '平均拨号时长,单位秒。计算公式为:TotalDialingTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '37'],
],
],
'Overall' => [
'description' => '整体指标。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '449'],
'TotalLoggedInTime' => ['description' => '总登录时长,单位秒。'."\n"
.'_注意:不含离线和小休时长_', 'type' => 'integer', 'format' => 'int64', 'example' => '23218'],
'OccupancyRate' => ['description' => '座席利用率,计算公式为: (TotalworkTime + TotalTalkTime ) / TotalLoggedInTime。', 'type' => 'number', 'format' => 'float', 'example' => '0.02332222293912065'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '94'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'AverageBreakTime' => ['description' => '平均小休时长,单位秒。计算公式为:TotalBreakTime/小休次数。小休次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalHoldTime' => ['description' => '总保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'MaxBreakTime' => ['description' => '最大小休时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为:TotalWorkTime/TotalCalls。', 'type' => 'number', 'format' => 'float', 'example' => '8'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为: TotalTalkTime/(CallsAnswered+CallsHandled)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxReadyTime' => ['description' => '最大就绪时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '19328'],
'AverageReadyTime' => ['description' => '平均就绪时长,单位秒。计算公式为:TotalReadyTime/就绪次数。就绪次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/(呼入CallsHold+呼出CallsHold)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalReadyTime' => ['description' => '总就绪时长,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '22428'],
'TotalBreakTime' => ['description' => '总小休时长,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalCalls' => ['description' => '总电话量。计算公式为:CallsOffered + CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '13'],
'BreakCodeDetailList' => [
'description' => '小休详情列表。',
'type' => 'array',
'items' => [
'description' => '小休详情。',
'type' => 'object',
'properties' => [
'BreakCode' => ['description' => '小休类型代码。', 'type' => 'string', 'example' => '会议'],
'Count' => ['description' => '此类型小休的发生次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'Duration' => ['description' => '此类型小休的总计发生时长,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '3600'],
],
],
],
],
],
'Back2Back' => [
'description' => '双呼指标。',
'type' => 'object',
'properties' => [
'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AnswerRate' => ['description' => '接通率,计算公式为:CallsAnswered/CallsDialed(由于接听事件与应答事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0.6'],
'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'TotalCustomerRingTime' => ['description' => '总客户侧振岭时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxCustomerRingTime' => ['description' => '最大客户侧振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageCustomerRingTime' => ['description' => '平均客户侧振铃时长,单位秒', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'AgentHandleRate' => ['description' => '坐席应答率。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'CallsCustomerAnswered' => ['description' => '客户接听电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'],
'CustomerAnswerRate' => ['description' => '客户接通率。', 'type' => 'number', 'format' => 'float', 'example' => '0.8'],
],
],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
500 => [
['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'],
],
],
'title' => '获取技能组历史数据报表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-22T01:05:26.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHistoricalSkillGroupReport'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 4,\\n \\"List\\": [\\n {\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 5,\\n \\"CallsOverflow\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"CallsHandled\\": 7,\\n \\"TotalWorkTime\\": 85,\\n \\"TotalAbandonedInRingTime\\": 0,\\n \\"MaxWorkTime\\": 12,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"AverageWaitTime\\": 5,\\n \\"TotalHoldTime\\": 0,\\n \\"MaxAbandonTime\\": 0,\\n \\"AverageWorkTime\\": 13,\\n \\"CallsQueued\\": 7,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"AverageAbandonedInRingTime\\": 0,\\n \\"AverageAbandonTime\\": 0,\\n \\"CallsRinged\\": 7,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"MaxAbandonedInQueueTime\\": 0,\\n \\"TotalWaitTime\\": 34,\\n \\"TotalRingTime\\": 32,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 12,\\n \\"AbandonRate\\": 0,\\n \\"TotalTalkTime\\": 447,\\n \\"TotalAbandonTime\\": 0,\\n \\"CallsOffered\\": 7,\\n \\"MaxAbandonedInRingTime\\": 0,\\n \\"MaxWaitTime\\": 13,\\n \\"AverageAbandonedInQueueTime\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"AverageTalkTime\\": 64,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 1,\\n \\"CallsTimeout\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalAbandonedInQueueTime\\": 0,\\n \\"CallsAbandonedInQueue\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"AccessChannelTypeDetails\\": [\\n {\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"CallsOffered\\": 2\\n }\\n ],\\n \\"AverageFirstResponseTime\\": 6,\\n \\"AverageResponseTime\\": 8,\\n \\"CallsQueuingFailed\\": 0,\\n \\"ServiceLevel15\\": 0.7,\\n \\"ServiceLevel30\\": 0.9,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 9,\\n \\"TotalMessagesSentByCustomer\\": 3\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 6,\\n \\"CallsAnswered\\": 1,\\n \\"TotalWorkTime\\": 9,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 218,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 2,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 3,\\n \\"MaxDialingTime\\": 12,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 3,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 37\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 449,\\n \\"TotalLoggedInTime\\": 23218,\\n \\"OccupancyRate\\": 0.02332222293912065,\\n \\"TotalWorkTime\\": 94,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 12,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 1,\\n \\"AverageWorkTime\\": 8,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 19328,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 22428,\\n \\"TotalBreakTime\\": 3,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 13,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"会议\\",\\n \\"Count\\": 2,\\n \\"Duration\\": 3600\\n }\\n ]\\n },\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": 100,\\n \\"AnswerRate\\": 0.6,\\n \\"CallsAnswered\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"AgentHandleRate\\": 1,\\n \\"CallsCustomerAnswered\\": 8,\\n \\"CustomerAnswerRate\\": 0.8\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>26A34338-5CD9-4C95-A7A6-5BDCE76C6B94</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>4</TotalCount>\\n <PageSize>100</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <SkillGroupName>test1</SkillGroupName>\\n <SkillGroupId>skg-test1@ccc-test</SkillGroupId>\\n <Inbound>\\n <ServiceLevel20>0</ServiceLevel20>\\n <CallsAbandonedInQueue>0</CallsAbandonedInQueue>\\n <TotalWorkTime>85</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <CallsRinged>7</CallsRinged>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>12</MaxRingTime>\\n <CallsOffered>7</CallsOffered>\\n <CallsAbandoned>0</CallsAbandoned>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <MaxAbandonedInRingTime>0</MaxAbandonedInRingTime>\\n <TotalRingTime>32</TotalRingTime>\\n <HandleRate>1</HandleRate>\\n <AverageAbandonedInQueueTime>0</AverageAbandonedInQueueTime>\\n <TotalTalkTime>447</TotalTalkTime>\\n <AverageWaitTime>5</AverageWaitTime>\\n <TotalAbandonedInRingTime>0</TotalAbandonedInRingTime>\\n <CallsQueued>7</CallsQueued>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <CallsAttendedTransferOut>0</CallsAttendedTransferOut>\\n <TotalAbandonTime>0</TotalAbandonTime>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>64</AverageTalkTime>\\n <MaxAbandonedInQueueTime>0</MaxAbandonedInQueueTime>\\n <CallsTimeout>0</CallsTimeout>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <CallsAbandonedInRing>0</CallsAbandonedInRing>\\n <CallsOverflow>0</CallsOverflow>\\n <CallsHandled>7</CallsHandled>\\n <MaxWaitTime>13</MaxWaitTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <CallsAttendedTransferIn>0</CallsAttendedTransferIn>\\n <MaxAbandonTime>0</MaxAbandonTime>\\n <AverageRingTime>5</AverageRingTime>\\n <TotalWaitTime>34</TotalWaitTime>\\n <AverageAbandonTime>0</AverageAbandonTime>\\n <AverageAbandonedInRingTime>0</AverageAbandonedInRingTime>\\n <TotalAbandonedInQueueTime>0</TotalAbandonedInQueueTime>\\n <CallsBlindTransferOut>0</CallsBlindTransferOut>\\n <AverageWorkTime>13</AverageWorkTime>\\n <MaxWorkTime>12</MaxWorkTime>\\n <CallsBlindTransferIn>0</CallsBlindTransferIn>\\n <AbandonRate>0</AbandonRate>\\n </Inbound>\\n <Outbound>\\n <TotalDialingTime>218</TotalDialingTime>\\n <TotalWorkTime>9</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <CallsRinged>0</CallsRinged>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>0</MaxRingTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <TotalRingTime>0</TotalRingTime>\\n <AverageDialingTime>37</AverageDialingTime>\\n <CallsAnswered>1</CallsAnswered>\\n <TotalTalkTime>3</TotalTalkTime>\\n <CallsDialed>6</CallsDialed>\\n <MaxDialingTime>12</MaxDialingTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <CallsAttendedTransferOut>0</CallsAttendedTransferOut>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>3</AverageTalkTime>\\n <AnswerRate>0</AnswerRate>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <CallsAttendedTransferIn>0</CallsAttendedTransferIn>\\n <AverageRingTime>0</AverageRingTime>\\n <CallsBlindTransferOut>0</CallsBlindTransferOut>\\n <AverageWorkTime>2</AverageWorkTime>\\n <MaxWorkTime>0</MaxWorkTime>\\n <CallsBlindTransferIn>0</CallsBlindTransferIn>\\n </Outbound>\\n <Overall>\\n <TotalReadyTime>22428</TotalReadyTime>\\n <TotalCalls>13</TotalCalls>\\n <TotalBreakTime>3</TotalBreakTime>\\n <TotalWorkTime>94</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <AverageHoldTime>0</AverageHoldTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <AverageBreakTime>0</AverageBreakTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <TotalTalkTime>449</TotalTalkTime>\\n <AverageReadyTime>0</AverageReadyTime>\\n <TotalLoggedInTime>23218</TotalLoggedInTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <MaxReadyTime>19328</MaxReadyTime>\\n <AverageWorkTime>8</AverageWorkTime>\\n <MaxWorkTime>12</MaxWorkTime>\\n <MaxBreakTime>1</MaxBreakTime>\\n <OccupancyRate>0.02332222293912065</OccupancyRate>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n </Overall>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListInstances' => [
'summary' => '调用ListInstances获取当前阿里云账号下的云联络中心实例列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccTMAX45'],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'List' => [
'description' => '列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '实例状态。',
'type' => 'string',
'enumValueTitles' => ['RELEASED' => '已释放', 'RUNNING' => '正常运行中', 'STOPPED' => '已停服', 'CREATING' => '创建中'],
'example' => 'RUNNING',
],
'ConsoleUrl' => ['description' => '云联络中心实例的网址,用于访问云呼叫中心实例的主页面,由云呼叫中心的特定网址加上实例ID组成。', 'type' => 'string', 'example' => 'https://ccc-v2.aliyun.com/#/workbench/ccc-test'],
'Description' => ['description' => '实例的描述。', 'type' => 'string', 'example' => '云联络中心的测试实例。'],
'CreateTime' => ['description' => '实例的创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1624679747000'],
'AliyunUid' => ['description' => '实例所属的阿里云账户ID。', 'type' => 'string', 'example' => '157123456789****'],
'Name' => ['description' => '实例名称。', 'type' => 'string', 'example' => '测试实例'],
'DomainName' => ['description' => '实例的域名,全局唯一。', 'type' => 'string', 'example' => 'ccc-test'],
'Id' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'AdminList' => [
'description' => '管理员列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '管理员的姓名。', 'type' => 'string', 'example' => '测试坐席'],
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'."\n"],
'LoginName' => ['description' => '坐席登录名。', 'type' => 'string', 'example' => 'agent'],
'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => 'username@example.com'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1382114****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'RoleName' => [
'description' => '角色名称。',
'type' => 'string',
'enumValueTitles' => ['Mannager' => '技能组组长', 'Agent' => '坐席', 'Admin' => '管理员'],
'example' => 'Admin',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'RoleId' => ['description' => '角色ID,格式为:角色@实例ID。', 'type' => 'string', 'example' => 'Admin@ccc-test'],
],
'description' => '',
],
],
'NumberList' => [
'description' => '号码列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '0830011****'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取实例列表',
'description' => '若RAM子账号需要调用该接口,则需具有“管理云呼叫中心(CCC)的权限”(AliyunCCCFullAccess)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"RUNNING\\",\\n \\"ConsoleUrl\\": \\"https://ccc-v2.aliyun.com/#/workbench/ccc-test\\",\\n \\"Description\\": \\"云联络中心的测试实例。\\",\\n \\"CreateTime\\": 1624679747000,\\n \\"AliyunUid\\": \\"157123456789****\\",\\n \\"Name\\": \\"测试实例\\",\\n \\"DomainName\\": \\"ccc-test\\",\\n \\"Id\\": \\"ccc-test\\",\\n \\"AdminList\\": [\\n {\\n \\"DisplayName\\": \\"测试坐席\\",\\n \\"Extension\\": \\"8032****\\\\n\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\"\\n }\\n ],\\n \\"NumberList\\": [\\n {\\n \\"Number\\": \\"0830011****\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
],
'ListInstancesOfUser' => [
'summary' => '调用ListInstancesOfUser获取用户所属的云联络中心实例列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccTMAX45'],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3969FC68-CEC2-4398-B76A-60D2F7EDEBAF'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'List' => [
'description' => '列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '实例状态。',
'type' => 'string',
'enumValueTitles' => ['RELEASED(已注销)' => 'RELEASED(已注销)', 'CREATING(创建中)' => 'CREATING(创建中)', 'RUNNING(正常运行中)' => 'RUNNING(正常运行中)', 'STOPPED(已停服)' => 'STOPPED(已停服)'],
'example' => 'RUNNING',
],
'ConsoleUrl' => ['description' => '云联络中心实例的网址,用于访问云联络中心实例的主页面,由云联络中心的特定网址加上实例ID组成。', 'type' => 'string', 'example' => 'https://ccc-v2.aliyun.com/#/workbench/ccc-test'],
'Description' => ['description' => '实例的描述。', 'type' => 'string', 'example' => '云联络中心的测试实例。'],
'AliyunUid' => ['description' => '实例所属的阿里云账户ID。', 'type' => 'string', 'example' => '157123456789****'],
'Name' => ['description' => '实例名称。', 'type' => 'string', 'example' => '测试实例'],
'DomainName' => ['description' => '实例的域名,全局唯一。', 'type' => 'string', 'example' => 'ccc-test'],
'Id' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'AdminList' => [
'description' => '管理员列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '管理员的姓名。', 'type' => 'string', 'example' => '测试坐席'],
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'LoginName' => ['description' => '坐席登录名。', 'type' => 'string', 'example' => 'agent'],
'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => 'username@example.com'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['OFF_SITE(场外模式)' => 'OFF_SITE(场外模式)', 'ON_SITE(场内模式)' => 'ON_SITE(场内模式)', 'OFFICE_PHONE(办公电话模式)' => 'OFFICE_PHONE(办公电话模式)'],
'example' => 'ON_SITE',
],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1382114****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'RoleName' => [
'description' => '角色名称。',
'type' => 'string',
'enumValueTitles' => ['Agent' => '坐席', 'Manager(技能组组长)' => 'Manager(技能组组长)', 'Admin(管理员)' => 'Admin(管理员)'],
'example' => 'Admin',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'RoleId' => ['description' => '角色ID,格式为:角色@实例ID。', 'type' => 'string', 'example' => 'Admin@ccc-test'],
],
'description' => '',
],
],
'NumberList' => [
'description' => '号码列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Active' => ['description' => '是否可用。', 'type' => 'boolean', 'example' => 'true'],
'UserId' => ['description' => '坐席ID,如果此参数不为空,说明该号码是座席个人外呼号码。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '0830011****'],
'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '乐山'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Usage' => [
'description' => '号码用途。',
'type' => 'string',
'enumValueTitles' => ['Bidirection(呼入及呼出)' => 'Bidirection(呼入及呼出)', 'Inbound(呼入)' => 'Inbound(呼入)', 'Outbound(呼出)' => 'Outbound(呼出)'],
'example' => 'Bidirection',
],
'ContactFlowId' => ['description' => '该电话号码所关联的联系流ID(IVR)。', 'type' => 'string', 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek'],
'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '四川'],
'SkillGroups' => [
'description' => '号码所关联的技能组列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '技能组展示名。', 'type' => 'string', 'example' => '测试技能组'],
'Description' => ['description' => '技能组描述。', 'type' => 'string', 'example' => '云联络中心的测试技能组。'],
'PhoneNumberCount' => ['description' => '技能组关联的号码数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'UserCount' => ['description' => '技能组关联的坐席数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Name' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
],
],
'title' => '获取用户所属的实例列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstancesOfUser'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"3969FC68-CEC2-4398-B76A-60D2F7EDEBAF\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"RUNNING\\",\\n \\"ConsoleUrl\\": \\"https://ccc-v2.aliyun.com/#/workbench/ccc-test\\",\\n \\"Description\\": \\"云联络中心的测试实例。\\",\\n \\"AliyunUid\\": \\"157123456789****\\",\\n \\"Name\\": \\"测试实例\\",\\n \\"DomainName\\": \\"ccc-test\\",\\n \\"Id\\": \\"ccc-test\\",\\n \\"AdminList\\": [\\n {\\n \\"DisplayName\\": \\"测试坐席\\",\\n \\"Extension\\": \\"8032****\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\"\\n }\\n ],\\n \\"NumberList\\": [\\n {\\n \\"Active\\": true,\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Number\\": \\"0830011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"ContactFlowId\\": \\"a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\",\\n \\"Province\\": \\"四川\\",\\n \\"SkillGroups\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"PhoneNumberCount\\": 1,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"UserCount\\": 2,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"skillgroup\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>3969FC68-CEC2-4398-B76A-60D2F7EDEBAF</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Status>RUNNING</Status>\\n <Description>测试实例</Description>\\n <DomainName>ccc-test</DomainName>\\n <ConsoleUrl>https://ccc-v2.aliyun.com/#/workbench/ccc-test</ConsoleUrl>\\n <AliyunUid>157123456789****</AliyunUid>\\n <Id>ccc-test</Id>\\n <Name>云呼测试实例</Name>\\n <AdminList>\\n <Extension>8032****</Extension>\\n <LoginName>user-test</LoginName>\\n <RoleName>Admin</RoleName>\\n <Email>1886666****@163.com</Email>\\n <InstanceId>ccc-test</InstanceId>\\n <UserId>user-test@ccc-test</UserId>\\n <DisplayName>云呼测试1</DisplayName>\\n <RoleId>Admin@ccc-test</RoleId>\\n <Mobile>1382114****</Mobile>\\n <WorkMode>ON_SITE</WorkMode>\\n </AdminList>\\n <NumberList>\\n <Usage>Bidirection</Usage>\\n <Active>true</Active>\\n <Number>0830011****</Number>\\n <InstanceId>ccc-test</InstanceId>\\n <ContactFlowId>a3fb6c62-9b49-4942-ae5b-cf2abd4123ek</ContactFlowId>\\n <UserId>user-test@ccc-test</UserId>\\n <City>乐山</City>\\n <Province>四川</Province>\\n <SkillGroups>\\n <Description>测试</Description>\\n <PhoneNumberCount>1</PhoneNumberCount>\\n <InstanceId>ccc-test</InstanceId>\\n <UserCount>2</UserCount>\\n <DisplayName>测试技能组</DisplayName>\\n <SkillGroupId>test@ccc-test</SkillGroupId>\\n <Name>test</Name>\\n </SkillGroups>\\n </NumberList>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListIntervalAgentReport' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'AgentId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,格式为Unix时间戳,单位毫秒,非必填,默认为当天的0时,统计的时间精度为小时,向前取整,闭区间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532448000000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '截止时间,格式为Unix时间戳,单位毫秒,非必填,默认是当前时间,如果Interval为Daily,StartTime和EndTime最大间隔是180天。如果Interval为Hourly,最大间隔时间为10天。统计的时间精度为小时,向后取整,开区间。例如:开始时间为11:12:20,结束时间为11:45:50,则对齐后的入参时间范围为[11:00:00,12:00:00),即大于等于11点,小于12点。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532707199000'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'Interval',
'in' => 'query',
'schema' => [
'description' => '分段统计类型,非必填,默认为Daily(按天汇总)。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Hourly' => '按小时统计', 'Daily' => '按天统计'],
'example' => 'Hourly',
],
],
[
'name' => 'MediaType',
'in' => 'query',
'schema' => ['description' => '媒体类型,默认是语音(Audio), 其他可选参数包括Chat和Video.', 'type' => 'string', 'required' => false, 'example' => 'VIDEO'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'],
'Data' => [
'description' => '坐席分段统计数据列表。',
'type' => 'array',
'items' => [
'description' => '坐席分段统计数据。',
'type' => 'object',
'properties' => [
'StatsTime' => ['description' => '时间段的开始时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620291600000'],
'Inbound' => [
'description' => '呼入指标。',
'type' => 'object',
'properties' => [
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。计算公式为: TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsHandled' => ['description' => '应答量,即坐席应答的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAttendedTransferOut' => ['description' => '咨询转出量。若一通电话多次转出给其他坐席,每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalHoldTime' => ['description' => '总通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为:TotalWorkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsBlindTransferIn' => ['description' => '直接转入量。若一通电话多次转入给该坐席,每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsRinged' => ['description' => '坐席振铃的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAttendedTransferIn' => ['description' => '咨询转入量。若一通电话多次转入给该坐席,每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsBlindTransferOut' => ['description' => '直接转出量。若一通电话多次转出给其他坐席,每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsOffered' => ['description' => '分配量,即分配给此坐席的电话次数, 包括其他坐席盲转和咨询转给此坐席的电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为:TotalTalkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsHold' => ['description' => '保持量,即发生通话保持的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'HandleRate' => ['description' => '应答率。计算公式为:CallsHandled / CallsOffered(由于应答事件与分配事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AccessChannelTypeDetails' => [
'description' => '各渠道的统计数据。',
'type' => 'array',
'items' => [
'description' => '各渠道的统计数据。',
'type' => 'object',
'properties' => [
'AccessChannelType' => ['description' => '渠道类型。', 'type' => 'string', 'example' => 'Web'],
'CallsOffered' => ['description' => '分配的会话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
],
],
],
'AverageFirstResponseTime' => ['description' => 'Chat会话平均首次响应时长,单位为秒。', 'type' => 'number', 'format' => 'float', 'example' => '8'],
'AverageResponseTime' => ['description' => 'Chat会话平均响应时长。', 'type' => 'number', 'format' => 'float', 'example' => '10'],
'ServiceLevel15' => ['description' => '15秒服务水平。', 'type' => 'number', 'format' => 'float', 'example' => '0.6'],
'TotalMessagesSent' => ['description' => 'Chat会话中总消息发送量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'TotalMessagesSentByAgent' => ['description' => 'Chat会话中坐席发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'TotalMessagesSentByCustomer' => ['description' => 'Chat会话中客户发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
],
],
'Outbound' => [
'description' => '呼出指标。',
'type' => 'object',
'properties' => [
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。计算公式为: TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
'CallsAttendedTransferOut' => ['description' => '咨询转出量。若一通电话多次转出给其他坐席,每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'TotalDialingTime' => ['description' => '总拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '148'],
'TotalHoldTime' => ['description' => '总通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为:TotalWorkTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'CallsBlindTransferIn' => ['description' => '直接转入量。若一通电话多次转入给该坐席,每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsRinged' => ['description' => '坐席振铃的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAttendedTransferIn' => ['description' => '咨询转入量。若一通电话多次转入给该坐席,每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsBlindTransferOut' => ['description' => '直接转出量。若一通电话多次转出给其他坐席,每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxDialingTime' => ['description' => '最大拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '60'],
'AnswerRate' => ['description' => '接通率,计算公式为:CallsAnswered/CallsDialed(由于接听事件与应答事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为:TotalTalkTime/CallsAnswered。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsHold' => ['description' => '保持量,即发生通话保持的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageDialingTime' => ['description' => '平均拨号时长,单位秒。计算公式为:TotalDialingTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '30'],
],
],
'Overall' => [
'description' => '整体指标。',
'type' => 'object',
'properties' => [
'OccupancyRate' => ['description' => '座席利用率,计算公式为: (TotalworkTime + TotalTalkTime ) / TotalLoggedInTime。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'TotalHoldTime' => ['description' => '总保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为:TotalWorkTime/TotalCalls。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'MaxBreakTime' => ['description' => '最大小休时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0'],
'MaxReadyTime' => ['description' => '最大就绪时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '435'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalReadyTime' => ['description' => '总就绪时长,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '763'],
'LastCheckoutTime' => ['description' => '入参Interval为Daily才有值,当天的最后下线时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用,请使用LastCheckOutTime代替此参数。'],
'LastCheckOutTime' => ['description' => '入参Interval为Daily才有值,当天的最后下线时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalCalls' => ['description' => '总电话量。计算公式为:CallsOffered+CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'TotalLoggedInTime' => ['description' => '总登录时长,单位秒。_注意:不包含离线和小休时长_。', 'type' => 'integer', 'format' => 'int64', 'example' => '914'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageBreakTime' => ['description' => '平均小休时长,单位秒。计算公式为:TotalBreakTime/小休次数。小休次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为: TotalTalkTime/(CallsAnswered+CallsHandled)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/(呼入CallsHold+呼出CallsHold)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageReadyTime' => ['description' => '平均就绪时长,单位秒。计算公式为:TotalReadyTime/就绪次数。就绪次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalBreakTime' => ['description' => '总小休时长,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'TotalOnSiteOnlineTime' => ['description' => '总场内在线时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用,请使用TotalOnSiteLoggedInTime代替此参数'],
'TotalOffSiteOnlineTime' => ['description' => '总场外在线时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用,请使用TotalOffSiteLoggedInTime代替此参数'],
'TotalOfficePhoneOnlineTime' => ['description' => '总办公电话在线时长,单位秒', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用,请使用TotalOfficePhoneLoggedInTime代替此参数'],
'BreakCodeDetailList' => [
'description' => '小休详情列表。',
'type' => 'array',
'items' => [
'description' => '小休详情。',
'type' => 'object',
'properties' => [
'BreakCode' => ['description' => '小休码。', 'type' => 'string', 'example' => '会议'],
'Count' => ['description' => '数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Duration' => ['description' => '持续时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
],
],
'TotalOutboundScenarioTime' => ['description' => '总仅外呼时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用,请使用TotalOutboundScenarioLoggedInTime代替此参数'],
'TotalOutboundScenarioReadyTime' => ['description' => '总仅外呼空闲时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'FirstCheckInTime' => ['description' => '入参Interval为Daily才有值,当天的首次上线时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalOfficePhoneLoggedInTime' => ['description' => '总办公电话在线时长,单位秒', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalOffSiteLoggedInTime' => ['description' => '总场外在线时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalOnSiteLoggedInTime' => ['description' => '总场内在线时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalOutboundScenarioLoggedInTime' => ['description' => '总仅外呼在线时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
],
'Back2Back' => [
'description' => '双呼指标。',
'type' => 'object',
'properties' => [
'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AnswerRate' => ['description' => '接通率,计算公式为:CallsAnswered/CallsDialed(由于接听事件与应答事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'],
'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'TotalCustomerRingTime' => ['description' => '总客户侧振岭时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxCustomerRingTime' => ['description' => '最大客户侧振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageCustomerRingTime' => ['description' => '平均客户侧振铃时长,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'CallsAgentHandled' => ['description' => '坐席接听电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'AgentHandleRate' => ['description' => '坐席应答率。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'CallsCustomerAnswered' => ['description' => '客户接听电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '9'],
'CustomerAnswerRate' => ['description' => '客户接通率。', 'type' => 'number', 'format' => 'float', 'example' => '0.75'],
],
],
'Internal' => [
'description' => '内部呼叫指标。',
'type' => 'object',
'properties' => [
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsHandled' => ['description' => '应答量,即坐席应答的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsOffered' => ['description' => '分配量,即分配给此坐席的电话次数, 包括其他坐席盲转和咨询转给此坐席的电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsTalked' => ['description' => '参与通话次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '80'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
500 => [
['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'],
],
],
'title' => '获取坐席分段统计报表',
'summary' => '调用ListIntervalAgentReport获取指定实例下指定坐席的分段统计报表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-22T01:05:26.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2023-05-23T11:59:01.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalAgentReport'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": [\\n {\\n \\"StatsTime\\": 1620291600000,\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AccessChannelTypeDetails\\": [\\n {\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"CallsOffered\\": 2\\n }\\n ],\\n \\"AverageFirstResponseTime\\": 8,\\n \\"AverageResponseTime\\": 10,\\n \\"ServiceLevel15\\": 0.6,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 10,\\n \\"TotalMessagesSentByCustomer\\": 2\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 5,\\n \\"CallsAnswered\\": 0,\\n \\"TotalWorkTime\\": 4,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 2,\\n \\"TotalDialingTime\\": 148,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 1,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 60,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 30\\n },\\n \\"Overall\\": {\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 4,\\n \\"MaxWorkTime\\": 2,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 1,\\n \\"MaxBreakTime\\": 1,\\n \\"SatisfactionIndex\\": 0,\\n \\"MaxReadyTime\\": 435,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalReadyTime\\": 763,\\n \\"LastCheckoutTime\\": 0,\\n \\"LastCheckOutTime\\": 0,\\n \\"TotalCalls\\": 5,\\n \\"TotalLoggedInTime\\": 914,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageBreakTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"TotalBreakTime\\": 1,\\n \\"TotalOnSiteOnlineTime\\": 0,\\n \\"TotalOffSiteOnlineTime\\": 0,\\n \\"TotalOfficePhoneOnlineTime\\": 0,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"会议\\",\\n \\"Count\\": 10,\\n \\"Duration\\": 100\\n }\\n ],\\n \\"TotalOutboundScenarioTime\\": 0,\\n \\"TotalOutboundScenarioReadyTime\\": 100,\\n \\"FirstCheckInTime\\": 0,\\n \\"TotalOfficePhoneLoggedInTime\\": 100,\\n \\"TotalOffSiteLoggedInTime\\": 100,\\n \\"TotalOnSiteLoggedInTime\\": 100,\\n \\"TotalOutboundScenarioLoggedInTime\\": 100\\n },\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": 100,\\n \\"AnswerRate\\": 0.5,\\n \\"CallsAnswered\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"CallsAgentHandled\\": 12,\\n \\"AgentHandleRate\\": 1,\\n \\"CallsCustomerAnswered\\": 9,\\n \\"CustomerAnswerRate\\": 0.75\\n },\\n \\"Internal\\": {\\n \\"AverageTalkTime\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"CallsTalked\\": 80\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>943D8EF3-3321-471F-A104-51C96FCA94D6</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <StatsTime>1620291600000</StatsTime>\\n <Inbound>\\n <TotalWorkTime>0</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <CallsRinged>0</CallsRinged>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>0</MaxRingTime>\\n <CallsOffered>0</CallsOffered>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <CallsHandled>0</CallsHandled>\\n <TotalRingTime>0</TotalRingTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <HandleRate>0</HandleRate>\\n <CallsAttendedTransferIn>0</CallsAttendedTransferIn>\\n <TotalTalkTime>0</TotalTalkTime>\\n <AverageRingTime>0</AverageRingTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <CallsBlindTransferOut>0</CallsBlindTransferOut>\\n <AverageWorkTime>0</AverageWorkTime>\\n <CallsAttendedTransferOut>0</CallsAttendedTransferOut>\\n <MaxWorkTime>0</MaxWorkTime>\\n <CallsBlindTransferIn>0</CallsBlindTransferIn>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n </Inbound>\\n <Outbound>\\n <TotalDialingTime>148</TotalDialingTime>\\n <TotalWorkTime>4</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <CallsRinged>0</CallsRinged>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>0</MaxRingTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <TotalRingTime>0</TotalRingTime>\\n <AverageDialingTime>30</AverageDialingTime>\\n <CallsAnswered>0</CallsAnswered>\\n <TotalTalkTime>0</TotalTalkTime>\\n <CallsDialed>5</CallsDialed>\\n <MaxDialingTime>60</MaxDialingTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <CallsAttendedTransferOut>0</CallsAttendedTransferOut>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n <AnswerRate>0</AnswerRate>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <CallsAttendedTransferIn>0</CallsAttendedTransferIn>\\n <AverageRingTime>0</AverageRingTime>\\n <CallsBlindTransferOut>0</CallsBlindTransferOut>\\n <AverageWorkTime>1</AverageWorkTime>\\n <MaxWorkTime>2</MaxWorkTime>\\n <CallsBlindTransferIn>0</CallsBlindTransferIn>\\n </Outbound>\\n <Overall>\\n <TotalReadyTime>763</TotalReadyTime>\\n <TotalCalls>5</TotalCalls>\\n <TotalBreakTime>1</TotalBreakTime>\\n <LastCheckoutTime>0</LastCheckoutTime>\\n <TotalWorkTime>4</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <AverageHoldTime>0</AverageHoldTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <AverageBreakTime>0</AverageBreakTime>\\n <FirstCheckInTime>0</FirstCheckInTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <TotalTalkTime>0</TotalTalkTime>\\n <AverageReadyTime>0</AverageReadyTime>\\n <TotalLoggedInTime>914</TotalLoggedInTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <MaxReadyTime>435</MaxReadyTime>\\n <AverageWorkTime>1</AverageWorkTime>\\n <MaxWorkTime>2</MaxWorkTime>\\n <MaxBreakTime>1</MaxBreakTime>\\n <OccupancyRate>0</OccupancyRate>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n </Overall>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListIntervalAgentSkillGroupReport' => [
'summary' => '获取指定实例下指定坐席的分段统计报表。',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccOQKOLI'],
],
'parameters' => [
[
'name' => 'AgentId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间戳,默认为当天的0时。统计的时间精度为小时,向前取整,闭区间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532448000000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '截止时间,格式为Unix时间戳,单位毫秒,非必填,默认是当前时间,如果Interval为Daily,StartTime和EndTime最大间隔是180天。如果Interval为Hourly,最大间隔时间为10天。统计的时间精度为小时,向后取整,开区间。例如:开始时间为11:12:20,结束时间为11:45:50,则对齐后的入参时间范围为[11:00:00,12:00:00),即大于等于11点,小于12点。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1558443508000'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'Interval',
'in' => 'query',
'schema' => [
'description' => '分段统计类型,非必填,默认为Daily(按天汇总)。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Hourly' => '按小时统计。', 'Daily' => '按天统计。'],
'example' => 'Daily',
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'example' => ' '."\n"
.'skg-default@ccc-test'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5'],
'Data' => [
'description' => '坐席在对应技能组中的分段统计数据列表。',
'type' => 'array',
'items' => [
'description' => '坐席在对应技能组中的分段统计数据。',
'type' => 'object',
'properties' => [
'StatsTime' => ['description' => '时间段的开始时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620291600000'],
'Inbound' => [
'description' => '呼入指标。',
'type' => 'object',
'properties' => [
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '11'],
'CallsHandled' => ['description' => '应答量,即坐席应答的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '85'],
'CallsAttendedTransferOut' => ['description' => '咨询转出量。若一通电话多次转出给其他坐席,每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalHoldTime' => ['description' => '总通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为: TotalWorkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'CallsBlindTransferIn' => ['description' => '直接转入量。若一通电话多次转入给该坐席,每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'CallsRinged' => ['description' => '坐席振铃的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsAttendedTransferIn' => ['description' => '咨询转入量。若一通电话多次转入给该坐席,每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsBlindTransferOut' => ['description' => '直接转出量。若一通电话多次转出给其他坐席,每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsOffered' => ['description' => '分配量,即分配给此坐席的电话次数, 包括其他坐席盲转和咨询转给此坐席的电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为: TotalTalkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'],
'CallsHold' => ['description' => '保持量,即发生通话保持的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'HandleRate' => ['description' => '应答率。计算公式为:CallsHandled/CallsOffered(由于应答事件与分配事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'AverageFirstResponseTime' => ['description' => 'Chat会话平均首次响应时长,单位为秒。', 'type' => 'number', 'format' => 'float', 'example' => '6'],
'AverageResponseTime' => ['description' => 'Chat会话平均响应时长。', 'type' => 'number', 'format' => 'float', 'example' => '18'],
'TotalMessagesSent' => ['description' => 'Chat会话中总消息发送量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'TotalMessagesSentByAgent' => ['description' => 'Chat会话中坐席发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'],
'TotalMessagesSentByCustomer' => ['description' => 'Chat会话中客户发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
],
],
'Outbound' => [
'description' => '呼出指标。',
'type' => 'object',
'properties' => [
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsAttendedTransferOut' => ['description' => '咨询转出量。若一通电话多次转出给其他坐席,每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalDialingTime' => ['description' => '总拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalHoldTime' => ['description' => '总通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为:TotalWorkTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'CallsBlindTransferIn' => ['description' => '直接转入量。若一通电话多次转入给该坐席,每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'CallsRinged' => ['description' => '坐席振铃的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsAttendedTransferIn' => ['description' => '咨询转入量。若一通电话多次转入给该坐席,每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsBlindTransferOut' => ['description' => '直接转出量。若一通电话多次转出给其他坐席,每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxDialingTime' => ['description' => '最大拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AnswerRate' => ['description' => '接通率,计算公式为:CallsAnswered/CallsDialed(由于接听事件与应答事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为:TotalTalkTime/CallsAnswered。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'CallsHold' => ['description' => '保持量,即发生通话保持的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'AverageDialingTime' => ['description' => '平均拨号时长,单位秒。计算公式为:TotalDialingTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
],
],
'Overall' => [
'description' => '整体指标。',
'type' => 'object',
'properties' => [
'OccupancyRate' => ['description' => '座席利用率。', 'type' => 'number', 'format' => 'float', 'example' => '0.4'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalHoldTime' => ['description' => '总保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为:TotalWorkTime/TotalCalls。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'MaxBreakTime' => ['description' => '最大小休时长,单位秒', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '1.4'],
'MaxReadyTime' => ['description' => '最大就绪时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalReadyTime' => ['description' => '总就绪时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'LastCheckOutTime' => ['description' => '最后签出时间,格式是unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1712548421000'],
'TotalCalls' => ['description' => '总电话量。计算公式为:CallsOffered + CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalLoggedInTime' => ['description' => '总登录时长,单位秒。_注意:不包含离线和小休时长_。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageBreakTime' => ['description' => '平均小休时长,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为: TotalTalkTime/(CallsAnswered+CallsHandled)。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'FirstCheckInTime' => ['description' => '入参Interval为Daily才有值,当天的首次上线时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/(Inbound.CallsHold+Outbound.CallsHold)。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'AverageReadyTime' => ['description' => '平均就绪时长,单位秒。计算公式为:TotalReadyTime/就绪次数。就绪次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'TotalBreakTime' => ['description' => '总小休时长,单位秒', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'BreakCodeDetailList' => [
'description' => '小休详情列表。',
'type' => 'array',
'items' => [
'description' => '小休详情。',
'type' => 'object',
'properties' => [
'BreakCode' => ['description' => '小休码。', 'type' => 'string', 'example' => '开会'],
'Count' => ['description' => '次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Duration' => ['description' => '时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
],
],
'TotalOutboundScenarioTime' => ['description' => '总仅外呼时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalOutboundScenarioReadyTime' => ['description' => '总仅外呼空闲时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalOutboundScenarioLoggedInTime' => ['description' => '总仅外呼在线时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalOffSiteLoggedInTime' => ['description' => '总场外在线时长,单位秒。', 'type' => 'string', 'example' => '100'],
'TotalOfficePhoneLoggedInTime' => ['description' => '办公电话在线时长,单位秒', 'type' => 'string', 'example' => '100'],
'TotalOnSiteLoggedInTime' => ['description' => '总场内在线时长,单位秒。', 'type' => 'string', 'example' => '100'],
'LastCheckoutTime' => ['description' => '入参Interval为Daily才有值,当天的最后下线时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
],
'Internal' => [
'description' => '内部呼叫指标。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsOffered' => ['description' => '分配量,即分配给此坐席的电话次数, 包括其他坐席盲转和咨询转给此坐席的电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsHandled' => ['description' => '应答量,即坐席应答的次数。一通电话每次进入队列后,若被多个坐席应答,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsTalk' => ['description' => '已废弃,该字段参考CallsTalked。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsTalked' => ['description' => '参与通话次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
],
'Back2Back' => [
'description' => '双呼指标。',
'type' => 'object',
'properties' => [
'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AnswerRate' => ['description' => '接通率,计算公式为:CallsAnswered/CallsDialed(由于接听事件与应答事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'],
'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AgentAnswerRate' => ['description' => '坐席测应答率。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'CallsCustomerHandled' => ['description' => '客户测接起次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CustomerHandleRate' => ['description' => '客户测接起率。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'TotalCustomerRingTime' => ['description' => '总客户测振岭时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'MaxCustomerRingTime' => ['description' => '最大客户测振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageCustomerRingTime' => ['description' => '平均客户测振铃时长,单位秒', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'AgentHandleRate' => ['description' => '坐席应答率。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'CallsCustomerAnswered' => ['description' => '客户接听电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'CustomerAnswerRate' => ['description' => '客户接通率。', 'type' => 'number', 'format' => 'float', 'example' => '0.6'],
'CallsAgentHandled' => ['description' => '坐席接听电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
],
500 => [
['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取分组坐席分段统计报表',
'changeSet' => [
['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalAgentSkillGroupReport'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"Data\\": [\\n {\\n \\"StatsTime\\": 1620291600000,\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 11,\\n \\"CallsHandled\\": 7,\\n \\"TotalWorkTime\\": 85,\\n \\"CallsAttendedTransferOut\\": 10,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"CallsBlindTransferIn\\": 100,\\n \\"SatisfactionIndex\\": 100,\\n \\"CallsRinged\\": 100,\\n \\"CallsAttendedTransferIn\\": 100,\\n \\"CallsBlindTransferOut\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 0.5,\\n \\"CallsHold\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"HandleRate\\": 0.5,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"AverageFirstResponseTime\\": 6,\\n \\"AverageResponseTime\\": 18,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 8,\\n \\"TotalMessagesSentByCustomer\\": 5\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"TotalWorkTime\\": 100,\\n \\"CallsAttendedTransferOut\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalDialingTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"CallsBlindTransferIn\\": 100,\\n \\"SatisfactionIndex\\": 100,\\n \\"CallsRinged\\": 100,\\n \\"CallsAttendedTransferIn\\": 100,\\n \\"CallsBlindTransferOut\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxDialingTime\\": 100,\\n \\"AnswerRate\\": 0.5,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 100,\\n \\"CallsHold\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"AverageDialingTime\\": 100\\n },\\n \\"Overall\\": {\\n \\"OccupancyRate\\": 0.4,\\n \\"TotalWorkTime\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"MaxBreakTime\\": 100,\\n \\"SatisfactionIndex\\": 1.4,\\n \\"MaxReadyTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"TotalReadyTime\\": 100,\\n \\"LastCheckOutTime\\": 1712548421000,\\n \\"TotalCalls\\": 100,\\n \\"TotalLoggedInTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageBreakTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"FirstCheckInTime\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"AverageReadyTime\\": 100,\\n \\"TotalBreakTime\\": 100,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"开会\\",\\n \\"Count\\": 1,\\n \\"Duration\\": 100\\n }\\n ],\\n \\"TotalOutboundScenarioTime\\": 100,\\n \\"TotalOutboundScenarioReadyTime\\": 100,\\n \\"TotalOutboundScenarioLoggedInTime\\": 100,\\n \\"TotalOffSiteLoggedInTime\\": \\"100\\",\\n \\"TotalOfficePhoneLoggedInTime\\": \\"100\\",\\n \\"TotalOnSiteLoggedInTime\\": \\"100\\",\\n \\"LastCheckoutTime\\": 100\\n },\\n \\"Internal\\": {\\n \\"TotalTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"CallsTalk\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"CallsTalked\\": 100\\n },\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": 100,\\n \\"AnswerRate\\": 0.5,\\n \\"CallsAnswered\\": 100,\\n \\"AgentAnswerRate\\": 100,\\n \\"CallsCustomerHandled\\": 100,\\n \\"CustomerHandleRate\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"AgentHandleRate\\": 1,\\n \\"CallsCustomerAnswered\\": 12,\\n \\"CustomerAnswerRate\\": 0.6,\\n \\"CallsAgentHandled\\": 5\\n }\\n }\\n ]\\n}","type":"json"}]',
],
'ListIntervalInstanceReport' => [
'summary' => '调用ListIntervalInstanceReport获取指定实例的分段统计报表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,格式为Unix时间戳,单位毫秒,非必填,默认为当天的0时,统计的时间精度为小时,向前取整,闭区间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1620230400000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '截止时间,格式为Unix时间戳,单位毫秒,非必填,默认是当前时间,如果Interval为Daily,StartTime和EndTime最大间隔是180天。如果Interval为Hourly,最大间隔时间为10天。统计的时间精度为小时,向后取整,开区间。例如:开始时间为11:12:20,结束时间为11:45:50,则对齐后的入参时间范围为[11:00:00,12:00:00) ,即大于等于11点,小于12点。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1620316799000'],
],
[
'name' => 'Interval',
'in' => 'query',
'schema' => [
'description' => '分段统计类型,非必填,默认为Daily(按天汇总)。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Hourly' => '按小时统计', 'Daily' => '按天统计'],
'example' => 'Hourly',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'],
'Data' => [
'description' => '实例分段统计数据列表。',
'type' => 'array',
'items' => [
'description' => '实例分段统计数据。',
'type' => 'object',
'properties' => [
'StatsTime' => ['description' => '开始时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620230400000'],
'Inbound' => [
'description' => '呼入指标。',
'type' => 'object',
'properties' => [
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。计算公式为: TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '5'],
'CallsVoicemail' => ['description' => '通话进入语音留言信箱的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxAbandonedInIVRTime' => ['description' => '最大IVR放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsHandled' => ['description' => '应答量,即坐席应答的电话数量。若一通电话被多个坐席应答,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
'CallsIVRException' => ['description' => '发生IVR异常的通话数量,判定条件是IVR进入了挂机原因节点且挂机原因节点设置的挂机原因为转人工失败,此时计数加1。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAbandonedInIVR' => ['description' => 'IVR放弃量,即电话进入IVR流程之后在IVR环节客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '17'],
'TotalHoldTime' => ['description' => '总通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxAbandonTime' => ['description' => '最大放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageAbandonTime' => ['description' => '平均放弃时长,单位秒。计算公式为:TotalAbandonTime/CallsAbandoned。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AbandonedRate' => ['description' => '已废弃,该字段可以参考AbandonRate', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsRinged' => ['description' => '座席振铃的电话数量,若一通电话分配给多个座席并产生了振铃,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
'CallsQueuingFailed' => ['description' => '队列失败量,即电话进入队列之后在排队环节客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '32'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '447'],
'MaxAbandonedInRingTime' => ['description' => '最大振铃放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsBlindTransferred' => ['description' => '直接转接量,即发生直接转接的电话数量。若一通电话发起多次转接,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageAbandonedInIVRTime' => ['description' => '平均IVR放弃时长,单位秒。计算公式为:TotalAbandonedInIVRTime/CallsAbandonedInIVR。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageAbandonedInQueueTime' => ['description' => '平均排队放弃时长,单位秒。计算公式为:TotalAbandonedInQueueTime/CallsAbandonedInQueue。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'MaxWaitTime' => ['description' => '最大等待时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '13'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为:TotalTalkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '64'],
'CallsAttendedTransferred' => ['description' => '咨询转接量,即发生咨询转接的电话数量。若一通电话发起多次转接,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalAbandonedInIVRTime' => ['description' => '总IVR放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsQueuingOverflow' => ['description' => '队列溢出的通话数量,即通话在IVR排队时队列溢出。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAbandonedInRing' => ['description' => '振铃放弃量,即坐席振铃中客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalAbandonedInRingTime' => ['description' => '总振铃放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '85'],
'AverageWaitTime' => ['description' => '平均等待时长,平均每通电话的坐席接起前等待时长。计算公式为: TotalWaitTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '5'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为: TotalWorkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '13'],
'CallsQueued' => ['description' => '进入队列的电话数量,若一通电话多次进入队列,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
'AverageAbandonedInRingTime' => ['description' => '平均振铃放弃时长,单位秒。计算公式为:TotalAbandonedInRingTime/CallsAbandonedInRing。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsAbandoned' => ['description' => '放弃量。计算公式为:CallsAbandonedInIVR+CallsAbandonedInQueue+CallsAbandonedInRing。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxAbandonedInQueueTime' => ['description' => '最大排队放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAbandonedInVoiceNavigator' => ['description' => '通话在智能导航模块放弃的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalWaitTime' => ['description' => '总等待时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '34'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '219'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'TotalAbandonTime' => ['description' => '总放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsOffered' => ['description' => '呼入到云联络中心的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
'CallsQueuingTimeout' => ['description' => '在排队阶段超时的通话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ServiceLevel20' => ['description' => '20秒服务水平,等待时长小于等于20秒的电话数量/CallsQueued。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsForwardToOutsideNumber' => ['description' => '发生转外线的通话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsHold' => ['description' => '保持量,即发生通话保持的电话数量。若一通电话保持多次,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'HandleRate' => ['description' => '应答率。计算公式为:CallsHandled/CallsOffered(由于应答事件与分配事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsAbandonedInQueue' => ['description' => '队列放弃量,即电话进入队列之后在排队环节客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalAbandonedInQueueTime' => ['description' => '总排队放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AbandonRate' => ['description' => '放弃率。计算公式为:CallsAbandoned/CallsOffered(由于放弃事件与分配事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsCausedIVRException' => ['description' => '导致IVR异常的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsToVoicemail' => ['description' => '转入语音信箱的电话数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'AverageFirstResponseTime' => ['description' => 'Chat会话平均首次响应时长,单位为秒。', 'type' => 'number', 'format' => 'float', 'example' => '6'],
'AverageResponseTime' => ['description' => 'Chat会话平均响应时长。', 'type' => 'number', 'format' => 'float', 'example' => '15'],
'TotalMessagesSent' => ['description' => 'Chat会话中总消息发送量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'TotalMessagesSentByAgent' => ['description' => 'Chat会话中坐席发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'],
'TotalMessagesSentByCustomer' => ['description' => 'Chat会话中客户发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
],
],
'Outbound' => [
'description' => '呼出指标。',
'type' => 'object',
'properties' => [
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。计算公式为: TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalDialingTime' => ['description' => '总拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalHoldTime' => ['description' => '总通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为:TotalWorkTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsRinged' => ['description' => '坐席振铃的电话数量,若一通电话分配给多个座席并产生了振铃,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxDialingTime' => ['description' => '最大拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsBlindTransferred' => ['description' => '直接转接量,即发生直接转接的电话数量。若一通电话发起多次转接,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AnswerRate' => ['description' => '接通率,计算公式为:CallsAnswered/CallsDialed(由于接听事件与应答事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为:TotalTalkTime/CallsAnswered。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsAttendedTransferred' => ['description' => '咨询转接量,即发生咨询转接的电话数量。若一通电话发起多次转接,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsHold' => ['description' => '保持量,即发生通话保持的电话数量。若一通电话保持多次,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageDialingTime' => ['description' => '平均拨号时长,单位秒。计算公式为:TotalDialingTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
],
],
'Overall' => [
'description' => '整体指标。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalLoggedInTime' => ['description' => '总登录时长,单位秒。不包含小休时长。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'OccupancyRate' => ['description' => '座席利用率,计算公式为: (TotalworkTime + TotalTalkTime ) / TotalLoggedInTime。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageBreakTime' => ['description' => '平均小休时长,单位秒。计算公式为:TotalBreakTime/小休次数。小休次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalHoldTime' => ['description' => '总保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'MaxBreakTime' => ['description' => '最大小休时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为:TotalWorkTime/TotalCalls。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为: TotalTalkTime/(CallsAnswered+CallsHandled)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxReadyTime' => ['description' => '最大就绪时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageReadyTime' => ['description' => '平均就绪时长,单位秒。计算公式为:TotalReadyTime/就绪次数。就绪次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/(呼入CallsHold+呼出CallsHold)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalReadyTime' => ['description' => '总就绪时长,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalBreakTime' => ['description' => '总小休时长,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalCalls' => ['description' => '总电话量。计算公式为:CallsOffered + CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
],
'title' => '获取实例分段统计报表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalInstanceReport'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": [\\n {\\n \\"StatsTime\\": 1620230400000,\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 5,\\n \\"CallsVoicemail\\": 0,\\n \\"MaxAbandonedInIVRTime\\": 0,\\n \\"CallsHandled\\": 7,\\n \\"CallsIVRException\\": 0,\\n \\"CallsAbandonedInIVR\\": 0,\\n \\"MaxWorkTime\\": 17,\\n \\"TotalHoldTime\\": 0,\\n \\"MaxAbandonTime\\": 0,\\n \\"AverageAbandonTime\\": 0,\\n \\"AbandonedRate\\": 0,\\n \\"CallsRinged\\": 7,\\n \\"CallsQueuingFailed\\": 0,\\n \\"TotalRingTime\\": 32,\\n \\"TotalTalkTime\\": 447,\\n \\"MaxAbandonedInRingTime\\": 0,\\n \\"CallsBlindTransferred\\": 0,\\n \\"AverageAbandonedInIVRTime\\": 0,\\n \\"AverageAbandonedInQueueTime\\": 0,\\n \\"MaxWaitTime\\": 13,\\n \\"AverageTalkTime\\": 64,\\n \\"CallsAttendedTransferred\\": 0,\\n \\"TotalAbandonedInIVRTime\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"TotalAbandonedInRingTime\\": 0,\\n \\"TotalWorkTime\\": 85,\\n \\"AverageWaitTime\\": 5,\\n \\"AverageWorkTime\\": 13,\\n \\"CallsQueued\\": 7,\\n \\"AverageAbandonedInRingTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"MaxAbandonedInQueueTime\\": 0,\\n \\"CallsAbandonedInVoiceNavigator\\": 0,\\n \\"TotalWaitTime\\": 34,\\n \\"MaxTalkTime\\": 219,\\n \\"MaxRingTime\\": 12,\\n \\"TotalAbandonTime\\": 0,\\n \\"CallsOffered\\": 7,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"ServiceLevel20\\": 1,\\n \\"MaxHoldTime\\": 0,\\n \\"CallsForwardToOutsideNumber\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 1,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"CallsAbandonedInQueue\\": 0,\\n \\"TotalAbandonedInQueueTime\\": 0,\\n \\"AbandonRate\\": 0,\\n \\"CallsCausedIVRException\\": 0,\\n \\"CallsToVoicemail\\": 1,\\n \\"AverageFirstResponseTime\\": 6,\\n \\"AverageResponseTime\\": 15,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 8,\\n \\"TotalMessagesSentByCustomer\\": 4\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"CallsBlindTransferred\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsAttendedTransferred\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 0\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"TotalLoggedInTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 0\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>943D8EF3-3321-471F-A104-51C96FCA94D6</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <StatsTime>1620291600000</StatsTime>\\n <Inbound>\\n <ServiceLevel20>1</ServiceLevel20>\\n <CallsAbandonedInQueue>0</CallsAbandonedInQueue>\\n <TotalWorkTime>85</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <CallsRinged>7</CallsRinged>\\n <MaxAbandonedInIVRTime>0</MaxAbandonedInIVRTime>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>12</MaxRingTime>\\n <CallsOffered>7</CallsOffered>\\n <CallsAbandoned>0</CallsAbandoned>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <MaxAbandonedInRingTime>0</MaxAbandonedInRingTime>\\n <TotalRingTime>32</TotalRingTime>\\n <HandleRate>1</HandleRate>\\n <TotalAbandonedInIVRTime>0</TotalAbandonedInIVRTime>\\n <AverageAbandonedInQueueTime>0</AverageAbandonedInQueueTime>\\n <TotalTalkTime>447</TotalTalkTime>\\n <AverageWaitTime>5</AverageWaitTime>\\n <TotalAbandonedInRingTime>0</TotalAbandonedInRingTime>\\n <CallsQueued>7</CallsQueued>\\n <MaxTalkTime>219</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <AverageAbandonedInIVRTime>0</AverageAbandonedInIVRTime>\\n <TotalAbandonTime>0</TotalAbandonTime>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>64</AverageTalkTime>\\n <CallsBlindTransferred>0</CallsBlindTransferred>\\n <CallsAbandonedInIVR>0</CallsAbandonedInIVR>\\n <MaxAbandonedInQueueTime>0</MaxAbandonedInQueueTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <CallsAbandonedInRing>0</CallsAbandonedInRing>\\n <CallsHandled>7</CallsHandled>\\n <MaxWaitTime>13</MaxWaitTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <CallsAttendedTransferred>0</CallsAttendedTransferred>\\n <MaxAbandonTime>0</MaxAbandonTime>\\n <AverageRingTime>5</AverageRingTime>\\n <TotalWaitTime>34</TotalWaitTime>\\n <AverageAbandonTime>0</AverageAbandonTime>\\n <AverageAbandonedInRingTime>0</AverageAbandonedInRingTime>\\n <TotalAbandonedInQueueTime>0</TotalAbandonedInQueueTime>\\n <AverageWorkTime>13</AverageWorkTime>\\n <AbandonedRate>0</AbandonedRate>\\n <MaxWorkTime>17</MaxWorkTime>\\n </Inbound>\\n <Outbound>\\n <TotalDialingTime>0</TotalDialingTime>\\n <TotalWorkTime>0</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <CallsRinged>0</CallsRinged>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>0</MaxRingTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <TotalRingTime>0</TotalRingTime>\\n <AverageDialingTime>0</AverageDialingTime>\\n <CallsAnswered>0</CallsAnswered>\\n <TotalTalkTime>0</TotalTalkTime>\\n <CallsDialed>0</CallsDialed>\\n <MaxDialingTime>0</MaxDialingTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n <AnswerRate>0</AnswerRate>\\n <CallsBlindTransferred>0</CallsBlindTransferred>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <CallsAttendedTransferred>0</CallsAttendedTransferred>\\n <AverageRingTime>0</AverageRingTime>\\n <AverageWorkTime>0</AverageWorkTime>\\n <MaxWorkTime>0</MaxWorkTime>\\n </Outbound>\\n <Overall>\\n <TotalReadyTime>0</TotalReadyTime>\\n <TotalCalls>0</TotalCalls>\\n <TotalBreakTime>0</TotalBreakTime>\\n <TotalWorkTime>0</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <AverageHoldTime>0</AverageHoldTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <AverageBreakTime>0</AverageBreakTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <TotalTalkTime>0</TotalTalkTime>\\n <AverageReadyTime>0</AverageReadyTime>\\n <TotalLoggedInTime>0</TotalLoggedInTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <MaxReadyTime>0</MaxReadyTime>\\n <AverageWorkTime>0</AverageWorkTime>\\n <MaxWorkTime>0</MaxWorkTime>\\n <MaxBreakTime>0</MaxBreakTime>\\n <OccupancyRate>0</OccupancyRate>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n </Overall>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListIntervalSkillGroupReport' => [
'summary' => '调用ListIntervalSkillGroupReport获取指定实例下指定技能组的分段统计报表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccOQKOLI'],
],
'parameters' => [
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skg-default@ccc-test'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,格式为Unix时间戳,单位毫秒,非必填,默认为当天的0时,统计的时间精度为小时,向前取整,闭区间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1604639129000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '截止时间,格式为Unix时间戳,单位毫秒,非必填,默认是当前时间,如果Interval为Daily,StartTime和EndTime最大间隔是180天。如果Interval为Hourly,最大间隔时间为10天。统计的时间精度为小时,向后取整,开区间。例如:开始时间为11:12:20,结束时间为11:45:50,则对齐后的入参时间范围为[11:00:00,12:00:00) ,即大于等于11点,小于12点。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1604725528000'],
],
[
'name' => 'Interval',
'in' => 'query',
'schema' => [
'description' => '分段统计类型,默认为Daily(按天汇总)。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Hourly' => '按小时统计', 'Daily' => '按天统计'],
'example' => 'Hourly',
],
],
[
'name' => 'MediaType',
'in' => 'query',
'schema' => ['description' => '媒体类型,默认是语音(Audio), 其他可选参数包括Chat和Video.', 'type' => 'string', 'required' => false, 'example' => 'VIDEO'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'],
'Data' => [
'description' => '技能组分段统计数据列表。',
'type' => 'array',
'items' => [
'description' => '技能组分段统计数据。',
'type' => 'object',
'properties' => [
'StatsTime' => ['description' => '时间段的开始时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000'],
'Inbound' => [
'description' => '呼入指标。',
'type' => 'object',
'properties' => [
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。计算公式为: TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '11'],
'CallsOverflow' => ['description' => '溢出量,即发生队列(技能组)溢出的电话数量。若一通电话多次进入同一队列,每次溢出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAbandonedInRing' => ['description' => '振铃放弃量,即坐席振铃中客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsHandled' => ['description' => '应答量,即坐席应答的次数。一通电话每次进入队列后,若被多个坐席应答,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '23'],
'TotalAbandonedInRingTime' => ['description' => '总振铃放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '19'],
'CallsAttendedTransferOut' => ['description' => '咨询转出量,即由该技能组发起的咨询转接到其他技能组的电话数量,同一技能组内坐席间的转接不计数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWaitTime' => ['description' => '平均等待时长,平均每通电话的坐席接起前等待时长。计算公式为:TotalWaitTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '11'],
'TotalHoldTime' => ['description' => '总通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxAbandonTime' => ['description' => '最大放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为: TotalWorkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '8'],
'CallsQueued' => ['description' => '呼入场景进入队列(技能组)的电话数量,若一通电话多次进入同一队列,每次进入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'CallsBlindTransferIn' => ['description' => '直接转入量,即由其他技能组发起的直接转接到该技能组的电话数量,同一技能组内坐席间的转接不计数。若一个坐席同时签入多个技能组,则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组,每次转接算一次。下同。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageAbandonedInRingTime' => ['description' => '平均振铃放弃时长,单位秒。计算公式为: TotalAbandonedInRingTime/CallsAbandonedInRing。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageAbandonTime' => ['description' => '平均放弃时长,单位秒。计算公式为:TotalAbandonTime/CallsAbandoned。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsRinged' => ['description' => '坐席振铃的电话数量,一通电话每次进入队列后,若分配给多个座席并产生了振铃,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'CallsBlindTransferOut' => ['description' => '直接转出量,即由该技能组发起的直接转接到其他技能组的电话数量,同一技能组内坐席间的转接不计数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAttendedTransferIn' => ['description' => '咨询转入量,即由其他技能组发起的咨询转接到该技能组的电话数量,同一技能组内坐席间的转接不计数。若一个坐席同时迁入多个技能组,则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组,每次转接算一次。下同。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAbandoned' => ['description' => '放弃量。计算公式为:CallsAbandonedInQueue+CallsAbandonedInRing。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxAbandonedInQueueTime' => ['description' => '最大排队放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalWaitTime' => ['description' => '总等待时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '33'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '33'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '18'],
'AbandonRate' => ['description' => '放弃率。计算公式为:CallsAbandoned/CallsOffered(由于放弃事件与分配事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '9'],
'TotalAbandonTime' => ['description' => '总放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsOffered' => ['description' => '分配量,即分配给该技能组的电话数量,包括通过队列分配的电话数量和通过转接(咨询转接和直接转接)分配的电话数量。计算公式为:CallsQueued+CallsBlindTransferIn+CallsAttentandedTransferIn。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'MaxAbandonedInRingTime' => ['description' => '最大振铃放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWaitTime' => ['description' => '最大等待时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '18'],
'AverageAbandonedInQueueTime' => ['description' => '平均排队放弃时长,单位秒。计算公式为: TotalAbandonedInQueueTime/CallsAbandonedInQueue。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'ServiceLevel20' => ['description' => '20秒服务水平,等待时长小于等于20秒的电话数量/CallsQueued。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为: TotalTalkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '5'],
'CallsHold' => ['description' => '保持量,即发生通话保持的次数。一通电话每次进入队列后,若发生多次通话保持,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'HandleRate' => ['description' => '应答率。计算公式为:CallsHandled/CallsOffered(由于应答事件与分配事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0.6666666666666666'],
'CallsTimeout' => ['description' => '超时量,即发生队列(技能组)超时的电话数量。若一通电话多次进入同一队列,每次超时算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalAbandonedInQueueTime' => ['description' => '总排队放弃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAbandonedInQueue' => ['description' => '队列放弃量,即电话进入队列之后在排队环节客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsQueuingOverflow' => ['description' => '队列溢出的通话数量,即通话在IVR排队时队列溢出。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsQueuingTimeout' => ['description' => '在排队阶段超时的通话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalMessagesSent' => ['description' => 'Chat会话中总消息发送量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'TotalMessagesSentByAgent' => ['description' => 'Chat会话中坐席发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
'TotalMessagesSentByCustomer' => ['description' => 'Chat会话中客户发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'AverageFirstResponseTime' => ['description' => 'Chat会话平均首次响应时长,单位为秒。', 'type' => 'number', 'format' => 'float', 'example' => '6'],
'AverageResponseTime' => ['description' => 'Chat会话平均响应时长。', 'type' => 'number', 'format' => 'float', 'example' => '18'],
],
],
'Outbound' => [
'description' => '呼出指标。',
'type' => 'object',
'properties' => [
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。计算公式为: TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'CallsAttendedTransferOut' => ['description' => '咨询转出量,即由该技能组发起的咨询转接到其他技能组的电话数量,同一技能组内坐席间的转接不计数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
'TotalDialingTime' => ['description' => '总拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '60'],
'TotalHoldTime' => ['description' => '总通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为:TotalWorkTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '3'],
'CallsBlindTransferIn' => ['description' => '直接转入量,即由其他技能组发起的直接转接到该技能组的电话数量,同一技能组内坐席间的转接不计数。若一个坐席同时签入多个技能组,则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组,每次转接算一次。下同。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsRinged' => ['description' => '坐席振铃的电话数量,一通电话每次进入队列后,若分配给多个座席并产生了振铃,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAttendedTransferIn' => ['description' => '咨询转入量,即由其他技能组发起的咨询转接到该技能组的电话数量,同一技能组内坐席间的转接不计数。若一个坐席同时迁入多个技能组,则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组,每次转接算一次。下同。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsBlindTransferOut' => ['description' => '直接转出量,即由该技能组发起的直接转接到其他技能组的电话数量,同一技能组内坐席间的转接不计数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'MaxDialingTime' => ['description' => '最大拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '49'],
'AnswerRate' => ['description' => '接通率,计算公式为:CallsAnswered/CallsDialed(由于接听事件与应答事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为:TotalTalkTime/CallsAnswered。', 'type' => 'number', 'format' => 'float', 'example' => '5'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'CallsHold' => ['description' => '保持量,即发生通话保持的电话数量。一通电话在转出当前技能组之前,若发生多次通话保持,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageDialingTime' => ['description' => '平均拨号时长,单位秒。计算公式为:TotalDialingTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '30'],
],
],
'Overall' => [
'description' => '整体指标。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '13'],
'TotalLoggedInTime' => ['description' => '总登录时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '9236'],
'OccupancyRate' => ['description' => '座席利用率,计算公式为: (TotalworkTime + TotalTalkTime ) / TotalLoggedInTime。', 'type' => 'number', 'format' => 'float', 'example' => '0.00422315148470254'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '27'],
'MaxHoldTime' => ['description' => '最大通话保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '19'],
'AverageBreakTime' => ['description' => '平均小休时长,单位秒。计算公式为:TotalBreakTime/小休次数。小休次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalHoldTime' => ['description' => '总保持时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionRate' => ['description' => '满意率,计算公式为:标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'MaxBreakTime' => ['description' => '最大小休时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为:TotalWorkTime/TotalCalls。', 'type' => 'number', 'format' => 'float', 'example' => '6'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。计算公式为: TotalTalkTime/(CallsAnswered+CallsHandled)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxReadyTime' => ['description' => '最大就绪时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '4927'],
'AverageReadyTime' => ['description' => '平均就绪时长,单位秒。计算公式为:TotalReadyTime/就绪次数。就绪次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageHoldTime' => ['description' => '平均通话保持时长,单位秒。计算公式为:TotalHoldTime/(呼入CallsHold+呼出CallsHold)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalReadyTime' => ['description' => '总就绪时长,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '9106'],
'TotalBreakTime' => ['description' => '总小休时长,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'],
'TotalCalls' => ['description' => '总电话量。计算公式为:CallsOffered + CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'BreakCodeDetailList' => [
'description' => '各类型小休统计数据。',
'type' => 'array',
'items' => [
'description' => '小休统计数据。',
'type' => 'object',
'properties' => [
'BreakCode' => ['description' => '小休类型代码。', 'type' => 'string', 'example' => '会议'],
'Count' => ['description' => '此类型小休的发生次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Duration' => ['description' => '此类型小休的总计发生时长,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'],
],
],
],
],
],
'Back2Back' => [
'description' => '双呼指标。',
'type' => 'object',
'properties' => [
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageCustomerRingTime' => ['description' => '平均客户侧振铃时长,单位秒', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'CallsCustomerAnswered' => ['description' => '客户接听电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'CustomerAnswerRate' => ['description' => '客户接通率。', 'type' => 'number', 'format' => 'float', 'example' => '0.6'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
'MaxCustomerRingTime' => ['description' => '最大客户侧振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalCustomerRingTime' => ['description' => '总客户侧振岭时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'AgentHandleRate' => ['description' => '坐席应答率。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'string', 'example' => '100'],
'AnswerRate' => ['description' => '接通率,计算公式为:CallsAnswered/CallsDialed(由于接听事件与应答事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'string', 'example' => '0.5'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。', 'type' => 'string', 'example' => '100'],
'CallsAgentHandled' => ['description' => '坐席接听电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
],
'title' => '获取技能组分段统计报表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-22T01:05:26.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalSkillGroupReport'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": [\\n {\\n \\"StatsTime\\": 1604639129000,\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 11,\\n \\"CallsOverflow\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"CallsHandled\\": 2,\\n \\"TotalWorkTime\\": 23,\\n \\"TotalAbandonedInRingTime\\": 0,\\n \\"MaxWorkTime\\": 19,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"AverageWaitTime\\": 11,\\n \\"TotalHoldTime\\": 0,\\n \\"MaxAbandonTime\\": 0,\\n \\"AverageWorkTime\\": 8,\\n \\"CallsQueued\\": 3,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"AverageAbandonedInRingTime\\": 0,\\n \\"AverageAbandonTime\\": 0,\\n \\"CallsRinged\\": 3,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"MaxAbandonedInQueueTime\\": 0,\\n \\"TotalWaitTime\\": 33,\\n \\"TotalRingTime\\": 33,\\n \\"MaxTalkTime\\": 6,\\n \\"MaxRingTime\\": 18,\\n \\"AbandonRate\\": 0,\\n \\"TotalTalkTime\\": 9,\\n \\"TotalAbandonTime\\": 0,\\n \\"CallsOffered\\": 3,\\n \\"MaxAbandonedInRingTime\\": 0,\\n \\"MaxWaitTime\\": 18,\\n \\"AverageAbandonedInQueueTime\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"AverageTalkTime\\": 5,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0.6666666666666666,\\n \\"CallsTimeout\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalAbandonedInQueueTime\\": 0,\\n \\"CallsAbandonedInQueue\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 7,\\n \\"TotalMessagesSentByCustomer\\": 5,\\n \\"AverageFirstResponseTime\\": 6,\\n \\"AverageResponseTime\\": 18\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 2,\\n \\"CallsAnswered\\": 1,\\n \\"TotalWorkTime\\": 5,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 4,\\n \\"TotalDialingTime\\": 60,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 3,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 5,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 5,\\n \\"MaxDialingTime\\": 49,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 5,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 30\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 13,\\n \\"TotalLoggedInTime\\": 9236,\\n \\"OccupancyRate\\": 0.00422315148470254,\\n \\"TotalWorkTime\\": 27,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 19,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 1,\\n \\"AverageWorkTime\\": 6,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 4927,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 9106,\\n \\"TotalBreakTime\\": 5,\\n \\"MaxTalkTime\\": 6,\\n \\"TotalCalls\\": 5,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"会议\\",\\n \\"Count\\": 1,\\n \\"Duration\\": 120\\n }\\n ]\\n },\\n \\"Back2Back\\": {\\n \\"MaxRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"CallsCustomerAnswered\\": 12,\\n \\"CustomerAnswerRate\\": 0.6,\\n \\"TotalRingTime\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"AgentHandleRate\\": 1,\\n \\"MaxTalkTime\\": \\"100\\",\\n \\"AnswerRate\\": \\"0.5\\",\\n \\"AverageTalkTime\\": \\"100\\",\\n \\"CallsAgentHandled\\": 5\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>943D8EF3-3321-471F-A104-51C96FCA94D6</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <StatsTime>1604639129000</StatsTime>\\n <Inbound>\\n <ServiceLevel20>0</ServiceLevel20>\\n <CallsAbandonedInQueue>0</CallsAbandonedInQueue>\\n <TotalWorkTime>23</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <CallsRinged>3</CallsRinged>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>18</MaxRingTime>\\n <CallsOffered>3</CallsOffered>\\n <CallsAbandoned>0</CallsAbandoned>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <MaxAbandonedInRingTime>0</MaxAbandonedInRingTime>\\n <TotalRingTime>33</TotalRingTime>\\n <HandleRate>0.6666666666666666</HandleRate>\\n <AverageAbandonedInQueueTime>0</AverageAbandonedInQueueTime>\\n <TotalTalkTime>9</TotalTalkTime>\\n <AverageWaitTime>11</AverageWaitTime>\\n <TotalAbandonedInRingTime>0</TotalAbandonedInRingTime>\\n <CallsQueued>3</CallsQueued>\\n <MaxTalkTime>6</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <CallsAttendedTransferOut>0</CallsAttendedTransferOut>\\n <TotalAbandonTime>0</TotalAbandonTime>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>5</AverageTalkTime>\\n <MaxAbandonedInQueueTime>0</MaxAbandonedInQueueTime>\\n <CallsTimeout>0</CallsTimeout>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <CallsAbandonedInRing>0</CallsAbandonedInRing>\\n <CallsOverflow>0</CallsOverflow>\\n <CallsHandled>2</CallsHandled>\\n <MaxWaitTime>18</MaxWaitTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <CallsAttendedTransferIn>0</CallsAttendedTransferIn>\\n <MaxAbandonTime>0</MaxAbandonTime>\\n <AverageRingTime>11</AverageRingTime>\\n <TotalWaitTime>33</TotalWaitTime>\\n <AverageAbandonTime>0</AverageAbandonTime>\\n <AverageAbandonedInRingTime>0</AverageAbandonedInRingTime>\\n <TotalAbandonedInQueueTime>0</TotalAbandonedInQueueTime>\\n <CallsBlindTransferOut>0</CallsBlindTransferOut>\\n <AverageWorkTime>8</AverageWorkTime>\\n <MaxWorkTime>19</MaxWorkTime>\\n <CallsBlindTransferIn>0</CallsBlindTransferIn>\\n <AbandonRate>0</AbandonRate>\\n </Inbound>\\n <Outbound>\\n <TotalDialingTime>60</TotalDialingTime>\\n <TotalWorkTime>5</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <AverageHoldTime>0</AverageHoldTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <AverageDialingTime>30</AverageDialingTime>\\n <CallsAnswered>1</CallsAnswered>\\n <TotalTalkTime>5</TotalTalkTime>\\n <CallsDialed>2</CallsDialed>\\n <MaxDialingTime>49</MaxDialingTime>\\n <MaxTalkTime>5</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <AverageWorkTime>3</AverageWorkTime>\\n <MaxWorkTime>4</MaxWorkTime>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>5</AverageTalkTime>\\n <AnswerRate>0</AnswerRate>\\n </Outbound>\\n <Overall>\\n <TotalReadyTime>9106</TotalReadyTime>\\n <TotalCalls>5</TotalCalls>\\n <TotalBreakTime>5</TotalBreakTime>\\n <TotalWorkTime>27</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <AverageHoldTime>0</AverageHoldTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <AverageBreakTime>0</AverageBreakTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <TotalTalkTime>13</TotalTalkTime>\\n <AverageReadyTime>0</AverageReadyTime>\\n <TotalLoggedInTime>9236</TotalLoggedInTime>\\n <MaxTalkTime>6</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <MaxReadyTime>4927</MaxReadyTime>\\n <AverageWorkTime>6</AverageWorkTime>\\n <MaxWorkTime>19</MaxWorkTime>\\n <MaxBreakTime>1</MaxBreakTime>\\n <OccupancyRate>0.00422315148470254</OccupancyRate>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n </Overall>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListIvrTrackingDetails' => [
'summary' => '调用ListIvrTrackingDetails获取指定实例下指定通话的IVR轨迹详情。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc5HY0NN'],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10'],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-10963442671187****'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D2RB671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'List' => [
'description' => 'IVR轨迹详情列表。',
'type' => 'array',
'items' => [
'description' => 'IVR轨迹详情。',
'type' => 'object',
'properties' => [
'Instance' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Callee' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '0533128****'],
'EnterTime' => ['description' => '进入该IVR节点的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1621910542876'],
'NodeVariables' => ['description' => '节点变量。', 'type' => 'object', 'example' => '{"digits":"2"}'],
'NodeExitCode' => [
'description' => '节点的状态码。',
'type' => 'string',
'enumValueTitles' => ['Timeout' => '队列/函数/收号等超时', 'Hangup' => '客户挂机', 'Default' => '逻辑判断缺省出口', 'Branch-A/B/C' => '各个逻辑判断出口', 'Success' => '成功', 'Failure' => '失败', 'Overflow' => '队列溢出'],
'example' => 'Success',
],
'FlowName' => ['description' => '联系流名称。', 'type' => 'string', 'example' => '测试IVR'],
'FlowId' => ['description' => '联系流ID。', 'type' => 'string', 'example' => 'abc99462-1058-47d0-a114-f145ea7444ff'],
'NodeProperties' => ['description' => '节点的属性集合。', 'type' => 'object', 'example' => '{"say":"您好。"}'],
'NodeType' => [
'description' => '节点类型。',
'type' => 'string',
'enumValueTitles' => [
'ASR' => '语音识别', 'SUB' => '子流程', 'INCOMING_CALL' => '开始', 'GATHER_INPUT' => '收号', 'SUB_END' => '子流程结束', 'BLIND_TRANSFER' => '直接转接', 'JSON_PARSER' => 'JSON解析', 'SUB_START' => '子流程开始', 'SATISFACTION_RATING' => '满意度收集', 'TRANSFER_TO_AGENT' => '转人工',
'SPLIT' => '分支', 'SET_VARIABLES' => '设置变量', 'VOICE_NAVIGATOR' => '智能导航', 'PLAY_SAY' => '放音', 'HANGUP_REASON' => '挂机原因', 'HANGUP' => '结束', 'SMS' => '发短信', 'VOICE_MAIL' => '语音信箱', 'RUN_FUNCTION' => '函数计算', 'HTTP_REQUEST' => 'HTTP请求',
'FORWARD_TO_OUTSIDE_NUMBER' => '转外线',
],
'example' => 'PLAY_SAY',
],
'Caller' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '1332315****'],
'NodeName' => ['description' => '节点名称。', 'type' => 'string', 'example' => '放音'],
'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-10963442671187****'],
'LeaveTime' => ['description' => '离开该IVR节点的时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1621910545105'],
'ChannelVariables' => ['description' => '随路数据。', 'type' => 'string', 'example' => 'A=B;C=D'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => '65cp2c15-92ac-4e67-98b2-073a3c541c5d'],
'NodeId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'e0bc19a3'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'],
],
500 => [
['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'],
],
],
'title' => '获取IVR轨迹详情列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIvrTrackingDetails'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"D2RB671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"List\\": [\\n {\\n \\"Instance\\": \\"ccc-test\\",\\n \\"Callee\\": \\"0533128****\\",\\n \\"EnterTime\\": 1621910542876,\\n \\"NodeVariables\\": {\\n \\"digits\\": \\"2\\"\\n },\\n \\"NodeExitCode\\": \\"Success\\",\\n \\"FlowName\\": \\"测试IVR\\",\\n \\"FlowId\\": \\"abc99462-1058-47d0-a114-f145ea7444ff\\",\\n \\"NodeProperties\\": {\\n \\"say\\": \\"您好。\\"\\n },\\n \\"NodeType\\": \\"PLAY_SAY\\",\\n \\"Caller\\": \\"1332315****\\",\\n \\"NodeName\\": \\"放音\\",\\n \\"ContactId\\": \\"job-10963442671187****\\",\\n \\"LeaveTime\\": 1621910545105,\\n \\"ChannelVariables\\": \\"A=B;C=D\\",\\n \\"ChannelId\\": \\"65cp2c15-92ac-4e67-98b2-073a3c541c5d\\",\\n \\"NodeId\\": \\"e0bc19a3\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>D2RB671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>4</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Callee>053xxxx3128</Callee>\\n <NodeName>放音</NodeName>\\n <Instance>ccc-test</Instance>\\n <EnterTime>1621910542876</EnterTime>\\n <NodeExitCode>Success</NodeExitCode>\\n <ContactId>job-109634426711871319</ContactId>\\n <ChannelId>65cp2c15-92ac-4e67-98b2-073a3c541c5d</ChannelId>\\n <ChannelVariables>A=B;C=D</ChannelVariables>\\n <FlowId>abc99462-1058-47d0-a114-f145ea7444ff</FlowId>\\n <LeaveTime>1621910545105</LeaveTime>\\n <NodeProperties>{\\"say\\":\\"您好。\\"}</NodeProperties>\\n <Caller>133xxxx2315</Caller>\\n <FlowName>测试IVR</FlowName>\\n <NodeType>PLAY_OR_SAY</NodeType>\\n <NodeId>e0bc19a3</NodeId>\\n <NodeVariables>{\\"digits\\":\\"2\\"}</NodeVariables>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListLegacyAgentEventLogs' => [
'summary' => '调用ListLegacyAgentEventLogs获取1.0遗留坐席事件日志列表,该接口仅对特定用户开放,其他客户不建议调用。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-1000。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1657853640015'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1658026440011'],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => ['description' => '按坐席ID过滤,非必填,默认为空,为空表示不过滤。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2802EE59-3B53-513A-A130-85E480AF689D'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'List' => [
'description' => '坐席事件日志列表',
'type' => 'array',
'items' => [
'description' => '坐席事件日志。',
'type' => 'object',
'properties' => [
'TargetSelect' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'TargetRequest' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'StatisticDate' => ['description' => '统计时刻。', 'type' => 'string', 'example' => '2021-12-03T10:15:30'],
'PhoneNo' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8012****'],
'GroupNo' => ['description' => '坐席签入的技能组ID列表,多个技能组ID用逗号分割。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test,skillgroup2@ccc-test'],
'Event' => [
'description' => '事件类型。',
'type' => 'string',
'enumValueTitles' => ['拨号' => '拨号', '振铃' => '振铃', '处理' => '处理'],
'example' => '拨号',
],
'ConnId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => '345467****'],
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => ['呼入' => '呼入', '呼出' => '呼出'],
'example' => '呼入',
],
'CallId' => ['description' => '通话ID。', 'type' => 'string', 'example' => '378654****'],
'CallerId' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '08331111****'],
'CalleeId' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '1312343****'],
'AgentNo' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'AgentDropCall' => ['description' => '是否为坐席挂机。', 'type' => 'string', 'example' => 'false'],
'TransferNumber' => ['description' => '转接号码。', 'type' => 'string', 'example' => '07518888****'],
'CallDir' => [
'description' => '呼叫方向。',
'type' => 'string',
'enumValueTitles' => ['内部' => '内部', '外部' => '外部'],
'example' => '内部',
],
'CallMode' => [
'description' => '通话模式。',
'type' => 'string',
'enumValueTitles' => ['呼入' => '呼入', '呼出' => '呼出'],
'example' => '呼入',
],
'TenantId' => ['description' => '租户ID。', 'type' => 'string', 'example' => 'acc101'],
'OutboundScenario' => ['description' => '坐席是否为仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
],
],
],
],
],
],
'description' => '',
],
],
],
'staticInfo' => [
'substitutions' => ['CCC::2020-07-01::ListAgentStateLogs'],
],
'title' => '获取遗留坐席事件日志列表',
'changeSet' => [
['createdAt' => '2022-07-05T09:31:24.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLegacyAgentEventLogs'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2802EE59-3B53-513A-A130-85E480AF689D\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"TargetSelect\\": \\"skillgroup@ccc-test\\",\\n \\"TargetRequest\\": \\"skillgroup@ccc-test\\",\\n \\"StatisticDate\\": \\"2021-12-03T10:15:30\\",\\n \\"PhoneNo\\": \\"8012****\\",\\n \\"GroupNo\\": \\"skillgroup1@ccc-test,skillgroup2@ccc-test\\",\\n \\"Event\\": \\"拨号\\",\\n \\"ConnId\\": \\"345467****\\",\\n \\"CallType\\": \\"呼入\\",\\n \\"CallId\\": \\"378654****\\",\\n \\"CallerId\\": \\"08331111****\\",\\n \\"CalleeId\\": \\"1312343****\\",\\n \\"AgentNo\\": \\"agent@ccc-test\\",\\n \\"AgentDropCall\\": \\"false\\",\\n \\"TransferNumber\\": \\"07518888****\\",\\n \\"CallDir\\": \\"内部\\",\\n \\"CallMode\\": \\"呼入\\",\\n \\"TenantId\\": \\"acc101\\",\\n \\"OutboundScenario\\": false\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListLegacyAgentStatusLogs' => [
'summary' => '调用ListLegacyAgentStatusLogs获取1.0遗留坐席状态日志列表,该接口仅对特定用户开放,其他客户不建议调用。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1657778840011'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1657879880010'],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => ['description' => '按坐席ID过滤,非必填,默认为空,为空表示不过滤。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4C9A5D93-33A6-57F3-A423-4C83BD0A8455'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'List' => [
'description' => '坐席状态数据列表。',
'type' => 'array',
'items' => [
'description' => '坐席状态数据。',
'type' => 'object',
'properties' => [
'TransferNo' => ['description' => '转接号码。', 'type' => 'string', 'example' => '07551231****'],
'TargetSelect' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'TargetRequest' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Status' => [
'description' => '坐席状态。',
'type' => 'string',
'enumValueTitles' => ['拨号' => '拨号', '振铃' => '振铃', '处理' => '处理', '小休' => '小休'],
'example' => '振铃',
],
'StatisticDate' => ['description' => '统计时刻。', 'type' => 'string', 'example' => '2021-12-03T10:15:30'],
'StatisticTime' => ['description' => '状态持续时间,单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'PhoneNo' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8012****'],
'MonitedAgentPhoneNo' => ['description' => '被监听号码。', 'type' => 'string', 'example' => '8012****'],
'MonitedAgentNo' => ['description' => '监听号码。', 'type' => 'string', 'example' => '8032****'],
'GroupNo' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'ConnId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => '487326****'],
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => ['呼入' => '呼入', '呼出' => '呼出'],
'example' => '呼入',
],
'CallId' => ['description' => '通话ID。', 'type' => 'string', 'example' => '454326****'],
'CallerId' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '08337676****'],
'CalleeId' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '1312121****'],
'CallDir' => [
'description' => '呼叫方向。',
'type' => 'string',
'enumValueTitles' => ['内部' => '内部', '外部' => '外部'],
'example' => '内部',
],
'AgentNo' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'AgentDropCall' => ['description' => '是否为坐席挂机。', 'type' => 'string', 'example' => 'false'],
'AliHangupCause' => ['description' => '挂断原因。', 'type' => 'string', 'example' => '无'],
'TransferNumber' => ['description' => '转接号码。', 'type' => 'string', 'example' => '05711231****'],
'Extend1' => ['description' => '自定义扩展字段。', 'type' => 'string', 'example' => '无'],
'Extend2' => ['description' => '自定义扩展字段。', 'type' => 'string', 'example' => '无'],
'Extend3' => ['description' => '自定义扩展字段。', 'type' => 'string', 'example' => '无'],
'Extend4' => ['description' => '自定义扩展字段。', 'type' => 'string', 'example' => '无'],
'TenantId' => ['description' => '租户ID。', 'type' => 'string', 'example' => 'acc6736'],
'OutboundScenario' => ['description' => '坐席是否为仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
],
],
],
],
],
],
'description' => '',
],
],
],
'staticInfo' => [
'substitutions' => ['CCC::2020-07-01::ListAgentStateLogs'],
],
'title' => '获取遗留坐席状态日志列表',
'changeSet' => [
['createdAt' => '2022-07-05T09:31:24.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLegacyAgentStatusLogs'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"4C9A5D93-33A6-57F3-A423-4C83BD0A8455\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"TransferNo\\": \\"07551231****\\",\\n \\"TargetSelect\\": \\"skillgroup@ccc-test\\",\\n \\"TargetRequest\\": \\"skillgroup@ccc-test\\",\\n \\"Status\\": \\"振铃\\",\\n \\"StatisticDate\\": \\"2021-12-03T10:15:30\\",\\n \\"StatisticTime\\": 3,\\n \\"PhoneNo\\": \\"8012****\\",\\n \\"MonitedAgentPhoneNo\\": \\"8012****\\",\\n \\"MonitedAgentNo\\": \\"8032****\\",\\n \\"GroupNo\\": \\"skillgroup@ccc-test\\",\\n \\"ConnId\\": \\"487326****\\",\\n \\"CallType\\": \\"呼入\\",\\n \\"CallId\\": \\"454326****\\",\\n \\"CallerId\\": \\"08337676****\\",\\n \\"CalleeId\\": \\"1312121****\\",\\n \\"CallDir\\": \\"内部\\",\\n \\"AgentNo\\": \\"agent@ccc-test\\",\\n \\"AgentDropCall\\": \\"false\\",\\n \\"AliHangupCause\\": \\"无\\",\\n \\"TransferNumber\\": \\"05711231****\\",\\n \\"Extend1\\": \\"无\\",\\n \\"Extend2\\": \\"无\\",\\n \\"Extend3\\": \\"无\\",\\n \\"Extend4\\": \\"无\\",\\n \\"TenantId\\": \\"acc6736\\",\\n \\"OutboundScenario\\": false\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListLegacyQueueEventLogs' => [
'summary' => '调用ListLegacyQueueEventLogs获取1.0遗留队列事件日志列表,该接口仅对特定用户开放,其他客户不建议调用。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-1000。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1657939540015'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1658026180018'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '按技能组ID过滤,非必填,默认为空,为空表示不过滤。', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1A5A8998-41F9-5F85-BFCF-EB2B6E376812'],
'Success' => ['description' => '是否调用成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'List' => [
'description' => '队列事件日志列表。',
'type' => 'array',
'items' => [
'description' => '队列事件日志。',
'type' => 'object',
'properties' => [
'Vq' => ['description' => '队列名称。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'StatisticDate' => ['description' => '统计日期。', 'type' => 'string', 'example' => '2021-12-03T10:15:30'],
'QueueTime' => ['description' => '队列时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Ani' => ['description' => '主叫', 'type' => 'string', 'example' => '8012****'],
'Dnis' => ['description' => '被叫。', 'type' => 'string', 'example' => '1312211****'],
'Cause' => [
'description' => '挂机原因。',
'type' => 'string',
'enumValueTitles' => ['队列呼损' => '队列呼损', '正常' => '正常', '久振呼损' => '久振呼损'],
'example' => '正常',
],
'AnswerTime' => ['description' => '应答时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'],
'AnswerPhone' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Acid' => ['description' => '通话ID。', 'type' => 'string', 'example' => '456328****'],
'TenantId' => ['description' => '租户ID。', 'type' => 'string', 'example' => 'acc3733'],
'Id' => ['description' => '主键', 'type' => 'integer', 'format' => 'int64', 'example' => '109160'],
],
],
],
],
],
],
'description' => '',
],
],
],
'title' => '获取遗留队列事件日志列表',
'changeSet' => [
['createdAt' => '2022-07-05T09:31:24.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLegacyQueueEventLogs'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"1A5A8998-41F9-5F85-BFCF-EB2B6E376812\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"Vq\\": \\"skillgroup@ccc-test\\",\\n \\"StatisticDate\\": \\"2021-12-03T10:15:30\\",\\n \\"QueueTime\\": 10,\\n \\"Ani\\": \\"8012****\\",\\n \\"Dnis\\": \\"1312211****\\",\\n \\"Cause\\": \\"正常\\",\\n \\"AnswerTime\\": 15,\\n \\"AnswerPhone\\": \\"agent@ccc-test\\",\\n \\"Acid\\": \\"456328****\\",\\n \\"TenantId\\": \\"acc3733\\",\\n \\"Id\\": 109160\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListMonoRecordings' => [
'summary' => '调用ListMonoRecordings获取指定实例下指定通话的各通话方的单轨录音,通话中每一方都有一个话务通道,每个话务通道对应生成一个合轨录音,格式为WAV。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc5HY0NN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-25697383427137****'],
],
[
'name' => 'AgentChannelId',
'in' => 'query',
'schema' => ['title' => '坐席对话channelId', 'description' => '坐席对话channelId', 'type' => 'string', 'required' => false, 'example' => 'ch-user-****-****-1772180844645-job-*****'],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => ['title' => '坐席ID', 'description' => '坐席ID', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E836EF2A-EDAE-5310-8921-F983C967D42D'],
'Data' => [
'description' => '录音信息列表。',
'type' => 'array',
'items' => [
'description' => '录音信息。',
'type' => 'object',
'properties' => [
'FileName' => ['description' => '录音文件名称。', 'type' => 'string', 'example' => 'job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.wav'],
'FileUrl' => ['description' => '录音文件的OSS下载地址,注意下载地址的过期时间,下载地址的有效期为1天。', 'type' => 'string', 'example' => 'https://ccc-v2-shanghai.oss-cn-shanghai.aliyuncs.com/ccc-test/job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.wav?Expires=1657014031&OSSAccessKeyId=****&Signature=****'],
'AgentId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'AgentName' => ['description' => '坐席名称。', 'type' => 'string', 'example' => '坐席小王'],
'StartTime' => ['description' => '录音开始时间,格式为Unix时间戳,单位毫秒。', 'type' => 'string', 'example' => '1620259200000'],
'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-25920271311543****'],
'Duration' => ['description' => '录音时长,单位毫秒。', 'type' => 'string', 'example' => '5903871'],
'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'RamId' => ['description' => '坐席对应的RAM账号ID。', 'type' => 'string', 'example' => '26972543893791****'],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"E836EF2A-EDAE-5310-8921-F983C967D42D\\",\\n \\"Data\\": [\\n {\\n \\"FileName\\": \\"job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.wav\\",\\n \\"FileUrl\\": \\"https://ccc-v2-shanghai.oss-cn-shanghai.aliyuncs.com/ccc-test/job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.wav?Expires=1657014031&OSSAccessKeyId=****&Signature=****\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"StartTime\\": \\"1620259200000\\",\\n \\"ContactId\\": \\"job-25920271311543****\\",\\n \\"Duration\\": \\"5903871\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"RamId\\": \\"26972543893791****\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取单轨录音列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMonoRecordings'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ListMultiChannelRecordings' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc5HY0NN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => ['title' => '通话ID', 'description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-25920271311543****'],
],
[
'name' => 'AgentChannelId',
'in' => 'query',
'schema' => ['title' => '坐席通话ChannelId', 'description' => '坐席通话ChannelId', 'type' => 'string', 'required' => false, 'example' => 'ch-user-****-****-1772180844645-job-******'],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => ['title' => '坐席ID', 'description' => '坐席ID', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B19CD719-9F65-56A6-8B79-DA4282EA4797'],
'Data' => [
'description' => '录音列表。',
'type' => 'array',
'items' => [
'description' => '录音。',
'type' => 'object',
'properties' => [
'FileName' => ['description' => '录音文件名称。', 'type' => 'string', 'example' => 'job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.mkv'],
'FileUrl' => ['description' => '录音文件的OSS下载地址,注意下载地址的过期时间,下载地址的有效期为1天。', 'type' => 'string', 'example' => 'https://ccc-v2-shanghai.oss-cn-shanghai.aliyuncs.com/ccc-test/job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.mkv?Expires=1657014031&OSSAccessKeyId=****&Signature=****'],
'AgentId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'AgentName' => ['description' => '坐席名称。', 'type' => 'string', 'example' => '坐席小王'],
'StartTime' => ['description' => '录音开始时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1656926518491'],
'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-25920271311543****'],
'Duration' => ['description' => '录音时长,单位毫秒。', 'type' => 'string', 'example' => '56321'],
'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'RamId' => ['description' => '坐席对应的RAM账号ID。', 'type' => 'string', 'example' => '22807673106369****'],
'AgentChannelId' => ['description' => '坐席话务通道ID。', 'type' => 'string', 'example' => 'ch-user-8526899****-8602****-1656926504363-job-25920271311543****'],
'HoldTimeSegments' => [
'description' => '通话保持的时间片段列表。',
'type' => 'array',
'items' => [
'description' => '通话保持的时间片段。',
'type' => 'object',
'properties' => [
'StartTime' => ['description' => '通话保持的开始时间,单位是毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1673255098049'],
'EndTime' => ['description' => '通话保持的结束时间,单位是毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1687860143925'],
],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取多通道录音列表',
'summary' => '调用ListMultiChannelRecordings获取指定实例下指定通话的各通话方的多轨录音,通话中每一方都有一个话务通道,每个话务通道对应一个多轨录音,格式为MKV。',
'changeSet' => [
['createdAt' => '2023-05-08T07:40:07.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMultiChannelRecordings'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"B19CD719-9F65-56A6-8B79-DA4282EA4797\\",\\n \\"Data\\": [\\n {\\n \\"FileName\\": \\"job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.mkv\\",\\n \\"FileUrl\\": \\"https://ccc-v2-shanghai.oss-cn-shanghai.aliyuncs.com/ccc-test/job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.mkv?Expires=1657014031&OSSAccessKeyId=****&Signature=****\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"StartTime\\": 1656926518491,\\n \\"ContactId\\": \\"job-25920271311543****\\",\\n \\"Duration\\": \\"56321\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"RamId\\": \\"22807673106369****\\",\\n \\"AgentChannelId\\": \\"ch-user-8526899****-8602****-1656926504363-job-25920271311543****\\",\\n \\"HoldTimeSegments\\": [\\n {\\n \\"StartTime\\": 1673255098049,\\n \\"EndTime\\": 1687860143925\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'ListNotificationRecords' => [
'summary' => '查询非MQ方式消息推送记录。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccUU766R'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'NotificationKeys',
'in' => 'query',
'schema' => ['description' => '待查询消息Key列表。比如,通话ID, 可以查询出对应通话ID的所有消息。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => '["job-468a63a2-****-****-****-b1ecf726d4be","job-532a63a2-****-****-****-bcccc26d4cc"]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3'],
'Data' => [
'description' => '数据。',
'type' => 'array',
'items' => [
'description' => '消息列表。',
'type' => 'object',
'properties' => [
'NotificationType' => ['description' => '消息类型。', 'type' => 'string', 'example' => 'Dialing'],
'NotificationKey' => ['description' => '消息Key', 'type' => 'string', 'example' => 'job-468a63a2-****-****-****-b1ecf726d4be'],
'Content' => ['description' => '消息内容。', 'type' => 'string', 'example' => '{'."\n"
.' "agentId": "agent@ccc-test",'."\n"
.' "callType": "OUTBOUND",'."\n"
.' "callee": "13****00",'."\n"
.' "caller": "05****81",'."\n"
.' "channelId": "ch-user-13****00-05****81-1772619731285-job-*****",'."\n"
.' "contactId": "job-*****",'."\n"
.' "eventTime": "2026-03-04T10:22:11.309Z",'."\n"
.' "eventType": "Dialing",'."\n"
.' "instanceId": "ccc-test",'."\n"
.' "mediaType": "AUDIO",'."\n"
.' "skillGroupId": "skill@ccc-test"'."\n"
.'}'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
],
],
],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '查询非MQ方式消息推送记录',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"0630E5DF-CEB0-445B-8626-D5C7481181C3\\",\\n \\"Data\\": [\\n {\\n \\"NotificationType\\": \\"Dialing\\",\\n \\"NotificationKey\\": \\"job-468a63a2-****-****-****-b1ecf726d4be\\",\\n \\"Content\\": \\"{\\\\n\\\\t\\\\\\"agentId\\\\\\": \\\\\\"agent@ccc-test\\\\\\",\\\\n\\\\t\\\\\\"callType\\\\\\": \\\\\\"OUTBOUND\\\\\\",\\\\n\\\\t\\\\\\"callee\\\\\\": \\\\\\"13****00\\\\\\",\\\\n\\\\t\\\\\\"caller\\\\\\": \\\\\\"05****81\\\\\\",\\\\n\\\\t\\\\\\"channelId\\\\\\": \\\\\\"ch-user-13****00-05****81-1772619731285-job-*****\\\\\\",\\\\n\\\\t\\\\\\"contactId\\\\\\": \\\\\\"job-*****\\\\\\",\\\\n\\\\t\\\\\\"eventTime\\\\\\": \\\\\\"2026-03-04T10:22:11.309Z\\\\\\",\\\\n\\\\t\\\\\\"eventType\\\\\\": \\\\\\"Dialing\\\\\\",\\\\n\\\\t\\\\\\"instanceId\\\\\\": \\\\\\"ccc-test\\\\\\",\\\\n\\\\t\\\\\\"mediaType\\\\\\": \\\\\\"AUDIO\\\\\\",\\\\n\\\\t\\\\\\"skillGroupId\\\\\\": \\\\\\"skill@ccc-test\\\\\\"\\\\n}\\",\\n \\"InstanceId\\": \\"ccc-test\\"\\n }\\n ],\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
],
'ListOutboundNumbersOfUser' => [
'summary' => '调用ListOutboundNumbersOfUser获取指定实例下指定坐席的可外呼号码。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'SkillGroupIdList',
'in' => 'query',
'schema' => ['description' => '签入技能组ID列表,非必填,默认为空,表示查询UserId归属的所有技能组的外呼号码,如果有值,则查询该值指定的技能组下的外呼号码。注意,此处传入的技能组ID必须是UserId所在的技能组的ID。', 'type' => 'string', 'required' => false, 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'List' => [
'description' => '号码列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '0830019****'],
'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '乐山'],
'Province' => ['description' => '号码归属地省。'."\n"
."\n", 'type' => 'string', 'example' => '四川'],
'Provider' => ['type' => 'string', 'description' => ''],
'ProviderCode' => ['type' => 'string', 'deprecated' => true, 'description' => ''],
'ProviderDisplayName' => ['type' => 'string', 'deprecated' => true, 'description' => ''],
'ProviderShortName' => ['type' => 'string', 'description' => ''],
'ProviderType' => [
'type' => 'string',
'enum' => ['THIRD_PARTY', 'SELF_HOSTED'],
'description' => '',
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
],
'title' => '获取坐席的外呼号码列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-07-15T12:01:46.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-06-12T11:54:29.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOutboundNumbersOfUser'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Number\\": \\"0830019****\\",\\n \\"City\\": \\"乐山\\",\\n \\"Province\\": \\"四川\\",\\n \\"Provider\\": \\"\\",\\n \\"ProviderCode\\": \\"\\",\\n \\"ProviderDisplayName\\": \\"\\",\\n \\"ProviderShortName\\": \\"\\",\\n \\"ProviderType\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<TotalCount>1</TotalCount>\\n<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<PageSize>10</PageSize>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <City>乐山</City>\\n <Number>083xxxx0019</Number>\\n <Province>四川</Province>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListPersonalNumbersOfUser' => [
'summary' => '调用ListPersonalNumbersOfUser获取指定实例下指定坐席的个人外呼号码列表,也可通过该接口反查可添加为坐席个人外呼号码的号码列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'user-test@ccc-test'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'IsMember',
'in' => 'query',
'schema' => ['description' => '是否关联坐席,若为true,则查询UserId关联的个人外呼号码列表,若为false,则查询UserId可关联但未关联的个人外呼号码列表。通常和AddPersonalNumbersToUser接口一起使用。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
[
'name' => 'SearchPattern',
'in' => 'query',
'schema' => ['description' => '根据号码进行模糊匹配,非必填,不填默认为空。', 'type' => 'string', 'required' => false, 'example' => '0833'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'List' => [
'description' => '号码列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Active' => ['description' => '号码是否可用。', 'type' => 'boolean', 'example' => 'true'],
'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '08330011****'],
'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '乐山'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'ContactFlowId' => ['description' => '该号码关联的IVR联系流ID。', 'type' => 'string', 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek'],
'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '四川'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取坐席的个人号码列表',
'description' => '注意:如果号码已绑定了技能组,则不会出现在可作为个人外呼号码的号码列表中。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPersonalNumbersOfUser'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Active\\": true,\\n \\"Number\\": \\"08330011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ContactFlowId\\": \\"a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\",\\n \\"Province\\": \\"四川\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Active>true</Active>\\n <Number>083xxxx0011</Number>\\n <InstanceId>ccc-test</InstanceId>\\n <ContactFlowId>a3fb6c62-9b49-4942-ae5b-cf2abd4123ek</ContactFlowId>\\n <City>乐山</City>\\n <Province>四川</Province>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListPhoneNumbers' => [
'summary' => '调用ListPhoneNumbers获取指定实例下的号码列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SearchPattern',
'in' => 'query',
'schema' => ['description' => '根据号码进行模糊匹配,非必填,默认为空,为空表示不过滤。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0833'],
],
[
'name' => 'Usage',
'in' => 'query',
'schema' => [
'description' => '号码的用途,非必填,默认为空,为空表示不过滤。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['Outbound' => '呼出', 'Inbound' => '呼入', 'Bidirection' => '呼入和呼出'],
'example' => 'Bidirection',
'maxLength' => 200,
'minLength' => 1,
],
],
[
'name' => 'Active',
'in' => 'query',
'schema' => ['description' => '号码是否可用,非必填,默认为空,为空表示不过滤。', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页序号,范围1-100', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'List' => [
'description' => '号码列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Active' => ['description' => '号码是否可用。', 'type' => 'boolean', 'example' => 'true'],
'CreateTime' => ['description' => '号码创建时间,即关联到实例的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'string', 'example' => '1617958538000'],
'UserId' => ['description' => '坐席ID,如果此参数不为空,说明该号码是座席专属号码。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Tags' => ['description' => '号码业务标签,主要用于给号码打标,做一些扩展业务,普通客户无需关心。', 'type' => 'string', 'example' => 'M1'],
'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '乐山'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Usage' => [
'description' => '号码用途。',
'type' => 'string',
'enumValueTitles' => ['Outbound' => '呼出', 'Inbound' => '呼入', 'Bidirection' => '呼入和呼出'],
'example' => 'Bidirection',
],
'ContactFlowName' => ['description' => '号码关联的IVR联系流名称。', 'type' => 'string', 'example' => '默认联系流'],
'Provider' => ['description' => '号码供应商名称。', 'type' => 'string', 'example' => 'alicom'],
'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '08330011****'],
'ContactFlowId' => ['description' => '号码关联的IVR联系流ID。', 'type' => 'string', 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek'],
'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '四川'],
'SkillGroups' => [
'description' => '号码关联的技能组列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '技能组展示名。', 'type' => 'string', 'example' => '测试技能组'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Name' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'],
'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'],
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取号码列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-06-30T08:58:18.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPhoneNumbers'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Active\\": true,\\n \\"CreateTime\\": \\"1617958538000\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Tags\\": \\"M1\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"ContactFlowName\\": \\"默认联系流\\",\\n \\"Provider\\": \\"alicom\\",\\n \\"Number\\": \\"08330011****\\",\\n \\"ContactFlowId\\": \\"a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\",\\n \\"Province\\": \\"四川\\",\\n \\"SkillGroups\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"skillgroup\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<PageSize>20</PageSize>\\n<Message>无</Message>\\n<PageNumber>1</PageNumber>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Usage>Bidirection</Usage>\\n <Active>true</Active>\\n <Number>083xxxx0011</Number>\\n <InstanceId>ccc-test</InstanceId>\\n <ContactFlowId>a3fb6c62-9b49-4942-ae5b-cf2abd4123ek</ContactFlowId>\\n <UserId>user-test@ccc-test</UserId>\\n <CreateTime>1617958538000</CreateTime>\\n <ContactFlowName>测试IVR</ContactFlowName>\\n <City>乐山</City>\\n <Tags>M1</Tags>\\n <Province>四川</Province>\\n <Provider>ali</Provider>\\n <SkillGroups>\\n <InstanceId>ccc-test</InstanceId>\\n <DisplayName>测试技能组</DisplayName>\\n <SkillGroupId>test@ccc-test</SkillGroupId>\\n <Name>test</Name>\\n </SkillGroups>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListPhoneNumbersOfSkillGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'IsMember',
'in' => 'query',
'schema' => ['description' => '是否关联技能组,若为true,则查询SkillgroupId关联的号码列表,若为false,则查询SkillgroupId可关联但未关联的号码列表。通常和AddNumbersToSkillGroup接口一起使用。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
[
'name' => 'SearchPattern',
'in' => 'query',
'schema' => ['description' => '根据号码进行模糊匹配,非必填,默认为空,为空表示不过滤。', 'type' => 'string', 'required' => false, 'example' => '0833'],
],
[
'name' => 'Active',
'in' => 'query',
'schema' => ['description' => '号码是否可用,非必填,默认为空,为空表示不过滤。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'List' => [
'description' => '号码列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Active' => ['description' => '号码是否可用。', 'type' => 'boolean', 'example' => 'true'],
'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '08330011****'],
'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '乐山'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Usage' => [
'description' => '号码用途。',
'type' => 'string',
'enumValueTitles' => ['Outbound' => '呼出', 'Inbound' => '呼入', 'Bidirection' => '呼入和呼出'],
'example' => 'Bidirection',
],
'ContactFlowId' => ['description' => '号码关联的IVR联系流ID。', 'type' => 'string', 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek'],
'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '四川'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的技能组ID。'],
],
],
'title' => '获取技能组的号码列表',
'summary' => '调用ListPhoneNumbersOfSkillGroup获取指定实例下指定技能组关联的号码列表,也可以通过该接口反查未关联但可关联到该技能组的号码。',
'description' => '注意:如果号码已作为个人外呼号码使用,则不会出现在可添加到技能组的号码列表中。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPhoneNumbersOfSkillGroup'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Active\\": true,\\n \\"Number\\": \\"08330011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"ContactFlowId\\": \\"a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\",\\n \\"Province\\": \\"四川\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Usage>Bidirection</Usage>\\n <Active>true</Active>\\n <Number>083xxxx0011</Number>\\n <InstanceId>ccc-test</InstanceId>\\n <ContactFlowId>a3fb6c62-9b49-4942-ae5b-cf2abd4123ek</ContactFlowId>\\n <City>乐山</City>\\n <Province>四川</Province>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListPrivilegesOfUser' => [
'summary' => '调用ListPrivilegesOfUser获取当前用户拥有的权限。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Scope' => [
'description' => '权限范围。',
'type' => 'string',
'enumValueTitles' => ['SELF_ONLY' => '仅可访问自己的所有数据', 'INSTANCE' => '整个实例下的数据皆可访问', 'SKILL_GROUP' => '可以访问自己所在技能组的所有数据'],
'example' => 'SELF_ONLY',
],
'Name' => ['description' => '权限名称,普通客户无需了解具体的权限名称,该接口主要由坐席工作台调用。', 'type' => 'string', 'example' => 'Workbench:Call'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取坐席的权限列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrivilegesOfUser'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Scope\\": \\"SELF_ONLY\\",\\n \\"Name\\": \\"Workbench:Call\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Scope>SELF_ONLY</Scope>\\n <InstanceId>ccc-test</InstanceId>\\n <Name>Workbench:Call</Name>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListRamUsers' => [
'summary' => '调用ListRamUsers获取未导入指定实例下的RAM用户列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n"
."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test '],
],
[
'name' => 'SearchPattern',
'in' => 'query',
'schema' => ['description' => '根据坐席登录名或坐席展示名进行模糊匹配,非必填,默认为空,为空表示不过滤。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'agent'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-1000。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100000', 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。'."\n"
."\n", 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。'."\n"
."\n", 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '24753D71-C91D-1A38-A8AD-372BF12453F6'],
'Data' => [
'description' => '数据。'."\n"
."\n",
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-1000。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'List' => [
'description' => 'RAM用户列表。'."\n"
."\n",
'type' => 'array',
'items' => [
'description' => 'RAM用户',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => 'RAM账户姓名。', 'type' => 'string', 'example' => '测试账号'],
'Email' => ['description' => '邮箱。'."\n"
."\n", 'type' => 'string', 'example' => 'username@example.com'],
'LoginName' => ['description' => 'RAM用户名。'."\n"
."\n", 'type' => 'string', 'example' => 'agent'],
'Mobile' => ['description' => 'RAM账户预留的个人电话号码。', 'type' => 'string', 'example' => '1382114****'],
'AliyunUid' => ['description' => 'RAM账户所属的阿里云主账号UID。', 'type' => 'integer', 'format' => 'int64', 'example' => '15772400000****'],
'Primary' => ['description' => 'RAM账号是否为主账号。', 'type' => 'boolean', 'example' => 'false'],
'RamId' => ['description' => 'RAM用户的UID。', 'type' => 'string', 'example' => '28036411123456****'],
],
],
],
],
],
'Params' => [
'type' => 'array',
'items' => ['description' => '响应参数。'."\n"
."\n", 'type' => 'string', 'example' => '无'],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取RAM用户列表',
'description' => '一个RAM用户可以作为坐席导入到多个实例下,但是一个坐席只能指向一个RAM账户,如果我们在实例下创建坐席,实际上是创建了一个RAM账户的,此时如果想创建一个新的实例又不想创建多余的RAM账户,就可以调用ListRamUsers接口获取未导入实例下的RAM用户列表,然后再调用导入RAM用户的接口将RAM用户导入到实例下。这样可以避免过多的创建RAM账户,造成资源浪费。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-06T05:44:48.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRamUsers'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"24753D71-C91D-1A38-A8AD-372BF12453F6\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"测试账号\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"AliyunUid\\": 0,\\n \\"Primary\\": false,\\n \\"RamId\\": \\"28036411123456****\\"\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>24753D71-C91D-1A38-A8AD-372BF12453F6</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <LoginName>user-test</LoginName>\\n <Email>1886666****@163.com\\t</Email>\\n <Primary>false</Primary>\\n <AliyunUid>157724000000000</AliyunUid>\\n <RamId>28036411123456xxxx</RamId>\\n <DisplayName>测试用户\\t</DisplayName>\\n <Mobile>1382114****</Mobile>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListRealtimeAgentStates' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '50572',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '按技能组ID过滤,非必填,默认为空,表示不过滤。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'skillgroup@ccc-test'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'AgentIdList',
'in' => 'formData',
'schema' => ['description' => '坐席ID列表,格式为JSON数组的字符串,数组元素最多20个,非必填,默认为空,表示匹配当前实例下的所有坐席。', 'type' => 'string', 'required' => false, 'example' => '["agent1@ccc-test", "agent2@ccc-test"]'],
],
[
'name' => 'StateList',
'in' => 'formData',
'schema' => [
'description' => '按状态列表过滤,非必填,默认为空,表示匹配所有状态。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Ready' => '空闲', 'Talking' => '通话', 'ACW' => '话后处理', 'Break' => '小休', 'Ringing' => '振铃', 'Offline' => '离线', 'Dialing' => '拨号'],
'example' => '["ACW", "Dialing"]',
],
],
[
'name' => 'AgentName',
'in' => 'query',
'schema' => ['description' => '按坐席名称进行模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'agent'],
],
[
'name' => 'WorkModeList',
'in' => 'query',
'schema' => [
'description' => '按工作模式列表过滤,非必填,默认为空,表示匹配所有工作模式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => '["OFFICE_PHONE","ON_SITE"]',
],
],
[
'name' => 'OutboundScenario',
'in' => 'query',
'schema' => ['description' => '过滤仅外呼模式下的坐席,非必填,默认为空,表示不按仅外呼模式过滤。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'Query',
'in' => 'query',
'schema' => ['description' => '模糊过滤,可以是坐席展示名、坐席工号或坐席分机号的全部或者一部分,非必填,默认为空,表示不过滤。', 'type' => 'string', 'required' => false, 'example' => 'agent'],
],
[
'name' => 'CallTypeList',
'in' => 'query',
'schema' => [
'description' => '按通话类型列表过滤,格式为JSON数组的字符串,数组元素为通话类型,非必填,默认为空,表示匹配所有的通话类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Outbound' => '呼出', 'Back2Back' => '双呼', 'PrivacyDial' => '加密通话', 'Internal' => '内部呼叫', 'Predictive' => '预测式外呼', 'Inbound' => '呼入', 'Conference' => '会议'],
'example' => '["Inbound", "Outbound"]',
],
],
[
'name' => 'MediaType',
'in' => 'query',
'schema' => ['description' => '媒体类型,默认是语音(Audio), 其他可选参数包括Chat(文本)、Video(视频)、ALL(全选).', 'type' => 'string', 'required' => false, 'example' => 'AUDIO'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'List' => [
'description' => '实时坐席状态数据列表。',
'type' => 'array',
'items' => [
'description' => '实时坐席状态数据。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '80317391'],
'StateCode' => [
'description' => '子状态,部分场景下,仅用State字段无法完整表示坐席状态,因此需要子状态辅助,比如监听状态下,State=Talking,StateCode=Monitoring。',
'type' => 'string',
'enumValueTitles' => ['Monitored' => '被监听', 'Consulted' => '被咨询', 'Coaching' => '辅导中', 'Consulting' => '咨询中', 'Coached' => '被辅导', 'Conference' => '会议', 'Monitoring' => '监听中'],
'example' => 'Monitored',
],
'State' => [
'description' => '坐席状态。',
'type' => 'string',
'enumValueTitles' => ['Ready' => '空闲', 'Talking' => '通话', 'ACW' => '话后处理', 'Ringing' => '振铃', 'Break' => '小休', 'Offline' => '下线', 'Dialing' => '拨号'],
'example' => 'ACW',
],
'BreakCode' => ['description' => '小休码。'."\n"
."\n"
.'**枚举值:**'."\n"
."\n"
.'- RingingTimeout:坐席振铃超时导致的小休。'."\n"
."\n"
.'- RejectCall:坐席拒接导致的小休。'."\n"
."\n"
.'- Warm-up:坐席上线后置闲前的临时小休状态。', 'type' => 'string', 'example' => 'Warm-up'],
'AgentId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent1@ccc-test'],
'StateTime' => ['description' => '状态开始的时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1696670640774'],
'AgentName' => ['description' => '坐席姓名。', 'type' => 'string', 'example' => '坐席小王'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'CounterParty' => ['description' => '用于一些特定的三方场景,主要是监听,辅导,咨询,在三方场景时表示第三方,比如在监听或辅导场景,用于表示被监听或被辅导的坐席,在咨询场景下,表示被转接的坐席或外呼号码。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'SkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
'SkillGroupNameList' => [
'description' => '坐席签入的技能组名称列表。',
'type' => 'array',
'items' => ['description' => '技能组名称。', 'type' => 'string', 'example' => '测试技能组'],
],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1382114****'],
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => ['Outbound' => '呼出', 'Back2Back' => '双呼', 'PrivacyDial' => '加密通话', 'Internal' => '内部呼叫', 'Predictive' => '预测式外呼', 'Inbound' => '呼入', 'Conference' => '会议'],
'example' => 'Outbound',
],
'Duration' => ['description' => '当前状态的持续时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'],
],
],
'title' => '获取实时坐席状态报表',
'summary' => '调用ListRealtimeAgentStates获取指定实例下一个或多个指定坐席的实时状态数据报表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-02-13T02:21:10.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-06-21T06:52:28.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-07-12T04:33:02.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-06-24T03:34:23.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2021-12-21T12:54:51.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRealtimeAgentStates'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Extension\\": \\"80317391\\",\\n \\"StateCode\\": \\"Monitored\\",\\n \\"State\\": \\"ACW\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"AgentId\\": \\"agent1@ccc-test\\",\\n \\"StateTime\\": 1696670640774,\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"CounterParty\\": \\"agent@ccc-test\\",\\n \\"SkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ],\\n \\"SkillGroupNameList\\": [\\n \\"测试技能组\\"\\n ],\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1382114****\\",\\n \\"CallType\\": \\"Outbound\\",\\n \\"Duration\\": 16\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Extension>80317391</Extension>\\n <CounterParty>user-admin@ccc-test</CounterParty>\\n <StateTime>8</StateTime>\\n <InstanceId>ccc-test</InstanceId>\\n <State>ACW</State>\\n <StateCode>Monitored</StateCode>\\n <AgentName>云呼测试坐席</AgentName>\\n <AgentId>user-test@ccc-test</AgentId>\\n </List>\\n <List>\\n <SkillGroupIdList>[\\"skg-default@ccc-test\\"]</SkillGroupIdList>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListRealtimeSkillGroupStates' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccOQKOLI'],
],
'parameters' => [
[
'name' => 'SkillGroupIdList',
'in' => 'formData',
'schema' => ['description' => '待查询数据的技能组ID列表。如果不传,查询当前实例下的所有技能组,格式为JSON数组的字符串,数组元素为技能组ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["skillgroup1@ccc-test", "skillgroup2@ccc-test"]'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'MediaType',
'in' => 'query',
'schema' => ['description' => '媒体类型。'."\n"
."\n"
.'枚举值:'."\n"
."\n"
.'AUDIO:语音。'."\n"
."\n"
.'VIDEO:视频。'."\n"
."\n"
.'CHAT: 消息。'."\n"
."\n"
.'ALL: 所有。', 'type' => 'string', 'required' => false, 'example' => 'AUDIO'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'List' => [
'description' => '实时技能组状态数据列表。',
'type' => 'array',
'items' => [
'description' => '实时技能组状态数据。',
'type' => 'object',
'properties' => [
'WorkingAgents' => ['description' => '当前话后处理中的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'LongestWaitingTime' => ['description' => '当前最大排队等待时长,单位秒', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'LoggedInAgents' => ['description' => '当前在线坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'WaitingCalls' => ['description' => '当前排队电话个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'BreakingAgents' => ['description' => '当前小休坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TalkingAgents' => ['description' => '当前正在通话坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'],
'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'ReadyAgents' => ['description' => '当前空闲坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenarioReadyAgents' => ['description' => '处于仅外呼模式且在空闲状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalAgents' => ['description' => '总坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'BreakCodeDetailList' => [
'description' => '小休统计数据',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BreakCode' => ['description' => '小休状态代码', 'type' => 'string', 'example' => '客户自定义参数,比如午餐、会议等'],
'Count' => ['description' => '指定小休状态发生的次数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'description' => '',
],
],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
],
'title' => '获取实时技能组状态报表',
'summary' => '调用ListRealtimeSkillGroupStates获取指定实例下实时技能组状态报表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-06-21T06:52:28.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-11-22T01:05:25.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRealtimeSkillGroupStates'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"List\\": [\\n {\\n \\"WorkingAgents\\": 0,\\n \\"LongestWaitingTime\\": 0,\\n \\"LoggedInAgents\\": 2,\\n \\"WaitingCalls\\": 0,\\n \\"BreakingAgents\\": 0,\\n \\"TalkingAgents\\": 0,\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"ReadyAgents\\": 2,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenarioReadyAgents\\": 0,\\n \\"TotalAgents\\": 12,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"客户自定义参数,比如午餐、会议等\\",\\n \\"Count\\": 1\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>26A34338-5CD9-4C95-A7A6-5BDCE76C6B94</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>2</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <BreakingAgents>0</BreakingAgents>\\n <TalkingAgents>0</TalkingAgents>\\n <SkillGroupName>test1</SkillGroupName>\\n <InstanceId>ccc-test</InstanceId>\\n <LoggedInAgents>2</LoggedInAgents>\\n <ReadyAgents>2</ReadyAgents>\\n <WaitingCalls>0</WaitingCalls>\\n <SkillGroupId>skg-test1@ccc-test</SkillGroupId>\\n <LongestCall>0</LongestCall>\\n <WorkingAgents>0</WorkingAgents>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListRecentCallDetailRecords' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc5HY0NN'],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => '开始时间戳,默认是当天开始时间,最早为当前时间往前180天。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1604638129000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '截止时间戳,默认是当前时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1604639129000'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'Criteria',
'in' => 'query',
'schema' => ['description' => '模糊搜索条件,格式为JSON对象,对象包含三个属性,可以随机组合,三个属性分别为phoneNumber(按主叫或被叫号码模糊搜索)、callingNumber(按主叫号码模糊搜索)和calledNumber(按被叫号码模糊搜索)。', 'type' => 'string', 'required' => false, 'example' => '{"phoneNumber":"1312121****","callingNumber":"1312121****","calledNumber":"1312121****"}'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数,只有PageNumber为1才会返回真实大小,其他都是0。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'],
'List' => [
'description' => '通话记录列表。',
'type' => 'array',
'items' => [
'description' => '通话记录。',
'type' => 'object',
'properties' => [
'StartTime' => ['description' => '通话开始时间,内呼从进入IVR开始,外呼从开始接通计算,格式为Unix字符串,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532448000000'],
'ContactDisposition' => [
'description' => '电话结束原因。',
'type' => 'string',
'enumValueTitles' => [
'AbandonedInQueue' => '排队放弃', 'NoAnswer' => '客户未接', 'QueuingTimeout' => '排队超时', 'Voicemail' => '转语音邮箱', 'QueuingFailed' => '转人工失败', 'QueuingOverflow' => '排队溢出', 'AbandonedInVoiceNavigator' => '智能导航中放弃', 'Success' => '正常结束', 'IVRException' => 'IVR异常', 'AbandonedInRing' => '振铃放弃',
'AbandonedInIVR' => 'IVR放弃', 'Reject' => '客户拒接', 'ForwardToOutsideNumber' => '转外线',
],
'example' => 'Success',
],
'ContactType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => ['Outbound' => '呼出', 'Back2Back' => '双呼', 'PrivacyDial' => '加密通话', 'Internal' => '内部呼叫', 'Predictive' => '预测式外呼', 'Inbound' => '呼入', 'Conference' => '会议'],
'example' => 'Outbound',
],
'AgentIds' => ['description' => '坐席ID列表,多个值用逗号分隔。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-7660472242845****'],
'CallDuration' => ['description' => '通话时长,单位秒。', 'type' => 'string', 'example' => '16'],
'CallingNumber' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '0533128****'],
'Duration' => ['description' => '通话持续时间,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'CalledNumber' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '1332315****'],
'SkillGroupIds' => ['description' => '参与通话的座席所属的技能组,多个技能组以逗号分隔。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
],
'title' => '获取坐席最近通话记录列表',
'summary' => '调用ListRecentCallDetailRecords获取指定实例下当前RAM账号映射的坐席的最近通话记录列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRecentCallDetailRecords'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"StartTime\\": 1532448000000,\\n \\"ContactDisposition\\": \\"Success\\",\\n \\"ContactType\\": \\"Outbound\\",\\n \\"AgentIds\\": \\"agent@ccc-test\\",\\n \\"ContactId\\": \\"job-7660472242845****\\",\\n \\"CallDuration\\": \\"16\\",\\n \\"CallingNumber\\": \\"0533128****\\",\\n \\"Duration\\": 16,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"CalledNumber\\": \\"1332315****\\",\\n \\"SkillGroupIds\\": \\"skillgroup@ccc-test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>11</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <SkillGroupIds>skg-default@ccc-test</SkillGroupIds>\\n <CalledNumber>133xxxx2315</CalledNumber>\\n <ContactType>Outbound</ContactType>\\n <InstanceId>ccc-test</InstanceId>\\n <ContactDisposition>Success</ContactDisposition>\\n <StartTime>1532448000000</StartTime>\\n <AgentIds>user-test@ccc-test</AgentIds>\\n <Duration>16</Duration>\\n <ContactId>job-76604722428454704</ContactId>\\n <CallDuration>16</CallDuration>\\n <CallingNumber>053xxxx3128</CallingNumber>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListRoles' => [
'summary' => '调用ListRoles获取指定实例下的所有角色。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '711D948F-C616-4E23-8573-0F260513CE09'],
'Data' => [
'description' => '角色列表。'."\n"
."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => '角色名称。',
'type' => 'string',
'enumValueTitles' => ['Agent' => '坐席', 'Admin' => '管理员', 'Manager' => '技能组组长'],
'example' => 'Admin',
],
'RoleId' => ['description' => '角色ID,格式为:角色@实例ID。', 'type' => 'string', 'example' => 'Admin@ccc-test'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Invalid', 'errorMessage' => 'The parameter %s is invalid. %s.', 'description' => '该参数无效。'],
],
],
'title' => '获取角色列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoles'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"711D948F-C616-4E23-8573-0F260513CE09\\",\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"Admin\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListSkillGroupStates' => [
'summary' => '调用ListSkillgroupStates获取指定实例下指定技能组的状态列表,该接口仅对特定用户开放,其他客户不建议调用。',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccOQKOLI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SkillGroupIds',
'in' => 'query',
'schema' => ['description' => '技能组ID列表。'."\n"
."\n", 'type' => 'string', 'required' => false, 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1F69EBB0-63E9-5DDE-887F-9FC040ADF309'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'TotalCount' => ['description' => '总数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'List' => [
'description' => '技能组状态数据列表。',
'type' => 'array',
'items' => [
'description' => '技能组状态数据。',
'type' => 'object',
'properties' => [
'WorkingAgents' => ['description' => '话后处理坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'LoggedInAgents' => ['description' => '在线坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'BreakingAgents' => ['description' => '处于小休状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'LongestCall' => ['description' => '最大等待时长。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'WaitingCalls' => ['description' => '当前排队电话个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TalkingAgents' => ['description' => '正在通话坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => '测试技能组'],
'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
'ReadyAgents' => ['description' => '空闲坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'AverageWaitingTime' => ['description' => '平均等待时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'WaitingCallsLevel10' => ['description' => '等待时长小于10秒的通话的个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'WaitingCallsLevel20' => ['description' => '等待时长小于20秒的通话的个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'WaitingCallsLevel30' => ['description' => '等待时长小于30秒的通话的个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'OutboundScenarioReadyAgents' => ['description' => '处于仅外呼状态并且空闲的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'InboundTalkingAgents' => ['description' => '呼入场景下通话的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'OutboundTalkingAgents' => ['description' => '外呼场景下通话的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
],
],
],
],
],
],
'description' => '',
],
],
],
'staticInfo' => [
'substitutions' => ['CCC::2020-07-01::ListRealtimeSkillGroupStates'],
],
'title' => '获取技能组状态列表',
'changeSet' => [
['createdAt' => '2022-11-25T02:02:44.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-07-04T11:51:59.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-06-15T03:10:11.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-06-06T09:08:50.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-02-28T02:23:24.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillGroupStates'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"1F69EBB0-63E9-5DDE-887F-9FC040ADF309\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"WorkingAgents\\": 0,\\n \\"LoggedInAgents\\": 0,\\n \\"BreakingAgents\\": 0,\\n \\"LongestCall\\": 0,\\n \\"WaitingCalls\\": 0,\\n \\"TalkingAgents\\": 0,\\n \\"SkillGroupName\\": \\"测试技能组\\",\\n \\"SkillGroupId\\": \\"skillgroup1@ccc-test\\",\\n \\"ReadyAgents\\": 1,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"AverageWaitingTime\\": 3,\\n \\"WaitingCallsLevel10\\": 0,\\n \\"WaitingCallsLevel20\\": 0,\\n \\"WaitingCallsLevel30\\": 0,\\n \\"OutboundScenarioReadyAgents\\": 0,\\n \\"InboundTalkingAgents\\": 0,\\n \\"OutboundTalkingAgents\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListSkillGroupSummaryReportsSinceMidnight' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccOQKOLI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SkillGroups',
'in' => 'query',
'schema' => ['description' => '待查询的技能组ID列表,格式为JSON数组的字符串,数组元素为技能组ID,非必填,默认为空,表示查询当前分页下的所有技能组。', 'type' => 'string', 'required' => false, 'example' => '["skillgroup1@ccc-test", "skillgroup2@ccc-test2"]'."\n"],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2B36CEBC-6D11-5451-9E6B-C6D1927841C5'],
'Success' => ['description' => '是否调用成功。', 'type' => 'boolean', 'example' => 'true'],
'PagedSkillGroupSummaryReport' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'List' => [
'description' => '技能组概览数据列表。',
'type' => 'array',
'items' => [
'description' => '技能组概览数据。',
'type' => 'object',
'properties' => [
'Timestamp' => ['description' => '统计打点时刻。', 'type' => 'string', 'example' => '2018-09-13 00:00:00'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => '测试技能组'],
'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Overall' => [
'description' => '整体指标。',
'type' => 'object',
'properties' => [
'TotalLoggedInTime' => ['description' => '总登录时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'OccupancyRate' => ['description' => '座席利用率,单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxReadyTime' => ['description' => '最大空闲时长,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageReadyTime' => ['description' => '平均空闲时长,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalBreakTime' => ['description' => '总小休时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalReadyTime' => ['description' => '总空闲时长,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalCalls' => ['description' => '总电话量。计算公式为:CallsOffered + CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
],
],
'Inbound' => [
'description' => '呼入指标。',
'type' => 'object',
'properties' => [
'AverageRingTime' => ['description' => '平均振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsHandled' => ['description' => '应答量,即坐席应答的次数。一通电话每次进入队列后,若被多个坐席应答,算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'QueueMaxWaitTimeDuration' => ['description' => '队列最大等待时间,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。计算公式为: TotalWorkTime/CallsHandled。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AnsweredByAgentOfQueueWaitTimeDuration' => ['description' => '坐席接起时队列等待时间,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalRingTime' => ['description' => '总振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'InComingQueueOfQueueCount' => ['description' => '技能组呼入次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'string', 'example' => '0'],
'MaxRingTime' => ['description' => '最大振铃时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsOffered' => ['description' => '分配量,即分配给该技能组的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AbandonedInQueueOfQueueCount' => ['description' => '技能组排队放弃次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'OverFlowInQueueOfQueueCount' => ['description' => '技能组排队超时次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AnsweredByAgentOfQueueMaxWaitTimeDuration' => ['description' => '坐席接起时队列最大等待时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ServiceLevel20' => ['description' => '20秒应答率,单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AnsweredByAgentOfQueueCount' => ['description' => '技能组转人工接起次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'HandleRate' => ['description' => '应答率。计算公式为:CallsHandled/CallsOffered(由于应答事件与分配事件可能落在不同的时间范围内,所以某些情况下结果可能大于100%)。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'GiveUpByAgentOfQueueCount' => ['description' => '技能组振铃放弃次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'QueueWaitTimeDuration' => ['description' => '队列等待时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsServiceLevel20' => ['description' => '等待20s内坐席接起次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsServiceLevel30' => ['description' => '等待30s内坐席接起次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsServiceLevel10' => ['description' => '等待10s内坐席接起次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAttendedTransferOut' => ['description' => '咨询转出量。若一通电话多次转出给其他坐席,每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsBlindTransferOut' => ['description' => '直接转出量。若一通电话多次转出给其他坐席,每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsQueuingTimeout' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'CallsTimeout' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'CallsQueuingCanceled' => ['type' => 'string', 'description' => ''],
'CallsQueuingFailure' => ['type' => 'string', 'description' => ''],
'CallsQueuingRerouted' => ['type' => 'string', 'description' => ''],
'CallsAbandoned' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'CallsOverflow' => ['type' => 'string', 'description' => ''],
],
],
'Outbound' => [
'description' => '呼出指标。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => ['description' => '总通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxDialingTime' => ['description' => '最大拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsAnswered' => ['description' => '电话接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AnswerRate' => ['description' => '接通率,单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'TotalWorkTime' => ['description' => '总话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxWorkTime' => ['description' => '最大话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalDialingTime' => ['description' => '总拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageTalkTime' => ['description' => '平均通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageWorkTime' => ['description' => '平均话后处理时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionIndex' => ['description' => '满意度指数,即满意度按键数字(1位数字)的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'],
'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MaxTalkTime' => ['description' => '最大通话时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AverageDialingTime' => ['description' => '平均拨号时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CallsServiceLevel30' => ['description' => '等待30s内坐席接起次数。', 'type' => 'string', 'example' => '0'],
'CallsOffered' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'CallsAbandoned' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'CallsQueuingTimeout' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'CallsQueuingOverflow' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'CallsQueuingFailed' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'CallsQueuingRerouted' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'CallsQueuingCancelled' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'CallsQueuingFailure' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'TotalWaitTime' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'CallsAgentHandled' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'CallsServiceLevel30V2' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
],
],
],
],
],
],
],
],
'description' => '',
],
],
],
'staticInfo' => [
'substitutions' => ['CCC::2020-07-01::ListHistoricalSkillGroupReport'],
],
'title' => '获取技能组概览数据列表',
'summary' => '调用ListSkillgroupSummaryReportsSinceMidnight获取指定实例下按指定条件过滤后的技能组历史数据报表,统计的时间范围是从当天0时开始,到当前时间结束。该接口仅对特定用户开放,其他客户不建议调用。',
'changeSet' => [
['createdAt' => '2024-06-06T07:19:09.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-05-28T06:54:07.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-05-17T08:45:04.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-05-15T02:47:00.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-04-24T12:54:21.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-06-15T03:10:11.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-06-06T09:08:50.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-03-09T09:23:25.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-02-28T02:23:24.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2B36CEBC-6D11-5451-9E6B-C6D1927841C5\\",\\n \\"Success\\": true,\\n \\"PagedSkillGroupSummaryReport\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"List\\": [\\n {\\n \\"Timestamp\\": \\"2018-09-13 00:00:00\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"SkillGroupName\\": \\"测试技能组\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Overall\\": {\\n \\"TotalLoggedInTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 0\\n },\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"QueueMaxWaitTimeDuration\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"AnsweredByAgentOfQueueWaitTimeDuration\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"InComingQueueOfQueueCount\\": 0,\\n \\"MaxTalkTime\\": \\"0\\",\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"AbandonedInQueueOfQueueCount\\": 0,\\n \\"OverFlowInQueueOfQueueCount\\": 0,\\n \\"AnsweredByAgentOfQueueMaxWaitTimeDuration\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"AnsweredByAgentOfQueueCount\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"GiveUpByAgentOfQueueCount\\": 0,\\n \\"QueueWaitTimeDuration\\": 0,\\n \\"CallsServiceLevel20\\": 0,\\n \\"CallsServiceLevel30\\": 0,\\n \\"CallsServiceLevel10\\": 0,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"CallsTimeout\\": 0,\\n \\"CallsQueuingCanceled\\": \\"\\",\\n \\"CallsQueuingFailure\\": \\"\\",\\n \\"CallsQueuingRerouted\\": \\"\\",\\n \\"CallsAbandoned\\": 0,\\n \\"CallsOverflow\\": \\"\\"\\n },\\n \\"Outbound\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"AverageDialingTime\\": 0,\\n \\"CallsServiceLevel30\\": \\"0\\",\\n \\"CallsOffered\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"CallsQueuingFailed\\": 0,\\n \\"CallsQueuingRerouted\\": 0,\\n \\"CallsQueuingCancelled\\": 0,\\n \\"CallsQueuingFailure\\": 0,\\n \\"TotalWaitTime\\": 0,\\n \\"CallsAgentHandled\\": 0,\\n \\"CallsServiceLevel30V2\\": 0\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListSkillGroups' => [
'summary' => '调用ListSkillGroups获取指定实例下的技能组列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccPBOQGO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SearchPattern',
'in' => 'query',
'schema' => ['description' => '根据技能组名称或技能组展示名进行模糊匹配,非必填,默认为空,为空表示不过滤。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '测试技能组'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'MediaType',
'in' => 'query',
'schema' => ['description' => '媒体类型,默认是语音(Audio), 其他可选参数包括Chat和Video.', 'type' => 'string', 'required' => false, 'example' => 'Audio'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'List' => [
'description' => '技能组列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '技能组展示名。', 'type' => 'string', 'example' => '测试技能组'],
'Description' => ['description' => '技能组的描述。', 'type' => 'string', 'example' => '云联络中心的测试技能组。'],
'PhoneNumberCount' => ['description' => '技能组关联的号码数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'],
'UserCount' => ['description' => '技能组关联的坐席数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'MediaType' => ['description' => '媒体类型,默认是语音(AUDIO), 其他可选参数包括CHAT和VIDEO。', 'type' => 'string', 'example' => 'CHAT'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取技能组列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-06T05:44:48.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillGroups'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"PhoneNumberCount\\": 1,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"UserCount\\": 2,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"MediaType\\": \\"CHAT\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <SkillGroupName>test</SkillGroupName>\\n <Description>测试</Description>\\n <PhoneNumberCount>1</PhoneNumberCount>\\n <InstanceId>ccc-test</InstanceId>\\n <UserCount>2</UserCount>\\n <DisplayName>测试技能组</DisplayName>\\n <SkillGroupId>test@ccc-test</SkillGroupId>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListSkillLevelsOfUser' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'IsMember',
'in' => 'query',
'schema' => ['description' => '是否与传入的坐席关联,如果值为true,表示获取传入的坐席关联的技能组的技能等级列表,如果值为false,表示获取坐席可关联但未关联的技能组列表。默认值为true。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'SearchPattern',
'in' => 'query',
'schema' => ['description' => '根据技能组名称或技能组展示名进行模糊匹配,非必填,默认为空,为空表示不过滤。', 'type' => 'string', 'required' => false, 'example' => 'skillgroup'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'List' => [
'description' => '技能组等级列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SkillLevel' => ['description' => '技能等级,取值范围1-10,数值越小,业务能力越强,单位时间内能处理更多的通话。', 'type' => 'string', 'example' => '5'],
'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'],
'MediaType' => ['description' => '媒体类型,默认是语音(AUDIO), 其他可选参数包括CHAT和VIDEO。', 'type' => 'string', 'example' => 'VIDEO'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
],
'title' => '获取坐席的技能组等级列表',
'summary' => '获取指定实例下指定坐席关联的技能组的技能等级列表,也可以使用该接口查询坐席可关联但未关联的技能组列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-06T05:44:48.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillLevelsOfUser'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"SkillLevel\\": \\"5\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"MediaType\\": \\"VIDEO\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <SkillLevel>5</SkillLevel>\\n <SkillGroupName>测试技能组</SkillGroupName>\\n <SkillGroupId>test@ccc-test</SkillGroupId>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListSmsMetadata' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '251523',
'abilityTreeNodes' => ['FEATUREcccBM6DRP'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '100'],
],
[
'name' => 'ScenarioListJson',
'in' => 'query',
'schema' => ['description' => '场景类型。'."\n"
.'- SATISFACTION_SURVEY(满意度调查)'."\n"
.'- CONTACT_FLOW_NODE(IVR流程节点)'."\n"
.'- MISSED_CALL_NOTIFICATION(漏话提醒)'."\n"
.'- FLASH_SMS(阿里通信闪信通知)', 'type' => 'string', 'required' => false, 'example' => '["SATISFACTION_SURVEY","CONTACT_FLOW_NODE"]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8707EB29-BAED-4302-B999-40BA61877437'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'List' => [
'description' => '短信配置列表。',
'type' => 'array',
'items' => [
'description' => '短信配置。',
'type' => 'object',
'properties' => [
'SmsMetadataId' => ['description' => '短信配置ID。', 'type' => 'string', 'example' => '5ffc1c9a-4d3d-4019-*****-73255fb01d1c'],
'TemplateCode' => ['description' => '模板CODE。', 'type' => 'string', 'example' => 'SMS_468xxxx298'],
'Description' => ['description' => '配置描述。', 'type' => 'string', 'example' => '漏话短信配置'],
'Scenario' => ['description' => '场景类型。', 'type' => 'string', 'example' => 'MISSED_CALL_NOTIFICATION'],
'AliyunUid' => ['description' => '阿里云账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '15772400000****'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Name' => ['description' => '配置名称。', 'type' => 'string', 'example' => '漏话短信提醒'],
'SignName' => ['description' => '短信签名名称。', 'type' => 'string', 'example' => '云呼叫中心'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 200,\\n \\"List\\": [\\n {\\n \\"SmsMetadataId\\": \\"5ffc1c9a-4d3d-4019-*****-73255fb01d1c\\",\\n \\"TemplateCode\\": \\"SMS_468xxxx298\\",\\n \\"Description\\": \\"漏话短信配置\\",\\n \\"Scenario\\": \\"MISSED_CALL_NOTIFICATION\\",\\n \\"AliyunUid\\": 0,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"漏话短信提醒\\",\\n \\"SignName\\": \\"云呼叫中心\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取短信配置详情',
'summary' => '使用ListSmsMetadata获取短信配置详情。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ListTicketTasks' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'TicketId',
'in' => 'query',
'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => false, 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListTicketTasksResponse',
'description' => 'ListTicketTasksResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TaskName' => ['description' => '节点名称。', 'type' => 'string', 'example' => '节点1'],
'Assignee' => ['description' => '处理人ID。', 'type' => 'string', 'example' => 'assignee@ccc-test'],
'Comment' => ['description' => '处理意见。', 'type' => 'string', 'example' => '同意'],
'StartTime' => ['description' => '开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620259200000'],
'EndTime' => ['description' => '结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620269200000'],
'AssigneeName' => ['description' => '处理人姓名。', 'type' => 'string', 'example' => 'assignee'],
'TaskId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'eb039a4a6a5742c6b44ccff0c1fca745'],
'TicketId' => ['description' => '工单ID。', 'type' => 'string', 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb'."\n"],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'FileKeys' => [
'description' => '文件列表。',
'type' => 'array',
'items' => ['description' => '文件。', 'type' => 'string', 'example' => '["ticket-file/xxx.png"]'],
],
'FileUrls' => [
'description' => '文件访问链接列表。',
'type' => 'array',
'items' => ['description' => '文件访问链接。', 'type' => 'string', 'example' => '["http://oss-cn-hangzhou.com/bucket/ticket-file/xxx.png"]'],
],
'TaskDefinitionNodeId' => ['description' => '工单节点流程定义ID。', 'type' => 'string', 'example' => 'APPROVAL__6zu2QjAz'],
'TaskDefinitionNodeType' => ['description' => '工单节点流程定义类型。', 'type' => 'string', 'example' => 'APPROVAL'],
'Action' => ['description' => '节点处理动作。', 'type' => 'string', 'example' => 'CounterSignTask'],
],
'description' => '',
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE '],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"TaskName\\": \\"节点1\\",\\n \\"Assignee\\": \\"assignee@ccc-test\\",\\n \\"Comment\\": \\"同意\\",\\n \\"StartTime\\": 1620259200000,\\n \\"EndTime\\": 1620269200000,\\n \\"AssigneeName\\": \\"assignee\\",\\n \\"TaskId\\": \\"eb039a4a6a5742c6b44ccff0c1fca745\\",\\n \\"TicketId\\": \\"5491d3b4-14ee-4341-b5f1-db2c78beddeb\\\\n\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"FileKeys\\": [\\n \\"[\\\\\\"ticket-file/xxx.png\\\\\\"]\\"\\n ],\\n \\"FileUrls\\": [\\n \\"[\\\\\\"http://oss-cn-hangzhou.com/bucket/ticket-file/xxx.png\\\\\\"]\\"\\n ],\\n \\"TaskDefinitionNodeId\\": \\"APPROVAL__6zu2QjAz\\",\\n \\"TaskDefinitionNodeType\\": \\"APPROVAL\\",\\n \\"Action\\": \\"CounterSignTask\\"\\n }\\n ],\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\\\t\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '获取工单节点信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ListTicketTemplates' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'SearchPattern',
'in' => 'query',
'schema' => ['description' => '模板名称,模糊搜索。', 'type' => 'string', 'required' => false, 'example' => '模板1'],
],
[
'name' => 'CategoryId',
'in' => 'query',
'schema' => ['description' => '工单类目ID。', 'type' => 'string', 'required' => false, 'example' => '43c2671b-********86d0-6bd187905cc8'],
],
[
'name' => 'State',
'in' => 'query',
'schema' => ['description' => '模板状态。'."\n"
.'- Enabled(已上线)'."\n"
.'- Disabled(已下线)', 'type' => 'string', 'required' => false, 'example' => 'Enabled'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListTicketTemplatesResponse',
'description' => 'ListTicketTemplatesResponse',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '25'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'List' => [
'description' => '模板列表。',
'type' => 'array',
'items' => [
'description' => '模板。',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'TemplateId' => ['description' => '模板ID。', 'type' => 'string', 'example' => 'b5c21219-3a1e-4bc0-92e7-da66e057d2f6'],
'Name' => ['description' => '模板名称。', 'type' => 'string', 'example' => '测试模板'],
'State' => ['description' => '状态。', 'type' => 'string', 'example' => 'Enabled'],
'Editor' => ['description' => '编辑人。', 'type' => 'string', 'example' => 'creator@ccc-test'],
'TicketFields' => [
'description' => '模板字段列表。',
'type' => 'array',
'items' => [
'description' => '字段。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '显示名称。', 'type' => 'string', 'example' => '姓名'."\n"],
'Description' => ['description' => '描述。', 'type' => 'string', 'example' => '姓名字段'],
'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'name'],
'DataType' => ['description' => '数据类型'."\n"
.'。', 'type' => 'string', 'example' => 'String'],
'Pattern' => ['description' => '正则表达式校验规则。', 'type' => 'string', 'example' => '^'],
'PatternErrorMessage' => ['description' => '正则表达式校验错误提示信息', 'type' => 'string', 'example' => '不是有效的email地址'."\n"],
'MinLength' => ['description' => '最小长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'MaxLength' => ['description' => '最大长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'Minimum' => ['description' => '数字最小值。', 'type' => 'number', 'format' => 'double', 'example' => '1'],
'Maximum' => ['description' => '数字最大值。', 'type' => 'number', 'format' => 'double', 'example' => '10'],
'Required' => ['description' => '是否必填。', 'type' => 'boolean', 'example' => 'false'],
'System' => ['description' => '是否是系统字段。', 'type' => 'boolean', 'example' => 'false'],
'Disabled' => ['description' => '是否被禁用。', 'type' => 'boolean', 'example' => 'false'],
'Array' => ['description' => '是否是数组。', 'type' => 'boolean', 'example' => 'false'],
'ReadOnly' => ['description' => '是否只读。', 'type' => 'boolean', 'example' => 'false'],
'EditorType' => ['description' => '编辑器类型。', 'type' => 'string', 'example' => 'textbox'],
'Attribute' => ['description' => '扩展属性。', 'type' => 'string', 'example' => '{}'],
'DisplayOrder' => ['description' => '列表展示顺序。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'CreatedTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1715780670000'],
'UpdatedTime' => ['description' => '更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1715780670000'],
'Creator' => ['description' => '创建者。', 'type' => 'string', 'example' => 'creator'],
],
],
],
'ProcessDefinition' => ['description' => '流程信息(废弃)。', 'type' => 'string', 'example' => '无'],
'UpdatedTime' => ['description' => '更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1715780670000'],
'CategoryId' => ['description' => '类⽬ID。', 'type' => 'string', 'example' => '43c2671b-*****-4223-86d0-6bd187905cc8'],
'AppliedVersion' => ['description' => '当前正在工作的版本。', 'type' => 'string', 'example' => '0'],
'LatestVersion' => ['description' => '草稿版本。', 'type' => 'string', 'example' => '1715780670000'],
],
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8707EB29-BAED-4302-B999-40BA61877437'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": 25,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TemplateId\\": \\"b5c21219-3a1e-4bc0-92e7-da66e057d2f6\\",\\n \\"Name\\": \\"测试模板\\",\\n \\"State\\": \\"Enabled\\",\\n \\"Editor\\": \\"creator@ccc-test\\",\\n \\"TicketFields\\": [\\n {\\n \\"DisplayName\\": \\"姓名\\\\n\\",\\n \\"Description\\": \\"姓名字段\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"String\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\\\n\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 30,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attribute\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 1715780670000,\\n \\"UpdatedTime\\": 1715780670000,\\n \\"Creator\\": \\"creator\\"\\n }\\n ],\\n \\"ProcessDefinition\\": \\"无\\",\\n \\"UpdatedTime\\": 1715780670000,\\n \\"CategoryId\\": \\"43c2671b-*****-4223-86d0-6bd187905cc8\\",\\n \\"AppliedVersion\\": \\"0\\",\\n \\"LatestVersion\\": \\"1715780670000\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '获取工单模板列表',
'summary' => '使用ListTickerTemplate获取工单模板列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ListTickets' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'TicketId',
'in' => 'query',
'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => false, 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb'],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => ['description' => '工单标题。', 'type' => 'string', 'required' => false, 'example' => '标题'],
],
[
'name' => 'State',
'in' => 'query',
'schema' => ['description' => '工单状态。', 'type' => 'string', 'required' => false, 'example' => 'Processing'],
],
[
'name' => 'CategoryId',
'in' => 'query',
'schema' => ['description' => '工单类目ID。', 'type' => 'string', 'required' => false, 'example' => '43c2671b-****-4223-86d0-6bd187905cc8'],
],
[
'name' => 'Creator',
'in' => 'query',
'schema' => ['description' => '创建者。', 'type' => 'string', 'required' => false, 'example' => 'creator@cccV2-kmz'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,基于工单创建时间过滤。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1646841600000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,基于工单创建时间过滤。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1646928000000'],
],
[
'name' => 'CustomerId',
'in' => 'query',
'schema' => ['description' => '客户ID,云联络中心客户资料ID。', 'type' => 'string', 'required' => false, 'example' => '51e155ce-3747-*****-b402-13c69597b920'],
],
[
'name' => 'JobIdList',
'in' => 'query',
'schema' => ['description' => '话务ID列表。', 'type' => 'string', 'required' => false, 'example' => '["job-12******","job-23****"]'],
],
[
'name' => 'Assignee',
'in' => 'query',
'schema' => ['description' => '处理者ID。', 'type' => 'string', 'required' => false, 'example' => 'assignee@cccV2-kmz'."\n"],
],
[
'name' => 'AssigneeType',
'in' => 'query',
'schema' => ['description' => '处理者类型。', 'type' => 'string', 'required' => false, 'example' => 'Agent'],
],
[
'name' => 'Participant',
'in' => 'query',
'schema' => ['description' => '参与人ID。', 'type' => 'string', 'required' => false, 'example' => 'participant@cccV2-kmz'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'List' => [
'description' => '工单列表。',
'type' => 'array',
'items' => [
'description' => '工单。',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'TicketId' => ['description' => '工单ID。', 'type' => 'string', 'example' => 'feb83abd-9f08-49d2-9b56-41d1b66ca0ac'],
'Title' => ['description' => '工单标题。', 'type' => 'string', 'example' => '标题'],
'TemplateId' => ['description' => '模板ID。', 'type' => 'string', 'example' => 'c844a5f0-496c-4c5b-8a0c-dd27686e8ff6'],
'TemplateVersion' => ['description' => '模板版本。', 'type' => 'string', 'example' => '0'],
'CategoryId' => ['description' => '工单类目ID。', 'type' => 'string', 'example' => '43c2671b-*****-4223-86d0-6bd187905cc8'],
'CategoryName' => ['description' => '工单类目名称。', 'type' => 'string', 'example' => '类目1'],
'StartTime' => ['description' => '工单开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1631440860000'],
'EndTime' => ['description' => '工单结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1631440860000'],
'State' => ['description' => '状态。', 'type' => 'string', 'example' => 'Processing'],
'CloseCode' => ['description' => '工单结束原因。', 'type' => 'string', 'example' => 'Completed'],
'Assignee' => ['description' => '处理人ID。', 'type' => 'string', 'example' => 'assignee@ccc-test'],
'Comment' => ['description' => '处理意见。', 'type' => 'string', 'example' => '无'],
'AssigneeName' => ['description' => '处理人姓名。', 'type' => 'string', 'example' => 'Assignee'],
'Creator' => ['description' => '创建人ID。', 'type' => 'string', 'example' => 'creator@ccc-test'."\n"],
'CreatorName' => ['description' => '创建者名称。', 'type' => 'string', 'example' => 'Creator'],
'Context' => ['description' => '工单表单信息。', 'type' => 'string', 'example' => '{"productName":"alynx"}'],
'CreatedTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '1631440860000'],
'UpdatedTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '1631440860000'],
'CurrentTaskId' => ['description' => '当前节点ID。', 'type' => 'string', 'example' => '0707dab6-34a8-11ef-9823-161e3802b2d4'],
'CurrentTaskName' => ['description' => '当前节点名称。', 'type' => 'string', 'example' => '节点1'],
'CurrentTaskStartTime' => ['description' => '当前节点开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1631440860000'],
'CustomerId' => ['description' => '客户ID。', 'type' => 'string', 'example' => '51e155ce-*****1-b402-13c69597b920'],
'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'job-47150***150396416'],
'Source' => ['description' => '工单来源。', 'type' => 'string', 'example' => 'CHAT'],
],
],
],
],
],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TicketId\\": \\"feb83abd-9f08-49d2-9b56-41d1b66ca0ac\\",\\n \\"Title\\": \\"标题\\",\\n \\"TemplateId\\": \\"c844a5f0-496c-4c5b-8a0c-dd27686e8ff6\\",\\n \\"TemplateVersion\\": \\"0\\",\\n \\"CategoryId\\": \\"43c2671b-*****-4223-86d0-6bd187905cc8\\",\\n \\"CategoryName\\": \\"类目1\\",\\n \\"StartTime\\": 1631440860000,\\n \\"EndTime\\": 1631440860000,\\n \\"State\\": \\"Processing\\",\\n \\"CloseCode\\": \\"Completed\\",\\n \\"Assignee\\": \\"assignee@ccc-test\\",\\n \\"Comment\\": \\"无\\",\\n \\"AssigneeName\\": \\"Assignee\\",\\n \\"Creator\\": \\"creator@ccc-test\\\\n\\",\\n \\"CreatorName\\": \\"Creator\\",\\n \\"Context\\": \\"{\\\\\\"productName\\\\\\":\\\\\\"alynx\\\\\\"}\\",\\n \\"CreatedTime\\": \\"1631440860000\\",\\n \\"UpdatedTime\\": \\"1631440860000\\",\\n \\"CurrentTaskId\\": \\"0707dab6-34a8-11ef-9823-161e3802b2d4\\",\\n \\"CurrentTaskName\\": \\"节点1\\",\\n \\"CurrentTaskStartTime\\": 1631440860000,\\n \\"CustomerId\\": \\"51e155ce-*****1-b402-13c69597b920\\",\\n \\"JobId\\": \\"job-47150***150396416\\",\\n \\"Source\\": \\"CHAT\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
'title' => '获取工单列表',
'summary' => '使用ListTickets获取实例下工单列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ListUnassignedNumbers' => [
'summary' => '调用ListUnassignedNumbers获取阿里云主账号下未分配到实例的号码列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'SearchPattern',
'in' => 'query',
'schema' => ['description' => '根据号码进行模糊匹配,非必填,默认为空,为空表示不过滤。'."\n"
."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0833'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。'."\n"
."\n", 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。'."\n"
."\n", 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F '],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'List' => [
'description' => '号码列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Number' => ['description' => '号码。'."\n"
."\n", 'type' => 'string', 'example' => '08330011****'],
'City' => ['description' => '号码归属地市。'."\n"
."\n", 'type' => 'string', 'example' => '乐山'],
'Province' => ['description' => '号码归属地省。'."\n"
."\n", 'type' => 'string', 'example' => '四川'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
500 => [
['errorCode' => 'InternalService.ResourcePlatform', 'errorMessage' => 'An internal ResourcePlatform service error occurred. %s', 'description' => '内部ResourcePlatform服务错误。'],
],
],
'title' => '获取未分配号码列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-02-02T03:52:26.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUnassignedNumbers'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\\\t\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"List\\": [\\n {\\n \\"Number\\": \\"08330011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"Province\\": \\"四川\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F\\t</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Usage>true</Usage>\\n <Active>true</Active>\\n <Number>083xxxx0011\\t</Number>\\n <City>乐山</City>\\n <Province>四川</Province>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListUserLevelsOfSkillGroup' => [
'summary' => '调用ListUserLevelsOfSkillGroup获取指定实例下指定技能组下属的坐席技能等级列表,也可以调用该接口反差可关联但未关联指定技能组的坐席列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccPBOQGO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'],
],
[
'name' => 'IsMember',
'in' => 'query',
'schema' => ['description' => '是否与传入的技能组关联,如果值为true,表示获取SkillgroupId关联的坐席的技能等级列表,如果值为false,表示获取可关联但未关联SkillgroupId的坐席列表。默认值为true。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'SearchPattern',
'in' => 'query',
'schema' => ['description' => '根据坐席登录名或坐席展示名进行模糊匹配,非必填,默认为空,为空表示不过滤。', 'type' => 'string', 'required' => false, 'example' => '测试坐席'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'List' => [
'description' => '技能等级列表。',
'type' => 'array',
'items' => [
'description' => '技能等级信息。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '坐席展示名。', 'type' => 'string', 'example' => '坐席小王'],
'SkillLevel' => ['description' => '坐席技能等级。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'LoginName' => ['description' => '坐席登录名。', 'type' => 'string', 'example' => 'agent'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'],
'RoleName' => [
'description' => '角色名称。',
'type' => 'string',
'enumValueTitles' => ['Agent' => '坐席', 'Admin' => '管理员', 'Manager' => '技能组组长'],
'example' => 'Admin',
],
'RoleId' => ['description' => '角色ID,格式为:角色@实例ID。', 'type' => 'string', 'example' => 'Admin@ccc-test'],
'RamId' => ['description' => '用户的RAM账号。', 'type' => 'string', 'example' => '28036411123456****'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的技能组ID。'],
],
],
'title' => '获取技能组的坐席等级列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserLevelsOfSkillGroup'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"SkillLevel\\": 5,\\n \\"LoginName\\": \\"agent\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\",\\n \\"RamId\\": \\"28036411123456****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <LoginName>user-test</LoginName>\\n <RoleName>Admin</RoleName>\\n <SkillLevel>5</SkillLevel>\\n <SkillGroupName>Default</SkillGroupName>\\n <UserId>user-test@ccc-test</UserId>\\n <DisplayName>测试坐席</DisplayName>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <RoleId>Admin@ccc-test</RoleId>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListUsers' => [
'summary' => '调用ListUsers获取指定实例下的坐席列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SearchPattern',
'in' => 'query',
'schema' => ['description' => '根据坐席登录名或坐席展示名进行模糊匹配,非必填,默认为空,为空表示不过滤。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'agent'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => false, 'example' => 'ankedayaopin@zcwlwhkf'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'List' => [
'description' => '坐席列表。',
'type' => 'array',
'items' => [
'description' => '坐席信息。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '坐席展示名。', 'type' => 'string', 'example' => '坐席小王'],
'LoginName' => ['description' => '坐席登录名。', 'type' => 'string', 'example' => 'agent'],
'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => 'username@example.com'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1382114****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'DisplayId' => ['description' => '坐席的工号。', 'type' => 'string', 'example' => '1001'],
'RoleName' => [
'description' => '角色名称。',
'type' => 'string',
'enumValueTitles' => ['Mannager' => '技能组组长', 'Agent' => '坐席', 'Admin' => '管理员'],
'example' => 'Admin',
],
'RoleId' => ['description' => '角色ID,格式为:角色@实例ID。', 'type' => 'string', 'example' => 'Admin@ccc-test'],
'PrimaryAccount' => ['description' => '坐席映射的RAM账户是否为RAM主账号。', 'type' => 'boolean', 'example' => '已弃用,请使用Primary代替此参数。', 'default' => '已弃用,请使用Primary代替此参数'],
'PersonalOutboundNumberList' => [
'description' => '坐席个人外呼号码列表。',
'type' => 'array',
'items' => [
'description' => '号码信息。',
'type' => 'object',
'properties' => [
'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '0830011****'],
'Active' => ['description' => '是否可用。', 'type' => 'boolean', 'example' => 'true'],
'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '乐山'],
'Usage' => [
'description' => '号码用途。',
'type' => 'string',
'enumValueTitles' => ['Outbound' => '呼出', 'Inbound' => '呼入', 'Bidirection' => '呼入及呼出'],
'example' => 'Bidirection',
],
'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '四川'],
],
],
],
'SkillLevelList' => [
'description' => '坐席关联的技能组等级列表。',
'type' => 'array',
'items' => [
'description' => '技能组等级信息。',
'type' => 'object',
'properties' => [
'SkillLevel' => ['description' => '技能等级。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'],
],
],
],
'RamId' => ['description' => '坐席关联的RAM账号的UID。', 'type' => 'integer', 'format' => 'int64', 'example' => '21234502254620****'],
'Extension' => ['description' => '座机分机号。', 'type' => 'string', 'example' => '8031****'],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'DeviceExt' => ['description' => 'SIP话机分机号,如果座席注册了SIP话机,则此参数为SIP话机设备的分机号。', 'type' => 'string', 'example' => '8033****'],
'DeviceState' => [
'description' => 'SIP话机设备的状态,如果未注册SIP话机,则状态为UNREGISTERED(未注册),如过SIP话机注册过但是不在线,则状态为OFFLINE(离线),如果SIP话机注册过并且在线则为ONLINE(在线)。',
'type' => 'string',
'enumValueTitles' => ['UNREGISTERED' => '未注册', 'OFFLINE' => '离线', 'ONLINE' => '在线'],
'example' => 'OFFLINE',
],
'Primary' => ['description' => '坐席映射的RAM账户是否为RAM主账号。', 'type' => 'boolean'],
],
],
],
],
],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取坐席列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-22T01:05:26.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2022-01-19T00:08:15.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsers'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"DisplayId\\": \\"1001\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\",\\n \\"PrimaryAccount\\": true,\\n \\"PersonalOutboundNumberList\\": [\\n {\\n \\"Number\\": \\"0830011****\\",\\n \\"Active\\": true,\\n \\"City\\": \\"乐山\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"Province\\": \\"四川\\"\\n }\\n ],\\n \\"SkillLevelList\\": [\\n {\\n \\"SkillLevel\\": 5,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\"\\n }\\n ],\\n \\"RamId\\": 0,\\n \\"Extension\\": \\"8031****\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"DeviceExt\\": \\"8033****\\",\\n \\"DeviceState\\": \\"OFFLINE\\",\\n \\"Primary\\": true\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <LoginName>user-test</LoginName>\\n <Email>1886666****@163.com</Email>\\n <DeviceId>Yealink SIP-T23G 44.84.203.6</DeviceId>\\n <PrimaryAccount>false</PrimaryAccount>\\n <RamId>2022546208793</RamId>\\n <DisplayId>1001</DisplayId>\\n <RoleId>Admin@ccc-test</RoleId>\\n <Mobile>1382114****</Mobile>\\n <Extension>80xxxx31</Extension>\\n <DeviceState>OFFLINE</DeviceState>\\n <RoleName>Admin</RoleName>\\n <UserId>user-test@ccc-test</UserId>\\n <DisplayName>测试用户</DisplayName>\\n <DeviceExt>80xxxx33</DeviceExt>\\n <WorkMode>ON_SITE</WorkMode>\\n <PersonalOutboundNumberList>\\n <Usage>Bidirection</Usage>\\n <Active>true</Active>\\n <Number>083xxxx0011</Number>\\n <City>乐山</City>\\n <Province>四川</Province>\\n </PersonalOutboundNumberList>\\n <SkillLevelList>\\n <SkillGroupName>skg-test</SkillGroupName>\\n <SkillLevel>5</SkillLevel>\\n <SkillGroupId>skg-test@ccc-test</SkillGroupId>\\n </SkillLevelList>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ListVisitorChatMessages' => [
'summary' => '使用ListVisitorChatMessages获取访客聊天记录。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'SortOrder',
'in' => 'query',
'schema' => ['description' => '排序方式,默认为降序。'."\n"
."\n"
.'枚举值:'."\n"
."\n"
.'ASC:升序。'."\n"
."\n"
.'DESC:降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '云联络中心实例。', 'type' => 'string', 'required' => false, 'example' => 'ccc-test'],
],
[
'name' => 'VisitorId',
'in' => 'query',
'schema' => ['description' => '访客ID。', 'type' => 'string', 'required' => false, 'example' => 'fcd020fe-****-1a272a174a7d'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1647325450000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,格式为Unix时间戳,单位毫秒。', 'type' => 'string', 'required' => false, 'example' => '1650316799000'],
],
[
'name' => 'NextPageToken',
'in' => 'query',
'schema' => ['description' => '下一页标识。第一次请求无需传入,服务会返回,第二次请求传入即可。', 'type' => 'string', 'required' => false, 'example' => '1737193352340::7463707254.EAUNIT'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页每页数据集大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
[
'name' => 'AccessToken',
'in' => 'query',
'schema' => ['description' => '网络业务渠道Token。', 'type' => 'string', 'required' => false, 'example' => '9XYGTGWtq2wXzVikKuip_zeVGl6O4VJ-l-*-*-JPofhap4P7fAevuE='],
],
[
'name' => 'AccessChannelId',
'in' => 'query',
'schema' => ['description' => '网络业务渠道ID。', 'type' => 'string', 'required' => false, 'example' => 'cf584733-***-***-9699-cb77aa3b7aa6'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8707EB29-BAED-4302-B999-40BA61877437'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'NextPageToken' => ['description' => '下一页标识。', 'type' => 'string', 'example' => '1737193352340::7463707254.EAUNIT'."\n"],
'Messages' => [
'description' => '消息列表。',
'type' => 'array',
'items' => [
'description' => '消息。',
'type' => 'object',
'properties' => [
'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'chat-65382141036853491'],
'SenderId' => ['description' => '消息发送用户ID。', 'type' => 'string', 'example' => 'fcd020fe-****-1a272a174a7d'."\n"],
'SenderType' => ['description' => '发送方类型。'."\n"
."\n"
.'枚举值'."\n"
.'- **ADMIN**:系统'."\n"
.'- **CUSTOMER**:访客'."\n"
.'- **AGENT**:坐席', 'type' => 'string', 'example' => 'CUSTOMER'],
'Timestamp' => ['description' => '时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1696126980371'],
'Content' => ['description' => '消息内容。', 'type' => 'string', 'example' => '{"variables":{},"text":"Hi,我是小云~ 很高兴遇见你!","contentType":"Text"}'],
'SenderName' => ['description' => '发送者名称。', 'type' => 'string', 'example' => '访客1'],
'SenderAvatarUrl' => ['description' => '发送者头像地址。', 'type' => 'string', 'example' => 'http://xxxxx.com/avatar.png'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Permission.Unauthorized', 'errorMessage' => 'You are not authorized to perform this action. %s privileges are required.', 'description' => '您无权执行此操作。 必须具有指定权限。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"NextPageToken\\": \\"1737193352340::7463707254.EAUNIT\\\\n\\",\\n \\"Messages\\": [\\n {\\n \\"JobId\\": \\"chat-65382141036853491\\",\\n \\"SenderId\\": \\"fcd020fe-****-1a272a174a7d\\\\n\\",\\n \\"SenderType\\": \\"CUSTOMER\\",\\n \\"Timestamp\\": 1696126980371,\\n \\"Content\\": \\"{\\\\\\"variables\\\\\\":{},\\\\\\"text\\\\\\":\\\\\\"Hi,我是小云~ 很高兴遇见你!\\\\\\",\\\\\\"contentType\\\\\\":\\\\\\"Text\\\\\\"}\\",\\n \\"SenderName\\": \\"访客1\\",\\n \\"SenderAvatarUrl\\": \\"http://xxxxx.com/avatar.png\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取访客聊天记录',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ListVoicemails' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc0NRNJB'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页序号,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小,范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '获取的历史数据的起始时间,默认为当天的0时,时间戳为毫秒级。(必填)', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1532448000000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '获取的历史数据的终止时间,默认为当前时间,时间戳为毫秒级。(必填)', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1532707199000'],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => ['description' => '通过指定的contactId来查询某一通电话的记录,contactId可以通过软电话SDK发生通话时获取到。如果传入该参数,则自动忽略其他查询参数。', 'type' => 'string', 'required' => false, 'example' => 'job-125152394144124921'],
],
[
'name' => 'Caller',
'in' => 'query',
'schema' => ['description' => '主叫号码。'."\n"
."\n", 'type' => 'string', 'required' => false, 'example' => '073xxxx7539'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '语音信箱名称。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'voicemail-test'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页序号。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总条目数,只有PageNumber为1才会返回,其他都是0。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'],
'List' => [
'description' => '语音信箱记录列表。',
'type' => 'array',
'items' => [
'description' => '语音信箱记录。',
'type' => 'object',
'properties' => [
'CdrStartTime' => ['description' => '话务开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532448000000,已废弃,请使用StartTime。'],
'Caller' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '073xxxx7539'],
'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-125152394144124921'],
'RecordingDuration' => ['description' => '留言时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '10,已废弃,请使用Duration'],
'InstanceId' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'Name' => ['description' => '语音信箱名称。', 'type' => 'string', 'example' => 'voicemail-test'],
'Callee' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '0533128****'],
'StartTime' => ['description' => '语音信箱开始时间。', 'type' => 'string', 'example' => '1631440860000'],
'Duration' => ['description' => '留言时长,单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '获取语音信箱列表',
'summary' => '调用ListVoicemails获取指定实例下语音信箱列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListVoicemails'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"CdrStartTime\\": 0,\\n \\"Caller\\": \\"073xxxx7539\\",\\n \\"ContactId\\": \\"job-125152394144124921\\",\\n \\"RecordingDuration\\": 0,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"voicemail-test\\",\\n \\"Callee\\": \\"0533128****\\",\\n \\"StartTime\\": \\"1631440860000\\",\\n \\"Duration\\": 16\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListVoicemailsResponse>\\n <Code>OK</Code>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Message>无</Message>\\n <RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>11</TotalCount>\\n <List>\\n <CdrStartTime>1532448000000</CdrStartTime>\\n <Caller>073xxxx7539</Caller>\\n <ContactId>job-125152394144124921</ContactId>\\n <RecordingDuration>10</RecordingDuration>\\n <InstanceId>ccc-test</InstanceId>\\n <Name>voicemail-test</Name>\\n </List>\\n </Data>\\n</ListVoicemailsResponse>","errorExample":""}]',
],
'ListWaitingChats' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SkillGroupIdList',
'in' => 'query',
'schema' => ['description' => '技能组ID列表。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '["skillgroup1@ccc-test", "skillgroup2@ccc-test"]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'],
'Data' => [
'description' => '返回数据。',
'type' => 'array',
'items' => [
'description' => '会话信息。',
'type' => 'object',
'properties' => [
'ChatConversationId' => ['description' => '聊天会话ID。', 'type' => 'string', 'example' => '$23086709$EAUNIT'],
'BeingAssigned' => ['description' => '会话是否已分配坐席。', 'type' => 'boolean', 'example' => 'false'],
'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'chat-434537064047960064'],
'EnqueueTime' => ['description' => '进入队列时刻,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1718868572094'],
'AccessChannelId' => ['description' => '网络业务渠道ID。', 'type' => 'string', 'example' => '843073c2-*****-49fb-a616-738ddddfebdc'],
'AccessChannelType' => ['description' => '网络业务渠道类型。', 'type' => 'string', 'example' => 'Web'],
'UserList' => [
'description' => '用户列表。',
'type' => 'array',
'items' => [
'description' => '用户。',
'type' => 'object',
'properties' => [
'UserName' => ['description' => '用户姓名。', 'type' => 'string', 'example' => '访客-1c***'],
'UserId' => ['description' => '用户ID。', 'type' => 'string', 'example' => 'c361765f-******-4e07-b81c-4b5d9183fac6'."\n"],
'UserType' => ['description' => '用户类型。', 'type' => 'string', 'example' => 'CUSTOMER'],
'AvatarUrl' => ['description' => '头像链接。', 'type' => 'string', 'example' => '无'],
],
],
],
'Messages' => [
'description' => '消息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SenderId' => ['description' => '消息发送用户ID。', 'type' => 'string', 'example' => 'c361765f-******-4e07-b81c-4b5d9183fac6'],
'Content' => ['description' => '内容信息。', 'type' => 'string', 'example' => '测试消息'],
'SenderType' => ['description' => '发送方类型。取值:'."\n"
.'- **CUSTOMER**:访客'."\n"
.'- **AGENT**:坐席', 'type' => 'string', 'example' => '{"variables":{},"text":"<p>这种的名片选单面还是双面</p>"}'],
],
'description' => '',
],
],
'SkillGroupId' => ['description' => '技能组信息。', 'type' => 'string', 'example' => 'skill@ccc-test'],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Data\\": [\\n {\\n \\"ChatConversationId\\": \\"$23086709$EAUNIT\\",\\n \\"BeingAssigned\\": false,\\n \\"JobId\\": \\"chat-434537064047960064\\",\\n \\"EnqueueTime\\": 1718868572094,\\n \\"AccessChannelId\\": \\"843073c2-*****-49fb-a616-738ddddfebdc\\",\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"UserList\\": [\\n {\\n \\"UserName\\": \\"访客-1c***\\",\\n \\"UserId\\": \\"c361765f-******-4e07-b81c-4b5d9183fac6\\\\n\\",\\n \\"UserType\\": \\"CUSTOMER\\",\\n \\"AvatarUrl\\": \\"无\\"\\n }\\n ],\\n \\"Messages\\": [\\n {\\n \\"SenderId\\": \\"c361765f-******-4e07-b81c-4b5d9183fac6\\",\\n \\"Content\\": \\"测试消息\\",\\n \\"SenderType\\": \\"{\\\\\\"variables\\\\\\":{},\\\\\\"text\\\\\\":\\\\\\"<p>这种的名片选单面还是双面</p>\\\\\\"}\\"\\n }\\n ],\\n \\"SkillGroupId\\": \\"skill@ccc-test\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取队列中的聊天',
'summary' => '坐席通过ListWaitingChats获取队列中等待分配或认领的聊天。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'MakeCall' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '50581',
'abilityTreeNodes' => ['FEATUREcccIPHVDY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '发起外呼的坐席ID,非必填,不填默认使用当前RAM账号映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
[
'name' => 'Caller',
'in' => 'query',
'schema' => ['description' => '主叫号码,如果是内部呼叫,这此参数无效,如果是外部呼叫,此参数为当前坐席可用的外呼号码,需要确保该号码可外呼且坐席对该号码有使用权,使用权通过两种途径获得,一是将号码绑定到当前坐席签入的技能组上,二是将号码设置为坐席的个人外呼号码。', 'type' => 'string', 'required' => false, 'example' => '010989****'],
],
[
'name' => 'Callee',
'in' => 'query',
'schema' => ['description' => '被叫号码,如果是内部呼叫,该字段填写目标坐席的分机号,如果是外呼呼叫,填写客户的电话号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1318888****'],
],
[
'name' => 'TimeoutSeconds',
'in' => 'query',
'schema' => ['description' => '超时时间,呼叫在经过该参数指定的时间仍然未接通的情况下,则主动挂断,取值范围30-300,单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '300', 'minimum' => '30', 'example' => '30'],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => ['description' => '随路数据,客户无需关心。', 'type' => 'string', 'required' => false, 'example' => 'tags'],
],
[
'name' => 'MaskedCallee',
'in' => 'query',
'schema' => ['description' => '脱敏后的被叫号码,如果该字段不为空,表示需要对被叫号码脱敏,脱敏规则由客户自行定义,只需将脱敏后的被叫号码填入即可,使用脱敏被叫会导致某些场景下看到的是脱敏后的被叫号码,无法查看真实被叫号码。', 'type' => 'string', 'required' => false, 'example' => '131****8888'],
],
[
'name' => 'MediaType',
'in' => 'query',
'schema' => ['description' => '媒体类型,默认是语音(AUDIO), 其他可选参数包括VIDEO。', 'type' => 'string', 'required' => false, 'example' => 'AUDIO'],
],
[
'name' => 'FlashSmsVariables',
'in' => 'query',
'schema' => ['description' => '闪信配置', 'type' => 'string', 'required' => false, 'example' => '{\\"applicationId\\":\\"6bd18325-ea7f-4881-8902-4d06283d3b3b\\",\\"templateId\\":\\"1722217249064\\"}'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。'."\n",
'type' => 'object',
'properties' => [
'ContextId' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6570007401392****'],
'CallVariables' => ['description' => '随路数据。通过SIP信令传递的自定义数据。', 'type' => 'string', 'example' => 'a=b;c=d'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '无'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'NONE',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '8001****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'],
'example' => 'MONITORING',
],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609225718295'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '无'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6570007401392****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '1318888****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8001****'],
'MediaType' => ['description' => '媒体类型,默认是语音(AUDIO), 其他可选参数包括VIDEO。', 'type' => 'string', 'example' => 'Audio'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8001****'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6570007401392****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'READY',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'UserBusy', 'errorMessage' => 'The user %s you called was busy. Please try again later.', 'description' => '您呼叫的用户正忙,请稍后再试。'],
['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''],
['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作,用户状态不符合预期。'],
],
404 => [
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.Extension', 'errorMessage' => 'No available extension number exists.', 'description' => '没有可分配的分机号。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 123456,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"CallVariables\\": \\"a=b;c=d\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"NONE\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609225718295,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8001****\\",\\n \\"MediaType\\": \\"Audio\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>26A34338-5CD9-4C95-A7A6-5BDCE76C6B94</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <ContextId>123456</ContextId>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65700074013925376</JobId>\\n <ChannelContexts>\\n <Destination>8001****</Destination>\\n <ChannelState>NONE</ChannelState>\\n <ReleaseReason>无</ReleaseReason>\\n <Originator>1318888****</Originator>\\n <ChannelFlags>[]</ChannelFlags>\\n <ReleaseInitiator>无</ReleaseInitiator>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>8001****</UserExtension>\\n <CallType>OUTBOUND</CallType>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:131888****->8001****:1609225718294:job-65700074013925376</ChannelId>\\n <Timestamp>1609225718295</Timestamp>\\n <JobId>job-65700074013925376</JobId>\\n </ChannelContexts>\\n </CallContext>\\n <UserContext>\\n <Extension>8001****</Extension>\\n <UserState>READY</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <BreakCode>Warm-up</BreakCode>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-bsd87c04aaa8f7000176ad354b1c</DeviceId>\\n <OutboundScenario>false</OutboundScenario>\\n <JobId>job-65700074013925376</JobId>\\n <WorkMode>ON_SITE</WorkMode>\\n <SignedSkillGroupIdList>[\\"skill-group@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
'title' => '发起呼叫',
'summary' => '调用MakeCall发起呼叫,被叫可以是内部坐席,也可以是外部客户 。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-04-08T07:49:03.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-08-30T02:20:48.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-01-11T08:11:36.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2023-10-26T08:13:46.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-11-29T08:23:20.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-18T13:14:10.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MakeCall'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ModifyAudioFile' => [
'summary' => '调用ModifyAudioFile修改指定实例下指定音频资源ID对应的音频文件。可以修改音频文件名称、音频文件展示名和音频文件在OSS中的Key。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccKYIENB'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'AudioResourceId',
'in' => 'query',
'schema' => ['description' => '音频资源ID,唯一标识一个音频文件。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acc300c4-75c9-41ba-ba5e-2a365c96c248'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '音频文件的展示名,长度为1-32个字符,修改音频文件时无法修改展示名,因此此处需要填写音频文件原始的展示名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '欢迎语'],
],
[
'name' => 'OssFileKey',
'in' => 'query',
'schema' => ['description' => '待修改的音频文件在OSS中的Key。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test/new-test-file.wav'],
],
[
'name' => 'AudioFileName',
'in' => 'query',
'schema' => ['description' => '待修改的音频文件名称,可以填写新的音频文件内容。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'new-test-file.wav'],
],
[
'name' => 'Usage',
'in' => 'query',
'schema' => ['description' => '音频文件用途,默认为General(用于IVR等场景), 其他可选值为HoldMusic(通话保持等待音)。', 'type' => 'string', 'required' => false, 'example' => 'General'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D2F84AAC-7C79-547F-8EE9-7B735F42B93F'],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '修改音频文件',
'changeSet' => [
['createdAt' => '2023-11-17T01:12:04.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAudioFile'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D2F84AAC-7C79-547F-8EE9-7B735F42B93F\\"\\n}","type":"json"}]',
],
'ModifyCampaignNumbers' => [
'summary' => '修改批量预测式外呼活动的主叫号码。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccQFUGXR'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'CampaignId',
'in' => 'query',
'schema' => ['title' => '活动ID', 'description' => '活动ID。', 'type' => 'string', 'required' => true, 'example' => '6badb397-****-****-21019d382a09'],
],
[
'name' => 'InstGroupId',
'in' => 'query',
'schema' => ['title' => '号码集合ID', 'description' => '号码集合ID。', 'type' => 'string', 'required' => false, 'example' => '3971876649-****-****-098763a382a09'."\n"],
],
[
'name' => 'NumberList',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '号码列表',
'description' => '号码列表。',
'type' => 'array',
'items' => ['description' => '号码。', 'type' => 'string', 'required' => false, 'example' => '["0830011xxxx", "0830312xxxx"]'],
'required' => false,
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ModifyCampaignNumbersResponse',
'description' => 'ModifyCampaignNumbersResponse',
'type' => 'object',
'properties' => [
'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '修改预测式外呼活动主叫号码',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ModifyCustomCallTagging' => [
'summary' => '调用ModifyCustomCallTagging修改指定实例下指定号码对应的呼入号码标记的信息,可以修改呼入号码标记的描述和绑定的号码标签。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => ['description' => '呼入号码标记的号码,会根据号码匹配待修改的呼入号码标记。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1312121****'],
],
[
'name' => 'CallTagNameList',
'in' => 'query',
'schema' => ['description' => '号码标签名称列表,请传入待修改的完整的号码标签列表,确保号码标签已创建。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["TagA","TagB"]'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '新的呼入号码标记描述,非必填,默认为空,为空表示不修改。', 'type' => 'string', 'required' => false, 'example' => '王先生'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
['errorCode' => 'LimitExceed.CallTagsPerNumber', 'errorMessage' => 'The total number of call tag of numbers exceeds the limit %s.', 'description' => '号码标签数量超出单个呼入号码标记的上线阈值。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.CustomCallTagging', 'errorMessage' => 'Custom call tagging %s does not exist in instance %s.', 'description' => '呼入号码标记不存在。'],
],
500 => [
['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'],
],
],
'title' => '修改呼入号码标记',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-02-24T14:31:19.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCustomCallTagging'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>无</Message>\\n<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]',
],
'ModifyInstance' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccTMAX45'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '实例的描述,长度不超过256个字符。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '新的实例描述。'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '83TKE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '无'],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '修改实例',
'summary' => '调用ModifyInstance修改云联络中心实例。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstance'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"83TKE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>83TKE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>无</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ModifyPhoneNumber' => [
'summary' => '调用ModifyPhoneNumber修改指定实例下指定号码的信息,主要是修改号码用途和绑定的联系流ID。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => ['description' => '号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0102134****'],
],
[
'name' => 'Usage',
'in' => 'query',
'schema' => [
'description' => '号码用途。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['Outbound' => '呼出', 'Inbound' => '呼入', 'Bidirection' => '呼入和呼出'],
'example' => 'Bidirection',
'maxLength' => 200,
'minLength' => 1,
],
],
[
'name' => 'ContactFlowId',
'in' => 'query',
'schema' => ['description' => '号码绑定的IVR联系流ID,仅在号码用途为Inbound或Bidirection时,该字段才有效。', 'type' => 'string', 'required' => false, 'example' => '78128960-bb00-4ddc-8a82-923a8c5bd22d'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.Number', 'errorMessage' => 'The specified number %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的号码。'],
],
],
'title' => '修改号码',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPhoneNumber'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]',
],
'ModifySkillGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccPBOQGO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'],
],
[
'name' => 'DisplayName',
'in' => 'query',
'schema' => ['description' => '技能组展示名,长度为1-64个字符。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '新测试技能组', 'maxLength' => 200, 'minLength' => 1],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '技能组的描述,非必填,默认为空。', 'type' => 'string', 'required' => false, 'example' => '云联络中心的新测试技能组。'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的技能组ID。'],
],
],
'title' => '修改技能组',
'summary' => '调用ModifySkillGroup修改指定实例下指定技能组ID对应的技能组的信息,主要是修改技能组展示名和技能组的描述信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySkillGroup'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]',
],
'ModifySkillLevelsOfUser' => [
'summary' => '修改指定实例下指定坐席的一个或多个技能组下的技能等级。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'SkillLevelList',
'in' => 'query',
'schema' => ['description' => '技能组的技能等级列表,格式为JSON数组的字符串,数组元素是一个对象,包含两个字段:skillGroupId和skillLevel,skillGroupId填写想要修改的技能组ID,skillLevel填写想要修改的技能等级,取值范围1-10,值越小,业务能力越强,单位时间内能处理更多的通话。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"skillGroupId":"skillgroup1@ccc-test","skillLevel":1},{"skillGroupId":"skillgroup2@ccc-test","skillLevel":10}]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E49D8B83-A3EC-44D4-A920-578BC3C698AD'],
'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '无'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
403 => [
['errorCode' => 'Permission.User', 'errorMessage' => 'You have no permission to access user(s) %s.', 'description' => '您无权访问这些用户。'],
['errorCode' => 'Permission.SkillGroup', 'errorMessage' => 'You have no permission to access skill group(s) %s.', 'description' => '您无权访问这些技能组。'],
],
[
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '修改坐席的多个技能等级',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-17T01:12:02.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySkillLevelsOfUser'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"E49D8B83-A3EC-44D4-A920-578BC3C698AD\\",\\n \\"Data\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>E49D8B83-A3EC-44D4-A920-578BC3C698AD</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Code>OK</Code>","errorExample":""}]',
],
'ModifyUser' => [
'summary' => '调用ModifyUser修改指定实例下指定坐席的信息,可修改电话号码、工作模式、角色和工号。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'user-test@ccc-test'],
],
[
'name' => 'Mobile',
'in' => 'query',
'schema' => ['description' => '坐席个人电话号码。', 'type' => 'string', 'required' => false, 'example' => '1382114****'],
],
[
'name' => 'WorkMode',
'in' => 'query',
'schema' => [
'description' => '工作模式。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
],
[
'name' => 'RoleId',
'in' => 'query',
'schema' => ['description' => '角色ID,格式为:角色@实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Admin@ccc-test'],
],
[
'name' => 'DisplayId',
'in' => 'query',
'schema' => ['description' => '坐席的工号。', 'type' => 'string', 'required' => false, 'example' => '1001'],
],
[
'name' => 'DisplayName',
'in' => 'query',
'schema' => ['description' => '用户的全名', 'type' => 'string', 'required' => false, 'example' => '张三疯'],
],
[
'name' => 'Force',
'in' => 'query',
'schema' => ['description' => '是否强制修改。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Nickname',
'in' => 'query',
'schema' => ['description' => '坐席昵称', 'type' => 'string', 'required' => false, 'example' => '老王'],
],
[
'name' => 'AvatarUrl',
'in' => 'query',
'schema' => ['description' => '坐席头像地址。', 'type' => 'string', 'required' => false, 'example' => 'http://abc.com/sam.jpb'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
403 => [
['errorCode' => 'Permission.Common', 'errorMessage' => 'You have no permission to access. %s', 'description' => '您无权进行访问。'],
['errorCode' => 'Permission.SkillGroup', 'errorMessage' => 'You have no permission to access skill group(s) %s.', 'description' => '您无权访问这些技能组。'],
],
[
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.RoleId', 'errorMessage' => 'Role %s does not exist.', 'description' => '指定的角色不存在。'],
],
500 => [
['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'],
['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'],
],
],
'title' => '修改坐席',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-17T01:12:03.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2023-04-14T05:54:04.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2021-12-21T08:08:33.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyUser'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>无</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ModifyUserLevelsOfSkillGroup' => [
'summary' => '调用ModifyUserLevelsOfSkillGroup修改指定实例下指定技能组下属的一个或多个坐席的技能等级。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'],
],
[
'name' => 'UserLevelList',
'in' => 'query',
'schema' => ['description' => '坐席技能等级列表,格式为JSON数组的字符串,数组元素是一个对象,包含两个字段:userId和skillLevel,userId填写想要修改的坐席ID,skillLevel填写想要修改的技能等级,取值范围1-10,值越小,业务能力越强,单位时间内能处理更多的通话。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"userId":"agent1@ccc-test","skillLevel":1},{"userId":"agent2@ccc-test","skillLevel":10}]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E49D8B83-A3EC-44D4-A920-578BC3C698AD'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的技能组ID。'],
],
500 => [
['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'],
],
],
'title' => '修改技能组的多个坐席等级',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyUserLevelsOfSkillGroup'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"E49D8B83-A3EC-44D4-A920-578BC3C698AD\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>E49D8B83-A3EC-44D4-A920-578BC3C698AD</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>无</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'MonitorCall' => [
'summary' => '调用MonitorCall监听指定实例下指定通话ID对应的通话。通话必须处于坐席和客户双方正常接通状态,且发起监听的坐席有权限对被监听坐席进行监听。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
[
'name' => 'MonitoredUserId',
'in' => 'query',
'schema' => ['description' => '被监听的座席的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent2@ccc-test'],
],
[
'name' => 'TimeoutSeconds',
'in' => 'query',
'schema' => ['description' => '监听超时时间,经过指定的时间监听仍未成功,则取消监听,正常情况下,监听操作会马上成功,设置超时时间是为了防止异常发生,此字段选填,默认30,单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'Index' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'CREATED',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'],
'example' => 'MONITORING',
],
'SkillGroupId' => ['description' => '话务通道关联的技能组ID,呼入场景下,关联的技能组ID由IVR中转人工模块配置的技能组决定,呼出场景下,关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => ' - OFFICE_PHONE(办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'BREAK',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''],
['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作,用户状态不符合预期。'],
],
404 => [
['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'],
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'],
],
],
'title' => '监听通话',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-10-26T08:13:46.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MonitorCall'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>1</Index>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <AssociatedData/>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'MuteCall' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '被静音的坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6581536084722****'],
],
[
'name' => 'ChannelId',
'in' => 'query',
'schema' => ['description' => '待静音的话务通道ID,非必填,默认为空,为空表示静音UserId对应的坐席的话务通道。', 'type' => 'string', 'required' => false, 'example' => 'ch:user:1318888****->8001****:1609253204816:job-6581536084722****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => 'A275B008-A25B-494D-AB53-93CE253815B6'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。'."\n",
'type' => 'object',
'properties' => [
'CallContext' => [
'description' => '话务上下文环境。'."\n",
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '通话类型。'."\n",
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。'."\n", 'type' => 'string', 'example' => 'job-6581536084722****'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'Index' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '无'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'ANSWERED',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '8001****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'],
'example' => '[MUTED]',
],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609253212511'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '无'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6581536084722****'],
'ChannelId' => ['description' => '话务通道ID。'."\n", 'type' => 'string', 'example' => 'ch:user:1318888****->8001****:1609253204816:job-6581536084722****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8001****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '1318888****'],
'SkillGroupId' => ['description' => '话务通道关联的技能组ID,呼入场景下,关联的技能组ID由IVR中转人工模块配置的技能组决定,呼出场景下,关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。'."\n",
'type' => 'object',
'properties' => [
'Extension' => ['description' => '座席分机号。', 'type' => 'string', 'example' => '8001****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609253205896'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609253204811'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1390000****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6581536084722****'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'TALKING',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''],
['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作,用户状态不符合预期。'],
],
404 => [
['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'],
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'],
],
],
'title' => '静音通话',
'summary' => '调用MuteCall静音指定实例下指定通话ID对应的通话,只能由正在通话状态的坐席调用,且只能静音调用者自己,坐席静音后,客户将无法听见坐席的声音。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-01-18T12:07:41.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-11-06T05:44:48.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MuteCall'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"A275B008-A25B-494D-AB53-93CE253815B6\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6581536084722****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"[MUTED]\\",\\n \\"Timestamp\\": 1609253212511,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6581536084722****\\",\\n \\"ChannelId\\": \\"ch:user:1318888****->8001****:1609253204816:job-6581536084722****\\",\\n \\"UserExtension\\": \\"8001****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609253205896,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609253204811,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"job-6581536084722****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>A275B008-A25B-494D-AB53-93CE253815B6</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65815360847228928</JobId>\\n <ChannelContexts>\\n <Destination>8001****</Destination>\\n <ChannelState>ANSWERED</ChannelState>\\n <ReleaseInitiator>无</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>1</Index>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:1318888****-&gt;8001****:1609253204816:job-65815360847228928\\"</ChannelId>\\n <Timestamp>1609253212511</Timestamp>\\n <ReleaseReason>无</ReleaseReason>\\n <Originator>1318888****</Originator>\\n <ChannelFlags>[]</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>8001****</UserExtension>\\n <JobId>job-65815360847228928</JobId>\\n </ChannelContexts>\\n </CallContext>\\n <UserContext>\\n <Extension>8001****</Extension>\\n <UserState>TALKING</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <BreakCode>Warm-up</BreakCode>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-bs736efb521810000176aef6e955</DeviceId>\\n <Heartbeat>1609253205896</Heartbeat>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>1390000****</Mobile>\\n <JobId>job-65815360847228928</JobId>\\n <WorkMode>ON_SITE</WorkMode>\\n <Reserved>1609253204811</Reserved>\\n <SignedSkillGroupIdList>[\\"skill-group@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'PauseCampaign' => [
'summary' => '调用PauseCampaign暂停指定实例下指定ID对应的预测式外呼活动。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CampaignId',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '4A68E287-6888-5ADB-8048-DB488B4DEF35'],
'Code' => ['title' => 'code', 'description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['title' => 'message', 'description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4A68E287-6888-5ADB-8048-DB488B4DEF35\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
'title' => '暂停预测式外呼活动',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PauseCampaign'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'PickOutboundNumbers' => [
'summary' => '调用PickOutboundNumbers根据传入的被叫号码选择适合的主叫号码,选号逻辑由智能算法控制。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CalledNumber',
'in' => 'query',
'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1388888****'],
],
[
'name' => 'Count',
'in' => 'query',
'schema' => ['description' => '希望返回的可选号码数量, 默认1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '3', 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'SkillGroupIdList',
'in' => 'query',
'schema' => ['description' => '技能组ID集合,格式为JSON数组的字符串,数组元素是技能组ID,号码与技能组是关联的,此参数用于指定从哪些技能组挑选号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["skillgroup@ccc-test"]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Callee' => [
'description' => '被叫号码。',
'type' => 'object',
'properties' => [
'Number' => ['description' => '号码', 'type' => 'string', 'example' => '1388888****'],
'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '北京'],
'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '北京'],
],
],
'Caller' => [
'description' => '主叫号码。',
'type' => 'object',
'properties' => [
'Number' => ['description' => '号码', 'type' => 'string', 'example' => '0108989****'],
'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '北京'],
'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '北京'],
],
],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '选择外呼号码',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": [\\n {\\n \\"Callee\\": {\\n \\"Number\\": \\"1388888****\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\"\\n },\\n \\"Caller\\": {\\n \\"Number\\": \\"0108989****\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Callee>\\n <Number>1388888****</Number>\\n <City> 北京</City>\\n <Province>北京</Province>\\n </Callee>\\n <Caller>\\n <Number>0108989****</Number>\\n <City>北京</City>\\n <Province>北京</Province>\\n </Caller>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'PollUserStatus' => [
'summary' => '轮询指定实例下指定坐席的坐席状态,一般由前端坐席工作台调用,用于同步坐席状态。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'ContextId' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '103655'],
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'Index' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'CREATED',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'],
'example' => 'MONITORING',
],
'SkillGroupId' => ['description' => '话务通道关联的技能组ID,呼入场景下,关联的技能组ID由IVR中转人工模块配置的技能组决定,呼出场景下,关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'ChannelVariables' => ['description' => '随路数据。', 'type' => 'string', 'example' => '123'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'],
],
],
],
'CallVariables' => ['description' => '随路数据。通过SIP信令传递的自定义数据。', 'type' => 'string', 'example' => 'a=b;c=d'],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'BREAK',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
'ParallelJobList' => [
'description' => '坐席当前正在处理和已经处理完的Chat会话',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'JobId' => ['description' => '会话ID', 'type' => 'string', 'example' => 'job-6538214103685****'."\n"],
'Status' => ['description' => '客服在这个会话中的状态。'."\n"
.'### 枚举值:'."\n"
.'- RINGING'."\n"
.'- TALKING'."\n"
.'- RELEASED(结束)'."\n"
.'- MISSED(未接)', 'type' => 'string', 'example' => 'RINGING'],
'Timestamp' => ['description' => '状态变更的时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
],
'description' => '',
],
],
],
],
'ChatContexts' => [
'description' => '会话上下文环境。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'chat-65382141036853491'."\n"],
'ChatType' => ['description' => '会话类型。', 'type' => 'string', 'example' => 'INBOUND'],
'CallVariables' => ['description' => '随路数据。', 'type' => 'string', 'example' => '无'],
'Members' => [
'description' => '参与这个 Chat会话的坐席和客户的信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Index' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'."\n"],
'UserType' => ['description' => '用户类型。'."\n"
."\n"
.'枚举值:'."\n"
.'- CUSTOMER:客户'."\n"
.'- AGENT:坐席', 'type' => 'string', 'example' => 'Manager'],
'Status' => ['description' => '客服在这个会话中的状态。'."\n"
."\n"
.'枚举值:'."\n"
.'- RINGING'."\n"
.'- TALKING'."\n"
.'- RELEASED(结束)'."\n"
.'- MISSED(未接)', 'type' => 'string', 'example' => 'RINGING'],
'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'a527a80a-75cf-448f-aba0-fca37c61946d'],
'ReleaseInitiator' => ['description' => '挂断方。', 'type' => 'string', 'example' => 'User'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '无'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
],
'title' => '轮询坐席状态',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-17T01:12:03.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2022-11-28T06:51:14.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PollUserStatus'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103655,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"ChannelVariables\\": \\"123\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ],\\n \\"CallVariables\\": \\"a=b;c=d\\"\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ],\\n \\"ParallelJobList\\": [\\n {\\n \\"JobId\\": \\"job-6538214103685****\\\\n\\",\\n \\"Status\\": \\"RINGING\\",\\n \\"Timestamp\\": 1609136956378\\n }\\n ]\\n },\\n \\"ChatContexts\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"chat-65382141036853491\\\\n\\",\\n \\"ChatType\\": \\"INBOUND\\",\\n \\"CallVariables\\": \\"无\\",\\n \\"Members\\": [\\n {\\n \\"Index\\": 1,\\n \\"UserId\\": \\"agent@ccc-test\\\\n\\",\\n \\"UserType\\": \\"Manager\\",\\n \\"Status\\": \\"RINGING\\",\\n \\"SkillGroupId\\": \\"a527a80a-75cf-448f-aba0-fca37c61946d\\",\\n \\"ReleaseInitiator\\": \\"User\\",\\n \\"ReleaseReason\\": \\"无\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <ContextId/>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>1</Index>\\n <AssociatedData>无</AssociatedData>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <ChannelVariables>123</ChannelVariables>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n <UserContext>\\n <Extension>80326034</Extension>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <BreakCode>Warm-up</BreakCode>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <JobId>job-65382141036853491</JobId>\\n <WorkMode>ON_SITE</WorkMode>\\n <Reserved>1609136956378</Reserved>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ProcessCustomIMCallback' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '263383',
'abilityTreeNodes' => ['FEATUREcccD72NOC'],
],
'parameters' => [
[
'name' => 'AccessChannelId',
'in' => 'formData',
'schema' => ['description' => '网络业务渠道ID。', 'type' => 'string', 'required' => true, 'example' => 'cf584733-***-***-9699-cb77aa3b7aa6'],
],
[
'name' => 'ConversationId',
'in' => 'formData',
'schema' => ['description' => '会话id', 'type' => 'string', 'required' => true, 'example' => 'd165de4f-9851-445e-9535-66ebfa72fa51'],
],
[
'name' => 'SenderId',
'in' => 'formData',
'schema' => ['description' => '消息发送者用户ID。', 'type' => 'string', 'required' => true, 'example' => '63061274befd6b545aab4c83'],
],
[
'name' => 'SenderName',
'in' => 'formData',
'schema' => ['description' => '发送者名称。', 'type' => 'string', 'required' => false, 'example' => 'tom'],
],
[
'name' => 'RequestId',
'in' => 'formData',
'schema' => ['description' => '请求ID', 'type' => 'string', 'required' => false, 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'],
],
[
'name' => 'SenderAvatarMediaId',
'in' => 'formData',
'schema' => ['description' => '头像id', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
],
[
'name' => 'MessageContent',
'in' => 'formData',
'schema' => ['description' => '消息内容', 'type' => 'string', 'required' => true, 'example' => '消息内容,格式如下:'."\n"
."\n\n"
.'文本消息:'."\n"
.'{ "contentType":"Text", "text":"你好 " }'."\n"
."\n"
.'图片消息:'."\n"
.'{ "contentType":"Image", "mediaId": "xxx-xxx-xxx", "fileType": "png", "fileSize": 1233 }'."\n"
."\n"
.'视频消息:'."\n"
.'{ "contentType":"Video", "mediaId": "xxx-xxx-xxx" "duration": 12, "fileSize": 1233, }'."\n"
."\n"
.'音频消息:'."\n"
.'{ "contentType":"Audio", "mediaId": "xxx-xxx-xxx" "duration": 12, "fileSize": 1233 }'."\n"
."\n"
.'文件消息:'."\n"
.'{ "contentType":"File", "mediaId": "xxx-xxx-xxx", "fileSize": 223232, "filename": "xyz. zip" }'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ProcessDingTalkRobotCallbackResponse',
'description' => 'ProcessDingTalkRobotCallbackResponse',
'type' => 'object',
'properties' => [
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'chat-65382141036853491'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5'],
'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '[\'OFFLINE\', \'BREAK,READY,WORKING\']'],
],
'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '无'],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JobId\\": \\"chat-65382141036853491\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"[\'OFFLINE\', \'BREAK,READY,WORKING\']\\"\\n ],\\n \\"Data\\": \\"无\\"\\n}","type":"json"}]',
'title' => '第三方IM消息回调',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'PublishContactFlow' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccTPIKHY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'ContactFlowId',
'in' => 'query',
'schema' => ['description' => '联系流ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b0a063bf-f138-42a4-ad9f-9babe3ec1a9e'],
],
[
'name' => 'DraftId',
'in' => 'query',
'schema' => ['description' => '草稿ID,当前联系流对应的草稿版本ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0e0b8e78-af3e-4360-a5c5-f9bb5c2b8af2'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => 'BFB6788F-20D4-5767-BC67-99EAAC28F789'],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '发布联系流',
'summary' => '发布联系流。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishContactFlow'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BFB6788F-20D4-5767-BC67-99EAAC28F789\\"\\n}","type":"json"}]',
],
'ReadyForService' => [
'summary' => '调用ReadyForService使指定实例下的指定坐席就绪,就绪后坐席进入空闲状态。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID,不填默认为当前RAM账户映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'user-test@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
[
'name' => 'OutboundScenario',
'in' => 'query',
'schema' => ['description' => '上线后是否进入仅外呼模式,选填,默认false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => 'CC49060B-87ED-489A-AD3D-00E57775DBFF'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8001****'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up'."\n",
],
'InstanceId' => ['description' => '实例ID。'."\n"
."\n", 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'READY',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''],
['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作,用户状态不符合预期。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
],
'title' => '坐席就绪',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-10-26T08:13:46.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReadyForService'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"CC49060B-87ED-489A-AD3D-00E57775DBFF\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\\\n\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>CC49060B-87ED-489A-AD3D-00E57775DBFF</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Extension>80011474</Extension>\\n <UserState>OFFLINE</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <UserId>user-test@ccc-test</UserId>\\n <OutboundScenario>false</OutboundScenario>\\n <WorkMode>ON_SITE</WorkMode>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'RedialCall' => [
'summary' => '重拨脱敏后的话单中的号码',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abc'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '座席用户ID信息。', 'type' => 'string', 'required' => false, 'example' => 'samzhang@abc'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '座席端提供的唯一ID,用来表示一个座席工作台。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'CCC-x.x.x.x-chrome102-bsdf911812c60f61e'],
],
[
'name' => 'Caller',
'in' => 'query',
'schema' => ['description' => '主叫号码。', 'type' => 'string', 'required' => false, 'example' => '0109810****'],
],
[
'name' => 'Callee',
'in' => 'query',
'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1318888****'],
],
[
'name' => 'TimeoutSeconds',
'in' => 'query',
'schema' => ['description' => '超时时间,呼叫在经过该参数指定的时间仍然未接通的情况下,则主动挂断。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '300', 'minimum' => '30', 'example' => '30'],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => ['description' => '随路数据,不能超过128字节,主要用于扩展需求,普通客户无需关心。', 'type' => 'string', 'required' => false, 'example' => 'a=b'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '话务ID。用来重拨的上一通电话的话务ID。', 'type' => 'string', 'required' => false, 'example' => 'job-6581536084722****'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '状态码。返回OK代表请求成功,其他错误码详见错误码列表。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BF268B34-09C2-43FD-BAC4-5D31EA63****'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => 'skillGroupId'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'ContextId' => ['description' => '上下文ID,严格有序递增。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789'],
'CallContext' => [
'description' => '话务上下文环境。'."\n",
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '呼叫类型, 最初发起呼叫时的类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'InstanceId' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'example' => 'abc'],
'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '139xxxx0501'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'CREATED',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '8001****'],
'UserId' => ['description' => '座席用户ID信息。', 'type' => 'string', 'example' => 'samzhang@abc'],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'],
'example' => 'COACHING',
],
'Timestamp' => ['description' => '状态数据上次变更时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '486:USER_BUSY'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'JobId' => ['description' => '话务ID。'."\n", 'type' => 'string', 'example' => 'job-6573574060089****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '1318888****'],
'UserExtension' => ['description' => '用户分机号。', 'type' => 'string', 'example' => '8000****'."\n"],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '用户分机号。', 'type' => 'string', 'example' => '8000****'],
'WorkMode' => ['description' => '工作模式。枚举值:'."\n"
.'- ON_SITE: 场内模式'."\n"
.'- OFF_SITE: 场外模式'."\n"
.'- OFFICE_PHONE: 办公电话模式', 'type' => 'string', 'example' => 'ON_SITE'."\n"],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'CCC-x.x.x.x-chrome102-bsdf911812c60f61e'."\n"],
'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'job-6573574060089****'],
'UserId' => ['description' => '座席用户ID信息。', 'type' => 'string', 'example' => 'samzhang@abc'."\n"],
'BreakCode' => ['description' => '小休状态码,分为系统定义和客户定义两种。'."\n"
."\n"
.'系统定义的小休码:'."\n"
.'- Warm-up:坐席上线后置闲前的临时小休状态'."\n"
.'- RingingTimeout: 坐席振铃超时导致的小休'."\n"
.'- RejectCall:坐席拒接导致的小休'."\n"
."\n"
.'客户自定义状态码没有限制,客户可以根据业务需要自行定义。', 'type' => 'string', 'example' => 'Warm-up'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'abc'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'False'],
'UserState' => ['description' => '座席状态。枚举值:'."\n"
.'- READY: 空闲'."\n"
.'- WORKING: 话后处理中'."\n"
.'- DIALING: 拨号中'."\n"
.'- BREAK: 小休'."\n"
.'- OFFLINE: 离线'."\n"
.'- TALKING: 通话中'."\n"
.'- RINGING: 振铃中', 'type' => 'string', 'example' => 'READY'],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '坐席签入的技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@abc'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'UserBusy', 'errorMessage' => 'The user %s you called was busy. Please try again later.', 'description' => '您呼叫的用户正忙,请稍后再试。'],
['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''],
['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作,用户状态不符合预期。'],
],
404 => [
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.Extension', 'errorMessage' => 'No available extension number exists.', 'description' => '没有可分配的分机号。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'],
],
],
'title' => '重拨',
'changeSet' => [
['createdAt' => '2023-10-26T08:13:46.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-12-30T02:49:39.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RedialCall'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BF268B34-09C2-43FD-BAC4-5D31EA63****\\",\\n \\"Params\\": [\\n \\"skillGroupId\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 123456789,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"abc\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"139xxxx0501\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"samzhang@abc\\",\\n \\"ChannelFlags\\": \\"COACHING\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"486:USER_BUSY\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8000****\\\\n\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8000****\\",\\n \\"WorkMode\\": \\"ON_SITE\\\\n\\",\\n \\"DeviceId\\": \\"CCC-x.x.x.x-chrome102-bsdf911812c60f61e\\\\n\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"UserId\\": \\"samzhang@abc\\\\n\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"abc\\",\\n \\"OutboundScenario\\": true,\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@abc\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
],
'RegisterDevice' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,用户可自行设置,无特殊要求,字符串形式即可。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-device'],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['description' => '设备密码,该密码用于在SIP设备发起注册信令时做鉴权校验,请妥善保管。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'password'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be blank.', 'description' => ''],
],
],
'title' => '注册设备',
'summary' => '调用RegisterDevice注册SIP设备到指定实例下的指定坐席, SIP设备可以是SIP话机或SIP软电话。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterDevice'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Code>OK</Code>","errorExample":""}]',
],
'RegisterDevices' => [
'summary' => '调用RegisterDevices注册一个或多个SIP设备到指定实例下的指定坐席,SIP设备可以是SIP话机或SIP软电话。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserIdListJson',
'in' => 'query',
'schema' => ['description' => ' 座席ID列表,格式为JSON数组的字符串,数组元素是坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '["user-test@ccc-test"]'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,用户可自行设置,无特殊要求,字符串形式即可。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-device'],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['description' => '设备密码,该密码用于在SIP设备发起注册信令时做鉴权校验,请妥善保管。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'password'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'Params' => [
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
],
'title' => '注册多个设备',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-01-19T00:08:15.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterDevices'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Code>OK</Code>","errorExample":""}]',
],
'RejectChat' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '话务ID。', 'type' => 'string', 'required' => true, 'example' => 'chat-65382141036853491'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B59382D2-5755-4C6D-861F-FA2AAD8F89F7'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''],
['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid.', 'description' => ''],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
409 => [
['errorCode' => 'AlreadyExists.SkillGroup', 'errorMessage' => 'The skill group %s already exists in instance %s.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"B59382D2-5755-4C6D-861F-FA2AAD8F89F7\\"\\n}","type":"json"}]',
'title' => '拒绝聊天',
'summary' => '坐席通过RejectChat拒绝接受被分配的聊天。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'RejectTicket' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'TicketId',
'in' => 'query',
'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => false, 'example' => 'f2c6722b-cd13-442d-bf10-22a07c70d6d5'],
],
[
'name' => 'Comment',
'in' => 'query',
'schema' => ['description' => '处理意见。', 'type' => 'string', 'required' => false, 'example' => '请补充信息。'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'TurnDownTicketResponse',
'description' => 'TurnDownTicketResponse',
'type' => 'object',
'properties' => [
'Data' => ['description' => '数据。'."\n", 'type' => 'any', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '678F7002-CA01-4ABF-A112-585AFBDF3A3B'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"678F7002-CA01-4ABF-A112-585AFBDF3A3B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '退回工单',
'summary' => '使用RejectTicket退回工单,退回的工单在创建人补充信息后可以重新提交。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ReleaseCall' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID,不填默认使用当前RAM账号映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'],
],
[
'name' => 'ChannelId',
'in' => 'query',
'schema' => ['description' => '待挂断的话务通道ID,非必填,不填默认为当前UserId对应坐席所在的话务通道。', 'type' => 'string', 'required' => false, 'example' => 'ch:user:1390501****->8032****:1609138902226:job-6538214103685****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'CREATED',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'],
'ChannelVariables' => ['description' => '随路数据', 'type' => 'string', 'example' => 'a=b;c=d;'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'BREAK',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
'ContextId' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"ChannelVariables\\": \\"a=b;c=d;\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n },\\n \\"ContextId\\": 123456\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <Extension>80326034</Extension>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <AssociatedData/>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
'title' => '挂断通话',
'summary' => '调用ReleaseCall挂断指定实例下指定通话ID对应的通话,调用者必须是坐席,且正处于通话状态。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-10-26T08:13:45.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-06-05T23:22:12.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-01-19T00:08:15.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseCall'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ReleaseChat' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '话务ID。', 'type' => 'string', 'required' => true, 'example' => 'chat-6538214103685****'],
],
[
'name' => 'UserType',
'in' => 'query',
'schema' => ['description' => '用户类型。'."\n"
.'- CUSTOMER : 访客'."\n"
.'- AGENT: 坐席', 'type' => 'string', 'required' => true, 'example' => 'CUSTOMER'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '用户ID。访客ID或坐席ID。', 'type' => 'string', 'required' => false, 'example' => 'edbcf95a-ef9f-4296-a0a6-985ac9e36db3'],
],
[
'name' => 'Token',
'in' => 'query',
'schema' => ['description' => '网络业务的渠道Token。', 'type' => 'string', 'required' => false, 'example' => '9XYGTGWtq2wFi_Bpg7aUnIoYi_vG_rO3bjEn0YtsxbHRHrYHlz1LDBLJAyZcLxieRQR4h_6AnWvTjJeNU5jg************Hwej7WgWrmA='],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B06B3244-1B44-481B-90C4-F2F92E59D6B5'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''],
['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid.', 'description' => ''],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
409 => [
['errorCode' => 'AlreadyExists.SkillGroup', 'errorMessage' => 'The skill group %s already exists in instance %s.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"B06B3244-1B44-481B-90C4-F2F92E59D6B5\\"\\n}","type":"json"}]',
'title' => '结束聊天',
'summary' => '通话ReleaseChat接口结束当前聊天。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'RemoveBlacklistCallTagging' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => ['description' => '电话号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1312121****'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。号码为加密号码(带有*),需要填写JobId,非加密号码,不需要填写该字段。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
['errorCode' => 'LimitExceed.CallTagsPerNumber', 'errorMessage' => 'The total number of call tag of numbers exceeds the limit %s.', 'description' => '号码标签数量超出单个呼入号码标记的上线阈值。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.CustomCallTagging', 'errorMessage' => 'Custom call tagging %s does not exist in instance %s.', 'description' => '呼入号码标记不存在。'],
],
500 => [
['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'],
],
],
'title' => '移除号码黑名单标签',
'summary' => '移除指定号码的黑名单标签。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","type":"json"}]',
],
'RemoveDoNotCallNumbers' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'NumberList',
'in' => 'query',
'schema' => ['description' => '待删除的禁止外呼号码列表,格式为JSON数组的字符串,数组长度区间为1-300。', 'type' => 'string', 'required' => false, 'example' => '["1900000****","1312211****"]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'Params' => [
'description' => '错误消息中占位符对应的响应参数。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => 'numberList'],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '删除禁止外呼号码',
'summary' => '调用RemoveDoNotCallNumbers删除指定实例下的一个或多个禁止外呼号码配置项。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-06T05:44:48.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveDoNotCallNumbers'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"numberList\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>无</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'RemovePersonalNumbersFromUser' => [
'summary' => '调用RemovePersonalNumbersFromUser删除指定实例下指定坐席的一个或多个个人外呼号码。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'NumberList',
'in' => 'query',
'schema' => ['description' => '待删除的个人外呼号码列表,通过调用ListPersonalNumbersOfUser可获取坐席当前关联的个人外呼号码列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["0101234****", "0105678****"]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '删除坐席关联的多个号码',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePersonalNumbersFromUser'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]',
],
'RemovePhoneNumberFromSkillGroups' => [
'summary' => '调用RemovePhoneNumberFromSkillGroups删除指定实例下指定号码关联的一个或多个技能组与该号码的绑定关系,删除的是号码与技能组的绑定关系,并不是真实号码。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccPBOQGO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => ['description' => '待解绑的号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0101234****'],
],
[
'name' => 'SkillGroupIdList',
'in' => 'query',
'schema' => ['description' => '待解绑的技能组ID列表,请确保技能组与号码之间原本就存在绑定关系。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'],
['errorCode' => 'Parameter.Invalid', 'errorMessage' => 'The parameter %s is invalid. %s.', 'description' => '该参数无效。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '删除多个技能组关联的号码',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePhoneNumberFromSkillGroups'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]',
],
'RemovePhoneNumbers' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc1MRAID'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'NumberList',
'in' => 'query',
'schema' => ['description' => '待删除的号码列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["0101234****","0105678****"]'],
],
[
'name' => 'Force',
'in' => 'query',
'schema' => ['description' => '是否强制删除,如果号码关联了技能组、联系流或坐席,只有将该字段设置为true才可以执行删除,非必填,默认false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '删除失败的号码列表。',
'type' => 'array',
'items' => ['description' => '号码。', 'type' => 'string', 'example' => '0101234****'],
'example' => '无',
],
'Params' => [
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '删除号码',
'summary' => '调用RemovePhoneNumbers删除指定实例下的一个或多个号码。并非真实删除某个号码,而是将这个号码与实例进行解绑,包括号码关联的技能组、联系流、坐席等,都将随之解绑。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-17T01:12:03.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePhoneNumbers'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": [\\n \\"0101234****\\"\\n ],\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>无</Data>\\n<FailureList>无</FailureList>\\n<Code>OK</Code>","errorExample":""}]',
],
'RemovePhoneNumbersFromSkillGroup' => [
'summary' => '调用RemovePhoneNumbersFromSkillGroup删除指定实例下指定技能组关联的一个或多个号码与该技能组的关联关系。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccPBOQGO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'NumberList',
'in' => 'query',
'schema' => ['description' => '号码列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["0101234****","0105678****"]'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'],
['errorCode' => 'Parameter.Invalid', 'errorMessage' => 'The parameter %s is invalid. %s.', 'description' => '该参数无效。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的技能组ID。'],
],
],
'title' => '删除技能组关联的多个号码',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePhoneNumbersFromSkillGroup'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]',
],
'RemoveSkillGroupsFromUser' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccPBOQGO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'SkillGroupIdList',
'in' => 'query',
'schema' => ['description' => '取消关联的技能组ID列表,格式为JSON数组的字符串,数组元素是技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '删除坐席关联的多个技能组',
'summary' => '调用RemoveSkillGroupsFromUser删除指定实例下指定坐席关联的一个或多个技能组与该坐席之间的关联关系。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveSkillGroupsFromUser'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>无</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'RemoveUsers' => [
'summary' => '调用RemoveUsers删除指定实例下的一个或多个坐席,该操作仅将RAM账户与实例解绑,然后将RAM账户映射的坐席从实例中删除,并不会删除RAM账户本身。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserIdList',
'in' => 'query',
'schema' => ['description' => '坐席ID列表,格式为JSON数组的字符串,数组元素是坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '["agent1@ccc-test","agent2@ccc-test"]'],
],
[
'name' => 'Force',
'in' => 'query',
'schema' => ['description' => '是否强制删除。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'FilePath',
'in' => 'query',
'schema' => ['description' => '待删除用户列表文件的OSS对象的ObjectKey。', 'type' => 'string', 'required' => false, 'example' => 'temp/removeUsers.xlsx'],
],
[
'name' => 'NotificationEmail',
'in' => 'query',
'schema' => ['description' => '通知邮件地址。', 'type' => 'string', 'required' => false, 'example' => '123@abc.com'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '删除坐席',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-17T01:12:02.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-04-14T05:54:04.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUsers'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Code>OK</Code>","errorExample":""}]',
],
'RemoveUsersFromSkillGroup' => [
'summary' => '调用RemoveUsersFromSkillGroup删除指定实例下指定技能组关联的一个或多个坐席,该操作仅删除技能组与坐席之间的关联关系,并不会删除坐席。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'],
],
[
'name' => 'UserIdList',
'in' => 'query',
'schema' => ['description' => '坐席ID列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["agent1@ccc-test","agent2@ccc-test"]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的技能组ID。'],
],
],
'title' => '删除技能组关联的多个坐席',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUsersFromSkillGroup'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]',
],
'ResetAgentState' => [
'summary' => '调用ResetAgentState重置指定实例下指定坐席的坐席状态。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID,非必填,不填默认使用当前RAM账户映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,可以随便填写,无特殊作用,无特殊要求。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'type' => 'array',
'items' => ['description' => '参数信息。', 'type' => 'string', 'example' => '无'],
'description' => '',
],
'Data' => [
'description' => '坐席状态数据。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8001****'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'JobId' => ['description' => '通话ID,如果该字段有值,说明坐席当前处于通话过程中。', 'type' => 'string', 'example' => '无'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休码包括:Warm-up'."\n"
.'(坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否开启了仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'UserState' => [
'description' => '坐席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'OFFLINE',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
],
'title' => '重置坐席状态',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-10-26T08:13:45.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAgentState'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"无\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"OFFLINE\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup@ccc-test\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Extension>80011112</Extension>\\n <UserState>OFFLINE</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <UserId>user-test@ccc-test</UserId>\\n <OutboundScenario>false</OutboundScenario>\\n <WorkMode>ON_SITE</WorkMode>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'ResetUserPassword' => [
'summary' => '调用ResetUserPassword重置指定实例下指定坐席的登录密码。实际上坐席并没有登录密码,修改的是坐席关联的RAM账户的登录密码,通常用于客服忘记自己的RAM账户登录密码的场景。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['description' => '新的密码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'password'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
403 => [
['errorCode' => 'Permission.Role', 'errorMessage' => 'You have no permission to access role %s.', 'description' => '您无权访问指定角色。'],
],
[
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
500 => [
['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'],
['errorCode' => 'InternalService.RAM', 'errorMessage' => 'An internal RAM service error occurred. %s', 'description' => '内部RAM服务错误。'],
['errorCode' => 'InternalService.STS', 'errorMessage' => 'An internal STS service error occurred. %s', 'description' => '内部STS服务错误。'],
],
],
'title' => '重置坐席密码',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetUserPassword'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]',
],
'RestoreArchivedRecordings' => [
'summary' => '解冻指定实例下的通话录音。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccKYIENB'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'ContactIds',
'in' => 'query',
'schema' => ['description' => '话务ID列表,JSON格式。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[\\"job-216750038017142784\\"]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'Instance 0 does not exist.'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F8066648-5D95-55AB-ACD3-2F4AD3BEA715'],
'Data' => [
'description' => '数据。'."\n",
'type' => 'array',
'items' => [
'description' => '数据。'."\n",
'type' => 'object',
'properties' => [
'Exists' => ['description' => '录音文件是否存在。', 'type' => 'string', 'example' => 'False'],
'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-25920271311543****'],
'Status' => ['description' => '录音解冻状态,可选值为Completed或者Progressing。', 'type' => 'string', 'example' => 'Progressing'],
'StorageType' => ['description' => '录音文件的存储类型。', 'type' => 'string', 'example' => 'Standard'],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'],
['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '解冻录音文件',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestoreArchivedRecordings'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance 0 does not exist.\\",\\n \\"RequestId\\": \\"F8066648-5D95-55AB-ACD3-2F4AD3BEA715\\",\\n \\"Data\\": [\\n {\\n \\"Exists\\": \\"False\\",\\n \\"ContactId\\": \\"job-25920271311543****\\",\\n \\"Status\\": \\"Progressing\\",\\n \\"StorageType\\": \\"Standard\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ResubmitTicket' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'TicketId',
'in' => 'query',
'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => true, 'example' => 'f2c6722b-cd13-442d-bf10-22a07c70d6d5'],
],
[
'name' => 'Comment',
'in' => 'query',
'schema' => ['description' => '处理意见。', 'type' => 'string', 'required' => false, 'example' => '信息已补充'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'CloseTicketResponse',
'description' => 'CloseTicketResponse',
'type' => 'object',
'properties' => [
'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '重新提交工单',
'summary' => '使用ResubmitTicket接口对驳回/退回的工单重新提交。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'ResumeCampaign' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccQFUGXR'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CampaignId',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F505C4C8-1E12-573A-9BA7-4BEAAD129553'],
'Code' => ['title' => 'code', 'description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['title' => 'message', 'description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'],
],
],
],
],
'title' => '恢复预测式外呼活动',
'summary' => '调用ResumeCampaign恢复指定实例下指定ID对应的预测式外呼活动。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeCampaign'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F505C4C8-1E12-573A-9BA7-4BEAAD129553\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<ResumeCampaignResponse>\\n <RequestId>F505C4C8-1E12-573A-9BA7-4BEAAD129553</RequestId>\\n <Code>OK</Code>\\n <Message>无</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n</ResumeCampaignResponse>","errorExample":""}]',
],
'RetrieveCall' => [
'summary' => '调用RetrieveCall取回指定实例下指定通话ID对应的通话,通话必须处于保持状态才可操作取回。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'],
],
[
'name' => 'ChannelId',
'in' => 'query',
'schema' => ['description' => '待取回的话务通道ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ch:user:1390501****->8032****:1609138902226:job-6538214103685****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'CREATED',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'SkillGroupId' => ['description' => '话务通道关联的技能组ID,呼入场景下,关联的技能组ID由IVR中转人工模块配置的技能组决定,呼出场景下,关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'BREAK',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''],
['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作,用户状态不符合预期。'],
],
404 => [
['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'],
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'],
],
],
'title' => '取回通话',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-10-26T08:13:45.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RetrieveCall'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <SkillGroupId>skg-test1@ccc-test</SkillGroupId>\\n <AssociatedData/>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'SaveDocument' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'parameters' => [
[
'name' => 'SchemaId',
'in' => 'formData',
'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'],
],
[
'name' => 'DocumentId',
'in' => 'formData',
'schema' => ['description' => '文档ID', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'DocumentJson',
'in' => 'formData',
'schema' => ['description' => '要保存的文档内容,需要符合Schema定义的规则', 'type' => 'string', 'required' => true, 'example' => '{"name":"tom"}'],
],
[
'name' => 'RequestId',
'in' => 'formData',
'schema' => ['description' => '请求ID', 'type' => 'string', 'required' => false, 'example' => 'EAF3C248-E123-441B-A545-B6CD02E98EED'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SaveDocumentResponse',
'description' => 'SaveDocumentResponse',
'type' => 'object',
'properties' => [
'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '0101234****'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '01B12EE4-6AF2-4730-8B78-EC15F4E5C025'],
'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息'."\n"
."\n", 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"0101234****\\",\\n \\"RequestId\\": \\"01B12EE4-6AF2-4730-8B78-EC15F4E5C025\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '保存Document',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'SaveRTCStatsV2' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '50605',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CallId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '257e73de-1ee8-123b-0b9a-00163e0a****'],
],
[
'name' => 'GeneralInfo',
'in' => 'query',
'schema' => ['description' => '通用信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[null,"","","1647337928819","1647337888816","agent",null,"上海","10.10.XX.XX","11.1.XX.XX","2002"]'],
],
[
'name' => 'SenderReport',
'in' => 'query',
'schema' => ['description' => '发送报告内容。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["11090","2055127460","0","2236","384592","ssrc_2055127460_send","2022-03-15T09:52:08.820Z","1"]'],
],
[
'name' => 'ReceiverReport',
'in' => 'query',
'schema' => ['description' => '收到报告内容。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["1","1649328987","40","PCMU","383560","89","49","ssrc_1649328987_recv","2022-03-15T09:52:08.820Z","","0","20000"]'],
],
[
'name' => 'GoogAddress',
'in' => 'query',
'schema' => ['description' => '接入点地址。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["47.101.XX.XX","44368","47.104.XX.XX","37947"]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'TimeStamp' => ['description' => '生成记录时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1647309061000'],
'RowCount' => ['description' => '行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Permission.User', 'errorMessage' => 'You have no permission to access user(s) %s.', 'description' => '您无权访问这些用户。'],
],
[
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
500 => [
['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'],
],
],
'title' => '上报坐席端WebRTC统计信息',
'summary' => '调用SaveRTCStatsV2上报坐席端WebRTC语音传输统计信息,普通客户无需关心该接口。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"TimeStamp\\": 1647309061000,\\n \\"RowCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<RowCount>1</RowCount>\\n<Code>OK</Code>\\n<TimeStamp>1647309061000</TimeStamp>\\n<Success>true</Success>","errorExample":""}]',
],
'SaveTerminalLog' => [
'summary' => '调用SaveTerminalLog上报坐席端日志信息,普通客户无需关心该接口。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '50606',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CallId',
'in' => 'query',
'schema' => ['description' => '话务通道的CallId,有SIP协议生成,每个SIP通话都有一个CallId。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e13c9740-1e37-123b-21b6-00163e352f9'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-b8b0ca63-330c-4e65-8ae3-9de2c7ce7683'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => 'APP名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CCCClient'],
],
[
'name' => 'DataType',
'in' => 'query',
'schema' => ['description' => '数据类型,默认是1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '0', 'example' => '1'],
],
[
'name' => 'Content',
'in' => 'query',
'schema' => ['description' => '内容信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'none'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => '状态信息,true或false。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
[
'name' => 'UniqueRequestId',
'in' => 'query',
'schema' => ['description' => '方法请求ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'none'],
],
[
'name' => 'MethodName',
'in' => 'query',
'schema' => ['description' => '方法名称。', 'type' => 'string', 'required' => false, 'example' => 'TurnServerTest'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'TimeStamp' => ['description' => '生成日志时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1647309061000'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'],
],
403 => [
['errorCode' => 'Permission.Unauthorized', 'errorMessage' => 'You are not authorized to perform this action. %s privileges are required.', 'description' => '您无权执行此操作。 必须具有指定权限。'],
],
500 => [
['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'],
],
],
'title' => '保存坐席端日志信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SaveTerminalLog'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"TimeStamp\\": 1647309061000\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>\\n<TimeStamp>1647309061000</TimeStamp>\\n<Success>true</Success>","errorExample":""}]',
],
'SaveWebRTCStats' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '50608',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CallId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '257e73de-1ee8-123b-0b9a-00163e0a****'],
],
[
'name' => 'GeneralInfo',
'in' => 'query',
'schema' => ['description' => '通用信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[null,"","","1647337928819","1647337888816","agent",null,"上海","10.10.XX.XX","11.1.XX.XX","2002"]'],
],
[
'name' => 'SenderReport',
'in' => 'query',
'schema' => ['description' => '发送报告内容。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["11090","2055127460","0","2236","384592","ssrc_2055127460_send","2022-03-15T09:52:08.820Z","1"]'],
],
[
'name' => 'ReceiverReport',
'in' => 'query',
'schema' => ['description' => '收到报告内容。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["1","1649328987","40","PCMU","383560","89","49","ssrc_1649328987_recv","2022-03-15T09:52:08.820Z","","0","20000"]'],
],
[
'name' => 'GoogAddress',
'in' => 'query',
'schema' => ['description' => '接入点地址。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["47.101.XX.XX","44368","47.104.XX.XX","37947"]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CF1C21B9-2D49-4B54-880F-FBE248C16903'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'TimeStamp' => ['description' => '生成记录时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1555492246000'],
'RowCount' => ['description' => '行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Permission.User', 'errorMessage' => 'You have no permission to access user(s) %s.', 'description' => '您无权访问这些用户。'],
],
[
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
500 => [
['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'],
],
],
'title' => '上报坐席端WebRTC统计信息',
'summary' => '调用SaveWebRTCStats上报坐席端WebRTC语音传输统计信息,普通客户无需关心该接口。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"CF1C21B9-2D49-4B54-880F-FBE248C16903\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"TimeStamp\\": 1555492246000,\\n \\"RowCount\\": 1\\n}","type":"json"}]',
],
'SaveWebRtcInfo' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '50607',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CallId',
'in' => 'query',
'schema' => ['description' => '话务通道的CallId,有SIP协议生成,每个SIP通话都有一个CallId。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e13c9740-1e37-123b-21b6-00163e352f9'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-b8b0ca63-330c-4e65-8ae3-9de2c7ce7683'],
],
[
'name' => 'ContentType',
'in' => 'query',
'schema' => ['description' => '上报内容,值来自前端WebRTC中rtcPeerConnection.getStats(selector)获取的语音传输质量数据,只在云联络中心的公有云平台中使用,集成客户无需关心。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4'],
],
[
'name' => 'Content',
'in' => 'query',
'schema' => ['description' => '上报内容信息,只在云联络中心的公有云平台中使用,集成客户无需关心。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"media_source":{},"remote_inbound_rtp":{},"outbound_rtp":{},"inbound_rtp":{},"remote_outbound_rtp":{},"candidate":{},"basic":{"callId":"e13c9740-1e37-123b-21b6-00163e352f9","timestamp":"1647262108395","callStartTime":"1647262108393","uid":"user-test","access_point":"shanghai","browser":"90","ip":"127.0.0.1"}}'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CF1C21B9-2D49-4B54-880F-FBE248C16903'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'TimeStamp' => ['description' => '信息入库时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1647262108395'],
'RowCount' => ['description' => '信息入库返回的行数,表示成功写入多少条记录,如果不为1,可能有异常,需要关注。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Permission.User', 'errorMessage' => 'You have no permission to access user(s) %s.', 'description' => '您无权访问这些用户。'],
],
[
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
500 => [
['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'],
],
],
'title' => '上报WebRTC状态信息',
'summary' => '调用SaveWebRtcInfo上报座席端WebRTC的通话状态信息,包括通话质量监控数据等,用于后台统计和监控,客户无需关心该接口。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"CF1C21B9-2D49-4B54-880F-FBE248C16903\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"TimeStamp\\": 1647262108395,\\n \\"RowCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"<RequestId>CF1C21B9-2D49-4B54-880F-FBE248C16903</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<RowCount>1</RowCount>\\n<Code>OK</Code>\\n<TimeStamp>1647262108395</TimeStamp>\\n<Success>true</Success>","errorExample":""}]',
],
'SendDtmfSignaling' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '发送DTMF的坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6573574060089****'],
],
[
'name' => 'ChannelId',
'in' => 'query',
'schema' => ['description' => '待发送DTMF的话务通道ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ch:customer:0108989****->1318888****:1609234221870:job-6573574060089****'],
],
[
'name' => 'Dtmf',
'in' => 'query',
'schema' => ['description' => 'DTMF按键信息,即拨号盘上的按键,包括0-9、*、#。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5', 'maxLength' => 1000000, 'minLength' => 0],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => '842399EC-7D32-4472-AD08-9504C3F141FF'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。'."\n",
'type' => 'object',
'properties' => [
'CallContext' => [
'description' => '话务上下文环境。'."\n",
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。'."\n", 'type' => 'string', 'example' => 'job-6573574060089****'],
'ChannelContexts' => [
'description' => '话务通道列表。'."\n",
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'Index' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。'."\n", 'type' => 'string', 'example' => '无'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'ANSWERED',
],
'Destination' => ['description' => '话务通道的被叫方。'."\n", 'type' => 'string', 'example' => '8001****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'],
'example' => 'MONITORING',
],
'SkillGroupId' => ['description' => '话务通道关联的技能组ID,呼入场景下,关联的技能组ID由IVR中转人工模块配置的技能组决定,呼出场景下,关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609234222367'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '无'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6573574060089****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:131888****->8001****:1609234221870:job-6573574060089****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8001****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0101234****'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。'."\n",
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8001****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609234222375'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609234221864'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1390000****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6573574060089****'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'TALKING',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''],
['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作,用户状态不符合预期。'],
],
404 => [
['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'],
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'],
],
],
'title' => '发送按键信息',
'summary' => '调用SendDtmfSignaling在通话过程中发送DTMF按键信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-10-26T08:13:45.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendDtmfSignaling'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"842399EC-7D32-4472-AD08-9504C3F141FF\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609234222367,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609234221870:job-6573574060089****\\",\\n \\"UserExtension\\": \\"8001****\\",\\n \\"Originator\\": \\"0101234****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609234222375,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609234221864,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>842399EC-7D32-4472-AD08-9504C3F141FF</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65735740600893440</JobId>\\n <ChannelContexts>\\n <Destination>8001****</Destination>\\n <ChannelState>ANSWERED</ChannelState>\\n <ReleaseInitiator>无</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>1</Index>\\n <AssociatedData>无</AssociatedData>\\n <SkillGroupId>skill-group@ccc-test</SkillGroupId>\\n <ChannelId>ch:user:131888****->8001****:1609234221870:job-65735740600893440\\"</ChannelId>\\n <Timestamp>1609234222367</Timestamp>\\n <ReleaseReason>无</ReleaseReason>\\n <Originator>0101234****</Originator>\\n <ChannelFlags>[]</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>8001****</UserExtension>\\n <JobId>job-65735740600893440</JobId>\\n </ChannelContexts>\\n </CallContext>\\n <UserContext>\\n <Extension>8001****</Extension>\\n <UserState>TALKING</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <BreakCode>Warm-up</BreakCode>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-bse05179638553000176add4046f</DeviceId>\\n <Heartbeat>1609234222375</Heartbeat>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>1390000****</Mobile>\\n <JobId>job-65735740600893440</JobId>\\n <WorkMode>ON_SITE</WorkMode>\\n <Reserved>1609234221864</Reserved>\\n <SignedSkillGroupIdList>[\\"skill-group@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'SignInGroup' => [
'summary' => '调用SignInGroup使坐席签入指定实例下的指定技能组,即坐席上线操作。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID,不填默认使用当前RAM账号映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '语音设备ID。当有多个语音设备可用时,通过此参数指定其中一个语音设备,比如浏览器WebRTC或者SIP话机等。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CCC-xx.xx.xx.xx-chrome119-bse1b618bff3xxxxd'],
],
[
'name' => 'SignedSkillGroupIdList',
'in' => 'query',
'schema' => ['description' => '想要签入的技能组ID列表,格式为JSON数组字符串,数组元素是技能组ID。', 'type' => 'string', 'required' => true, 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]'],
],
[
'name' => 'ChatDeviceId',
'in' => 'query',
'schema' => ['description' => 'Chat设备ID。', 'type' => 'string', 'required' => false, 'example' => '4c51c9116c36537cb850dc1081d745df'],
],
[
'name' => 'Additivity',
'in' => 'query',
'schema' => ['description' => '座席已经签入一些技能组后,如果指定此参数为True, 则可以签入更多新技能组。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'."\n"],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => '无'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'READY',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
'ChatDeviceId' => ['description' => 'Chat设备ID。', 'type' => 'string', 'example' => '4c51c9116c36537cb850dc1081d745df'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
],
'title' => '签入技能组',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SignInGroup'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\\\n\\",\\n \\"JobId\\": \\"无\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ],\\n \\"ChatDeviceId\\": \\"4c51c9116c36537cb850dc1081d745df\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <Extension>80326034</Extension>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <WorkMode>ON_SITE</WorkMode>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'SignOutGroup' => [
'summary' => '调用SignOutGroup使坐席签出当前签入的技能组,即坐席下线操作。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID,不填默认使用当前RAM账号映射的坐席。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => '200'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'BREAK',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''],
['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作,用户状态不符合预期。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
],
'title' => '签出技能组',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-10-26T08:13:45.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SignOutGroup'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n</Data>\\n<Code>200</Code>","errorExample":""}]',
],
'StartBack2BackCall' => [
'summary' => '调用StartBack2BackCall发起双呼。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'Caller',
'in' => 'query',
'schema' => ['description' => '主叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1391814****'],
],
[
'name' => 'Callee',
'in' => 'query',
'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1372168****'],
],
[
'name' => 'TimeoutSeconds',
'in' => 'query',
'schema' => ['description' => '双呼超时时间,呼叫在经过该参数指定的时间仍然未接通的情况下,则主动挂断,非必填,默认30,单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '0', 'example' => '30'],
],
[
'name' => 'Broker',
'in' => 'query',
'schema' => ['description' => '中间号码,需要是实例下可用的外呼号码,双呼时会使用该号码先后呼叫主叫和被叫。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0102157****'],
],
[
'name' => 'AdditionalBroker',
'in' => 'query',
'schema' => ['description' => '附加中间号码,如果该参数存在,则呼叫主叫时使用中间号码,呼叫被叫时使用该参数指定的号码,非必填, 默认空。', 'type' => 'string', 'required' => false, 'example' => '0102156****'],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => ['description' => '随路数据,不能超过128字节,主要用于扩展需求,普通客户无需关心。', 'type' => 'string', 'required' => false, 'example' => '无'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'BACK2BACK',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-1034159089076****'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '无'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'NONE',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1372168****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => '无'],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => 'COACHING', 'MONITORING' => 'MONITORING', 'MONITORED' => 'MONITORED', 'COACHED' => 'COACHED', 'HOLD' => 'HOLD', 'MUTED' => 'MUTED'],
'example' => 'MONITORING',
],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1618217874062'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '无'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => 'INBOUND', 'BARGE' => 'BARGE', 'CONSULTANT' => 'CONSULTANT', 'CONFERENCE' => 'CONFERENCE', 'MONITOR' => 'MONITOR', 'INTERNAL' => 'INTERNAL', 'OUTBOUND' => 'OUTBOUND', 'INTERCEPT' => 'INTERCEPT', 'BACK2BACK' => 'BACK2BACK', 'PREDICTIVE' => 'PREDICTIVE',
'COACH' => 'COACH',
],
'example' => 'BACK2BACK',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-1034159089076****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'],
'Originator' => ['description' => '话务通道的主叫方', 'type' => 'string', 'example' => '0102157****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8001****'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8020****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1618217872911'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1618217794599'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'DeviceState' => [
'description' => '设备状态。',
'type' => 'string',
'enumValueTitles' => ['UNREGISTERED' => '未注册', 'ONLINE' => '在线', 'OFFLINE' => '离线'],
'example' => '无',
],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-1034159089076****'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'OFFLINE',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.Number', 'errorMessage' => 'The specified number %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的号码。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'],
],
],
'title' => '发起双呼',
'description' => '双呼和传统的双方通话不同,主叫并不直接呼叫对方,而是通过一个背靠背代理(Back to Back Agent),背靠背代理首先呼叫主叫方,接通后,再呼叫被叫方,然后把二者拉进一个会场。在这种方式下,由于每个呼叫的所有消息流经背靠背代理,因此服务提供商可以据此提供增值服务,比如计时、录音、隐藏真实号码等等。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartBack2BackCall'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"BACK2BACK\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-1034159089076****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"NONE\\",\\n \\"Destination\\": \\"1372168****\\",\\n \\"UserId\\": \\"无\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1618217874062,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"BACK2BACK\\",\\n \\"JobId\\": \\"job-1034159089076****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0102157****\\",\\n \\"UserExtension\\": \\"8001****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8020****\\",\\n \\"Heartbeat\\": 1618217872911,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1618217794599,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"无\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-1034159089076****\\",\\n \\"UserState\\": \\"OFFLINE\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>26A34338-5CD9-4C95-A7A6-5BDCE76C6B94</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>BACK2BACK</CallType>\\n <JobId>job-103415908907622400</JobId>\\n <ChannelContexts>\\n <Destination>1014</Destination>\\n <ChannelState>NONE</ChannelState>\\n <ReleaseReason>无</ReleaseReason>\\n <ReleaseInitiator>无</ReleaseInitiator>\\n <Originator>010xxxx2157</Originator>\\n <ChannelFlags>[]</ChannelFlags>\\n <UserId>无</UserId>\\n <UserExtension>80011474</UserExtension>\\n <CallType>BACK2BACK</CallType>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:1318888888->80011474:1609225718294:job-65700074013925376</ChannelId>\\n <Timestamp>1618217874062</Timestamp>\\n <JobId>job-103415908907622400</JobId>\\n </ChannelContexts>\\n </CallContext>\\n <UserContext>\\n <UserState>OFFLINE</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-bsd87c04aaa8f7000176ad354b1c</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Uri>无</Uri>\\n <Mobile>86-132xxxx4730</Mobile>\\n <Extension>80202301</Extension>\\n <DeviceState>无</DeviceState>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1618217872911</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-103415908907622400</JobId>\\n <Reserved>1618217794599</Reserved>\\n <SignedSkillGroupIdList>[\\"skg-default@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'StartChat' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ccc-test'],
],
[
'name' => 'UserList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '聊天成员信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'UserId' => ['description' => '成员ID。', 'type' => 'string', 'required' => false, 'example' => 'fcd020fe-d8e4-40e5-8c77-1a272a174a7d'],
'UserType' => ['description' => '成员类型。'."\n"
.'- AGENT : 坐席'."\n"
.'- CUSTOMER : 访客', 'type' => 'string', 'required' => false, 'example' => 'CUSTOMER'],
'AvatarUrl' => ['description' => '成员头像链接。', 'type' => 'string', 'required' => false, 'example' => 'http://xxx.com/image'],
'Nickname' => ['description' => '成员昵称。', 'type' => 'string', 'required' => false, 'example' => '访客-1a272a174a7d'],
],
'required' => false,
'description' => '',
],
'required' => true,
],
],
[
'name' => 'Token',
'in' => 'query',
'schema' => ['description' => '网络业务的渠道Token。', 'type' => 'string', 'required' => false, 'example' => '9XYGTGWtq2wFi_Bpg7aUnIoYi_vG_rO3bjEn0YtsxbHRHrYHlz1LDBLJAyZcLxieRQR4h_6AnWvTjJeNU5jg************Hwej7WgWrmA='],
],
[
'name' => 'AccessChannelId',
'in' => 'query',
'schema' => ['description' => '网络业务渠道ID。', 'type' => 'string', 'required' => false, 'example' => 'cf584733-***-***-9699-cb77aa3b7aa6'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
'ChatConversationId' => ['description' => '聊天会话ID。', 'type' => 'string', 'example' => '$23086709$EAUNIT'],
'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'chat-525523618219921408'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''],
['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid.', 'description' => ''],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
409 => [
['errorCode' => 'AlreadyExists.SkillGroup', 'errorMessage' => 'The skill group %s already exists in instance %s.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"ChatConversationId\\": \\"$23086709$EAUNIT\\",\\n \\"JobId\\": \\"chat-525523618219921408\\"\\n }\\n}","type":"json"}]',
'title' => '发起聊天',
'summary' => '调用StartChat发起聊天。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'StartConference' => [
'summary' => '调用StartConference发起一个会议。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '发起会议的坐席ID,非必填,不填则默认使用当前RAM账户映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'],
],
[
'name' => 'ParticipantListJson',
'in' => 'query',
'schema' => ['description' => '参会方列表,格式为JSON数组的字符串,数组元素是参会方,如果是内呼坐席,参会方是目标的坐席分机号,如果是外呼客户,参会方是客户号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["8045****","1317511****"]'],
],
[
'name' => 'TimeoutSeconds',
'in' => 'query',
'schema' => ['description' => '超时时间,呼叫在经过该参数指定的时间仍然未接通的情况下,则主动挂断,非必填,默认30,单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '0', 'example' => '30'],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => ['description' => '随路数据,不能超过128字节,主要用于扩展需求,普通客户无需关心。', 'type' => 'string', 'required' => false, 'example' => '无'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FDD327D1-AB8A-596B-883F-F63582A73F1D'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'CallContext' => [
'description' => '话务上下文环境。'."\n",
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。'."\n", 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'ANSWERED',
],
'Destination' => ['description' => '话务通道的被叫方。'."\n"
."\n", 'type' => 'string', 'example' => '8001****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'."\n"],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'],
'example' => 'MONITORING',
],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6573574060089****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:131888****->8001****:1609225718294:job-65700074013925376'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '1318888****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'."\n"],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up'."\n",
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => '1609136956378'."\n"],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'DeviceState' => [
'description' => '设备状态。',
'type' => 'string',
'enumValueTitles' => ['UNREGISTERED' => '未注册', 'ONLINE' => '在线', 'OFFLINE' => '离线'],
'example' => 'false',
],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'TALKING',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.Number', 'errorMessage' => 'The specified number %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的号码。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'],
],
],
'title' => '发起会议',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartConference'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"FDD327D1-AB8A-596B-883F-F63582A73F1D\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\\\n\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609225718294:job-65700074013925376\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8032****\\\\n\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\\\n\\",\\n \\"InstanceId\\": \\"1609136956378\\\\n\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"false\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
],
'StartEditContactFlow' => [
'summary' => '发起编辑联系流,生成联系流草稿。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccTPIKHY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'ContactFlowId',
'in' => 'query',
'schema' => ['description' => '联系流ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '798e83a9-5140-4039-afa1-761ca4cca2df'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Data' => ['description' => '数据,联系流草稿ID。', 'type' => 'string', 'example' => 'b3114362-9062-46c7-82dc-ae55ac168b2e'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BC2733CE-C470-564A-8C11-9DC02468823A'],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '创建联系流草稿',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartEditContactFlow'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"b3114362-9062-46c7-82dc-ae55ac168b2e\\",\\n \\"RequestId\\": \\"BC2733CE-C470-564A-8C11-9DC02468823A\\"\\n}","type":"json"}]',
],
'StartPredictiveCall' => [
'summary' => '调用StartPredictiveCall发起预测式外呼。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccQFUGXR'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'Caller',
'in' => 'query',
'schema' => ['description' => '主叫号码,需要是实例下可用的外呼号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0109810****'],
],
[
'name' => 'Callee',
'in' => 'query',
'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1312353****'],
],
[
'name' => 'TimeoutSeconds',
'in' => 'query',
'schema' => ['description' => '超时时间,呼叫在经过该参数指定的时间仍然未接通的情况下,则主动挂断,单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '0', 'example' => '10'],
],
[
'name' => 'ContactFlowId',
'in' => 'query',
'schema' => ['description' => 'IVR联系流ID,被叫接通后,通话将自动转入此IVR流程。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9774c36c-12fe-4e37-adce-89bc77ce****'],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => ['description' => '随路数据,主要用于扩展需求,普通用户无需关心。', 'type' => 'string', 'required' => false, 'example' => '无'],
],
[
'name' => 'ContactFlowVariables',
'in' => 'query',
'schema' => ['description' => '传入的联系流变量,格式为JSON数组的字符串,数组元素是一个键值对,Key为变量名,Value为变量值。在联系流ID对应的IVR的开始节点中新建同名的自定义参数,即可在IVR流程中使用该参数。', 'type' => 'string', 'required' => false, 'example' => '{"name":"王先生","time":"19点20分","address":"某某中心"}'],
],
[
'name' => 'MaskedCallee',
'in' => 'query',
'schema' => ['description' => '脱敏后的被叫号码,如果该字段不为空,表示需要对被叫号码脱敏,脱敏规则由客户自行定义,只需将脱敏后的被叫号码填入即可,使用脱敏被叫会导致某些场景下看到的是脱敏后的被叫号码,无法查看真实被叫号码。', 'type' => 'string', 'required' => false, 'example' => '1312353****'],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => ['description' => '技能组ID,非必填,如果该参数有值,则外呼号码仅从该参数指定的技能组的关联号码中选取。', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6570007401392****'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '无'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'NONE',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '8001****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'],
'example' => '[]',
],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609225718295'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '无'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6570007401392****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:131888****->8001****:1609225718294:job-6570007401392****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '1318888****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8001****'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8001****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'DeviceState' => [
'description' => '设备状态。',
'type' => 'string',
'enumValueTitles' => ['UNREGISTERED' => '未注册', 'ONLINE' => '在线', 'OFFLINE' => '离线'],
'example' => 'ONLINE',
],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6570007401392****'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'READY',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
],
404 => [
['errorCode' => 'NotExists.Number', 'errorMessage' => 'The specified number %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的号码。'],
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '发起预测式外呼',
'description' => '云呼叫中心除了支持客服从坐席工作台发起外呼外,还支持从自有业务系统后台发起外呼,待接通后转给坐席。以支持把云呼叫中心功能无缝嵌入您的业务流程。'."\n"
.'比如,您的客户可以在您的微信公众号上,输入自己的号码,并点击咨询产品的按钮,由您的后台系统调用本接口,实现呼叫客户手机,接通后播放“我们收到您在公众号上对我们产品的咨询,现在给您转接顾问,请稍等”,并转给合适的客服接听通话。'."\n"
.'相较于1.0的DialEX接口,用户使用该接口可以更加灵活的进行配置。除了可以自定义外呼转入的IVR外,还可以传入自定义的参数,在IVR中对参数进行语音播报,实现通知的场景。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-11-29T08:23:20.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-11-29T08:23:20.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-20T10:36:28.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPredictiveCall'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"NONE\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"[]\\",\\n \\"Timestamp\\": 1609225718295,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609225718294:job-6570007401392****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8001****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"ONLINE\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>26A34338-5CD9-4C95-A7A6-5BDCE76C6B94</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65700074013925376</JobId>\\n <ChannelContexts>\\n <Destination>8001****</Destination>\\n <ChannelState>NONE</ChannelState>\\n <ReleaseReason>无</ReleaseReason>\\n <Originator>1318888****</Originator>\\n <ChannelFlags>[]</ChannelFlags>\\n <ReleaseInitiator>无</ReleaseInitiator>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>8001****</UserExtension>\\n <CallType>OUTBOUND</CallType>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:131888****->8001****:1609225718294:job-65700074013925376</ChannelId>\\n <Timestamp>1609225718295</Timestamp>\\n <JobId>job-65700074013925376</JobId>\\n </ChannelContexts>\\n </CallContext>\\n <UserContext>\\n <Extension>8001****</Extension>\\n <DeviceState>无</DeviceState>\\n <UserState>READY</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <BreakCode>Warm-up</BreakCode>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-bsd87c04aaa8f7000176ad354b1c</DeviceId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-1324730****</Mobile>\\n <JobId>job-65700074013925376</JobId>\\n <WorkMode>ON_SITE</WorkMode>\\n <Reserved>1609136956378</Reserved>\\n <SignedSkillGroupIdList>[\\"skill-group@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'StartPrivacyCall' => [
'summary' => '发起隐私呼叫。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '云联络中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => true, 'example' => 'ALIPUBB7A727C170949'],
],
[
'name' => 'Caller',
'in' => 'query',
'schema' => ['description' => '主叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0109810****'],
],
[
'name' => 'Callee',
'in' => 'query',
'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1888888****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3'],
'Params' => [
'description' => '参数信息。',
'type' => 'array',
'items' => ['type' => 'string', 'description' => ''],
],
'Data' => ['description' => '返回结果,通话ID。', 'type' => 'string', 'example' => 'job-xxx'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.Number', 'errorMessage' => 'The specified number %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的号码。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"0630E5DF-CEB0-445B-8626-D5C7481181C3\\",\\n \\"Params\\": [\\n \\"\\"\\n ],\\n \\"Data\\": \\"job-xxx\\"\\n}","type":"json"}]',
'title' => '发起隐私呼叫',
'changeSet' => [
['createdAt' => '2022-09-07T01:59:54.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPrivacyCall'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'SubmitCampaign' => [
'summary' => '调用SubmitCampaign启动指定实例下指定ID对应的预测式外呼活动。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccQFUGXR'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CampaignId',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE315'],
'Code' => ['title' => 'code', 'description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['title' => 'message', 'description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'],
],
],
],
],
'title' => '启动预测式外呼活动',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitCampaign'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitCampaignResponse>\\n <RequestId>7CC6523B-0E51-1B62-8DA5-6A9831CAE315</RequestId>\\n <Code>OK</Code>\\n <Message>无</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n</SubmitCampaignResponse>","errorExample":""}]',
],
'SwitchToConference' => [
'summary' => '调用SwitchToConference将指定实例下的指定通话的状态切换至三方会议,通常用于咨询转会议的场景。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID,不填默认使用当前RAM账号映射的坐席。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '无效字段,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-24114064019637****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9C96A73-09C9-5E2A-8CDB-85EC0BC246DA'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelContexts' => [
'description' => '话务通道列表。'."\n",
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'Index' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'NONE',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '8001****'],
'SkillGroupId' => ['description' => '该通话相关技能组。呼入场景下,技能组由IVR中路由的排队队列指定。在呼出场景下,技能组是座席签入的第一个技能组。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'],
'example' => 'MONITORING',
],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609255716900'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:131888****->8001****:1609225718294:job-6538214103685****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '1318888****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => 'agent@ccc-test'],
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => '1609136956378'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'DeviceState' => [
'description' => '设备状态。',
'type' => 'string',
'enumValueTitles' => ['UNREGISTERED' => '未注册', 'ONLINE' => '在线', 'OFFLINE' => '离线'],
'example' => 'false',
],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'TALKING',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'."\n"],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''],
['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作,用户状态不符合预期。'],
],
404 => [
['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'],
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'],
],
],
'title' => '转会议',
'changeSet' => [
['createdAt' => '2023-10-26T08:13:44.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchToConference'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"D9C96A73-09C9-5E2A-8CDB-85EC0BC246DA\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"NONE\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609255716900,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609225718294:job-6538214103685****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8032****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Heartbeat\\": 0,\\n \\"Extension\\": \\"8032****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"1609136956378\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"false\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\\\n\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
],
'TakeBreak' => [
'summary' => '调用TakeBreak将指定实例下的指定坐席设置为小休状态。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID,不填默认使用当前RAM账户映射的坐席。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
[
'name' => 'Code',
'in' => 'query',
'schema' => ['description' => '小休状态码,客户可以自定义任何小休状态。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'lunchtime'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => 'B59382D2-5755-4C6D-861F-FA2AAD8F89F7'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。'."\n",
'type' => 'object',
'properties' => [
'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8001****'],
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609249563836'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'Reserved' => ['description' => '坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609234221864'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '席上线后置闲前的临时小休状态'],
'example' => 'lunchtime',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1390000****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => '无'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'BREAK',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作,用户状态不符合预期。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
],
'title' => '小休',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-10-26T08:13:44.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TakeBreak'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"B59382D2-5755-4C6D-861F-FA2AAD8F89F7\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609249563836,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609234221864,\\n \\"BreakCode\\": \\"lunchtime\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"无\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>B59382D2-5755-4C6D-861F-FA2AAD8F89F7</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <Extension>8001****</Extension>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <BreakCode>default</BreakCode>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-bs3b5f22c6d78f000176aebe9471</DeviceId>\\n <Heartbeat>1609249563836</Heartbeat>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>1390000****</Mobile>\\n <JobId>无</JobId>\\n <WorkMode>ON_SITE</WorkMode>\\n <Reserved>1609234221864</Reserved>\\n <SignedSkillGroupIdList>[\\"skill-group@ccc-test\\"]</SignedSkillGroupIdList>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'TerminateTicket' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'TicketId',
'in' => 'query',
'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => false, 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb'],
],
[
'name' => 'Comment',
'in' => 'query',
'schema' => ['description' => '处理意见。', 'type' => 'string', 'required' => false, 'example' => '关单'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'CloseTicketResponse',
'description' => 'CloseTicketResponse',
'type' => 'object',
'properties' => [
'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '关闭工单',
'summary' => '使用TerminateTicket关闭工单。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'TransferTicketTask' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'TicketId',
'in' => 'query',
'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => false, 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb'],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '节点ID。', 'type' => 'string', 'required' => false, 'example' => 'f780ade8-3ca9-458b-b067-63077946a570'],
],
[
'name' => 'Assignee',
'in' => 'query',
'schema' => ['description' => '处理人ID。', 'type' => 'string', 'required' => true, 'example' => 'assignee@ccc-test'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'Comment',
'in' => 'query',
'schema' => ['description' => '处理意见。', 'type' => 'string', 'required' => false, 'example' => '请assignee处理'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'TransferTicketTaskResponse',
'description' => 'TransferTicketTaskResponse',
'type' => 'object',
'properties' => [
'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '678F7002-CA01-4ABF-A112-585AFBDF3A3B'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"678F7002-CA01-4ABF-A112-585AFBDF3A3B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '工单指派',
'summary' => '使用TransferTicketTask指派工单给其他处理人处理。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'UnmuteCall' => [
'summary' => '调用UnmuteCall取消通话静音。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '需要取消静音的坐席ID,不填默认使用当前RAM账户映射的坐席。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID,无意义,可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => false, 'example' => 'job-6538214103685****'."\n"],
],
[
'name' => 'ChannelId',
'in' => 'query',
'schema' => ['description' => '待取消静音的话务通道ID,非必填,默认为空,为空表示取消静音UserId对应的坐席的话务通道。', 'type' => 'string', 'required' => false, 'example' => 'ch:user:1390501****->8032****:1609138902226:job-6538214103685****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'description' => '响应参数列表。',
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'CallContext' => [
'description' => '话务上下文环境。',
'type' => 'object',
'properties' => [
'CallType' => [
'description' => '通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelContexts' => [
'description' => '话务通道列表。',
'type' => 'array',
'items' => [
'description' => '话务通道。',
'type' => 'object',
'properties' => [
'Index' => ['description' => '系统自增ID,客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ReleaseInitiator' => ['description' => '话务通道的挂断方,表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'],
'ChannelState' => [
'description' => '话务通道的状态。',
'type' => 'string',
'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'],
'example' => 'CREATED',
],
'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'],
'UserId' => ['description' => '话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'ChannelFlags' => [
'description' => '话务通道标志。',
'type' => 'string',
'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'],
'example' => 'MONITORING',
],
'SkillGroupId' => ['description' => '该通话相关技能组。呼入场景下,技能组由IVR中路由的排队队列指定。在呼出场景下,技能组是座席签入的第一个技能组。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'],
'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'],
'ReleaseReason' => ['description' => '话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'],
'CallType' => [
'description' => '话务通道的通话类型。',
'type' => 'string',
'enumValueTitles' => [
'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼',
'COACH' => '辅导',
],
'example' => 'OUTBOUND',
],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-6538214103685****'],
'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'],
'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'],
],
],
],
],
],
'UserContext' => [
'description' => '坐席上下文环境。',
'type' => 'object',
'properties' => [
'Heartbeat' => ['description' => '上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'],
'Extension' => ['description' => '座席分机号。', 'type' => 'string', 'example' => '8032****'],
'WorkMode' => [
'description' => '工作模式。',
'type' => 'string',
'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'],
'example' => 'ON_SITE',
],
'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'],
'DeviceId' => ['description' => '设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'],
'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'],
'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'],
'BreakCode' => [
'description' => '小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。',
'type' => 'string',
'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'],
'example' => 'Warm-up',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'],
'UserState' => [
'description' => '座席状态。',
'type' => 'string',
'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'],
'example' => 'TALKING',
],
'SignedSkillGroupIdList' => [
'description' => '坐席签入的技能组ID列表。',
'type' => 'array',
'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'],
['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''],
['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作,用户状态不符合预期。'],
],
404 => [
['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'],
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'],
],
500 => [
['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'],
],
],
'title' => '取消通话静音',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-10-26T08:13:44.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnmuteCall'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-6538214103685****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Heartbeat\\": 1609136956378,\\n \\"Extension\\": \\"8032****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <Extension>80326034</Extension>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <Heartbeat>1609136956378</Heartbeat>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>1</Index>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <AssociatedData/>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]',
],
'UnregisterDevice' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREccc8HB4RI'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
],
403 => [
['errorCode' => 'Permission.User', 'errorMessage' => 'You have no permission to access user(s) %s.', 'description' => '您无权访问这些用户。'],
],
[
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
500 => [
['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'],
],
],
'title' => '删除注册设备',
'summary' => '调用UnregisterDevice删除指定实例下指定坐席的设备注册记录,删除后将导致与坐席关联的SIP话机或SIP软电话不可用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnregisterDevice'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]',
],
'UpdateCallSummary' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccBCFPY3'],
],
'parameters' => [
[
'name' => 'TicketId',
'in' => 'query',
'schema' => ['description' => '小结ID。', 'type' => 'string', 'required' => true, 'example' => 'f2c6722b-cd13-442d-bf10-22a07c70d6d5'],
],
[
'name' => 'Context',
'in' => 'query',
'schema' => ['title' => '更新内容', 'description' => '更新内容。', 'type' => 'string', 'required' => false, 'example' => '{"summaryTitle":"标题","summaryContent":"内容","keywords":"关键信息"}'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'UpdateCallSummaryResponse',
'description' => 'UpdateCallSummaryResponse',
'type' => 'object',
'properties' => [
'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71'],
'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '更新会话小结',
'summary' => '使用UpdateCallSummary更新会话小结。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
],
'UpdateCampaign' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccQFUGXR'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'CampaignId',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => 'ab11908b-6ebc-4b0c-b51e-3e17c7060'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,格式为Unix时间戳,单位毫秒。', 'type' => 'string', 'required' => false, 'example' => '1689901200000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,格式为Unix时间戳,单位毫秒。', 'type' => 'string', 'required' => false, 'example' => '1689933600000'],
],
[
'name' => 'CallableTime',
'in' => 'query',
'schema' => ['description' => '可执行时间,支持多个时间段。', 'type' => 'string', 'required' => false, 'example' => '['."\n"
.' {'."\n"
.' "beginTime": "09:00:00",'."\n"
.' "endTime": "12:00:00"'."\n"
.' }'."\n"
.']'],
],
[
'name' => 'StrategyParameters',
'in' => 'query',
'schema' => ['description' => '策略参数。', 'type' => 'string', 'required' => false, 'example' => 'PACING策略,参考参数'."\n"
.'{'."\n"
.' "ratio": 2'."\n"
.'}'."\n"
."\n"
.'PID策略,参考参数'."\n"
.'{'."\n"
.' "abandonRate":5,'."\n"
.' "historicalConnectedRate":45'."\n"
.'}'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '预测式外呼活动名称。', 'type' => 'string', 'required' => false, 'example' => '云联络中心测试'],
],
[
'name' => 'ContactFlowId',
'in' => 'query',
'schema' => ['description' => '联系流ID。', 'type' => 'string', 'required' => false, 'example' => '3a310f56-4d30-4081-ba24-5d87a3b7262e'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E'],
'Code' => ['title' => 'code', 'description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['title' => 'message', 'description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
],
],
],
'title' => '修改外呼活动',
'summary' => '修改外呼活动参数。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
],
'UpdateChatRoutingProfile' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'],
],
[
'name' => 'RoutingProfiles',
'in' => 'query',
'schema' => ['description' => '会话分配/转接配置。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{'."\n"
.' "RoutingType": "Automatic",'."\n"
.' "AgentConcurrencySettings": {'."\n"
.' "AllowExceedingLimitWhenTransferring": false,'."\n"
.' "ConcurrencyLimit": 4,'."\n"
.' "AllowExceedingLimitWhenClaiming": true,'."\n"
.' "Enabled": true'."\n"
.' },'."\n"
.' "ChatSettings": {'."\n"
.' "IdleChatTimeoutSeconds": 300'."\n"
.' },'."\n"
.' "DistributionSettings": {'."\n"
.' "Enabled": true,'."\n"
.' "AgentRingTimeoutSeconds": 119,'."\n"
.' "MaxNumberOfConversationsAgentCanMiss": 5,'."\n"
.' "PostAgentMissingConversionsAction": "Nothing"'."\n"
.' }'."\n"
.'}'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''],
['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'],
['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'No permission', 'description' => ''],
],
[
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '更新会话转接配置',
'summary' => '使用UpdateChatRoutingProfile进行会话转接配置。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'UpdateConfigItems' => [
'summary' => '调用UpdateConfigItems添加或修改指定实例下的配置信息,例如:来电显示是否隐藏号码,呼入场景下是否允许坐席主动挂机等。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccTMAX45'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'ObjectId',
'in' => 'query',
'schema' => ['description' => '配置信息所属的对象的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'ObjectType',
'in' => 'query',
'schema' => ['description' => '配置信息所属对象的类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE'],
],
[
'name' => 'ConfigItems',
'in' => 'query',
'schema' => [
'description' => '配置项列表,格式为JSON数组的字符串,数组元素是一个对象,该对象包含两个字段,name,value,name是配置项的名称,value是配置项的值。配置项名称包含系统定义和客户自定义两种,系统定义包括是否允许坐席挂机、是否自动接听、久振未接时长等,这部分配置项名称是固定的,值可以由客户自定义,除此之外,配置项名称也支持客户自定义,客户可以根据需要添加配置项。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['AllowAudioDownload' => '是否允许坐席下载录音,取值:0(不允许)、1(允许)。', 'RecordingStorageSetting' => '实例录音存储配置。', 'AllowChooseSignedSkillGroup' => '坐席上线前是否手动选择签入的技能组,取值:0(自动签入所属的全部技能组)、1(手动选择签入的技能组)。', 'AgentRingingTimeoutSeconds' => '坐席久振未接超时时长,取值范围为5-90,单位秒。', 'ShowCalledID' => '坐席来电显示,取值:-1(隐藏全部来电号码)、0(隐藏部分来电号码)、1(显示完整来电号码)。', 'ShowCalleeID' => '坐席外呼显示,取值:-1(隐藏全部外呼号码)、0(隐藏部分外呼号码)、1(显示完整外呼号码)。', 'AllowHangup' => '坐席呼入挂机方式,取值:0(不允许坐席挂机)、1(允许坐席挂机)。', 'AutoAnswerCall' => '坐席接听来电方式,取值:-1(手动接听)、n(振铃n秒后接听)。'],
'example' => '[{"name":"ShowCalledID","value":"-1"},{"name":"ShowCalleeID","value":"1"},{"name":"AllowHangup","value":"0"},{"name":"AutoAnswerCall","value":"-1"},{"name":"AllowAudioDownload","value":"1"},{"name":"AllowChooseSignedSkillGroup","value":"1"}]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8E7Y5B39-3E24-4A04-81E6-6C4F5B39DF75'],
'Params' => [
'type' => 'array',
'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'],
],
],
'title' => '更新配置项',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-11-17T01:12:03.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConfigItems'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"8E7Y5B39-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>8E7Y5B39-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Code>OK</Code>","errorExample":""}]',
],
'UpdateSchemaProperty' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'parameters' => [
[
'name' => 'SchemaId',
'in' => 'formData',
'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'],
],
[
'name' => 'Property',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '字段',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '显示名称', 'type' => 'string', 'required' => false, 'example' => '姓名'],
'Description' => ['description' => '描述。', 'type' => 'string', 'required' => false, 'example' => '-'],
'Name' => ['description' => '名称', 'type' => 'string', 'required' => true, 'example' => 'name'],
'DataType' => ['description' => '数据类型', 'type' => 'string', 'required' => true, 'example' => 'string'],
'Pattern' => ['description' => '正则表达式校验规则', 'type' => 'string', 'required' => false, 'example' => '(.*)'],
'PatternErrorMessage' => ['description' => '正则表达式校验错误提示信息', 'type' => 'string', 'required' => false, 'example' => '不是有效的email地址'],
'MinLength' => ['description' => '最小长度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'MaxLength' => ['description' => '最大长度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
'Minimum' => ['description' => '数字最小值', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '10800'],
'Maximum' => ['description' => '数字最大值', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '11'],
'Required' => ['description' => '是否必填', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
'Disabled' => ['description' => '是否被禁用', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'Array' => ['description' => '是否是数组', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
'ReadOnly' => ['description' => '是否只读', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'EditorType' => ['description' => '编辑器类型', 'type' => 'string', 'required' => false, 'example' => 'textbox'],
'Attributes' => ['description' => '扩展属性', 'type' => 'string', 'required' => false, 'example' => '{\\"instanceId\\":\\"4cc3f160-ca64-49ff-bc70-390a044a4e83\\",\\"appId\\":\\"1684145288664\\",\\"commodityCode\\":\\"dide_pre\\",\\"dide_pre_set\\":\\"version_ent\\"}'],
'DisplayOrder' => ['description' => '列表展示顺序', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
'required' => false,
],
],
[
'name' => 'RequestId',
'in' => 'formData',
'schema' => ['description' => '请求ID', 'type' => 'string', 'required' => false, 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例 ID', 'type' => 'string', 'required' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'UpdateSchemaPropertyResponse',
'description' => 'UpdateSchemaPropertyResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A450574A-337F-43E2-BC59-9C6594C994C6'],
'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码'."\n"
."\n", 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '响应参数。',
'type' => 'array',
'items' => ['description' => '参数信息。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A450574A-337F-43E2-BC59-9C6594C994C6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '更新Schema字段',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'UpdateSubscription' => [
'summary' => '使用UpdateSubscription接口进行消息订阅配置。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcccD5GAHN'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'],
],
[
'name' => 'AliyunUid',
'in' => 'query',
'schema' => ['description' => '无需填写', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '无'],
],
[
'name' => 'ProducerId',
'in' => 'query',
'schema' => ['description' => 'MQ方式,对应GroupId。'."\n"
.'Webhook方式,填写PID_Webhook。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'GID_xxx'],
],
[
'name' => 'DefaultTopic',
'in' => 'query',
'schema' => ['description' => 'MQ方式为MQ的Topic。Webhook方式填写Topic_Webhook', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ccc-event'],
],
[
'name' => 'AccessPoint',
'in' => 'query',
'schema' => ['description' => 'MQ的接入地址。Webhook的服务地址。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rmq-cn-****.cn-shanghai.rmq.aliyuncs.com:8080'],
],
[
'name' => 'EventSubscriptionsJson',
'in' => 'query',
'schema' => ['description' => '消息订阅清单。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"Name ":"StopConsultant ","Disabled ":true},{"Name ":"QueueingRerouted ","Disabled ":true},{"Name ":"IvrTracking ","Disabled ":true},{"Name ":"DualTrackRecordingReady ","Disabled ":true},{"Name ":"SatisfactionSurveyResponse ","Disabled ":true},{"Name ":"Dialing ","Disabled ":false},{"Name ":"Abandoned ","Disabled ":true},{"Name ":"QueueingCancelled ","Disabled ":true},{"Name ":"RecordingReady ","Disabled ":true},{"Name ":"StopCoach ","Disabled ":true},{"Name ":"Established ","Disabled ":true},{"Name ":"InitiateConsultant ","Disabled ":true},{"Name ":"Route2IVR ","Disabled ":false},{"Name ":"Retrieved ","Disabled ":true},{"Name ":"CampaignPaused ","Disabled ":true},{"Name ":"TextStream ","Disabled ":true},{"Name ":"AgentRelease ","Disabled ":true},{"Name ":"VoicemailReady ","Disabled ":true},{"Name ":"Released ","Disabled ":false},{"Name ":"CDRReady ","Disabled ":true},{"Name ":"CaseAttempted ","Disabled ":true},{"Name ":"AgentBreak ","Disabled ":true},{"Name ":"AgentRingingTimeout ","Disabled ":true},{"Name ":"AgentReady ","Disabled ":true},{"Name ":"CampaignResumed ","Disabled ":true},{"Name ":"AgentDialing ","Disabled ":true},{"Name ":"Ringing ","Disabled ":true},{"Name ":"StartConsultant ","Disabled ":false},{"Name ":"QueueingTimeout ","Disabled ":true},{"Name ":"AgentTalk ","Disabled ":true},{"Name ":"AgentRinging ","Disabled ":true},{"Name ":"StartMonitor ","Disabled ":true},{"Name ":"BlindTransfer ","Disabled ":true},{"Name ":"Intercept ","Disabled ":true},{"Name ":"RingingTimeout ","Disabled ":true},{"Name ":"StartConference ","Disabled ":true},{"Name ":"QueueingOverflow ","Disabled ":true},{"Name ":"BargeIn ","Disabled ":true},{"Name ":"StopConference ","Disabled ":true},{"Name ":"AgentCheckOut ","Disabled ":true},{"Name ":"CampaignSubmitted ","Disabled ":true},{"Name ":"AgentCheckIn ","Disabled ":true},{"Name ":"Enqueue ","Disabled ":false},{"Name ":"AttendedTransfer ","Disabled ":true},{"Name ":"StopMonitor ","Disabled ":true},{"Name ":"DispatchingFailure ","Disabled ":true},{"Name ":"SatisfactionSurveyOffer ","Disabled ":true},{"Name ":"CampaignCompleted ","Disabled ":true},{"Name ":"CampaignAborted ","Disabled ":true},{"Name ":"AssignAgent ","Disabled ":true},{"Name ":"Held ","Disabled ":true},{"Name ":"StartCoach ","Disabled ":true}]'],
],
[
'name' => 'MqType',
'in' => 'query',
'schema' => ['description' => '消息推送类型。'."\n"
.'- rocketmq4'."\n"
.'- rocketmq5'."\n"
.'- webhook', 'type' => 'string', 'required' => false, 'example' => 'rocketmq5'],
],
[
'name' => 'Username',
'in' => 'query',
'schema' => ['description' => 'MQ用户名,只有当MqType==rocketmq5时,需要指定。', 'type' => 'string', 'required' => false, 'example' => 'username'],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['description' => 'MQ 密码,只有当 MqType==rocketmq5 时,需要指定。', 'type' => 'string', 'required' => false, 'example' => 'password'],
],
[
'name' => 'MqInstanceId',
'in' => 'query',
'schema' => ['description' => 'MQ实例,当MqType==rocketmq4或MqType==rocketmq5时,需要指定', 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
'Data' => [
'description' => '数据。',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'],
'ProducerId' => ['description' => 'MQ 方式,对应 GroupId。 Webhook 方式,填写 PID_Webhook。', 'type' => 'string', 'example' => 'GID_xxx'],
'Topic' => ['description' => 'MQ 方式为 MQ 的 Topic。Webhook 方式填写 Topic_Webhook', 'type' => 'string', 'example' => 'ccc-event'],
'AccessPoint' => ['description' => 'MQ 的接入地址。Webhook 的服务地址。', 'type' => 'string', 'example' => 'rmq-cn-****.cn-shanghai.rmq.aliyuncs.com:8080'],
'Username' => ['description' => 'MQ 用户名,只有当 MqType==rocketmq5 时,需要指定。', 'type' => 'string', 'example' => 'username'],
'MqType' => ['description' => '消息推送类型。'."\n"
.'- rocketmq4'."\n"
.'- rocketmq5'."\n"
.'- webhook', 'type' => 'string', 'example' => 'rocketmq5'],
'MqInstanceId' => ['description' => 'MQ 实例,当 MqType==rocketmq4 或 MqType==rocketmq5 时,需要指定', 'type' => 'string', 'example' => 'rmq-cn-****'],
'EventList' => [
'description' => '消息事件清单。',
'type' => 'array',
'items' => [
'description' => '消息事件。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '事件名称。', 'type' => 'string', 'example' => 'Dialing'],
'Disabled' => ['description' => '是否推送。', 'type' => 'boolean', 'example' => 'true'],
'Topic' => ['description' => '事件主题。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'],
['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'],
['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'],
],
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'title' => '配置消息订阅',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ProducerId\\": \\"GID_xxx\\",\\n \\"Topic\\": \\"ccc-event\\",\\n \\"AccessPoint\\": \\"rmq-cn-****.cn-shanghai.rmq.aliyuncs.com:8080\\",\\n \\"Username\\": \\"username\\",\\n \\"MqType\\": \\"rocketmq5\\",\\n \\"MqInstanceId\\": \\"rmq-cn-****\\",\\n \\"EventList\\": [\\n {\\n \\"Name\\": \\"Dialing\\",\\n \\"Disabled\\": true,\\n \\"Topic\\": \\"无\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'UpdateTicket' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
[
'name' => 'TicketId',
'in' => 'query',
'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => true, 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb'],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => ['description' => '工单标题。', 'type' => 'string', 'required' => false, 'example' => '标题'],
],
[
'name' => 'CustomerId',
'in' => 'query',
'schema' => ['description' => '用户ID。', 'type' => 'string', 'required' => false, 'example' => '51e155ce-***-****-b402-13c69597b920'],
],
[
'name' => 'Context',
'in' => 'query',
'schema' => ['description' => '工单表单信息。', 'type' => 'string', 'required' => false, 'example' => '{"productName":"玩具1"}'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'UpdateTicketResponse',
'description' => 'UpdateTicketResponse',
'type' => 'object',
'properties' => [
'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '更新工单信息',
'summary' => '使用UpdateTicket更新工单内容。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
'WithdrawTicket' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'TicketId',
'in' => 'query',
'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => true, 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb'],
],
[
'name' => 'Comment',
'in' => 'query',
'schema' => ['description' => '处理意见。', 'type' => 'string', 'required' => true, 'example' => '撤回,补充信息'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'CancelTicketResponse',
'description' => 'CancelTicketResponse',
'type' => 'object',
'properties' => [
'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'],
'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
'Params' => [
'description' => '错误参数列表。',
'type' => 'array',
'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]',
'title' => '撤回工单',
'summary' => '使用WithdrawTicket撤回工单。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ramActions' => [],
],
],
'endpoints' => [
['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ccc.cn-shanghai.aliyuncs.com', 'endpoint' => 'ccc.cn-shanghai.aliyuncs.com', 'vpc' => 'ccc-vpc.cn-shanghai.aliyuncs.com'],
],
'errorCodes' => [
['code' => 'AbnormalService.Ceased', 'message' => 'Service abnormal. The instance %s is stopped.', 'http_code' => 403, 'description' => '服务异常,实例已停止。'],
['code' => 'AbnormalService.Creating', 'message' => 'Service abnormal. The instance %s is being created.', 'http_code' => 403, 'description' => '服务异常,正在创建实例。'],
['code' => 'AbnormalService.Disabled', 'message' => 'Service abnormal. Call center service of %s is not enabled.', 'http_code' => 403, 'description' => '服务异常,云联络中心服务未启用。'],
['code' => 'AlreadyExists.CustomNumber', 'message' => 'Custom number already exists.', 'http_code' => 409, 'description' => '呼入号码标记已存在。'],
['code' => 'AlreadyExists.DomainName', 'message' => 'Instance %s already exists.', 'http_code' => 409, 'description' => '云联络中心实例已存在。'],
['code' => 'AlreadyExists.InstanceId', 'message' => 'The instance %s already exists.', 'http_code' => 409, 'description' => '云联络中心实例已存在。'],
['code' => 'AlreadyExists.PhoneNumber', 'message' => 'The specified number %s already exists in the instance.', 'http_code' => 409, 'description' => '云联络中心实例中已经存在指定的号码。'],
['code' => 'AlreadyExists.RamUser', 'message' => 'RAM user %s already exists.', 'http_code' => 409, 'description' => 'Ram用户已存在。'],
['code' => 'AlreadyExists.SkillGroupId', 'message' => 'Skill group %s already exists in instance %s.', 'http_code' => 409, 'description' => '云联络中心实例中已经存在指定的技能组。'],
['code' => 'AlreadyExists.User', 'message' => 'User %s already exists in instance %s.', 'http_code' => 409, 'description' => '云联络中心实例下已存在指定的用户。'],
['code' => 'AlreadyExists.UserName', 'message' => 'User name %s already exists。', 'http_code' => 409, 'description' => '用户名%s已存在。'],
['code' => 'Authentication.Signature', 'message' => 'Failed to generate signature for SIP authentication.', 'http_code' => 500, 'description' => '无法为SIP身份验证生成签名。'],
['code' => 'InternalService.AC', 'message' => 'An internal AC service error occurred. %s', 'http_code' => 500, 'description' => '内部AC服务错误。'],
['code' => 'InternalService.Account', 'message' => 'An internal Account service error occurred. %s', 'http_code' => 500, 'description' => '内部Account服务错误。'],
['code' => 'InternalService.Common', 'message' => 'An internal service error occurred. %s', 'http_code' => 500, 'description' => '内部服务错误。'],
['code' => 'InternalService.CTI', 'message' => 'An internal CTI service error occurred. %s', 'http_code' => 500, 'description' => '内部CTI服务错误。'],
['code' => 'InternalService.DB', 'message' => 'An internal DB service error occurred. %s', 'http_code' => 500, 'description' => '内部数据服务错误。'],
['code' => 'InternalService.IVR', 'message' => 'An internal IVR service error occurred. %s', 'http_code' => 500, 'description' => '内部IVR服务错误。'],
['code' => 'InternalService.OSS', 'message' => 'An internal OSS service error occurred. %s', 'http_code' => 500, 'description' => '内部OSS服务错误。'],
['code' => 'InternalService.RAM', 'message' => 'An internal RAM service error occurred. %s', 'http_code' => 500, 'description' => '内部RAM服务错误。'],
['code' => 'InternalService.Redis', 'message' => 'An internal Redis service error occurred. %s', 'http_code' => 500, 'description' => '内部Redis服务错误。'],
['code' => 'InternalService.ResourcePlatform', 'message' => 'An internal ResourcePlatform service error occurred. %s', 'http_code' => 500, 'description' => '内部ResourcePlatform服务错误。'],
['code' => 'InternalService.STS', 'message' => 'An internal STS service error occurred. %s', 'http_code' => 500, 'description' => '内部STS服务错误。'],
['code' => 'InternalService.WorkFlow', 'message' => 'An internal WorkFlow service error occurred. %s', 'http_code' => 500, 'description' => '内部WorkFlow服务错误。'],
['code' => 'InUse.Instance', 'message' => 'Instance %s is in use now.', 'http_code' => 400, 'description' => '指定的云联络中心实例正在使用中。'],
['code' => 'InUse.SkillGroup', 'message' => 'Skill group %s is in use now.', 'http_code' => 400, 'description' => '技能组正在被使用,该状态表明技能组可能关联着号码或坐席。'],
['code' => 'InvalidOperation.ChannelState', 'message' => 'The operation is not allowed. Channel state (%s) does not meet expectations (%s).', 'http_code' => 400, 'description' => '非法操作,channel状态不符合预期。'],
['code' => 'InvalidOperation.ContactFlow', 'message' => 'The operation is not allowed. Contact flow %s is edited by someone else.', 'http_code' => 400, 'description' => '不允许该操作。 该联系流正在由其他人编辑。'],
['code' => 'InvalidOperation.DeviceState', 'message' => 'The operation is not allowed. Device state (%s) does not meet expectations (%s).', 'http_code' => 400, 'description' => '非法操作。 设备状态不符合预期。'],
['code' => 'InvalidOperation.DraftContactFlow', 'message' => 'Draft %s of ContactFlow %s is edited by someone else.', 'http_code' => 400, 'description' => '该联系流草稿正在由其他人编辑。'],
['code' => 'InvalidOperation.DuplicatedCallee', 'message' => 'The operation is not allowed. The called number %s already exists in call %s.', 'http_code' => 400, 'description' => '非法操作,新加入的一方已在通道中。'],
['code' => 'InvalidOperation.SignedSkillGroup', 'message' => 'The operation is not allowed. User have not yet signed in any skill group.', 'http_code' => 400, 'description' => '非法操作,用户尚未迁入任何技能组。'],
['code' => 'InvalidOperation.UserState', 'message' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'http_code' => 400, 'description' => '非法操作,用户状态不符合预期。'],
['code' => 'LimitExceed.CallTagsPerInstance', 'message' => 'The total number of call tag of the instance exceeds the limit %s.', 'http_code' => 400, 'description' => '号码标签数量超出单个实例的上限阈值。'],
['code' => 'LimitExceed.CallTagsPerNumber', 'message' => 'The total number of call tag of numbers exceeds the limit %s.', 'http_code' => 400, 'description' => '号码标签数量超出单个呼入号码标记的上线阈值。'],
['code' => 'LimitExceeded.File', 'message' => 'The size of the file exceeds the limit of %s MB.', 'http_code' => 400, 'description' => '文件大小超过上限。无法继续添加,如有特殊需要,请您通过工单进行问题反馈。'],
['code' => 'LimitExceeded.SkillGroup', 'message' => 'The total count of skill group exceeds the limit %s.', 'http_code' => 400, 'description' => '技能组数量超过上限。'],
['code' => 'LimitExceeded.SkillGroupsPerUser', 'message' => 'The total count of skill group of a user exceeds the limit %s.', 'http_code' => 400, 'description' => '单用户关联的技能组数量超过上限。'],
['code' => 'LimitExceeded.User', 'message' => 'The total count of user exceeds the limit %s.', 'http_code' => 400, 'description' => '用户数量超过上限。无法继续添加用户,如有特殊需要,请您通过工单进行问题反馈。'],
['code' => 'NoPermission.User', 'message' => 'User %s has no permission to %s.', 'http_code' => 403, 'description' => '用户%s没有%s的权限。'],
['code' => 'NotExist.Instance', 'message' => 'Call center instance %s does not exist.', 'http_code' => 404, 'description' => '云联络中心实例%s不存在。'],
['code' => 'NotExist.SkillGroup', 'message' => 'Skill group %s does not exist.', 'http_code' => 404, 'description' => '技能组%s不存在。'],
['code' => 'NotExist.User', 'message' => 'User %s of instance %s does not exist.', 'http_code' => 404, 'description' => '用户%s在实例%s中不存在。'],
['code' => 'NotExists.AudioResourceFileKey', 'message' => 'Audio resource file key %s does not exist.', 'http_code' => 404, 'description' => '指定的音频资源文件密钥不存在。'],
['code' => 'NotExists.AudioResourceId', 'message' => 'Audio resource %s does not exists.', 'http_code' => 404, 'description' => '指定的音频资源不存在。'],
['code' => 'NotExists.ChannelId', 'message' => 'The specified channel %s does not exist in call %s.', 'http_code' => 404, 'description' => '通话中不存在指定的Channel信息。'],
['code' => 'NotExists.ContactFlowDraftId', 'message' => 'Draft %s of contact flow %s does not exist in instance %s.', 'http_code' => 404, 'description' => '云联络中心实例的联系流中不存在指定的草稿。'],
['code' => 'NotExists.ContactFlowId', 'message' => 'Contact flow %s does not exist in instance %s.', 'http_code' => 404, 'description' => '云联络中心实例中不存在指定的联系流。'],
['code' => 'NotExists.ContactFlowSnapshotId', 'message' => 'Snapshot %s of contact flow %s does not exist in instance %s.', 'http_code' => 404, 'description' => '云联络中心实例的联系流中不存在指定的快照。'],
['code' => 'NotExists.CustomCallTagging', 'message' => 'Custom call tagging %s does not exist in instance %s.', 'http_code' => 404, 'description' => '呼入号码标记不存在。'],
['code' => 'NotExists.Extension', 'message' => 'No available extension number exists.', 'http_code' => 404, 'description' => '没有可分配的分机号。'],
['code' => 'NotExists.FunctionMetaId', 'message' => 'Function meta %s does not exist in instance %s.', 'http_code' => 404, 'description' => '云联络中心实例中不存在指定的Function Meta。'],
['code' => 'NotExists.InstanceId', 'message' => 'The specified instance %s does not exist.', 'http_code' => 404, 'description' => '指定的呼叫中心实例不存在。'],
['code' => 'NotExists.JobId', 'message' => 'The call %s does not exist.', 'http_code' => 404, 'description' => '指定的通话信息不存在。'],
['code' => 'NotExists.Number', 'message' => 'The specified number %s does not exist in instance %s.', 'http_code' => 404, 'description' => '云联络中心实例中不存在指定的号码。'],
['code' => 'NotExists.OutboundNumber', 'message' => 'A valid number for outbound call is not found.', 'http_code' => 404, 'description' => '找不到呼出电话的有效号码。'],
['code' => 'NotExists.RamId', 'message' => 'RAM user %s does not exist.', 'http_code' => 404, 'description' => '指定的RAM用户不存在。'],
['code' => 'NotExists.RoleId', 'message' => 'Role %s does not exist.', 'http_code' => 404, 'description' => '指定的角色不存在。'],
['code' => 'NotExists.SkillGroupId', 'message' => 'The skill group ID %s does not exist in instance %s.', 'http_code' => 404, 'description' => '云联络中心实例中不存在指定的技能组ID。'],
['code' => 'NotExists.SkillGroupName', 'message' => 'The skill group name %s does not exist in instance %s.', 'http_code' => 404, 'description' => '云联络中心实例中不存在指定的技能组名称。'],
['code' => 'NotExists.Switch', 'message' => 'The switch %s does not exist.', 'http_code' => 404, 'description' => 'Switch不存在'],
['code' => 'NotExists.UserId', 'message' => 'The user %s does not exist in instance %s.', 'http_code' => 404, 'description' => '云联络中心实例中不存在指定的用户。'],
['code' => 'NotExists.UserResourceFileKey', 'message' => 'User resource file key %s does not exist.', 'http_code' => 404, 'description' => 'OSS用户资源文件的Key不存在。'],
['code' => 'NotFound.CallingNumber', 'message' => 'No available calling number found in the group %s.', 'http_code' => 404, 'description' => '在组 %s 中找不到可用的主叫号码。'],
['code' => 'Parameter.Blank', 'message' => 'The parameter %s may not be null or blank.', 'http_code' => 400, 'description' => '该参数不能为null或含有空白符的字符串。'],
['code' => 'Parameter.Blank', 'message' => 'The parameter %s must not be null or empty.', 'http_code' => 400, 'description' => '该参数不能为null值。'],
['code' => 'Parameter.CallerType', 'message' => 'Invalid caller type. Caller type (%s) does not meet expectations (%s).', 'http_code' => 400, 'description' => '非法的调用类型,调用类型不符合预期。'],
['code' => 'Parameter.Empty', 'message' => 'The parameter %s may not be null or empty.', 'http_code' => 400, 'description' => '该参数不能为null值或为空字符串。'],
['code' => 'Parameter.Enumeration', 'message' => 'The parameter %s must be one of the value of enumeration %s.', 'http_code' => 400, 'description' => '该参数必须为系统限定的枚举值之一。'],
['code' => 'Parameter.Format', 'message' => 'The format of parameter %s is invalid. %s', 'http_code' => 400, 'description' => '该参数的格式不合法。'],
['code' => 'Parameter.Invalid', 'message' => 'The parameter %s is invalid. %s.', 'http_code' => 400, 'description' => '该参数无效。'],
['code' => 'Parameter.InvalidFileContent', 'message' => 'The content or format of the file (%s) is invalid.', 'http_code' => 400, 'description' => '参数错误,传入的文件内容无效。'],
['code' => 'Parameter.Maximum', 'message' => 'The parameter %s must be less than or equal to %s.', 'http_code' => 400, 'description' => '参数必须小于或等于系统规定的最大值。'],
['code' => 'Parameter.Minimum', 'message' => 'The parameter %s must be greater than or equal to %s.', 'http_code' => 400, 'description' => '参数必须大于或等于系统规定的最小值。'],
['code' => 'Parameter.Null', 'message' => 'The parameter %s may not be null.', 'http_code' => 400, 'description' => '该参数不能为null值.'],
['code' => 'Parameter.UnknownCaller', 'message' => 'Invalid caller. Caller UID is null.', 'http_code' => 400, 'description' => '无效的调用者,Caller Uid 为null。'],
['code' => 'Permission.Common', 'message' => 'You have no permission to access. %s', 'http_code' => 403, 'description' => '您无权进行访问。'],
['code' => 'Permission.Instance', 'message' => 'You have no permission to access instance %s.', 'http_code' => 403, 'description' => '您无权访问指定的实例。'],
['code' => 'Permission.PhoneNumber', 'message' => 'You have no permission to access number(s) %s.', 'http_code' => 403, 'description' => '您无权使用该号码。'],
['code' => 'Permission.RAM', 'message' => 'You are not authorized to perform this action. RAM authorization is required.', 'http_code' => 403, 'description' => '您无权执行此操作。 需要RAM授权。'],
['code' => 'Permission.Role', 'message' => 'You have no permission to access role %s.', 'http_code' => 403, 'description' => '您无权访问指定角色。'],
['code' => 'Permission.SkillGroup', 'message' => 'You have no permission to access skill group(s) %s.', 'http_code' => 403, 'description' => '您无权访问这些技能组。'],
['code' => 'Permission.StsToken', 'message' => 'You have no permission to access sts token %s.', 'http_code' => 403, 'description' => '您无权访问STS Token。'],
['code' => 'Permission.Unauthorized', 'message' => 'You are not authorized to perform this action. %s privileges are required.', 'http_code' => 403, 'description' => '您无权执行此操作。 必须具有指定权限。'],
['code' => 'Permission.User', 'message' => 'You have no permission to access user(s) %s.', 'http_code' => 403, 'description' => '您无权访问这些用户。'],
['code' => 'UserBusy', 'message' => 'The user %s you called was busy. Please try again later.', 'http_code' => 400, 'description' => '您呼叫的用户正忙,请稍后再试。'],
],
'changeSet' => [
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'AppendCases'],
],
'createdAt' => '2025-11-13T08:46:40.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateCampaign'],
],
'createdAt' => '2025-11-13T08:46:38.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateInstance'],
],
'createdAt' => '2025-10-28T09:55:47.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'MakeCall'],
],
'createdAt' => '2025-04-08T07:49:31.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListRealtimeAgentStates'],
],
'createdAt' => '2025-02-13T02:21:36.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetConversationDetail'],
],
'createdAt' => '2024-12-12T15:21:10.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'BlindTransfer'],
],
'createdAt' => '2024-10-28T02:30:54.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListCallDetailRecordsV2'],
],
'createdAt' => '2024-09-06T02:26:42.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'MakeCall'],
],
'createdAt' => '2024-08-30T02:21:15.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'LaunchSurvey'],
],
'createdAt' => '2024-08-13T06:55:08.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListCallDetailRecords'],
],
'createdAt' => '2024-07-29T10:26:01.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListRealtimeAgentStates'],
['description' => '请求参数发生变更', 'api' => 'ListRealtimeSkillGroupStates'],
],
'createdAt' => '2024-06-21T06:52:51.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'LaunchSurvey'],
],
'createdAt' => '2024-06-21T06:40:38.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetCampaign'],
['description' => '响应参数发生变更', 'api' => 'ListCampaigns'],
],
'createdAt' => '2024-06-06T11:38:32.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'],
],
'createdAt' => '2024-06-06T07:19:33.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'],
],
'createdAt' => '2024-05-28T06:54:30.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'],
],
'createdAt' => '2024-05-17T08:45:26.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'],
],
'createdAt' => '2024-05-15T02:47:21.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'],
],
'createdAt' => '2024-04-24T12:54:41.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'BlindTransfer'],
['description' => '请求参数发生变更', 'api' => 'InitiateAttendedTransfer'],
],
'createdAt' => '2024-04-01T09:23:20.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'AnswerCall'],
],
'createdAt' => '2024-02-05T03:20:31.000Z',
'description' => '',
],
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'ListUnassignedNumbers'],
],
'createdAt' => '2024-02-02T03:52:45.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListCustomCallTagging'],
],
'createdAt' => '2024-01-29T09:14:31.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'MuteCall'],
],
'createdAt' => '2024-01-18T12:07:59.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CoachCall'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'MakeCall'],
],
'createdAt' => '2024-01-11T08:11:54.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateUser'],
],
'createdAt' => '2023-12-22T03:22:19.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateAudioFile'],
['description' => '响应参数发生变更', 'api' => 'GetCampaign'],
['description' => '响应参数发生变更', 'api' => 'GetHistoricalCampaignReport'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetHistoricalInstanceReport'],
['description' => '响应参数发生变更', 'api' => 'ListCampaignTrendingReport'],
['description' => '响应参数发生变更', 'api' => 'ListCases'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListHistoricalAgentReport'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListHistoricalAgentSkillGroupReport'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListHistoricalSkillGroupReport'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListIntervalAgentReport'],
],
'createdAt' => '2023-11-22T01:05:50.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListAudioFiles'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListBriefSkillGroups'],
['description' => '响应参数发生变更', 'api' => 'ListCampaigns'],
['description' => '请求参数发生变更', 'api' => 'ModifyAudioFile'],
['description' => '响应参数发生变更', 'api' => 'ModifySkillLevelsOfUser'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ModifyUser'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'PollUserStatus'],
['description' => '响应参数发生变更', 'api' => 'RemovePhoneNumbers'],
],
'createdAt' => '2023-11-17T01:12:22.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'AddNumbersToSkillGroup'],
['description' => '请求参数发生变更', 'api' => 'BlindTransfer'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateUser'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetInstanceTrendingReport'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetLoginDetails'],
],
'createdAt' => '2023-11-07T07:22:42.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateSkillGroup'],
['description' => '响应参数发生变更', 'api' => 'ExportDoNotCallNumbers'],
['description' => '响应参数发生变更', 'api' => 'GetSkillGroup'],
['description' => '响应参数发生变更', 'api' => 'GetTurnCredentials'],
['description' => '响应参数发生变更', 'api' => 'GetTurnServerList'],
['description' => '响应参数发生变更', 'api' => 'ImportDoNotCallNumbers'],
['description' => '请求参数发生变更', 'api' => 'InterceptCall'],
['description' => '请求参数发生变更', 'api' => 'ListContactFlows'],
],
'createdAt' => '2023-11-06T05:45:10.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'BargeInCall'],
['description' => '请求参数发生变更', 'api' => 'CancelAttendedTransfer'],
['description' => '请求参数发生变更', 'api' => 'CompleteAttendedTransfer'],
['description' => '请求参数发生变更', 'api' => 'HoldCall'],
['description' => '请求参数发生变更', 'api' => 'InitiateAttendedTransfer'],
],
'createdAt' => '2023-10-26T08:14:09.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'AnswerCall'],
],
'createdAt' => '2023-10-26T07:16:03.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListCallDetailRecords'],
],
'createdAt' => '2023-10-09T15:22:58.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'AnswerCall'],
['description' => '响应参数发生变更', 'api' => 'ReleaseCall'],
],
'createdAt' => '2023-06-05T23:22:27.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetMonoRecording'],
],
'createdAt' => '2023-06-05T09:02:03.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListHistoricalAgentReport'],
['description' => '响应参数发生变更', 'api' => 'ListIntervalAgentReport'],
],
'createdAt' => '2023-05-23T11:59:19.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListAgentStateLogs'],
],
'createdAt' => '2023-05-10T07:29:56.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListMultiChannelRecordings'],
],
'createdAt' => '2023-05-08T07:40:22.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'BlindTransfer'],
['description' => '请求参数发生变更', 'api' => 'InitiateAttendedTransfer'],
],
'createdAt' => '2023-04-25T07:34:05.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ModifyUser'],
['description' => '请求参数发生变更', 'api' => 'RemoveUsers'],
],
'createdAt' => '2023-04-14T05:54:27.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'BlindTransfer'],
['description' => '请求参数发生变更', 'api' => 'InitiateAttendedTransfer'],
],
'createdAt' => '2023-04-12T02:15:44.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListCallDetailRecords'],
],
'createdAt' => '2023-03-24T08:21:09.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'RedialCall'],
],
'createdAt' => '2022-12-30T02:50:22.000Z',
'description' => 'Redia接口参数调整',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListCallDetailRecords'],
],
'createdAt' => '2022-12-07T10:57:14.000Z',
'description' => '- Support ListCallDetailRecords DialingTime response.',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'ListLegacyAppraiseLogs'],
],
'createdAt' => '2022-12-06T08:58:56.000Z',
'description' => '- Add ListAppraiseLogs api.',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ChangeWorkMode'],
],
'createdAt' => '2022-11-28T07:11:28.000Z',
'description' => '修改工作模式增加签入技能组和移动号码参数',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'PollUserStatus'],
],
'createdAt' => '2022-11-28T06:52:47.000Z',
'description' => '增加CallVariables',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListSkillGroupStates'],
],
'createdAt' => '2022-11-25T02:04:46.000Z',
'description' => '- ListSkillGroupStates support inbound/outbound agent count by inbound/outbound.',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetAudioFile'],
['description' => '响应参数发生变更', 'api' => 'ListAudioFiles'],
],
'createdAt' => '2022-10-17T02:12:18.000Z',
'description' => '删除录音相关接口中无效的返回字段。',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListRealtimeAgentStates'],
],
'createdAt' => '2022-10-17T02:12:17.000Z',
'description' => '- ListRealtimeAgentStates支持Query和CallTypeList查询',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListAgentStates'],
],
'createdAt' => '2022-10-17T02:12:16.000Z',
'description' => '- 增加excludeOfflineUsers查询参数',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetCallDetailRecord'],
['description' => '响应参数发生变更', 'api' => 'ListCallDetailRecords'],
],
'createdAt' => '2022-10-14T06:48:16.000Z',
'description' => '- Supported releaseReason response',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'StartPrivacyCall'],
],
'createdAt' => '2022-09-07T02:00:28.000Z',
'description' => 'StartPrivacyCall提供Open Api',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'GetUploadAudioDataParams'],
],
'createdAt' => '2022-08-24T07:35:41.000Z',
'description' => '- support api for getting quality check params',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListRealtimeAgentStates'],
],
'createdAt' => '2022-07-12T04:34:09.000Z',
'description' => '变更ListRealtimeAgentStates接口的SkillgroupId参数的文档必填熟悉为关闭。',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'ListLegacyAgentEventLogs'],
['description' => 'OpenAPI 下线', 'api' => 'ListLegacyAgentStatusLogs'],
['description' => 'OpenAPI 下线', 'api' => 'ListLegacyQueueEventLogs'],
],
'createdAt' => '2022-07-05T09:31:50.000Z',
'description' => '- support legacy api',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListSkillGroupStates'],
],
'createdAt' => '2022-07-04T11:52:53.000Z',
'description' => '- 返回技能组仅外呼空闲坐席数量',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListHistoricalAgentReport'],
],
'createdAt' => '2022-07-04T11:50:45.000Z',
'description' => '- ListHistoricalAgentReport返回技能组相关信息',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListAgentStates'],
],
'createdAt' => '2022-07-01T13:18:19.000Z',
'description' => '- 新增仅外呼状态返回值',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListPhoneNumbers'],
],
'createdAt' => '2022-06-30T08:59:40.000Z',
'description' => '删除ListPhoneNumbers中无效的返回字段。',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListSkillGroupStates'],
['description' => '响应参数发生变更', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'],
],
'createdAt' => '2022-06-15T03:11:04.000Z',
'description' => '- 支持acc部分字段',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListSkillGroupStates'],
['description' => '响应参数发生变更', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'],
],
'createdAt' => '2022-06-07T11:35:47.000Z',
'description' => '- 增加10秒服务水平',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListRealtimeAgentStates'],
],
'createdAt' => '2022-05-25T03:04:15.000Z',
'description' => '- 增加ListRealtimeAgentStates返回参数WorkMode/OutboundScenario',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'ImportAdmins'],
],
'createdAt' => '2022-04-20T06:13:53.000Z',
'description' => 'Support ImportAdmin',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateCampaign'],
],
'createdAt' => '2022-04-18T03:06:59.000Z',
'description' => 'CreateCamapign支持SP参数',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'AnswerCall'],
['description' => '响应参数发生变更', 'api' => 'BlindTransfer'],
['description' => '响应参数发生变更', 'api' => 'LaunchSurvey'],
],
'createdAt' => '2022-03-15T12:26:19.000Z',
'description' => '增加消息顺序号',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'],
],
'createdAt' => '2022-03-10T06:25:38.000Z',
'description' => '支持技能组30秒服务水平统计',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetCallDetailRecord'],
],
'createdAt' => '2022-03-03T08:33:51.000Z',
'description' => '增加坐席事件时长',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetUser'],
],
'createdAt' => '2022-02-28T07:49:12.000Z',
'description' => 'GetUser接口返回参数增加DisplayId工号字段',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'ListAgentSummaryReportsSinceMidnight'],
['description' => 'OpenAPI 下线', 'api' => 'ListSkillGroupStates'],
['description' => 'OpenAPI 下线', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'],
],
'createdAt' => '2022-02-28T02:23:52.000Z',
'description' => 'ACC专用接口',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'CreateCustomCallTagging'],
['description' => 'OpenAPI 下线', 'api' => 'DeleteCustomCallTagging'],
['description' => 'OpenAPI 下线', 'api' => 'ListCustomCallTagging'],
['description' => 'OpenAPI 下线', 'api' => 'ModifyCustomCallTagging'],
],
'createdAt' => '2022-02-24T14:32:10.000Z',
'description' => '公开云呼2.0黑名单相关接口',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'CreateCallTags'],
['description' => 'OpenAPI 下线', 'api' => 'DeleteCallTag'],
['description' => 'OpenAPI 下线', 'api' => 'ExportCustomCallTagging'],
['description' => 'OpenAPI 下线', 'api' => 'ExportDoNotCallNumbers'],
['description' => 'OpenAPI 下线', 'api' => 'GetDoNotCallFileUploadParameters'],
['description' => 'OpenAPI 下线', 'api' => 'ImportCustomCallTagging'],
['description' => 'OpenAPI 下线', 'api' => 'ImportDoNotCallNumbers'],
['description' => 'OpenAPI 下线', 'api' => 'ListCallTags'],
['description' => 'OpenAPI 下线', 'api' => 'ListDoNotCallNumbers'],
['description' => 'OpenAPI 下线', 'api' => 'RemoveDoNotCallNumbers'],
],
'createdAt' => '2022-02-24T13:01:42.000Z',
'description' => '公开云呼2.0黑名单相关接口',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetCallDetailRecord'],
],
'createdAt' => '2022-02-23T06:55:22.000Z',
'description' => 'GetCallDetailRecord接口返回值中,增加FlowType字段,MAIN_FLOW / SURVEY_FLOW, 分别标识主流成和满意度调查流程',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateUser'],
['description' => '请求参数发生变更', 'api' => 'ModifyUser'],
],
'createdAt' => '2022-02-21T07:56:04.000Z',
'description' => '创建/修改用户接口添加工号的入参。',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetLoginDetails'],
['description' => '响应参数发生变更', 'api' => 'GetUser'],
['description' => '响应参数发生变更', 'api' => 'ListUsers'],
['description' => 'OpenAPI 下线', 'api' => 'RegisterDevices'],
['description' => '响应参数发生变更', 'api' => 'ReleaseCall'],
],
'createdAt' => '2022-01-19T15:24:03.000Z',
'description' => '支持SIP话机配置',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetLoginDetails'],
],
'createdAt' => '2021-12-22T06:06:04.000Z',
'description' => 'GetLoginDetails返回值增加WorkMode',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'StartPredictiveCall'],
],
'createdAt' => '2021-12-16T13:15:34.000Z',
'description' => 'Request增加技能组参数',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'MakeCall'],
['description' => '请求参数发生变更', 'api' => 'StartPredictiveCall'],
],
'createdAt' => '2021-12-01T09:27:12.000Z',
'description' => '增加注销话机接口',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetCallDetailRecord'],
['description' => '响应参数发生变更', 'api' => 'ListCallDetailRecords'],
],
'createdAt' => '2021-09-08T02:46:28.000Z',
'description' => '增加主叫归属地callerLocation和被叫归属地calleeLocation, 部分号码查询不到归属地信息时,该字段为null',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'StartPredictiveCall'],
],
'createdAt' => '2021-08-20T10:37:34.000Z',
'description' => '后台外呼接口上线',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'MakeCall'],
],
'createdAt' => '2021-08-18T13:14:49.000Z',
'description' => 'MakeCall增加随路数据',
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVoicemailRecording'],
['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsers'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoricalCampaignReport'],
['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgentStateLogs'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCallTag'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportCorpNumbers'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePhoneNumberFromSkillGroups'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPhoneNumbers'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCallTags'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDoNotCallFileUploadParameters'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUsersFromSkillGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportDoNotCallNumbers'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportCustomCallTagging'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillLevelsOfUser'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUnassignedNumbers'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstancesOfUser'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterDevices'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PauseCampaign'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListVoicemails'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIvrTrackingDetails'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBriefSkillGroups'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnmuteCall'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAudioFiles'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssignUsers'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConfigItems'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCampaignTrendingReport'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEarlyMediaRecording'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrivilegesOfUser'],
['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillGroupStates'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallTags'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLegacyAgentEventLogs'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCustomCallTagging'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListContactFlows'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPersonalNumbersOfUser'],
['threshold' => '1100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPredictiveCall'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAudioFile'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAudioFileUploadParameters'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCampaign'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMultiChannelRecordings'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishContactFlow'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveSkillGroupsFromUser'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRealtimeAgentStates'],
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LaunchAuthentication'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoricalInstanceReport'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomCallTagging'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUsers'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAttempts'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUser'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetUserPassword'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCampaign'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTurnServerList'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportDoNotCallNumbers'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AnswerCall'],
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallDetailRecords'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendDtmfSignaling'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRecentCallDetailRecords'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLegacyAgentStatusLogs'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySkillGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyUser'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDevices'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RetrieveCall'],
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillGroups'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'HoldCall'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePersonalNumbersFromUser'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAudioFile'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroup'],
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUploadAudioDataParams'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetContactFlow'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCaseFileUploadUrl'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReadyForService'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMultiChannelRecording'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BargeInCall'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartEditContactFlow'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRealtimeCampaignStats'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportCustomCallTagging'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveDoNotCallNumbers'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoricalCallerReport'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPrivacyCall'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyUserLevelsOfSkillGroup'],
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SaveTerminalLog'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseCall'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateContactFlow'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLoginDetails'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddSkillGroupsToUser'],
['threshold' => '400', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMonoRecording'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPhoneNumbers'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddNumbersToSkillGroup'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAgentState'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAudioFile'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeWorkMode'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTurnCredentials'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EndConference'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportAdmins'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalSkillGroupReport'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MonitorCall'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDoNotCallNumbers'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSkillGroup'],
['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AppendCases'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BlindTransfer'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceTrendingReport'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchToConference'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnregisterDevice'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LaunchSurvey'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySkillLevelsOfUser'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserLevelsOfSkillGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DiscardEditingContactFlow'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoles'],
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCallDetailRecord'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPhoneNumber'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CoachCall'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUser'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPersonalNumbersToUser'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHistoricalAgentReport'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InterceptCall'],
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestoreArchivedRecordings'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAudioFileDownloadUrl'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalInstanceReport'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalAgentSkillGroupReport'],
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgentStates'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomCallTagging'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartBack2BackCall'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHistoricalAgentSkillGroupReport'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePhoneNumbersFromSkillGroup'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CompleteAttendedTransfer'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomCallTagging'],
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNumberLocation'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRamUsers'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MuteCall'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalAgentReport'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteContactFlow'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePhoneNumbers'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelAttendedTransfer'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeCampaign'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TakeBreak'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHistoricalSkillGroupReport'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConversationDetail'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitiateAttendedTransfer'],
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MakeCall'],
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddUsersToSkillGroup'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConfigItems'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SignInGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAudioFile'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitCampaign'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRealtimeInstanceStates'],
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RedialCall'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPhoneNumberToSkillGroups'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartConference'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterDevice'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCases'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLegacyQueueEventLogs'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstance'],
['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgentSummaryReportsSinceMidnight'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOutboundNumbersOfUser'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMonoRecordings'],
['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddCases'],
['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PollUserStatus'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AbortCampaign'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCampaigns'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPhoneNumbersOfSkillGroup'],
['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SignOutGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRealtimeSkillGroupStates'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSkillGroup'],
],
'product' => ['code' => 'ccc', 'title' => '云呼叫中心'],
],
'ram' => [
'productCode' => 'CloudCallCenter',
'productName' => '云联络中心',
'ramCodes' => ['ccc'],
'ramLevel' => '操作级',
'ramConditions' => [],
'ramActions' => [],
'resourceTypes' => [],
],
];
|