API

大致上跟下面網址API一致

API密鑰產生後，可以複製密鑰，並在Header的Authorization帶入'Bearer ' + {{token}}即可，注意產生密鑰後查看請複製該密鑰，十五分鐘後將會無法再查詢到。

DMflow 機器人API | DMflow | DMflow Docs On-premisedocs.communeify.com

另新增

閒聊角色

更新產品

PATCH /_api/v1/roleqa/product/info/{id}

HEADER KEY	HEADER VALUE
Authorization	{{auth}}

REQUEST JSON

{
	"title": "",
	"description": "",
	"rating": 0.0f,
	"enabled": false
}

REQUEST_PATH	必填	型態	說明
title		string	若填寫則會覆蓋
description		string	若填寫則會覆蓋
rating		number	0~5
enabled		boolean	是否

RESPONSE JSON

{
	"rc" : 0
}

表單問答

查詢表單

POST /_api/v1/formqa/search

HEADER KEY	HEADER VALUE
Authorization	{{auth}}

REQUEST JSON

{
	"id": "",
	"tableId": "",
	"index": 0,
	"onlyReturnCount": false,
	"wheres": [{
			"name": "",
			"compare": "",
			"value": ""
		}
	]
}

REQUEST_PATH	必填	型態	說明
id		string	主鍵ID，有ID將不會理會wheres
tableId		string	表單ID
index		number	頁碼
onlyReturnCount		boolean	是否只要count
wheres		array	conditions
wheres[0].name		string	欄位鍵(不能使用於text欄位)
wheres[0].compare		enum	eq(關鍵字使用eq等同in), gt, lt, lte, gte
wheres[0].value		string	如果是日期欄位請使用(秒數)，數字則請用數字

暫時不支援order以及size，預設每次size為20

RESPONSE JSON

{
	"rc" : 0
	"error": "",
	"data": {
		"total_element": 0,
		"docs": []
	}
}

表單觸發動作

POST /_api/v1/formqa/action

Trigger action API限制每個trigger每小時執行100次包含(迴圈次數)，但不會因為100次而停止，假設已經運行了99次，最後一次如果有100次包含迴圈則仍會執行最後一次，而不是執行一半停止。

HEADER KEY	HEADER VALUE
Authorization	{{auth}}

REQUEST JSON

{
	"parameters": {},
	"triggerId": "",
	"tableId": "",
	"guestId": ""
}

REQUEST_PATH	必填	型態	說明
parameters		object	{ "product": "產品名", "price": 200, "quantity": 5 }
triggerId		string	觸發器ID
tableId		string	表單ID
guestId		string	匿名使用者ID

RESPONSE JSON

{
	"rc" : 0
	"error": "",
	"data": {
		"error": false,
		"success": true,
		"response": ""
	}
}

data.error 代表觸發器觸發了錯誤節點

data.success 代表觸發器成功抵達END節點

rc不為零為錯誤訊息，此錯誤可能是因為API KEY不對，或是參數不正確，而error是告知你為何錯誤。

使用須知

目前伺服器採用使用才啟動，若第一次呼叫API可能會需要一點時間，但後面就會恢復正常時間。

已棄用

/_api/v1/bot/chat