Querying All IVR Flows of a Specified Tenant Space (queryIVRFlowList)

Scenario

Query all IVR flows of a specified tenant space.

Method

POST

URI

https://Domain name/apiaccess/rest/cc-management/v1/ivrFlow/queryIVRFlowList. For example, the domain name is service.besclouds.com.

Request Description

Response Description

• Status code: 200

  Table 2 Response body parameters

  No.	Parameter	Type	Mandatory or Not	Description
  1	schema	Object	Yes	-
  1.1	result	Array (object)	No	IVR information.
  1.1.1	isLoad	Number	No	Whether to load a flow. The options are as follows: 0: no; 1: yes.
  1.1.2	accessCode	String	No	Flow access code.
  1.1.3	maxCallNum	Integer	No	Maximum number of concurrent calls in a flow.
  1.1.4	description	String	No	Flow description.
  1.1.5	id	Number	No	Flow ID.
  1.1.6	flowFileName	String	No	Flow file name.
  1.1.7	flowType	Number	No	Flow type. 0: unspecified service type 1: GSL service file type 2: VoiceXML service file type 3: service type of the third-party IVR 4: VXML flow supported by the CCIVR 5: CCXMLL flow 6: WaitScript flow
  1.2	retCode	String	No	Return code. The options are as follows: 0: success; other values: failure.
  1.3	message	String	No	Return information.

• Status code: 400

  Incorrect request. Check the request path and parameters.

• Status code: 401

  Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.

• Status code: 403

  Authentication fails.

• Status code: 404

  The requested content is not found. Check the request path.

• Status code: 500

  Business failure. Check the values of parameters in the request.

Error Codes

None

Example

Request header:

Content-Type:application/json
Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX
X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX

Response parameters:

{
    "result": [
        {
            "isLoad": 1,
            "accessCode": "90500",
            "maxCallNum": null,
            "description": "Exception handling",
            "id": 1,
            "flowFileName": "defaultIVR.GSL",
            "flowType": 1
        },
        {
            "isLoad": 1,
            "accessCode": "90501",
            "maxCallNum": null,
            "description": "1015",
            "id": 2,
            "flowFileName": "defaultIVR.GSL",
            "flowType": 1
        }
    ],
    "retCode": "0",
    "message": "success"
}