Filter Rule

Access SMS filter rule configurations used for real-time allowlist and blocklist filtering. Retrieve lists of filter rules and detailed information about a specific filter rule by ID.

Each filter rule is scoped to a specific traffic type, identified by the required trafficTypeCname query parameter (SMSMOINBOUND, SMSMTINBOUND, or SMSMTOUTBOUND), so the same rule name can exist independently for MO, MT-inbound, and MT-outbound SMS traffic. A rule carries a type, a numeric errorCode returned when the rule triggers a rejection, and identifiers linking it back to its traffic type.

Filter rule definitions themselves are read-only through this API; only their allowlist/blocklist entries — managed via the Filter Rule Value API — can be created, updated, or deleted here. Results can be paginated, sorted, and filtered by fields such as name, type, errorCode, and trafficTypeName.