PresenceUserConfig

Represents a configuration that determines a presence user’s settings.

Version 

Introduced in API version 65.0.

Supported SOAP API Calls 

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules 

• Available only if Omni-Channel is enabled in your org.

Fields 

AcwExtensionDuration 

• Type: int

• Required: No

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Introduced: API version 65.0

• Description: The maximum length of time, measured in seconds, an agent can spend on After Conversation Work (ACW) each time they extend the timer. You must set this field if HasAcwExtensionEnabled is set to true. Specify a value from 10 through 3600.

AfterConvoWorkMaxTime 

• Type: int

• Required: No

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Introduced: API version 65.0

• Description: The maximum length of time, measured in seconds, an agent has to complete ACW. You must set this field if HasAfterConvoWorkTimer is set to true. Specify a value from 10 through 3600.

Capacity 

• Type: int

• Required: No

• Properties: Create, Filter, Group, Sort, Update

• Description: The maximum number of work units an agent can be assigned at one time.

CustomSoundId 

• Type: reference

• Required: No

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Introduced: API version 55.0

• Relationship name: CustomSound

• Relationship type: relationship

• Refers to: StaticResource

DeveloperName 

• Type: string

• Required: No

• Properties: Create, Filter, Group, Sort, Update

• Description: - The unique name of the object in the API.

HasAcwExtensionEnabled 

• Type: boolean

• Required: No

• Properties: Create, Defaulted on create, Filter, Group, Sort, Update

• Introduced: API version 65.0

• Description: Indicates whether agents can extend their ACW time (true) or not (false). Available only if HasAfterConvoWorkTimer is set to true. If this field is set to true, you must also set the AcwExtensionDuration and MaxExtensions fields.

The default value is false.

• Default value: false

HasAfterConvoWorkTimer 

• Type: boolean

• Required: No

• Properties: Create, Defaulted on create, Filter, Group, Sort, Update

• Introduced: API version 65.0

• Description: Indicates whether ACW time can be configured for the agent (true) or not (false). If set to true, you must also set the AfterConvoWorkMaxTime field to true.

The default value is false.

• Default value: false

InterruptibleCapacity 

• Type: int

• Required: No

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Introduced: API version 61.0

• Description: The maximum number of work units using interruptible capacity that can be assigned to an agent at a time. If the value in this field is empty it defaults to the value set in the Capacity field. This field is available only when the Interruptible Capacity feature is enabled.

Language 

• Type: picklist

• Required: No

• Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

• Description: The language of the presence configuration.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

MasterLabel 

• Type: string

• Required: No

• Properties: Create, Filter, Group, Sort, Update

• Description: The label of the presence configuration.

MaxExtensions 

• Type: picklist

• Required: No

• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

• Introduced: API version 65.0

• Description: Maximum number of times an agent can extend their ACW time. Specify a value from 1 through 10. You must set this field if HasAcwExtensionEnabled is set to true.

• Possible values:

  • 1 — 1

  • 2 — 2

  • 3 — 3

  • 4 — 4

  • 5 — 5

  • 6 — 6

  • 7 — 7

  • 8 — 8

  • 9 — 9

  • 10 — 10

OptionsIsAllowAnyDestinationFlowForTransferEnabled 

• Type: boolean
• Required: No
• Properties: Create, Filter, Update

OptionsIsAllowAnyDestinationProfileForTransferEnabled 

• Type: boolean
• Required: No
• Properties: Create, Filter, Update

OptionsIsAllowAnyDestinationQueueForTransferEnabled 

• Type: boolean
• Required: No
• Properties: Create, Filter, Update

OptionsIsAutoAcceptEnabled 

• Type: boolean
• Required: No
• Properties: Create, Filter, Update

OptionsIsDeclineEnabled 

• Type: boolean
• Required: No
• Properties: Create, Filter, Update

OptionsIsDeclineReasonEnabled 

• Type: boolean
• Required: No
• Properties: Create, Filter, Update

OptionsIsDisconnectSoundEnabled 

• Type: boolean
• Required: No
• Properties: Create, Filter, Update

OptionsIsRequestSoundEnabled 

• Type: boolean
• Required: No
• Properties: Create, Filter, Update

PresenceStatusOnDeclineId 

• Type: reference

• Required: No

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Relationship name: PresenceStatusOnDecline

• Relationship type: relationship

• Refers to: ServicePresenceStatus

PresenceStatusOnPushTimeoutId 

• Type: reference

• Required: No

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Introduced: API version 36.0

• Relationship name: PresenceStatusOnPushTimeout

• Relationship type: relationship

• Refers to: ServicePresenceStatus

SoundLength 

• Type: int
• Required: No
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Introduced: API version 55.0