Config API Version 2 Call Rating

List call ratings for an IGRP

Returns a list of IGRP call ratings.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/callRatings

URL Path Params

IGRP SPECIFIER (int) - Installation ID.

GET Params

filter (array) OPTIONAL - One or more filters, see Filter Types.
sort (array) OPTIONAL - One or more sorting params, see Sort Types.
limit (integer) OPTIONAL - limit on the result set.
offset (integer) OPTIONAL - offset of the result set.

Filter Types

callRatingId (int) - Call rating ID.
callRatingName (string) - Call rating name.
sayOptions (int) - A flag (1 or 0) to enable text-to-speech output of call rating options.
createDatetime (date) - Create date/time of call rating.
updateDatetime (date) - Update date/time of call rating.

Sort Types

callRatingId (int) - Call rating ID.
callRatingName (string) - Call rating name.
sayOptions (int) - A flag (1 or 0) to enable text-to-speech output of call rating options.
createDatetime (date) - Create date/time of call rating.
updateDatetime (date) - Update date/time of call rating.

Response:

Returns a list of call ratings under the given {IGRP SPECIFIER}.

callRatingId (int) - Call rating ID.
igrp (int) - Installation ID.
callRatingName (string) - Call rating name.
sayOptions (int) - A flag (1 or 0) to enable text-to-speech output of call rating options.
createDatetime (date) - Create date/time of call rating.
updateDatetime (date) - Update date/time of call rating.

{"callRatingId":"1","igrp":"1","callRatingName":"Test 1","sayOptions":"1","createDatetime":"2014-11-13 11:20:00","updateDatetime":"2014-11-28 12:47:15"}
{"callRatingId":"2","igrp":"1","callRatingName":"Test 2","sayOptions":"1","createDatetime":"2014-11-13 11:20:08","updateDatetime":"2014-11-28 12:47:18"}

Read IGRP call rating

Returns an IGRP call rating.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/callRatings/{callRatingId}

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
callRatingId (int) - The call rating ID

Response:

callRatingId (int) - Call rating ID.
igrp (int) - Installation ID.
callRatingName (string) - Call rating name.
sayOptions (int) - A flag (1 or 0) to enable text-to-speech output of call rating options.
createDatetime (date) - Create date/time of call rating.
updateDatetime (date) - Update date/time of call rating.

{"callRatingId":"1","igrp":"1","callRatingName":"Test 1","sayOptions":"1","createDatetime":"2014-11-13 11:20:00","updateDatetime":"2014-11-28 12:47:15"}

Create IGRP call rating

Creates an IGRP call rating.

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}/callRatings

URL Path Params

IGRP SPECIFIER (int) - Installation ID.

POST Params

callRatingName (string) - Call rating name.
sayOptions (int) - A flag (1 or 0) to enable text-to-speech output of call rating options.

Response:

HTTP 201 - CREATED

Update IGRP call rating

Updates an IGRP call rating.

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}/callRatings/{callRatingId}

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
callRatingId (int) - The call rating ID

POST Params

callRatingName (string) OPTIONAL - Call rating name.
sayOptions (int) OPTIONAL - A flag (1 or 0) to enable text-to-speech output of call rating options.

Response:

HTTP 204 - NO CONTENT

Delete IGRP call rating

Deletes an IGRP call rating.

Request:

DELETE /config/v2/igrps/{IGRP SPECIFIER}/callRatings/{callRatingId}

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
callRatingId (int) - The call rating ID

Response:

HTTP 204 - NO CONTENT

List call rating items for an IGRP

Returns a list of IGRP call rating items.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/callRatings/{callRatingId}/items

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
callRatingId (int) - The call rating ID (“all” is acceptable in place of the call rating ID).

GET Params

filter (array) OPTIONAL - One or more filters, see Filter Types.
sort (array) OPTIONAL - One or more sorting params, see Sort Types.
limit (integer) OPTIONAL - limit on the result set.
offset (integer) OPTIONAL - offset of the result set.

Filter Types

callRatingItemId (int) - Call rating item ID.
callRatingId (int) - Call rating ID.
itemDigit (int) - Item digit to be used for text-to-speech/Dual Tone Multi Frequency.
itemText (string) - Item text to be used for text-to-speech/call rating.
captureTxv (int) - A flag (1 or 0) to enable sales value capture for this item.
currency (string) - Currency to record sales value in (three-letter ISO-4217 currency code).

Sort Types

callRatingItemId (int) - Call rating item ID.
callRatingId (int) - Call rating ID.
itemDigit (int) - Item digit to be used for text-to-speech/Dual Tone Multi Frequency.
itemText (string) - Item text to be used for text-to-speech/call rating.
captureTxv (int) - A flag (1 or 0) to enable sales value capture for this item.
currency (string) - Currency to record sales value in (three-letter ISO-4217 currency code).

Response:

Returns a list of call ratings under the given {IGRP SPECIFIER}.

callRatingItemId (int) - Call rating item ID.
callRatingId (int) - Call rating ID.
itemDigit (int) - Item digit to be used for text-to-speech/Dual Tone Multi Frequency.
itemText (string) - Item text to be used for text-to-speech/call rating.
captureTxv (int) - A flag (1 or 0) to enable sales value capture for this item.
currency (string) - Currency to record sales value in (three-letter ISO-4217 currency code).

{"callRatingItemId":"1","callRatingId":"1","itemDigit":"1","itemText":"Existing Contact","captureTxv":"0","currency":""}
{"callRatingItemId":"2","callRatingId":"1","itemDigit":"2","itemText":"New Lead","captureTxv":"1","currency":"GBP"}

Read IGRP call rating item

Returns an IGRP call rating item.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/callRatings/{callRatingId}/items/{callRatingItemId}

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
callRatingId (int) - The call rating ID
callRatingItemId (int) - The call rating item ID

Response:

callRatingItemId (int) - Call rating item ID.
callRatingId (int) - Call rating ID.
itemDigit (int) - Item digit to be used for text-to-speech/Dual Tone Multi Frequency.
itemText (string) - Item text to be used for text-to-speech/call rating.
captureTxv (int) - A flag (1 or 0) to enable sales value capture for this item.
currency (string) - Currency to record sales value in (three-letter ISO-4217 currency code).

{"callRatingItemId":"1","callRatingId":"1","itemDigit":"1","itemText":"Existing Contact","captureTxv":"0","currency":""}

Create IGRP call rating item

Creates an IGRP call rating item.

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}/callRatings/{callRatingId}/items

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
callRatingId (int) - The call rating ID

POST Params

itemDigit (int) - Item digit to be used for text-to-speech/Dual Tone Multi Frequency.
itemText (string) - Item text to be used for text-to-speech/call rating.
captureTxv (int) - A flag (1 or 0) to enable sales value capture for this item.
currency (string) OPTIONAL - Currency to record sales value in (three-letter ISO-4217 currency code).

Response:

HTTP 201 - CREATED

Update IGRP call rating item

Updates an IGRP call rating item.

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}/callRatings/{callRatingId}/items/{callRatingItemId}

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
callRatingId (int) - The call rating ID
callRatingItemId (int) - The call rating item ID

POST Params

itemDigit (int) OPTIONAL - Item digit to be used for text-to-speech/Dual Tone Multi Frequency.
itemText (string) OPTIONAL - Item text to be used for text-to-speech/call rating.
captureTxv (int) OPTIONAL - A flag (1 or 0) to enable sales value capture for this item.
currency (string) OPTIONAL - Currency to record sales value in (three-letter ISO-4217 currency code).

Response:

HTTP 204 - NO CONTENT

Delete IGRP call rating item

Deletes an IGRP call rating item.

Request:

DELETE /config/v2/igrps/{IGRP SPECIFIER}/callRatings/{callRatingId}/items/{callRatingItemId}

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
callRatingId (int) - The call rating ID
callRatingItemId (int) - The call rating item ID

Response:

HTTP 204 - NO CONTENT

Edit call rating for a trigger

Updates a call triggers callRating

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}/calls/{callRef}/rating

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
callRef (string) - The callRef for the trigger to update

POST Params

callRating (string) - The new call rating, must be one of the options in the call rating config linked to the DGRP.
txv (float) - The new transaction value for the trigger, can only be set if the selected rating has captureTxv enabled. The value should be in the same currency as the configured call rating option

Response:

HTTP 202 - ACCEPTED