ListDialogueFlows - 查询一个场景下的对话流程列表-旧画布接口(废弃)

更新时间:
复制 MD 格式

旧画布场景中查询一个话术下的对话流程列表。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

outboundbot:ListDialogueFlows

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID

b5b0a30f-69e7-4147-98b5-553fc526361d

ScriptId

string

场景 ID

d7c28efb-47f7-4a85-a522-5038e30a0b98

返回参数

名称

类型

描述

示例值

object

HttpStatusCode

integer

HTTP 返回码。

200

Code

string

状态码

OK

Message

string

接口提示信息

Success

RequestId

string

请求 ID

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

Success

boolean

表示是否调用成功。

  • true:调用成功。

  • false:调用失败。

true

DialogueFlows

array<object>

对话流程数据列表

object

对话流程数据列表

DialogueFlowDefinition

string

对话流程数据

{"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

string

流程类型。

  • 子流程类型 SubFlow,

  • 主流程类型 MainFlow

MainFlow

DialogueFlowId

string

对话流 ID

dae01529-3c3e-458e-b07a-97643d09ebb9

DialogueFlowName

string

对话流程名字

主流程

ScriptId

string

外呼场景 ID

2d5aa451-661f-4f08-b0c4-28eec78decc4

ScriptVersion

string

场景版本号

1569220563549

示例

正常返回示例

JSON格式

{
  "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"
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

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. 指定的话术不存在。

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

变更历史

更多信息,参考变更详情