GetInboundSmsTemplateById

POST

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

SmsApi

Gets an InboundSmsTemplate group defined by GetInboundSmsTemplateByIdReq message for the specified
inbound_sms_template_id, region_id and org_id.
The method will return a InboundTemplate group.
Required permissions: VIEW_SMS

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

inbound_sms_template_id

string

inbound_sms_template_id

optional

Example

{
  "inbound_sms_template_id": "string"
}

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/getinboundsmstemplatebyid' \
--header 'Content-Type: application/json' \
--data-raw '{
    "inbound_sms_template_id": "string"
}'

Responses

🟢200OK

application/json

Success

Body

inbound_sms_template

object (InboundSmsTemplate)

inbound_sms_template

optional

report_settings

object (ReportSettings)

report_settings

optional

last_updated

string <date-time>

last_updated

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

inbound_sms_template_id

string

inbound_sms_template_id

optional

name

string

name

optional

sms_number_sid

integer <int64> | string

sms_number_sid

optional

sms_intent_templates

array[object (SmsIntentTemplate) {8}]

sms_intent_templates

optional

last_updated

string <date-time>

last_updated

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

description

string

description

optional

action_key

string

action_key

optional

action_detail

string

action_detail

optional

action_trigger

string

action_trigger

optional

sms_intent_template_sid

integer <int64> | string

sms_intent_template_sid

optional

priority

integer <int64> | string

priority

optional

Example

{
  "inbound_sms_template": {
    "report_settings": {
      "sms_settings": {
        "src_number": "string",
        "phone_numbers": [
          "string"
        ]
      },
      "email_settings": {
        "report_type": "string",
        "report_format": "string",
        "from_email_address": "string",
        "email_addresses": [
          "string"
        ]
      },
      "ftp_settings": {
        "passwd": "string",
        "username": "string",
        "report_format": "string",
        "path": "string",
        "url": "string"
      },
      "sftp_settings": {
        "passwd": "string",
        "username": "string",
        "report_format": "string",
        "path": "string",
        "authentication_type": "string",
        "url": "string",
        "private_key": "string"
      },
      "enabled": true,
      "delivery_method": "string",
      "report_template_sid": 0
    },
    "last_updated": "1s",
    "inbound_sms_template_id": "string",
    "name": "string",
    "sms_number_sid": 0
  },
  "sms_intent_templates": [
    {
      "last_updated": "1s",
      "name": "string",
      "description": "string",
      "action_key": "string",
      "action_detail": "string",
      "action_trigger": "string",
      "sms_intent_template_sid": 0,
      "priority": 0
    }
  ]
}

🔴500Server Error

ListInboundSmsTemplates

CreateInboundSmsGroup