Updated on 2023-09-27 GMT+08:00

POST /CCSQM/rest/ccisqm/v1/interposal-rules/addInterposalRule

Scenario

This interface is invoked to create an interruption rule.

Method

POST

URI

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

name

String (64)

Yes

Rule name

1.2

score

Number

Yes

Rule score

1.3

seconds

Number

Yes

Maximum duration of crosstalks, in seconds

1.4

times

Number

Yes

Maximum number of crosstalks

1.5

other

Object

Yes

Inspection conditions

1.5.1

call_end

Number

No

End timestamp of a call, in seconds

1.5.2

call_from

Number

No

Start timestamp of a call, in seconds

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

resultCode

String

No

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

1.2

resultDesc

String

No

Description

1.3

interposal_id

String

No

Interruption rule ID

  • 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 an interruption rule.

    Request header:

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

    Request parameters:

    {"other":{"call_from":1623913102,"call_end":1623999504},"name":"test0611","score":4,"seconds":4,"times":4}

    Response parameters:

    {"interposal_id":"922992717770788864","resultCode":"0405000","resultDesc": "Operation successful."}