afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/LiveChatUserConfig.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "usage",
    "field_reference"
  ],
  "title": "LiveChatUserConfig - Data API",
  "description": "Represents a setting that controls the console settings for Chat users. This object is available in API version 24.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "AutoGreeting": {
      "type": "textarea",
      "properties": "Create, Nillable",
      "description": "The text that is automatically sent from an agent to a visitor when a chat session starts."
    },
    "Capacity": {
      "type": "int",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "Limits the amount of active chat sessions an agent can engage in."
    },
    "CriticalWaitTime": {
      "type": "int",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "The amount of time before a chat flashes to alert an agent to answer it."
    },
    "CustomAgentName": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "The custom name of the agent associated with the Live Agent configuration."
    },
    "DeveloperName": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Note: When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
    },
    "HasLogoutSound": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort",
      "description": "Determines whether a sound plays when an agent logs out of the console."
    },
    "HasNotifications": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort",
      "description": "Determines whether desktop notifications are enabled for the configuration. Available in API version 25.0 and later."
    },
    "HasRequestSound": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort",
      "description": "Determines whether a sound plays when a chat request comes in."
    },
    "HasSneakPeek": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort",
      "description": "Determines whether an agent sees a real-time preview of the messages typed by a visitor."
    },
    "HasTransferConferenceGreeting": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Determines whether to enable sending an autogreeting when you transfer to another agent or invite an agent to a conference chat. The default value is false. Available in API version 53.0 and later."
    },
    "IsAutoAwayOnDecline": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort",
      "description": "Determines whether agents’ status is automatically changed to Away when they decline a chat request. Available in API version 26.0 and later."
    },
    "Language": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The language of the configuration."
    },
    "MasterLabel": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort",
      "description": "The name of the configuration."
    },
    "OptionsHasAgentFileTransfer": {
      "type": "boolean",
      "properties": "Create, Filter",
      "description": "Determines whether agents can initiate a file transfer from a chat customer. Available in API version 31.0 and later."
    },
    "OptionsHasAgentSneakPeek": {
      "type": "boolean",
      "properties": "Create, Filter",
      "description": "Determines whether Sneak Peek is enabled for agents. Available in API version 29.0 and later."
    },
    "OptionsHasAssistanceFlag": {
      "type": "boolean",
      "properties": "Create, Filter",
      "description": "Determines whether assistance flags are enabled for agents. Available in API version 29.0 and later."
    },
    "OptionsHasChatConferencing": {
      "type": "boolean",
      "properties": "Create, Filter",
      "description": "Determines whether agents can invite other agents into a customer chat. Available in API version 34.0 and later."
    },
    "OptionsHasChatMonitoring": {
      "type": "boolean",
      "properties": "Create, Filter",
      "description": "Determines whether supervisors can view agents’ ongoing chats. Available in API version 29.0 and later."
    },
    "OptionsHasChatTransferToAgent": {
      "type": "boolean",
      "properties": "Create, Filter",
      "description": "Specifies whether an agent can transfer a chat directly to another agent. Available in API version 36.0 and later."
    },
    "OptionsHasChatTransferToButton": {
      "type": "boolean",
      "properties": "Create, Filter",
      "description": "Specifies whether an agent can transfer a chat to an agent assigned to a particular chat button. Available in API version 36.0 and later."
    },
    "OptionsHasChatTransferToSkill": {
      "type": "boolean",
      "properties": "Create, Filter",
      "description": "Specifies whether an agent can transfer a chat to agents assigned to a particular skill. Available in API version 36.0 and later."
    },
    "OptionsHasTransferConferenceGreeting": {
      "type": "boolean",
      "properties": "Create, Filter, Update",
      "description": "Specifies whether an agent can transfer a chat to an autogreeting or conference greeting. Available in API version 53.0 and later."
    },
    "OptionsHasVisitorBlocking": {
      "type": "boolean",
      "properties": "Create, Filter",
      "description": "Determines whether an agent can block IP addresses of troublesome visitors. Available in API version 34.0 and later."
    },
    "OptionsHasWhisperMessage": {
      "type": "boolean",
      "properties": "Create, Filter",
      "description": "Determines whether supervisors can send private messages to agents within an agent’s chat with a customer. Available in API version 29.0 and later."
    },
    "OptionsIsAutoAwayOnPushTimeout": {
      "type": "boolean",
      "properties": "Create, Filter",
      "description": "Determines whether an agent’s status automatically changes to Away if the agent doesn’t respond to a chat request within the specified push time-out limit. Available in API version 34.0 and later."
    },
    "SupervisorDefaultAgentStatus": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The default agent status by which to filter agents in the Agent Status list in the supervisor panel."
    },
    "SupervisorDefaultButtonId": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The default button ID by which to filter agents in the Agent Status list in the supervisor panel."
    },
    "SupervisorDefaultSkillId": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The default skill ID by which to filter agents in the Agent Status list in the supervisor panel."
    }
  },
  "special_access_rules": "As of Summer ’20 and later, only authenticated internal and external users can access this object.",
  "usage": "Use this object to query and manage agent configurations in Chat.",
  "field_reference": {
    "AutoGreeting": {
      "field_label": "Auto Greeting",
      "type": "textarea",
      "length": "1000"
    },
    "Capacity": {
      "field_label": "Chat Capacity",
      "type": "int",
      "digits": "9"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CriticalWaitTime": {
      "field_label": "Critical Wait Alert Time (seconds)",
      "type": "int",
      "digits": "9"
    },
    "CustomAgentName": {
      "field_label": "Custom Agent Name",
      "type": "string",
      "length": "255"
    },
    "DeveloperName": {
      "field_label": "Developer Name",
      "type": "string",
      "length": "80"
    },
    "HasLogoutSound": {
      "field_label": "Play a notification sound if Omni Channel loses connection",
      "type": "boolean"
    },
    "HasNotifications": {
      "field_label": "Notifications Enabled",
      "type": "boolean"
    },
    "HasRequestSound": {
      "field_label": "Play a notification sound for chat requests",
      "type": "boolean"
    },
    "HasSneakPeek": {
      "field_label": "Sneak Peek Enabled",
      "type": "boolean"
    },
    "HasTransferConferenceGreeting": {
      "field_label": "Disable Auto Greeting on Transfer/Conference",
      "type": "boolean"
    },
    "Id": {
      "field_label": "Chat Agent Configuration ID",
      "type": "id",
      "length": "18"
    },
    "IsAutoAwayOnDecline": {
      "field_label": "Auto Away on Decline",
      "type": "boolean"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "Language": {
      "field_label": "Master Language",
      "type": "picklist",
      "length": "40"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "MasterLabel": {
      "field_label": "Chat Agent Configuration Name",
      "type": "string",
      "length": "80"
    },
    "OptionsHasAgentFileTransfer": {
      "field_label": "Agent File Transfer Enabled",
      "type": "boolean"
    },
    "OptionsHasAgentSneakPeek": {
      "field_label": "Agent Sneak Peek Enabled",
      "type": "boolean"
    },
    "OptionsHasAssistanceFlag": {
      "field_label": "Assistance Flag Enabled",
      "type": "boolean"
    },
    "OptionsHasChatConferencing": {
      "field_label": "Chat Conferencing Enabled",
      "type": "boolean"
    },
    "OptionsHasChatMonitoring": {
      "field_label": "Chat Monitoring Enabled",
      "type": "boolean"
    },
    "OptionsHasChatTransferToAgent": {
      "field_label": "Chat Transfer To Agents Enabled",
      "type": "boolean"
    },
    "OptionsHasChatTransferToButton": {
      "field_label": "Chat Transfer To Chat Buttons Enabled",
      "type": "boolean"
    },
    "OptionsHasChatTransferToSkill": {
      "field_label": "Chat Transfer To Skills Enabled",
      "type": "boolean"
    },
    "OptionsHasTransferConferenceGreeting": {
      "field_label": "HasTransferConferenceGreeting",
      "type": "boolean"
    },
    "OptionsHasVisitorBlocking": {
      "field_label": "Visitor Blocking Enabled",
      "type": "boolean"
    },
    "OptionsHasWhisperMessage": {
      "field_label": "Whisper Messages Enabled",
      "type": "boolean"
    },
    "OptionsIsAutoAwayOnPushTimeout": {
      "field_label": "Auto Away on Push Time-Out",
      "type": "boolean"
    },
    "SupervisorDefaultAgentStatus": {
      "field_label": "Default Agent Status Filter",
      "type": "picklist",
      "length": "255"
    },
    "SupervisorDefaultButtonId": {
      "field_label": "Chat Button ID",
      "type": "reference",
      "length": "18"
    },
    "SupervisorDefaultSkillId": {
      "field_label": "Skill ID",
      "type": "reference",
      "length": "18"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}