ListSmsGroupByFilters

POST

https://api.cbf.tcn.com/api/v0alpha/smsapi/listsmsgroupbyfilters

List Sms Group defined by ListSmsGroupByFiltersReq message.
Gets all details belong to the clientsid with filters
The method will return a stream of ListSmsGroupByFiltersRes messages
containing SmsGroup Info and SMSIntent
Required permissions: VIEW_SMS

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "search_from": "1s",
    "search_to": "1s",
    "status": "string",
    "name": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v0alpha/smsapi/listsmsgroupbyfilters' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "search_from": "1s",
    "search_to": "1s",
    "status": "string",
    "name": "string"
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "sms_group_with_intents": [
        {
            "sms_group_info_res": {
                "sms_group_sid": 0,
                "country_sid": 0,
                "sms_message_sid": 0,
                "name": "string",
                "start_time": "1s",
                "stop_time": "1s",
                "sends_per_minute": 0,
                "status": 0,
                "total_cost": 0,
                "caller_ids": [
                    "string"
                ],
                "client_name": "string",
                "total_scheduled": 0,
                "total_completed": 0,
                "contact_group_sid_str": "string",
                "contact_group_sid": 0,
                "phone_num_col": "string",
                "use_tz_restrictions": "string",
                "message_count": 0,
                "todays_message_count": 0,
                "date_created": "1s"
            },
            "sms_intent_groups": [
                {
                    "sms_intent_group_sid": 0,
                    "sms_group_sid": 0,
                    "name": "string",
                    "description": "string",
                    "action_key": "string",
                    "action_detail": "string",
                    "action_trigger": "string",
                    "priority": 0
                }
            ],
            "sms_mam_settings": {
                "mam_hg_sid": "string",
                "mam_hg_name": "string"
            }
        }
    ]
}

🟢200Success

Modified at 2025-09-26 15:44:58

SendSmsNotification

ListSmsGroupsByGroupSids