AtBot Logic (Preview)

AtBot Logic (Preview)

AtBot Logic, is a business bot that services the Microsoft cloud.

Note:

  • This is a Standard connector.

AtBot Logic is a bot in Teams that you train using Flow.

Here are some tips for using the AtBot Logic Flow Connector:

  • Each flow created that uses the AtBot Logic trigger will train the AtBot Logic bot to run that flow in Teams. This is called a skill in AtBot Logic.
  • You log into AtBot Logic using your Office 365 Azure AD credentials.
  • You will need to log into the same account in Flow and the AtBot Logic bot in Teams in order to load the proper skills.
  • The AtBot Logic actions can only be used in a flow that was triggered by the AtBot Logic trigger. There is a special property called ReplyActivity that comes from the trigger to allow the AtBot Logic bot to maintain state with flow.
  • Support for engaging AtBot Logic from PowerApps is not supported yet, but is coming soon!
  • For more information about AtBot Logic visit https://atbot.io/

By signing up for AtBot Logic, you agree to H3 terms of service and privacy statement.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Delete from bot memory

This operation is used to remove a piece of information from memory in the bot.

Required Parameters

User Principal Name
string
The user to save the memory item against.
Memory Type
string
The type of memory.
Value
string
The memory item value.

Returns

Generate Adaptive Card

This operation is used to a generate an adaptive card to be used later to display a list or carousel of cards.

Required Parameters

Selected Adaptive Card
string
Select the adaptive card.

Optional Parameters

content
dynamic

Returns

Get Bot Memory Items by Type

Get all Bot Memory Items by Type.

Required Parameters

User Principal Name.
string
Provide the User Principal Name.
Memory Type
string
Provide the type of memory to list.

Returns

array of MemoryItem

Get adaptive card response from User

This operation is used to ask the user for input via adaptive card.

Required Parameters

Selected Adaptive Card
string
Select the adaptive card.

Optional Parameters

webHook
dynamic

Returns

The outputs of this operation are dynamic.

Get choice list response from User

This operation is used to ask the user for choice list input.

Required Parameters

Message
string
Enter the message to send to the user.
Reply Activity
string
Reply Activity from the bot.

Optional Parameters

filters
string
Icon URL
string
Enter an absolute url to an icon to display for each choice item.
Accept Response From
string
Accept response from specific user or any user.

Returns

Get choice response from User

This operation is used to ask the user for choice input.

Required Parameters

Message
string
Enter the message to send to the user.
Choice Values
string
Provide each choice on a separate line.
Reply Activity
string
Reply Activity from the bot.

Optional Parameters

filters
string
Accept Response From
string
Accept response from specific user or any user.

Returns

Get datetime response from User

This operation is used to ask the user for datetime input.

Required Parameters

Date Scope
string
Select the scope of the date value.
Message
string
Enter the message to send to the user.
Reply Activity
string
Reply Activity from the bot.

Optional Parameters

filters
string
Accept Response From
string
Accept response from specific user or any user.

Returns

Get intent vector response from User

This operation is used to ask the user for NLP input.

Required Parameters

Message
string
Enter the message to send to the user.
LUIS Intent Vector
string
Pick your LUIS Intent Vector.
Reply Activity
string
Reply Activity from the bot.

Optional Parameters

filters
string
Accept Response From
string
Accept response from specific user or any user.

Returns

The outputs of this operation are dynamic.

Get memory response from User

This operation is used to ask the user for bot memory input.

Required Parameters

Message
string
Enter the message to send to the user.
Memory Type
string
Provide the type of memory to list.
Reply Activity
string
Reply Activity from the bot.

Optional Parameters

filters
string
Icon URL
string
Enter an absolute url to an icon to display for each choice item.
Accept Response From
string
Accept response from specific user or any user.
Target User
string
Optionally specify the UPN of the user the bot should pull memory items from. If left blank, it will pull memory items from the user that initiated the skill. In the case of a group conversation started from the bot, it will pull memory items from the user authenticated in Flow.

Returns

Get people response from User

This operation is used to ask the user for people picker input.

Required Parameters

Message
string
Enter the message to send to the user.
Mode
string
Ask the user to select one or many people.
Reply Activity
string
Reply Activity from the bot.

Optional Parameters

filters
string
Search String
string
Optionally provide a starting search string.
Accept Response From
string
Accept response from specific user or any user.

Returns

Get response from User

This operation is used to ask the user for input.

Required Parameters

Message
string
Enter the message to send to the user.
Reply Activity
string
Reply Activity from the bot.

Optional Parameters

filters
string
Accept Response From
string
Accept response from specific user or any user.

Returns

Save to bot memory

This operation is used to save a piece of information to memory in the bot.

Required Parameters

User Principal Name
string
The user to save the memory item against.
Memory Type
string
The type of memory.
Title
string
The memory item title.
Value
string
The memory item value.

Returns

Send Adaptive Card Set reply

This operation is used to a send an adaptive card set reply to the activity that triggered the flow. The set can be in either List or Carousel form.

Optional Parameters

Display Style
string
Select the display style to use.
Reply Activity
string
Reply Activity from the bot.

Returns

Send Adaptive Card reply

This operation is used to a send an adaptive card reply to the activity that triggered the flow.

Required Parameters

Selected Adaptive Card
string
Select the adaptive card.

Optional Parameters

content
dynamic

Returns

Send reply

This operation is used to a send a reply to the activity that triggered the flow.

Required Parameters

Reply Text
string
The message to reply to the user with.
Reply Activity
string
Reply Activity from the bot

Returns

Start a new group conversation

This operation is used to start a new group conversation in a channel.

Required Parameters

Target Bot
string
Select the bot.
Channel Name
string
The channel to post the conversation to. Type in the name.
Conversation Text
string
The message to start the conversation with.

Returns

Start a new private conversation

This operation is used to start a new private conversation with a user.

Required Parameters

Target Bot
string
Select the bot.
Conversation Text
string
The message to start the conversation with.
User
string
User principal name (UPN).

Returns

Triggers

When a registered intent is used

This operation triggers when the given LUIS intent vector is used by the bot.

Required Parameters

Trigger Description
string
Description shown in the bot help dialog.
Bot Trigger Type
string
Select the type of trigger.

Optional Parameters

filters
string
LUIS Intent Vector
string
Pick your LUIS Intent Vector.

Returns

The outputs of this operation are dynamic.

When an intent is used

This operation triggers when the given LUIS intent is used by the bot.

Required Parameters

Trigger Description
string
Description shown in the bot help dialog
Bot Trigger Type
string
Select the type of trigger.

Optional Parameters

filters
string
Keywords
string
Enter custom keywords that will trigger the Flow.
LUIS API Key
string
Provide AtBot with your LUIS API Key.
LUIS App
string
Pick your LUIS app.
LUIS Intent
string
Pick the LUIS intent to use.

Returns

The outputs of this operation are dynamic.

Definitions

BotReplyResponse

Message Id
string
Id of the message created from the reply. Used to update the message.

BotResponse

Cancellation Notice
boolean
This flag will be True if the user responds with a cancellation keyword.
File Bytes
byte
The file bytes.
File Name
string
The file name.
File Type
string
The file type.
Responding User
string
The user responding to the bot.
Response Text
string
The response the user entered.
files
array of object

BotResponse_Date

Cancellation Notice
boolean
This flag will be True if the user responds with a cancellation keyword.
Responding User
string
The user responding to the bot.
Response Date
date-time
The response datetime the user entered.
Response Date UTC
date-time
The response datetime the user entered, in UTC format.

BotResponse_Choice

Cancellation Notice
boolean
This flag will be True if the user responds with a cancellation keyword.
Responding User
string
The user responding to the bot.
Response Choice
string
The response choice the user entered.

BotResponse_ChoiceList

Cancellation Notice
boolean
This flag will be True if the user responds with a cancellation keyword.
Responding User
string
The user responding to the bot.
Selected Choice List Subtitle
string
The selected choice list subtitle.
Selected Choice List Title
string
The selected choice list title.
Selected Choice List Value
string
The selected choice list value.

BotResponse_People

Cancellation Notice
boolean
This flag will be True if the user responds with a cancellation keyword.
Email
string
The user email.
Full Name
string
The user full name.
Responding User
string
The user responding to the bot.
User Id
string
The user Id.
User Principal Name
string
The user principal name.
people
array of object

BotResponse_Memory

Cancellation Notice
boolean
This flag will be True if the user responds with a cancellation keyword.
Memory Item Title
string
The title of the memory item.
Memory Item Value
string
The value of the memory item.
Responding User
string
The user responding to the bot.

Response_SaveBotMemory

Bot Memory Save Result
string
The result of the save to bot memory.

Response_DeleteBotMemory

Bot Memory Delete Result
string
The result of the delete from bot memory.

BotGroupConversationStartResponse

Message Id
string
Id of the message created from the reply. Used to update the message.
Reply Activity
string
Activity Json.

BotConversationStartResponse

Message Id
string
Id of the message created from the reply. Used to update the message.
Reply Activity
string
Activity Json.

MemoryItem

Memory Item Title
string
The title of the memory item.
Memory Item Value
string
The value of the memory item.