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

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

Scenario

This interface is invoked to add a script.

Method

POST

URI

https://Domain name/apiaccess/CCSQM/rest/ccisqm/v1/conversation-rules/addSentenceGroup (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

sentences

Array [String]

No

Sentences used in a script

1.2

role

String

Yes

Role corresponding to a script

  • any: unlimited
  • staff: agent
  • customer: user

1.3

position

String

Yes

Phase in a call

  • any: unlimited
  • top: beginning of a call
  • bottom: end of a call
  • set: specified phase

1.4

SGType

String

Yes

Logical operator of a sentence

  • must: must say
  • if: if says
  • must_say: must say
  • must_not_say: cannot say
  • then: goes on saying
  • and: also says

1.5

sg_name

String

No

Script name

1.6

dialogue_flow_id

String

Yes

Dialog logic ID

1.7

position_distance

Number

No

Offset of a sentence. The value ranges from 1 to 9999.

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

sg_id

String

No

Script ID

1.2

resultCode

String

No

Return code

  • 0405000: success
  • Others: 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: Add a script.

    Request header:

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

    Request parameters:

    {
	"sentences": ["10877","10795","10795","10849","10870","10877","10877","10721","10877"],
	"role": "customer",
	"position": "set",
	"SGType": "must_say",
	"sg_name": "Script name 65",
	"dialogue_flow_id": "1068973778081419264",
	"position_distance": 2271
}

    Response parameters:

    {
    "sg_id": "1071513309271822336",
    "resultCode": "0405000",
    "resultDesc": "Operation successful."
}
Parent topic: conversationspecific