{"_id":"5845a4a99f6fbb1b00430802","version":{"_id":"5845a4a89f6fbb1b004307b7","project":"54d3007669578e0d002730c9","__v":2,"createdAt":"2016-12-05T17:32:24.708Z","releaseDate":"2016-12-05T17:32:24.708Z","categories":["5845a4a89f6fbb1b004307b8","5845a4a89f6fbb1b004307b9","5845a4a89f6fbb1b004307ba","5845a4a89f6fbb1b004307bb","5845a4a89f6fbb1b004307bc","5845a4a89f6fbb1b004307bd","5845a4a89f6fbb1b004307be","5845a4a89f6fbb1b004307bf","5845a4a89f6fbb1b004307c0","592deb23644f060f008e5aa6"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"25.0.0","version":"25"},"__v":0,"parentDoc":null,"project":"54d3007669578e0d002730c9","category":{"_id":"5845a4a89f6fbb1b004307bd","project":"54d3007669578e0d002730c9","__v":0,"version":"5845a4a89f6fbb1b004307b7","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-07-08T18:48:02.369Z","from_sync":false,"order":5,"slug":"integrations","title":"Integrations"},"user":"55a04a395730f40d001104d2","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-10T16:33:07.744Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":8,"body":"* [Overview](#overview)\n* [Enabling Skype Integration in API.AI](#enabling-skype-integration-in-apiai)\n* [Creating a Bot in Skype](#creating-a-bot-in-skype)\n* [Configuring API.AI Skype Integration](#configuring-apiai-skype-integration)\n* [Test Your Bot](#test-your-bot)\n* [Hosting Skype Bot with Heroku](#hosting-skype-bot-with-heroku)\n * [Creating Your Skype Bot](#section-creating-your-skype-bot)\n * [Enabling Skype Integration in API.AI](#section-enabling-skype-integration-in-api-ai)\n * [Configuring Heroku App](#section-configuring-heroku-app)\n* [Hosting Bots on Your Server](#hosting-bots-on-your-server)\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Overview\"\n}\n[/block]\n**API.AI Skype Integration** allows you to easily create <a href=\"https://dev.botframework.com/bots/\" target=\"_blank\">Skype bots</a> with natural language understanding based on the API.AI technology.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Enabling Skype Integration in API.AI\"\n}\n[/block]\n<a href=\"https://console.api.ai/api-client/#/newAgent\" target=\"_blank\">Create an API.AI agent</a> with the help of the <a href=\"https://docs.api.ai/docs/key-concepts\" target=\"_blank\">API.AI NLU technology tools</a>.\n\nGo to 'Integrations' from the left side menu and enable Skype integration.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/8745651-Skype-Apiai-enable.png\",\n        \"Skype-Apiai-enable.png\",\n        2036,\n        856,\n        \"#fafbfb\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\nCopy the Request URL to the clipboard.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9f1ac51-Skype-copy-Request-URL.png\",\n        \"Skype-copy-Request-URL.png\",\n        2184,\n        1380,\n        \"#4a5261\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Creating a Bot in Skype\"\n}\n[/block]\nLog in to the Microsoft Dev Center and register a new bot: <a href=\"https://dev.botframework.com/bots/new\" target=\"_blank\">https://dev.botframework.com/bots/new</a>\n\nProvide a name, bot handle, and description in the Bot profile section:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/5dfb418-Skype_register-bot-profile.png\",\n        \"Skype_register-bot-profile.png\",\n        1700,\n        1478,\n        \"#efeef4\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\nIn the Configuration section, paste the Request URL you’ve copied in the API.AI Skype integration settings to the 'Messaging endpoint' field.\n\nClick the 'Create Microsoft App ID and password' button.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2b0b5ac-Skype_Configuration_URL.png\",\n        \"Skype_Configuration_URL.png\",\n        1638,\n        702,\n        \"#2a868a\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\nOn the new page that will open, click the 'Generate a password to continue' button:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/5410f03-Skype_Generate-AppId-and-Password.png\",\n        \"Skype_Generate-AppId-and-Password.png\",\n        2118,\n        792,\n        \"#e6e6e5\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\nA pop-up with a new password will appear:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9849aab-Skype_password.png\",\n        \"Skype_password.png\",\n        2008,\n        980,\n        \"#818181\"\n      ]\n    }\n  ]\n}\n[/block]\nGo back to the Skype bot settings and fill in the information in the Publisher profile section and click 'Register'. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Configuring API.AI Skype Integration\"\n}\n[/block]\nCopy the password and App ID from your Skype bot settings and insert them to the respective fields in the API.AI Skype integration settings. Then, click 'Start'.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/678cc00-Skype-configuring-in-Api-ai.png\",\n        \"Skype-configuring-in-Api-ai.png\",\n        2128,\n        1382,\n        \"#495261\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Test Your Bot\"\n}\n[/block]\nAfter clicking on 'Register' in your Skype bot settings, you'll see the option for adding your bot to Skype.\n\nClick 'Test' – the message \"Accepted\" should appear below the button.\n\nThen, click 'Add to Skype' in the Skype channel.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9ffb1e9-Skype-after-register.png\",\n        \"Skype-after-register.png\",\n        2538,\n        1502,\n        \"#f1f2f9\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\nThen, click 'Add to Contacts':\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/290d307-Skype-add-to-contacts.png\",\n        \"Skype-add-to-contacts.png\",\n        2444,\n        1558,\n        \"#1b85ad\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\nThe bot will appear in your list of contacts. Click 'Add contact'.\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/626abfb-Skype-add-contact.png\",\n        \"Skype-add-contact.png\",\n        1904,\n        1443,\n        \"#e7e6e5\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\nYour bot is ready for testing.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/EZth8ph9ThCtFuWdqUBI_image05.png\",\n        \"image05.png\",\n        \"1904\",\n        \"1454\",\n        \"#2f5a71\",\n        \"\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Hosting Skype Bot with Heroku\"\n}\n[/block]\nHere’s an example of how you can host and launch your Skype bot with Heroku.\n\n## Creating Your Skype Bot\n\nCreate a bot in Skype as described [here](#creating-a-bot-in-skype).\n\n## Enabling Skype Integration in API.AI\n\n<a href=\"https://console.api.ai/api-client/#/newAgent\" target=\"_blank\">Create an API.AI agent</a> with the help of the <a href=\"https://docs.api.ai/docs/key-concepts\" target=\"_blank\">API.AI NLU technology tools</a>.\n\nGo to 'Integrations' from the left side menu and enable Skype integration.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/be58004-Skype-Apiai-enable.png\",\n        \"Skype-Apiai-enable.png\",\n        2036,\n        856,\n        \"#fafbfb\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\nThen, click on the ‘Deploy to Heroku’ button (you need to be logged in to your Heroku account).\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/92624d9-Skype-Deploy-to-Heroku.png\",\n        \"Skype-Deploy-to-Heroku.png\",\n        2256,\n        1396,\n        \"#495161\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\n## Configuring Heroku App\n\nOn the Heroku app settings page, fill in the following fields:\n\n**App Name** – choose a name for your Heroku app.\n\n**APIAI_LANG** – if your agent language setting is other than English, indicate a <a href=\"https://docs.api.ai/docs/key-concepts\" target=\"_blank\">language tag</a> corresponding to your API.AI agent settings.\n\n **APP_ID** – paste the Microsoft App ID you obtained in your Skype bot settings.\n\n**APP_SECRET** – paste the Microsoft App Password you obtained in your Skype bot settings.\n\nThen, click the ‘Deploy for Free’ button and wait until “Your app was successfully deployed.” appears.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/b56ec33-SKype-Heroku-settings.png\",\n        \"SKype-Heroku-settings.png\",\n        1786,\n        1460,\n        \"#e8ecee\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\nAfter your Heroku app has been successfully deployed, you can test your Skype bot as described [here](#test-your-bot).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Hosting Bots on Your Server\"\n}\n[/block]\nYou can use our source code from <a href=\"https://github.com/api-ai/apiai-nodejs-client/tree/master/samples/skype\">github</a> to create your custom Skype bots.","excerpt":"","slug":"skype-integration","type":"basic","title":"Skype"}
* [Overview](#overview) * [Enabling Skype Integration in API.AI](#enabling-skype-integration-in-apiai) * [Creating a Bot in Skype](#creating-a-bot-in-skype) * [Configuring API.AI Skype Integration](#configuring-apiai-skype-integration) * [Test Your Bot](#test-your-bot) * [Hosting Skype Bot with Heroku](#hosting-skype-bot-with-heroku) * [Creating Your Skype Bot](#section-creating-your-skype-bot) * [Enabling Skype Integration in API.AI](#section-enabling-skype-integration-in-api-ai) * [Configuring Heroku App](#section-configuring-heroku-app) * [Hosting Bots on Your Server](#hosting-bots-on-your-server) [block:api-header] { "type": "basic", "title": "Overview" } [/block] **API.AI Skype Integration** allows you to easily create <a href="https://dev.botframework.com/bots/" target="_blank">Skype bots</a> with natural language understanding based on the API.AI technology. [block:api-header] { "type": "basic", "title": "Enabling Skype Integration in API.AI" } [/block] <a href="https://console.api.ai/api-client/#/newAgent" target="_blank">Create an API.AI agent</a> with the help of the <a href="https://docs.api.ai/docs/key-concepts" target="_blank">API.AI NLU technology tools</a>. Go to 'Integrations' from the left side menu and enable Skype integration. [block:image] { "images": [ { "image": [ "https://files.readme.io/8745651-Skype-Apiai-enable.png", "Skype-Apiai-enable.png", 2036, 856, "#fafbfb" ], "sizing": "full" } ] } [/block] Copy the Request URL to the clipboard. [block:image] { "images": [ { "image": [ "https://files.readme.io/9f1ac51-Skype-copy-Request-URL.png", "Skype-copy-Request-URL.png", 2184, 1380, "#4a5261" ], "sizing": "full" } ] } [/block] [block:api-header] { "type": "basic", "title": "Creating a Bot in Skype" } [/block] Log in to the Microsoft Dev Center and register a new bot: <a href="https://dev.botframework.com/bots/new" target="_blank">https://dev.botframework.com/bots/new</a> Provide a name, bot handle, and description in the Bot profile section: [block:image] { "images": [ { "image": [ "https://files.readme.io/5dfb418-Skype_register-bot-profile.png", "Skype_register-bot-profile.png", 1700, 1478, "#efeef4" ], "sizing": "full" } ] } [/block] In the Configuration section, paste the Request URL you’ve copied in the API.AI Skype integration settings to the 'Messaging endpoint' field. Click the 'Create Microsoft App ID and password' button. [block:image] { "images": [ { "image": [ "https://files.readme.io/2b0b5ac-Skype_Configuration_URL.png", "Skype_Configuration_URL.png", 1638, 702, "#2a868a" ], "sizing": "full" } ] } [/block] On the new page that will open, click the 'Generate a password to continue' button: [block:image] { "images": [ { "image": [ "https://files.readme.io/5410f03-Skype_Generate-AppId-and-Password.png", "Skype_Generate-AppId-and-Password.png", 2118, 792, "#e6e6e5" ], "sizing": "full" } ] } [/block] A pop-up with a new password will appear: [block:image] { "images": [ { "image": [ "https://files.readme.io/9849aab-Skype_password.png", "Skype_password.png", 2008, 980, "#818181" ] } ] } [/block] Go back to the Skype bot settings and fill in the information in the Publisher profile section and click 'Register'. [block:api-header] { "type": "basic", "title": "Configuring API.AI Skype Integration" } [/block] Copy the password and App ID from your Skype bot settings and insert them to the respective fields in the API.AI Skype integration settings. Then, click 'Start'. [block:image] { "images": [ { "image": [ "https://files.readme.io/678cc00-Skype-configuring-in-Api-ai.png", "Skype-configuring-in-Api-ai.png", 2128, 1382, "#495261" ], "sizing": "full" } ] } [/block] [block:api-header] { "type": "basic", "title": "Test Your Bot" } [/block] After clicking on 'Register' in your Skype bot settings, you'll see the option for adding your bot to Skype. Click 'Test' – the message "Accepted" should appear below the button. Then, click 'Add to Skype' in the Skype channel. [block:image] { "images": [ { "image": [ "https://files.readme.io/9ffb1e9-Skype-after-register.png", "Skype-after-register.png", 2538, 1502, "#f1f2f9" ], "sizing": "full" } ] } [/block] Then, click 'Add to Contacts': [block:image] { "images": [ { "image": [ "https://files.readme.io/290d307-Skype-add-to-contacts.png", "Skype-add-to-contacts.png", 2444, 1558, "#1b85ad" ], "sizing": "full" } ] } [/block] The bot will appear in your list of contacts. Click 'Add contact'. [block:image] { "images": [ { "image": [ "https://files.readme.io/626abfb-Skype-add-contact.png", "Skype-add-contact.png", 1904, 1443, "#e7e6e5" ], "sizing": "full" } ] } [/block] Your bot is ready for testing. [block:image] { "images": [ { "image": [ "https://files.readme.io/EZth8ph9ThCtFuWdqUBI_image05.png", "image05.png", "1904", "1454", "#2f5a71", "" ], "sizing": "full" } ] } [/block] [block:api-header] { "type": "basic", "title": "Hosting Skype Bot with Heroku" } [/block] Here’s an example of how you can host and launch your Skype bot with Heroku. ## Creating Your Skype Bot Create a bot in Skype as described [here](#creating-a-bot-in-skype). ## Enabling Skype Integration in API.AI <a href="https://console.api.ai/api-client/#/newAgent" target="_blank">Create an API.AI agent</a> with the help of the <a href="https://docs.api.ai/docs/key-concepts" target="_blank">API.AI NLU technology tools</a>. Go to 'Integrations' from the left side menu and enable Skype integration. [block:image] { "images": [ { "image": [ "https://files.readme.io/be58004-Skype-Apiai-enable.png", "Skype-Apiai-enable.png", 2036, 856, "#fafbfb" ], "sizing": "full" } ] } [/block] Then, click on the ‘Deploy to Heroku’ button (you need to be logged in to your Heroku account). [block:image] { "images": [ { "image": [ "https://files.readme.io/92624d9-Skype-Deploy-to-Heroku.png", "Skype-Deploy-to-Heroku.png", 2256, 1396, "#495161" ], "sizing": "full" } ] } [/block] ## Configuring Heroku App On the Heroku app settings page, fill in the following fields: **App Name** – choose a name for your Heroku app. **APIAI_LANG** – if your agent language setting is other than English, indicate a <a href="https://docs.api.ai/docs/key-concepts" target="_blank">language tag</a> corresponding to your API.AI agent settings. **APP_ID** – paste the Microsoft App ID you obtained in your Skype bot settings. **APP_SECRET** – paste the Microsoft App Password you obtained in your Skype bot settings. Then, click the ‘Deploy for Free’ button and wait until “Your app was successfully deployed.” appears. [block:image] { "images": [ { "image": [ "https://files.readme.io/b56ec33-SKype-Heroku-settings.png", "SKype-Heroku-settings.png", 1786, 1460, "#e8ecee" ], "sizing": "full" } ] } [/block] After your Heroku app has been successfully deployed, you can test your Skype bot as described [here](#test-your-bot). [block:api-header] { "type": "basic", "title": "Hosting Bots on Your Server" } [/block] You can use our source code from <a href="https://github.com/api-ai/apiai-nodejs-client/tree/master/samples/skype">github</a> to create your custom Skype bots.