Spaces:
Build error
Build error
File size: 97,410 Bytes
0827183 |
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 |
{
"swagger": "2.0",
"info": {
"version": "v3",
"title": "Microsoft Bot Connector API - v3.0",
"description": "The Bot Connector REST API allows your bot to send and receive messages to channels configured in the\r\n[Bot Framework Developer Portal](https://dev.botframework.com). The Connector service uses industry-standard REST\r\nand JSON over HTTPS.\r\n\r\nClient libraries for this REST API are available. See below for a list.\r\n\r\nMany bots will use both the Bot Connector REST API and the associated [Bot State REST API](/en-us/restapi/state). The\r\nBot State REST API allows a bot to store and retrieve state associated with users and conversations.\r\n\r\nAuthentication for both the Bot Connector and Bot State REST APIs is accomplished with JWT Bearer tokens, and is\r\ndescribed in detail in the [Connector Authentication](/en-us/restapi/authentication) document.\r\n\r\n# Client Libraries for the Bot Connector REST API\r\n\r\n* [Bot Builder for C#](/en-us/csharp/builder/sdkreference/)\r\n* [Bot Builder for Node.js](/en-us/node/builder/overview/)\r\n* Generate your own from the [Connector API Swagger file](https://raw.githubusercontent.com/Microsoft/BotBuilder/master/CSharp/Library/Microsoft.Bot.Connector.Shared/Swagger/ConnectorAPI.json)\r\n\r\n© 2016 Microsoft",
"termsOfService": "https://www.microsoft.com/en-us/legal/intellectualproperty/copyright/default.aspx",
"contact": {
"name": "Bot Framework",
"url": "https://botframework.com",
"email": "botframework@microsoft.com"
},
"license": {
"name": "The MIT License (MIT)",
"url": "https://opensource.org/licenses/MIT"
}
},
"host": "api.botframework.com",
"schemes": [
"https"
],
"paths": {
"/v3/attachments/{attachmentId}": {
"get": {
"tags": [
"Attachments"
],
"summary": "GetAttachmentInfo",
"description": "Get AttachmentInfo structure describing the attachment views",
"operationId": "Attachments_GetAttachmentInfo",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "attachmentId",
"in": "path",
"description": "attachment id",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "An attachmentInfo object is returned which describes the:\r\n* type of the attachment\r\n* name of the attachment\r\n\r\n\r\nand an array of views:\r\n* Size - size of the object\r\n* ViewId - View Id which can be used to fetch a variation on the content (ex: original or thumbnail)",
"schema": {
"$ref": "#/definitions/AttachmentInfo"
}
},
"default": {
"description": "The operation failed and the response is an error object describing the status code and failure.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/v3/attachments/{attachmentId}/views/{viewId}": {
"get": {
"tags": [
"Attachments"
],
"summary": "GetAttachment",
"description": "Get the named view as binary content",
"operationId": "Attachments_GetAttachment",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "attachmentId",
"in": "path",
"description": "attachment id",
"required": true,
"type": "string"
},
{
"name": "viewId",
"in": "path",
"description": "View id from attachmentInfo",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Attachment stream",
"schema": {
"format": "byte",
"type": "file"
}
},
"301": {
"description": "The Location header describes where the content is now."
},
"302": {
"description": "The Location header describes where the content is now."
},
"default": {
"description": "The operation failed and the response is an error object describing the status code and failure.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/v3/conversations": {
"get": {
"tags": [
"Conversations"
],
"summary": "GetConversations",
"description": "List the Conversations in which this bot has participated.\r\n\r\nGET from this method with a skip token\r\n\r\nThe return value is a ConversationsResult, which contains an array of ConversationMembers and a skip token. If the skip token is not empty, then \r\nthere are further values to be returned. Call this method again with the returned token to get more values.\r\n\r\nEach ConversationMembers object contains the ID of the conversation and an array of ChannelAccounts that describe the members of the conversation.",
"operationId": "Conversations_GetConversations",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "continuationToken",
"in": "query",
"description": "skip or continuation token",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "An object will be returned containing \r\n* an array (Conversations) of ConversationMembers objects\r\n* a continuation token\r\n\r\nEach ConversationMembers object contains:\r\n* the Id of the conversation\r\n* an array (Members) of ChannelAccount objects",
"schema": {
"$ref": "#/definitions/ConversationsResult"
}
},
"default": {
"description": "The operation failed and the response is an error object describing the status code and failure.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
},
"post": {
"tags": [
"Conversations"
],
"summary": "CreateConversation",
"description": "Create a new Conversation.\r\n\r\nPOST to this method with a\r\n* Bot being the bot creating the conversation\r\n* IsGroup set to true if this is not a direct message (default is false)\r\n* Array containing the members to include in the conversation\r\n\r\nThe return value is a ResourceResponse which contains a conversation id which is suitable for use\r\nin the message payload and REST API uris.\r\n\r\nMost channels only support the semantics of bots initiating a direct message conversation. An example of how to do that would be:\r\n\r\n```\r\nvar resource = await connector.conversations.CreateConversation(new ConversationParameters(){ Bot = bot, members = new ChannelAccount[] { new ChannelAccount(\"user1\") } );\r\nawait connect.Conversations.SendToConversationAsync(resource.Id, new Activity() ... ) ;\r\n\r\n```",
"operationId": "Conversations_CreateConversation",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "parameters",
"in": "body",
"description": "Parameters to create the conversation from",
"required": true,
"schema": {
"$ref": "#/definitions/ConversationParameters"
}
}
],
"responses": {
"200": {
"description": "An object will be returned containing \r\n* the ID for the conversation\r\n* ActivityId for the activity if provided. If ActivityId is null then the channel doesn't support returning resource id's for activity.",
"schema": {
"$ref": "#/definitions/ConversationResourceResponse"
}
},
"201": {
"description": "An object will be returned containing \r\n* the ID for the conversation\r\n* ActivityId for the activity if provided. If ActivityId is null then the channel doesn't support returning resource id's for activity.",
"schema": {
"$ref": "#/definitions/ConversationResourceResponse"
}
},
"202": {
"description": "An object will be returned containing \r\n* the ID for the conversation\r\n* ActivityId for the activity if provided. If ActivityId is null then the channel doesn't support returning resource id's for activity.",
"schema": {
"$ref": "#/definitions/ConversationResourceResponse"
}
},
"default": {
"description": "The operation failed and the response is an error object describing the status code and failure.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/v3/conversations/{conversationId}/activities": {
"post": {
"tags": [
"Conversations"
],
"summary": "SendToConversation",
"description": "This method allows you to send an activity to the end of a conversation.\r\n\r\nThis is slightly different from ReplyToActivity().\r\n* SendToConversation(conversationId) - will append the activity to the end of the conversation according to the timestamp or semantics of the channel.\r\n* ReplyToActivity(conversationId,ActivityId) - adds the activity as a reply to another activity, if the channel supports it. If the channel does not support nested replies, ReplyToActivity falls back to SendToConversation.\r\n\r\nUse ReplyToActivity when replying to a specific activity in the conversation.\r\n\r\nUse SendToConversation in all other cases.",
"operationId": "Conversations_SendToConversation",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "conversationId",
"in": "path",
"description": "Conversation ID",
"required": true,
"type": "string"
},
{
"name": "activity",
"in": "body",
"description": "Activity to send",
"required": true,
"schema": {
"$ref": "#/definitions/Activity"
}
}
],
"responses": {
"200": {
"description": "An object will be returned containing the ID for the resource.",
"schema": {
"$ref": "#/definitions/ResourceResponse"
}
},
"201": {
"description": "A ResourceResponse object will be returned containing the ID for the resource.",
"schema": {
"$ref": "#/definitions/ResourceResponse"
}
},
"202": {
"description": "An object will be returned containing the ID for the resource.",
"schema": {
"$ref": "#/definitions/ResourceResponse"
}
},
"default": {
"description": "The operation failed and the response is an error object describing the status code and failure.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/v3/conversations/{conversationId}/activities/history": {
"post": {
"tags": [
"Conversations"
],
"summary": "SendConversationHistory",
"description": "This method allows you to upload the historic activities to the conversation.\r\n\r\nSender must ensure that the historic activities have unique ids and appropriate timestamps. The ids are used by the client to deal with duplicate activities and the timestamps are used by the client to render the activities in the right order.",
"operationId": "Conversations_SendConversationHistory",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "conversationId",
"in": "path",
"description": "Conversation ID",
"required": true,
"type": "string"
},
{
"name": "history",
"in": "body",
"description": "Historic activities",
"required": true,
"schema": {
"$ref": "#/definitions/Transcript"
}
}
],
"responses": {
"200": {
"description": "An object will be returned containing the ID for the resource.",
"schema": {
"$ref": "#/definitions/ResourceResponse"
}
},
"201": {
"description": "A ResourceResponse object will be returned containing the ID for the resource.",
"schema": {
"$ref": "#/definitions/ResourceResponse"
}
},
"202": {
"description": "An object will be returned containing the ID for the resource.",
"schema": {
"$ref": "#/definitions/ResourceResponse"
}
},
"default": {
"description": "The operation failed and the response is an error object describing the status code and failure.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/v3/conversations/{conversationId}/activities/{activityId}": {
"put": {
"tags": [
"Conversations"
],
"summary": "UpdateActivity",
"description": "Edit an existing activity.\r\n\r\nSome channels allow you to edit an existing activity to reflect the new state of a bot conversation.\r\n\r\nFor example, you can remove buttons after someone has clicked \"Approve\" button.",
"operationId": "Conversations_UpdateActivity",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "conversationId",
"in": "path",
"description": "Conversation ID",
"required": true,
"type": "string"
},
{
"name": "activityId",
"in": "path",
"description": "activityId to update",
"required": true,
"type": "string"
},
{
"name": "activity",
"in": "body",
"description": "replacement Activity",
"required": true,
"schema": {
"$ref": "#/definitions/Activity"
}
}
],
"responses": {
"200": {
"description": "An object will be returned containing the ID for the resource.",
"schema": {
"$ref": "#/definitions/ResourceResponse"
}
},
"201": {
"description": "A ResourceResponse object will be returned containing the ID for the resource.",
"schema": {
"$ref": "#/definitions/ResourceResponse"
}
},
"202": {
"description": "An object will be returned containing the ID for the resource.",
"schema": {
"$ref": "#/definitions/ResourceResponse"
}
},
"default": {
"description": "The operation failed and the response is an error object describing the status code and failure.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
},
"post": {
"tags": [
"Conversations"
],
"summary": "ReplyToActivity",
"description": "This method allows you to reply to an activity.\r\n\r\nThis is slightly different from SendToConversation().\r\n* SendToConversation(conversationId) - will append the activity to the end of the conversation according to the timestamp or semantics of the channel.\r\n* ReplyToActivity(conversationId,ActivityId) - adds the activity as a reply to another activity, if the channel supports it. If the channel does not support nested replies, ReplyToActivity falls back to SendToConversation.\r\n\r\nUse ReplyToActivity when replying to a specific activity in the conversation.\r\n\r\nUse SendToConversation in all other cases.",
"operationId": "Conversations_ReplyToActivity",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "conversationId",
"in": "path",
"description": "Conversation ID",
"required": true,
"type": "string"
},
{
"name": "activityId",
"in": "path",
"description": "activityId the reply is to (OPTIONAL)",
"required": true,
"type": "string"
},
{
"name": "activity",
"in": "body",
"description": "Activity to send",
"required": true,
"schema": {
"$ref": "#/definitions/Activity"
}
}
],
"responses": {
"200": {
"description": "An object will be returned containing the ID for the resource.",
"schema": {
"$ref": "#/definitions/ResourceResponse"
}
},
"201": {
"description": "A ResourceResponse object will be returned containing the ID for the resource.",
"schema": {
"$ref": "#/definitions/ResourceResponse"
}
},
"202": {
"description": "An object will be returned containing the ID for the resource.",
"schema": {
"$ref": "#/definitions/ResourceResponse"
}
},
"default": {
"description": "The operation failed and the response is an error object describing the status code and failure.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
},
"delete": {
"tags": [
"Conversations"
],
"summary": "DeleteActivity",
"description": "Delete an existing activity.\r\n\r\nSome channels allow you to delete an existing activity, and if successful this method will remove the specified activity.",
"operationId": "Conversations_DeleteActivity",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "conversationId",
"in": "path",
"description": "Conversation ID",
"required": true,
"type": "string"
},
{
"name": "activityId",
"in": "path",
"description": "activityId to delete",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The operation succeeded, there is no response."
},
"202": {
"description": "The request has been accepted for processing, but the processing has not been completed"
},
"default": {
"description": "The operation failed and the response is an error object describing the status code and failure.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/v3/conversations/{conversationId}/members": {
"get": {
"tags": [
"Conversations"
],
"summary": "GetConversationMembers",
"description": "Enumerate the members of a conversation. \r\n\r\nThis REST API takes a ConversationId and returns an array of ChannelAccount objects representing the members of the conversation.",
"operationId": "Conversations_GetConversationMembers",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "conversationId",
"in": "path",
"description": "Conversation ID",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "An array of ChannelAccount objects",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ChannelAccount"
}
}
},
"default": {
"description": "The operation failed and the response is an error object describing the status code and failure.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/v3/conversations/{conversationId}/pagedmembers": {
"get": {
"tags": [
"Conversations"
],
"summary": "GetConversationPagedMembers",
"description": "Enumerate the members of a conversation one page at a time.\r\n\r\nThis REST API takes a ConversationId. Optionally a pageSize and/or continuationToken can be provided. It returns a PagedMembersResult, which contains an array\r\nof ChannelAccounts representing the members of the conversation and a continuation token that can be used to get more values.\r\n\r\nOne page of ChannelAccounts records are returned with each call. The number of records in a page may vary between channels and calls. The pageSize parameter can be used as \r\na suggestion. If there are no additional results the response will not contain a continuation token. If there are no members in the conversation the Members will be empty or not present in the response.\r\n\r\nA response to a request that has a continuation token from a prior request may rarely return members from a previous request.",
"operationId": "Conversations_GetConversationPagedMembers",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "conversationId",
"in": "path",
"description": "Conversation ID",
"required": true,
"type": "string"
},
{
"name": "pageSize",
"in": "query",
"description": "Suggested page size",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "continuationToken",
"in": "query",
"description": "Continuation Token",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PagedMembersResult"
}
}
}
}
},
"/v3/conversations/{conversationId}/members/{memberId}": {
"delete": {
"tags": [
"Conversations"
],
"summary": "DeleteConversationMember",
"description": "Deletes a member from a conversation. \r\n\r\nThis REST API takes a ConversationId and a memberId (of type string) and removes that member from the conversation. If that member was the last member\r\nof the conversation, the conversation will also be deleted.",
"operationId": "Conversations_DeleteConversationMember",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "conversationId",
"in": "path",
"description": "Conversation ID",
"required": true,
"type": "string"
},
{
"name": "memberId",
"in": "path",
"description": "ID of the member to delete from this conversation",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The operation succeeded, there is no response."
},
"204": {
"description": "The operation succeeded but no content was returned."
},
"default": {
"description": "The operation failed and the response is an error object describing the status code and failure.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/v3/conversations/{conversationId}/activities/{activityId}/members": {
"get": {
"tags": [
"Conversations"
],
"summary": "GetActivityMembers",
"description": "Enumerate the members of an activity. \r\n\r\nThis REST API takes a ConversationId and a ActivityId, returning an array of ChannelAccount objects representing the members of the particular activity in the conversation.",
"operationId": "Conversations_GetActivityMembers",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "conversationId",
"in": "path",
"description": "Conversation ID",
"required": true,
"type": "string"
},
{
"name": "activityId",
"in": "path",
"description": "Activity ID",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "An array of ChannelAccount objects",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ChannelAccount"
}
}
},
"default": {
"description": "The operation failed and the response is an error object describing the status code and failure.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/v3/conversations/{conversationId}/attachments": {
"post": {
"tags": [
"Conversations"
],
"summary": "UploadAttachment",
"description": "Upload an attachment directly into a channel's blob storage.\r\n\r\nThis is useful because it allows you to store data in a compliant store when dealing with enterprises.\r\n\r\nThe response is a ResourceResponse which contains an AttachmentId which is suitable for using with the attachments API.",
"operationId": "Conversations_UploadAttachment",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "conversationId",
"in": "path",
"description": "Conversation ID",
"required": true,
"type": "string"
},
{
"name": "attachmentUpload",
"in": "body",
"description": "Attachment data",
"required": true,
"schema": {
"$ref": "#/definitions/AttachmentData"
}
}
],
"responses": {
"200": {
"description": "An object will be returned containing the ID for the resource.",
"schema": {
"$ref": "#/definitions/ResourceResponse"
}
},
"201": {
"description": "A ResourceResponse object will be returned containing the ID for the resource.",
"schema": {
"$ref": "#/definitions/ResourceResponse"
}
},
"202": {
"description": "An object will be returned containing the ID for the resource.",
"schema": {
"$ref": "#/definitions/ResourceResponse"
}
},
"default": {
"description": "The operation failed and the response is an error object describing the status code and failure.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
}
},
"definitions": {
"AttachmentInfo": {
"description": "Metadata for an attachment",
"type": "object",
"properties": {
"name": {
"description": "Name of the attachment",
"type": "string"
},
"type": {
"description": "ContentType of the attachment",
"type": "string"
},
"views": {
"description": "attachment views",
"type": "array",
"items": {
"$ref": "#/definitions/AttachmentView"
}
}
}
},
"AttachmentView": {
"description": "Attachment View name and size",
"type": "object",
"properties": {
"viewId": {
"description": "Id of the attachment",
"type": "string"
},
"size": {
"format": "int32",
"description": "Size of the attachment",
"type": "integer"
}
}
},
"ErrorResponse": {
"description": "An HTTP API response",
"type": "object",
"properties": {
"error": {
"$ref": "#/definitions/Error",
"description": "Error message"
}
}
},
"Error": {
"description": "Object representing error information",
"type": "object",
"properties": {
"code": {
"description": "Error code",
"type": "string"
},
"message": {
"description": "Error message",
"type": "string"
},
"innerHttpError": {
"$ref": "#/definitions/InnerHttpError",
"description": "Error from inner http call"
}
}
},
"InnerHttpError": {
"description": "Object representing inner http error",
"type": "object",
"properties": {
"statusCode": {
"format": "int32",
"description": "HttpStatusCode from failed request",
"type": "integer"
},
"body": {
"description": "Body from failed request",
"type": "object"
}
}
},
"ConversationParameters": {
"description": "Parameters for creating a new conversation",
"type": "object",
"properties": {
"isGroup": {
"description": "IsGroup",
"type": "boolean"
},
"bot": {
"$ref": "#/definitions/ChannelAccount",
"description": "The bot address for this conversation"
},
"members": {
"description": "Members to add to the conversation",
"type": "array",
"items": {
"$ref": "#/definitions/ChannelAccount"
}
},
"topicName": {
"description": "(Optional) Topic of the conversation (if supported by the channel)",
"type": "string"
},
"tenantId": {
"description": "(Optional) The tenant ID in which the conversation should be created",
"type": "string"
},
"activity": {
"$ref": "#/definitions/Activity",
"description": "(Optional) When creating a new conversation, use this activity as the initial message to the conversation"
},
"channelData": {
"description": "Channel specific payload for creating the conversation",
"type": "object"
}
}
},
"ChannelAccount": {
"description": "Channel account information needed to route a message",
"type": "object",
"properties": {
"id": {
"description": "Channel id for the user or bot on this channel (Example: joe@smith.com, or @joesmith or 123456)",
"type": "string"
},
"name": {
"description": "Display friendly name",
"type": "string"
},
"aadObjectId": {
"description": "This account's object ID within Azure Active Directory (AAD)",
"type": "string"
},
"role": {
"$ref": "#/definitions/RoleTypes",
"description": "Role of the entity behind the account (Example: User, Bot, Skill, etc.)"
}
}
},
"Activity": {
"description": "An Activity is the basic communication type for the Bot Framework 3.0 protocol.",
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/ActivityTypes",
"description": "Contains the activity type."
},
"id": {
"description": "Contains an ID that uniquely identifies the activity on the channel.",
"type": "string"
},
"timestamp": {
"format": "date-time",
"description": "Contains the date and time that the message was sent, in UTC, expressed in ISO-8601 format.",
"type": "string"
},
"localTimestamp": {
"format": "date-time",
"description": "Contains the local date and time of the message, expressed in ISO-8601 format.\r\nFor example, 2016-09-23T13:07:49.4714686-07:00.",
"type": "string"
},
"localTimezone": {
"description": "Contains the name of the local timezone of the message, expressed in IANA Time Zone database format.\r\nFor example, America/Los_Angeles.",
"type": "string"
},
"callerId": {
"description": "A string containing an IRI identifying the caller of a bot. This field is not intended to be transmitted\r\nover the wire, but is instead populated by bots and clients based on cryptographically verifiable data\r\nthat asserts the identity of the callers (e.g. tokens).",
"type": "string"
},
"serviceUrl": {
"description": "Contains the URL that specifies the channel's service endpoint. Set by the channel.",
"type": "string"
},
"channelId": {
"description": "Contains an ID that uniquely identifies the channel. Set by the channel.",
"type": "string"
},
"from": {
"$ref": "#/definitions/ChannelAccount",
"description": "Identifies the sender of the message."
},
"conversation": {
"$ref": "#/definitions/ConversationAccount",
"description": "Identifies the conversation to which the activity belongs."
},
"recipient": {
"$ref": "#/definitions/ChannelAccount",
"description": "Identifies the recipient of the message."
},
"textFormat": {
"$ref": "#/definitions/TextFormatTypes",
"description": "Format of text fields Default:markdown"
},
"attachmentLayout": {
"$ref": "#/definitions/AttachmentLayoutTypes",
"description": "The layout hint for multiple attachments. Default: list."
},
"membersAdded": {
"description": "The collection of members added to the conversation.",
"type": "array",
"items": {
"$ref": "#/definitions/ChannelAccount"
}
},
"membersRemoved": {
"description": "The collection of members removed from the conversation.",
"type": "array",
"items": {
"$ref": "#/definitions/ChannelAccount"
}
},
"reactionsAdded": {
"description": "The collection of reactions added to the conversation.",
"type": "array",
"items": {
"$ref": "#/definitions/MessageReaction"
}
},
"reactionsRemoved": {
"description": "The collection of reactions removed from the conversation.",
"type": "array",
"items": {
"$ref": "#/definitions/MessageReaction"
}
},
"topicName": {
"description": "The updated topic name of the conversation.",
"type": "string"
},
"historyDisclosed": {
"description": "Indicates whether the prior history of the channel is disclosed.",
"type": "boolean"
},
"locale": {
"description": "A locale name for the contents of the text field.\r\nThe locale name is a combination of an ISO 639 two- or three-letter culture code associated with a language\r\nand an ISO 3166 two-letter subculture code associated with a country or region.\r\nThe locale name can also correspond to a valid BCP-47 language tag.",
"type": "string"
},
"text": {
"description": "The text content of the message.",
"type": "string"
},
"speak": {
"description": "The text to speak.",
"type": "string"
},
"inputHint": {
"$ref": "#/definitions/InputHints",
"description": "Indicates whether your bot is accepting,\r\nexpecting, or ignoring user input after the message is delivered to the client."
},
"summary": {
"description": "The text to display if the channel cannot render cards.",
"type": "string"
},
"suggestedActions": {
"$ref": "#/definitions/SuggestedActions",
"description": "The suggested actions for the activity."
},
"attachments": {
"description": "Attachments",
"type": "array",
"items": {
"$ref": "#/definitions/Attachment"
}
},
"entities": {
"description": "Represents the entities that were mentioned in the message.",
"type": "array",
"items": {
"$ref": "#/definitions/Entity"
}
},
"channelData": {
"description": "Contains channel-specific content.",
"type": "object"
},
"action": {
"description": "Indicates whether the recipient of a contactRelationUpdate was added or removed from the sender's contact list.",
"type": "string"
},
"replyToId": {
"description": "Contains the ID of the message to which this message is a reply.",
"type": "string"
},
"label": {
"description": "A descriptive label for the activity.",
"type": "string"
},
"valueType": {
"description": "The type of the activity's value object.",
"type": "string"
},
"value": {
"description": "A value that is associated with the activity.",
"type": "object"
},
"name": {
"description": "The name of the operation associated with an invoke or event activity.",
"type": "string"
},
"relatesTo": {
"$ref": "#/definitions/ConversationReference",
"description": "A reference to another conversation or activity."
},
"code": {
"$ref": "#/definitions/EndOfConversationCodes",
"description": "The a code for endOfConversation activities that indicates why the conversation ended."
},
"expiration": {
"format": "date-time",
"description": "The time at which the activity should be considered to be \"expired\" and should not be presented to the recipient.",
"type": "string"
},
"importance": {
"$ref": "#/definitions/ActivityImportance",
"description": "The importance of the activity."
},
"deliveryMode": {
"$ref": "#/definitions/DeliveryModes",
"description": "A delivery hint to signal to the recipient alternate delivery paths for the activity.\r\nThe default delivery mode is \"default\"."
},
"listenFor": {
"description": "List of phrases and references that speech and language priming systems should listen for",
"type": "array",
"items": {
"type": "string"
}
},
"textHighlights": {
"description": "The collection of text fragments to highlight when the activity contains a ReplyToId value.",
"type": "array",
"items": {
"$ref": "#/definitions/TextHighlight"
}
},
"semanticAction": {
"$ref": "#/definitions/SemanticAction",
"description": "An optional programmatic action accompanying this request"
}
}
},
"ConversationAccount": {
"description": "Conversation account represents the identity of the conversation within a channel",
"type": "object",
"properties": {
"isGroup": {
"description": "Indicates whether the conversation contains more than two participants at the time the activity was generated",
"type": "boolean"
},
"conversationType": {
"description": "Indicates the type of the conversation in channels that distinguish between conversation types",
"type": "string"
},
"tenantId": {
"description": "This conversation's tenant ID",
"type": "string"
},
"id": {
"description": "Channel id for the user or bot on this channel (Example: joe@smith.com, or @joesmith or 123456)",
"type": "string"
},
"name": {
"description": "Display friendly name",
"type": "string"
},
"aadObjectId": {
"description": "This account's object ID within Azure Active Directory (AAD)",
"type": "string"
},
"role": {
"$ref": "#/definitions/RoleTypes",
"description": "Role of the entity behind the account (Example: User, Bot, Skill, etc.)"
}
}
},
"MessageReaction": {
"description": "Message reaction object",
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/MessageReactionTypes",
"description": "Message reaction type"
}
}
},
"SuggestedActions": {
"description": "SuggestedActions that can be performed",
"type": "object",
"properties": {
"to": {
"description": "Ids of the recipients that the actions should be shown to. These Ids are relative to the channelId and a subset of all recipients of the activity",
"type": "array",
"items": {
"type": "string"
}
},
"actions": {
"description": "Actions that can be shown to the user",
"type": "array",
"items": {
"$ref": "#/definitions/CardAction"
}
}
}
},
"Attachment": {
"description": "An attachment within an activity",
"type": "object",
"properties": {
"contentType": {
"description": "mimetype/Contenttype for the file",
"type": "string"
},
"contentUrl": {
"description": "Content Url",
"type": "string"
},
"content": {
"description": "Embedded content",
"type": "object"
},
"name": {
"description": "(OPTIONAL) The name of the attachment",
"type": "string"
},
"thumbnailUrl": {
"description": "(OPTIONAL) Thumbnail associated with attachment",
"type": "string"
}
}
},
"Entity": {
"description": "Metadata object pertaining to an activity",
"type": "object",
"properties": {
"type": {
"description": "Type of this entity (RFC 3987 IRI)",
"type": "string"
}
}
},
"ConversationReference": {
"description": "An object relating to a particular point in a conversation",
"type": "object",
"properties": {
"activityId": {
"description": "(Optional) ID of the activity to refer to",
"type": "string"
},
"user": {
"$ref": "#/definitions/ChannelAccount",
"description": "(Optional) User participating in this conversation"
},
"bot": {
"$ref": "#/definitions/ChannelAccount",
"description": "Bot participating in this conversation"
},
"conversation": {
"$ref": "#/definitions/ConversationAccount",
"description": "Conversation reference"
},
"channelId": {
"description": "Channel ID",
"type": "string"
},
"serviceUrl": {
"description": "Service endpoint where operations concerning the referenced conversation may be performed",
"type": "string"
}
}
},
"TextHighlight": {
"description": "Refers to a substring of content within another field",
"type": "object",
"properties": {
"text": {
"description": "Defines the snippet of text to highlight",
"type": "string"
},
"occurrence": {
"format": "int32",
"description": "Occurrence of the text field within the referenced text, if multiple exist.",
"type": "integer"
}
}
},
"SemanticAction": {
"description": "Represents a reference to a programmatic action",
"type": "object",
"properties": {
"state": {
"$ref": "#/definitions/SemanticActionStates",
"description": "State of this action. Allowed values: `start`, `continue`, `done`"
},
"id": {
"description": "ID of this action",
"type": "string"
},
"entities": {
"description": "Entities associated with this action",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Entity"
}
}
}
},
"CardAction": {
"description": "A clickable action",
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/ActionTypes",
"description": "The type of action implemented by this button"
},
"title": {
"description": "Text description which appears on the button",
"type": "string"
},
"image": {
"description": "Image URL which will appear on the button, next to text label",
"type": "string"
},
"text": {
"description": "Text for this action",
"type": "string"
},
"displayText": {
"description": "(Optional) text to display in the chat feed if the button is clicked",
"type": "string"
},
"value": {
"description": "Supplementary parameter for action. Content of this property depends on the ActionType",
"type": "object"
},
"channelData": {
"description": "Channel-specific data associated with this action",
"type": "object"
}
}
},
"ConversationResourceResponse": {
"description": "A response containing a resource",
"type": "object",
"properties": {
"activityId": {
"description": "ID of the Activity (if sent)",
"type": "string"
},
"serviceUrl": {
"description": "Service endpoint where operations concerning the conversation may be performed",
"type": "string"
},
"id": {
"description": "Id of the resource",
"type": "string"
}
}
},
"ConversationsResult": {
"description": "Conversations result",
"type": "object",
"properties": {
"continuationToken": {
"description": "Paging token",
"type": "string"
},
"conversations": {
"description": "List of conversations",
"type": "array",
"items": {
"$ref": "#/definitions/ConversationMembers"
}
}
}
},
"ConversationMembers": {
"description": "Conversation and its members",
"type": "object",
"properties": {
"id": {
"description": "Conversation ID",
"type": "string"
},
"members": {
"description": "List of members in this conversation",
"type": "array",
"items": {
"$ref": "#/definitions/ChannelAccount"
}
}
}
},
"ResourceResponse": {
"description": "A response containing a resource ID",
"type": "object",
"properties": {
"id": {
"description": "Id of the resource",
"type": "string"
}
}
},
"Transcript": {
"description": "Transcript",
"type": "object",
"properties": {
"activities": {
"description": "A collection of Activities that conforms to the Transcript schema.",
"type": "array",
"items": {
"$ref": "#/definitions/Activity"
}
}
}
},
"PagedMembersResult": {
"description": "Page of members.",
"type": "object",
"properties": {
"continuationToken": {
"description": "Paging token",
"type": "string"
},
"members": {
"description": "The Channel Accounts.",
"type": "array",
"items": {
"$ref": "#/definitions/ChannelAccount"
}
}
}
},
"AttachmentData": {
"description": "Attachment data",
"type": "object",
"properties": {
"type": {
"description": "Content-Type of the attachment",
"type": "string"
},
"name": {
"description": "Name of the attachment",
"type": "string"
},
"originalBase64": {
"format": "byte",
"description": "Attachment content",
"type": "string"
},
"thumbnailBase64": {
"format": "byte",
"description": "Attachment thumbnail",
"type": "string"
}
}
},
"HeroCard": {
"description": "A Hero card (card with a single, large image)",
"type": "object",
"properties": {
"title": {
"description": "Title of the card",
"type": "string"
},
"subtitle": {
"description": "Subtitle of the card",
"type": "string"
},
"text": {
"description": "Text for the card",
"type": "string"
},
"images": {
"description": "Array of images for the card",
"type": "array",
"items": {
"$ref": "#/definitions/CardImage"
}
},
"buttons": {
"description": "Set of actions applicable to the current card",
"type": "array",
"items": {
"$ref": "#/definitions/CardAction"
}
},
"tap": {
"$ref": "#/definitions/CardAction",
"description": "This action will be activated when user taps on the card itself"
}
}
},
"CardImage": {
"description": "An image on a card",
"type": "object",
"properties": {
"url": {
"description": "URL thumbnail image for major content property",
"type": "string"
},
"alt": {
"description": "Image description intended for screen readers",
"type": "string"
},
"tap": {
"$ref": "#/definitions/CardAction",
"description": "Action assigned to specific Attachment"
}
}
},
"AnimationCard": {
"description": "An animation card (Ex: gif or short video clip)",
"type": "object",
"properties": {
"title": {
"description": "Title of this card",
"type": "string"
},
"subtitle": {
"description": "Subtitle of this card",
"type": "string"
},
"text": {
"description": "Text of this card",
"type": "string"
},
"image": {
"$ref": "#/definitions/ThumbnailUrl",
"description": "Thumbnail placeholder"
},
"media": {
"description": "Media URLs for this card. When this field contains more than one URL, each URL is an alternative format of the same content.",
"type": "array",
"items": {
"$ref": "#/definitions/MediaUrl"
}
},
"buttons": {
"description": "Actions on this card",
"type": "array",
"items": {
"$ref": "#/definitions/CardAction"
}
},
"shareable": {
"description": "This content may be shared with others (default:true)",
"type": "boolean"
},
"autoloop": {
"description": "Should the client loop playback at end of content (default:true)",
"type": "boolean"
},
"autostart": {
"description": "Should the client automatically start playback of media in this card (default:true)",
"type": "boolean"
},
"aspect": {
"description": "Aspect ratio of thumbnail/media placeholder. Allowed values are \"16:9\" and \"4:3\"",
"type": "string"
},
"duration": {
"description": "Describes the length of the media content without requiring a receiver to open the content. Formatted as an ISO 8601 Duration field.",
"type": "string"
},
"value": {
"description": "Supplementary parameter for this card",
"type": "object"
}
}
},
"ThumbnailUrl": {
"description": "Thumbnail URL",
"type": "object",
"properties": {
"url": {
"description": "URL pointing to the thumbnail to use for media content",
"type": "string"
},
"alt": {
"description": "HTML alt text to include on this thumbnail image",
"type": "string"
}
}
},
"MediaUrl": {
"description": "Media URL",
"type": "object",
"properties": {
"url": {
"description": "Url for the media",
"type": "string"
},
"profile": {
"description": "Optional profile hint to the client to differentiate multiple MediaUrl objects from each other",
"type": "string"
}
}
},
"AudioCard": {
"description": "Audio card",
"type": "object",
"properties": {
"title": {
"description": "Title of this card",
"type": "string"
},
"subtitle": {
"description": "Subtitle of this card",
"type": "string"
},
"text": {
"description": "Text of this card",
"type": "string"
},
"image": {
"$ref": "#/definitions/ThumbnailUrl",
"description": "Thumbnail placeholder"
},
"media": {
"description": "Media URLs for this card. When this field contains more than one URL, each URL is an alternative format of the same content.",
"type": "array",
"items": {
"$ref": "#/definitions/MediaUrl"
}
},
"buttons": {
"description": "Actions on this card",
"type": "array",
"items": {
"$ref": "#/definitions/CardAction"
}
},
"shareable": {
"description": "This content may be shared with others (default:true)",
"type": "boolean"
},
"autoloop": {
"description": "Should the client loop playback at end of content (default:true)",
"type": "boolean"
},
"autostart": {
"description": "Should the client automatically start playback of media in this card (default:true)",
"type": "boolean"
},
"aspect": {
"description": "Aspect ratio of thumbnail/media placeholder. Allowed values are \"16:9\" and \"4:3\"",
"type": "string"
},
"duration": {
"description": "Describes the length of the media content without requiring a receiver to open the content. Formatted as an ISO 8601 Duration field.",
"type": "string"
},
"value": {
"description": "Supplementary parameter for this card",
"type": "object"
}
}
},
"BasicCard": {
"description": "A basic card",
"type": "object",
"properties": {
"title": {
"description": "Title of the card",
"type": "string"
},
"subtitle": {
"description": "Subtitle of the card",
"type": "string"
},
"text": {
"description": "Text for the card",
"type": "string"
},
"images": {
"description": "Array of images for the card",
"type": "array",
"items": {
"$ref": "#/definitions/CardImage"
}
},
"buttons": {
"description": "Set of actions applicable to the current card",
"type": "array",
"items": {
"$ref": "#/definitions/CardAction"
}
},
"tap": {
"$ref": "#/definitions/CardAction",
"description": "This action will be activated when user taps on the card itself"
}
}
},
"MediaCard": {
"description": "Media card",
"type": "object",
"properties": {
"title": {
"description": "Title of this card",
"type": "string"
},
"subtitle": {
"description": "Subtitle of this card",
"type": "string"
},
"text": {
"description": "Text of this card",
"type": "string"
},
"image": {
"$ref": "#/definitions/ThumbnailUrl",
"description": "Thumbnail placeholder"
},
"media": {
"description": "Media URLs for this card. When this field contains more than one URL, each URL is an alternative format of the same content.",
"type": "array",
"items": {
"$ref": "#/definitions/MediaUrl"
}
},
"buttons": {
"description": "Actions on this card",
"type": "array",
"items": {
"$ref": "#/definitions/CardAction"
}
},
"shareable": {
"description": "This content may be shared with others (default:true)",
"type": "boolean"
},
"autoloop": {
"description": "Should the client loop playback at end of content (default:true)",
"type": "boolean"
},
"autostart": {
"description": "Should the client automatically start playback of media in this card (default:true)",
"type": "boolean"
},
"aspect": {
"description": "Aspect ratio of thumbnail/media placeholder. Allowed values are \"16:9\" and \"4:3\"",
"type": "string"
},
"duration": {
"description": "Describes the length of the media content without requiring a receiver to open the content. Formatted as an ISO 8601 Duration field.",
"type": "string"
},
"value": {
"description": "Supplementary parameter for this card",
"type": "object"
}
}
},
"ReceiptCard": {
"description": "A receipt card",
"type": "object",
"properties": {
"title": {
"description": "Title of the card",
"type": "string"
},
"facts": {
"description": "Array of Fact objects",
"type": "array",
"items": {
"$ref": "#/definitions/Fact"
}
},
"items": {
"description": "Array of Receipt Items",
"type": "array",
"items": {
"$ref": "#/definitions/ReceiptItem"
}
},
"tap": {
"$ref": "#/definitions/CardAction",
"description": "This action will be activated when user taps on the card"
},
"total": {
"description": "Total amount of money paid (or to be paid)",
"type": "string"
},
"tax": {
"description": "Total amount of tax paid (or to be paid)",
"type": "string"
},
"vat": {
"description": "Total amount of VAT paid (or to be paid)",
"type": "string"
},
"buttons": {
"description": "Set of actions applicable to the current card",
"type": "array",
"items": {
"$ref": "#/definitions/CardAction"
}
}
}
},
"Fact": {
"description": "Set of key-value pairs. Advantage of this section is that key and value properties will be \r\nrendered with default style information with some delimiter between them. So there is no need for developer to specify style information.",
"type": "object",
"properties": {
"key": {
"description": "The key for this Fact",
"type": "string"
},
"value": {
"description": "The value for this Fact",
"type": "string"
}
}
},
"ReceiptItem": {
"description": "An item on a receipt card",
"type": "object",
"properties": {
"title": {
"description": "Title of the Card",
"type": "string"
},
"subtitle": {
"description": "Subtitle appears just below Title field, differs from Title in font styling only",
"type": "string"
},
"text": {
"description": "Text field appears just below subtitle, differs from Subtitle in font styling only",
"type": "string"
},
"image": {
"$ref": "#/definitions/CardImage",
"description": "Image"
},
"price": {
"description": "Amount with currency",
"type": "string"
},
"quantity": {
"description": "Number of items of given kind",
"type": "string"
},
"tap": {
"$ref": "#/definitions/CardAction",
"description": "This action will be activated when user taps on the Item bubble."
}
}
},
"SigninCard": {
"description": "A card representing a request to sign in",
"type": "object",
"properties": {
"text": {
"description": "Text for signin request",
"type": "string"
},
"buttons": {
"description": "Action to use to perform signin",
"type": "array",
"items": {
"$ref": "#/definitions/CardAction"
}
}
}
},
"OAuthCard": {
"description": "A card representing a request to perform a sign in via OAuth",
"type": "object",
"properties": {
"text": {
"description": "Text for signin request",
"type": "string"
},
"connectionName": {
"description": "The name of the registered connection",
"type": "string"
},
"buttons": {
"description": "Action to use to perform signin",
"type": "array",
"items": {
"$ref": "#/definitions/CardAction"
}
}
}
},
"ThumbnailCard": {
"description": "A thumbnail card (card with a single, small thumbnail image)",
"type": "object",
"properties": {
"title": {
"description": "Title of the card",
"type": "string"
},
"subtitle": {
"description": "Subtitle of the card",
"type": "string"
},
"text": {
"description": "Text for the card",
"type": "string"
},
"images": {
"description": "Array of images for the card",
"type": "array",
"items": {
"$ref": "#/definitions/CardImage"
}
},
"buttons": {
"description": "Set of actions applicable to the current card",
"type": "array",
"items": {
"$ref": "#/definitions/CardAction"
}
},
"tap": {
"$ref": "#/definitions/CardAction",
"description": "This action will be activated when user taps on the card itself"
}
}
},
"VideoCard": {
"description": "Video card",
"type": "object",
"properties": {
"title": {
"description": "Title of this card",
"type": "string"
},
"subtitle": {
"description": "Subtitle of this card",
"type": "string"
},
"text": {
"description": "Text of this card",
"type": "string"
},
"image": {
"$ref": "#/definitions/ThumbnailUrl",
"description": "Thumbnail placeholder"
},
"media": {
"description": "Media URLs for this card. When this field contains more than one URL, each URL is an alternative format of the same content.",
"type": "array",
"items": {
"$ref": "#/definitions/MediaUrl"
}
},
"buttons": {
"description": "Actions on this card",
"type": "array",
"items": {
"$ref": "#/definitions/CardAction"
}
},
"shareable": {
"description": "This content may be shared with others (default:true)",
"type": "boolean"
},
"autoloop": {
"description": "Should the client loop playback at end of content (default:true)",
"type": "boolean"
},
"autostart": {
"description": "Should the client automatically start playback of media in this card (default:true)",
"type": "boolean"
},
"aspect": {
"description": "Aspect ratio of thumbnail/media placeholder. Allowed values are \"16:9\" and \"4:3\"",
"type": "string"
},
"duration": {
"description": "Describes the length of the media content without requiring a receiver to open the content. Formatted as an ISO 8601 Duration field.",
"type": "string"
},
"value": {
"description": "Supplementary parameter for this card",
"type": "object"
}
}
},
"GeoCoordinates": {
"description": "GeoCoordinates (entity type: \"https://schema.org/GeoCoordinates\")",
"type": "object",
"properties": {
"elevation": {
"format": "double",
"description": "Elevation of the location [WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)",
"type": "number"
},
"latitude": {
"format": "double",
"description": "Latitude of the location [WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)",
"type": "number"
},
"longitude": {
"format": "double",
"description": "Longitude of the location [WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)",
"type": "number"
},
"type": {
"description": "The type of the thing",
"type": "string"
},
"name": {
"description": "The name of the thing",
"type": "string"
}
}
},
"Mention": {
"description": "Mention information (entity type: \"mention\")",
"type": "object",
"properties": {
"mentioned": {
"$ref": "#/definitions/ChannelAccount",
"description": "The mentioned user"
},
"text": {
"description": "Sub Text which represents the mention (can be null or empty)",
"type": "string"
},
"type": {
"description": "Type of this entity (RFC 3987 IRI)",
"type": "string"
}
}
},
"Place": {
"description": "Place (entity type: \"https://schema.org/Place\")",
"type": "object",
"properties": {
"address": {
"description": "Address of the place (may be `string` or complex object of type `PostalAddress`)",
"type": "object"
},
"geo": {
"description": "Geo coordinates of the place (may be complex object of type `GeoCoordinates` or `GeoShape`)",
"type": "object"
},
"hasMap": {
"description": "Map to the place (may be `string` (URL) or complex object of type `Map`)",
"type": "object"
},
"type": {
"description": "The type of the thing",
"type": "string"
},
"name": {
"description": "The name of the thing",
"type": "string"
}
}
},
"Thing": {
"description": "Thing (entity type: \"https://schema.org/Thing\")",
"type": "object",
"properties": {
"type": {
"description": "The type of the thing",
"type": "string"
},
"name": {
"description": "The name of the thing",
"type": "string"
}
}
},
"MediaEventValue": {
"description": "Supplementary parameter for media events",
"type": "object",
"properties": {
"cardValue": {
"description": "Callback parameter specified in the Value field of the MediaCard that originated this event",
"type": "object"
}
}
},
"TokenRequest": {
"description": "A request to receive a user token",
"type": "object",
"properties": {
"provider": {
"description": "The provider to request a user token from",
"type": "string"
},
"settings": {
"description": "A collection of settings for the specific provider for this request",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"TokenResponse": {
"description": "A response that includes a user token",
"type": "object",
"properties": {
"channelId": {
"description": "The channelId of the TokenResponse",
"type": "string"
},
"connectionName": {
"description": "The connection name",
"type": "string"
},
"token": {
"description": "The user token",
"type": "string"
},
"expiration": {
"description": "Expiration for the token, in ISO 8601 format (e.g. \"2007-04-05T14:30Z\")",
"type": "string"
}
}
},
"ActivityTypes": {
"description": "Types of Activities",
"enum": [
"message",
"contactRelationUpdate",
"conversationUpdate",
"typing",
"endOfConversation",
"event",
"invoke",
"deleteUserData",
"messageUpdate",
"messageDelete",
"installationUpdate",
"messageReaction",
"suggestion",
"trace",
"handoff"
],
"type": "string",
"properties": {},
"x-ms-enum": {
"name": "ActivityTypes",
"modelAsString": true
}
},
"AttachmentLayoutTypes": {
"description": "Attachment layout types",
"enum": [
"list",
"carousel"
],
"type": "string",
"properties": {},
"x-ms-enum": {
"name": "AttachmentLayoutTypes",
"modelAsString": true
}
},
"SemanticActionStates": {
"description": "Indicates whether the semantic action is starting, continuing, or done",
"enum": [
"start",
"continue",
"done"
],
"type": "string",
"properties": {},
"x-ms-enum": {
"name": "SemanticActionStates",
"modelAsString": true
}
},
"ActionTypes": {
"description": "Defines action types for clickable buttons.",
"enum": [
"openUrl",
"imBack",
"postBack",
"playAudio",
"playVideo",
"showImage",
"downloadFile",
"signin",
"call",
"payment",
"messageBack"
],
"type": "string",
"properties": {},
"x-ms-enum": {
"name": "ActionTypes",
"modelAsString": true
}
},
"ContactRelationUpdateActionTypes": {
"description": "Action types valid for ContactRelationUpdate activities",
"enum": [
"add",
"remove"
],
"type": "string",
"properties": {},
"x-ms-enum": {
"name": "ContactRelationUpdateActionTypes",
"modelAsString": true
}
},
"InstallationUpdateActionTypes": {
"description": "Action types valid for InstallationUpdate activities",
"enum": [
"add",
"remove"
],
"type": "string",
"properties": {},
"x-ms-enum": {
"name": "InstallationUpdateActionTypes",
"modelAsString": true
}
},
"MessageReactionTypes": {
"description": "Message reaction types",
"enum": [
"like",
"plusOne"
],
"type": "string",
"properties": {},
"x-ms-enum": {
"name": "MessageReactionTypes",
"modelAsString": true
}
},
"TextFormatTypes": {
"description": "Text format types",
"enum": [
"markdown",
"plain",
"xml"
],
"type": "string",
"properties": {},
"x-ms-enum": {
"name": "TextFormatTypes",
"modelAsString": true
}
},
"InputHints": {
"description": "Indicates whether the bot is accepting, expecting, or ignoring input",
"enum": [
"acceptingInput",
"ignoringInput",
"expectingInput"
],
"type": "string",
"properties": {},
"x-ms-enum": {
"name": "InputHints",
"modelAsString": true
}
},
"EndOfConversationCodes": {
"description": "Codes indicating why a conversation has ended",
"enum": [
"unknown",
"completedSuccessfully",
"userCancelled",
"botTimedOut",
"botIssuedInvalidMessage",
"channelFailed"
],
"type": "string",
"properties": {},
"x-ms-enum": {
"name": "EndOfConversationCodes",
"modelAsString": true
}
},
"ActivityImportance": {
"description": "Defines the importance of an Activity",
"enum": [
"low",
"normal",
"high"
],
"type": "string",
"properties": {},
"x-ms-enum": {
"name": "ActivityImportance",
"modelAsString": true
}
},
"RoleTypes": {
"description": "Role of the entity behind the account (Example: User, Bot, Skill, etc.)",
"enum": [
"user",
"bot",
"skill"
],
"type": "string",
"properties": {},
"x-ms-enum": {
"name": "RoleTypes",
"modelAsString": true
}
},
"DeliveryModes": {
"description": "Values for deliveryMode field",
"enum": [
"normal",
"notification",
"expectReplies"
],
"type": "string",
"properties": {},
"x-ms-enum": {
"name": "DeliveryModes",
"modelAsString": true
}
},
"MicrosoftPayMethodData": {
"deprecated": true,
"description": "Deprecated. Bot Framework no longer supports payments.",
"type": "object",
"properties": {
"merchantId": {
"description": "Microsoft Pay Merchant ID",
"type": "string"
},
"supportedNetworks": {
"deprecated": true,
"description": "Deprecated. Bot Framework no longer supports payments.",
"type": "array",
"items": {
"type": "string"
}
},
"supportedTypes": {
"deprecated": true,
"description": "Deprecated. Bot Framework no longer supports payments.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"PaymentAddress": {
"deprecated": true,
"description": "Deprecated. Bot Framework no longer supports payments.",
"type": "object",
"properties": {
"country": {
"description": "This is the CLDR (Common Locale Data Repository) region code. For example, US, GB, CN, or JP",
"type": "string"
},
"addressLine": {
"description": "This is the most specific part of the address. It can include, for example, a street name, a house number, apartment number, a rural delivery route, descriptive instructions, or a post office box number.",
"type": "array",
"items": {
"type": "string"
}
},
"region": {
"description": "This is the top level administrative subdivision of the country. For example, this can be a state, a province, an oblast, or a prefecture.",
"type": "string"
},
"city": {
"description": "This is the city/town portion of the address.",
"type": "string"
},
"dependentLocality": {
"description": "This is the dependent locality or sublocality within a city. For example, used for neighborhoods, boroughs, districts, or UK dependent localities.",
"type": "string"
},
"postalCode": {
"description": "This is the postal code or ZIP code, also known as PIN code in India.",
"type": "string"
},
"sortingCode": {
"description": "This is the sorting code as used in, for example, France.",
"type": "string"
},
"languageCode": {
"description": "This is the BCP-47 language code for the address. It's used to determine the field separators and the order of fields when formatting the address for display.",
"type": "string"
},
"organization": {
"description": "This is the organization, firm, company, or institution at this address.",
"type": "string"
},
"recipient": {
"description": "This is the name of the recipient or contact person.",
"type": "string"
},
"phone": {
"description": "This is the phone number of the recipient or contact person.",
"type": "string"
}
}
},
"PaymentCurrencyAmount": {
"deprecated": true,
"description": "Deprecated. Bot Framework no longer supports payments.",
"type": "object",
"properties": {
"currency": {
"description": "A currency identifier",
"type": "string"
},
"value": {
"description": "Decimal monetary value",
"type": "string"
},
"currencySystem": {
"description": "Currency system",
"type": "string"
}
}
},
"PaymentDetails": {
"deprecated": true,
"description": "Deprecated. Bot Framework no longer supports payments.",
"type": "object",
"properties": {
"total": {
"$ref": "#/definitions/PaymentItem",
"description": "Contains the total amount of the payment request"
},
"displayItems": {
"description": "Contains line items for the payment request that the user agent may display",
"type": "array",
"items": {
"$ref": "#/definitions/PaymentItem"
}
},
"shippingOptions": {
"description": "A sequence containing the different shipping options for the user to choose from",
"type": "array",
"items": {
"$ref": "#/definitions/PaymentShippingOption"
}
},
"modifiers": {
"description": "Contains modifiers for particular payment method identifiers",
"type": "array",
"items": {
"$ref": "#/definitions/PaymentDetailsModifier"
}
},
"error": {
"description": "Error description",
"type": "string"
}
}
},
"PaymentItem": {
"deprecated": true,
"description": "Deprecated. Bot Framework no longer supports payments.",
"type": "object",
"properties": {
"label": {
"description": "Human-readable description of the item",
"type": "string"
},
"amount": {
"$ref": "#/definitions/PaymentCurrencyAmount",
"description": "Monetary amount for the item"
},
"pending": {
"description": "When set to true this flag means that the amount field is not final.",
"type": "boolean"
}
}
},
"PaymentShippingOption": {
"deprecated": true,
"description": "Deprecated. Bot Framework no longer supports payments.",
"type": "object",
"properties": {
"id": {
"description": "String identifier used to reference this PaymentShippingOption",
"type": "string"
},
"label": {
"description": "Human-readable description of the item",
"type": "string"
},
"amount": {
"$ref": "#/definitions/PaymentCurrencyAmount",
"description": "Contains the monetary amount for the item"
},
"selected": {
"description": "Indicates whether this is the default selected PaymentShippingOption",
"type": "boolean"
}
}
},
"PaymentDetailsModifier": {
"deprecated": true,
"description": "Deprecated. Bot Framework no longer supports payments.",
"type": "object",
"properties": {
"supportedMethods": {
"description": "Contains a sequence of payment method identifiers",
"type": "array",
"items": {
"type": "string"
}
},
"total": {
"$ref": "#/definitions/PaymentItem",
"description": "This value overrides the total field in the PaymentDetails dictionary for the payment method identifiers in the supportedMethods field"
},
"additionalDisplayItems": {
"description": "Provides additional display items that are appended to the displayItems field in the PaymentDetails dictionary for the payment method identifiers in the supportedMethods field",
"type": "array",
"items": {
"$ref": "#/definitions/PaymentItem"
}
},
"data": {
"description": "A JSON-serializable object that provides optional information that might be needed by the supported payment methods",
"type": "object"
}
}
},
"PaymentMethodData": {
"deprecated": true,
"description": "Deprecated. Bot Framework no longer supports payments.",
"type": "object",
"properties": {
"supportedMethods": {
"description": "Required sequence of strings containing payment method identifiers for payment methods that the merchant web site accepts",
"type": "array",
"items": {
"type": "string"
}
},
"data": {
"description": "A JSON-serializable object that provides optional information that might be needed by the supported payment methods",
"type": "object"
}
}
},
"PaymentOptions": {
"deprecated": true,
"description": "Deprecated. Bot Framework no longer supports payments.",
"type": "object",
"properties": {
"requestPayerName": {
"description": "Indicates whether the user agent should collect and return the payer's name as part of the payment request",
"type": "boolean"
},
"requestPayerEmail": {
"description": "Indicates whether the user agent should collect and return the payer's email address as part of the payment request",
"type": "boolean"
},
"requestPayerPhone": {
"description": "Indicates whether the user agent should collect and return the payer's phone number as part of the payment request",
"type": "boolean"
},
"requestShipping": {
"description": "Indicates whether the user agent should collect and return a shipping address as part of the payment request",
"type": "boolean"
},
"shippingType": {
"description": "If requestShipping is set to true, then the shippingType field may be used to influence the way the user agent presents the user interface for gathering the shipping address",
"type": "string"
}
}
},
"PaymentRequest": {
"deprecated": true,
"description": "Deprecated. Bot Framework no longer supports payments.",
"type": "object",
"properties": {
"id": {
"description": "ID of this payment request",
"type": "string"
},
"methodData": {
"description": "Allowed payment methods for this request",
"type": "array",
"items": {
"$ref": "#/definitions/PaymentMethodData"
}
},
"details": {
"$ref": "#/definitions/PaymentDetails",
"description": "Details for this request"
},
"options": {
"$ref": "#/definitions/PaymentOptions",
"description": "Provides information about the options desired for the payment request"
},
"expires": {
"description": "Expiration for this request, in ISO 8601 duration format (e.g., 'P1D')",
"type": "string"
}
}
},
"PaymentRequestComplete": {
"deprecated": true,
"description": "Deprecated. Bot Framework no longer supports payments.",
"type": "object",
"properties": {
"id": {
"description": "Payment request ID",
"type": "string"
},
"paymentRequest": {
"$ref": "#/definitions/PaymentRequest",
"description": "Initial payment request"
},
"paymentResponse": {
"$ref": "#/definitions/PaymentResponse",
"description": "Corresponding payment response"
}
}
},
"PaymentResponse": {
"deprecated": true,
"description": "Deprecated. Bot Framework no longer supports payments.",
"type": "object",
"properties": {
"methodName": {
"description": "The payment method identifier for the payment method that the user selected to fulfil the transaction",
"type": "string"
},
"details": {
"description": "A JSON-serializable object that provides a payment method specific message used by the merchant to process the transaction and determine successful fund transfer",
"type": "object"
},
"shippingAddress": {
"$ref": "#/definitions/PaymentAddress",
"description": "If the requestShipping flag was set to true in the PaymentOptions passed to the PaymentRequest constructor, then shippingAddress will be the full and final shipping address chosen by the user"
},
"shippingOption": {
"description": "If the requestShipping flag was set to true in the PaymentOptions passed to the PaymentRequest constructor, then shippingOption will be the id attribute of the selected shipping option",
"type": "string"
},
"payerEmail": {
"description": "If the requestPayerEmail flag was set to true in the PaymentOptions passed to the PaymentRequest constructor, then payerEmail will be the email address chosen by the user",
"type": "string"
},
"payerPhone": {
"description": "If the requestPayerPhone flag was set to true in the PaymentOptions passed to the PaymentRequest constructor, then payerPhone will be the phone number chosen by the user",
"type": "string"
}
}
},
"PaymentRequestCompleteResult": {
"deprecated": true,
"description": "Deprecated. Bot Framework no longer supports payments.",
"type": "object",
"properties": {
"result": {
"description": "Result of the payment request completion",
"type": "string"
}
}
},
"PaymentRequestUpdate": {
"deprecated": true,
"description": "Deprecated. Bot Framework no longer supports payments.",
"type": "object",
"properties": {
"id": {
"description": "ID for the payment request to update",
"type": "string"
},
"details": {
"$ref": "#/definitions/PaymentDetails",
"description": "Update payment details"
},
"shippingAddress": {
"$ref": "#/definitions/PaymentAddress",
"description": "Updated shipping address"
},
"shippingOption": {
"description": "Updated shipping options",
"type": "string"
}
}
},
"PaymentRequestUpdateResult": {
"deprecated": true,
"description": "Deprecated. Bot Framework no longer supports payments.",
"type": "object",
"properties": {
"details": {
"$ref": "#/definitions/PaymentDetails",
"description": "Update payment details"
}
}
}
},
"securityDefinitions": {
"bearer_auth": {
"type": "apiKey",
"description": "Access token to authenticate calls to the Bot Connector Service.",
"name": "Authorization",
"in": "header"
}
}
} |