文档

ListDialogueFlows - 查询一个话术下的对话流程列表

更新时间:

查询一个话术下的对话流程列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 id

361c8a53-0e29-42f3-8aa7-c7752d010399
ScriptIdstring

话术 id,对话流程数据来自这个话术

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

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

http 状态码

200
Codestring

接口状态码

OK
Messagestring

接口提示消息

Success
RequestIdstring

请求 id

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

是否成功

true
DialogueFlowsarray<object>

对话流程数据列表

object
DialogueFlowTypestring

对话流程类型

MainFlow
DialogueFlowDefinitionstring

对话流程定义数据

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

对话流程 id

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

对话流程名字

主流程
ScriptIdstring

话术 id

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

话术版本

1569220563549

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "DialogueFlows": [
    {
      "DialogueFlowType": "MainFlow",
      "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\"]}]}",
      "DialogueFlowId": "dae01529-3c3e-458e-b07a-97643d09ebb9",
      "DialogueFlowName": "主流程",
      "ScriptId": "2d5aa451-661f-4f08-b0c4-28eec78decc4",
      "ScriptVersion": "1569220563549"
    }
  ]
}

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "DialogueFlows": [
    {
      "DialogueFlowType": "MainFlow",
      "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\"]}]}",
      "DialogueFlowId": "dae01529-3c3e-458e-b07a-97643d09ebb9",
      "DialogueFlowName": "主流程",
      "ScriptId": "2d5aa451-661f-4f08-b0c4-28eec78decc4",
      "ScriptVersion": "1569220563549"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
404NotExist.InstanceThe specified Instance does not exist.指定的实例不存在。
404NotExist.ScriptThe specified Script does not exist.指定的话术不存在。
500InternalErrorAn error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.内部错误。建议重试,如果多次重试报错请提交工单。

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

变更历史

变更时间变更内容概要操作
暂无变更历史