Connectors Reference

AtBot Admin

AtBot Admin by H3 Solutions, Inc., is a business bot that services the Microsoft cloud.

 

Status: Preview

Tier: Standard

Version: 2.0.0

 

Actions:

Name

Summary

WebHookRegistrations_Delete (string id, string pid)

Delete webhook

GetBots ()

Get Bots

GetBotsNoWildcard ()

Get Bots

GetCategories ()

Get Skill Categories

Admin_AddSkillToCategory (AdminAddSkillInfo content)

Add Skill To Category

Admin_RemoveSkillFromAllCategories (AdminRemoveSkillCateoriesInfo content)

Remove a Skill from all Categories

Admin_QueryLicenseStatus ()

Get License Status

Admin_AddLicensedUser (AdminAddRemoveLicensedUserInfo content)

Add Licensed User

Admin_RemoveLicensedUser (AdminAddRemoveLicensedUserInfo content)

Remove Licensed User

Admin_BroadcastMessage (AdminBroadcastMessageInfo content)

Broadcast bot message

 

Triggers:

Name

Summary

WebHookRegistrations_Post_NoMatch (WebHookEx_Admin_NoMatch webHook)

When the bot sends the default message to the user

WebHookRegistrations_Post_SkillModified (WebHookEx_Admin_SkillModified webHook)

When a skill is created or modified

WebHookRegistrations_Post_UnlicensedUserAttempt (WebHookEx_Admin_UnlicensedUserAttempt webHook)

When an unlicensed user attempts to use a bot

 

Objects:

Name

Summary

AdminAddRemoveLicensedUserInfo

 

AdminAddRemoveLicensedUserPayload

 

AdminAddSkillInfo

 

AdminAddSkillToCategoryPayload

 

AdminBroadcastMessageInfo

 

AdminBroadcastMessagePayload

 

AdminQueryLicenseStatusPayload

 

AdminRemoveSkillCateoriesInfo

 

AdminRemoveSkillCateoriesPayload

 

Category

 

EnterpriseBot

 

WebHook

 

WebHookEx_Admin_NoMatch

 

WebHookEx_Admin_SkillModified

 

WebHookEx_Admin_UnlicensedUserAttempt

 

 

Actions:

WebHookRegistrations_Delete

Summary: Delete webhook

Description: Deletes the webhook.

 

Syntax:

AtBotAdmin.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:

 

GetBots

Summary: Get Bots

Description: Get all enterprise bots in your tenant.

 

Syntax:

AtBotAdmin.GetBots ()

 

Returns:

          Type:array of (EnterpriseBot)

 

GetBotsNoWildcard

Summary: Get Bots

Description: Get all enterprise bots in your tenant.

 

Syntax:

AtBotAdmin.GetBotsNoWildcard ()

 

Returns:

          Type:array of (EnterpriseBot)

 

GetCategories

Summary: Get Skill Categories

Description: Get all skill categories defined in your tenant.

 

Syntax:

AtBotAdmin.GetCategories ()

 

Returns:

          Type:array of (Category)

 

Admin_AddSkillToCategory

Summary: Add Skill To Category

Description: Add a skill by ID to a Category.

 

Syntax:

AtBotAdmin.Admin_AddSkillToCategory (AdminAddSkillInfo content)

 

Parameters:

Name

Type

Summary

Required

Related Action

content

AdminAddSkillInfo

 

 

True

 

Returns:

          Type:AdminAddSkillToCategoryPayload

 

Admin_RemoveSkillFromAllCategories

Summary: Remove a Skill from all Categories

Description: Remove all Categorie references to a skill.

 

Syntax:

AtBotAdmin.Admin_RemoveSkillFromAllCategories (AdminRemoveSkillCateoriesInfo content)

 

Parameters:

Name

Type

Summary

Required

Related Action

content

AdminRemoveSkillCateoriesInfo

 

 

True

 

Returns:

          Type:AdminRemoveSkillCateoriesPayload

 

Admin_QueryLicenseStatus

Summary: Get License Status

Description: Get counts of total licenses, seats taken, and seats available.

 

Syntax:

AtBotAdmin.Admin_QueryLicenseStatus ()

 

Returns:

          Type:AdminQueryLicenseStatusPayload

 

Admin_AddLicensedUser

Summary: Add Licensed User

Description: Add a user license.

 

Syntax:

AtBotAdmin.Admin_AddLicensedUser (AdminAddRemoveLicensedUserInfo content)

 

Parameters:

Name

Type

Summary

Required

Related Action

content

AdminAddRemoveLicensedUserInfo

 

 

True

 

Returns:

          Type:AdminAddRemoveLicensedUserPayload

 

Admin_RemoveLicensedUser

Summary: Remove Licensed User

Description: Remove a user license.

 

Syntax:

AtBotAdmin.Admin_RemoveLicensedUser (AdminAddRemoveLicensedUserInfo content)

 

Parameters:

Name

Type

Summary

Required

Related Action

content

AdminAddRemoveLicensedUserInfo

 

 

True

 

Returns:

          Type:AdminAddRemoveLicensedUserPayload

 

Admin_BroadcastMessage

Summary: Broadcast bot message

Description: Broadcast a private message to all specified users from the selected bot.

 

Syntax:

AtBotAdmin.Admin_BroadcastMessage (AdminBroadcastMessageInfo content)

 

Parameters:

Name

Type

Summary

Required

Related Action

content

AdminBroadcastMessageInfo

 

 

True

 

Returns:

          Type:AdminBroadcastMessagePayload

 

Triggers:

Trigger WebHookRegistrations_Post_NoMatch

Summary: When the bot sends the default message to the user

Description: This operation triggers when there is no matching skill or QnA answer to a user message and the default message is sent.

 

Syntax:

AtBotAdmin.WebHookRegistrations_Post_NoMatch (WebHookEx_Admin_NoMatch webHook)

 

Parameters:

Name

Type

Summary

Required

Related Action

webHook

WebHookEx_Admin_NoMatch

 

 

True

 

Returns:

          Type:WebHook

 

Trigger WebHookRegistrations_Post_SkillModified

Summary: When a skill is created or modified

Description: This operation triggers when a skill is created or updated.

 

Syntax:

AtBotAdmin.WebHookRegistrations_Post_SkillModified (WebHookEx_Admin_SkillModified webHook)

 

Parameters:

Name

Type

Summary

Required

Related Action

webHook

WebHookEx_Admin_SkillModified

 

 

True

 

Returns:

          Type:WebHook

 

Trigger WebHookRegistrations_Post_UnlicensedUserAttempt

Summary: When an unlicensed user attempts to use a bot

Description: This operation triggers when an unlicensed user attempts to use a bot.

 

Syntax:

AtBotAdmin.WebHookRegistrations_Post_UnlicensedUserAttempt (WebHookEx_Admin_UnlicensedUserAttempt webHook)

 

Parameters:

Name

Type

Summary

Required

Related Action

webHook

WebHookEx_Admin_UnlicensedUserAttempt

 

 

True

 

Returns:

          Type:WebHook

 


 

AdminAddRemoveLicensedUserInfo

Summary:

Description:

 

          Properties:

Name

Type

Summary

userId

string

User ID

 


 

AdminAddRemoveLicensedUserPayload

Summary:

Description:

 

          Properties:

Name

Type

Summary

response

string

 

 


 

AdminAddSkillInfo

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Skill ID

 

categoryId

string

Category

 


 

AdminAddSkillToCategoryPayload

Summary:

Description:

 

          Properties:

Name

Type

Summary

response

string

 

 


 

AdminBroadcastMessageInfo

Summary:

Description:

 

          Properties:

Name

Type

Summary

message

string

Broadcast message

The message to broadcast.

EnterpriseBot

string

Target Bot

Select the bot.

users

string

Specified users

Leave blank to send to all users.  Optionally provide a semicolon delimited list of User Principal Names (UPNs) of users to broadcast the message to.


 

AdminBroadcastMessagePayload

Summary:

Description:

 

          Properties:

Name

Type

Summary

response

string

 

 


 

AdminQueryLicenseStatusPayload

Summary:

Description:

 

          Properties:

Name

Type

Summary

total-license-count

integer

 

 

seats-taken

integer

 

 

seats-available

integer

 

 


 

AdminRemoveSkillCateoriesInfo

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Skill ID

 


 

AdminRemoveSkillCateoriesPayload

Summary:

Description:

 

          Properties:

Name

Type

Summary

response

string

 

 


 

Category

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

name

string

 

 

description

string

 

 


 

EnterpriseBot

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

name

string

 

 

description

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

 


 

WebHookEx_Admin_NoMatch

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

webHookUri

string

 

 

secret

string

 

 

description

string

 

 

isPaused

boolean

 

 

filters

array of (string)

 

 

headers

Headers

 

 

properties

Properties

 

 

EnterpriseBot

string

Target Bot

Select the bot.

 

Headers

Summary:

Description:

 

          Properties:

Name

Type

Summary

 

Properties

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

WebHookEx_Admin_SkillModified

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

 


 

WebHookEx_Admin_UnlicensedUserAttempt

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