句子 Insight
  1. 流程引擎
句子 Insight
  • 🍊 句子专属知识库
  • Insight Open API
    • Insight Open API
    • 对话
      • 对话接口
      • 开始语音通话
      • 结束语音通话
    • 流程引擎
      • 获取流程引擎事件列表
        GET
      • 获取流程引擎执行历史
        GET
      • 添加历史消息到流程引擎
        POST
      • 触发流程引擎事件
        POST
    • 知识库
      • 文档
        • 段落
          • 获取段落列表
          • 创建段落
          • 更新段落
          • 删除段落
        • 获取文档列表
        • 获取文档详情
        • 创建文档
        • 更新文档信息
        • 删除文档
        • 创建文档-自动分段
      • 网页
        • 创建网页-自动分段
      • 获取知识库列表
      • 获取知识库信息
      • 创建知识库
      • 更新知识库信息
      • 删除知识库
    • 回调接口
      • 点赞踩回调
    • 获取 access token
      POST
  1. 流程引擎

获取流程引擎执行历史

GET
/openapi/workflow/history/list
通过这个接口可以拉取流程引擎机器人的所有执行历史数据,其内容与调优中心页面上的内容一致
其中triggerType是一个枚举值,目前支持的有
枚举值说明
receive-text-message接收文本消息
receive-image-message接收图片消息
tag-event标签事件
new-friend新好友事件
canvas-event-trigger事件
actionType也是一个枚举值,如下
枚举值说明
send-text-message发送文本消息
send-image-message发送图片消息
tag-user打标签操作
invite-room邀请入群
canvas-event-action自定义流程事件
update-data赋值会话属性
plugin-action插件应用动作
handover转人工

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Query 参数
botId
string 
必需
拉取数据对应的机器人ID
startTimestamp
string 
必需
毫秒级时间戳,拉取数据的开始时间
endTimestamp
string 
必需
毫秒级时间戳,拉取数据的结束时间
page
string 
必需
示例值:
1
pageSize
string 
必需
示例值:
10
triggerType
string 
可选
筛选某个对应触发器的执行流程
示例值:
receive-text-message
actionType
string 
可选
筛选最终执行动作类型
示例值:
send-text-message
keyword
string 
可选

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://insight.juzibot.com/openapi/workflow/history/list?botId&startTimestamp&endTimestamp&page=1&pageSize=10&triggerType=receive-text-message&actionType=send-text-message&keyword'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
data
array [object {7}] 
必需
historyId
string 
历史记录id
必需
workflowName
string 
执行版本名
必需
当前历史记录执行的时候,使用的流程引擎对应版本的名字
workflowVersion
string 
执行版本
必需
当前历史记录执行的时候,使用的流程引擎的版本
sessionId
string 
会话ID
必需
会话ID,用来标识唯一的一个会话
createdAt
string 
创建时间
必需
当前历史记录执行的时间
triggerContent
object 
触发器内容
必需
当前历史记录的触发器
outputActions
array [object {2}] 
执行动作
必需
当前历史记录执行的若干动作,是一个数组
page
object 
必需
page
integer 
必需
total
integer 
必需
示例
{
  "code": 0,
  "data": [
    {
      "historyId": "string",
      "workflowName": "string",
      "workflowVersion": "string",
      "sessionId": "string",
      "createdAt": "string",
      "triggerContent": {
        "triggerType": "string",
        "content": {
          "text": "string"
        }
      },
      "outputActions": [
        {
          "type": "string",
          "payload": {
            "text": "string"
          }
        }
      ]
    }
  ],
  "page": {
    "page": 0,
    "total": 0
  }
}
上一页
获取流程引擎事件列表
下一页
添加历史消息到流程引擎
Built with