ScheduleSms

POST

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

Schedule Sms group defined by ScheduleSmsReq message for the specified
sms_template_id with initialpace, sourcenumber, contactgroupsid
The method will return a Sms group.
Required permissions: EXECUTE_SEND_BROADCAST

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "sms_template_sid": 0,
    "initial_pace": 0,
    "selected_phone_col": "string",
    "source_number": "string",
    "country_sid": 0,
    "timezone_restrictions": true,
    "group_name": "string",
    "contact_group_sid": 0,
    "start_time": "1s",
    "stop_time": "1s",
    "selected_mam_hunt_group": "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/schedulesms' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sms_template_sid": 0,
    "initial_pace": 0,
    "selected_phone_col": "string",
    "source_number": "string",
    "country_sid": 0,
    "timezone_restrictions": true,
    "group_name": "string",
    "contact_group_sid": 0,
    "start_time": "1s",
    "stop_time": "1s",
    "selected_mam_hunt_group": "string"
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "sms_group_sid": 0
}

🟢200Success

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

UpdateSmsGroupScheduleTimes

ResendUnconnectedSms