/genesys-routing | Type: Application | PCID required: Yes
Tools
genesys_routing_delete_directroutingbackup_settings_me
Delete the user’s Direct Routing Backup settings and revert to the Direct Routing Queue default.genesys_routing_delete_language
Delete a routing language Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
languageId | string | Yes | — | Language ID |
genesys_routing_delete_queue
Delete a queue Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | Queue ID |
forceDelete | boolean | No | — | forceDelete |
genesys_routing_delete_queue_member
Delete a queue member. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | Queue ID |
memberId | string | Yes | — | Member ID |
genesys_routing_delete_queue_wrapupcode
Delete a wrap-up code from a queue Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | Queue ID |
codeId | string | Yes | — | Code ID |
genesys_routing_delete_settings
Delete an organization’s routing settingsgenesys_routing_delete_skill
Delete Routing Skill Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillId | string | Yes | — | Skill ID |
genesys_routing_delete_skillgroup
Remove skill group definition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillGroupId | string | Yes | — | Skill Group ID |
genesys_routing_delete_user_directroutingbackup_settings
Delete the user’s Direct Routing Backup settings and revert to the Direct Routing Queue default. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
genesys_routing_delete_user_routinglanguage
Remove a routing language from a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
languageId | string | Yes | — | languageId |
genesys_routing_delete_user_routingskill
Remove a routing skill from a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
skillId | string | Yes | — | skillId |
genesys_routing_delete_user_utilization
Delete the user’s max utilization settings and revert to the organization-wide default. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
genesys_routing_delete_utilization
Delete the organization-wide max utilization settings and revert to the system default.genesys_routing_delete_utilization_label
Delete a utilization label Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
labelId | string | Yes | — | Utilization Label ID |
forceDelete | boolean | No | — | Remove all label usages (if found) without warning |
genesys_routing_delete_wrapupcode
Delete wrap-up code Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
codeId | string | Yes | — | Wrapup Code ID |
genesys_routing_get_availablemediatypes
Get available media typesgenesys_routing_get_directroutingbackup_settings_me
Get the user’s Direct Routing Backup settings.genesys_routing_get_language
Get a routing language Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
languageId | string | Yes | — | Language ID |
genesys_routing_get_languages
Get the list of supported languages. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
sortOrder | string | No | — | Ascending or descending sort order |
name | string | No | — | Name |
id | any[] | No | — | id |
genesys_routing_get_message_recipient
Get a recipient Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
recipientId | string | Yes | — | Recipient ID |
genesys_routing_get_message_recipients
Get recipients Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messengerType | string | No | — | Messenger Type |
name | string | No | — | Recipient Name |
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
genesys_routing_get_queue
Get details about this queue. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | Queue ID |
expand | any[] | No | — | Which fields, if any, to expand |
genesys_routing_get_queue_assistant
Get an assistant associated with a queue. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | Queue ID |
expand | any[] | No | — | Which fields, if any, to expand. |
languageVariation | string | No | — | Language variation |
fallbackToPrimaryAssistant | boolean | No | — | Fall back to primary assistant if specified variation is not found |
genesys_routing_get_queue_comparisonperiod
Get a Comparison Period. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | Queue id |
comparisonPeriodId | string | Yes | — | ComparisonPeriod id |
genesys_routing_get_queue_comparisonperiods
Get list of comparison periods Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | Queue id |
genesys_routing_get_queue_estimatedwaittime
Get Estimated Wait Time Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | queueId |
conversationId | string | No | — | conversationId |
genesys_routing_get_queue_mediatype_estimatedwaittime
Get Estimated Wait Time Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | queueId |
mediaType | string | Yes | — | mediaType |
labelId | string | No | — | Unique id that represents the interaction label used with media type for EWT calculation |
genesys_routing_get_queue_members
Get the members of this queue. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | Queue ID |
pageNumber | integer | No | — | pageNumber |
pageSize | integer | No | — | Max value is 100 |
sortOrder | string | No | — | Note: results are sorted by name. |
expand | any[] | No | — | Which fields, if any, to expand. |
name | string | No | — | Filter by queue member name (contains-style search) |
profileSkills | any[] | No | — | Filter by profile skill (contains-style search) |
skills | any[] | No | — | Filter by skill (contains-style search) |
languages | any[] | No | — | Filter by language (contains-style search) |
routingStatus | any[] | No | — | Filter by routing status |
presence | any[] | No | — | Filter by presence |
memberBy | string | No | — | Filter by member type |
joined | boolean | No | — | Filter by joined status |
genesys_routing_get_queue_wrapupcodes
Get the wrap-up codes for a queue Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | Queue ID |
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
name | string | No | — | Wrapup code’s name (trailing asterisks allowed) |
genesys_routing_get_queues
Get list of queues. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageNumber | integer | No | — | Page number |
pageSize | integer | No | — | Page size |
sortOrder | string | No | — | Note: results are sorted by name. |
name | string | No | — | Include only queues with the given name (leading and trailing asterisks allowed) |
id | any[] | No | — | Include only queues with the specified ID(s) |
divisionId | any[] | No | — | Include only queues in the specified division ID(s) |
peerId | any[] | No | — | Include only queues with the specified peer ID(s) |
cannedResponseLibraryId | string | No | — | Include only queues explicitly associated with the specified canned response library ID |
hasPeer | boolean | No | — | Include only queues with a peer ID |
expand | any[] | No | — | Which fields, if any, to expand |
genesys_routing_get_queues_me
Get a paged listing of queues the user is a member of. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageNumber | integer | No | — | Page number |
pageSize | integer | No | — | Page size |
joined | boolean | No | — | Filter by joined status. |
sortOrder | string | No | — | Note: results are sorted by name. |
genesys_routing_get_routing_availablemediatypes
Get available media typesgenesys_routing_get_routing_language
Get a routing language Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
languageId | string | Yes | — | Language ID |
genesys_routing_get_routing_languages
Get the list of supported languages. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
sortOrder | string | No | — | Ascending or descending sort order |
name | string | No | — | Name |
id | any[] | No | — | id |
genesys_routing_get_routing_queue
Get details about this queue. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | Queue ID |
expand | any[] | No | — | Which fields, if any, to expand |
genesys_routing_get_routing_queue_estimatedwaittime
Get Estimated Wait Time Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | queueId |
conversationId | string | No | — | conversationId |
genesys_routing_get_routing_queue_members
Get the members of this queue. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | Queue ID |
pageNumber | integer | No | — | pageNumber |
pageSize | integer | No | — | Max value is 100 |
sortOrder | string | No | — | Note: results are sorted by name. |
expand | any[] | No | — | Which fields, if any, to expand. |
name | string | No | — | Filter by queue member name (contains-style search) |
profileSkills | any[] | No | — | Filter by profile skill (contains-style search) |
skills | any[] | No | — | Filter by skill (contains-style search) |
languages | any[] | No | — | Filter by language (contains-style search) |
routingStatus | any[] | No | — | Filter by routing status |
presence | any[] | No | — | Filter by presence |
memberBy | string | No | — | Filter by member type |
joined | boolean | No | — | Filter by joined status |
genesys_routing_get_routing_queue_wrapupcodes
Get the wrap-up codes for a queue Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | Queue ID |
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
name | string | No | — | Wrapup code’s name (trailing asterisks allowed) |
genesys_routing_get_routing_queues
Get list of queues. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageNumber | integer | No | — | Page number |
pageSize | integer | No | — | Page size |
sortOrder | string | No | — | Note: results are sorted by name. |
name | string | No | — | Include only queues with the given name (leading and trailing asterisks allowed) |
id | any[] | No | — | Include only queues with the specified ID(s) |
divisionId | any[] | No | — | Include only queues in the specified division ID(s) |
peerId | any[] | No | — | Include only queues with the specified peer ID(s) |
cannedResponseLibraryId | string | No | — | Include only queues explicitly associated with the specified canned response library ID |
hasPeer | boolean | No | — | Include only queues with a peer ID |
expand | any[] | No | — | Which fields, if any, to expand |
genesys_routing_get_routing_queues_me
Get a paged listing of queues the user is a member of. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageNumber | integer | No | — | Page number |
pageSize | integer | No | — | Page size |
joined | boolean | No | — | Filter by joined status. |
sortOrder | string | No | — | Note: results are sorted by name. |
genesys_routing_get_routing_skill
Get Routing Skill Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillId | string | Yes | — | Skill ID |
genesys_routing_get_routing_skills
Get the list of routing skills. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
name | string | No | — | Filter for results that start with this value |
id | any[] | No | — | id |
genesys_routing_get_routing_utilization
Get the organization-wide max utilization settings.genesys_routing_get_routing_wrapupcode
Get details about this wrap-up code. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
codeId | string | Yes | — | Wrapup Code ID |
genesys_routing_get_routing_wrapupcodes
Get list of wrapup codes. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
sortBy | string | No | — | Sort by |
sortOrder | string | No | — | Sort order |
name | string | No | — | Wrapup code’s name (‘Sort by’ param is ignored unless this field is provided) |
id | any[] | No | — | Filter by wrapup code ID(s) |
divisionId | any[] | No | — | Filter by division ID(s) |
genesys_routing_get_settings
Get an organization’s routing settingsgenesys_routing_get_settings_contactcenter
Get Contact Center Settingsgenesys_routing_get_settings_transcription
Get Transcription Settingsgenesys_routing_get_skill
Get Routing Skill Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillId | string | Yes | — | Skill ID |
genesys_routing_get_skillgroup
Get skill group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillGroupId | string | Yes | — | Skill Group ID |
genesys_routing_get_skillgroup_members
Get skill group members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillGroupId | string | Yes | — | Skill Group ID |
pageSize | integer | No | — | Page size |
after | string | No | — | The cursor that points to the next item |
before | string | No | — | The cursor that points to the previous item |
expand | string | No | — | Expand the name on each user |
genesys_routing_get_skillgroup_members_divisions
Get list of member divisions for this skill group. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillGroupId | string | Yes | — | Skill Group ID |
expand | string | No | — | Expand the name on each user |
genesys_routing_get_skillgroups
Get skill group listing Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | Page size |
name | string | No | — | Return only skill group names whose names start with this value (case-insensitive matching) |
after | string | No | — | The cursor that points to the next item |
before | string | No | — | The cursor that points to the previous item |
genesys_routing_get_skills
Get the list of routing skills. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
name | string | No | — | Filter for results that start with this value |
id | any[] | No | — | id |
genesys_routing_get_user_directroutingbackup_settings
Get the user’s Direct Routing Backup settings. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
genesys_routing_get_user_queues
Get queues for user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
joined | boolean | No | — | Is joined to the queue |
divisionId | any[] | No | — | Division ID(s) |
genesys_routing_get_user_routinglanguages
List routing languages assigned to a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
sortOrder | string | No | — | Ascending or descending sort order |
genesys_routing_get_user_routingskills
List routing skills assigned to a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
sortOrder | string | No | — | Ascending or descending sort order |
genesys_routing_get_user_skillgroups
Get skill groups for a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
pageSize | integer | No | — | Page size |
after | string | No | — | The cursor that points to the next page |
before | string | No | — | The cursor that points to the previous page |
genesys_routing_get_user_utilization
Get the user’s max utilization settings. If not configured, the organization-wide default is returned. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
genesys_routing_get_utilization
Get the organization-wide max utilization settings.genesys_routing_get_utilization_label
Get details about this utilization label Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
labelId | string | Yes | — | Utilization Label ID |
genesys_routing_get_utilization_label_agents
Get list of agent ids associated with a utilization label Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
labelId | string | Yes | — | Utilization Label ID |
genesys_routing_get_utilization_labels
Get list of utilization labels Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
sortOrder | string | No | — | Sort order by name |
name | string | No | — | Utilization label’s name (Wildcard is supported, e.g., ‘label1*’, ‘label’ |
genesys_routing_get_wrapupcode
Get details about this wrap-up code. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
codeId | string | Yes | — | Wrapup Code ID |
genesys_routing_get_wrapupcodes
Get list of wrapup codes. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
sortBy | string | No | — | Sort by |
sortOrder | string | No | — | Sort order |
name | string | No | — | Wrapup code’s name (‘Sort by’ param is ignored unless this field is provided) |
id | any[] | No | — | Filter by wrapup code ID(s) |
divisionId | any[] | No | — | Filter by division ID(s) |
genesys_routing_patch_conversation
Update attributes of an in-queue conversation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
conversationId | string | Yes | — | Conversation ID |
labelId | string | No | — | Label requirement for the conversation. To remove the label requirement (setting it to System Default Label), specify an empty string, i.e., "". |
languageId | string | No | — | Language requirement for the conversation. To remove the language requirement, specify an empty string, i.e., "". |
priority | integer | No | — | Priority for the conversation. Each point of priority is equivalent to one minute of time in queue. Range:[-25000000, 25000000]. To reset, specify 0. |
requestScoredAgents | any[] | No | — | requestScoredAgents |
skillIds | any[] | No | — | Skill requirements for the conversation. To remove all skill requirements, specify an empty list, i.e. []. |
genesys_routing_patch_queue_member
Update the ring number OR joined status for a queue member. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | Queue ID |
memberId | string | Yes | — | Member ID |
id | string | No | — | The queue member’s id. |
joined | boolean | No | — | joined |
memberBy | string | No | — | memberBy |
name | string | No | — | name |
ringNumber | integer | No | — | ringNumber |
routingStatus | object | No | — | routingStatus |
selfUri | string | No | — | The URI for this object |
user | object | No | — | user |
genesys_routing_patch_queue_members
Join or unjoin a set of up to 100 users for a queue Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | Queue ID |
body | any[] | Yes | — | Queue Members |
genesys_routing_patch_settings_contactcenter
Update Contact Center Settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
removeSkillsFromBlindTransfer | boolean | No | — | Strip skills from transfer |
genesys_routing_patch_settings_transcription
Patch Transcription Settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contentSearchEnabled | boolean | No | — | Setting to enable/disable content search |
lowLatencyTranscriptionEnabled | boolean | No | — | Boolean flag indicating whether low latency transcription via Notification API is enabled |
pciDssRedactionEnabled | boolean | No | — | Setting to enable/disable PCI DSS Redaction |
piiRedactionEnabled | boolean | No | — | Setting to enable/disable PII Redaction |
transcription | string | Yes | — | Setting to enable/disable transcription capability |
transcriptionConfidenceThreshold | integer | Yes | — | Configure confidence threshold. The possible values are from 1 to 100. |
genesys_routing_patch_skill
Update Routing Skill Division Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillId | string | Yes | — | Skill ID |
divisionId | string | No | — | The division to which this skill will belong |
genesys_routing_patch_skillgroup
Update skill group definition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillGroupId | string | Yes | — | Skill Group ID |
dateCreated | string | No | — | Created date/time of the skill group. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
dateModified | string | No | — | Last modified date/time of the skill group. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
description | string | No | — | Group description |
division | object | No | — | division |
id | string | No | — | The globally unique identifier for the object. |
memberCount | integer | No | — | Estimated number of members in this group. It can take some time for the count to be updated after expressions are changed. |
name | string | Yes | — | The group name. |
selfUri | string | No | — | The URI for this object |
skillConditions | any[] | Yes | — | Conditions for this group |
status | string | No | — | Group’s filling status |
genesys_routing_patch_user_queue
Join or unjoin a queue for a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | Queue ID |
userId | string | Yes | — | User ID |
acwSettings | object | No | — | acwSettings |
agentOwnedRouting | object | No | — | agentOwnedRouting |
bullseye | object | No | — | bullseye |
callingPartyName | string | No | — | The name to use for caller identification for outbound calls from this queue. |
callingPartyNumber | string | No | — | The phone number to use for caller identification for outbound calls from this queue. |
cannedResponseLibraries | object | No | — | cannedResponseLibraries |
conditionalGroupActivation | object | No | — | conditionalGroupActivation |
conditionalGroupRouting | object | No | — | conditionalGroupRouting |
createdBy | string | No | — | The ID of the user that created the queue. |
dateCreated | string | No | — | The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
dateModified | string | No | — | The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
defaultScripts | object | No | — | The default script Ids for the communication types. |
description | string | No | — | The queue description. |
directRouting | object | No | — | directRouting |
division | object | No | — | division |
emailInQueueFlow | object | No | — | emailInQueueFlow |
enableAudioMonitoring | boolean | No | — | Indicates whether audio monitoring is enabled for this queue. |
enableManualAssignment | boolean | No | — | Indicates whether manual assignment is enabled for this queue. |
enableTranscription | boolean | No | — | Indicates whether voice transcription is enabled for this queue. |
id | string | No | — | The globally unique identifier for the object. |
joined | boolean | No | — | joined |
joinedMemberCount | integer | No | — | The number of joined members in the queue. |
lastAgentRoutingMode | string | No | — | The Last Agent Routing Mode for the queue. |
mediaSettings | object | No | — | mediaSettings |
memberCount | integer | No | — | The total number of members in the queue. |
memberGroups | any[] | No | — | The groups of agents associated with the queue, if any. Queue membership will update to match group membership changes. |
messageInQueueFlow | object | No | — | messageInQueueFlow |
modifiedBy | string | No | — | The ID of the user that last modified the queue. |
name | string | No | — | name |
onHoldPrompt | object | No | — | onHoldPrompt |
outboundEmailAddress | object | No | — | outboundEmailAddress |
outboundMessagingAddresses | object | No | — | outboundMessagingAddresses |
peerId | string | No | — | The ID of an associated external queue. |
queueFlow | object | No | — | queueFlow |
routingRules | any[] | No | — | The routing rules for the queue, used for Preferred Agent Routing. |
scoringMethod | string | No | — | The Scoring Method for the queue. |
selfUri | string | No | — | The URI for this object |
skillEvaluationMethod | string | No | — | The skill evaluation method to use when routing conversations. |
suppressInQueueCallRecording | boolean | No | — | Indicates whether recording in-queue calls is suppressed for this queue. |
userMemberCount | integer | No | — | The number of user members (i.e., non-group members) in the queue. |
whisperPrompt | object | No | — | whisperPrompt |
genesys_routing_patch_user_queues
Join or unjoin a set of queues for a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
divisionId | any[] | No | — | Division ID(s) |
body | any[] | Yes | — | User Queues |
genesys_routing_patch_user_routinglanguage
Update an assigned routing language’s proficiency Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
languageId | string | Yes | — | languageId |
id | string | No | — | The globally unique identifier for the object. |
languageUri | string | No | — | URI to the organization language used by this user language. |
name | string | No | — | name |
proficiency | number | No | — | A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings. |
selfUri | string | No | — | The URI for this object |
state | string | No | — | Activate or deactivate this routing language. |
genesys_routing_post_analytics_queues_observations_query
Query for queue observations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
detailMetrics | any[] | No | — | Metrics for which to include additional detailed observations |
filter | object | Yes | — | filter |
metrics | any[] | Yes | — | Behaves like a SQL SELECT clause. Only named metrics will be retrieved. |
genesys_routing_post_languages
Create Language Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dateModified | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
id | string | No | — | The globally unique identifier for the object. |
name | string | Yes | — | The language name. |
selfUri | string | No | — | The URI for this object |
state | string | No | — | state |
version | string | No | — | version |
genesys_routing_post_queue_members
Bulk add or delete up to 100 queue members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | Queue ID |
delete | boolean | No | — | True to delete queue members |
body | any[] | Yes | — | Queue Members |
genesys_routing_post_queue_wrapupcodes
Add up to 100 wrap-up codes to a queue Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | Queue ID |
body | any[] | Yes | — | List of wrapup codes |
genesys_routing_post_queues
Create a queue Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
acwSettings | object | No | — | acwSettings |
agentOwnedRouting | object | No | — | agentOwnedRouting |
autoAnswerOnly | boolean | No | — | Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered. |
bullseye | object | No | — | bullseye |
callingPartyName | string | No | — | The name to use for caller identification for outbound calls from this queue. |
callingPartyNumber | string | No | — | The phone number to use for caller identification for outbound calls from this queue. |
cannedResponseLibraries | object | No | — | cannedResponseLibraries |
conditionalGroupActivation | object | No | — | conditionalGroupActivation |
conditionalGroupRouting | object | No | — | conditionalGroupRouting |
createdBy | string | No | — | The ID of the user that created the queue. |
dateCreated | string | No | — | The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
dateModified | string | No | — | The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
defaultScripts | object | No | — | The default script Ids for the communication types. |
description | string | No | — | The queue description. |
directRouting | object | No | — | directRouting |
division | object | No | — | division |
emailInQueueFlow | object | No | — | emailInQueueFlow |
enableAudioMonitoring | boolean | No | — | Indicates whether audio monitoring is enabled for this queue. |
enableManualAssignment | boolean | No | — | Indicates whether manual assignment is enabled for this queue. |
enableTranscription | boolean | No | — | Indicates whether voice transcription is enabled for this queue. |
id | string | No | — | The globally unique identifier for the object. |
joinedMemberCount | integer | No | — | The number of joined members in the queue. |
lastAgentRoutingMode | string | No | — | The Last Agent Routing Mode for the queue. |
mediaSettings | object | No | — | mediaSettings |
memberCount | integer | No | — | The total number of members in the queue. |
memberGroups | any[] | No | — | The groups of agents associated with the queue, if any. Queue membership will update to match group membership changes. |
messageInQueueFlow | object | No | — | messageInQueueFlow |
modifiedBy | string | No | — | The ID of the user that last modified the queue. |
name | string | Yes | — | The queue name |
onHoldPrompt | object | No | — | onHoldPrompt |
outboundEmailAddress | object | No | — | outboundEmailAddress |
outboundMessagingAddresses | object | No | — | outboundMessagingAddresses |
peerId | string | No | — | The ID of an associated external queue. |
queueFlow | object | No | — | queueFlow |
routingRules | any[] | No | — | The routing rules for the queue, used for Preferred Agent Routing. |
scoringMethod | string | No | — | The Scoring Method for the queue. |
selfUri | string | No | — | The URI for this object |
skillEvaluationMethod | string | No | — | The skill evaluation method to use when routing conversations. |
sourceQueueId | string | No | — | The id of an existing queue to copy the settings (does not include GPR settings) from when creating a new queue. |
suppressInQueueCallRecording | boolean | No | — | Indicates whether recording in-queue calls is suppressed for this queue. |
userMemberCount | integer | No | — | The number of user members (i.e., non-group members) in the queue. |
whisperPrompt | object | No | — | whisperPrompt |
genesys_routing_post_skillgroup_members_divisions
Add or remove member divisions for this skill group. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skillGroupId | string | Yes | — | Skill Group ID |
addDivisionIds | any[] | No | — | addDivisionIds |
removeDivisionIds | any[] | No | — | removeDivisionIds |
genesys_routing_post_skillgroups
Create a skill group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dateCreated | string | No | — | Created date/time of the skill group. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
dateModified | string | No | — | Last modified date/time of the skill group. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
description | string | No | — | Group description |
division | object | No | — | division |
id | string | No | — | The globally unique identifier for the object. |
memberCount | integer | No | — | Estimated number of members in this group. It can take some time for the count to be updated after expressions are changed. |
memberDivisions | any[] | No | — | Member divisions for this skill group |
name | string | Yes | — | The group name. |
selfUri | string | No | — | The URI for this object |
skillConditions | any[] | Yes | — | Conditions for this group |
status | string | No | — | Group’s filling status |
genesys_routing_post_skills
Create Skill Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The name of the skill. |
genesys_routing_post_user_routinglanguages
Assign a routing language to a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
id | string | Yes | — | The id of the existing routing language to add to the user |
languageUri | string | No | — | URI to the organization language used by this user language. |
proficiency | number | Yes | — | Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular language. It is used when a queue is set to “Best available language” mode to allow acd interactions to target agents with higher proficiency ratings. |
selfUri | string | No | — | The URI for this object |
genesys_routing_post_user_routingskills
Assign a routing skill to a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
id | string | Yes | — | The id of the existing routing skill to add to the user |
proficiency | number | Yes | — | Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular skill. It is used when a queue is set to “Best available skills” mode to allow acd interactions to target agents with higher proficiency ratings. |
selfUri | string | No | — | The URI for this object |
skillUri | string | No | — | URI to the organization skill used by this user skill. |
genesys_routing_post_utilization_labels
Create a utilization label Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The utilization label name. |
utilization | object | No | — | utilization |
genesys_routing_post_wrapupcodes
Create a wrap-up code Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
createdBy | string | No | — | The ID of the user that created the wrap-up code. |
dateCreated | string | No | — | Date when the wrap-up code was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
dateModified | string | No | — | Date when the wrap-up code was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
description | string | No | — | The wrap-up code description. |
division | object | No | — | division |
id | string | No | — | The globally unique identifier for the object. |
modifiedBy | string | No | — | The ID of the user that modified the wrap-up code. |
name | string | Yes | — | The wrap-up code name. |
selfUri | string | No | — | The URI for this object |
genesys_routing_put_directroutingbackup_settings_me
Update the user’s Direct Routing Backup settings. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agentWaitSeconds | integer | No | — | Time (in seconds) that a Direct Routing interaction will wait for Direct Routing agent before going to selected backup. Valid range [60, 864000]. |
backedUpUsers | any[] | No | — | Set of users that this user is a backup for. |
queueId | string | No | — | ID of queue to be used as backup. If queueId and userId are both specified, queue behaves as secondary backup. |
userId | string | No | — | ID of user to be used as backup. If queueId and userId are both specified, user behaves as primary backup. |
waitForAgent | boolean | No | — | Flag indicating if Direct Routing interactions should wait for Direct Routing agent or go immediately to selected backup. |
genesys_routing_put_message_recipient
Update a recipient Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
recipientId | string | Yes | — | Recipient ID |
flow | object | No | — | flow |
genesys_routing_put_queue
Update a queue Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | Queue ID |
acwSettings | object | No | — | acwSettings |
agentOwnedRouting | object | No | — | agentOwnedRouting |
autoAnswerOnly | boolean | No | — | Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered. |
bullseye | object | No | — | bullseye |
callingPartyName | string | No | — | The name to use for caller identification for outbound calls from this queue. |
callingPartyNumber | string | No | — | The phone number to use for caller identification for outbound calls from this queue. |
cannedResponseLibraries | object | No | — | cannedResponseLibraries |
conditionalGroupActivation | object | No | — | conditionalGroupActivation |
conditionalGroupRouting | object | No | — | conditionalGroupRouting |
createdBy | string | No | — | The ID of the user that created the queue. |
dateCreated | string | No | — | The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
dateModified | string | No | — | The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
defaultScripts | object | No | — | The default script Ids for the communication types. |
description | string | No | — | The queue description. |
directRouting | object | No | — | directRouting |
division | object | No | — | division |
emailInQueueFlow | object | No | — | emailInQueueFlow |
enableAudioMonitoring | boolean | No | — | Indicates whether audio monitoring is enabled for this queue. |
enableManualAssignment | boolean | No | — | Indicates whether manual assignment is enabled for this queue. |
enableTranscription | boolean | No | — | Indicates whether voice transcription is enabled for this queue. |
id | string | No | — | The globally unique identifier for the object. |
joinedMemberCount | integer | No | — | The number of joined members in the queue. |
lastAgentRoutingMode | string | No | — | The Last Agent Routing Mode for the queue. |
mediaSettings | object | No | — | mediaSettings |
memberCount | integer | No | — | The total number of members in the queue. |
memberGroups | any[] | No | — | The groups of agents associated with the queue, if any. Queue membership will update to match group membership changes. |
messageInQueueFlow | object | No | — | messageInQueueFlow |
modifiedBy | string | No | — | The ID of the user that last modified the queue. |
name | string | Yes | — | The queue name |
onHoldPrompt | object | No | — | onHoldPrompt |
outboundEmailAddress | object | No | — | outboundEmailAddress |
outboundMessagingAddresses | object | No | — | outboundMessagingAddresses |
peerId | string | No | — | The ID of an associated external queue. |
queueFlow | object | No | — | queueFlow |
routingRules | any[] | No | — | The routing rules for the queue, used for Preferred Agent Routing. |
scoringMethod | string | No | — | The Scoring Method for the queue. |
selfUri | string | No | — | The URI for this object |
skillEvaluationMethod | string | No | — | The skill evaluation method to use when routing conversations. |
suppressInQueueCallRecording | boolean | No | — | Indicates whether recording in-queue calls is suppressed for this queue. |
userMemberCount | integer | No | — | The number of user members (i.e., non-group members) in the queue. |
whisperPrompt | object | No | — | whisperPrompt |
genesys_routing_put_settings
Update an organization’s routing settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
resetAgentScoreOnPresenceChange | boolean | No | — | Reset agent score when agent presence changes from off-queue to on-queue |
genesys_routing_put_settings_transcription
Update Transcription Settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contentSearchEnabled | boolean | No | — | Setting to enable/disable content search |
lowLatencyTranscriptionEnabled | boolean | No | — | Boolean flag indicating whether low latency transcription via Notification API is enabled |
pciDssRedactionEnabled | boolean | No | — | Setting to enable/disable PCI DSS Redaction |
piiRedactionEnabled | boolean | No | — | Setting to enable/disable PII Redaction |
transcription | string | Yes | — | Setting to enable/disable transcription capability |
transcriptionConfidenceThreshold | integer | Yes | — | Configure confidence threshold. The possible values are from 1 to 100. |
genesys_routing_put_user_directroutingbackup_settings
Update the user’s Direct Routing Backup settings. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
agentWaitSeconds | integer | No | — | Time (in seconds) that a Direct Routing interaction will wait for Direct Routing agent before going to selected backup. Valid range [60, 864000]. |
backedUpUsers | any[] | No | — | Set of users that this user is a backup for. |
queueId | string | No | — | ID of queue to be used as backup. If queueId and userId are both specified, queue behaves as secondary backup. |
waitForAgent | boolean | No | — | Flag indicating if Direct Routing interactions should wait for Direct Routing agent or go immediately to selected backup. |
genesys_routing_put_user_routingskill
Update an assigned routing skill’s proficiency Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
skillId | string | Yes | — | skillId |
id | string | No | — | The globally unique identifier for the object. |
name | string | No | — | name |
proficiency | number | No | — | A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When “Best available skills” is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings. |
selfUri | string | No | — | The URI for this object |
skillUri | string | No | — | URI to the organization skill used by this user skill. |
state | string | No | — | Activate or deactivate this routing skill. |
genesys_routing_put_user_utilization
Update the user’s max utilization settings. Include only those media types requiring custom configuration. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
labelUtilizations | object | No | — | Map of label ids to utilization settings. |
utilization | object | No | — | Map of media type to utilization settings. |
genesys_routing_put_utilization
Update the organization-wide max utilization settings. Include only those media types requiring custom configuration. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
labelUtilizations | object | No | — | Map of label ids to utilization settings. |
utilization | object | No | — | Map of media type to utilization settings. |
genesys_routing_put_utilization_label
Update a utilization label Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
labelId | string | Yes | — | Utilization Label ID |
name | string | Yes | — | The utilization label name. |
genesys_routing_put_wrapupcode
Update wrap-up code Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
codeId | string | Yes | — | Wrapup Code ID |
createdBy | string | No | — | The ID of the user that created the wrap-up code. |
dateCreated | string | No | — | Date when the wrap-up code was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
dateModified | string | No | — | Date when the wrap-up code was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
description | string | No | — | The wrap-up code description. |
division | object | No | — | division |
id | string | No | — | The globally unique identifier for the object. |
modifiedBy | string | No | — | The ID of the user that modified the wrap-up code. |
name | string | Yes | — | The wrap-up code name. |
selfUri | string | No | — | The URI for this object |

