• 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

Config API Version 2 Caller Insight

Introduction

Caller Insight is used to display real-time call data to call centre staff.

Each staff member has a primary organisation ID (see Config V2 Users. This organisation ID is used to look up linked IGRPs, and display data for only those IGRPs.

List Caller Insight organisations

Returns a list of organisations linked to Caller Insight for an IGRP.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/callerInsight/orgs

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

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

Sort Types

The list may be sorted by any of the returned fields. By default the list is sorted by igrpName.

Response:

Returns a list of organisations linked to Caller Insight for the given {IGRP SPECIFIER}.

• igrp (int) - Installation ID.
• orgId (int) - Organisation ID.
• orgName (string) - Organisation name.

{"igrp":"1","orgId":"1","igrpName":"Org one"}
{"igrp":"1","orgId":"2","igrpName":"Org two"}

Link Caller Insight organisation

Links an organisation to Caller Insight for an IGRP.

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}/callerInsight/orgs

URL Path Params

• IGRP SPECIFIER (int) - Installation ID.

POST Params

• ORG SPECIFIER (int) - Organisation ID.

Response:

HTTP 204 - NO CONTENT

Unlink Caller Insight organisation

Unlinks an organisation from Caller Insight for an IGRP.

Request:

DELETE /config/v2/igrps/{IGRP SPECIFIER}/callerInsight/orgs/{ORG SPECIFIER}

URL Path Params

• IGRP SPECIFIER (int) - Installation ID.
• ORG SPECIFIER (int) - Organisation ID.

Response:

HTTP 204 - NO CONTENT

Caller Insight User Config

List Caller Insight users

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/callerInsight/users/

URL Path Params

• IGRP SPECIFIER (int) - Installation ID.

Request Params

• limit (int) OPTIONAL - Limit the result set.
• offset (int) OPTIONAL - Offset the result set.
• filter (array) OPTIONAL - See Filter Types below.
• sort (array) OPTIONAL - See Sort Types below.

Filter Types

• callerInsightUserId (int) - Caller Insight user ID.
• sipUserId (int) - The ID of the SIP user this Caller Insight user is linked to, will be zero for non-PBX users.
• operatorRef (string) - The operator reference of the user.
• displayName (string) - The display name of the user.

Sort Types

• callerInsightUserId (int) - Caller Insight user ID.
• sipUserId (int) - The ID of the SIP user this Caller Insight user is linked to, will be zero for non-PBX users.
• operatorRef (string) - The operator reference of the user.
• displayName (string) - The display name of the user.

Response:

Returns a list of Caller Insight users configured for the IGRP.

• callerInsightUserId (int) - Caller Insight user ID.
• sipUserId (int) - The ID of the SIP user this Caller Insight user is linked to, will be zero for non-PBX users.
• operatorRef (string) - The operator reference of the user.
• displayName (string) - The display name of the user.
• igrp (int) - The IGRP the user is in.

{"callerInsightUserId":"1","sipUserId":"3","operatorRef":"a.user","displayName":"A User","igrp":"1"}
{"callerInsightUserId":"2","sipUserId":"0","operatorRef":"another.user","displayName":"Another User","igrp":"1"}

Read a Caller Insight user

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/callerInsight/users/{CALLER INSIGHT USER SPECIFIER}

URL Path Params

• IGRP SPECIFIER (int) - Installation ID.
• CALLER INSIGHT USER SPECIFIER (int) - Caller Insight User ID.

Response:

Returns a Caller Insight user.

• callerInsightUserId (int) - Caller Insight user ID.
• sipUserId (int) - The ID of the SIP user this Caller Insight user is linked to, will be zero for non-PBX users.
• operatorRef (string) - The operator reference of the user.
• displayName (string) - The display name of the user.
• igrp (int) - The IGRP the user is in.

{"callerInsightUserId":"1","sipUserId":"3","operatorRef":"a.user","displayName":"A User","igrp":"1"}

Create a Caller Insight user

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}/callerInsight/users/

URL Path Params

• IGRP SPECIFIER (int) - Installation ID.

Request Params

• operatorRef (string) - The operator reference of the user.
• displayName (string) - The display name of the user.

Response:

HTTP 201 - CREATED

Update a Caller Insight user

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}/callerInsight/users/{CALLER INSIGHT USER SPECIFIER}

URL Path Params

• IGRP SPECIFIER (int) - Installation ID.
• CALLER INSIGHT USER SPECIFIER (int) - Caller Insight User ID.

Request Params

• operatorRef (string) OPTIONAL - The operator reference of the user.
• displayName (string) OPTIONAL - The display name of the user.

Response:

HTTP 204 - NO CONTENT

Import Caller Insight users from SIP users

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}/callerInsight/users/import/{DOMAIN SPECIFIER}

URL Path Params

• IGRP SPECIFIER (int) - Installation ID.
• DOMAIN SPECIFIER (int) - SIP Domain ID of the user to import.

Request Params

• sipUserId (int/array) - The SIP user ID/s to import. Can be supplied as a single value or an array of IDs.

Response:

HTTP 204 - NO CONTENT

Delete a Caller Insight user

Request:

DELETE /config/v2/igrps/{IGRP SPECIFIER}/callerInsight/users/{CALLER INSIGHT USER SPECIFIER}

URL Path Params

• IGRP SPECIFIER (int) - Installation ID.
• CALLER INSIGHT USER SPECIFIER (int) - Caller Insight User ID.

Response:

HTTP 204 - NO CONTENT

CRM Button Config

List CRM Buttons

Returns a list of CRM buttons for an organisation.

Request:

GET /config/v2/organisations/{ORG SPECIFIER}/callerInsight/crmButtons

URL Path Params

• ORG SPECIFIER (int) - Organisation ID.

GET Params

• limit (integer) OPTIONAL - limit on the result set.
• offset (integer) OPTIONAL - offset of the result set.

Response:

Returns a list of CRM buttons for the organisation.

• crmButtonId (int) - CRM Button ID.
• orgId (int) - User’s organisation ID
• targeturl (string) - Target URL of the button
• buttonLabel (string) - Text label for the button
• clickOut (string) - Click out behavior for the button. Can be one of (default, window or iframe)

{"crmButtonId":"1","orgId":"1","targetUrl":"http:\/\/www.infinity-tracking.com\/","buttonLabel":"Test","clickOut":"default"}
{"crmButtonId":"2","orgId":"1","targetUrl":"http:\/\/www.infinity-tracking.com\/","buttonLabel":"Button","clickOut":"default"}

Read CRM Button Config

Returns the properties of a particular CRM button.

Request:

GET /config/v2/organisations/{ORG SPECIFIER}/callerInsight/crmButtons/{crmButtonId}

URL Path Params

• crmButtonId (int) - CRM button ID.
• ORG SPECIFIER (int) - Organisation ID.

Response:

Returns the properties of a particular CRM button.

• crmButtonId (int) - CRM Button ID.
• orgId (int) - User’s organisation ID
• targeturl (string) - Target URL of the button
• buttonLabel (string) - Text label for the button
• clickOut (string) - Click out behavior for the button. Can be one of (default, window or iframe)

{"crmButtonId":"1","orgId":"1","targetUrl":"http:\/\/www.infinity-tracking.com\/","buttonLabel":"Test","clickOut":"default"}

Create CRM Button

Creates a CRM button with the given properties.

Request:

POST /config/v2/organisations/{ORG SPECIFIER}/callerInsight/crmButtons

URL Path Params

• crmButtonId (int) - CRM button ID.

POST Params

• orgId (int) - User’s organisation ID
• targeturl (string) - Target URL of the button
• buttonLabel (string) - Text label for the button
• clickOut (string) - Click out behavior for the button. Can be one of (default, window or iframe)

Response:

Returns the crmButtonId of the newly created button.

• crmButtonId (int) - CRM Button ID.

HTTP 201 - CREATED
{"crmButtonId":"1"}

Update a CRM Button Config

Updates a CRM button with the given properties.

Request:

POST /config/v2/organisations/{ORG SPECIFIER}/callerInsight/crmButtons/{crmButtonId}

URL Path Params

• crmButtonId (int) - CRM button ID.
• ORG SPECIFIER (int) - Organisation ID.

POST Params

• targeturl (string) - Target URL of the button
• buttonLabel (string) - Text label for the button
• clickOut (string) - Click out behavior for the button. Can be one of (default, window or iframe)

Response:

HTTP 204 - NO CONTENT

Delete a CRM Button

Deletes a CRM button.

Request:

DELETE /config/v2/organisations/{ORG SPECIFIER}/callerInsight/crmButtons/{crmButtonId}

URL Path Params

• crmButtonId (int) - CRM button ID.
• ORG SPECIFIER (int) - Organisation ID.

Response:

HTTP 200 - OK