查询一个话术下的对话流程列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 实例 id | 361c8a53-0e29-42f3-8aa7-c7752d010399 |
ScriptId | string | 是 | 话术 id,对话流程数据来自这个话术 | d7c28efb-47f7-4a85-a522-5038e30a0b98 |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | NotExist.Instance | The specified Instance does not exist. | 指定的实例不存在。 |
404 | NotExist.Script | The specified Script does not exist. | 指定的话术不存在。 |
500 | InternalError | An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. | 内部错误。建议重试,如果多次重试报错请提交工单。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史