Skip to main content

Uniphore Help Center Portal

Create Call Exclusion Filter

Create and configure the call exclusion filter for the tenant. The filters can be based on call duration, silence %, hold %, agent talk time, and customer talk time. Calls matching the defined filter conditions are excluded from processing. Up to 3 filters can be configured for a tenant. The tenant is taken from the caller's token.

Endpoint

URL: https://<<hostname>>/uzng-gateway/v1/tenant/call-exclusion-filter

Method: PUT

Header Parameter

Authorization - Bearer <token>

Note

To obtain an authorization token, click here.

Sample Request

{
  "match": "ALL",
  "conditions": [
    { "metric": "silence_pct",  "op": ">", "value": 40 },
    { "metric": "duration_sec", "op": "<", "value": 30 }
  ]
}

Request Parameter

Parameter Name	Datatype	Description	Required/ Optional
match	String	Logical operator for combining conditions. Accepted values: ANY (at least one condition must match) or ALL (all conditions must match).	Required
conditions	Array	List of filter conditions to evaluate against each call. Up to 3 filters can be configured.	Required
conditions: metric	string	The call metric to evaluate. The available metrics are duration_sec, silence_sec, hold_sec, agent_talk_sec, customer_talk_sec (durations in seconds), or silence_pct / hold_pct (silence or hold as a percentage of call duration).	Required
conditions: op	string	Comparison operator. Supported values: >, >=, <, <=, =.	Required
conditions: value	number	The threshold value to compare the metric against. Value allows positive numbers. For percentage (pct), the value should be between 0 and 100.	Required

Sample Response

{
  "tenantId": "acme",
  "enabled": true,
  "match": "ALL",
  "conditions": [
    { "metric": "silence_pct",  "op": ">", "value": 40, "unit": "pct" },
    { "metric": "duration_sec", "op": "<", "value": 30, "unit": "sec" }
  ],
  "readableRule": "Exclude call when silence > 40% AND call duration < 30s",
  "updatedBy": "delivery@uni.com",
  "updatedAt": "2026-07-14T10:15:00Z",
  "version": 3
}

Sample Error Response

{
  "error": {
    "code": "INVALID_CONDITION_METRIC",
    "message": "Unknown metric 'talk_sec'. Supported metrics are: hold_sec, silence_pct, duration_sec."
  }
}

Response and Error Codes

Response Code	Condition	Description
200	OK	The exclusion filter was successfully updated.
400	Bad Request	The request body is malformed or contains invalid values. Example: Missing required field, invalid match value, empty condition.
401	Unauthorized	The request is missing a valid authentication token.
403	Forbidden	The authenticated user does not have tenant-level permissions to modify the exclusion filter. Ensure `write:tenant:call-exclusion-filter` is granted.
404	Not Found	The specified tenant does not exist or is not accessible.
422	Unprocessable Entity	The request body is syntactically valid JSON but fails semantic validation. Example: Invalid match value, invalid condition metric, invalid condition operator,
500	Internal Server Error	An unexpected error occurred on the server. Retry the request or contact support if the issue persists.

In this section: