Authenticating Microsoft Azure account to connect with Zobot

To Setup:

  1. Navigate to Settings > Bot > Zobot > Add. Give your assistant a name and choose the platform - Azure Bot Service

  1. Then choose the brand that you want to deploy the bot on and click Next.
  2. The Azure Bot Service Configuration window appears. You need to enter the Azure Channel Secret Key in the respective box and click Create. The Channel Secret key is the unique secret key assigned to the Azure bot service channel you are trying to map your Zobot with.

4. To get the Host URL and the API Key: 

  • Login to Microsoft Azure
  • Navigate to the bot service > Channels. You will see two options available to add a new site - Direct Line and Web chat.​ 

  • Add a new site and the Channel Secret Key will be generated. You can use this secret key to integrate with the Zobot.

​​Option 1: Direct Line

​​Option 2: Web Chat

Note: 

  • When Direct Line Protocol is used, you need to make sure that the protocol version that has been enabled is 3.0. Otherwise, the service will not work inside SalesIQ. 

  • Any changes that were made and redeployed inside Azure might take about 10 minutes to reflect inside SalesIQ.
  • Once the Channel Secret Key is regenerated, the bots that were configured using the old secret key will not work.

5. Then, provide a Trigger Response in the text box.​ You can use only JSON format to set up the trigger response, SalesIQ does not support the text format. The message can be a text or input/display cards, you should follow the JSON format given below to add the trigger response.

​6. You can also define Action failure responses if you have defined an action for your bot and if in case the bot will not be able to complete the given action then the message configured here will be displayed to the visitors.

  • After standard business hours - The message/action configured in this section will be displayed to the visitor if they try to connect with an operator outside the standard business hours.
  • Operators not available - The message/action configured in this section will be displayed when the bot tries to forward a visitor chat to the operator and all the operators are busy assisting other visitors and no one is available to take up the chat.
  • Operators does not exist - The message/action configured in this section will be displayed when the bot tries to forward the chat and finds the mentioned operator is inactive or not a part of the portal anymore.

Text Message: You can use this format to trigger a text message.

	
{
  "replies": [
    {
      "text": "Hello there, I'm Zappy. "
    },
    {
      "text": "How may I help you today?"
    }
  ]
}

 

Text and Input Cards: You can use this format to trigger a message using text and an input card.

	
{
  "replies": [
    {
      "text": "Hello there, I'm Zappy.  "
    },
    {
      "text": "How may I help you today?"
    }
  ],
  "input": {
    "type": "select",
    "options": [
      "I would like to buy a property",
      "Thanks. Just browsing!"
    ]
  }
}

 

Text and Display Cards: You can use this format to trigger a message using text and a display card.

	
{
  "replies": [
    {
      "text": "Hello there, I'm Zappy. "
    },
    {
      "text": "How may I help you today?",
      "image": "http://zylker.com/help/common.png",
      "type": "links",
      "links": [
        {
          "url": "https://zylker.com/home",
          "text": "Zylker-home",
          "icon": "http://zylker.com/help/home.png"
        },
        {
          "url": "https://zylker.com/special-discounts",
          "text": "Zylker-discounts",
          "icon": "http://zylker.com/help/discounts.png"
        }
      ]
    }
  ]
}

 

Text, Input and Display Cards: You can use this format to trigger a message using text, an input card and a display card.

{
  "replies": [
    {
      "text": "Hello there, I'm Zappy."
    },
    {
      "text": "How may I help you today?",
      "image": "http://zylker.com/help/common.png",
      "type": "articles",
      "title": "Articles about property",
      "articles": [
        "121212121",
        "123434343",
        "123334678"
      ]
    }
  ],
  "input": {
    "type": "select",
    "options": [
      "I would like to buy a property",
      "Thanks. Just browsing!"
    ]
  }
}

Text and Suggestions: You can use this format to trigger a message using text and suggestions.

	
{
  "replies": [
    {
      "text": "Hey there! How may I help you today?"
    },
    {
      "text": "Here is the reference image",
      "image": "http://zylker.com/help/common.png"
    }
  ],
  "suggestions": [
    "I want to buy a property.",
    "Thanks. Just browsing"
  ]
}

 

7. Click Create

8. You can edit the trigger message and also edit the assistant name to change the bot deployed. 

9. Now, you can Access Azure Bot Service Resources window from the bot dashboard.

  • If you are a Portal owner/ Administrator who created the Azure Bot Service connection, then the Access Azure Bot Service Resources button will appear on the top right corner and you will be to access the service and edit it
  • If you are a Supervisor, you will be able to view the Zobot but you will not be able to edit it.
  • If you are an Associate, you will not be able to access the Zobot.