Skip to main content
POST
/
v1.0
/
subscribers
/
call-filter
/
update
json
{
  "FilterId": "CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499",
  "SubscriberId": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441",
  "Phone": "+1234567891",
  "FilterMode": "WHITELIST",
  "AllowedNumbers": ["+1111111111", "+2222222222"],
  "BlockedNumbers": ["+3333333333"],
  "EnableTranscription": true,
  "KeywordFilter": "{\"CustomKeywords\":[\"inappropriate\",\"banned\"],\"SystemKeywords\":{\"Profanity\":[\"word1\",\"word2\"],\"Violence\":[\"threat1\"]},\"SeverityMap\":{\"Word1\":\"HIGH\",\"Inappropriate\":\"MEDIUM\"}}",
  "TranscriptionAction": "WARNING",
  "WarningMessage": "This call may be terminated",
  "NotificationPhones": ["+9999999999"]
}
{
  "FilterId": "CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499",
  "SubscriberId": "TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441",
  "Phone": "+1234567891",
  "FilterMode": "WHITELIST",
  "AllowedNumbers": [
    "+1111111111",
    "+2222222222"
  ],
  "BlockedNumbers": [
    "+3333333333"
  ],
  "EnableTranscription": true,
  "TranscriptionAction": "WARNING",
  "WarningMessage": "This call may be terminated",
  "NotificationPhones": [
    "+9999999999"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.telegent.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
​
FilterId
string
required

The Call Filter ID you want to update. Format: CFID- followed by a UUID.

Example:

"CFID-05c3d6d2-21c2-4fab-8c7c-12746cad1499"

​
SubscriberId
string

Telegent Subscriber ID. Format: TSUID- followed by a UUID. Create one via POST /v1.0/subscribers/create or look up existing IDs with GET /v1.0/subscribers/get.

​
Phone
string

Phone number this filter applies to. Use E.164 format (e.g., +15555555555). Required even when SubscriberId is provided.

​
FilterMode
enum<string>

Controls how the call filter behaves. WHITELIST: only allowed numbers can call — everyone else is blocked. BLACKLIST: blocked numbers are rejected, all others ring through.

Available options:
WHITELIST,
BLACKLIST
​
AllowedNumbers
string[]

Phone numbers (E.164 format) allowed to call this subscriber. In WHITELIST mode, only these numbers can ring through.

​
BlockedNumbers
string[]

Phone numbers (E.164 format) blocked from calling this subscriber. Calls are rejected or silently dropped.

​
EnableTranscription
boolean

If true, calls are transcribed in real time and analyzed against the keyword rules. Required for any keyword-based call filtering or alerts to work.

​
KeywordFilter
string

Stringified JSON defining keyword rules. Structure: {"CustomKeywords":[...],"SystemKeywords":{"Profanity":[...],"Violence":[...]},"SeverityMap":{"keyword":"HIGH|MEDIUM|LOW"}}. CustomKeywords are user-added words; SystemKeywords are platform-provided categories; SeverityMap assigns a risk level to each term.

​
TranscriptionAction
enum<string>

What happens when a flagged keyword is detected during live transcription. WARNING: play WarningMessage to the caller but allow the call to continue. TERMINATE: end the call immediately. NOTIFY: alert NotificationPhones without interrupting the call.

Available options:
WARNING,
TERMINATE,
NOTIFY
​
WarningMessage
string

Text-to-speech message played to the caller when TranscriptionAction is set to WARNING. Keep it short and clear.

​
NotificationPhones
string[]

Phone numbers (E.164 format) that receive an alert when this filter triggers. Typically used for a guardian's phone to be notified about activity on a child's account.

​
ApplyToOutbound
boolean

If true, filtering applies to calls the subscriber places.

​
ApplyToInbound
boolean

If true, filtering applies to calls the subscriber receives.

​
BlockUnknownNumbers
boolean

If true, calls from any number not on the allowed list are blocked or sent to voicemail.

​
BlockInternational
boolean

If true, calls to or from numbers outside the subscriber's country code are blocked.

​
RecordFlaggedCalls
boolean

If true, any call flagged by keyword detection or other rules is recorded for later review.

Response

Call Filter Updated

The response is of type object.