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

GET Params

Filter Types

Sort Types

Same as Filter Types

Response:

All dictionaries for the given IGRP spec.

{"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

Response:

Single row of the dictionary details.

{"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

GET Params

Filter Types

Sort Types

Same as Filter Types

Response:

All terms for the given Dictionary and IGRP spec.

{"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

Response:

Single row of the term details.

{"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

POST Params

Response:

Single row of term details for the created term.

{"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

POST Params

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

Response:

HTTP 204 - NO CONTENT