Connectors Reference

AtBot Logic (Formerly Bizzy)

AtBot Logic (Formerly Bizzy), is a business bot that services the Microsoft cloud.

 

Status: Preview

Tier: Standard

Version: 3.0.1

 

Actions:

Name

Summary

SendReply (BotReply content)

Send reply

StartConversation (BotConversationStart content)

Start a new private conversation

GetBots ()

Get Bots

GetIntents (string luisApiKey, string appId)

Get intents

GetApps (string luisApiKey)

Get Apps

GetIntentVectors ()

Get LUIS App Registration Intent Vectors

Luis_GetPayloadSchema ([Optional]string triggerType, [Optional]string luisApiKey, [Optional]string appId)

Get Intent Schema

Luis_GetPayloadSchemaVector ([Optional]string vectorId)

Get Intent Vector Schema

Luis_GetPayloadSchemaVectorForResponse ([Optional]string vectorId)

Get Intent Vector Schema

Luis_GetIntentSchemaList (string luisApiKey, string appId)

Get Intent Schema List

Luis_GetWebHookSchema ([Optional]string triggerType, [Optional]string luisApiKey, [Optional]string appId)

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_PEOPLE (WebHookBotMessage_People webHook)

Get people response from User

WebHookRegistrations_InputResponse_INTENTVECTOR (WebHookBotMessage_IntentVector webHook)

Get intent vector response from User

WebHookRegistrations_Delete (string id, string pid)

Delete webhook

 

Triggers:

Name

Summary

WebHookRegistrations_Post (WebHookEx webHook)

When an intent is used

WebHookRegistrationsVector_Post (WebHookEx_Vector webHook)

When a registered intent is used

 

Objects:

Name

Summary

BotConversationStart

 

BotConversationStartResponse

 

BotReply

 

BotReplyResponse

 

DynamicResponseGetIntentSchemaList

 

DynamicResponseGetPayloadSchema

 

DynamicResponseGetPayloadSchemaVector

 

DynamicResponseGetPayloadSchemaVectorForResponse

 

DynamicResponseGetWebHookSchema

 

EnterpriseBot

 

ExternalApiKeys

 

IntentVector

 

Limits

 

LuisApp

 

LuisIntent

 

WebHook

 

WebHookBotMessage

 

WebHookBotMessage_Choice

 

WebHookBotMessage_Date

 

WebHookBotMessage_IntentVector

 

WebHookBotMessage_People

 

WebHookEx

 

WebHookEx_Vector

 

 

Actions:

SendReply

Summary: Send reply

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

 

Syntax:

AtBotLogic(FormerlyBizzy).SendReply (BotReply content)

 

Parameters:

Name

Type

Summary

Required

Related Action

content

BotReply

 

 

True

 

Returns:

          Type:BotReplyResponse

 

StartConversation

Summary: Start a new private conversation

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

 

Syntax:

AtBotLogic(FormerlyBizzy).StartConversation (BotConversationStart content)

 

Parameters:

Name

Type

Summary

Required

Related Action

content

BotConversationStart

 

 

True

 

Returns:

          Type:BotConversationStartResponse

 

GetBots

Summary: Get Bots

Description: Get all enterprise bots in your tenant.

 

Syntax:

AtBotLogic(FormerlyBizzy).GetBots ()

 

Returns:

          Type:array of (EnterpriseBot)

 

GetIntents

Summary: Get intents

Description: This operation is used to fetch the intents associated with your LUIS app.

 

Syntax:

AtBotLogic(FormerlyBizzy).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

GetApps

 

Returns:

          Type:array of (LuisIntent)

 

GetApps

Summary: Get Apps

Description: Get the LUIS apps you have access to.

 

Syntax:

AtBotLogic(FormerlyBizzy).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)

 

GetIntentVectors

Summary: Get LUIS App Registration Intent Vectors

Description: Get all LUIS Intent Vectors based on the App Registration ID.

 

Syntax:

AtBotLogic(FormerlyBizzy).GetIntentVectors ()

 

Returns:

          Type:array of (IntentVector)

 

Luis_GetPayloadSchema

Summary: Get Intent Schema

Description: For internal use only.

 

Syntax:

AtBotLogic(FormerlyBizzy).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:DynamicResponseGetPayloadSchema

 

Luis_GetPayloadSchemaVector

Summary: Get Intent Vector Schema

Description: For internal use only.

 

Syntax:

AtBotLogic(FormerlyBizzy).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:DynamicResponseGetPayloadSchemaVector

 

Luis_GetPayloadSchemaVectorForResponse

Summary: Get Intent Vector Schema

Description: For internal use only.

 

Syntax:

AtBotLogic(FormerlyBizzy).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:DynamicResponseGetPayloadSchemaVectorForResponse

 

Luis_GetIntentSchemaList

Summary: Get Intent Schema List

Description: For internal use only.

 

Syntax:

AtBotLogic(FormerlyBizzy).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:DynamicResponseGetIntentSchemaList

 

Luis_GetWebHookSchema

Summary: Get Intent Schema List

Description: For internal use only.

 

Syntax:

AtBotLogic(FormerlyBizzy).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

 

WebHookRegistrations_InputResponse

Summary: Get response from User

Description: This operation is used to ask the user for input.

 

Syntax:

AtBotLogic(FormerlyBizzy).WebHookRegistrations_InputResponse (WebHookBotMessage webHook)

 

Parameters:

Name

Type

Summary

Required

Related Action

webHook

WebHookBotMessage

 

 

True

 

Returns:

          Type:WebHook

 

WebHookRegistrations_InputResponse_DATE

Summary: Get datetime response from User

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

 

Syntax:

AtBotLogic(FormerlyBizzy).WebHookRegistrations_InputResponse_DATE (WebHookBotMessage_Date webHook)

 

Parameters:

Name

Type

Summary

Required

Related Action

webHook

WebHookBotMessage_Date

 

 

True

 

Returns:

          Type:WebHook

 

WebHookRegistrations_InputResponse_CHOICE

Summary: Get choice response from User

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

 

Syntax:

AtBotLogic(FormerlyBizzy).WebHookRegistrations_InputResponse_CHOICE (WebHookBotMessage_Choice webHook)

 

Parameters:

Name

Type

Summary

Required

Related Action

webHook

WebHookBotMessage_Choice

 

 

True

 

Returns:

          Type:WebHook

 

WebHookRegistrations_InputResponse_PEOPLE

Summary: Get people response from User

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

 

Syntax:

AtBotLogic(FormerlyBizzy).WebHookRegistrations_InputResponse_PEOPLE (WebHookBotMessage_People webHook)

 

Parameters:

Name

Type

Summary

Required

Related Action

webHook

WebHookBotMessage_People

 

 

True

 

Returns:

          Type:WebHook

 

WebHookRegistrations_InputResponse_INTENTVECTOR

Summary: Get intent vector response from User

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

 

Syntax:

AtBotLogic(FormerlyBizzy).WebHookRegistrations_InputResponse_INTENTVECTOR (WebHookBotMessage_IntentVector webHook)

 

Parameters:

Name

Type

Summary

Required

Related Action

webHook

WebHookBotMessage_IntentVector

 

 

True

 

Returns:

          Type:WebHook

 

WebHookRegistrations_Delete

Summary: Delete webhook

Description: Deletes the webhook.

 

Syntax:

AtBotLogic(FormerlyBizzy).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:

 

Triggers:

Trigger WebHookRegistrations_Post

Summary: When an intent is used

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

 

Syntax:

AtBotLogic(FormerlyBizzy).WebHookRegistrations_Post (WebHookEx webHook)

 

Parameters:

Name

Type

Summary

Required

Related Action

webHook

WebHookEx

 

 

True

 

Returns:

          Type:WebHook

 

Trigger WebHookRegistrationsVector_Post

Summary: When a registered intent is used

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

 

Syntax:

AtBotLogic(FormerlyBizzy).WebHookRegistrationsVector_Post (WebHookEx_Vector webHook)

 

Parameters:

Name

Type

Summary

Required

Related Action

webHook

WebHookEx_Vector

 

 

True

 

Returns:

          Type:WebHook

 


 

BotConversationStart

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).


 

BotConversationStartResponse

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.


 

BotReply

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


 

BotReplyResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Message Id

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


 

DynamicResponseGetIntentSchemaList

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

DynamicResponseGetPayloadSchema

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

DynamicResponseGetPayloadSchemaVector

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

DynamicResponseGetPayloadSchemaVectorForResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

DynamicResponseGetWebHookSchema

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

EnterpriseBot

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

name

string

 

 

description

string

 

 


 

ExternalApiKeys

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

IntentVector

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

title

string

 

 


 

Limits

Summary:

Description:

 

          Properties:

Name

Type

Summary

maximumNumberOfIntents

integer(int32)

 

 

maximumNumberOfEntities

integer(int32)

 

 

maximumNumberOfFeatures

integer(int32)

 

 


 

LuisApp

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

Limits

 

 

isTrained

boolean

 

 

endpointHits

integer(int32)

 

 

externalApiKeys

ExternalApiKeys

 

 

hasSpellCheckSupportedCulture

boolean

 

 


 

LuisIntent

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

 

type

string

 

 

id

string

 

 


 

WebHook

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

webHookUri

string

 

 

secret

string

 

 

description

string

 

 

isPaused

boolean

 

 

filters

array of (string)

 

 

headers

Headers

 

 

properties

Properties

 

 

 

Headers

Summary:

Description:

 

          Properties:

Name

Type

Summary

 

Properties

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

WebHookBotMessage

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

webHookUri

string

 

 

secret

string

 

 

description

string

 

 

isPaused

boolean

 

 

filters

array of (string)

 

 

headers

Headers

 

 

properties

Properties

 

 

message

string

Message

Enter the message to send to the user.

activityJson

string

Reply Activity

Reply Activity from the bot.

 

Headers

Summary:

Description:

 

          Properties:

Name

Type

Summary

 

Properties

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

WebHookBotMessage_Choice

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

webHookUri

string

 

 

secret

string

 

 

description

string

 

 

isPaused

boolean

 

 

filters

array of (string)

 

 

headers

Headers

 

 

properties

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.

 

Headers

Summary:

Description:

 

          Properties:

Name

Type

Summary

 

Properties

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

WebHookBotMessage_Date

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

webHookUri

string

 

 

secret

string

 

 

description

string

 

 

isPaused

boolean

 

 

filters

array of (string)

 

 

headers

Headers

 

 

properties

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.

 

Headers

Summary:

Description:

 

          Properties:

Name

Type

Summary

 

Properties

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

WebHookBotMessage_IntentVector

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

webHookUri

string

 

 

secret

string

 

 

description

string

 

 

isPaused

boolean

 

 

filters

array of (string)

 

 

headers

Headers

 

 

properties

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.

 

Headers

Summary:

Description:

 

          Properties:

Name

Type

Summary

 

Properties

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

WebHookBotMessage_People

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

webHookUri

string

 

 

secret

string

 

 

description

string

 

 

isPaused

boolean

 

 

filters

array of (string)

 

 

headers

Headers

 

 

properties

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.

 

Headers

Summary:

Description:

 

          Properties:

Name

Type

Summary

 

Properties

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

WebHookEx

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

webHookUri

string

 

 

secret

string

 

 

description

string

 

 

isPaused

boolean

 

 

filters

array of (string)

 

 

headers

Headers

 

 

properties

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

LUIS API Key

Provide AtBot with your LUIS API Key.

luisAppId

string

LUIS App

Pick your LUIS app.

luisIntent

string

LUIS Intent

Pick the LUIS intent to use.

 

Headers

Summary:

Description:

 

          Properties:

Name

Type

Summary

 

Properties

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

WebHookEx_Vector

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

webHookUri

string

 

 

secret

string

 

 

description

string

 

 

isPaused

boolean

 

 

filters

array of (string)

 

 

headers

Headers

 

 

properties

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.

 

Headers

Summary:

Description:

 

          Properties:

Name

Type

Summary

 

Properties

Summary:

Description:

 

          Properties:

Name

Type

Summary