调用DescribeDialogFlow接口获得会话流详情

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDialogFlow

系统规定参数。取值:DescribeDialogFlow。

DialogId Long 49966

对话流id

返回数据

名称 类型 示例值 描述
AccountId String 133208

账户Id

CreateTime String 2020-11-29 14:50:47

会话流创建时间

CreateUserId String 83225

创建者id

CreateUserName String 83225

创建者昵称

DialogId Long 49966

会话流Id

DialogName String 示例_查天气

对话流名称

GlobalVars Map {"name": "", "age": ""}

⾃定义全局变量和默认 值,⽐如⾃定义变量名称 为“name”和“age”, 则GlobalVar对象为 {"name": "", "age": ""}

InstanceId String 机器人Id

机器人Id

ModifyTime String 2020-12-01 11:17:51

会话流修改时间

ModifyUserId String 83225

修改者Id

ModifyUserName String null

修改者昵称

ModuleDefinition Struct

会话定义信息

Edges Array of Edges

对话流节点连线对象

Id String dcb56361

连线Id

Label String 节点连线的标记名字

节点连线的标记名字,自定义字符串,一般在判断节点后的联系都有标记,与判断条件对应。

Source String d3724d34-711c-4468-bbca-69e714060457

起始节点

Target String 1410-a5c531c3

目标节点

Nodes Array of Nodes

节点集合

Code String 节点类型

节点类型,分为start, entry,function,response四种

ComponentCode String 节点类型

节点类型,分为start, entry,function,response四种

Id String UUID

节点ID,取值为UUID

Label String 节点名称

节点名称

PluginData Struct

插件数据对象

Entry Struct

意图开启节点

PluginFieldDataEntry Struct

意图开启节点数据

ContentEntry Array of ContentEntry

数据内容

ConditionEntries Array of ConditionEntries

事件开启条件说明

Id String 126179

意图Id

Name String 参考描述

当条件为意图时,Value的值为意图名称。当条件为实体时,Name为实体类型名称,Value为实体值。

Term String Intent

识别项,此处为意图code

Type String ==

开启条件,此处为 "=="

Value String 查天气意图

当条件为意图时,Value的值为意图名称。当条件为实体时,Name为实体类型名称,Value为实体值。

LifeSpan Integer 5

在一次对话内的意图残留周期

Name String 查天气

意图名称

Function Struct

函数节点

PluginFieldDataFunction Struct

函数节点数据

AliyunFunction String 阿里云函数名称

阿里云函数名称

AliyunService String 阿里云函数服务

阿里云函数服务

Code String 函数代码

函数代码

Description String 函数描述

函数描述

EndPoint String 阿里云函数所在地域

阿里云函数所在地域

Function String HTTP

内置函数类型,此处为http

Name String 调用查天气API

函数节点名称

Params Map 参考JSON示例

函数参数

Switch Array of Switch

函数路由开头,可做路由使用

Id String 条件Id

条件Id

Label String 对应条件的后继连线的Label

对应条件的后继连线的Label

Name String routeVariable

分支变量的名称,值固定为routeVariable

Type String 操作符类型

操作符类型

Value String 条件的值

条件的值

Type String BuiltIn

函数类型,分为内置函数与阿里云函数

Response Struct

回复节点

PluginFieldDataResponse Struct

回复节点数据

ContentResponse Struct

回复节点内容

ButtonList Struct

回复按钮列表

Button Array of Button

按钮对象

Name String 按钮名称

按钮名称

Text String 按钮显示文本

按钮显示文本

Type String 按钮类型

按钮类型

Intro String 按钮描述信息

按钮描述信息

Image String 这个类型已下线

这个类型已下线

Text String 参考JSON示例

纯文本回复内容

Type String Text

回复类型

Name String 查天气回复

回复节点名称

Slot Struct

填槽节点

PluginFieldDataSlot Struct

填槽节点数据

ContentSlot Array of ContentSlot

填槽节点内容

IsArray Boolean false

是否数组

IsNecessary Boolean true

是否必填节点

LifeSpan Integer 5

填槽残留周期,可理解为反问次数

Name String city

槽位名称

Question List 参考JSON示例

槽位反问话术

Value String @sys.geo-city

槽位对应实体代码,“@${专有名词名称}”,@符号必传

IntentId String 126179

槽位对应意图ID

IntentName String 查天气意图

槽位对应意图名称//TODO,通过intentId取

IsSysIntent Boolean false

是否系统意图

Name String 查天气填槽

意图名称

PluginDataUpdate Boolean false

节点数据更新

Xx String 300

节点横坐标位置

Yy String 100

节点纵坐标位置

ModuleId Long 49162

会话模块Id

ModuleName String 示例_查天气

会话模块名称

RequestId String 0226F0F9-5F80-4331-A8CD-459AE93DA541

请求id

Status Integer 8

状态:3:草稿;6:已发布;8:下线

Tags String 表述划词

表述划词,见意图api

Templates String 模板信息

模板信息

返回结构参照Dialogs

返回参数

参数类型

参数说明

DialogId

Long

会话Id

DialogName

String

会话Name

Description

String

会话描述

GmtCreate

Date

创建时间

GmtModified

Date

修改时间

CreatorId

String

创建者Id

CreatorNick

String

创建者名称

ModifierId

String

修改者Id

ModifierNick

String

修改者名称

IsSampleDialog

Boolean

标识内置样例对话流:true:是,false:否

Status

Integer

状态:1:草稿,3:沙箱

IsOnline

Boolean

是否上线:true:上线,false:未上线

DialogFlowDefinition

参数名

类型

是否必填

描述

GlobalVars

Map<String, String>

自定义全局变量和默认值,比如自定义变量名称为“name”和“age”,则GlobalVar对象为 {"name": "", "age": ""}

ProcessData

ProcessData

对话流描述数据

DialogFlowDefinition->ProcessData

参数名

类型

是否必填

描述

Nodes

Array of Node

节点集合

Edges

Array of Edge

对话流节点连线对象

ProcessData->Edge

参数名

类型

是否必填

描述

Id

String

连线Id,UUID

Source

String

起始节点id

Target

String

目标节点id

ProcessData->Node

参数名

类型

是否必填

描述

Code

String

节点类型,分为start:开始节点, entry:触发节点,response:回复节点,function:函数节点,slot:填槽节点,五种

Id

String

节点ID,取值为UUID

Label

String

节点名称

X

float

节点横坐标位置

Y

float

节点纵坐标位置

PluginData

PluginData

插件数据对象

Node->PluginData

参数名

类型

是否必填

描述

Entry

Entry

触发节点

Slot

Slot

填槽节点

Response

Response

回复节点

Function

Function

函数节点

PluginData->Entry

参数名

类型

是否必填

描述

PluginFieldData

PluginFieldData

节点数据

Entry->PluginFieldData

参数名

类型

是否必填

描述

Content

Array of Content

时间开启条件:每条数据间是或的关系;

LifeSpan

Integer

在一次对话内的意图残留周期,默认5

Entry->PluginFieldData->Content

参数名

类型

是否必填

描述

ConditionEntries

Array of ConditionEntry

事件开启条件:每条件是并且的关系

Entry->PluginFieldData->Content->ConditionEntry

参数名

类型

是否必填

描述

Id

String

意图Id ,专有名词Id,全局变量为空

Term

String

识别项,此处为意图code,意图:Intent ,专有名词:Entities,系统变量:Global

Type

String

开启条件,此处为 "=="

Value

String

开启意图的名称

PluginData->Slot

参数名

类型

是否必填

描述

PluginFieldData

PluginFieldData

节点数据

Slot->PluginFieldData

参数名

类型

是否必填

描述

content

Array of Content

JsonList

填槽节点内容

intentId

String

槽位对应意图ID

intentName

String

槽位对应意图名称//TODO,通过intentId取

Slot->PluginFieldData->Content

参数名

类型

是否必填

描述

Id

String

槽位ID

IsArray

Boolean

是否数组

IsNecessary

Boolean

是否必填节点

LifeSpan

Integer

填槽残留周期,可理解为反问次数

name

String

槽位名称 //TODO

question

Array String

槽位反问话术

value

String

槽位对应实体代码,“@${专有名词名称}”,@符号必传 //TODO

Tags

Array of Tag

表述划词,见意图api //TODO

PluginData->Response

参数名

类型

是否必填

描述

PluginFieldData

PluginFieldData

节点数据

Response->PluginFieldData

参数名

类型

是否必填

描述

content

Content

回复节点内容

Response->PluginFieldData->Content

参数名

类型

是否必填

描述

Text

String

纯文本回复内容

Type

String

回复类型:Text:纯文本

PluginData->Function

参数名

类型

是否必填

描述

PluginFieldData

PluginFieldData

节点数据

Function->PluginFieldData

参数名

类型

是否必填

描述

AliyunFunction

String

阿里云函数名称(公有云)

AliyunService

String

阿里云函数服务(公有云)

EndPoint

String

阿里云函数所在地域(公有云)

Description

String

函数描述

Code

String

函数代码(私有云)

Function

String

内置函数类型,此处为HTTP

Type

String

函数类型,分为BuiltIn:阿里云函数,Customized:内置函数

Switch

Array of Switch

函数路由开头,可做路由使用

Params

Param

函数参数

Function->PluginFieldData->Switch

参数名

类型

是否必填

描述

Id

String

跳转标识,UUID

VariableName

String

必须:“routeVariable”

Type

String

条件:只支持“=”

Value

String

取值,比如“=123”

Label

String

业务分支标识

Function->PluginFieldData->Param

参数名

类型

是否必填

描述

Method

String

调用方法,POST,GET

Query

Map<String, String>

查询内容

Header

Map<String, String>

Http请求头信息

Body

String

Http通过POST提交的数据

Url

String

调用内置函数URL

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDialogFlow
&<公共请求参数>

正常返回示例

XML 格式

<Status>8</Status>
<ModifyTime>2020-12-01 11:17:51</ModifyTime>
<AccountId>133208</AccountId>
<RequestId>0226F0F9-5F80-4331-A8CD-459AE93DA541</RequestId>
<ModuleName>示例_查天气</ModuleName>
<CreateTime>2020-11-29 14:50:47</CreateTime>
<CreateUserId>83225</CreateUserId>
<DialogId>49966</DialogId>
<CreateUserName>83225</CreateUserName>
<GlobalVars/>
<ModuleDefinition>
    <Edges>
        <Target>1410-a5c531c3</Target>
        <Id>dcb56361</Id>
        <Source>d3724d34-711c-4468-bbca-69e714060457</Source>
    </Edges>
    <Edges>
        <Target>1410-c7a72a78</Target>
        <Id>4372692b</Id>
        <Source>1410-a5c531c3</Source>
    </Edges>
    <Edges>
        <Target>1410-c4c55810</Target>
        <Id>ea83900c</Id>
        <Source>1410-c7a72a78</Source>
    </Edges>
    <Edges>
        <Target>1410-32ad0fc3</Target>
        <Id>e4ba46c5</Id>
        <Source>1410-c4c55810</Source>
    </Edges>
    <Nodes>
        <PluginDataUpdate>false</PluginDataUpdate>
        <Xx>300</Xx>
        <Yy>100</Yy>
        <PluginData>
            <Response>
                <PluginFieldDataResponse>
                    <ContentResponse>
                        <ButtonList/>
                    </ContentResponse>
                </PluginFieldDataResponse>
            </Response>
            <Function>
                <PluginFieldDataFunction/>
            </Function>
            <Entry>
                <PluginFieldDataEntry/>
            </Entry>
            <Slot>
                <PluginFieldDataSlot/>
            </Slot>
        </PluginData>
        <ComponentCode>start</ComponentCode>
        <Label>开始节点</Label>
        <Id>d3724d34-711c-4468-bbca-69e714060457</Id>
        <Code>start</Code>
    </Nodes>
    <Nodes>
        <PluginDataUpdate>false</PluginDataUpdate>
        <Xx>300</Xx>
        <Yy>160</Yy>
        <PluginData>
            <Response>
                <PluginFieldDataResponse>
                    <ContentResponse>
                        <ButtonList/>
                    </ContentResponse>
                </PluginFieldDataResponse>
            </Response>
            <Function>
                <PluginFieldDataFunction/>
            </Function>
            <Entry>
                <PluginFieldDataEntry>
                    <ContentEntry>
                        <ConditionEntries>
                            <Type>==</Type>
                            <Value>查天气意图</Value>
                            <Id>126179</Id>
                            <Term>Intent</Term>
                        </ConditionEntries>
                    </ContentEntry>
                    <LifeSpan>5</LifeSpan>
                    <Name>查天气</Name>
                </PluginFieldDataEntry>
            </Entry>
            <Slot>
                <PluginFieldDataSlot/>
            </Slot>
        </PluginData>
        <ComponentCode>entry</ComponentCode>
        <Label>查天气</Label>
        <Id>1410-a5c531c3</Id>
        <Code>entry</Code>
    </Nodes>
    <Nodes>
        <PluginDataUpdate>false</PluginDataUpdate>
        <Xx>300</Xx>
        <Yy>240</Yy>
        <PluginData>
            <Response>
                <PluginFieldDataResponse>
                    <ContentResponse>
                        <ButtonList/>
                    </ContentResponse>
                </PluginFieldDataResponse>
            </Response>
            <Function>
                <PluginFieldDataFunction/>
            </Function>
            <Entry>
                <PluginFieldDataEntry/>
            </Entry>
            <Slot>
                <PluginFieldDataSlot>
                    <ContentSlot>
                        <IsArray>false</IsArray>
                        <IsNecessary>true</IsNecessary>
                        <Value>@sys.geo-city</Value>
                        <LifeSpan>5</LifeSpan>
                        <Question>请问您要查哪里的天气?</Question>
                        <Name>city</Name>
                    </ContentSlot>
                    <IntentName>查天气意图</IntentName>
                    <IsSysIntent>false</IsSysIntent>
                    <IntentId>126179</IntentId>
                    <Name>查天气填槽</Name>
                </PluginFieldDataSlot>
            </Slot>
        </PluginData>
        <ComponentCode>slot</ComponentCode>
        <Label>查天气填槽</Label>
        <Id>1410-c7a72a78</Id>
        <Code>slot</Code>
    </Nodes>
    <Nodes>
        <PluginDataUpdate>false</PluginDataUpdate>
        <Xx>300</Xx>
        <Yy>400</Yy>
        <PluginData>
            <Response>
                <PluginFieldDataResponse>
                    <ContentResponse>
                        <Type>Text</Type>
                        <Text>${outputForFunction}</Text>
                        <Image/>
                        <ButtonList>
                            <Intro/>
                        </ButtonList>
                    </ContentResponse>
                    <Name>查天气回复</Name>
                </PluginFieldDataResponse>
            </Response>
            <Function>
                <PluginFieldDataFunction/>
            </Function>
            <Entry>
                <PluginFieldDataEntry/>
            </Entry>
            <Slot>
                <PluginFieldDataSlot/>
            </Slot>
        </PluginData>
        <ComponentCode>response</ComponentCode>
        <Label>查天气回复</Label>
        <Id>1410-32ad0fc3</Id>
        <Code>response</Code>
    </Nodes>
    <Nodes>
        <PluginDataUpdate>false</PluginDataUpdate>
        <Xx>300</Xx>
        <Yy>320</Yy>
        <PluginData>
            <Response>
                <PluginFieldDataResponse>
                    <ContentResponse>
                        <ButtonList/>
                    </ContentResponse>
                </PluginFieldDataResponse>
            </Response>
            <Function>
                <PluginFieldDataFunction>
                    <Function>HTTP</Function>
                    <AliyunFunction/>
                    <Type>BuiltIn</Type>
                    <Description/>
                    <Params>
                        <Query>
                            <City>${查天气意图.city}</City>
                        </Query>
                        <Header/>
                        <Method>GET</Method>
                        <Body/>
                        <Url>https://1744880035250859.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/DS_weathre_service/DS_weather_function/</Url>
                    </Params>
                    <EndPoint/>
                    <Code/>
                    <Name>调用查天气API</Name>
                    <AliyunService/>
                </PluginFieldDataFunction>
            </Function>
            <Entry>
                <PluginFieldDataEntry/>
            </Entry>
            <Slot>
                <PluginFieldDataSlot/>
            </Slot>
        </PluginData>
        <ComponentCode>function</ComponentCode>
        <Label>调用查天气API</Label>
        <Id>1410-c4c55810</Id>
        <Code>function</Code>
    </Nodes>
</ModuleDefinition>
<ModuleId>49162</ModuleId>
<ModifyUserId>83225</ModifyUserId>
<DialogName>示例_查天气</DialogName>
<ModifyUserName>null</ModifyUserName>

JSON 格式

{
	"Status": 8,
	"ModifyTime": "2020-12-01 11:17:51",
	"AccountId": "133208",
	"RequestId": "0226F0F9-5F80-4331-A8CD-459AE93DA541",
	"ModuleName": "示例_查天气",
	"CreateTime": "2020-11-29 14:50:47",
	"CreateUserId": "83225",
	"DialogId": 49966,
	"CreateUserName": "83225",
	"GlobalVars": {},
	"ModuleDefinition": {
		"Edges": [
			{
				"Target": "1410-a5c531c3",
				"Id": "dcb56361",
				"Source": "d3724d34-711c-4468-bbca-69e714060457"
			},
			{
				"Target": "1410-c7a72a78",
				"Id": "4372692b",
				"Source": "1410-a5c531c3"
			},
			{
				"Target": "1410-c4c55810",
				"Id": "ea83900c",
				"Source": "1410-c7a72a78"
			},
			{
				"Target": "1410-32ad0fc3",
				"Id": "e4ba46c5",
				"Source": "1410-c4c55810"
			}
		],
		"Nodes": [
			{
				"PluginDataUpdate": false,
				"Xx": 300,
				"Yy": 100,
				"PluginData": {
					"Response": {
						"PluginFieldDataResponse": {
							"ContentResponse": {
								"ButtonList": {}
							}
						}
					},
					"Function": {
						"PluginFieldDataFunction": {}
					},
					"Entry": {
						"PluginFieldDataEntry": {}
					},
					"Slot": {
						"PluginFieldDataSlot": {}
					}
				},
				"ComponentCode": "start",
				"Label": "开始节点",
				"Id": "d3724d34-711c-4468-bbca-69e714060457",
				"Code": "start"
			},
			{
				"PluginDataUpdate": false,
				"Xx": 300,
				"Yy": 160,
				"PluginData": {
					"Response": {
						"PluginFieldDataResponse": {
							"ContentResponse": {
								"ButtonList": {}
							}
						}
					},
					"Function": {
						"PluginFieldDataFunction": {}
					},
					"Entry": {
						"PluginFieldDataEntry": {
							"ContentEntry": [
								{
									"ConditionEntries": [
										{
											"Type": "==",
											"Value": "查天气意图",
											"Id": "126179",
											"Term": "Intent"
										}
									]
								}
							],
							"LifeSpan": 5,
							"Name": "查天气"
						}
					},
					"Slot": {
						"PluginFieldDataSlot": {}
					}
				},
				"ComponentCode": "entry",
				"Label": "查天气",
				"Id": "1410-a5c531c3",
				"Code": "entry"
			},
			{
				"PluginDataUpdate": false,
				"Xx": 300,
				"Yy": 240,
				"PluginData": {
					"Response": {
						"PluginFieldDataResponse": {
							"ContentResponse": {
								"ButtonList": {}
							}
						}
					},
					"Function": {
						"PluginFieldDataFunction": {}
					},
					"Entry": {
						"PluginFieldDataEntry": {}
					},
					"Slot": {
						"PluginFieldDataSlot": {
							"ContentSlot": [
								{
									"IsArray": false,
									"IsNecessary": true,
									"Value": "@sys.geo-city",
									"LifeSpan": 5,
									"Question": [
										"请问您要查哪里的天气?"
									],
									"Name": "city"
								}
							],
							"IntentName": "查天气意图",
							"IsSysIntent": false,
							"IntentId": "126179",
							"Name": "查天气填槽"
						}
					}
				},
				"ComponentCode": "slot",
				"Label": "查天气填槽",
				"Id": "1410-c7a72a78",
				"Code": "slot"
			},
			{
				"PluginDataUpdate": false,
				"Xx": 300,
				"Yy": 400,
				"PluginData": {
					"Response": {
						"PluginFieldDataResponse": {
							"ContentResponse": {
								"Type": "Text",
								"Text": "${outputForFunction}",
								"Image": "",
								"ButtonList": {
									"Intro": "",
									"Button": []
								}
							},
							"Name": "查天气回复"
						}
					},
					"Function": {
						"PluginFieldDataFunction": {}
					},
					"Entry": {
						"PluginFieldDataEntry": {}
					},
					"Slot": {
						"PluginFieldDataSlot": {}
					}
				},
				"ComponentCode": "response",
				"Label": "查天气回复",
				"Id": "1410-32ad0fc3",
				"Code": "response"
			},
			{
				"PluginDataUpdate": false,
				"Xx": 300,
				"Yy": 320,
				"PluginData": {
					"Response": {
						"PluginFieldDataResponse": {
							"ContentResponse": {
								"ButtonList": {}
							}
						}
					},
					"Function": {
						"PluginFieldDataFunction": {
							"Function": "HTTP",
							"AliyunFunction": "",
							"Type": "BuiltIn",
							"Description": "",
							"Switch": [],
							"Params": {
								"Query": {
									"City": "${查天气意图.city}"
								},
								"Header": {},
								"Method": "GET",
								"Body": "",
								"Url": "https://1744880035250859.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/DS_weathre_service/DS_weather_function/"
							},
							"EndPoint": "",
							"Code": "",
							"Name": "调用查天气API",
							"AliyunService": ""
						}
					},
					"Entry": {
						"PluginFieldDataEntry": {}
					},
					"Slot": {
						"PluginFieldDataSlot": {}
					}
				},
				"ComponentCode": "function",
				"Label": "调用查天气API",
				"Id": "1410-c4c55810",
				"Code": "function"
			}
		]
	},
	"ModuleId": 49162,
	"ModifyUserId": "83225",
	"DialogName": "示例_查天气",
	"ModifyUserName": "null"
}

错误码

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