Retrieve SMS Filter Rules
curl --request GET \
--url https://{brand_domain}/api/mobile/v1/config/filter-rules \
--header 'Authorization: Bearer <token>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{brand_domain}/api/mobile/v1/config/filter-rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://{brand_domain}/api/mobile/v1/config/filter-rules"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{brand_domain}/api/mobile/v1/config/filter-rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{brand_domain}/api/mobile/v1/config/filter-rules"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{brand_domain}/api/mobile/v1/config/filter-rules")
.header("Authorization", "Bearer <token>")
.asString();const url = 'https://{brand_domain}/api/mobile/v1/config/filter-rules';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"data": {
"version": 1,
"updated_at": "2026-06-23T14:15:45Z",
"allowed_senders": [
"bKash",
"Nagad",
"16247"
],
"positive_keywords": [
"received",
"credited",
"TrxID",
"Tk",
"BDT"
],
"negative_keywords": [
"OTP",
"PIN",
"password",
"verify"
],
"check_interval_hours": 24
}
}API Reference
Retrieve SMS Filter Rules
Retrieves the dynamic privacy configuration, whitelisted senders, and positive/negative keywords. The companion app uses this to screen incoming SMS locally before transmitting payloads to the server, protecting customer privacy.
GET
https://{brand_domain}
/
api
/
mobile
/
v1
/
config
/
filter-rules
Retrieve SMS Filter Rules
curl --request GET \
--url https://{brand_domain}/api/mobile/v1/config/filter-rules \
--header 'Authorization: Bearer <token>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{brand_domain}/api/mobile/v1/config/filter-rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://{brand_domain}/api/mobile/v1/config/filter-rules"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{brand_domain}/api/mobile/v1/config/filter-rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{brand_domain}/api/mobile/v1/config/filter-rules"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{brand_domain}/api/mobile/v1/config/filter-rules")
.header("Authorization", "Bearer <token>")
.asString();const url = 'https://{brand_domain}/api/mobile/v1/config/filter-rules';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"data": {
"version": 1,
"updated_at": "2026-06-23T14:15:45Z",
"allowed_senders": [
"bKash",
"Nagad",
"16247"
],
"positive_keywords": [
"received",
"credited",
"TrxID",
"Tk",
"BDT"
],
"negative_keywords": [
"OTP",
"PIN",
"password",
"verify"
],
"check_interval_hours": 24
}
}Last modified on August 25, 2026
Related topics
SMS auto-verificationSubmit Received SMSList SMS TemplatesFeatures and CapabilitiesList Outbound SMS QueueWas this page helpful?