Connectors Reference
AtBot is a no-code bot building service that allows you to create conversational UIs quickly without any programming experience.
|
Status: Production |
Tier: Standard |
Version: 3.65.4 |
|
Name |
Summary |
|
Send reply |
|
|
SendReplyWithAdaptiveCard (string selectedCard, SendReplyWithAdaptiveCardParameterContent content) |
Send Adaptive Card reply |
|
GenerateAdaptiveCard (string selectedCard, [Optional]GenerateAdaptiveCardParameterContent content) |
Generate Adaptive Card |
|
Send Adaptive Card Set reply |
|
|
Update an adaptive card sent to a tab |
|
|
List Adaptive Cards |
|
|
List Adaptive Card Forms |
|
|
Get Adaptive Card Field Schema |
|
|
Get Adaptive Card Field Schema |
|
|
Get Adaptive Card Field Schema |
|
|
Get Adaptive Card Field Schema as a webHook |
|
|
Start a new private conversation |
|
|
Start a new group conversation |
|
|
Send Event |
|
|
Get Bots |
|
|
List Joined Teams |
|
|
List Team Channels |
|
|
Get intents |
|
|
Get Apps |
|
|
Get LUIS App Registration Intent Vectors |
|
|
Get Intent Schema |
|
|
Get Intent Vector Schema |
|
|
Luis_GetPayloadSchemaVectorForResponse ([Optional]string vectorId) |
Get Intent Vector Schema |
|
Get Intent Schema List |
|
|
Get Intent Schema List |
|
|
WebHookRegistrations_InputResponse (WebHookBotMessage webHook) |
Get response from User |
|
WebHookRegistrations_InputResponse_DATE (WebHookBotMessage_Date webHook) |
Get datetime response from User |
|
WebHookRegistrations_InputResponse_CHOICE (WebHookBotMessage_Choice webHook) |
Get choice response from User |
|
WebHookRegistrations_InputResponse_CHOICELIST (WebHookBotMessage_ChoiceList webHook) |
Get choice list response from User |
|
WebHookRegistrations_InputResponse_PEOPLE (WebHookBotMessage_People webHook) |
Get people response from User |
|
WebHookRegistrations_InputResponse_INTENTVECTOR (WebHookBotMessage_IntentVector webHook) |
Get intent vector response from User |
|
WebHookRegistrations_InputResponse_MEMORY (WebHookBotMessage_Memory webHook) |
Get memory response from User |
|
Get adaptive card response from User |
|
|
WebHookRegistrations_InitiateBridge (WebHookChatBridge webHook) |
Register chat bridge between two or more conversations |
|
Save to bot memory |
|
|
Delete from bot memory |
|
|
Get Bot Memory Items by Type |
|
|
Delete webhook |
|
Name |
Summary |
|
When a keyword is used |
|
|
When an intent vector is recognized |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
WebHookRegistrations_InputResponse_ADAPTIVECARDParameterWebHook |
|
Summary: Send reply
Description: This operation is used to a send a reply to the activity that triggered the flow.
Syntax:
AtBotLogic.SendReply (BotReply content)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
content |
|
|
True |
Returns:
Type:BotReplyResponse
Summary: Send Adaptive Card reply
Description: This operation is used to a send an adaptive card reply to the activity that triggered the flow.
Syntax:
AtBotLogic.SendReplyWithAdaptiveCard (string selectedCard, SendReplyWithAdaptiveCardParameterContent content)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
selectedCard |
string (Selected Adaptive Card) |
Select the adaptive card. |
True |
|
|
content |
SendReplyWithAdaptiveCardParameterContent
|
|
True |
Returns:
Type:BotReplyResponse
Summary: Generate Adaptive Card
Description: This operation is used to a generate an adaptive card to be used later to display a list or carousel of cards.
Syntax:
AtBotLogic.GenerateAdaptiveCard (string selectedCard, [Optional]GenerateAdaptiveCardParameterContent content)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
selectedCard |
string (Selected Adaptive Card) |
Select the adaptive card. |
True |
|
|
content |
GenerateAdaptiveCardParameterContent
|
|
False |
Returns:
Type:GenerateAdaptiveCardResponse
Summary: Send Adaptive Card Set reply
Description: 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.
Syntax:
AtBotLogic.SendReplyWithAdaptiveCardSet (AdaptiveCardSet CardSet)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
CardSet |
|
|
True |
Returns:
Type:BotReplyResponse
Summary: Update an adaptive card sent to a tab
Description: This operation is used to update a card sent to a tab.
Syntax:
AtBotLogic.UpdateAdaptiveCard (UpdateCardInfo CardInfo)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
CardInfo |
|
|
True |
Returns:
Type:BotReplyResponse
Summary: List Adaptive Cards
Description: List Adaptive Cards in your tenant.
Syntax:
AtBotLogic.ListAdaptiveCards ()
Returns:
Type:array of (AdaptiveCard)
Summary: List Adaptive Card Forms
Description: List Adaptive Card Forms in your tenant.
Syntax:
AtBotLogic.ListAdaptiveCardForms ()
Returns:
Type:array of (AdaptiveCard)
Summary: Get Adaptive Card Field Schema
Description: For internal use only.
Syntax:
AtBotLogic.AdaptiveCards_GetCardFields (string cardId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
cardId |
string (Card ID) |
Enter your card ID. |
True |
Returns:
Type:AdaptiveCards_GetCardFieldsResponse
Summary: Get Adaptive Card Field Schema
Description: For internal use only.
Syntax:
AtBotLogic.AdaptiveCards_GetCardFields_NoReplyActivity (string cardId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
cardId |
string (Card ID) |
Enter your card ID. |
True |
Returns:
Type:AdaptiveCards_GetCardFields_NoReplyActivityResponse
Summary: Get Adaptive Card Field Schema
Description: For internal use only.
Syntax:
AtBotLogic.AdaptiveCards_GetCardFormOutputSchema (string cardId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
cardId |
string (Card ID) |
Enter your card ID. |
True |
Returns:
Type:AdaptiveCards_GetCardFormOutputSchemaResponse
Summary: Get Adaptive Card Field Schema as a webHook
Description: For internal use only.
Syntax:
AtBotLogic.AdaptiveCards_GetCardWebhookFields (string cardId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
cardId |
string (Card ID) |
Enter your card ID. |
True |
Returns:
Type:AdaptiveCards_GetCardWebhookFieldsResponse
Summary: Start a new private conversation
Description: This operation is used to start a new private conversation with a user.
Syntax:
AtBotLogic.StartConversation (BotConversationStart content)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
content |
|
|
True |
Returns:
Type:BotConversationStartResponse
Summary: Start a new group conversation
Description: This operation is used to start a new group conversation in a channel.
Syntax:
AtBotLogic.StartGroupConversation (BotGroupConversationStart content)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
content |
|
|
True |
Returns:
Type:BotGroupConversationStartResponse
Summary: Send Event
Description: This operation is used to a send an event to the bot client.
Syntax:
AtBotLogic.SendBridgeEvent (ChatBridgeEvent content)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
content |
|
|
True |
Returns:
Summary: Get Bots
Description: Get all enterprise bots in your tenant.
Syntax:
AtBotLogic.GetBots ()
Returns:
Type:array of (EnterpriseBot)
Summary: List Joined Teams
Description: List all Teams the user is a member of.
Syntax:
AtBotLogic.MyJoinedTeams ()
Returns:
Type:array of (TeamsTeam)
Summary: List Team Channels
Description: List all channels of a Team.
Syntax:
AtBotLogic.TeamChannels (string teamId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
teamId |
string (Team Id) |
Teams team Id. |
True |
Returns:
Type:array of (TeamsTeamChannel)
Summary: Get intents
Description: This operation is used to fetch the intents associated with your LUIS app.
Syntax:
AtBotLogic.GetIntents (string luisApiKey, string appId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
luisApiKey |
string (LUIS API Key) |
Provide AtBot with your LUIS API Key. |
True |
|
|
appId |
string (LUIS App) |
Pick your LUIS app. |
True |
Returns:
Type:array of (LuisIntent)
Summary: Get Apps
Description: Get the LUIS apps you have access to.
Syntax:
AtBotLogic.GetApps (string luisApiKey)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
luisApiKey |
string (LUIS API Key) |
Enter your LUIS API key. |
True |
Returns:
Type:array of (LuisApp)
Summary: Get LUIS App Registration Intent Vectors
Description: Get all LUIS Intent Vectors based on the App Registration ID.
Syntax:
AtBotLogic.GetIntentVectors ()
Returns:
Type:array of (IntentVector)
Summary: Get Intent Schema
Description: For internal use only.
Syntax:
AtBotLogic.Luis_GetPayloadSchema ([Optional]string triggerType, [Optional]string luisApiKey, [Optional]string appId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
triggerType |
string
|
|
False |
|
|
luisApiKey |
string (LUIS API Key) |
Enter your LUIS API key. |
False |
|
|
appId |
string
|
Select App you want Intents from. |
False |
Returns:
Type:Luis_GetPayloadSchemaResponse
Summary: Get Intent Vector Schema
Description: For internal use only.
Syntax:
AtBotLogic.Luis_GetPayloadSchemaVector ([Optional]string vectorId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
vectorId |
string (LUIS Vector ID) |
Enter your LUIS Vector ID. |
False |
Returns:
Type:Luis_GetPayloadSchemaVectorResponse
Summary: Get Intent Vector Schema
Description: For internal use only.
Syntax:
AtBotLogic.Luis_GetPayloadSchemaVectorForResponse ([Optional]string vectorId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
vectorId |
string (LUIS Vector ID) |
Enter your LUIS Vector ID. |
False |
Returns:
Type:Luis_GetPayloadSchemaVectorForResponseResponse
Summary: Get Intent Schema List
Description: For internal use only.
Syntax:
AtBotLogic.Luis_GetIntentSchemaList (string luisApiKey, string appId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
luisApiKey |
string (LUIS API Key) |
Enter your LUIS API key. |
True |
|
|
appId |
string
|
Select App you want Intents from. |
True |
Returns:
Type:Luis_GetIntentSchemaListResponse
Summary: Get Intent Schema List
Description: For internal use only.
Syntax:
AtBotLogic.Luis_GetWebHookSchema ([Optional]string triggerType, [Optional]string luisApiKey, [Optional]string appId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
triggerType |
string
|
|
False |
|
|
luisApiKey |
string (LUIS API Key) |
Enter your LUIS API key. |
False |
|
|
appId |
string
|
Select LUIS App. |
False |
Returns:
Type:DynamicResponseGetWebHookSchema
Summary: Get response from User
Description: This operation is used to ask the user for input.
Syntax:
AtBotLogic.WebHookRegistrations_InputResponse (WebHookBotMessage webHook)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
webHook |
|
|
True |
Returns:
Type:WebHook
Summary: Get datetime response from User
Description: This operation is used to ask the user for datetime input.
Syntax:
AtBotLogic.WebHookRegistrations_InputResponse_DATE (WebHookBotMessage_Date webHook)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
webHook |
|
|
True |
Returns:
Type:WebHook
Summary: Get choice response from User
Description: This operation is used to ask the user for choice input.
Syntax:
AtBotLogic.WebHookRegistrations_InputResponse_CHOICE (WebHookBotMessage_Choice webHook)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
webHook |
|
|
True |
Returns:
Type:WebHook
Summary: Get choice list response from User
Description: This operation is used to ask the user for choice list input.
Syntax:
AtBotLogic.WebHookRegistrations_InputResponse_CHOICELIST (WebHookBotMessage_ChoiceList webHook)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
webHook |
|
|
True |
Returns:
Type:WebHook
Summary: Get people response from User
Description: This operation is used to ask the user for people picker input.
Syntax:
AtBotLogic.WebHookRegistrations_InputResponse_PEOPLE (WebHookBotMessage_People webHook)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
webHook |
|
|
True |
Returns:
Type:WebHook
Summary: Get intent vector response from User
Description: This operation is used to ask the user for NLP input.
Syntax:
AtBotLogic.WebHookRegistrations_InputResponse_INTENTVECTOR (WebHookBotMessage_IntentVector webHook)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
webHook |
WebHookBotMessage_IntentVector
|
|
True |
Returns:
Type:WebHook
Summary: Get memory response from User
Description: This operation is used to ask the user for bot memory input.
Syntax:
AtBotLogic.WebHookRegistrations_InputResponse_MEMORY (WebHookBotMessage_Memory webHook)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
webHook |
|
|
True |
Returns:
Type:WebHook
Summary: Get adaptive card response from User
Description: This operation is used to ask the user for input via adaptive card.
Syntax:
AtBotLogic.WebHookRegistrations_InputResponse_ADAPTIVECARD (string selectedCard, [Optional]WebHookRegistrations_InputResponse_ADAPTIVECARDParameterWebHook webHook)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
selectedCard |
string (Selected Adaptive Card) |
Select the adaptive card. |
True |
|
|
webHook |
WebHookRegistrations_InputResponse_ADAPTIVECARDParameterWebHook
|
|
False |
Returns:
Type:WebHook
Summary: Register chat bridge between two or more conversations
Description: This operation is used to initiate a chat bridge between two or more users.
Syntax:
AtBotLogic.WebHookRegistrations_InitiateBridge (WebHookChatBridge webHook)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
webHook |
|
|
True |
Returns:
Type:WebHook
Summary: Save to bot memory
Description: This operation is used to save a piece of information to memory in the bot.
Syntax:
AtBotLogic.SaveBotMemory (SaveBotMemory content)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
content |
|
|
True |
Returns:
Summary: Delete from bot memory
Description: This operation is used to remove a piece of information from memory in the bot.
Syntax:
AtBotLogic.DeleteBotMemory (DeleteBotMemory content)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
content |
|
|
True |
Returns:
Summary: Get Bot Memory Items by Type
Description: Get all Bot Memory Items by Type.
Syntax:
AtBotLogic.GetMemoryItemsByType (CheckMemoryInfo checkMemoryInfo)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
checkMemoryInfo |
|
|
True |
Returns:
Type:array of (MemoryItem)
Summary: Delete webhook
Description: Deletes the webhook.
Syntax:
AtBotLogic.WebHookRegistrations_Delete (string id, string pid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (WebHook Id) |
WebHook Id. |
True |
|
|
pid |
string (Principal Id) |
Principal Id. |
True |
Returns:
Summary: When a keyword is used
Description: This operation triggers when the given keyword(s) are used by the bot. Supply multiple keywords in semi-colon delimited format.
Syntax:
AtBotLogic.WebHookRegistrations_Post (WebHookEx webHook)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
webHook |
|
|
True |
Returns:
Type:WebHook
Summary: When an intent vector is recognized
Description: This operation triggers when the given LUIS intent vector is recognized by the bot.
Syntax:
AtBotLogic.WebHookRegistrationsVector_Post (WebHookEx_Vector webHook)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
webHook |
|
|
True |
Returns:
Type:WebHook
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
|
|
name |
string
|
|
|
description |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
cards |
Adaptive Card Set |
Provide the card set object. |
|
displayStyle |
string Display Style |
Select the display style to use. Values: [Carousel, List] |
|
activityJson |
string Reply Activity |
Reply Activity from the bot. |
|
showInTab |
boolean Show In Tab |
Display this card set in a tab instead of inline chat. |
|
deepLinkButtonLabel |
string Tab Button Label |
Button label for displaying in a tab. |
|
deepLinkMessage |
string Tab Button Message |
Message to send with the button when displaying in a tab. |
Summary: Adaptive Card Set
Description: Provide the card set object.
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
EnterpriseBot |
string Target Bot |
Select the bot. |
|
message |
string Conversation Text |
The message to start the conversation with. |
|
user |
string User |
User principal name (UPN). |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Message Id |
Id of the message created from the reply. Used to update the message. |
|
activityJson |
string Reply Activity |
Activity Json. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
EnterpriseBot |
string Target Bot |
Select the bot. |
|
teamIDStr |
Channel Listing |
The channel listing output. |
|
channelId |
string Channel Name |
The channel to post the conversation to. Type in the name. |
|
message |
string Conversation Text |
The message to start the conversation with. |
Summary: Channel Listing
Description: The channel listing output.
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Conversation Id |
Id of the conversation created from the start group conversation. Used to update the conversation. |
|
messageId |
string Message Id |
Id of the message created from the start group conversation. Used to update the message. |
|
activityJson |
string Reply Activity |
Activity Json. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
message |
string Reply Text |
The message to reply to the user with. |
|
activityJson |
string Reply Activity |
Reply Activity from the bot |
|
showInChat |
boolean Show in chat |
If this is a Teams call, show this message in chat. Otherwise, the bot will only speak the message. |
|
customChannelDataJson |
string Custom Channel Data |
Custom Channel Data Json for the message (only supported in Direct Line) |
|
signalResponse |
string Signal Response JSON |
Signal Response JSON string |
|
messageId |
string Message ID |
(Optional) ID of a previous message in the same conversation to replace. If supplied, the bot will replace an existing chat message with this message. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Message Id |
Id of the message created from the reply. Used to update the message. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
activityJson |
string Reply Activity |
Reply Activity from the bot |
|
eventObject |
Event JSON |
The JSON object to be sent in the chat event. |
Summary: Event JSON
Description: The JSON object to be sent in the chat event.
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
user |
string User Principal Name. |
Provide the User Principal Name. |
|
type |
string Memory Type |
Provide the type of memory to list. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
user |
string User Principal Name |
The user to save the memory item against. |
|
type |
string Memory Type |
The type of memory. |
|
value |
string Value |
The memory item value. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
|
|
name |
string
|
|
|
description |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
|
|
title |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
maximumNumberOfIntents |
integer(int32)
|
|
|
maximumNumberOfEntities |
integer(int32)
|
|
|
maximumNumberOfFeatures |
integer(int32)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
|
|
name |
string
|
|
|
description |
string
|
|
|
culture |
string
|
|
|
active |
boolean
|
|
|
createdDate |
string(date-time)
|
|
|
modifiedDate |
string(date-time)
|
|
|
publishDate |
string(date-time)
|
|
|
lastTrainedDate |
string(date-time)
|
|
|
url |
string
|
|
|
authKey |
string
|
|
|
endpointKey |
string
|
|
|
endpontRegion |
string
|
|
|
usageScenario |
string
|
|
|
domain |
string
|
|
|
numberOfIntents |
integer(int32)
|
|
|
numberOfEntities |
integer(int32)
|
|
|
limits |
|
|
|
isTrained |
boolean
|
|
|
endpointHits |
integer(int32)
|
|
|
externalApiKeys |
|
|
|
hasSpellCheckSupportedCulture |
boolean
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
|
|
type |
string
|
|
|
id |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
title |
string Memory Item Title |
The title of the memory item. |
|
value |
string Memory Item Value |
The value of the memory item. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
text |
string Bot Memory Delete Result |
The result of the delete from bot memory. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
text |
string Bot Memory Save Result |
The result of the save to bot memory. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
user |
string User Principal Name |
The user to save the memory item against. |
|
type |
string Memory Type |
The type of memory. |
|
title |
string Title |
The memory item title. |
|
value |
string Value |
The memory item value. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
|
|
name |
string
|
|
|
description |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
|
|
name |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
card |
Adaptive Card |
Provide the card to use as the update. |
|
activityJson |
string Reply Activity |
Reply Activity from the bot. |
Summary: Adaptive Card
Description: Provide the card to use as the update.
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
|
|
webHookUri |
string
|
|
|
secret |
string
|
|
|
description |
string
|
|
|
isPaused |
boolean
|
|
|
filters |
array of (string)
|
|
|
headers |
|
|
|
properties |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
webHookUri |
string
|
|
|
filters |
array of (string)
|
|
|
headers |
|
|
|
properties |
|
|
|
message |
string Message |
Enter the message to send to the user. |
|
activityJson |
string Reply Activity |
Reply Activity from the bot. |
|
acceptResponseFrom |
string Accept Response From |
Accept response from specific user or any user. Values: [Original User, Any User] |
|
showInChat |
boolean Show in chat |
If this is a Teams call, show this message in chat. Otherwise, the bot will only speak the message. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
webHookUri |
string
|
|
|
filters |
array of (string)
|
|
|
headers |
|
|
|
properties |
|
|
|
message |
string Message |
Enter the message to send to the user. |
|
choices |
string Choice Values |
Provide each choice on a separate line. |
|
activityJson |
string Reply Activity |
Reply Activity from the bot. |
|
acceptResponseFrom |
string Accept Response From |
Accept response from specific user or any user. Values: [Original User, Any User] |
|
allowBranching |
string Allow Branching |
Allow the user to trigger branching skills before providing a response. Values: [No, Yes] |
|
showInChat |
boolean Show in chat |
If this is a Teams call, show this message in chat. Otherwise, the bot will only speak the message. |
|
listenForInput |
boolean Listen for voice response |
If this is a Teams call, this property determines whether the bot listens for a voice response. If no, or not a Teams call the bot will not immediately listen for a voice response. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
webHookUri |
string
|
|
|
filters |
array of (string)
|
|
|
headers |
|
|
|
properties |
|
|
|
icon |
string Icon URL |
Enter an absolute url to an icon to display for each choice item. |
|
message |
string Message |
Enter the message to send to the user. |
|
choices |
Choice Values |
Provide the choice array object. |
|
activityJson |
string Reply Activity |
Reply Activity from the bot. |
|
acceptResponseFrom |
string Accept Response From |
Accept response from specific user or any user. Values: [Original User, Any User] |
|
allowBranching |
string Allow Branching |
Allow the user to trigger branching skills before providing a response. Values: [No, Yes] |
|
showInChat |
boolean Show in chat |
If this is a Teams call, show this message in chat. Otherwise, the bot will only speak the message. |
|
listenForInput |
boolean Listen for voice response |
If this is a Teams call, this property determines whether the bot listens for a voice response. If no, or not a Teams call the bot will not immediately listen for a voice response. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary: Choice Values
Description: Provide the choice array object.
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
webHookUri |
string
|
|
|
filters |
array of (string)
|
|
|
headers |
|
|
|
properties |
|
|
|
dateScope |
string Date Scope |
Select the scope of the date value. Values: [Date Only, Time Only, Date and Time] |
|
message |
string Message |
Enter the message to send to the user. |
|
activityJson |
string Reply Activity |
Reply Activity from the bot. |
|
acceptResponseFrom |
string Accept Response From |
Accept response from specific user or any user. Values: [Original User, Any User] |
|
allowBranching |
string Allow Branching |
Allow the user to trigger branching skills before providing a response. Values: [No, Yes] |
|
showInChat |
boolean Show in chat |
If this is a Teams call, show this message in chat. Otherwise, the bot will only speak the message. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
webHookUri |
string
|
|
|
filters |
array of (string)
|
|
|
headers |
|
|
|
properties |
|
|
|
message |
string Message |
Enter the message to send to the user. |
|
intentVector |
string LUIS Intent Vector |
Pick your LUIS Intent Vector. |
|
activityJson |
string Reply Activity |
Reply Activity from the bot. |
|
acceptResponseFrom |
string Accept Response From |
Accept response from specific user or any user. Values: [Original User, Any User] |
|
allowBranching |
string Allow Branching |
Allow the user to trigger branching skills before providing a response. Values: [No, Yes] |
|
showInChat |
boolean Show in chat |
If this is a Teams call, show this message in chat. Otherwise, the bot will only speak the message. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
webHookUri |
string
|
|
|
filters |
array of (string)
|
|
|
headers |
|
|
|
properties |
|
|
|
message |
string Message |
Enter the message to send to the user. |
|
type |
string Memory Type |
Provide the type of memory to list. |
|
activityJson |
string Reply Activity |
Reply Activity from the bot. |
|
icon |
string Icon URL |
Enter an absolute url to an icon to display for each choice item. |
|
acceptResponseFrom |
string Accept Response From |
Accept response from specific user or any user. Values: [Original User, Any User] |
|
targetUserMemory |
string Target User |
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. |
|
allowBranching |
string Allow Branching |
Allow the user to trigger branching skills before providing a response. Values: [No, Yes] |
|
showInChat |
boolean Show in chat |
If this is a Teams call, show this message in chat. Otherwise, the bot will only speak the message. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
webHookUri |
string
|
|
|
filters |
array of (string)
|
|
|
headers |
|
|
|
properties |
|
|
|
message |
string Message |
Enter the message to send to the user. |
|
mode |
string Mode |
Ask the user to select one or many people. Values: [Single, Multiple] |
|
searchstr |
string Search String |
Optionally provide a starting search string. |
|
activityJson |
string Reply Activity |
Reply Activity from the bot. |
|
acceptResponseFrom |
string Accept Response From |
Accept response from specific user or any user. Values: [Original User, Any User] |
|
allowBranching |
string Allow Branching |
Allow the user to trigger branching skills before providing a response. Values: [No, Yes] |
|
showInChat |
boolean Show in chat |
If this is a Teams call, show this message in chat. Otherwise, the bot will only speak the message. |
|
listenForInput |
boolean Listen for voice response |
If this is a Teams call, this property determines whether the bot listens for a voice response. If no, or not a Teams call the bot will not immediately listen for a voice response. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
webHookUri |
string
|
|
|
filters |
array of (string)
|
|
|
headers |
|
|
|
properties |
|
|
|
participants |
array of (ParticipantsItem) Participants |
List all participants of the chat bridge |
|
endBridgeCommand |
string End Chat Command |
The keyword command to send to the bot to end the chat bridge. |
|
idleTimeoutDuration |
integer(int32) Idle Timeout |
The duration (in minutes) of idle activity to trigger a timeout. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
chatUserName |
string User Name |
Display name of the chat user. |
|
chatInitiationMessage |
string Initiation Message |
Message to send to this user when the chat bridge is established. |
|
activityJson |
string Reply Activity |
The reply activity for the chat user. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
webHookUri |
string
|
|
|
filters |
array of (string)
|
|
|
headers |
|
|
|
properties |
|
|
|
triggerDescription |
string Trigger Description |
Description shown in the bot help dialog |
|
triggerType |
string Bot Trigger Type |
Select the type of trigger. Values: [Shared, Personal] |
|
keywords |
string Keywords |
Enter custom keywords that will trigger the Flow. |
|
luisApiKey |
string (Deprecated) LUIS API Key |
(Deprecated) Provide AtBot with your LUIS API Key. This parameter is deprecated. Please use the Intent Vector trigger for LUIS use going forward. |
|
luisAppId |
string (Deprecated) LUIS App |
(Deprecated) Pick your LUIS app. This parameter is deprecated. Please use the Intent Vector trigger for LUIS use going forward. |
|
luisIntent |
string (Deprecated) LUIS Intent |
(Deprecated) Pick the LUIS intent to use. This parameter is deprecated. Please use the Intent Vector trigger for LUIS use going forward. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
webHookUri |
string
|
|
|
filters |
array of (string)
|
|
|
headers |
|
|
|
properties |
|
|
|
triggerDescription |
string Trigger Description |
Description shown in the bot help dialog. |
|
triggerType |
string Bot Trigger Type |
Select the type of trigger. Values: [Shared, Personal] |
|
intentVector |
string LUIS Intent Vector |
Pick your LUIS Intent Vector. |
|
allowBranching |
string Allow Branching |
Allow the user to trigger branching skills while answering followup questions. Values: [No, Yes] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |