UpdateSmsGroupStatus

POST

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

Update the Scheduled Sms group defined by SmsGroupInfo message for the specified
paused/unpaused/cancel status
The method will return a UpdateSmsGroupRes message with true or false .
Required permissions: EXECUTE_SEND_BROADCAST

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "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"
}

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/updatesmsgroupstatus' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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"
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "result": true
}

🟢200Success

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

ListSmsTasksWithDetailedStatus

UpdateSmsGroupSendsPerMinute