Config API Version 2 Custom Vocabulary

Introduction

The Custom Vocabulary section of the Config API allows you to create, read, update and delete dictionaries and vocab terms that have been created for the given IGRP. These dictionaries and terms aid the call transcription engine to accurately transcribe your call recordings.

List Dictionaries

Returns a list of all dictionaries for the given IGRP.

Request:

GET /config/v2/igrps/{igrpSpec}/dictionaries

Segment Params

igrpSpec (spec) - IGRP ID (integer).

GET Params

filter (array) OPTIONAL - One or more filters.
sort (array) OPTIONAL - One or more sorting params.
limit (integer) OPTIONAL - Limit on the result set.
offset (integer) OPTIONAL - Offset on the result set.

Filter Types

dictionaryName (string) - Dictionary name.

Sort Types

Same as Filter Types

Response:

All dictionaries for the given IGRP spec.

dictionaryId (integer) - Dictionary ID.
igrp (integer) - Installation ID.
dictionaryName (string) - Dictionary name.
createDatetime (string) - Date and time when the Dictionary was created.
updateDatetime (string) - Date and time when the Dictionary was last updated.

{"dictionaryId":"2","igrp":"2","dictionaryName":"General","createDatetime":"2018-01-15 12:41:35","updateDatetime":"2018-01-15 12:41:45"}
{"dictionaryId":"3","igrp":"2","dictionaryName":"Support","createDatetime":"2018-01-15 12:41:35","updateDatetime":"2018-01-15 12:41:45"}

Read Dictionary

Returns a single row dictionary for the given IGRP ID and dictionary ID.

Request:

GET /config/v2/igrps/{igrpSpec}/dictionaries/{dictionarySpec}

Segment Params

igrpSpec (spec) - IGRP ID (integer).
dictionarySpec (spec) - Dictionary ID (integer).

Response:

Single row of the dictionary details.

dictionaryId (integer) - Dictionary ID.
igrp (integer) - Installation ID.
dictionaryName (string) - Dictionary name.
createDatetime (string) - Date and time when the Dictionary was created.
updateDatetime (string) - Date and time when the Dictionary was last updated.

{"dictionaryId":"3","igrp":"2","dictionaryName":"Support","createDatetime":"2018-01-15 12:41:35","updateDatetime":"2018-01-15 12:41:45"}

List Dictionary Terms

Returns a list of all terms for the given Dictionary ID.

Request:

GET /config/v2/igrps/{igrpSpec}/dictionaries/{dictionarySpec}/terms

Segment Params

igrpSpec (spec) - IGRP ID (integer).
dictionarySpec (spec) - Dictionary ID (integer).

GET Params

filter (array) OPTIONAL - One or more filters.
sort (array) OPTIONAL - One or more sorting params.
limit (integer) OPTIONAL - Limit on the result set.
offset (integer) OPTIONAL - Offset on the result set.

Filter Types

term (string) - Term word or phrase.
weight (integer) - A term weight from 0 to 3.

Sort Types

Same as Filter Types

Response:

All terms for the given Dictionary and IGRP spec.

termId (integer) - Term ID.
dictionaryId (integer) - Dictionary ID this term belongs to.
term (string) - Term word or phrase (the jargon, pronoun or acronym).
weight (integer) - A numeric value between 0 and 3 that is used to increase the chances of the term being transcribed.
pronunciations (array) - An array of alternative pronunciations for the term.
createDatetime (string) - Date and time when the Dictionary term was created.
updateDatetime (string) - Date and time when the Dictionary term was last updated.

{"termId":"1","dictionaryId":"2","term":"gnocchi","weight":"0","pronunciations":["nokey","nochi"],"createDatetime":"2018-01-17 11:54:03","updateDatetime":"2018-01-17 11:54:29"}
{"termId":"2","dictionaryId":"2","term":"CEO","weight":"0","pronunciations":["C.E.O."],"createDatetime":"2018-01-17 11:54:03","updateDatetime":"2018-01-17 11:54:29"}
{"termId":"3","dictionaryId":"2","term":"Infinity","weight":"1","pronunciations":"","createDatetime":"2018-01-17 11:54:03","updateDatetime":"2018-01-17 11:54:29"}

Read Dictionary Term

Returns a single row term for the given Dictionary ID and Term ID.

Request:

GET /config/v2/igrps/{igrpSpec}/dictionaries/{dictionarySpec}/terms/{termSpec}

Segment Params

igrpSpec (spec) - IGRP ID (integer).
dictionarySpec (spec) - Dictionary ID (integer).
termSpec (spec) - Term ID (integer).

Response:

Single row of the term details.

termId (integer) - Term ID.
dictionaryId (integer) - Dictionary ID this term belongs to.
term (string) - Term word or phrase (the jargon, pronoun or acronym).
weight (integer) - A numeric value between 0 and 3 that is used to increase the chances of the term being transcribed.
pronunciations (array) - An array of alternative pronunciations for the term.
createDatetime (string) - Date and time when the Dictionary term was created.
updateDatetime (string) - Date and time when the Dictionary term was last updated.

{"termId":"2","dictionaryId":"2","term":"CEO","weight":"0","pronunciations":["C.E.O."],"createDatetime":"2018-01-17 11:54:03","updateDatetime":"2018-01-17 11:54:29"}

Create Dictionary Term

Create a new term for given Dictionary ID.

Request:

POST /config/v2/igrps/{igrpSpec}/dictionaries/{dictionarySpec}/terms

Segment Params

igrpSpec (spec) - IGRP ID (integer).
dictionarySpec (spec) - Dictionary ID (integer).

POST Params

term (string) - Term word or phrase.
weight (integer) OPTIONAL - A numeric value between 0 and 3, default 0.
pronunciations (array) OPTIONAL - An array of alternative pronunciations for the term, up to 100 variants per dictionary. Can be blank (empty).

Response:

Single row of term details for the created term.

termId (integer) - Term ID.
dictionaryId (integer) - Dictionary ID this term belongs to.
term (string) - Term word or phrase (the jargon, pronoun or acronym).
weight (integer) - A numeric value between 0 and 3 that is used to increase the chances of the term being transcribed.
pronunciations (array) - An array of alternative pronunciations for the term.
createDatetime (string) - Date and time when the Dictionary term was created.
updateDatetime (string) - Date and time when the Dictionary term was last updated.

{"termId":"2","dictionaryId":"2","term":"CEO","weight":"0","pronunciations":["C.E.O."],"createDatetime":"2018-01-17 11:54:03","updateDatetime":"2018-01-17 11:54:29"}

Update Dictionary Term

Update the properties for given Term ID.

Request:

POST /config/v2/igrps/{igrpSpec}/dictionaries/{dictionarySpec}/terms/{termSpec}

Segment Params

igrpSpec (spec) - IGRP ID (integer).
dictionarySpec (spec) - Dictionary ID (integer).
termSpec (spec) - Term ID (integer).

POST Params

term (string) OPTIONAL - Term word or phrase.
weight (integer) OPTIONAL - A numeric value between 0 and 3, default 0.
pronunciations (array) OPTIONAL - An array of alternative pronunciations for the term, up to 100 variants per dictionary. Can be blank (empty).

Response:

HTTP 204 - NO CONTENT

Delete Dictionary Term

Delete a term for given Term ID.

Request:

DELETE /config/v2/igrps/{igrpSpec}/dictionaries/{dictionarySpec}/terms/{termSpec}

Segment Params

igrpSpec (spec) - IGRP ID (integer).
dictionarySpec (spec) - Dictionary ID (integer).
termSpec (spec) - Term ID (integer).

Response:

HTTP 204 - NO CONTENT