AtBot is a no-code bot building service that allows you to create conversational UIs quickly without any programming experience. The Admin connector provides programmatic access to the configuration portal.
Status: Preview |
Tier: Standard |
Version: 2.2.0 |
Name |
Summary |
Delete webhook |
|
Redact bot message |
|
Get Admin Item Types for Read |
|
Get Admin Item Types for Create |
|
Get Admin Item Types for Update |
|
Get Admin Item Types for Delete |
|
Get Admin Items by Type |
|
CreateAdminItem (integer type, CreateAdminItemParameterContent content) |
Create Admin Item by Type |
UpdateAdminItem (integer type, UpdateAdminItemParameterContent content) |
Update Admin Item by Type and Id |
Get Admin Item by Type and Id |
|
Delete Admin Item by Type and Id |
|
Get Admin Item Output Schema |
|
GenerateDynamicSchemaCreateUpdateAdminItemOutput (integer type) |
Create or Update Admin Item Output Schema |
Create Admin Item Field Schema |
|
Update Admin Item Field Schema |
|
List Speech Regions |
Name |
Summary |
WebHookRegistrations_Post_SkillModified (WebHookEx_Admin_SkillModified webHook) |
When a skill is created or modified |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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:
Summary: Redact bot message
Description: Replace a bot message with a redaction message.
Syntax:
AtBotAdmin.Admin_RedactBotMessage (AdminRedactBotMessageInfo content)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
content |
|
|
True |
Returns:
Type:AdminRedactBotMessagePayload
Summary: Get Admin Item Types for Read
Description: Get all Admin Item Types for Read
Syntax:
AtBotAdmin.ListAdminItemTypesForGet ()
Returns:
Type:array of (AdminItemType)
Summary: Get Admin Item Types for Create
Description: Get all Admin Item Types for Create
Syntax:
AtBotAdmin.ListAdminItemTypesForCreate ()
Returns:
Type:array of (AdminItemType)
Summary: Get Admin Item Types for Update
Description: Get all Admin Item Types for Update
Syntax:
AtBotAdmin.ListAdminItemTypesForUpdate ()
Returns:
Type:array of (AdminItemType)
Summary: Get Admin Item Types for Delete
Description: Get all Admin Item Types for Delete
Syntax:
AtBotAdmin.ListAdminItemTypesForDelete ()
Returns:
Type:array of (AdminItemType)
Summary: Get Admin Items by Type
Description: Get an Admin Items by Type
Syntax:
AtBotAdmin.GetAdminItem (integer type)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
type |
integer(int32) (Selected Type) |
Select the type of item to get. |
True |
Returns:
Type:array of (DynamicSchemaGetAdminItemOutput)
Summary: Create Admin Item by Type
Description: Create an Admin Item by Type
Syntax:
AtBotAdmin.CreateAdminItem (integer type, CreateAdminItemParameterContent content)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
type |
integer(int32) (Selected Type) |
Select the type of item to get. |
True |
|
content |
CreateAdminItemParameterContent
|
|
True |
Returns:
Type:DynamicSchemaCreateUpdateAdminItemOutput
Summary: Update Admin Item by Type and Id
Description: Update an Admin Item by Type and Id
Syntax:
AtBotAdmin.UpdateAdminItem (integer type, UpdateAdminItemParameterContent content)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
type |
integer(int32) (Selected Type) |
Select the type of item to get. |
True |
|
content |
UpdateAdminItemParameterContent
|
|
True |
Returns:
Type:array of (DynamicSchemaCreateUpdateAdminItemOutput)
Summary: Get Admin Item by Type and Id
Description: Get an Admin Item by Type and Id
Syntax:
AtBotAdmin.GetAdminItemById (integer type, string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
type |
integer(int32) (Selected Type) |
Select the type of item to get. |
True |
|
id |
string (Admin Item Id) |
Provide the Id of item to get. Type NA when retrieving Logging and Settings |
True |
Returns:
Type:DynamicSchemaGetAdminItemOutput
Summary: Delete Admin Item by Type and Id
Description: Delete an Admin Item by Type and Id
Syntax:
AtBotAdmin.DeleteAdminItem (integer type, string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
type |
integer(int32) (Selected Type) |
Select the type of item to delete. |
True |
|
id |
string (Admin Item Id) |
Provide the Id of item to delete. |
True |
Returns:
Summary: Get Admin Item Output Schema
Description: For internal use only.
Syntax:
AtBotAdmin.GenerateDynamicSchemaGetAdminItemOutput (integer type)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
type |
integer(int32) (Item Type) |
The Item Type. |
True |
Returns:
Type:GenerateDynamicSchemaGetAdminItemOutputResponse
Summary: Create or Update Admin Item Output Schema
Description: For internal use only.
Syntax:
AtBotAdmin.GenerateDynamicSchemaCreateUpdateAdminItemOutput (integer type)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
type |
integer(int32) (Item Type) |
The Item Type. |
True |
Returns:
Type:GenerateDynamicSchemaCreateUpdateAdminItemOutputResponse
Summary: Create Admin Item Field Schema
Description: For internal use only.
Syntax:
AtBotAdmin.AdminItem_GetFieldsCreate (integer type)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
type |
integer(int32) (Item Type) |
The Item Type. |
True |
Returns:
Type:AdminItem_GetFieldsCreateResponse
Summary: Update Admin Item Field Schema
Description: For internal use only.
Syntax:
AtBotAdmin.AdminItem_GetFieldsUpdate (integer type)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
type |
integer(int32) (Item Type) |
The Item Type. |
True |
Returns:
Type:AdminItem_GetFieldsUpdateResponse
Summary: List Speech Regions
Description: List suppported speech regions.
Syntax:
AtBotAdmin.ListSpeechRegions ()
Returns:
Type:array of (SpeechRegion)
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 |
|
|
True |
Returns:
Type:WebHook
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
|
value |
integer(int32)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
messageRef |
string Message reference |
Message reference from chat transcripts. |
redactionMessage |
string Redaction message |
Type the message which will replace the bot message. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
response |
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 |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32)
|
|
name |
string
|
|
Summary:
Description:
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 |
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 |