Connectors Reference

AtBot Admin

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

 

Actions:

Name

Summary

WebHookRegistrations_Delete (string id, string pid)

Delete webhook

Admin_RedactBotMessage (AdminRedactBotMessageInfo content)

Redact bot message

ListAdminItemTypesForGet ()

Get Admin Item Types for Read

ListAdminItemTypesForCreate ()

Get Admin Item Types for Create

ListAdminItemTypesForUpdate ()

Get Admin Item Types for Update

ListAdminItemTypesForDelete ()

Get Admin Item Types for Delete

GetAdminItem (integer type)

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

GetAdminItemById (integer type, string id)

Get Admin Item by Type and Id

DeleteAdminItem (integer type, string id)

Delete Admin Item by Type and Id

GenerateDynamicSchemaGetAdminItemOutput (integer type)

Get Admin Item Output Schema

GenerateDynamicSchemaCreateUpdateAdminItemOutput (integer type)

Create or Update Admin Item Output Schema

AdminItem_GetFieldsCreate (integer type)

Create Admin Item Field Schema

AdminItem_GetFieldsUpdate (integer type)

Update Admin Item Field Schema

ListSpeechRegions ()

List Speech Regions

 

Triggers:

Name

Summary

WebHookRegistrations_Post_SkillModified (WebHookEx_Admin_SkillModified webHook)

When a skill is created or modified

 

Objects:

Name

Summary

AdminItemType

 

AdminItem_GetFieldsCreateResponse

 

AdminItem_GetFieldsUpdateResponse

 

AdminRedactBotMessageInfo

 

AdminRedactBotMessagePayload

 

CreateAdminItemParameterContent

 

DynamicSchemaCreateUpdateAdminItemOutput

 

DynamicSchemaGetAdminItemOutput

 

GenerateDynamicSchemaCreateUpdateAdminItemOutputResponse

 

GenerateDynamicSchemaGetAdminItemOutputResponse

 

SpeechRegion

 

UpdateAdminItemParameterContent

 

WebHook

 

WebHookEx_Admin_SkillModified

 

 

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:

 

Admin_RedactBotMessage

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

AdminRedactBotMessageInfo

 

 

True

 

Returns:

          Type:AdminRedactBotMessagePayload

 

ListAdminItemTypesForGet

Summary: Get Admin Item Types for Read

Description: Get all Admin Item Types for Read

 

Syntax:

AtBotAdmin.ListAdminItemTypesForGet ()

 

Returns:

          Type:array of (AdminItemType)

 

ListAdminItemTypesForCreate

Summary: Get Admin Item Types for Create

Description: Get all Admin Item Types for Create

 

Syntax:

AtBotAdmin.ListAdminItemTypesForCreate ()

 

Returns:

          Type:array of (AdminItemType)

 

ListAdminItemTypesForUpdate

Summary: Get Admin Item Types for Update

Description: Get all Admin Item Types for Update

 

Syntax:

AtBotAdmin.ListAdminItemTypesForUpdate ()

 

Returns:

          Type:array of (AdminItemType)

 

ListAdminItemTypesForDelete

Summary: Get Admin Item Types for Delete

Description: Get all Admin Item Types for Delete

 

Syntax:

AtBotAdmin.ListAdminItemTypesForDelete ()

 

Returns:

          Type:array of (AdminItemType)

 

GetAdminItem

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

ListAdminItemTypesForGet

 

Returns:

          Type:array of (DynamicSchemaGetAdminItemOutput)

 

CreateAdminItem

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

ListAdminItemTypesForCreate

content

CreateAdminItemParameterContent

 

 

True

 

Returns:

          Type:DynamicSchemaCreateUpdateAdminItemOutput

 

UpdateAdminItem

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

ListAdminItemTypesForUpdate

content

UpdateAdminItemParameterContent

 

 

True

 

Returns:

          Type:array of (DynamicSchemaCreateUpdateAdminItemOutput)

 

GetAdminItemById

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

ListAdminItemTypesForGet

id

string

(Admin Item Id)

Provide the Id of item to get. Type NA when retrieving Logging and Settings

True

 

Returns:

          Type:DynamicSchemaGetAdminItemOutput

 

DeleteAdminItem

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

ListAdminItemTypesForDelete

id

string

(Admin Item Id)

Provide the Id of item to delete.

True

 

Returns:

 

GenerateDynamicSchemaGetAdminItemOutput

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

 

GenerateDynamicSchemaCreateUpdateAdminItemOutput

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

 

AdminItem_GetFieldsCreate

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

 

AdminItem_GetFieldsUpdate

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

 

ListSpeechRegions

Summary: List Speech Regions

Description: List suppported speech regions.

 

Syntax:

AtBotAdmin.ListSpeechRegions ()

 

Returns:

          Type:array of (SpeechRegion)

 

Triggers:

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

 


 

AdminItemType

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

 

value

integer(int32)

 

 


 

AdminItem_GetFieldsCreateResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

AdminItem_GetFieldsUpdateResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

AdminRedactBotMessageInfo

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.


 

AdminRedactBotMessagePayload

Summary:

Description:

 

          Properties:

Name

Type

Summary

response

string

 

 


 

CreateAdminItemParameterContent

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

DynamicSchemaCreateUpdateAdminItemOutput

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

DynamicSchemaGetAdminItemOutput

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GenerateDynamicSchemaCreateUpdateAdminItemOutputResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GenerateDynamicSchemaGetAdminItemOutputResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

SpeechRegion

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

 

 

name

string

 

 


 

UpdateAdminItemParameterContent

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

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_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