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"],
  "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
}
{
  "FilterId": "MFID-7435d672-a2d0-451e-ab62-45499f5bc7a1",
  "SubscriberId": "TSUID-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
}

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.

Authorizations

​
Authorization
string
header
required

Enter the token obtained from the Authentication endpoint

Body

application/json
​
SubscriberId
string
required

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.

Example:

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

​
Phone
string
required

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

Example:

"+1234567890"

​
FilterMode
enum<string>
required

Controls how the filter behaves. ACTIVE: rules are enforced — messages that violate the filter are blocked. MONITOR_ONLY: violations are logged and notifications are sent, but messages are still delivered. INACTIVE: filter is paused and has no effect.

Available options:
ACTIVE,
MONITOR_ONLY,
INACTIVE
Example:

"ACTIVE"

​
AllowedContacts
string[]

Phone numbers (E.164 format) that bypass content filtering. Messages from these contacts are always delivered without keyword, link, or media checks.

​
BlockedContacts
string[]

Phone numbers (E.164 format) blocked from messaging this subscriber. Messages are silently dropped — the sender receives no error.

​
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.

​
NotificationPhones
string[]

Phone numbers (E.164 format) that receive an SMS 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 messages the subscriber sends out.

​
ApplyToInbound
boolean

If true, filtering applies to messages the subscriber receives.

​
BlockUnknownNumbers
boolean

If true, messages from any number not on the allowed contacts list are blocked.

​
BlockLinks
boolean

If true, messages that contain URLs are blocked.

​
BlockMedia
boolean

If true, MMS messages with media attachments (images, video, audio) are blocked.

Response

200 - application/json

Message Filter Created

The response is of type object.