Skip to main content
POST
/
v1.0
/
subscribers
/
message-filter
json
{
  "SubscriberId": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441",
  "Phone": "+1234567890",
  "FilterMode": "ACTIVE",
  "AllowedContacts": ["+1111111111", "+2222222222"],
  "BlockedContacts": ["+3333333333"],
  "BlockUnknownNumbers": true
}
{
  "FilterId": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1",
  "SubscriberId": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441",
  "Phone": "+1234567890",
  "FilterMode": "ACTIVE",
  "AllowedContacts": [
    "+1111111111",
    "+2222222222"
  ],
  "BlockedContacts": [
    "+3333333333"
  ],
  "KeywordFilter": "\"CustomKeywords\":[\"inappropriate\",\"banned\"],\"SystemKeywords\":{\"Profanity\":[\"word1\",\"word2\"],\"Violence\":[\"threat1\"]},\"SeverityMap\":{\"Word1\":\"HIGH\",\"Inappropriate\":\"MEDIUM\"}",
  "NotificationPhones": [
    "+9999999999"
  ],
  "ApplyToOutbound": true,
  "ApplyToInbound": true,
  "BlockUnknownNumbers": true,
  "BlockLinks": true,
  "BlockMedia": true
}

Authorizations

​
Authorization
string
header
required

Enter the token obtained from the Authentication endpoint

Body

application/json
​
SubscriberId
string
required

Subscriber ID

Example:

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

​
Phone
string
required

Phone number (E.164 format)

Example:

"+1234567890"

​
FilterMode
enum<string>
required

Filter mode

Available options:
ACTIVE,
MONITOR_ONLY,
INACTIVE
Example:

"ACTIVE"

​
AllowedContacts
string[]

List of allowed contact phone numbers

​
BlockedContacts
string[]

List of blocked contact phone numbers

​
KeywordFilter
string

JSON string containing keyword filter configuration

​
NotificationPhones
string[]

Phone numbers to receive filter notifications

​
ApplyToOutbound
boolean

Apply filter to outbound messages

​
ApplyToInbound
boolean

Apply filter to inbound messages

​
BlockUnknownNumbers
boolean

Block messages from unknown numbers

​
BlockLinks
boolean

Block messages containing links

​
BlockMedia
boolean

Block messages containing media

Response

200 - application/json

Message Filter Created

The response is of type object.