18.10.3. Natterbox AI Object Fields & Definitions

Prev Next

The following objects are generated and managed by AI Advisor

Objects managed by AI Advisor

Label

API Name

Allow Reports? (By default)

Description

Natterbox AI

TRUE

The core object which represents the call and stores all the AI analysis data

Natterbox AI Note

nbavs__NatterboxAINote__c

FALSE

This object stores the details from leaving notes on a call using the Insight Player.

Category

nbavs__Category__c

TRUE

Junction record between the Insight Category Configuration and an Insight record, when the category is triggered for that call

AI Advisor Category Configuration

nbavs__Insight_Category_Configuration__c

FALSE

Definition of a category which may be assigned to an Insight record using the Insight Category object.

Filter View

nbavs__FilterView__c

FALSE

A saved filter for a user within the AI Advisor Search page.

Objects deprecated (since enabling SFSO on v1.348)

Label

API Name

Allow Reports? (By default)

Description

Insight

nbavs__Insights__c

TRUE

The core object which represents the call

AI Prompts

nbavs__AI_Prompt__c

TRUE

This object is where the results of the AI prompts are stored

AI Prompt Configuration

nbavs__AI_Prompt_Configuration__c

FALSE

This object stores the details of the prompt configuration

Insight / AI Advisor Conversations

nbavs__Insight_Conversation__c

FALSE

Junction object

Insight / AI Advisor Category

nbavs__Insight_Category__c

TRUE

Junction record between the Insight Category Configuration and an Insight record, when the category is triggered for that call

Insight / AI Advisor Note

nbavs__Insight_Note__c

FALSE

This object stores the details from leaving notes on a call using the Insight Player.

Insight Note Deprecated

nbavs__Insights_Notes__c

FALSE

This object stores the details from leaving notes on a call using the Insight Player.

Insight / AI Advisor Error

nbavs__Insights_Failure__c

FALSE

This object stores any processing errors.

Insight / AI Advisor Rating

nbavs__Insight_Rating__c

FALSE

This object stores the results of the ‘Finish & Rate’ from the Insight Player.

Insight / AI Advisor User View

nbavs__Insight_User_View__c

FALSE

Record used to track Insight Player views of an Insight by users.

Since the consolidation of the objects, AI Advisor is now mainly driven through a single object called Natterbox AI.

This is the schema breakdown of the Natterbox AI Object:

Field Label

Field API Name

Type

Description

Account

nbavs__Account__c

Account

Lookup to the account that was called.

Answer Time

nbavs__Answer_Time__c

datetime

The time that the call channel was answered.

Call Category

nbavs__Call_Category__c

string (32)

Gets the relevant call category value from CRO for the respective UUID of the call.

Call Direction

nbavs__Call_Direction__c

picklist (255), restricted

The Call_Direction field exists for each conversation and specifies the direction of the call in the context of External (numbers not owned by the business) and Internal (numbers owned by the business).

Call Reporting

nbavs__Call_Reporting__c

nbavs__CallReporting__c

Lookup to the Call Reporting record for this call.

Call Type

nbavs__Call_Type__c

picklist (255), restricted

Indication on how the call was handled from the perspective of the From party, normally acting in the role of caller. Typically a call can either be connected to another party thus forming a Conversation, be connected to a service or not be connected to either, i.e. the call was not answered.

Caller Type

nbavs__Caller_Type__c

picklist (255), restricted

Values can be Employee or Customer to define the respective Insight record.

Channel Duration

nbavs__Channel_Duration__c

double (18, 0)

The duration of the physical channel in seconds, from the point at which it is answered to the point at which it gets hung up. If the channel is not answered, then duration will be 0.

Channel Duration Time

nbavs__Channel_Duration_Time__c

string (1300)*

The duration of the physical channel in seconds, from the point at which it is answered to the point at which it gets hung up. If the channel is not answered, then duration will be 0.

Contact

nbavs__Contact__c

Contact

Lookup to the contact that was called.

Conversation Count

nbavs__Conversation_Count__c

double (18, 0)

For the given call, this represents how many conversations the specified From or To party had whilst the call was active. See the introduction section labelled Transfers for more information.

Device Id

nbavs__Device_Id__c

double (18, 0)

The numeric Natterbox device ID associated with this call channel. If the call is OTT, then this will be blank.

End Time

nbavs__End_Time__c

datetime

The time that the call channel ended (was hung up).

FS-AI [Prompt Name]

FreeTextFilter_[NUMBER ID]__c

Text(255)

AI Free Text Search - This is a truncated version (the first 255 characters) of the AI Assist result which is searchable

FT-AI [Prompt Name]

FreeText_[NUMBER ID]__c

Long Text Area(32768)

AI Free Text - The result for AI Assist, this is a large text field - note this text field cannot be searched or reported on - see more on AI Assist here.

Group

nbavs__Group__c

string (1300)*

Related group name of Insight record/UUID.

Hangup Cause

nbavs__Hangup_Cause__c

string (32)

Indicates the reason that the channel hung up. This is applied at a channel level, i.e. even if the caller/called party has been involved in multiple conversations by virtue of being transferred, this hangup cause is the same on all channels.

Has Prompt Data

nbavs__PromptData__c

Checkbox

Whether or not the call received back AI prompt analysis data

Has Prompt Results

nbavs__PromptResults__c

Checkbox

Whether or not the call was marked for AI prompt analysis

Insights Name

Name

string (80), auto number, required

A reference auto number for the record.

Insights Player

nbavs__Insights_Player__c

string (1300), html*

URL link to Insight Player for this call.

Language

nbavs__Language__c

Text(50)

The language the call was set to be transcribed in

Lead

nbavs__Lead__c

Lead

Lookup to the lead that was called.

Natterbox AI Name

Name

Auto Number

Salesforce unique ID

Natterbox Group

nbavs__Natterbox_Group__c

nbavs__Group__c

Lookup to the Group__c record that the primary user is a member of.

Natterbox User

nbavs__Natterbox_User__c

nbavs__User__c

Lookup to User__c record for the primary user.

Number

nbavs__Number__c

string (32)

The number that belongs to the device or calling/called party. When a channel is a caller channel, i.e. a call has been initiated from a phone towards the Natterbox system, then for inbound calls to the organisation from external callers, this is typically the caller's PSTN number. For calls made by users within the organisation who are using SIP based devices, this is their SIP device extension number.

Where a channel is a called channel, i.e. a call has been initiated from the system to a phone, then this is always the number that is dialled.

Number of Categories

nbavs__NumberCategories__c

Roll-Up Summary (COUNT Category)

A count of all related Categories against the call.

Opportunity

nbavs__Opportunity__c

Opportunity

If the call channel is associated with a Customer, and an Opportunity has been found, then this will be linked to Opportunity record.

Other Natterbox User

nbavs__Other_Natterbox_User__c

nbavs__User__c

Lookup to User__c record for the other user.

This field is only ever populated in the event of an internal call between agents.

RE-[Prompt Name]

Reason_[NUMBER ID]__c

Long Text Area(1000)

AI Reasoning - The reasoning response that the AI gave for the rating - note this is a long text field cannot be searched or reported on

Related Name

nbavs__Related_Name__c

string (1300)*

Related name of the person involved in the call.

Related Record Id

nbavs__Related_Record_Id__c

string (1300)*

Related record URL of the person involved in the call.

RT-[Prompt Name]

Rating_[NUMBER ID]__c

Number(18, 0)

AI Rating - The result from the AI, typically this will be the numerical rating out of 10, but in the event of an error the full string will be populated here

Start Time

nbavs__Start_Time__c

datetime

The time that the call channel was actually initiated.

Transcription Download Status

nbavs__TranscriptionDownloadStatus__c

picklist (255), restricted

When a transcription is processed by the scheduled job, respective values are updated based on the processing result.

UUID

nbavs__UUID__c

string (100), external id, required, unique

The UUID of the call channel this Insight record is related to.

As seen in this table, Natterbox AI records have a lookup field to a Call Reporting record. This is the call that is being analysed.

Because of this, fields from the Call Reporting record can be used in a Natterbox AI report. Reports can be created with a report type of “Natterbox AI with Call Reporting” :

User selects 'Natterbox AI with call reporting' from the report type dropdown menu.

Alternatively, a custom report type can be created and the Call Reporting fields can be added using the Add fields related via lookup function:

Select the primary object for report creation, focusing on Natterbox AI.

Button labeled 'Lookup Fields' for adding new data fields in a user interface.

Fields related to Natterbox AI for call reporting are displayed with checkboxes.