调用ListContactFlows获取呼叫中心实例中的IVR流程列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListContactFlows

系统规定参数。取值:ListContactFlows

InstanceId String 9cfad875-6260-4a53-ab6e-b13e3fb31f7d

呼叫中心实例ID

返回数据

名称 类型 示例值 描述
Code String OK

响应码

ContactFlows

联系流列表

ContactFlow

联系流列表

AppliedVersion String 20180704215641

当前正在工作的版本。

ContactFlowDescription String Welcome

联系流的简单描述。

ContactFlowId String dDMD_0mif4hv

联系流唯一ID,系统自动生成的唯一标示符。

ContactFlowName String Welcome

联系流名称,在一个实例内名称不能重复。

InstanceId String 9cfad875-6260-4a53-ab6e-b13e3fb31f7d

联系流所归属的呼叫中心实例。

PhoneNumbers

联系流所绑定的电话号码列表。

PhoneNumber

联系流所绑定的电话号码列表。

AllowOutbound Boolean true

是否允许外呼。结果取决于:

1. 大于的设置,比如400号码不允许外呼

2. 呼叫中心实例的设置

说明 电话号码一般都允许内呼,如果不允许内呼,可以由大于做设置,用户拨打该号码时听到提示音;该号码不绑定联系流IVR,但是ACC不建议这么做。
InstanceId String 9cfad875-6260-4a53-ab6e-b13e3fb31f7d

电话号码所归属的呼叫中心实例ID。

Number String 178888888888

电话号码。

PhoneNumberDescription String xxx

电话号码的简单描述。

PhoneNumberId String xxx

电话号码ID,系统自动生成的唯一标示符。

RemainingTime Integer 60

测试号码剩余的通话时间。单位为分钟。

TestOnly Boolean true

是否是测试号码。

Trunks Integer 30

电话号码的中继数量。即可同时支持几路通话,数据来源于大于。

Usage String Bidirection

电话号码的用途。取值:呼入(Inbound),呼出(Outbound),以及同时用于呼入和呼出(Bidirection)。上述值由枚举类型PhoneNumberType定义。

该值的结果取决于:

1. 大于的设置,比如400号码不允许外呼

2. 呼叫中心实例的设置

说明 电话号码一般都允许内呼,如果不允许内呼,可以由大于做设置,用户拨打该号码时听到提示音;该号码不连接人和联系流IVR,但是ACC不建议这么做。
Type String Mainflow

流程类型, 定义来自于ContactFlowType。

Versions

联系流文件的所有版本。外表存贮。

ContactFlowVersion

联系流文件的所有版本。外表存贮。

ContactFlowVersionDescription String Welcome-20180601142524

联系流版本的说明及注解。

ContactFlowVersionId String tOMP_0prS2A1

联系流版本ID,系统自动生成的唯一标示符。

LastModified String 2018-07-04 22:00:55

联系流版本的最后修改时间。the number of milliseconds since January 1, 1970, 00:00:00 GMT

LastModifiedBy String cloudcallcenter

联系流版本最后由何人修改。

LockedBy String null

联系流版本被何人锁定。

在开始编辑前必须先将此版本锁定,编辑完成后解锁,这样可以避免多人同时修改一个版本而导致的冲突。在锁定的情况下,只有锁定人才能对其进行操作,其他人无权操作。无人锁定时该属性的值为NULL。

Status String Published

当前状态。

Version String 20180704215641

联系流版本信息,一般以日期+时间来表示。

HttpStatusCode Integer 200

HTTP状态码

Message String

响应信息

RequestId String F7505505-D727-46E2-9B66-47C5CEBDFCE1

请求ID

Success Boolean true

是否成功

示例

请求示例


http(s)://ccc.cn-shanghai.aliyuncs.com/?Action=ListContactFlows
&InstanceId=9cfad875-6260-4a53-ab6e-b13e3fb31f7d
&<公共请求参数>

正常返回示例

XML 格式

<ListContactFlowsResponse>
      <HttpStatusCode>200</HttpStatusCode>
      <ContactFlows>
            <ContactFlow>
                  <ContactFlowName>Welcome</ContactFlowName>
                  <ContactFlowDescription>Welcome</ContactFlowDescription>
                  <ContactFlowId>dDMD_0mif4hv</ContactFlowId>
                  <Versions>
                        <ContactFlowVersion>
                              <Status>Published</Status>
                              <ContactFlowVersionDescription>Welcome-20180601142524</ContactFlowVersionDescription>
                              <ContactFlowVersionId>tOMP_0prS2A1</ContactFlowVersionId>
                              <LastModifiedBy>cloudcallcenter</LastModifiedBy>
                              <LastModified>2018-07-04 22:00:55</LastModified>
                              <Version>20180704215641</Version>
                              <LockedBy></LockedBy>
                        </ContactFlowVersion>
                  </Versions>
                  <AppliedVersion>20180704215641</AppliedVersion>
                  <Type>Mainflow</Type>
                  <InstanceId>9cfad875-6260-4a53-ab6e-b13e3fb31f7d</InstanceId>
                  <PhoneNumbers>
            </PhoneNumbers>
            </ContactFlow>
      </ContactFlows>
      <RequestId>F7505505-D727-46E2-9B66-47C5CEBDFCE1</RequestId>
      <Success>true</Success>
      <Code>OK</Code>
</ListContactFlowsResponse>

JSON 格式

{
	"HttpStatusCode":200,
	"ContactFlows":{
		"ContactFlow":[
			{
				"ContactFlowName":"Welcome",
				"ContactFlowDescription":"Welcome",
				"ContactFlowId":"dDMD_0mif4hv",
				"Type":"Mainflow",
				"AppliedVersion":"20180704215641",
				"Versions":{
					"ContactFlowVersion":[
						{
							"Status":"Published",
							"ContactFlowVersionDescription":"Welcome-20180601142524",
							"ContactFlowVersionId":"tOMP_0prS2A1",
							"LastModified":"2018-07-04 22:00:55",
							"LastModifiedBy":"cloudcallcenter",
							"Version":"20180704215641",
							"LockedBy":""
						}
					]
				},
				"InstanceId":"9cfad875-6260-4a53-ab6e-b13e3fb31f7d",
				"PhoneNumbers":{
					"PhoneNumber":[]
				}
			}
		]
	},
	"RequestId":"F7505505-D727-46E2-9B66-47C5CEBDFCE1",
	"Success":true,
	"Code":"OK"
}

错误码

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