Cisco Unified Contact Center Enterprise Developers Guide Release 9.0(1)
Congestion Control API
Downloads: This chapterpdf (PDF - 381.0KB) The complete bookPDF (PDF - 1.09MB) | Feedback

Congestion Control API

Congestion Control API

You can use the Congestion Control API to list and edit the Congestion Control.

This section explains the supported API operations for Congestion Control and outlines the parameters.

Congestion Control API Parameters

The following table shows the parameters for Congestion Control API:

Parameter Name

Description

congestionEnabled

Enable or disable Congestion Control.

congestionTreatmentMode

Mode to handle Congestion.

Valid values are integers 1-5:

  • 1 = Dialed Number default label is used for call treatment.
  • 2 = Treat call with Routing client default label.
  • 3 = Treat call with System default label.
  • 4 = Terminate with Dialog Fail/RouteEnd.
  • 5 = Release message to the Routing client.

userOverride

Indicates whether a user can override the CPS_CAPACITY.

systemDefaultLabel

Default Label string to treat the calls subjected to Congestion Control.

cpsCapacity

Capacity for Call Per Second.

Congestion Control get

Returns the Congestion Control from the database.

Syntax

URL: https://<server>/unifiedconfig/config/congestioncontrol

HTTP Method: GET

Response

See also General Usage.

XML request payload

<congestionControl>
      <deploymentType>0</deploymentType>
      <congestionTreatmentMode>1</congestionTreatmentMode>
      <congestionEnabled>true</congestionTreatmentMode>
      <userOverride>false</userOverride>
      <systemDefaultLabel></systemDefaultLabel>
      <cpsCapaticy>100</cpsCapacity>
</congestionControl>

Congestion Control update

Updates one Congestion Control in the database.

Syntax

URL: https://<server>/unifiedconfig/config/congestioncontrol

HTTP Method: PUT

Input/Output format

xml

Response

See General Usage.

Operation validation

congestionEnabled

  • Optional field.
  • Has a dependancy on deploymentType.
  • If deploymentType is 0, this value has to be 0.
  • If deploymentType is 7 or 10, this value is 1.
  • For other deployment types (not 0, 7, or 10), this field can be 1 or 0.

congestionTreatmentMode

  • Optional field.
  • Valid values are:1-5

systemDefaultLabel

  • Optional field.
  • Max length of 32 characters allowed.
  • Internationalized characters not allowed.
  • If congestionTreatmentMode is set to 3 (Treat call with System default string), then systemDefaultLabel must be set.

cpsCapacity

  • Optional field.
  • Can be set if userOverride is set as true.
  • Cannot be greater than DEPLOYMENT_MAX_CPS, which is specified in the following table, based on Deployment Type.
Deployment Types Definition DEPLOYMENT_MAX_CPS

0

General

0

1

NAM

300

2

VRU

300

3

NAM Rogger

150

4

ICM Router Logger

115

5

8000 Agents Router Logger

69

6

12000 Agents Router Logger

115

7

Packaged CCE : CCE-PAC-M1

8

8

ICM Rogger

58

9

4000 Agents Rogger

35

10

Packaged CCE: CCE-PAC-M1 Lab Only

1

11

HCS-CC 1000 Agents

8

12

HCS-CC 500 Agents

5

13

UCCE 450 Agents Progger

4