All Products
Search
Document Center

:TriggerChatFlow

Last Updated:Nov 18, 2024
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Trigger an Online ChatFlow

Operation description

After triggering an online flow, if your flow contains components that incur costs for cloud products, such as message sending or function calls, please ensure you fully understand the billing methods and prices of the related products before using this interface.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
FlowCodestringYes

Flow code.

f4912c16943b4dfba44bd6fedacf8c70
DataobjectNo

Input parameters in Key-Value format. The Key must match the input strategy configured at the start node of your flow.

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

Unique event ID used for idempotent triggers. Do not include any business semantics; you can retrieve this parameter within the flow after triggering.

c68622e6-5f0d-c8a4-af41-e949c2a7580e
OutIdstringNo

External system transaction number, used to associate with external business system transactions. You can retrieve this parameter within the flow after triggering.

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

The declared occurrence time of the event, usually the time when the request was constructed, in milliseconds timestamp.

1731502129000
DiscardTimeMillislongNo

The time when the event should be discarded, i.e., the expiration time. If this field is specified, the message will be discarded if it exceeds this time, in milliseconds timestamp.

1731502729000

None.

Response parameters

ParameterTypeDescriptionExample
object
AccessDeniedDetailstring

Details of access denial

RequestIdstring

Request ID.

Messagestring

Error description message.

Dataobject

Returned data.

{}
Codestring

Status code.

Successboolean

Whether the call was successful.

  • true: Call succeeded.
  • false: Call failed.
true

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.