V-Spark Online Help

Sample /config JSON Output for a Company

The sample JSON in this section shows sample output for a single company from the /config API.

Figure 1. Sample Company output from the /config API
"DocTestCo": {
    "allowedmodels": [
        "eng1:callcenter",
        "spa1:spa1_callcenter"
    ],
    "apptemplate": [
        "Agent Scorecard",
        "Call Categorization",
        "Call Drivers",
        "Customer Experience"
    ],
    "cloudtoken": "",
    "cloudmodels": [],
    "created": "2017-05-18",
    "limithours": -1,
    "name": "Doc Test Co",
    "retention": -1,
    "status": "OK",
    "servers": [
        "asrsrvr1"
    ],
    "uuid": "077d93ffd9b902b2cb7c6a0c521fd42c"
},... 


Note

Sample JSON files in this document use ellipses (...) to indicate where more than one of a certain type of section can be present in a JSON file of that type.

This excerpt from the output of calling the /config API is very similar to the output that you would have received had you requested information about a single company by calling an API such as the /config/DocTestCo API on a V‑Spark installation where the "Doc Test Co" company (with the company short name, "DocTestCo") had been defined. The latter call would have returned the following, which differs only in that it does not need to identify the short name of the company that it refers to because it was specified in the URL.

Figure 2. Sample Company output from the /config/CO_SHORT API
{
    "uuid": "077d93ffd9b902b2cb7c6a0c521fd42c",
    "name": "Doc Test Co",
    "created": "2018-06-07",
    "limithours": -1,
    "cloudtoken": "",
    "cloudmodels": [],
    "allowedmodels": [
        "eng1:callcenter",
        "spa1:callcenter"
    ],
    "servers": [
        "asr-wvh.office.company.com",
        "asrsrvr1",
        "asrsrvr8",
        "http://asrsrvr8:17171"
    ],
    "retention": -1,
    "apptemplate": [
        "Agent Scorecard",
        "Call Categorization",
        "Call Drivers",
        "Customer Experience"
    ],
    "status": "OK"
} 


Table 1. /config/CO_SHORT Fields

Name

Type

Values

Description

uuid

Read-Only String

33 character token

The authorization token for this company. Use the uuid to retrieve or modify data about any organization, folder, apps, or user that have been defined under this company. This field is added by V‑Spark when the company is created.

"uuid": "077d93ffd9b902b2cb7c6a0c521fd42c"

name

REQUIRED string when creating a new company

The full display name of the company.

"name": "Doc Test Co"

created

Read-Only String

Date, in YYYY-MM-DD format

The year, month, and day that the company was created in V‑Spark. This field is added by V‑Spark when the company is created.

"created": "2018-06-07"

limithours

REQUIRED Integer when creating a new company

"-1" = no limit

The maximum number of audio hours this company can process through V‑Spark. Once that limit has been reached, the company can no longer process new audio, but users can still use V‑Spark to examine existing calls.

"limithours": -1

servers

REQUIRED list of strings if cloudtoken is not set

Hostnames or URLs

Networked computers this company uses as hosts for ASR. This field should only be set if cloudtoken is not set.

"servers": [
    "asr-wvh.office.company.com",
    "asrsrvr1",
    "asrsrvr8",
    "http://asrsrvr8:17171"
]

allowedmodels

List of strings

Limited to installed models

Transcription models that are available to this company when processing audio on servers.

This field should only be set if servers is set.

"allowedmodels": [
    "eng1:callcenter",
    "spa1:callcenter"
]

cloudtoken

REQUIRED string if servers is not set

33 character token

The authorization token this company uses when connecting to V‑Cloud servers. If this company is using servers no cloud token will be listed.

If you are creating the company, and the company will be processing audio on V‑Cloud this field must be defined.

This field should only be set if servers is not set.

"cloudtoken": ""

cloudmodels

List of strings

Limited to installed models

Transcription models this company can use when processing audio on V‑Cloud servers.

This field should only be set if cloudtoken is set and custom models will be used.

"cloudmodels": []

retention

Integer REQUIRED when creating a new company

"-1" = no limit

The maximum number of days transcription data can be retained by V‑Spark for organizations within this company before the data is deleted.

A value of -1 indicates that this company has no limit, and that data is retained indefinitely.

"retention": -1

apptemplate

List of strings

Limited to names of installed templates

This optional list defines the application templates that are available for this company.

"apptemplate": [
    "Agent Scorecard",
    "Call Categorization",
    "Call Drivers",
    "Customer Experience"
]

status

Read-Only string

OK, deleting, deleting (PERCENTAGE)

DELETE status information about the company, useful for long-running operations such as a DELETE. A status of "OK" indicates that any operations on the company have completed their work. For descriptions of the possible statuses, see Getting DELETE Status Information.

"status": "OK"