# Constants
The status for when the agent is logged in.
The status for when the agent is on a manual dial call.
The status for when the agent is on call.
The status for when the agent is paused.
The status for when the agent is on a preview call.
The status for when the agent is on a transfer call.
The status for when the agent is on a transfer call and the transfer is lost.
The status for when the agent is on a transfer call and the transfer target is lost.
0 explicitly means unspecified or invalid.
The status for when the agent is waiting.
The status for when the agent is wrapping up the call.
Blank.
Text contains.
Text does not contain.
Text does not end with.
Text does not start with.
Text ends with.
Equals.
Greater than.
Greater than or equal to.
Less than.
Less than or equal to.
Not blank.
Not equals.
Text starts with.
Not specified.
No description provided by the author
No description provided by the author
No description provided by the author
Connected hunt group.
Softphone hunt group.
0 explicitly means unspecified or invalid; equivalent to unconnected.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Campaign script category.
Hunt Group script category.
Not specified.
Check boxes.
Drop down select menu.
Multiple select menu.
Radio buttons.
Regular expression area.
Regular expression field.
Text area.
Text box.
Alphanumeric text box.
Numerical only text box.
Text verification field.
Not specified.
No description provided by the author
No description provided by the author
No description provided by the author
The code for when the agent triggers the advance to paused action.
The code for when the agent triggers the change password action.
The code for when the agent triggers the check voice mail action.
The code for when the agent triggers manually approve calls action.
0 explicitly means unspecified or invalid.
2 means a campaign client info display template.
1 means a hunt group client info display template.
0 explicitly means unspecified or invalid.
The action to advance the agent to a status Used for agent status: all but Logged In and all Transfer statuses.
The action to display a message.
The action to eject the agent.
The action to execute an integration link.
The action to execute a web link.
0 explicitly means unspecified or invalid.
Any number.
Cardinal number.
Ordinal number.
Agent Info type.
Custom Account Data key type.
Data Collect type.
Data Dip type.
Integration Data type.
IVR Data type.
Journey Data type.
Phone Metadata type.
Sip Header Data type.
Static or plaintext type.
TTS Field type.
0 explicitly means unspecified or invalid.
Zip Postal Metadata type.
Javascript web link type.
Standard web link type.
0 explicitly means unspecified or invalid.
# Variables
Enum value maps for AgentStatus.
Enum value maps for AgentStatus.
Enum value maps for CompareOperatorType.
Enum value maps for CompareOperatorType.
Enum value maps for ConnectionType.
Enum value maps for ConnectionType.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Enum value maps for HuntGroupType.
Enum value maps for HuntGroupType.
Enum value maps for ParameterSourceType.
Enum value maps for ParameterSourceType.
Enum value maps for Scorecards_EvaluationInterval.
Enum value maps for Scorecards_EvaluationInterval.
Enum value maps for ScriptCategory.
Enum value maps for ScriptCategory.
Enum value maps for ScriptResponseType.
Enum value maps for ScriptResponseType.
Enum value maps for Status.
Enum value maps for Status.
Enum value maps for SystemPauseCode.
Enum value maps for SystemPauseCode.
Enum value maps for TemplateCategory.
Enum value maps for TemplateCategory.
Enum value maps for TriggerAction.
Enum value maps for TriggerAction.
Enum value maps for VoiceAnalytics_Number_Kind.
Enum value maps for VoiceAnalytics_Number_Kind.
Enum value maps for WebLinkComponentKeyType.
Enum value maps for WebLinkComponentKeyType.
Enum value maps for WebLinkType.
Enum value maps for WebLinkType.
# Structs
An act within a HuntGroupScript.
Preferences for essential organization properties only to be used by account managers and customer support.
Preferences controlling direct agent properties.
No description provided by the author
Sets of rules that manage automatically adding responses to the DNCL.
A list of agent entries and duration to use to determine addition to DNCL.
DEPRECATED: Use services.org.hunt_groups.v1alpha1.AgentStatusOption instead
Deprecated: Marked as deprecated in api/commons/org/huntgroup.proto.
AgentTrigger is the entity for agent triggers.
AuthConnectionSettings is the entity for sso connection information.
No description provided by the author
Preferences for controlling the organization's authentication properties.
A message containing the settings needed to set up a duo mfa client for an organization.
A message containing the settings needed for email mfa for an organization.
AuthToken is an authentication token for a user.
AuthTokenExpiration is used to notify the user about an auth token expiration
Deprecated: Marked as deprecated in api/commons/org/auth_token.proto.
An Agent Call Response with comparitors and duration.
Barge-in filtering properties.
No description provided by the author
No description provided by the author
Preferences for editing templates and broadcast scheduling properties.
Broadcast start/stop time properties.
BusinessHours or operating hours.
Preferences for business intelligence settings/controls in analytics.
CallbackSettings is an entity containing the hunt group settings for the scheduled callbacks section of the hunt group manager.
Control which skills may be used when selecting routing.
Default callback routing properties.
Caller ID Bucket Data includes bucket name and the related XML property SID.
CertificateInfo contains the organization's certificate information.
A template used to describe a client info display.
CommunicationSettings is an entity containing the hunt group settings for the communication compliance section of the hunt group manager.
Automate response rules properties.
Automate response rules properties.
Scrub list data field properties.
Scrub list expiration properties.
CompareExpressionList contains a list of simple compare expressions.
ComplexBooleanExpression contains a compare expression list.
ComplexBooleanExpressionList contains a list of complex boolean expressions.
Preferences for natural language compliance campaign settings.
A conditional navigation within an Act.
Contact area code type.
No description provided by the author
No description provided by the author
Contact field description information.
The ContactFieldStyle contains the description id and the field style for a particular contact field.
Preferences for contact lists.
CountryHoliday holiday service name and country.
Custom dial order fields holds one or more contact field descriptions to indicate which fields in a contact record, and the order.
Contact import format properties.
Preferences for agent dashboard controls.
Preferences for controlling agent queue and hold table settings.
DataDipConfig is a proto recreation of the XML structure.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DayInterval describes a time interval of a given day.
The DialedNumberFieldStyle contains the field style for Dialed Number Field.
Dial order holds either a type enum, or one or more contact field description fields for custom order.
No description provided by the author
No description provided by the author
Dial order field holds the ID for saving into preferences and the name for display.
A disposition within an Act.
Preferences for email and SMS management.
Preferences for automated report jobs end-of-day delivery times.
FieldStyle describes a particular field within a client info display.
File name segment type and attributes.
File naming convention properties containing name segments.
Preferences for filters in reports and broadcasts.
GeneralSettings is an entity containing a section of the hunt group settings for the hunt group manager.
Agent Login GUI Statistics display and template.
Alphanumeric keypad options.
Data Dip data display options.
Available hunt group options.
Hold queue monitoring options.
Inbound natural compiance metadata options.
Payment Integration data display options.
Journey Integration data display options.
Pause option set properties.
Phone / Postal Metadata display options.
PrepareStateCallDelivery options (the dial modes).
GroupItem defines settings mapped to a single group.
HuntGroupDetails is the entity for hunt group details.
ClientInfoDisplayTemplateDetails is the entity for hunt group client info display template details.
GeneralDetails is the entity for hunt group general details.
IntegrationLinkDetails is the entity for hunt group integration link details.
ScriptDetails is the entity to describe the features of a script assigned to the hunt group.
TriggerDetails is the entity for hunt group trigger details.
WebLinkDetails is the entity for hunt group web link details.
HuntGroupScript represents a hunt group script.
HuntGroupSettings contains all of the hunt group settings.
HuntGroupWithClientInfoTemplateData is the entity for a hunt group with its client info display template data.
HuntGroup is the entity for a simplified hunt group details.
IdpClient represents an idp client.
Contact import template type.
No description provided by the author
No description provided by the author
Included call types.
IntegrationLink defines a link between a hunt group and an integration.
IntegrationLinkParameter defines a parameter for an integration link.
IntegrationLinkSubParameter defines a sub parameter for an integration link.
IntegrationLinkSubParameterPart defines a part of a sub parameter for an integration link.
Label is an entity message.
Entity message for a label assignment.
License defines the structure of organization license assignments.
No description provided by the author
No description provided by the author
ManualDialSettings is an entity containing the hunt group settings for the Manual Dial section of the hunt group settings manager.
Describes a mapping of return keys to manual dial values.
DefaultCallerId: custom or "Agent Caller ID" and number (if needed).
Allow the agent to override scrub settings.
MFA/2FA Information.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Totp is the type of MFA that uses a time-based one-time password.
No description provided by the author
MonthDayDate enables custom named dates.
Manual Dial natural compiance metadata options.
Use Natural Language Compliance and rule set ID.
NumberHistorySettings is an entity containing the hunt group settings for the Number History section of the hunt group settings manager.
ObservedHoliday may be a named date or a holiday.
No description provided by the author
No description provided by the author
ObservedHolidays a list of dates or holidays.
Organization contains the basic properties for an organization.
No description provided by the author
General preferences controlling organization properties.
P3PermissionGroup entity.
PasswordResetLink defines a link for the given user to reset their password.
PermissionGroup defines the permission group entity.
Preferences for phone dial options, call ID, and other call properties.
PreviewDialSettings is an entity containing the hunt group settings for the Preview Dial section of the hunt group manager.
PriorityGroup is a type and threshold in array for AgentProfileGroup.
ProgrammedDates a list of dates or holidays.
ProgrammedDay may be a named date or a holiday.
No description provided by the author
No description provided by the author
Range including start and end times.
Preferences for audio recording properties.
Recording file naming convention properties (per call type).
Recording file naming convention properties for compressed call recordings.
Report filter properties.
No description provided by the author
No description provided by the author
ResponseEvalutor manages regex.
Preferences for editing campaign scheduling properties.
Compliance schedule rule field properties.
Scorecards properties.
Preferences for scorecards management and evaluation.
SimpleCompareExpression describes a simple compare expression.
Agent skill.
SkillGroup represents a skill group entity.
A set of a skill identifier and the proficiency in that skill.
TimeOfDay describes the time of day by hour and minute.
TransferCallSettings is an entity containing the hunt group settings for the Transfer Call section of the hunt group settings manager.
DefaultCallerId indicates custom or 3rd party and number (if needed).
HandOffTypes indicates which Hand-off types the agent may use.
PbxTransferDisallowed if enabled, prohibits these extensions.
RequeueQueueConfiguration indicates which config to use on transfer.
RequeueTransferDisallowed if enabled, prohibits skills/hunt groups.
TransferTypes indicates which transfer types the agent may use.
DEPRECATED: Use services.org.hunt_groups.v1alpha1.TriggerActionOption instead
Deprecated: Marked as deprecated in api/commons/org/huntgroup.proto.
TriggerCallTypes is the call types to use for the trigger DEPRECATED: Use services.org.hunt_groups.v1alpha1.TriggerCallTypes instead
Deprecated: Marked as deprecated in api/commons/org/huntgroup.proto.
TriggerPauseCode is the pause code to use for the trigger DEPRECATED: Use services.org.hunt_groups.v1alpha1.TriggerPauseCode instead
Deprecated: Marked as deprecated in api/commons/org/huntgroup.proto.
No description provided by the author
No description provided by the author
Trust is the entity message for trusts.
TrustFilter is used to filter trusts during list RPCs.
No description provided by the author
TrustGroup contains ALL trusted permission/label groups assigned to a user.
No description provided by the author
User represents a user of the system.
The entity object used in the region_sid_map.
A verbiage within an Act.
Namespace for voice analytics messages.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Preferences for voice analytics.
Preferences for web-hook push URLs.
A structure used for representing a web link.
WebLinkComponent contains the key type and string of a web link.
WebLinkParameter contains a key and web link component.
ZIP/postal code scrubbing properties.
# Type aliases
AgentStatus is the status of the agent on which the trigger is based DEPRECATED: Use services.org.hunt_groups.v1alpha1.AgentStatus instead
Deprecated: Marked as deprecated in api/commons/org/huntgroup.proto.
CompareOperatorType differentiates between operator types in a SimpleCompareExpression.
ConnectionType defines the different provider types an auth connection can be.
HuntGroupType represents the type of a hunt group.
ParameterSourceType defines the type of parameter source.
EvaluationsInterval enumerates common time periods for evaluations.
ScriptCategory differentiates between Hunt Group and Campaign scripts.
ScriptResponseType differentiates between script responses.
Status represents the states that trusts can be in.
SystemPauseCode controls if a system Pause code is being used DEPRECATED: Use services.org.hunt_groups.v1alpha1.SystemPauseCode instead
Deprecated: Marked as deprecated in api/commons/org/huntgroup.proto.
Tempate category differentiates between template types.
TriggerAction is the action to take when the trigger is activated DEPRECATED: Use services.org.hunt_groups.v1alpha1.TriggerAction instead
Deprecated: Marked as deprecated in api/commons/org/huntgroup.proto.
No description provided by the author
Enums to represent the WebLinkComponentKeyType.
WebLinkType describes the type of a particular web link.