TCN API

ListRateDefinitions

POST

https://api.cbf.tcn.com/services/billing/v1alpha2/listratedefinitions

BillingService

Lists rate definitions.
Required permissions:
CUSTOMER_SUPPORT
Errors:

grpc.Internal: An internal error occurred.

grpc.InvalidArgument: The request is invalid.

grpc.PermissionDenied: Caller doesn't have the required permissions.

grpc.Unavailable: The operation is currently unavailable.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

fields

string

fields

optional

Optional: defaults to all fields.

page

object (Page)

page

optional

Optional: defaults to no paging.

token

string

token

optional

Optional: if not specified, will start from the beginning

limit

integer <int64> | string

limit

optional

Optional: if not specified, will not paginate

rate_definition_id

string

rate_definition_id

optional

filter

string

filter

optional

Optional: defaults to no filter

sort

array[object (Sort) {2}]

sort

optional

Optional: defaults to no sort.

direction

enum<string>

direction

optional

Required: direction to sort by

Allowed values:

ORDER_UNSPECIFIEDORDER_DESC

key

string

key

optional

Required: key to sort by

Example

{
  "fields": "string",
  "page": {
    "token": "string",
    "limit": 0
  },
  "rate_definition_id": "string",
  "filter": "string",
  "sort": [
    {
      "direction": "ORDER_UNSPECIFIED",
      "key": "string"
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/services/billing/v1alpha2/listratedefinitions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fields": "string",
    "page": {
        "token": "string",
        "limit": 0
    },
    "rate_definition_id": "string",
    "filter": "string",
    "sort": [
        {
            "direction": "ORDER_UNSPECIFIED",
            "key": "string"
        }
    ]
}'

Responses

🟢200OK

application/json

Success

Body

rate_definitions

array[object (RateDefinition) {14}]

rate_definitions

optional

event_type

enum<string>

event_type

optional

This enum will hold all application classes and sub-classes
Classes are encoded as hundreds (100, 200...) and sub-classes are the class ID + 0..99.

EventType is the source for typing subscriptions, notifications, and any future
event use cases such auditing, billing, logging, etc. (anything triggered by audit).

Follow the pattern of (product + event description), separated by underscores.

e.g. PRODUCT_EVENT_DESCRIPTION

EventTypes that trigger notifications should read nicely as a system message header.

e.g Product Event Description

Allowed values:

DUMMY_APPLICATIONDUMMY_APPLICATION_STORAGEDUMMY_APPLICATION_COMPUTEVOICE_ANALYTICSVOICE_ANALYTICS_FLAG_OCCURRENCEVOICE_ANALYTICS_FLAG_NEEDS_REVIEWVOICE_ANALYTICS_BILLING_REPORTVOICE_ANALYTICS_FLAG_SUMMARYVOICE_ANALYTICS_PHRASE_CORRECTIONVOICE_ANALYTICS_CREATE_TRANSCRIPTVOICE_ANALYTICS_CREATE_SENTIMENTVOICE_ANALYTICS_CREATE_SUMMARYOMNICHANNELOMNICHANNEL_PROJECTOMNICHANNEL_CAMPAIGNOMNICHANNEL_DAILY_PROJECT_REPORTOMNICHANNEL_DAILY_CONVERSATION_REPORTOMNICHANNEL_AGENT_ASSIGN_CONVERSATIONOMNICHANNEL_AGENT_UNASSIGN_CONVERSATIONOMNICHANNEL_AGENT_REASSIGN_CONVERSATIONOMNICHANNEL_T10OMNICHANNEL_CUSTOMER_TEXT_MESSAGEOMNICHANNEL_AGENT_TEXT_MESSAGEOMNICHANNEL_FINISH_WRAP_UPOMNICHANNEL_BEGIN_WRAP_UPOMNICHANNEL_T11OMNICHANNEL_CREATE_CONVERSATIONOMNICHANNEL_AGENT_SUSPENDOMNICHANNEL_CLOSE_CONVERSATIONOMNICHANNEL_MANAGER_TEXT_MESSAGEOMNICHANNEL_UPDATE_CAMPAIGNOMNICHANNEL_SET_CONVERSATION_COLLECTED_DATAOMNICHANNEL_ARCHIVE_CAMPAIGNOMNICHANNEL_PAUSE_CAMPAIGNOMNICHANNEL_RESUME_CAMPAIGNOMNICHANNEL_START_CAMPAIGNOMNICHANNEL_SCHEDULE_MODULEOMNICHANNEL_START_MODULEOMNICHANNEL_PAUSE_MODULEOMNICHANNEL_RESUME_MODULEOMNICHANNEL_ERROR_MODULEOMNICHANNEL_SUCCESS_MODULEOMNICHANNEL_FAIL_MODULEOMNICHANNEL_COMPLETE_MODULEOMNICHANNEL_ARCHIVE_MODULEOMNICHANNEL_UPDATE_MODULEOMNICHANNEL_MODULE_SMS_MESSAGE_SENTOMNICHANNEL_COMPLETE_CAMPAIGNOMNICHANNEL_MODULE_INITIAL_REPLYOMNICHANNEL_TASK_MESSAGE_SENTOMNICHANNEL_CONNECTED_INBOX_POLLOMNICHANNEL_CONNECTED_INBOX_CREATEDOMNICHANNEL_AGENT_MESSAGE_UNITSOMNICHANNEL_MANAGER_MESSAGE_UNITSOMNICHANNEL_CUSTOMER_MESSAGE_UNITSOMNICHANNEL_SYSTEM_MESSAGE_UNITSOMNICHANNEL_PAYMENT_LINK_SENTOMNICHANNEL_MANUAL_APPROVE_TASK_ACCEPTEDOMNICHANNEL_MANUAL_APPROVE_TASK_REJECTEDOMNICHANNEL_MANUAL_APPROVE_TASK_TIMEOUTOMNICHANNEL_MANUAL_APPROVE_TASK_REQUEUEOMNICHANNEL_TRANSCRIPT_SAVEDOMNICHANNEL_MESSAGE_SENTOMNICHANNEL_PROVIDER_RESPONSEOMNICHANNEL_PROVIDER_MESSAGE_FAILEDASM_AGENT_LOGINASM_OPEN_VOICEASM_OPEN_OMNI_AGENTASM_ACTIVATE_CONVERSATIONASM_DEACTIVATE_CONVERSATIONASM_AGENT_STATE_CHANGEDASM_AGENT_LOGOUTASM_PAUSE_EVENTASM_RESUME_EVENTASM_CONVERSATION_PULLED_EVENTSCORECARDS_CREATE_QUESTION_EVENTSCORECARDS_UPDATE_QUESTION_EVENTSCORECARDS_DELETE_QUESTION_EVENTSCORECARDS_CREATE_SCORECARD_EVENTSCORECARDS_UPDATE_SCORECARD_EVENTSCORECARDS_DELETE_SCORECARD_EVENTSCORECARDS_CLONE_SCORECARD_EVENTSCORECARDS_CREATE_EVALUATION_EVENTSCORECARDS_DELETE_EVALUATION_EVENTSCORECARDS_CREATE_SECTION_EVENTSCORECARDS_UPDATE_SECTION_EVENTSCORECARDS_DELETE_SECTION_EVENTSCORECARDS_CREATE_CATEGORY_EVENTSCORECARDS_UPDATE_CATEGORY_EVENTSCORECARDS_DELETE_CATEGORY_EVENTSCORECARDS_CREATE_EVALUATION_QUESTION_EVENTSCORECARDS_UPDATE_EVALUATION_QUESTION_EVENTSCORECARDS_DELETE_EVALUATION_QUESTION_EVENTSCORECARDS_CREATE_SCORECARD_QUESTION_EVENTSCORECARDS_UPDATE_SCORECARD_QUESTION_EVENTSCORECARDS_DELETE_SCORECARD_QUESTION_EVENTSCORECARDS_CREATE_AUTO_EVALUATION_EVENTSCORECARDS_UPDATE_EVALUATION_EVENTSCORECARDS_CREATE_SMART_EVALUATION_EVENTTICKET_CREATE_EVENTTICKET_EDIT_EVENTTICKET_CLOSE_EVENTTICKET_ACTION_CREATE_EVENTTICKET_ACTION_EDIT_EVENTTICKET_ACTION_STATE_CHANGE_EVENTTICKET_PARTICIPANT_EVENTTICKET_CREATE_COMMENT_EVENTTICKET_REPLY_COMMENT_EVENTTICKET_TEMPLATE_CREATE_EVENTTICKET_TEMPLATE_EDIT_EVENTTICKET_TEMPLATE_CLOSE_EVENTTICKET_TEMPLATE_ASSIGN_EVENTTICKET_TEMPLATE_STATE_CHANGE_EVENTTICKET_PROJECT_STATE_CHANGE_EVENTTICKET_CONTACT_ADD_EVENTTICKET_CUSTOM_FIELD_CREATE_EVENTTICKET_CUSTOM_FIELD_EDIT_EVENTCOMPLIANCE_RND_QUERY_EVENTCOMPLIANCE_RND_QUERY_CACHED_EVENTAGENT_TRAINING_CREATE_LEARNING_OPPORTUNITY_EVENTLMS_PIPELINE_FAILURE_EVENTLMS_PIPELINE_NO_OUTPUT_EVENTLMS_PIPELINE_SUCCESSFUL_EVENTEVENT_TYPE_BILLING_COMMIT_BILLING_PLANEVENT_TYPE_BILLING_CREATE_BILLING_PLANEVENT_TYPE_BILLING_CREATE_INVOICEEVENT_TYPE_BILLING_CREATE_RATE_DEFINITIONEVENT_TYPE_BILLING_DELETE_BILLING_PLANEVENT_TYPE_BILLING_DELETE_INVOICEEVENT_TYPE_BILLING_DELETE_RATE_DEFINITIONEVENT_TYPE_BILLING_EXPORT_INVOICEEVENT_TYPE_BILLING_UPDATE_BILLING_PLANEVENT_TYPE_BILLING_UPDATE_INVOICEEVENT_TYPE_BILLING_UPDATE_RATE_DEFINITIONEVENT_TYPE_BILLING_RATED_ITEMS_GENERATEDEVENT_TYPE_BILLING_ACCUMULATE_ITEMSEVENT_TYPE_DELIVERY_FAILUREEVENT_TYPE_DELIVERY_SUCCESSEVENT_TYPE_CONTACT_MANAGER_ADD_EVENTEVENT_TYPE_CONTACT_MANAGER_ENTRY_VIEW_EVENTEVENT_TYPE_CONTACT_MANAGER_KYC_ENC_VIEW_EVENTEVENT_TYPE_CONTACT_MANAGER_TTL_EVENTEVENT_TYPE_CONTACT_MANAGER_EDIT_EVENTEVENT_TYPE_CONTACT_MANAGER_UPLOAD_EVENTEVENT_TYPE_CONTACT_MANAGER_VERIFICATION_EVENTEVENT_TYPE_CONTACT_MANAGER_DELETE_EVENTEVENT_TYPE_CONTACT_MANAGER_EXPUNGE_EVENTEVENT_TYPE_CONTACT_MANAGER_ENTITY_ASSOCIATED_EVENTEVENT_TYPE_ORGANIZATION_ACCESS_TOKENS_EXPIRING_EVENTEVENT_TYPE_WFM_PUBLISH_SCHEDULE_EVENTEVENT_TYPE_P3_AMQP_CALL_RESULT_EVENTEVENT_TYPE_P3_AMQP_AGENT_RESPONSE_EVENT

config_type

enum<string>

config_type

optional

RateDefinitionConfigType defines the type of configuration for a rate definition.

Allowed values:

RATE_DEFINITION_CONFIG_TYPE_UNSPECIFIEDRATE_DEFINITION_CONFIG_TYPE_NOOPRATE_DEFINITION_CONFIG_TYPE_OMNI_AGENT_SEATSRATE_DEFINITION_CONFIG_TYPE_OMNI_CONNECTED_INBOX_POLLRATE_DEFINITION_CONFIG_TYPE_OMNI_CONNECTED_INBOX_CREATEDRATE_DEFINITION_CONFIG_TYPE_OMNI_AGENT_MESSAGE_CHATRATE_DEFINITION_CONFIG_TYPE_OMNI_AGENT_MESSAGE_CHAT_SIZERATE_DEFINITION_CONFIG_TYPE_OMNI_AGENT_MESSAGE_CHAT_UNITSRATE_DEFINITION_CONFIG_TYPE_OMNI_AGENT_MESSAGE_CHAT_SIZE_TOTALRATE_DEFINITION_CONFIG_TYPE_OMNI_AGENT_MESSAGE_EMAILRATE_DEFINITION_CONFIG_TYPE_OMNI_AGENT_MESSAGE_EMAIL_SIZERATE_DEFINITION_CONFIG_TYPE_OMNI_AGENT_MESSAGE_EMAIL_UNITSRATE_DEFINITION_CONFIG_TYPE_OMNI_AGENT_MESSAGE_EMAIL_SIZE_TOTALRATE_DEFINITION_CONFIG_TYPE_OMNI_AGENT_MESSAGE_SMSRATE_DEFINITION_CONFIG_TYPE_OMNI_AGENT_MESSAGE_SMS_SIZERATE_DEFINITION_CONFIG_TYPE_OMNI_AGENT_MESSAGE_SMS_UNITSRATE_DEFINITION_CONFIG_TYPE_OMNI_AGENT_MESSAGE_SMS_SIZE_TOTALRATE_DEFINITION_CONFIG_TYPE_OMNI_MANAGER_MESSAGE_CHATRATE_DEFINITION_CONFIG_TYPE_OMNI_MANAGER_MESSAGE_CHAT_SIZERATE_DEFINITION_CONFIG_TYPE_OMNI_MANAGER_MESSAGE_CHAT_UNITSRATE_DEFINITION_CONFIG_TYPE_OMNI_MANAGER_MESSAGE_CHAT_SIZE_TOTALRATE_DEFINITION_CONFIG_TYPE_OMNI_MANAGER_MESSAGE_EMAILRATE_DEFINITION_CONFIG_TYPE_OMNI_MANAGER_MESSAGE_EMAIL_SIZERATE_DEFINITION_CONFIG_TYPE_OMNI_MANAGER_MESSAGE_EMAIL_UNITSRATE_DEFINITION_CONFIG_TYPE_OMNI_MANAGER_MESSAGE_EMAIL_SIZE_TOTALRATE_DEFINITION_CONFIG_TYPE_OMNI_MANAGER_MESSAGE_SMSRATE_DEFINITION_CONFIG_TYPE_OMNI_MANAGER_MESSAGE_SMS_SIZERATE_DEFINITION_CONFIG_TYPE_OMNI_MANAGER_MESSAGE_SMS_UNITSRATE_DEFINITION_CONFIG_TYPE_OMNI_MANAGER_MESSAGE_SMS_SIZE_TOTALRATE_DEFINITION_CONFIG_TYPE_OMNI_SYSTEM_MESSAGE_CHATRATE_DEFINITION_CONFIG_TYPE_OMNI_SYSTEM_MESSAGE_CHAT_SIZERATE_DEFINITION_CONFIG_TYPE_OMNI_SYSTEM_MESSAGE_CHAT_UNITSRATE_DEFINITION_CONFIG_TYPE_OMNI_SYSTEM_MESSAGE_CHAT_SIZE_TOTALRATE_DEFINITION_CONFIG_TYPE_OMNI_SYSTEM_MESSAGE_EMAILRATE_DEFINITION_CONFIG_TYPE_OMNI_SYSTEM_MESSAGE_EMAIL_SIZERATE_DEFINITION_CONFIG_TYPE_OMNI_SYSTEM_MESSAGE_EMAIL_UNITSRATE_DEFINITION_CONFIG_TYPE_OMNI_SYSTEM_MESSAGE_EMAIL_SIZE_TOTALRATE_DEFINITION_CONFIG_TYPE_OMNI_SYSTEM_MESSAGE_SMSRATE_DEFINITION_CONFIG_TYPE_OMNI_SYSTEM_MESSAGE_SMS_SIZERATE_DEFINITION_CONFIG_TYPE_OMNI_SYSTEM_MESSAGE_SMS_UNITSRATE_DEFINITION_CONFIG_TYPE_OMNI_SYSTEM_MESSAGE_SMS_SIZE_TOTALRATE_DEFINITION_CONFIG_TYPE_OMNI_CUSTOMER_MESSAGE_CHATRATE_DEFINITION_CONFIG_TYPE_OMNI_CUSTOMER_MESSAGE_CHAT_SIZERATE_DEFINITION_CONFIG_TYPE_OMNI_CUSTOMER_MESSAGE_CHAT_UNITSRATE_DEFINITION_CONFIG_TYPE_OMNI_CUSTOMER_MESSAGE_CHAT_SIZE_TOTALRATE_DEFINITION_CONFIG_TYPE_OMNI_CUSTOMER_MESSAGE_EMAILRATE_DEFINITION_CONFIG_TYPE_OMNI_CUSTOMER_MESSAGE_EMAIL_SIZERATE_DEFINITION_CONFIG_TYPE_OMNI_CUSTOMER_MESSAGE_EMAIL_UNITSRATE_DEFINITION_CONFIG_TYPE_OMNI_CUSTOMER_MESSAGE_EMAIL_SIZE_TOTALRATE_DEFINITION_CONFIG_TYPE_OMNI_CUSTOMER_MESSAGE_SMSRATE_DEFINITION_CONFIG_TYPE_OMNI_CUSTOMER_MESSAGE_SMS_SIZERATE_DEFINITION_CONFIG_TYPE_OMNI_CUSTOMER_MESSAGE_SMS_UNITSRATE_DEFINITION_CONFIG_TYPE_OMNI_CUSTOMER_MESSAGE_SMS_SIZE_TOTALRATE_DEFINITION_CONFIG_TYPE_COMPLIANCE_RND_QUERYRATE_DEFINITION_CONFIG_TYPE_COMPLIANCE_RND_QUERY_CACHED

matching_rule

enum<string>

matching_rule

optional

MatchingRule represents a rule for matching an event to a
rate definition.

Allowed values:

MATCHING_RULE_UNSPECIFIEDMATCHING_RULE_COUNTRY_PREFIX

matching_config

optional

MatchingConfig represents the configuration for matching
an event to a rate definition.

create_time

string <date-time>

create_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

update_time

string <date-time>

update_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

delete_time

string <date-time>

delete_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

effective_time

string <date-time>

effective_time

optional

the time this rate definition becomes effective (or now if not set)

Examples:

1s1.000340012s

config

optional

the configuration for this definition

rate_definition_id

string

rate_definition_id

optional

matching_sha

string

matching_sha

optional

a hash of the matching rule and config

group_id

string

group_id

optional

a group identifier for this rate definition; optional

config_sha

string

config_sha

optional

a hash of the config

thread_id

string

thread_id

optional

the thread id for this rate definition; generated by the system
on creation of a default rate definition, otherwise needs to be
set on create requests.

token

string

token

optional

Optional: only present if paginating.

Example

{
  "rate_definitions": [
    {
      "event_type": "DUMMY_APPLICATION",
      "config_type": "RATE_DEFINITION_CONFIG_TYPE_UNSPECIFIED",
      "matching_rule": "MATCHING_RULE_UNSPECIFIED",
      "matching_config": {
        "country_prefix": {
          "country_code": 0,
          "prefixes": [
            "string"
          ]
        }
      },
      "create_time": "1s",
      "update_time": "1s",
      "delete_time": "1s",
      "effective_time": "1s",
      "config": {
        "agent_message_chat": {
          "rate_decimal": {
            "value": "string"
          },
          "rate": 0
        }
      },
      "rate_definition_id": "string",
      "matching_sha": "string",
      "group_id": "string",
      "config_sha": "string",
      "thread_id": "string"
    }
  ],
  "token": "string"
}

🔴500Server Error

ListActiveRateDefinitions

UpdateDefaultRateDefinition