Version 2 Keyword Spotting

Introduction

Identify spoken keyword or phrases in a call for use in later reporting.

Each keyword is given a numeric ID which can be used to reference it in the APIs.
A keyword to spot can consist of single or multiple words.
A keyword is stored for a single IGRP.
A keyword score is an integer value representing the keyword’s occurrence as a positive, negative or neutral outcome (-100 to +100)
A keyword can be set to spot on only the operator’s leg, caller’s leg, or both.
Confidence threshold is a numeric value representing the minimum confidence required in the call transcription.

Keyword Properties

keywordId (int) - An integer with the keyword ID.
igrp (int) - Installation ID.
keyword (string) - The keyword’s value to spot within the call.
keywordStatus (int) - An integer representing keyword status: 200, 423.
leg (string) - Party that can be a contact, an operator or any for the keyword.
minConfidence (int) - An integer representing confidence threshold of that keyword.
keywordScore (int) - An integer value representing the keyword’s occurrence as a positive, negative or neutral outcome.
createDatetime (datetime) - Create date/time of the keyword.
updateDatetime (datetime) - Update date/time of the keyword.
deleteDatetime (datetime) - Delete date/time of the keyword.

List Keywords for an IGRP

This lists the keywords for an IGRP.

Request:

GET /config/v2/igrps/{igrpSpec}/keywordGroups/{keywordGroupSpec}/keywords

Segment Params

igrpSpec (spec) - Installation ID (int).
keywordGroupSpec (spec) - KeywordGroup ID (int).

GET Params

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

Filter Types

The keywords list may be filtered by any of the returned fields.

Sort Types

The keywords list may be sorted by any of the returned fields. The default sort is keyword in ascending order.

Response:

Returns a list of keywords for an IGRP.

keywordId (int) - Keyword ID.
keyword (string) - Keyword or phrase.
keywordStatus (int) - Keyword status. See keyword properties.
leg (string) - Party that can be a contact, an operator or any for the keyword.
minConfidence (int) - Confidence threshold for that keyword.
keywordScore (int) - An integer value representing the keyword’s occurrence as a positive, negative or neutral outcome.
createDatetime (datetime) - Create date/time of keyword.
updateDatetime (datetime) - Update date/time of keyword.

{"keywordId":"3","keyword":"connections","keywordStatus":200,"leg":"contact","minConfidence":"2","keywordScore":"2","createDatetime":"2017-11-07 17:20:00","updateDatetime":"2017-11-10 10:22:14"}
{"keywordId":"1","keyword":"installation","keywordStatus":200,"leg":"operator","minConfidence":"1","keywordScore":"1","createDatetime":"2017-11-07 17:20:00","updateDatetime":"2017-11-10 10:20:43"}
{"keywordId":"2","keyword":"premium","keywordStatus":200,"leg":"operator","minConfidence":"1","keywordScore":"1","createDatetime":"2017-11-07 17:20:00","updateDatetime":"2017-11-10 10:20:43"}

Read Keyword properties

Read keyword properties for the specified keyword ID and IGRP.

Request:

GET /config/v2/igrps/{igrpSpec}/keywordGroups/{keywordGroupSpec}/keywords/{keywordSpottingSpec}

Segment Params

igrpSpec (spec) - Installation ID (int).
keywordSpottingSpec (spec) - Keyword ID (int).
keywordGroupSpec (spec) - KeywordGroup ID (int).

Response:

Returns details of a keyword for an IGRP.

keywordId (int) - Keyword ID.
keyword (string) - Keyword or Phrase.
keywordStatus (int) - Keyword status. See keyword properties.
leg (string) - Party that can be a contact, an operator or any for the keyword.
minConfidence (int) - Confidence threshold for that keyword.
keywordScore (int) - An integer value representing the keyword’s occurrence as a positive, negative or neutral outcome.
createDatetime (datetime) - Create date/time of that keyword.
updateDatetime (datetime) - Update date/time of that keyword.

{"keywordId":"1","keyword":"installation","keywordStatus":200,"leg":"operator","minConfidence":"1","keywordScore":"1","createDatetime":"2017-11-07 17:20:00","updateDatetime":"2017-11-10 10:20:43"}

Create Keyword config

This creates a new keyword and its properties for an IGRP.

Request:

POST /config/v2/igrps/{igrpSpec}/keywordGroups/{keywordGroupSpec}/keywords

Segment Params

igrpSpec (spec) - Installation ID (int).
keywordGroupSpec (spec) - KeywordGroup ID (int).

POST Params

keyword (string) - Keyword or phrase.
leg (string) - Party that can be a contact, an operator or any for the keyword.
minConfidence (int) - Confidence threshold for that keyword.
keywordScore (int) - An integer value representing the keyword’s occurrence as a positive, negative or neutral outcome.

Response:

{"keywordId":"7"}

Update Keyword Config

Updates the configuration of an existing keyword.

Request:

POST /config/v2/igrps/{igrpSpec}/keywordGroups/{keywordGroupSpec}/keywords/{keywordSpottingSpec}

Segment Params

igrpSpec (spec) - Installation ID (int).
keywordSpottingSpec (spec) - Keyword ID (int).
keywordGroupSpec (spec) - KeywordGroup ID (int).

POST Params

keywordStatus (int) - Keyword status. See keyword properties.
leg (string) - Party that can be a contact, an operator or any for the keyword.
minConfidence (int) - Confidence threshold for that keyword.
keywordScore (int) - An integer value representing the keyword’s occurrence that can only be of the same type as it was set(signed/unsigned/neutral).

Response:

Returns the HTTP 204 (No Content) status code if update successful.

HTTP 204 - NO CONTENT

Delete Keyword Config

Set keywordStatus to inactive for an existing keyword.

Request:

DELETE /config/v2/igrps/{igrpSpec}/keywordGroups/{keywordGroupSpec}/keywords/{keywordSpottingSpec}

Segment Params

igrpSpec (spec) - Installation ID (int).
keywordSpottingSpec (spec) - Keyword ID (int).
keywordGroupSpec (spec) - KeywordGroup ID (int).

Response:

Returns the HTTP 204 (No Content) status code if delete successful.

HTTP 204 - NO CONTENT