DocsICP FilingConsole
Documentation

CreateDialogueFlow

Updated at:
Copy as MD
Product
My Favorites

This legacy canvas API creates a dialogue flow.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

outboundbot:CreateDialogueFlow

create

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
InstanceId

string

Yes

The instance ID.

174952ab-9825-4cc9-a5e2-de82d7fa4cdd
DialogueName

string

Yes

The dialogue flow name.

主流程
ScriptId

string

Yes

The script ID.

d0bf93dd-1a54-4f00-819e-c75502d38681
DialogueFlowType

string

Yes

The type of the dialogue flow. Use MainFlow for a main flow or SubFlow for a subflow.

MainFlow

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

The HTTP status code.

200
RequestId

string

The request ID.

254EB995-DEDF-48A4-9101-9CA5B72FFBCC
DialogueFlowId

string

The dialogue flow ID.

390515b5-6115-4ccf-83e2-52d5bfaf2ddf
Success

boolean

Indicates whether the request was successful.

true
Code

string

The status code returned for the request.

OK
Message

string

The message returned by the request.

Success

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "DialogueFlowId": "390515b5-6115-4ccf-83e2-52d5bfaf2ddf",
  "Success": true,
  "Code": "OK",
  "Message": "Success"
}

Error codes

HTTP status code

Error code

Error message

Description
400 InvalidDialogueFlowName.Duplicated The specified DialogueFlowName already exists.
500 InternalError An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.
404 NotExist.Instance The specified Instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.