首页 云呼叫中心 API参考 API目录 IVR ListContactFlows - 获取联系流列表

ListContactFlows - 获取联系流列表

调用ListContactFlows获取指定实例下的IVR联系流列表。

调试

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

调试

授权信息

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

请求参数

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

实例ID。

ccc-test
PageNumberinteger

分页序号,范围1-100。

1
PageSizeinteger

分页大小,范围1-100。

10
Typestring

按IVR流程类型过滤,非必填,默认为空,为空表示不过滤。

MAIN_FLOW
枚举值:
- SURVEY_FLOW: 满意度流程
- SUB_FLOW: 子流程
- MAIN_FLOW: 主流程

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP状态码。

200
Messagestring

响应信息。

RequestIdstring

请求ID。

EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Dataobject

数据。

PageNumberinteger

分页序号。

1
PageSizeinteger

分页大小。

10
TotalCountinteger

总数。

1
Listarray

联系流列表。

object
Typestring

IVR联系流类型。

MAIN_FLOW
枚举值:
- SURVEY_FLOW: 满意度流程
- SUB_FLOW: 子流程
- MAIN_FLOW: 主流程
Definitionstring

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":""}
DraftIdstring

草稿ID,当IVR流程处于未发布状态时返回此字段。

db07c0bb-6b1f-47d2-b37e-2451c617562d
Descriptionstring

版本描述。

1.0
UpdatedTimestring

上次修改的时间。

2021-03-08 15:34:49.0
Editorstring

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

ccc-test
Publishedboolean

是否发布过。

true
InstanceIdstring

实例ID。

ccc-test
Namestring

IVR联系流名称。

默认流程
ContactFlowIdstring

IVR联系流ID。

78128960-bb00-4ddc-8e82-923a8c5bd22d
CreatedTimestring

创建时间。

2021-03-05 17:35:45.0
NumberListarray

IVR联系流绑定的号码列表。

string

号码

400289****

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 1,
    "List": [
      {
        "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": "db07c0bb-6b1f-47d2-b37e-2451c617562d",
        "Description": "1.0",
        "UpdatedTime": "2021-03-08 15:34:49.0",
        "Editor": "ccc-test",
        "Published": true,
        "InstanceId": "ccc-test",
        "Name": "默认流程",
        "ContactFlowId": "78128960-bb00-4ddc-8e82-923a8c5bd22d",
        "CreatedTime": "2021-03-05 17:35:45.0",
        "NumberList": [
          "400289****"
        ]
      }
    ]
  }
}

错误码

Http code错误码错误信息描述
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。

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

阿里云首页 云呼叫中心 相关技术圈