クラウドBOT RESTful API Callback Endpoint 実装要件 (4.0)

Download OpenAPI specification:Download

BOT実行時にcallback_endpointパラメータにエンドポイントを指定する、またはBOT購読(イベントフック)を行うことで、実行結果をエンドポイント宛にPOSTすることが可能です。
本書は、Endpointの実装要件を取りまとめたものです。

リクエストペイロードにマルチバイト文字が含まれる場合はUTF-8として扱ってください。

POSTデータの受領

POSTされた実行結果を受領します。
受領後はレスポンスコード200で応答してください。
レスポンスコードを200系以外で応答した場合、コールバックPOSTのリトライが発生します。リトライは最短で30秒間隔で行われます。
コールバックPOSTのリトライが発生している間は、BOT稼働時間として加算されます。

header Parameters

content-type

required

string

Value: "application/json"

Request Body schema: application/json

code required	integer レスポンスコード
job_id required	string ジョブID
bot_id required	string BOT ID
bot_name required	string BOT名
status required	integer [ 0 .. 2 ] ステータス(0:正常終了 1:エラー 2:実行中)
start_time required	string <date-time> 実行を開始した時間(ISO 8601)
elapsed_time	integer 実行に要した秒数
	object (datalist_output) 出力値を表すオブジェクトです。
message	string メッセージ

Responses

Request samples

Payload

Content type

application/json

{"code": 201,
"job_id": "00000000-0000-0000-0000-000000000000",
"bot_id": "get_items",
"bot_name": "商品取得BOT",
"status": 0,
"start_time": "2019-12-02T05:30:13Z",
"elapsed_time": 6,
"output": {"件数": "2",
"商品": [{"商品名": "チーズケーキ",
"価格": "500",
"画像": {"type": "files",
"files": [{"ref": "jobs/00000000-0000-0000-0000-000000000000/files/00000000-0000-0000-0000-000000000000",
"meta": {"name": "0001.jpg",
"size": 603956,
"timestamp": 1513657350000
}
}
]
},
"タグ": ["ケーキ",
"チーズ"
]
},
{"商品名": "ガトーショコラ",
"価格": "600",
"画像": {"type": "files",
"files": [{"ref": "jobs/00000000-0000-0000-0000-000000000000/files/00000000-0000-0000-0000-000000000001",
"meta": {"name": "0002.jpg",
"size": 694475,
"timestamp": 1651024763990
}
}
]
},
"タグ": ["ケーキ",
"チョコレート"
]
}
]
}
}