ListDialogueFlows-阿里云帮助中心

Queries the dialogue flows of a script in the legacy canvas.

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:ListDialogueFlows

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	b5b0a30f-69e7-4147-98b5-553fc526361d
ScriptId	string	Yes	The script ID.	d7c28efb-47f7-4a85-a522-5038e30a0b98

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
Code	string	The status code.	OK
Message	string	The response message.	Success
RequestId	string	The request ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates whether the request succeeded. true: The request succeeded. false: The request failed.	true
DialogueFlows	array<object>	A list of dialogue flows.
	object	A dialogue flow.
DialogueFlowDefinition	string	The dialogue flow data, formatted as a JSON string.	{"transitions":[{"source":"cc31e02b","sourceAnchor":0,"target":"345700de","targetAnchor":0,"id":"16d37c6e","index":1}],"nodes":[{"shape":"start-html","type":"start","size":"17034","x":180,"y":134,"id":"cc31e02b","index":0,"nodeIndex":0,"content":{"branches":[{"branchName":"发起对话","branchId":"3c50a880-a7bc-11e9-80fc-5917e4f31864"}]},"coordinates":{"x":180,"y":134}},{"shape":"function-html","type":"transfer","size":"17034","x":606,"y":134,"id":"345700de","nodeIndex":1,"name":"功能节点","script":"你是 @name ma","content":{"action":"Hangup","actionParams":"","label":["test1","test2","test3","test4","test5"]},"coordinates":{"x":606,"y":134},"index":2,"questions":["你是 @联系人姓名 ma"]}]}
DialogueFlowType	string	The flow type. `SubFlow`: The subflow. `MainFlow`: The main flow.	MainFlow
DialogueFlowId	string	The dialogue flow ID.	dae01529-3c3e-458e-b07a-97643d09ebb9
DialogueFlowName	string	The dialogue flow name.	主流程
ScriptId	string	The outbound script ID.	2d5aa451-661f-4f08-b0c4-28eec78decc4
ScriptVersion	string	The script version.	1569220563549

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "DialogueFlows": [
    {
      "DialogueFlowDefinition": "{\"transitions\":[{\"source\":\"cc31e02b\",\"sourceAnchor\":0,\"target\":\"345700de\",\"targetAnchor\":0,\"id\":\"16d37c6e\",\"index\":1}],\"nodes\":[{\"shape\":\"start-html\",\"type\":\"start\",\"size\":\"170*34\",\"x\":180,\"y\":134,\"id\":\"cc31e02b\",\"index\":0,\"nodeIndex\":0,\"content\":{\"branches\":[{\"branchName\":\"发起对话\",\"branchId\":\"3c50a880-a7bc-11e9-80fc-5917e4f31864\"}]},\"coordinates\":{\"x\":180,\"y\":134}},{\"shape\":\"function-html\",\"type\":\"transfer\",\"size\":\"170*34\",\"x\":606,\"y\":134,\"id\":\"345700de\",\"nodeIndex\":1,\"name\":\"功能节点\",\"script\":\"你是 @name ma\",\"content\":{\"action\":\"Hangup\",\"actionParams\":\"\",\"label\":[\"test1\",\"test2\",\"test3\",\"test4\",\"test5\"]},\"coordinates\":{\"x\":606,\"y\":134},\"index\":2,\"questions\":[\"你是 @联系人姓名 ma\"]}]}",
      "DialogueFlowType": "MainFlow",
      "DialogueFlowId": "dae01529-3c3e-458e-b07a-97643d09ebb9",
      "DialogueFlowName": "主流程",
      "ScriptId": "2d5aa451-661f-4f08-b0c4-28eec78decc4",
      "ScriptVersion": "1569220563549"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
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.
404	NotExist.Script	The specified Script does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.