全部产品
Search
文档中心

Chat App 消息服务:TriggerChatFlow - 触发已上线的Flow

更新时间:Nov 18, 2024

触发已上线的ChatFlow。

接口说明

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

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
FlowCodestring

流程编码。

f4912c16943b4dfba44bd6fedacf8c70
Dataobject

入参,Key-Value 格式,其 Key 需要与您在流程开始节点配置的入参策略相匹配。

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

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

c68622e6-5f0d-c8a4-af41-e949c2a7580e
OutIdstring

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

8d4acf7e-e360-eb83-6d74-fcf9c4538fda
ClaimTimeMillislong

声明的事件发生时刻,一般为请求构造时刻,毫秒时间戳。

1731502129000
DiscardTimeMillislong

事件应该被丢弃的时刻,即过期时刻。如果声明了改字段,超出此时刻将丢弃该消息,毫秒时间戳。

1731502729000

无。

返回参数

名称类型描述示例值
object
AccessDeniedDetailstring

权限校验失败详情

RequestIdstring

请求 ID。

Messagestring

错误描述信息。

Dataobject

返回数据。

{}
Codestring

状态码。

Successboolean

是否调用成功。

  • true:调用成功。
  • false:调用失败。
true

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "无",
  "RequestId": "无",
  "Message": "无",
  "Data": {},
  "Code": "无",
  "Success": true
}

错误码

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