Skip to main content
POST
/
v1.0
/
subscribers
/
call-filter
json
{
  "SubscriberId": "TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441",
  "Phone": "+1234567890",
  "FilterMode": "WHITELIST",
  "AllowedNumbers": ["+1111111111", "+2222222222"],
  "BlockedNumbers": ["+3333333333"],
  "EnableTranscription": true,
  "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": "+1234567890",
  "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"
  ],
  "ApplyToOutbound": false,
  "ApplyToInbound": false,
  "BlockUnknownNumbers": false,
  "BlockInternational": false,
  "RecordFlaggedCalls": false,
  "TimeRestrictions": null
}

Authorizations

​
Authorization
string
header
required

Enter the token obtained from the Authentication endpoint

Body

application/json
​
SubscriberId
string
required

Subscriber ID

Example:

"TSUID-C7AB61E0-9AD9-4512-ACA8-EDA284131441"

​
Phone
string
required

Phone number (E.164 format)

Example:

"+1234567890"

​
FilterMode
enum<string>
required

Filter mode

Available options:
WHITELIST,
BLACKLIST,
CHILD,
TEENAGER,
ADOLESCENT
Example:

"WHITELIST"

​
AllowedNumbers
string[]

List of allowed phone numbers

​
BlockedNumbers
string[]

List of blocked phone numbers

​
EnableTranscription
boolean

Enable call transcription

​
KeywordFilter
string

JSON string containing keyword filter configuration

​
TranscriptionAction
enum<string>

Action to take when keywords detected

Available options:
WARNING,
TERMINATE,
NOTIFY
​
WarningMessage
string

Warning message to play during call

​
NotificationPhones
string[]

Phone numbers to receive notifications

​
ApplyToOutbound
boolean

Apply filter to outbound calls

​
ApplyToInbound
boolean

Apply filter to inbound calls

​
BlockUnknownNumbers
boolean

Block calls from unknown numbers

​
BlockInternational
boolean

Block international calls

​
RecordFlaggedCalls
boolean

Record calls flagged by filter

​
TimeRestrictions
object

Time-based restrictions for calls

Response

200 - application/json

Call Filter Created

The response is of type object.