Cloud BOT

Cloud BOT is a new web browser automation tool born in Japan. Create and run your own robots easily and safely without any installation.

Status: Preview

Tier: Premium

Version: 1.0

Actions:

Name	Summary
IndexOfContracts (string x-cbot-content-language, [internal]string properties, [internal]string x-cbot-content-type)	Index of Contracts
IndexOfBots (string x-cbot-content-language, string public_id, [internal]string properties, [internal]string x-cbot-content-type)	Index Of Bots
BotDetail (string x-cbot-content-language, [internal]string properties, string public_id, string bot_id, [internal]string x-cbot-content-type)	Get BOT Details
ExecuteBot (string x-cbot-content-language, string public_id, string bot_id, [internal]string x-cbot-content-type, ExecuteBotParameterBody body)	Execute BOT
UnsubscribeOfTrigger (string public_id, string bot_id, string subscribe_id)	Unsubscribe the Trigger

Triggers:

Name	Summary
BotDone (string x-cbot-content-language, string public_id, string bot_id, [internal]string x-cbot-content-type, BotDoneParameterBody body)	When BOT execution is completed

Objects:

Name	Summary
BotDetailResponse
BotDoneParameterBody
BotDoneResponse
ExecuteBotParameterBody
ExecuteBotResponse
IndexOfBotsResponse
IndexOfContractsResponse
UnsubscribeOfTriggerResponse

Actions:

IndexOfContracts

Summary: Index of Contracts

Description: Get Index of Contracts

Syntax:

CloudBOT.IndexOfContracts (string x-cbot-content-language, [internal]string properties, [internal]string x-cbot-content-type)

Parameters:

Name	Type	Summary	Required	Related Action
x-cbot-content-language	string (Language)Values: [ja, en]		True
properties	string		True
x-cbot-content-type	string		True

Returns:

Type:IndexOfContractsResponse

IndexOfBots

Summary: Index Of Bots

Description: Get Index of Bots

Syntax:

CloudBOT.IndexOfBots (string x-cbot-content-language, string public_id, [internal]string properties, [internal]string x-cbot-content-type)

Parameters:

Name	Type	Summary	Required	Related Action
x-cbot-content-language	string (Language)Values: [ja, en]		True
public_id	string (Contract)		True	IndexOfContracts
properties	string		True
x-cbot-content-type	string		True

Returns:

Type:IndexOfBotsResponse

BotDetail

Summary: Get BOT Details

Description: Get BOT Details

Syntax:

CloudBOT.BotDetail (string x-cbot-content-language, [internal]string properties, string public_id, string bot_id, [internal]string x-cbot-content-type)

Parameters:

Name	Type	Summary	Required	Related Action
x-cbot-content-language	string (Language)Values: [ja, en]		True
properties	string		True
public_id	string (Contract)		True	IndexOfContracts
bot_id	string (BOT)		True	IndexOfBots
x-cbot-content-type	string		True

Returns:

Type:BotDetailResponse

ExecuteBot

Summary: Execute BOT

Description: Execute your BOT. (The API must be enabled and the BOT must be published on Cloud BOT website.)

Syntax:

CloudBOT.ExecuteBot (string x-cbot-content-language, string public_id, string bot_id, [internal]string x-cbot-content-type, ExecuteBotParameterBody body)

Parameters:

Name	Type	Summary	Required	Related Action
x-cbot-content-language	string (Language)Values: [ja, en]	Language	True
public_id	string (Contract)	Contract	True	IndexOfContracts
bot_id	string (BOT)	BOT	True	IndexOfBots
x-cbot-content-type	string		True
body	ExecuteBotParameterBody		True

Returns:

Type:ExecuteBotResponse

UnsubscribeOfTrigger

Summary: Unsubscribe the Trigger

Description: Unsubscribe the Trigger

Syntax:

CloudBOT.UnsubscribeOfTrigger (string public_id, string bot_id, string subscribe_id)

Parameters:

Name	Type	Summary	Required	Related Action
public_id	string	public_id	True
bot_id	string	bot_id	True
subscribe_id	string	subscribe_id	True

Returns:

Type:UnsubscribeOfTriggerResponse

Triggers:

Trigger BotDone

Summary: When BOT execution is completed

Description: Triggers when a BOT at the end of execution. (The API must be enabled and the BOT must be published on Cloud BOT website.)

Syntax:

CloudBOT.BotDone (string x-cbot-content-language, string public_id, string bot_id, [internal]string x-cbot-content-type, BotDoneParameterBody body)

Parameters:

Name	Type	Summary	Required	Related Action
x-cbot-content-language	string (Language)Values: [ja, en]	Language	True
public_id	string (Contract)	Contract	True	IndexOfContracts
bot_id	string (BOT)	BOT	True	IndexOfBots
x-cbot-content-type	string		True
body	BotDoneParameterBody		True

Returns:

Type:BotDoneResponse

BotDetailResponse

Summary:

Description:

Properties:

Name	Type	Summary
code	integer(int32)	code
id	string	id
name	string	name
description	string	description
icon	string	icon
created	string	created
last_modified	string	last_modified
creator	string	creator
input	Input	input
output	Output	output

Input

Summary:

Description: input

Properties:

Name

Type

Summary

Output

Summary:

Description: output

Properties:

Name

Type

Summary

BotDoneParameterBody

Summary:

Description:

Properties:

Name

Type

Summary

event

string

event

callback_endpoint

string

callback_endpoint

BotDoneResponse

Summary:

Description:

Properties:

Name	Type	Summary
code	integer(int32)	code
subscribe_id	integer(int32)	subscribe_id
unsubscribe_endpoint	string	unsubscribe_endpoint

ExecuteBotParameterBody

Summary:

Description:

Properties:

Name	Type	Summary
async	boolean Async	Async Values: [, ]
data1	string Data1	Data1
data2	string Data2	Data2
data3	string Data3	Data3
data4	string Data4	Data4
data5	string Data5	Data5
data6	string Data6	Data6
data7	string Data7	Data7
data8	string Data8	Data8
data9	string Data9	Data9
data10	string Data10	Data10
api_parameters	string API Parameters	API Parameters

ExecuteBotResponse

Summary:

Description:

Properties:

Name	Type	Summary
code	integer(int32) code
job_id	string job_id
bot_id	string bot_id
bot_name	string bot_name
status	integer(int32) status
start_time	string start_time
elapsed_time	integer(int32) elapsed_time
output	Output	output
callback	boolean	callback
message	string message

Output

Summary:

Description: output

Properties:

Name	Type	Summary
data1	string Data1
data2	string Data2
data3	string Data3
data4	string Data4
data5	string Data5
data6	string Data6
data7	string Data7
data8	string Data8
data9	string Data9
data10	string Data10
output_json	string OutputJSON

IndexOfBotsResponse

Summary:

Description:

Properties:

Name

Type

Summary

code

integer(int32)

code

bots

array of (BotsItem)

bots

BotsItem

Summary:

Description:

Properties:

Name	Type	Summary
id	string	id
name	string	name
description	string	description
icon	string	icon
created	string	created
last_modified	string	last_modified
creator	string	creator

IndexOfContractsResponse

Summary:

Description:

Properties:

Name

Type

Summary

code

integer(int32)

code

contracts

array of (ContractsItem)

contracts

ContractsItem

Summary:

Description:

Properties:

Name	Type	Summary
public_id	string	public_id
public_path	string	public_path
plan	string	plan
owner	string	owner
timezone	string	timezone
country	string	country
name	string	name
organization	string	organization
postcode	string	postcode
address	string	address
phone	string	phone
department	string	department
username	string	username

UnsubscribeOfTriggerResponse

Summary:

Description:

Properties:

Name

Type

Summary

code

integer(int32)

code