InSpark Company Connect is a total package of smart apps & an automated provisioning mechanism, for the accelerated implementation of your personalized staff portals. Inside, information is quick and easy to find; You have direct access to primary work environments (inside and outside of Microsoft 365) and employees have device and location independent access. Company Connect gets the best out of the Office 365, with no restrictions.
Status: Preview |
Tier: Premium |
Version: 1.0 |
Name |
Summary |
Prompt user for a choice |
|
Prompt user to confirm |
|
Get LUIS apps |
|
Get intents |
|
Get Intent Schema |
|
ProactiveDialog_Start (string id, [Optional]ProactiveDialog_StartParameterBody body) |
Start a proactive dialog with a user |
Unsubscribe proactive dialog |
|
Send a message to the user |
|
Unsubscribe dialog |
|
Unsubscribe Smart Source |
|
Prompt user for text |
Name |
Summary |
ProactiveDialog_Subscribe (ProactiveDialog_SubscribeParameterBody body) |
Start proactive dialog |
Start dialog |
|
SmartSource_Subscribe (SmartSource_SubscribeParameterBody body) |
Smart Source |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Prompt user for a choice
Description: This operation is used to prompt the user for input.
Syntax:
CompanyConnect.ChoicePrompt (ChoicePromptParameterRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
request |
|
|
True |
Returns:
Summary: Prompt user to confirm
Description: This operation is used to prompt the user confirm
Syntax:
CompanyConnect.ConfirmPrompt (ConfirmPromptParameterRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
request |
|
|
True |
Returns:
Summary: Get LUIS apps
Description: Get all LUIS apps
Syntax:
CompanyConnect.LuisApps_GetApps ()
Returns:
Type:array of (LuisApp)
Summary: Get intents
Description: Get all intents in the LUIS app
Syntax:
CompanyConnect.LuisApps_GetIntents (string appId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
appId |
string
|
|
True |
Returns:
Type:array of (LuisIntent)
Summary: Get Intent Schema
Description: Get the schema for an intent
Syntax:
CompanyConnect.LuisApps_GetSchema (string appId, string intent)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
appId |
string
|
|
True |
|
intent |
string
|
|
True |
Returns:
Type:LuisApps_GetSchemaResponse
Summary: Start a proactive dialog with a user
Description: This operation is used start a proactive dialog with a user.
Syntax:
CompanyConnect.ProactiveDialog_Start (string id, [Optional]ProactiveDialog_StartParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string (Dialog) |
The proactive dialog to start |
True |
|
body |
ProactiveDialog_StartParameterBody
|
|
False |
Returns:
Summary: Unsubscribe proactive dialog
Description: Unsubscribes a proactive dialog.
Syntax:
CompanyConnect.ProactiveDialog_Unsubscribe (string tenantId, string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
tenantId |
string
|
|
True |
|
id |
string
|
|
True |
Returns:
Type:ProactiveDialog_UnsubscribeResponse
Summary: Send a message to the user
Description: This operation is used to send a message to the user.
Syntax:
CompanyConnect.Reply (MessageActivity messageActivity)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
messageActivity |
|
|
True |
Returns:
Summary: Unsubscribe dialog
Description: Unsubscribes a dialog.
Syntax:
CompanyConnect.SmartDialog_Unsubscribe (string tenantId, string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
tenantId |
string
|
|
True |
|
id |
string
|
|
True |
Returns:
Summary: Unsubscribe Smart Source
Description: Delete a smart source.
Syntax:
CompanyConnect.SmartSource_Unsubscribe (string tenantId, string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
tenantId |
string
|
|
True |
|
id |
string
|
|
True |
Returns:
Summary: Prompt user for text
Description: This operation is used to prompt the user for input.
Syntax:
CompanyConnect.TextPrompt (TextPromptParameterRequest request)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
request |
|
|
True |
Returns:
Summary: Start proactive dialog
Description: Starts a new dialog initiated by the bot
Syntax:
CompanyConnect.ProactiveDialog_Subscribe (ProactiveDialog_SubscribeParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
ProactiveDialog_SubscribeParameterBody
|
|
True |
Returns:
Summary: Start dialog
Description: Starts a new dialog when the given intent is used
Syntax:
CompanyConnect.SmartDialog_Subscribe (DialogSubscriptionRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Summary: Smart Source
Description: Register a new Smart Source for use in Connect web parts
Syntax:
CompanyConnect.SmartSource_Subscribe (SmartSource_SubscribeParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
SmartSource_SubscribeParameterBody
|
|
True |
Returns:
Summary:
Description:
Properties:
Name |
Type |
Summary |
callbackUri |
string
|
|
prompt |
string
|
The prompt to send the user |
choices |
array of (string)
|
Reference to the current conversation |
conversationReference |
string
|
Reference to the current conversation |
Summary:
Description:
Properties:
Name |
Type |
Summary |
callbackUri |
string
|
|
prompt |
string
|
The prompt to send the user |
yesText |
string
|
Yes text. |
noText |
string
|
No text. |
conversationReference |
string
|
Reference to the current conversation |
Summary:
Description:
Properties:
Name |
Type |
Summary |
appId |
string
|
LUIS application |
intent |
string
|
Intent used to start this dialog |
description |
string
|
Description to show to the user to describe the purpose of this dialog |
callbackUrl |
string
|
callbackUrl |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
name |
string
|
|
description |
string
|
|
culture |
string
|
|
usageScenario |
string
|
|
domain |
string
|
|
versionsCount |
integer
|
|
createdDateTime |
string
|
|
endpoints |
|
|
endpointHitsCount |
integer
|
|
activeVersion |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
PRODUCTION |
|
|
STAGING |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
versionId |
string
|
|
directVersionPublish |
boolean
|
|
endpointUrl |
string
|
|
isStaging |
boolean
|
|
assignedEndpointKey |
|
|
region |
|
|
endpointRegion |
string
|
|
publishedDateTime |
string
|
|
failedRegions |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
versionId |
string
|
|
directVersionPublish |
boolean
|
|
endpointUrl |
string
|
|
isStaging |
boolean
|
|
assignedEndpointKey |
|
|
region |
|
|
endpointRegion |
string
|
|
publishedDateTime |
string
|
|
failedRegions |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
schema |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
customPrebuiltDomainName |
string
|
customPrebuiltDomainName |
customPrebuiltModelName |
string
|
customPrebuiltModelName |
id |
string
|
id |
name |
string
|
name |
typeId |
integer(int32)
|
typeId |
readableType |
string
|
readableType |
Summary:
Description:
Properties:
Name |
Type |
Summary |
text |
string
|
The text content of the message |
conversationReference |
string
|
Reference to the current conversation |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
upn |
string
|
The user principal name of the user |
Summary:
Description:
Properties:
Name |
Type |
Summary |
callbackUrl |
string
|
callbackUrl |
title |
string
|
The title of this dialog |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
callbackUrl |
string
|
callbackUrl |
title |
string
|
The title for the user data option. The title is displayed in the configuration of My Starting Point. |
category |
string
|
The category for the user data option. User data attribute options are grouped by category. |
icon |
string
|
The name of the icon to be used for the user data option. This can be any icon from the Office Fabric UI (see: https://developer.microsoft.com/en-us/fabric#/styles/web/icons) |
Summary:
Description:
Properties:
Name |
Type |
Summary |
callbackUri |
string
|
|
prompt |
string
|
The prompt to send the user. |
conversationReference |
string
|
Reference to the current conversation |