GetCategory - TCN API

GetCategory gets a scorecard category

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

GetCategoryRequest is request to get a category by id.

title

string

title

optional

Required. Must set category_id or title.

category_id

integer <int64> | string

category_id

optional

Required. Must set category_id or title.

Example

{
    "title": "string",
    "category_id": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

GetCategoryResponse returns the category.

category

optional

Category wraps a set of skills (or labels).
A scorecard can only be used to evaluate calls
with the same skill(s) as its category.

category_type

enum<string>

category_type

optional

Type of category, (skill calls or manual calls)

Allowed values:

INVALIDSKILL_CALLSMANUAL_DIAL

author_id

string

author_id

optional

user who created the category

title

string

title

optional

title, or name, of the category

description

string

description

optional

description of category (i.e. purpose and use)

version

integer <int32>

version

optional

current version of the category

call_types

array[string]

call_types

deprecated

Deprecated. Use scorecard.call_types

Allowed values:

INBOUNDOUTBOUNDPREVIEWMANUALMAC

is_system

boolean

is_system

optional

whether a category is a system category (read only)

category_id

integer <int64> | string

category_id

optional

unique id of the category

skill_profiles

array[integer <int64> | string]

skill_profiles

optional

skill_profiles ids related to category

skill_profile_group_sids

array[integer <int64> | string]

skill_profile_group_sids

optional

skill_profile_group_sids related to category

Example

{
    "category": {
        "category_type": "INVALID",
        "author_id": "string",
        "title": "string",
        "description": "string",
        "version": 0,
        "call_types": [
            "INBOUND"
        ],
        "is_system": true,
        "category_id": 0,
        "skill_profiles": [
            0
        ],
        "skill_profile_group_sids": [
            0
        ]
    }
}

🔴500Server Error