UpdateSmsGroupSendsPerMinute

POST

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

SmsApi

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

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

start_time

string <date-time>

start_time

optional

A Timestamp represents a point in time independent of any time zone or local
calendar, encoded as a count of seconds and fractions of seconds at
nanosecond resolution. The count is relative to an epoch at UTC midnight on
January 1, 1970, in the proleptic Gregorian calendar which extends the
Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
second table is needed for interpretation, using a 24-hour linear
smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
restricting to that range, we ensure that we can convert to and from RFC
3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
.setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from current time in Python.

timestamp = Timestamp()
timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the
RFC 3339 format. That is, the
format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
where {year} is always expressed using four digits while {month}, {day},
{hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
is required. A proto3 JSON serializer should always use UTC (as indicated by
"Z") when printing the Timestamp type and a proto3 JSON parser should be
able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the
standard
toISOString()
method. In Python, a standard datetime.datetime object can be converted
to this format using
strftime with
the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

Examples:

1s1.000340012s

stop_time

string <date-time>

stop_time

optional

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
second table is needed for interpretation, using a 24-hour linear
smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
restricting to that range, we ensure that we can convert to and from RFC
3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
.setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from current time in Python.

timestamp = Timestamp()
timestamp.GetCurrentTime()

JSON Mapping

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
01:30 UTC on January 15, 2017.

Examples:

1s1.000340012s

contact_group_sid_str

string

contact_group_sid_str

optional

Wrapper message for string.

The JSON representation for StringValue is JSON string.

phone_num_col

string

phone_num_col

optional

Wrapper message for string.

The JSON representation for StringValue is JSON string.

use_tz_restrictions

string

use_tz_restrictions

optional

Wrapper message for string.

The JSON representation for StringValue is JSON string.

date_created

string <date-time>

date_created

optional

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
second table is needed for interpretation, using a 24-hour linear
smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
restricting to that range, we ensure that we can convert to and from RFC
3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
.setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from current time in Python.

timestamp = Timestamp()
timestamp.GetCurrentTime()

JSON Mapping

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
01:30 UTC on January 15, 2017.

Examples:

1s1.000340012s

name

string

name

optional

total_cost

number <double>

total_cost

optional

client_name

string

client_name

optional

message_count

integer <int32>

message_count

optional

todays_message_count

integer <int32>

todays_message_count

optional

sms_group_sid

integer <int64> | string

sms_group_sid

optional

country_sid

integer <int64> | string

country_sid

optional

sms_message_sid

integer <int64> | string

sms_message_sid

optional

sends_per_minute

integer <int64> | string

sends_per_minute

optional

status

integer <int64> | string

status

optional

caller_ids

array[string]

caller_ids

optional

total_scheduled

integer <int64> | string

total_scheduled

optional

total_completed

integer <int64> | string

total_completed

optional

contact_group_sid

integer <int64> | string

contact_group_sid

optional

Example

{
  "start_time": "1s",
  "stop_time": "1s",
  "contact_group_sid_str": "string",
  "phone_num_col": "string",
  "use_tz_restrictions": "string",
  "date_created": "1s",
  "name": "string",
  "total_cost": 0,
  "client_name": "string",
  "message_count": 0,
  "todays_message_count": 0,
  "sms_group_sid": 0,
  "country_sid": 0,
  "sms_message_sid": 0,
  "sends_per_minute": 0,
  "status": 0,
  "caller_ids": [
    "string"
  ],
  "total_scheduled": 0,
  "total_completed": 0,
  "contact_group_sid": 0
}

Request 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/updatesmsgroupsendsperminute' \
--header 'Content-Type: application/json' \
--data-raw '{
    "start_time": "1s",
    "stop_time": "1s",
    "contact_group_sid_str": "string",
    "phone_num_col": "string",
    "use_tz_restrictions": "string",
    "date_created": "1s",
    "name": "string",
    "total_cost": 0,
    "client_name": "string",
    "message_count": 0,
    "todays_message_count": 0,
    "sms_group_sid": 0,
    "country_sid": 0,
    "sms_message_sid": 0,
    "sends_per_minute": 0,
    "status": 0,
    "caller_ids": [
        "string"
    ],
    "total_scheduled": 0,
    "total_completed": 0,
    "contact_group_sid": 0
}'

Responses

🟢200OK

application/json

Success

Body

result

boolean

result

optional

Example

{
  "result": true
}

🔴500Server Error

UpdateSmsGroupStatus

UpdateSmsGroupScheduleTimes