Help Center/ Cognitive Engagement Center/ API Reference/ Inspection, Monitoring, and Statistics Collection Interface Reference/ Intelligent Quality Check/ conversationflow/ POST /CCSQM/rest/ccisqm/v1/conversation-rules/addConversationFlow
Updated on 2023-09-27 GMT+08:00
View PDF
Share

POST /CCSQM/rest/ccisqm/v1/conversation-rules/addConversationFlow

Scenario

This interface is invoked to create a dialog logic.

Method

POST

URI

https://Domain name/apiaccess/CCSQM/rest/ccisqm/v1/conversation-rules/addConversationFlow (For example, the domain name is service.besclouds.com.)

Request Description

Table 1 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

Content-Type

String

No

The value is fixed to application/json; charset=UTF-8.

2

x-app-key

String

No

App key

3

Authorization

String

Yes

Authentication field. The format is Bearer {Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.)

4

x-UserId

String

Yes

Operator ID

You can sign in to the system and go to the employee management page to view the value of userId returned by an interface.
Table 2 Request body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

flow_name

String (128)

Yes

Dialog logic name

1.2

min

Number

Yes

Number of times a dialog logic occurs

1.3

expression

String

Yes

Logical relationship expression between scripts in a dialog logic, for example, must a9d7d3ce37ec4bf0a3ef027cfbe96275 (script ID)

1.4

rule_id

String

Yes

Dialog rule ID

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

flow_id

String

No

Dialog logic ID

1.2

resultCode

String

No

Return code. The value 0405000 indicates success, and other values indicate failure.

1.3

resultDesc

String

No

Return description
  • 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: 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

  • Scenario: Create a dialog logic.

    Request header:

    x-app-key:************************************  
X-UserID:1611917095665261978  
Authorization:Bearer ********************************

    Request parameters:

    {
	"flow_name": "APIcs",
	"min": 2,
	"expression": "must",
	"rule_id": "894378241748373505"
}

    Response parameters:

    {
	"flow_id": "925093880544628736",
	"resultCode": "0405000",
	"resultDesc": "Operation successful."
}
Parent topic: conversationflow