---
title: "Natterbox User Object"
slug: "natterbox-users"
updated: 2026-08-28T12:02:53Z
published: 2026-08-28T12:03:24Z
canonical: "docs.natterbox.com/natterbox-users"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.natterbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Natterbox User Object

Sometimes you need to be able to report on the current state of the Natterbox User, this allows you to look at active users or licences in a report format.

This is not an article on onboarding or offboarding Natterbox Users, please see [this chapter](/v1/docs/adding-a-user) for more information on that.

| Field | API name | Field Definition | Field Values |
| --- | --- | --- | --- |
| Active | nbavs__Enabled__c | This shows if a user has been enabled as an active Natterbox user | True, False |
| AI Prompt Studio | nbavs__AICallCoaching__c | True if the Natterbox User is assigned the AI Advisor license | True, False |
| AI Workforce Agent | nbavs__AIWorkforceAgent__c | True if the Natterbox User is assigned the AI Workforce Agent license | True, False |
| Availability Profile | nbavs__AvailabilityProfile__c | The availability profile the user has been assigned | Lookup (Availability Profile) |
| Availability State | nbavs__AvailabilityProfileState__c | The availability state the user has selected | Lookup (Availability State) |
| Chat | nbavs__Chat__c | True if the Natterbox User is assigned the Chat license | True, False |
| Contact Centre | nbavs__Manager__c | True if the Natterbox User is assigned the Contact Centre license | True, False |
| Copy to Voicemail Inbox | nbavs__VoicemailInboxCopy__c | - | True, False |
| Created By | CreatedById | A default Salesforce field used to track who created the record, mostly irrelevant for reporting purposes | Lookup (User) |
| CTI | nbavs__CTI__c | True if the Natterbox User is assigned the CTI license (legacy licence, no longer needed) | True, False |
| Dial List | nbavs__DialList__c | Assigned Dial List | Lookup (Dial List) |
| Email Address | nbavs__Username__c | Email address of user, this will be imported from the Salesforce User | Email (unique) |
| Email Notification for each Message | nbavs__VoicemailEmailNotifications__c | - | True, False |
| External Id | nbavs__Id__c | An alternative id to the Salesforce ID | 7 digit number (unqiue) |
| First Name | nbavs__FirstName__c | First Name from Salesforce User | Text |
| Freedom | nbavs__Freedom__c | True if the Natterbox User is assigned the Freedom license | True, False |
| Global Calls | nbavs__Global__c | - | True, False |
| Insight | nbavs__Insights__c | True if the Natterbox User is assigned the Insight license (legacy licence, auto-assigned when the AI Advisor licence is selected). This licence allows the calls to be transcribed if the call was recorded. | True, False |
| Last Modified By | LastModifiedById | A default Salesforce field used to track who last edited the record, mostly irrelevant for reporting purposes | Lookup (User) |
| Last Name | nbavs__LastName__c | Last Name from Salesforce User | Text |
| LCRC | nbavs__LCRC__c | - | Text |
| LENC | nbavs__LENC__c |  | Long Text Area |
| Messages available only via Email | nbavs__VoicemailEmailAttachment__c | - | True, False |
| Mobile | nbavs__MobilePhone__c | - | Phone |
| Name | Name | First Name and Last Name | Text |
| Numbers | nbavs__Numbers__c | - | True, False |
| Owner | OwnerId | A default Salesforce field populated with who owns the record, mostly irrelevant for this object | Lookup (User,Group) |
| PCI | nbavs__PCI__c | True if the Natterbox User is assigned the PCI license | True, False |
| Permission Level | nbavs__PermissionLevel__c | The permission level assigned to the user, it syncs with permission set on the Salesforce User, for more info, see [this guide](/v1/docs/permissions). | Basic, Team Leader, Admin |
| Personalised SMS | nbavs__SMS__c | True if the Natterbox User is assigned an SMS license | True, False |
| Pin | nbavs__Pin__c | Pin code that allows users to access voicemails. | Text (8) |
| Recipient Email Address(es) | nbavs__VoicemailEmailRecipients__c | - | Email |
| Record | nbavs__Record__c | True if the Natterbox User is assigned the Record license. The allows a user’s calls to be recorded or for a user to be able to listen to calls (if assigned the correct [recording permissions](/v1/docs/recording-access)). | True, False |
| Routing Policy Id | nbavs__RoutingPolicyId__c | This populates the id of the routing policy related to the AI Agent user in an AI Workforce Call Agent policy. | Text |
| Salesforce User | nbavs__User__c | Salesforce User that was used to created the Natterbox User | Lookup (Salesforce User) |
| Service Cloud Voice | nbavs__SCV__c | True if the Natterbox User is assigned the Service Cloud Voice license | True, False |
| SipDevice | nbavs__SipDevice__c | Id of the user’s Webphone | Example: 234203 |
| Status | nbavs__Status__c | - | Picklist: ACTIVE, SUSPENDED |
| Track Outbound CTI Device | nbavs__TrackOutboundCTIDevice__c | Used to track outbound CTI | True, False |
| Update Remote Availability | nbavs__Update_Remote_Availability__c | Used to update the Availability State in a flow | True, False |
| User Extension | nbavs__SipExtension__c | 4 digit code used to reach a user internally | 2000, 2001,… |
| Voice | nbavs__PBX__c | True if the Natterbox User is assigned the Voice license. This grants access to the Natterbox phone system so a user can make/receive calls. This used to be called Cloud PBX. | True, False |
| Voicemail Settings Updated | nbavs__VoicemailUpdated__c | - | True, False |
| WebPhone Disabled | nbavs__WebPhonePopupDisabled__c | - | True, False |
| WebPhone Mode | nbavs__WebphoneMode__c | - | Picklist: Stable, Beta, Use Default |
| WhatsApp | nbavs__WhatsApp__c | True if the Natterbox User is assigned the WhatsApp license | True, False |

Web-based applications that allow you to make phone calls directly in your Internet browser.

Sometimes referred to as the 'blue box' by agents. This window needs to be open to allow an agent to make and receive calls.