AtBot Admin (Preview)

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

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Flow Standard All Flow regions except the following:
     -   US Government (GCC)
PowerApps Standard All PowerApps regions except the following:
     -   US Government (GCC)

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Add Licensed User

Add a user license.

Add Skill To Category

Add a skill by ID to a Category.

Broadcast bot message

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

Get License Status

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

Get Skill Categories

Get all skill categories defined in your tenant.

Redact bot message

Replace a bot message with a redaction message.

Remove a Skill from all Categories

Remove all Categorie references to a skill.

Remove Licensed User

Remove a user license.

Add Licensed User

Add a user license.

Parameters

Name Key Required Type Description
User ID
userId True string

Add a user license.

Returns

Add Skill To Category

Add a skill by ID to a Category.

Parameters

Name Key Required Type Description
Skill ID
id True string

Add a skill by ID to a Category.

Category
categoryId True string

Add a skill by ID to a Category.

Returns

Broadcast bot message

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

Parameters

Name Key Required Type Description
Broadcast message
message True string

The message to broadcast.

Target Bot
EnterpriseBot True string

Select the bot.

Specified users
users string

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.

Returns

Get License Status

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

Returns

Get Skill Categories

Get all skill categories defined in your tenant.

Returns

Redact bot message

Replace a bot message with a redaction message.

Parameters

Name Key Required Type Description
Message reference
messageRef True string

Message reference from chat transcripts.

Redaction message
redactionMessage True string

Type the message which will replace the bot message.

Returns

Remove a Skill from all Categories

Remove all Categorie references to a skill.

Parameters

Name Key Required Type Description
Skill ID
id True string

Remove all Categorie references to a skill.

Returns

Remove Licensed User

Remove a user license.

Parameters

Name Key Required Type Description
User ID
userId True string

Remove a user license.

Returns

Triggers

When a skill is created or modified

This operation triggers when a skill is created or updated.

When an unlicensed user attempts to use a bot

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

When the bot sends the default message to the user

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

When a skill is created or modified

This operation triggers when a skill is created or updated.

Parameters

Name Key Required Type Description
filters
filters string

This operation triggers when a skill is created or updated.

Returns

When an unlicensed user attempts to use a bot

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

Parameters

Name Key Required Type Description
filters
filters string

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

Returns

When the bot sends the default message to the user

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

Parameters

Name Key Required Type Description
filters
filters string

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

Target Bot
EnterpriseBot True string

Select the bot.

Returns

Definitions

Category

Name Path Type Description
id
id string
name
name string
description
description string

AdminAddSkillToCategoryPayload

Name Path Type Description
response
response string

AdminRemoveSkillCateoriesPayload

Name Path Type Description
response
response string

AdminQueryLicenseStatusPayload

Name Path Type Description
total-license-count
total-license-count integer
seats-taken
seats-taken integer
seats-available
seats-available integer

AdminAddRemoveLicensedUserPayload

Name Path Type Description
response
response string

AdminBroadcastMessagePayload

Name Path Type Description
response
response string

AdminRedactBotMessagePayload

Name Path Type Description
response
response string

NoMatchTriggerOutput

Name Path Type Description
User Name
userName string

User who sent the message.

Bot Name
botName string

Name of the bot.

Message Text
userMessage string

Message text the user sent that did not match.

Reply Activity
activityJson string

Activity Json.

SkillModifiedTriggerOutput

Name Path Type Description
Skill ID
skillId string

ID of the skill.

Skill Name
skillName string

Name of the skill.

User Name
userName string

User who created or updated the skill.

Category Count
categoryCount integer

Count of categories the skill is in. Will be 0 for uncategorized skills.

Category Json
categoryJSON string

Category Json.

Keyword Json
keywordJSON string

Keyword Json.

LUIS Intents Json
intentJSON string

LUIS Intents Json.

UnlicensedUserAttemptTriggerOutput

Name Path Type Description
User Name
userName string

User who sent the message.

Bot Name
botName string

Name of the bot.

Message Text
userMessage string

Message text the user sent that did not match.