> ## 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. # Create Message Filter > Create a new message filter that controls what messages a subscriber can send and receive. **Prerequisites:** - Bearer token — `POST /v1.0/oauth2/tokens` - An existing Subscriber (`TSUID-`) — `POST /v1.0/subscribers/create` - AI Guardian enabled for messages — `POST /v1.0/subscribers/guardian-features` **What this does:** Creates a filter and returns a `MessageFilterId` (`MFID-`). The filter applies to the specified phone number. Configure mode (`ACTIVE`/`MONITOR_ONLY`/`INACTIVE`), allowed/blocked contacts, keyword rules, and restrictions on links, media, and unknown numbers. The filter takes effect immediately. **Next steps:** - Verify it was saved — `GET /v1.0/subscribers/message-filter` - Add trusted contacts that bypass filtering — `POST /v1.0/subscribers/message-filter/allowed-contacts/add` - Add senders to silently drop — `POST /v1.0/subscribers/message-filter/blocked-contacts/add` - Review configured keywords — `GET /v1.0/subscribers/message-filter/keywords` - Update later — `POST /v1.0/subscribers/message-filter/update` ## OpenAPI ````yaml /api-reference/openapi.json post /v1.0/subscribers/message-filter openapi: 3.0.3 info: title: mPaaS Core APIs version: 1.0.8 description: >- The Telegent mPaaS (Mobile Platform as a Service) API gives you full programmatic control over mobile phone numbers, messaging, voice routing, subscribers, and account management. Use these APIs to provision MVNO and IoT numbers, send and receive SMS/MMS, configure intelligent call routing, manage subscriber accounts, and apply AI Guardian controls. All requests require a Bearer token obtained from the Authentication endpoint. For support, visit https://support.telegent.com/support/home contact: name: Support email: support@telegent.com termsOfService: https://telegent.com/terms license: name: Use under LICX url: https://telegent.com/license servers: - url: https://api.telegent.com/v1.0 security: - BearerAuth: [] tags: - name: OAuth2 - name: AI Guardian - name: Accounts - name: Distributors - name: Message - name: Numbers - name: Voicemail - name: Packages - name: Products - name: Schedules - name: Services - name: Sims - name: Subscribers - name: Subscriptions - name: Voice - name: Workgroups paths: /v1.0/subscribers/message-filter: post: tags: - Subscribers summary: Create Message Filter description: >- Create a new message filter that controls what messages a subscriber can send and receive. **Prerequisites:** - Bearer token — `POST /v1.0/oauth2/tokens` - An existing Subscriber (`TSUID-`) — `POST /v1.0/subscribers/create` - AI Guardian enabled for messages — `POST /v1.0/subscribers/guardian-features` **What this does:** Creates a filter and returns a `MessageFilterId` (`MFID-`). The filter applies to the specified phone number. Configure mode (`ACTIVE`/`MONITOR_ONLY`/`INACTIVE`), allowed/blocked contacts, keyword rules, and restrictions on links, media, and unknown numbers. The filter takes effect immediately. **Next steps:** - Verify it was saved — `GET /v1.0/subscribers/message-filter` - Add trusted contacts that bypass filtering — `POST /v1.0/subscribers/message-filter/allowed-contacts/add` - Add senders to silently drop — `POST /v1.0/subscribers/message-filter/blocked-contacts/add` - Review configured keywords — `GET /v1.0/subscribers/message-filter/keywords` - Update later — `POST /v1.0/subscribers/message-filter/update` parameters: [] requestBody: required: true content: application/json: schema: type: object required: - SubscriberId - Phone - FilterMode properties: SubscriberId: type: string description: >- 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: type: string description: >- Phone number this filter applies to. Use E.164 format (e.g., `+15555555555`). Required even when `SubscriberId` is provided. example: '+1234567890' FilterMode: type: string enum: - ACTIVE - MONITOR_ONLY - INACTIVE description: >- 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. example: ACTIVE AllowedContacts: type: array items: type: string description: >- Phone numbers (E.164 format) that bypass content filtering. Messages from these contacts are always delivered without keyword, link, or media checks. BlockedContacts: type: array items: type: string description: >- Phone numbers (E.164 format) blocked from messaging this subscriber. Messages are silently dropped — the sender receives no error. KeywordFilter: type: string description: >- 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: type: array items: type: string description: >- 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: type: boolean description: >- If `true`, filtering applies to messages the subscriber sends out. ApplyToInbound: type: boolean description: >- If `true`, filtering applies to messages the subscriber receives. BlockUnknownNumbers: type: boolean description: >- If `true`, messages from any number not on the allowed contacts list are blocked. BlockLinks: type: boolean description: If `true`, messages that contain URLs are blocked. BlockMedia: type: boolean description: >- If `true`, MMS messages with media attachments (images, video, audio) are blocked. responses: '200': description: Message Filter Created content: application/json: schema: type: object examples: example: value: 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 '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/BadRequest_Result' example: StatusCode: 400 Message: >- Bad request: one or more required fields are missing or contain an invalid value. '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Unauthorized_Result' example: StatusCode: 401 Message: >- Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens. '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Forbidden_Result' example: StatusCode: 403 Message: >- Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope. '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/NotFound_Result' example: StatusCode: 404 Message: >- Not found: the requested resource does not exist or belongs to a different account. '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/MethodNotAllowed_Result' example: StatusCode: 405 Message: >- Method not allowed: verify the HTTP method required for this endpoint. '408': description: Request Timeout content: application/json: schema: $ref: '#/components/schemas/RequestTimeout_Result' example: StatusCode: 408 Message: >- Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff. '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/TooManyRequests_Result' example: StatusCode: 429 Message: >- Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay. '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/InternalServerError_Result' example: StatusCode: 500 Message: >- Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com. '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailable_Result' example: StatusCode: 503 Message: >- Service unavailable: the API is temporarily unavailable. Retry after a short delay. '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/GatewayTimeout_Result' example: StatusCode: 504 Message: >- Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff. x-codeSamples: - lang: JSON source: |- { "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 } - lang: cURL source: >- curl -X POST https://api.telegent.com/v1.0/subscribers/message-filter \ -H 'Authorization: Bearer YOUR_TOKEN' \ -H 'Content-Type: application/json' \ -d '{ "SubscriberId": "SID-C7AB61E0-9AD9-4512-ACA8-EDA284131441", "Phone": "+1234567890", "FilterMode": "ACTIVE", "AllowedContacts": ["+1111111111", "+2222222222"], "BlockedContacts": ["+3333333333"], "NotificationPhones": ["+9999999999"], "ApplyToOutbound": true, "ApplyToInbound": true, "BlockUnknownNumbers": true, "BlockLinks": true, "BlockMedia": true }' components: schemas: BadRequest_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 example: 400 Message: type: string nullable: true example: >- Bad request: one or more required fields are missing or contain an invalid value. additionalProperties: false example: StatusCode: 400 Message: >- Bad request: one or more required fields are missing or contain an invalid value. Unauthorized_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 example: 401 Message: type: string nullable: true example: 'Unauthorized: Bearer token is missing, expired, or invalid.' additionalProperties: false example: StatusCode: 401 Message: 'Unauthorized: Bearer token is missing, expired, or invalid.' Forbidden_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 example: 403 Message: type: string nullable: true example: >- Forbidden: your token does not have permission to access this resource. additionalProperties: false example: StatusCode: 403 Message: >- Forbidden: your token does not have permission to access this resource. NotFound_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 example: 404 Message: type: string nullable: true example: >- Not found: the requested resource does not exist or belongs to a different account. additionalProperties: false example: StatusCode: 404 Message: >- Not found: the requested resource does not exist or belongs to a different account. MethodNotAllowed_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 example: 405 Message: type: string nullable: true example: >- Method not allowed: verify the HTTP method required for this endpoint. additionalProperties: false example: StatusCode: 405 Message: 'Method not allowed: verify the HTTP method required for this endpoint.' RequestTimeout_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 example: 408 Message: type: string nullable: true example: >- Request timeout: the server did not receive a complete request in time. additionalProperties: false example: StatusCode: 408 Message: >- Request timeout: the server did not receive a complete request in time. TooManyRequests_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 example: 429 Message: type: string nullable: true example: >- Too many requests: rate limit exceeded. Slow your request cadence and retry. additionalProperties: false example: StatusCode: 429 Message: >- Too many requests: rate limit exceeded. Slow your request cadence and retry. InternalServerError_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 example: 500 Message: type: string nullable: true example: 'Internal server error: an unexpected error occurred.' additionalProperties: false example: StatusCode: 500 Message: 'Internal server error: an unexpected error occurred.' ServiceUnavailable_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 example: 503 Message: type: string nullable: true example: 'Service unavailable: the API is temporarily unavailable.' additionalProperties: false example: StatusCode: 503 Message: 'Service unavailable: the API is temporarily unavailable.' GatewayTimeout_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 example: 504 Message: type: string nullable: true example: 'Gateway timeout: an upstream service did not respond in time.' additionalProperties: false example: StatusCode: 504 Message: 'Gateway timeout: an upstream service did not respond in time.' ````