PendingServiceRouting

Represents the routing details of a work item that’s waiting to be routed or assigned. This object is available in API version 40.0 and later.

Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Special Access Rules

To access this object, Omni-Channel must be enabled.

Fields

Field	Details
BotId	Type reference Properties Create, Filter, Group, Nillable, Sort Description Bot ID the work item is assigned to. You can only use enhanced bots. This field is available in API version 55.0 and later. This field is a relationship field. Relationship Name Bot Relationship Type Lookup Refers To BotDefinition
CapacityPercentage	Type percent Properties Create, Filter, Nillable, Sort, Update Description Indicates the amount of work that this work item represents as a percentage. Valid values are from 0 to 100.
CapacityWeight	Type double Properties Create, Filter, Nillable, Sort, Update Description Indicates the amount of work that this work item represents as a whole number.
CustomRequestedDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Retains the datetime of this work item’s initial request, so work items are rerouted using the datetime of the initial work request. When left blank, work items are rerouted using the datetime when they’re rerouted.
DropAdditionalSkillsTimeout	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Time to wait before a skill marked as additional is dropped from Omni-Channel routing. The case is then routed to the best-matched agent even if they don’t have all the skills. If CustomRequestedDateTime is set in the PendingServiceRouting object, DropAdditionalSkillsTimeout uses CustomRequestedDateTime as the start time. If CustomRequestedDateTime + DropAdditionalSkillsTimeout has already passed, Omni-Channel immediately drops the additional skills after the pending service request is created.
GroupId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the Omni-Channel queue.
IsInterruptible	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a work item consumes interruptible or primary capacity. The default value is false. Available in version 57.0 and later when the Interruptible Capacity feature is enabled.
IsOwnerChangeInitiated	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a work item owner change triggered the direct assignment of this work item to the agent. The default value is `false`.
IsPreferredUserRequired	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether this work item stays with the preferred user even when the user isn’t available. The default value is `false`. This field is available in API version 50.0 and later. When a specific agent is required, don’t set `PushTimeout`. These options aren’t supported in this case.
IsPushAttempted	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a push has been attempted. `true` if this work item was pushed to an agent at least one time and `false` otherwise.
IsPushed	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this work item is pushed to an agent.
IsReadyForRouting	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this work item is ready to be routed to an agent. If `true`, you can’t edit this PendingServiceRouting record.
IsStatusChangeInitiated	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether a work item status change triggered the direct assignment of this work item to the agent. The default value is `false`. This field is available in API version 50.0 and later.
IsTransfer	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this work item routing is a transfer request.
LastDeclinedAgentSession	Type string Properties Filter, Group, Nillable, Sort Description Chat session ID of the agent who last declined this work item.
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the PendingServiceRouting record.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of this PendingServiceRouting record.
PreferredUserId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the preferred user to handle the work item.
PushTimeout	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The time limit set for an agent to respond to an item before it’s rerouted and the agent’s status is changed accordingly. The time limit is measured in seconds. This field is available in API version 36.0 and later. Effective API version 57.0, for inbound Voice calls, this field represents the time limit set for an agent to respond to a call before it’s declined. The value must be from 0 through 20. The value is capped at 20, so any number greater than that is treated as 20 seconds. Latency on the part of the telephony provider can result in agents having less than 20 seconds to answer a call before it’s rerouted. When an agent attempts to answer a call within 20 seconds and finds that the call was rerouted, the agent’s status remains unchanged. This scenario applies to these telephony models. Service Cloud Voice with Amazon Connect Service Cloud Voice with Partner Telephony from Amazon Connect When `IsPreferredUserRequired` is set to true, don’t set this option. When a specific agent is required, this option isn’t supported. Note
QueueId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the Omni-Channel queue. Due to API changes, `QueueId` is no longer recommended. Use `GroupId` instead.
RoutingModel	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Type of routing model. Possible values are: `ExternalRouting` `LeastActive` `MostAvailable`
RoutingPriority	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Order in which work items are routed to agents. This field is considered with skills-based routing only. Queue-based routing sets a work item's priority from the routing configuration.
RoutingType	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether the work item is routed by queue or by skills-based routing. Possible values are: `QueueBased` `SkillsBased`
SecondaryRoutingPriority	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the secondary routing priority.
Serial	Type int Properties Filter, Group, Nillable, Sort Description Serial number of the PendingServiceRouting record. The serial number is automatically incremented each time the PendingServiceRouting record is modified.
ServiceChannelId	Type reference Properties Create, Filter, Group, Sort Description ID of the service channel.
WorkItemId	Type reference Properties Create, Filter, Group, Sort Description ID of the work item. Refers To Custom objects and these standard objects: Account, Activity, Case, Claim, ClaimCoverage, ClaimRecovery, Contact, ContactRequest, CustomEntityData, Incident, Lead, LiveChatTranscript, MessagingSession, Opportunity, Orchestration Work Items, Order, Order, PaymentRequest, PersonTraining, Referral, SocialPost, SwarmMember, and VoiceCall. WorkOrder is available in version 58.0 and later.

Usage

When you use the PendingServiceRouting object for queue-based routing, the object doesn’t invoke triggers before or after insert, or any action (trigger, workflow rule, validation) that could interfere with the creation of the record.

Associated Objects

This object has these associated objects. Unless noted, they’re available in the same API version as this object.

PendingServiceRoutingOwnerSharingRule: Sharing rules are available for the object.
PendingServiceRoutingShare: Sharing is available for the object.

Limits

You can view the number of Pending Service Routing records that are currently in use in your org, as well as the current hourly use rate. From Setup, enter Omni-Channel in the Quick Find box and select Limits. The Limits page also displays the current Pending Service Routing record usage percentage and the Pending Service Routing record limits for your org.

Object Reference for the Salesforce Platform