TriggerChatFlow - 触发已上线的流程版本

触发已上线且触发器类型为手动的流程版本。

接口说明

  • 您可调用此接口触发已上线且触发器类型为手动的流程版本,也可在营销活动管理界面通过营销活动关联的触发器类型为手动的流程进行流程触发。

  • 在调用此接口之前,请确保您创建的流程触发器类型为手动且状态为已上线。

  • 若您创建的触发器类型为手动的流程没有状态为已上线的版本,可在流程编辑器界面单击流程名称进入画布编排界面手动上线流程版本或通过 OnlineFlowVersion 接口上线流程版本。

  • 触发已上线的流程后,若您的流程含有消息发送、函数调用等产生对应云产品费用的组件,请确保在使用该接口前,已充分了解相关产品的收费方式和价格。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

FlowCode

string

流程编码。在流程编辑器界面查看流程编码。

9ccc41**************************

Data

object

入参,Key-Value 格式,其 Key 需要与您在流程开始节点配置的入参策略相匹配。在流程编辑器界面单击触发器类型为手动的流程名称进入画布编排界面查看开始节点的变量名称。

{ "my_biz_data_0": "hi", "my_biz_data_1": "1024" }

Uuid

string

自定义事件唯一 ID,用于触发幂等,请勿携带任何业务语义,触发后您可以在流程中获取到此参数。

c68622e6-5f0d-c8a4-af41-e949c2a7580e

OutId

string

自定义外部系统流水号,用于关联外部业务系统流水,触发后您可以在流程中获取到此参数。

8d4acf7e-e360-eb83-6d74-fcf9c4538fda

ClaimTimeMillis

integer

声明事件发生时刻,即为流程触发时刻,一般为请求构造时刻,时间戳,单位:毫秒。

1731502129000

DiscardTimeMillis

integer

声明事件被丢弃时刻,即为触发流程的过期时刻,若声明了该字段,发起请求后响应时间超过此时刻,流程触发将被取消,时间戳,单位:毫秒。

1731502729000

无。

返回参数

名称

类型

描述

示例值

object

AccessDeniedDetail

string

权限校验失败详情。

None

RequestId

string

请求 ID。

90E63D28-E31D-1EB2-8939-A94866411B2O

Message

string

错误描述信息。

None

Data

object

返回数据。

Code

string

状态码。

OK

Success

boolean

是否调用成功。取值:

  • true:调用成功。

  • false:调用失败。

true

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Message": "None",
  "Data": {
    "test": "test",
    "test2": 1
  },
  "Code": "OK",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情