ListContactFlows-阿里云帮助中心

Call ListContactFlows to retrieve the IVR contact flows for a specified instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	ccc-test
PageNumber	integer	Yes	The page number. The value must be an integer that is greater than 0. Default value: 1.	1
PageSize	integer	Yes	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
Type	string	No	Specifies the type of IVR flow to list. If you omit this parameter, IVR flows of all types are listed. Valid values: SURVEY_FLOW : A survey flow. SUB_FLOW : A subflow. MAIN_FLOW : A main flow.	MAIN_FLOW
SortOrder	string	No	The sort order. Valid values: `ASC`: The results are sorted in ascending order. `DESC`: The results are sorted in descending order. This is the default value.	DESC
OrderByField	string	No	The field by which to sort the results. Default value: updatedTime.	updatedTime
SearchPattern	string	No	A keyword to search for in the names or descriptions of IVR flows.

Response elements

Element	Type	Description	Example
	object	The response object.
Code	string	The response code.	OK
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The response message.	无
RequestId	string	The request ID.	EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Data	object	The data returned.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries.	1
List	array<object>	A list of contact flows.
	object
Type	string	The type of the IVR contact flow. Valid values: SURVEY_FLOW : A satisfaction survey flow. SUB_FLOW : A subflow. MAIN_FLOW : A main flow.	MAIN_FLOW
Definition	string	The JSON-formatted definition of the IVR contact flow. This parameter is for internal use and is parsed by the backend.	{"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	The draft ID. This parameter is returned only when the contact flow is unpublished.	db07c0bb-6b1f-47d2-b37e-2451c617562d
Description	string	The description of the contact flow version.	1.0
UpdatedTime	string	The last time the contact flow was updated.	2021-03-08 15:34:49.0
Editor	string	The login name of the agent currently editing this draft.	ccc-test
Published	boolean	Indicates whether the contact flow has been published.	true
InstanceId	string	The instance ID.	ccc-test
Name	string	The name of the IVR contact flow.	默认流程
ContactFlowId	string	The ID of the IVR contact flow.	78128960-bb00-4ddc-8e82-923a8c5bd22d
CreatedTime	string	When the contact flow was created.	2021-03-05 17:35:45.0
NumberList	array	A list of phone numbers that are bound to the IVR contact flow.
	string	A phone number.	400289****

Examples

Success response

JSON format

{
  "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****"
        ]
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	NotExists.InstanceId	The specified instance %s does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.