GetContactFlow - 获取指定联系流

更新时间:
复制为 MD 格式

获取指定联系流。

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

ccc-test

ContactFlowId

string

联系流 ID。

274601be-a6d5-4429-bcef-32b51d031c6e

DraftId

string

草稿 ID,当前联系流对应的可编辑草稿版本 ID。

566399d7-5558-447c-a72f-9be2768b6a82

返回参数

名称

类型

描述

示例值

object

Code

string

响应码。

OK

HttpStatusCode

integer

HTTP 状态码

200

Message

string

响应信息。

RequestId

string

请求 ID。

2263B273-AC1B-44EB-BA98-87F2322C6780

Data

object

数据。

Type

string

流程类型:
MAIN_FLOW(主流程)
SUB_FLOW(子流程)
SURVEY_FLOW(满意度流程)

MAIN_FLOW

Definition

string

IVR 的内容。

{"activities":[{"type":"INCOMING_CALL","id":"e98f0d47","name":"开始","properties":{"position":{"x":263,"y":164}},"events":[{"event":"complete","next":"2d3ad2c2","edgeId":"41f7dbd0"}],"nodeIndex":0},{"type":"HANGUP","id":"bd4f37e2","name":"挂机","properties":{"position":{"x":765,"y":185}},"events":[{"event":"complete","next":null}],"nodeIndex":999},{"type":"PLAY_SAY","id":"2d3ad2c2","name":"放音","properties":{"say":"您好,欢迎来到云联络中心。","audioResourceId":"","position":{"x":485.5,"y":153.5},"audioType":"tts","audioInterrupt":false},"events":[{"event":"complete","next":"bd4f37e2","edgeId":"e1af4f1f"}],"nodeIndex":1}],"description":""}

DraftId

string

草稿 ID,当前联系流对应的可编辑草稿版本 ID。

566399d7-5558-447c-a72f-9be2768b6a82

Description

string

版本描述。

1.0

UpdatedTime

string

上次修改的时间。

2021-07-14 10:48:43.0

Editor

string

此草稿的当前编辑者的坐席登录名。

editor-xxx

Published

boolean

是否已发布 True:已发布:False:未发布

False

InstanceId

string

实例 ID。

ccc-test

Name

string

IVR 名称。

欢迎语

ContactFlowId

string

联系流 ID。

274601be-a6d5-4429-bcef-32b51d031c6e

CreatedTime

string

联系流程草稿创建时间。

2021-07-14 10:48:43.0

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "2263B273-AC1B-44EB-BA98-87F2322C6780",
  "Data": {
    "Type": "MAIN_FLOW",
    "Definition": "{\"activities\":[{\"type\":\"INCOMING_CALL\",\"id\":\"e98f0d47\",\"name\":\"开始\",\"properties\":{\"position\":{\"x\":263,\"y\":164}},\"events\":[{\"event\":\"complete\",\"next\":\"2d3ad2c2\",\"edgeId\":\"41f7dbd0\"}],\"nodeIndex\":0},{\"type\":\"HANGUP\",\"id\":\"bd4f37e2\",\"name\":\"挂机\",\"properties\":{\"position\":{\"x\":765,\"y\":185}},\"events\":[{\"event\":\"complete\",\"next\":null}],\"nodeIndex\":999},{\"type\":\"PLAY_SAY\",\"id\":\"2d3ad2c2\",\"name\":\"放音\",\"properties\":{\"say\":\"您好,欢迎来到云联络中心。\",\"audioResourceId\":\"\",\"position\":{\"x\":485.5,\"y\":153.5},\"audioType\":\"tts\",\"audioInterrupt\":false},\"events\":[{\"event\":\"complete\",\"next\":\"bd4f37e2\",\"edgeId\":\"e1af4f1f\"}],\"nodeIndex\":1}],\"description\":\"\"}",
    "DraftId": "566399d7-5558-447c-a72f-9be2768b6a82\n",
    "Description": "1.0\n",
    "UpdatedTime": "2021-07-14 10:48:43.0",
    "Editor": "editor-xxx",
    "Published": true,
    "InstanceId": "ccc-test",
    "Name": "欢迎语",
    "ContactFlowId": "274601be-a6d5-4429-bcef-32b51d031c6e\n",
    "CreatedTime": "2021-07-14 10:48:43.0"
  }
}

错误码

HTTP status code

错误码

错误信息

描述

404 NotExists.InstanceId The specified instance %s does not exist. 指定的呼叫中心实例不存在。

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

变更历史

更多信息,参考变更详情