调用IVRListContactFlows获取联系流列表_云联络中心(Cloud Contact Center)-阿里云帮助中心

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

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	ccc-test
PageNumber	integer	是	分页序号，范围 1-100。	1
PageSize	integer	是	分页大小，范围 1-100。	10
Type	string	否	按 IVR 流程类型过滤，非必填，默认为空，为空表示不过滤。枚举值： SURVEY_FLOW：满意度流程。 SUB_FLOW：子流程。 MAIN_FLOW：主流程。	MAIN_FLOW
SortOrder	string	否	排序方向。取值范围： ASC：升序 DESC（默认值）：降序	DESC
OrderByField	string	否	排序字段。	updatedTime

返回参数

名称	类型	描述	示例值
	object
Code	string	响应码。	OK
HttpStatusCode	integer	HTTP 状态码。	200
Message	string	响应信息。	无
RequestId	string	请求 ID。	EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Data	object	数据。
PageNumber	integer	分页序号。	1
PageSize	integer	分页大小。	10
TotalCount	integer	总数。	1
List	array<object>	联系流列表。
ContactFlow	object
Type	string	IVR 联系流类型。枚举值： SURVEY_FLOW：满意度流程。 SUB_FLOW：子流程。 MAIN_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，当 IVR 流程处于未发布状态时返回此字段。	db07c0bb-6b1f-47d2-b37e-2451c617562d
Description	string	版本描述。	1.0
UpdatedTime	string	上次修改的时间。	2021-03-08 15:34:49.0
Editor	string	此草稿的当前编辑者的坐席登录名。	ccc-test
Published	boolean	是否发布过。	true
InstanceId	string	实例 ID。	ccc-test
Name	string	IVR 联系流名称。	默认流程
ContactFlowId	string	IVR 联系流 ID。	78128960-bb00-4ddc-8e82-923a8c5bd22d
CreatedTime	string	创建时间。	2021-03-05 17:35:45.0
NumberList	array	IVR 联系流绑定的号码列表。
NumberList	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,
        "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 status code	错误码	错误信息	描述
404	NotExists.InstanceId	The specified instance %s does not exist.	指定的呼叫中心实例不存在。

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

变更历史

变更时间	变更内容概要	操作
2023-11-06	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情