添加历史消息到流程引擎

POST

/openapi/workflow/history/batch-add

流程引擎会自动管理所有历史聊天的消息，当使用对话接口的时候，可以通过传入history数据来覆盖系统内的聊天历史，也可以不传history的方式调用，让系统自动维护聊天内容的上下文。而如果某些场景下，需要流程引擎来管理上下文，但是特殊的情况下需要额外增加一些历史消息（比如在自己的 App 内做了消息推送），为了确保流程引擎可以有完整的上下文信息，则需要通过某些方式将这些外部系统的消息也保存到流程引擎中，以此来确保流程引擎内生成回复的正确性。所以就有了这个接口的使用场景。

因为考虑到可能出现的批量推送消息的使用情况，因此这个接口的保存使用了批量的方式，可以通过传入一批数据来批量插入历史消息，增强接口的效率

批量上传的批处理数据上限为 500 条，如果超过这个数字，请分批调用接口来传入数据

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

botId

string

机器人 ID

必需

sessionData

array [object {2}]

会话消息数据

必需

sessionId

string

会话 ID

必需

messages

array [object {2}]

消息数据

必需

示例

{
  "botId": "string",
  "sessionData": [
    {
      "sessionId": "string",
      "messages": [
        {
          "role": "string",
          "content": {
            "type": "string",
            "text": "string"
          }
        }
      ]
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://insight.juzibot.com/openapi/workflow/history/batch-add' \
--header 'Content-Type: application/json' \
--data-raw '{
    "botId": "string",
    "sessionData": [
        {
            "sessionId": "string",
            "messages": [
                {
                    "role": "string",
                    "content": {
                        "type": "string",
                        "text": "string"
                    }
                }
            ]
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

code

number

返回码

必需

为 0 的时候则调用成功

示例

{
  "code": 0
}

获取流程引擎执行历史

触发流程引擎事件