• Home
• Config V2 Basics
• Config V2 Organisations
• Config V2 Organisation Types
• Config V2 Channels
• Config V2 Installation Groups
• Config V2 Report Schedule Subscribers
• Config V2 Segments
• Config V2 Dial-In Groups
• Config V2 Goals
• Config V2 Goal Groups
• Config V2 Numbers
• Config V2 Custom
• Config V2 Profile
• Config V2 Users
• Config V2 Roles
• Config V2 Visitor Types
• Config V2 Attribution
• Config V2 SIP Phone System
• Config V2 Notifications
• Config V2 Dialplans
• Config V2 Integrations
• Config V2 PPC
• Config V2 DGRP maps
• Config V2 DGRP map items
• Config V2 IGRP Caller Blocks
• Config V2 Caller Insight
• Config V2 Caller Insight for Salesforce
• Config V2 Call Rating
• Config V2 Custom Vocabulary
• Reports V2 Basics
• Reports V2 Installation Groups
• Reports V2 Dial-In Groups
• Reports V2 Triggers
• Reports V2 Triggers (Deprecated)
• Reports V2 Custom
• Reports V2 Metrics

• Reports V2 Call Rating

• Reports V2 Channels
• Reports V2 Organisations
• Reports V2 Organisation Types
• Reports V2 Segments
• Reports V2 Visitors
• Reports V2 Attribution
• Reports V2 Audit
• Reports V2 Currencies
• Reports V2 Goals
• Reports V2 Real Time
• Reports V2 PBX triggers
• Export V2 Invoices
• Event API Basics
• Event API Example
• Event FTP Upload
• Call Events
• Salesforce Events
• Config V2 Oauth2
• Config V2 Scheduled Reports
• Reports V2 PPC
• Config V2 Keyword Spotting
• Reports V2 Call Keywords

Reports API Version 2 Call Rating

Introduction

Post Call Rating helps you to see clearly in the Portal the value of calls as they happen, your operators have the ability to assign a rating to a call so you can see which campaigns are driving effective traffic and subsequent calls to your site. Post-call rating is the action of assigning a rating to a call once the caller has hung up.

Each post call rating is associated with a call rating group, which contains the configuration of the call rating. The call rating group is associated with multiples items, allowing the user to assign a specific rating to a call, e.g. “new lead” or “existing lead”.

Each item consists of text and a digit. The text contains the call rating for this option and the digit indicates which button needs to be pressed on the phone to pick this option.

List all call rating items for an IGRP

Returns a list of all IGRP call rating items.

Request:

GET /reports/v2/igrps/{IGRP SPECIFIER}/callRatings/all/items

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

• 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

Same fields as Filter Types, see above.

Response:

Returns a list of all call rating items under the given {IGRP SPECIFIER}.

Same fields as Filter Types, see above.

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

List all unique call rating item texts for an IGRP

Returns a list of all unique IGRP call rating item texts.

Request:

GET /reports/v2/igrps/{IGRP SPECIFIER}/callRatings/all/uniqueItemTexts

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

• itemText (string) - Item text to be used for text-to-speech/call rating. Item Texts are grouped in a case insensitive way. The actual call rating values in the event triggers may be in a different case. For this reason, we would suggest using a case insensitive filtering when using itemText values from this route to generate filters, e.g. “ini”.

Sort Types

Same fields as Filter Types, see above.

Response:

Returns a list of all call rating items under the given {IGRP SPECIFIER}.

Same fields as Filter Types, see above.

{"itemText":"Existing Contact"}
{"itemText":"New Lead"}