Skip to main content
Server path: /genesys-routing | Type: Application | PCID required: Yes

Tools

ToolDescription
genesys_routing_delete_directroutingbackup_settings_meDelete the user’s Direct Routing Backup settings and revert to the Direct Routing Queue default.
genesys_routing_delete_languageDelete a routing language
genesys_routing_delete_queueDelete a queue
genesys_routing_delete_queue_memberDelete a queue member.
genesys_routing_delete_queue_wrapupcodeDelete a wrap-up code from a queue
genesys_routing_delete_settingsDelete an organization’s routing settings
genesys_routing_delete_skillDelete Routing Skill
genesys_routing_delete_skillgroupRemove skill group definition
genesys_routing_delete_user_directroutingbackup_settingsDelete the user’s Direct Routing Backup settings and revert to the Direct Routing Queue default.
genesys_routing_delete_user_routinglanguageRemove a routing language from a user
genesys_routing_delete_user_routingskillRemove a routing skill from a user
genesys_routing_delete_user_utilizationDelete the user’s max utilization settings and revert to the organization-wide default.
genesys_routing_delete_utilizationDelete the organization-wide max utilization settings and revert to the system default.
genesys_routing_delete_utilization_labelDelete a utilization label
genesys_routing_delete_wrapupcodeDelete wrap-up code
genesys_routing_get_availablemediatypesGet available media types
genesys_routing_get_directroutingbackup_settings_meGet the user’s Direct Routing Backup settings.
genesys_routing_get_languageGet a routing language
genesys_routing_get_languagesGet the list of supported languages.
genesys_routing_get_message_recipientGet a recipient
genesys_routing_get_message_recipientsGet recipients
genesys_routing_get_queueGet details about this queue.
genesys_routing_get_queue_assistantGet an assistant associated with a queue.
genesys_routing_get_queue_comparisonperiodGet a Comparison Period.
genesys_routing_get_queue_comparisonperiodsGet list of comparison periods
genesys_routing_get_queue_estimatedwaittimeGet Estimated Wait Time
genesys_routing_get_queue_mediatype_estimatedwaittimeGet Estimated Wait Time
genesys_routing_get_queue_membersGet the members of this queue.
genesys_routing_get_queue_wrapupcodesGet the wrap-up codes for a queue
genesys_routing_get_queuesGet list of queues.
genesys_routing_get_queues_meGet a paged listing of queues the user is a member of.
genesys_routing_get_routing_availablemediatypesGet available media types
genesys_routing_get_routing_languageGet a routing language
genesys_routing_get_routing_languagesGet the list of supported languages.
genesys_routing_get_routing_queueGet details about this queue.
genesys_routing_get_routing_queue_estimatedwaittimeGet Estimated Wait Time
genesys_routing_get_routing_queue_membersGet the members of this queue.
genesys_routing_get_routing_queue_wrapupcodesGet the wrap-up codes for a queue
genesys_routing_get_routing_queuesGet list of queues.
genesys_routing_get_routing_queues_meGet a paged listing of queues the user is a member of.
genesys_routing_get_routing_skillGet Routing Skill
genesys_routing_get_routing_skillsGet the list of routing skills.
genesys_routing_get_routing_utilizationGet the organization-wide max utilization settings.
genesys_routing_get_routing_wrapupcodeGet details about this wrap-up code.
genesys_routing_get_routing_wrapupcodesGet list of wrapup codes.
genesys_routing_get_settingsGet an organization’s routing settings
genesys_routing_get_settings_contactcenterGet Contact Center Settings
genesys_routing_get_settings_transcriptionGet Transcription Settings
genesys_routing_get_skillGet Routing Skill
genesys_routing_get_skillgroupGet skill group
genesys_routing_get_skillgroup_membersGet skill group members
genesys_routing_get_skillgroup_members_divisionsGet list of member divisions for this skill group.
genesys_routing_get_skillgroupsGet skill group listing
genesys_routing_get_skillsGet the list of routing skills.
genesys_routing_get_user_directroutingbackup_settingsGet the user’s Direct Routing Backup settings.
genesys_routing_get_user_queuesGet queues for user
genesys_routing_get_user_routinglanguagesList routing languages assigned to a user
genesys_routing_get_user_routingskillsList routing skills assigned to a user
genesys_routing_get_user_skillgroupsGet skill groups for a user
genesys_routing_get_user_utilizationGet the user’s max utilization settings. If not configured, the organization-wide default is returned.
genesys_routing_get_utilizationGet the organization-wide max utilization settings.
genesys_routing_get_utilization_labelGet details about this utilization label
genesys_routing_get_utilization_label_agentsGet list of agent ids associated with a utilization label
genesys_routing_get_utilization_labelsGet list of utilization labels
genesys_routing_get_wrapupcodeGet details about this wrap-up code.
genesys_routing_get_wrapupcodesGet list of wrapup codes.
genesys_routing_patch_conversationUpdate attributes of an in-queue conversation
genesys_routing_patch_queue_memberUpdate the ring number OR joined status for a queue member.
genesys_routing_patch_queue_membersJoin or unjoin a set of up to 100 users for a queue
genesys_routing_patch_settings_contactcenterUpdate Contact Center Settings
genesys_routing_patch_settings_transcriptionPatch Transcription Settings
genesys_routing_patch_skillUpdate Routing Skill Division
genesys_routing_patch_skillgroupUpdate skill group definition
genesys_routing_patch_user_queueJoin or unjoin a queue for a user
genesys_routing_patch_user_queuesJoin or unjoin a set of queues for a user
genesys_routing_patch_user_routinglanguageUpdate an assigned routing language’s proficiency
genesys_routing_post_analytics_queues_observations_queryQuery for queue observations
genesys_routing_post_languagesCreate Language
genesys_routing_post_queue_membersBulk add or delete up to 100 queue members
genesys_routing_post_queue_wrapupcodesAdd up to 100 wrap-up codes to a queue
genesys_routing_post_queuesCreate a queue
genesys_routing_post_skillgroup_members_divisionsAdd or remove member divisions for this skill group.
genesys_routing_post_skillgroupsCreate a skill group
genesys_routing_post_skillsCreate Skill
genesys_routing_post_user_routinglanguagesAssign a routing language to a user
genesys_routing_post_user_routingskillsAssign a routing skill to a user
genesys_routing_post_utilization_labelsCreate a utilization label
genesys_routing_post_wrapupcodesCreate a wrap-up code
genesys_routing_put_directroutingbackup_settings_meUpdate the user’s Direct Routing Backup settings.
genesys_routing_put_message_recipientUpdate a recipient
genesys_routing_put_queueUpdate a queue
genesys_routing_put_settingsUpdate an organization’s routing settings
genesys_routing_put_settings_transcriptionUpdate Transcription Settings
genesys_routing_put_user_directroutingbackup_settingsUpdate the user’s Direct Routing Backup settings.
genesys_routing_put_user_routingskillUpdate an assigned routing skill’s proficiency
genesys_routing_put_user_utilizationUpdate the user’s max utilization settings. Include only those media types requiring custom configuration.
genesys_routing_put_utilizationUpdate the organization-wide max utilization settings. Include only those media types requiring custom configuration.
genesys_routing_put_utilization_labelUpdate a utilization label
genesys_routing_put_wrapupcodeUpdate wrap-up code

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:
ParameterTypeRequiredDefaultDescription
languageIdstringYesLanguage ID

genesys_routing_delete_queue

Delete a queue Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesQueue ID
forceDeletebooleanNoforceDelete

genesys_routing_delete_queue_member

Delete a queue member. Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesQueue ID
memberIdstringYesMember ID

genesys_routing_delete_queue_wrapupcode

Delete a wrap-up code from a queue Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesQueue ID
codeIdstringYesCode ID

genesys_routing_delete_settings

Delete an organization’s routing settings

genesys_routing_delete_skill

Delete Routing Skill Parameters:
ParameterTypeRequiredDefaultDescription
skillIdstringYesSkill ID

genesys_routing_delete_skillgroup

Remove skill group definition Parameters:
ParameterTypeRequiredDefaultDescription
skillGroupIdstringYesSkill 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:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID

genesys_routing_delete_user_routinglanguage

Remove a routing language from a user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID
languageIdstringYeslanguageId

genesys_routing_delete_user_routingskill

Remove a routing skill from a user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID
skillIdstringYesskillId

genesys_routing_delete_user_utilization

Delete the user’s max utilization settings and revert to the organization-wide default. Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser 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:
ParameterTypeRequiredDefaultDescription
labelIdstringYesUtilization Label ID
forceDeletebooleanNoRemove all label usages (if found) without warning

genesys_routing_delete_wrapupcode

Delete wrap-up code Parameters:
ParameterTypeRequiredDefaultDescription
codeIdstringYesWrapup Code ID

genesys_routing_get_availablemediatypes

Get available media types

genesys_routing_get_directroutingbackup_settings_me

Get the user’s Direct Routing Backup settings.

genesys_routing_get_language

Get a routing language Parameters:
ParameterTypeRequiredDefaultDescription
languageIdstringYesLanguage ID

genesys_routing_get_languages

Get the list of supported languages. Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoPage size
pageNumberintegerNoPage number
sortOrderstringNoAscending or descending sort order
namestringNoName
idany[]Noid

genesys_routing_get_message_recipient

Get a recipient Parameters:
ParameterTypeRequiredDefaultDescription
recipientIdstringYesRecipient ID

genesys_routing_get_message_recipients

Get recipients Parameters:
ParameterTypeRequiredDefaultDescription
messengerTypestringNoMessenger Type
namestringNoRecipient Name
pageSizeintegerNoPage size
pageNumberintegerNoPage number

genesys_routing_get_queue

Get details about this queue. Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesQueue ID
expandany[]NoWhich fields, if any, to expand

genesys_routing_get_queue_assistant

Get an assistant associated with a queue. Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesQueue ID
expandany[]NoWhich fields, if any, to expand.
languageVariationstringNoLanguage variation
fallbackToPrimaryAssistantbooleanNoFall back to primary assistant if specified variation is not found

genesys_routing_get_queue_comparisonperiod

Get a Comparison Period. Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesQueue id
comparisonPeriodIdstringYesComparisonPeriod id

genesys_routing_get_queue_comparisonperiods

Get list of comparison periods Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesQueue id

genesys_routing_get_queue_estimatedwaittime

Get Estimated Wait Time Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesqueueId
conversationIdstringNoconversationId

genesys_routing_get_queue_mediatype_estimatedwaittime

Get Estimated Wait Time Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesqueueId
mediaTypestringYesmediaType
labelIdstringNoUnique 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:
ParameterTypeRequiredDefaultDescription
queueIdstringYesQueue ID
pageNumberintegerNopageNumber
pageSizeintegerNoMax value is 100
sortOrderstringNoNote: results are sorted by name.
expandany[]NoWhich fields, if any, to expand.
namestringNoFilter by queue member name (contains-style search)
profileSkillsany[]NoFilter by profile skill (contains-style search)
skillsany[]NoFilter by skill (contains-style search)
languagesany[]NoFilter by language (contains-style search)
routingStatusany[]NoFilter by routing status
presenceany[]NoFilter by presence
memberBystringNoFilter by member type
joinedbooleanNoFilter by joined status

genesys_routing_get_queue_wrapupcodes

Get the wrap-up codes for a queue Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesQueue ID
pageSizeintegerNoPage size
pageNumberintegerNoPage number
namestringNoWrapup code’s name (trailing asterisks allowed)

genesys_routing_get_queues

Get list of queues. Parameters:
ParameterTypeRequiredDefaultDescription
pageNumberintegerNoPage number
pageSizeintegerNoPage size
sortOrderstringNoNote: results are sorted by name.
namestringNoInclude only queues with the given name (leading and trailing asterisks allowed)
idany[]NoInclude only queues with the specified ID(s)
divisionIdany[]NoInclude only queues in the specified division ID(s)
peerIdany[]NoInclude only queues with the specified peer ID(s)
cannedResponseLibraryIdstringNoInclude only queues explicitly associated with the specified canned response library ID
hasPeerbooleanNoInclude only queues with a peer ID
expandany[]NoWhich fields, if any, to expand

genesys_routing_get_queues_me

Get a paged listing of queues the user is a member of. Parameters:
ParameterTypeRequiredDefaultDescription
pageNumberintegerNoPage number
pageSizeintegerNoPage size
joinedbooleanNoFilter by joined status.
sortOrderstringNoNote: results are sorted by name.

genesys_routing_get_routing_availablemediatypes

Get available media types

genesys_routing_get_routing_language

Get a routing language Parameters:
ParameterTypeRequiredDefaultDescription
languageIdstringYesLanguage ID

genesys_routing_get_routing_languages

Get the list of supported languages. Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoPage size
pageNumberintegerNoPage number
sortOrderstringNoAscending or descending sort order
namestringNoName
idany[]Noid

genesys_routing_get_routing_queue

Get details about this queue. Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesQueue ID
expandany[]NoWhich fields, if any, to expand

genesys_routing_get_routing_queue_estimatedwaittime

Get Estimated Wait Time Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesqueueId
conversationIdstringNoconversationId

genesys_routing_get_routing_queue_members

Get the members of this queue. Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesQueue ID
pageNumberintegerNopageNumber
pageSizeintegerNoMax value is 100
sortOrderstringNoNote: results are sorted by name.
expandany[]NoWhich fields, if any, to expand.
namestringNoFilter by queue member name (contains-style search)
profileSkillsany[]NoFilter by profile skill (contains-style search)
skillsany[]NoFilter by skill (contains-style search)
languagesany[]NoFilter by language (contains-style search)
routingStatusany[]NoFilter by routing status
presenceany[]NoFilter by presence
memberBystringNoFilter by member type
joinedbooleanNoFilter by joined status

genesys_routing_get_routing_queue_wrapupcodes

Get the wrap-up codes for a queue Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesQueue ID
pageSizeintegerNoPage size
pageNumberintegerNoPage number
namestringNoWrapup code’s name (trailing asterisks allowed)

genesys_routing_get_routing_queues

Get list of queues. Parameters:
ParameterTypeRequiredDefaultDescription
pageNumberintegerNoPage number
pageSizeintegerNoPage size
sortOrderstringNoNote: results are sorted by name.
namestringNoInclude only queues with the given name (leading and trailing asterisks allowed)
idany[]NoInclude only queues with the specified ID(s)
divisionIdany[]NoInclude only queues in the specified division ID(s)
peerIdany[]NoInclude only queues with the specified peer ID(s)
cannedResponseLibraryIdstringNoInclude only queues explicitly associated with the specified canned response library ID
hasPeerbooleanNoInclude only queues with a peer ID
expandany[]NoWhich fields, if any, to expand

genesys_routing_get_routing_queues_me

Get a paged listing of queues the user is a member of. Parameters:
ParameterTypeRequiredDefaultDescription
pageNumberintegerNoPage number
pageSizeintegerNoPage size
joinedbooleanNoFilter by joined status.
sortOrderstringNoNote: results are sorted by name.

genesys_routing_get_routing_skill

Get Routing Skill Parameters:
ParameterTypeRequiredDefaultDescription
skillIdstringYesSkill ID

genesys_routing_get_routing_skills

Get the list of routing skills. Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoPage size
pageNumberintegerNoPage number
namestringNoFilter for results that start with this value
idany[]Noid

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:
ParameterTypeRequiredDefaultDescription
codeIdstringYesWrapup Code ID

genesys_routing_get_routing_wrapupcodes

Get list of wrapup codes. Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoPage size
pageNumberintegerNoPage number
sortBystringNoSort by
sortOrderstringNoSort order
namestringNoWrapup code’s name (‘Sort by’ param is ignored unless this field is provided)
idany[]NoFilter by wrapup code ID(s)
divisionIdany[]NoFilter by division ID(s)

genesys_routing_get_settings

Get an organization’s routing settings

genesys_routing_get_settings_contactcenter

Get Contact Center Settings

genesys_routing_get_settings_transcription

Get Transcription Settings

genesys_routing_get_skill

Get Routing Skill Parameters:
ParameterTypeRequiredDefaultDescription
skillIdstringYesSkill ID

genesys_routing_get_skillgroup

Get skill group Parameters:
ParameterTypeRequiredDefaultDescription
skillGroupIdstringYesSkill Group ID

genesys_routing_get_skillgroup_members

Get skill group members Parameters:
ParameterTypeRequiredDefaultDescription
skillGroupIdstringYesSkill Group ID
pageSizeintegerNoPage size
afterstringNoThe cursor that points to the next item
beforestringNoThe cursor that points to the previous item
expandstringNoExpand the name on each user

genesys_routing_get_skillgroup_members_divisions

Get list of member divisions for this skill group. Parameters:
ParameterTypeRequiredDefaultDescription
skillGroupIdstringYesSkill Group ID
expandstringNoExpand the name on each user

genesys_routing_get_skillgroups

Get skill group listing Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoPage size
namestringNoReturn only skill group names whose names start with this value (case-insensitive matching)
afterstringNoThe cursor that points to the next item
beforestringNoThe cursor that points to the previous item

genesys_routing_get_skills

Get the list of routing skills. Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoPage size
pageNumberintegerNoPage number
namestringNoFilter for results that start with this value
idany[]Noid

genesys_routing_get_user_directroutingbackup_settings

Get the user’s Direct Routing Backup settings. Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID

genesys_routing_get_user_queues

Get queues for user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID
pageSizeintegerNoPage size
pageNumberintegerNoPage number
joinedbooleanNoIs joined to the queue
divisionIdany[]NoDivision ID(s)

genesys_routing_get_user_routinglanguages

List routing languages assigned to a user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID
pageSizeintegerNoPage size
pageNumberintegerNoPage number
sortOrderstringNoAscending or descending sort order

genesys_routing_get_user_routingskills

List routing skills assigned to a user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID
pageSizeintegerNoPage size
pageNumberintegerNoPage number
sortOrderstringNoAscending or descending sort order

genesys_routing_get_user_skillgroups

Get skill groups for a user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID
pageSizeintegerNoPage size
afterstringNoThe cursor that points to the next page
beforestringNoThe 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:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID

genesys_routing_get_utilization

Get the organization-wide max utilization settings.

genesys_routing_get_utilization_label

Get details about this utilization label Parameters:
ParameterTypeRequiredDefaultDescription
labelIdstringYesUtilization Label ID

genesys_routing_get_utilization_label_agents

Get list of agent ids associated with a utilization label Parameters:
ParameterTypeRequiredDefaultDescription
labelIdstringYesUtilization Label ID

genesys_routing_get_utilization_labels

Get list of utilization labels Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoPage size
pageNumberintegerNoPage number
sortOrderstringNoSort order by name
namestringNoUtilization label’s name (Wildcard is supported, e.g., ‘label1*’, ‘label

genesys_routing_get_wrapupcode

Get details about this wrap-up code. Parameters:
ParameterTypeRequiredDefaultDescription
codeIdstringYesWrapup Code ID

genesys_routing_get_wrapupcodes

Get list of wrapup codes. Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoPage size
pageNumberintegerNoPage number
sortBystringNoSort by
sortOrderstringNoSort order
namestringNoWrapup code’s name (‘Sort by’ param is ignored unless this field is provided)
idany[]NoFilter by wrapup code ID(s)
divisionIdany[]NoFilter by division ID(s)

genesys_routing_patch_conversation

Update attributes of an in-queue conversation Parameters:
ParameterTypeRequiredDefaultDescription
conversationIdstringYesConversation ID
labelIdstringNoLabel requirement for the conversation. To remove the label requirement (setting it to System Default Label), specify an empty string, i.e., "".
languageIdstringNoLanguage requirement for the conversation. To remove the language requirement, specify an empty string, i.e., "".
priorityintegerNoPriority for the conversation. Each point of priority is equivalent to one minute of time in queue. Range:[-25000000, 25000000]. To reset, specify 0.
requestScoredAgentsany[]NorequestScoredAgents
skillIdsany[]NoSkill 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:
ParameterTypeRequiredDefaultDescription
queueIdstringYesQueue ID
memberIdstringYesMember ID
idstringNoThe queue member’s id.
joinedbooleanNojoined
memberBystringNomemberBy
namestringNoname
ringNumberintegerNoringNumber
routingStatusobjectNoroutingStatus
selfUristringNoThe URI for this object
userobjectNouser

genesys_routing_patch_queue_members

Join or unjoin a set of up to 100 users for a queue Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesQueue ID
bodyany[]YesQueue Members

genesys_routing_patch_settings_contactcenter

Update Contact Center Settings Parameters:
ParameterTypeRequiredDefaultDescription
removeSkillsFromBlindTransferbooleanNoStrip skills from transfer

genesys_routing_patch_settings_transcription

Patch Transcription Settings Parameters:
ParameterTypeRequiredDefaultDescription
contentSearchEnabledbooleanNoSetting to enable/disable content search
lowLatencyTranscriptionEnabledbooleanNoBoolean flag indicating whether low latency transcription via Notification API is enabled
pciDssRedactionEnabledbooleanNoSetting to enable/disable PCI DSS Redaction
piiRedactionEnabledbooleanNoSetting to enable/disable PII Redaction
transcriptionstringYesSetting to enable/disable transcription capability
transcriptionConfidenceThresholdintegerYesConfigure confidence threshold. The possible values are from 1 to 100.

genesys_routing_patch_skill

Update Routing Skill Division Parameters:
ParameterTypeRequiredDefaultDescription
skillIdstringYesSkill ID
divisionIdstringNoThe division to which this skill will belong

genesys_routing_patch_skillgroup

Update skill group definition Parameters:
ParameterTypeRequiredDefaultDescription
skillGroupIdstringYesSkill Group ID
dateCreatedstringNoCreated date/time of the skill group. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
dateModifiedstringNoLast 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
descriptionstringNoGroup description
divisionobjectNodivision
idstringNoThe globally unique identifier for the object.
memberCountintegerNoEstimated number of members in this group. It can take some time for the count to be updated after expressions are changed.
namestringYesThe group name.
selfUristringNoThe URI for this object
skillConditionsany[]YesConditions for this group
statusstringNoGroup’s filling status

genesys_routing_patch_user_queue

Join or unjoin a queue for a user Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesQueue ID
userIdstringYesUser ID
acwSettingsobjectNoacwSettings
agentOwnedRoutingobjectNoagentOwnedRouting
bullseyeobjectNobullseye
callingPartyNamestringNoThe name to use for caller identification for outbound calls from this queue.
callingPartyNumberstringNoThe phone number to use for caller identification for outbound calls from this queue.
cannedResponseLibrariesobjectNocannedResponseLibraries
conditionalGroupActivationobjectNoconditionalGroupActivation
conditionalGroupRoutingobjectNoconditionalGroupRouting
createdBystringNoThe ID of the user that created the queue.
dateCreatedstringNoThe date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
dateModifiedstringNoThe 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
defaultScriptsobjectNoThe default script Ids for the communication types.
descriptionstringNoThe queue description.
directRoutingobjectNodirectRouting
divisionobjectNodivision
emailInQueueFlowobjectNoemailInQueueFlow
enableAudioMonitoringbooleanNoIndicates whether audio monitoring is enabled for this queue.
enableManualAssignmentbooleanNoIndicates whether manual assignment is enabled for this queue.
enableTranscriptionbooleanNoIndicates whether voice transcription is enabled for this queue.
idstringNoThe globally unique identifier for the object.
joinedbooleanNojoined
joinedMemberCountintegerNoThe number of joined members in the queue.
lastAgentRoutingModestringNoThe Last Agent Routing Mode for the queue.
mediaSettingsobjectNomediaSettings
memberCountintegerNoThe total number of members in the queue.
memberGroupsany[]NoThe groups of agents associated with the queue, if any. Queue membership will update to match group membership changes.
messageInQueueFlowobjectNomessageInQueueFlow
modifiedBystringNoThe ID of the user that last modified the queue.
namestringNoname
onHoldPromptobjectNoonHoldPrompt
outboundEmailAddressobjectNooutboundEmailAddress
outboundMessagingAddressesobjectNooutboundMessagingAddresses
peerIdstringNoThe ID of an associated external queue.
queueFlowobjectNoqueueFlow
routingRulesany[]NoThe routing rules for the queue, used for Preferred Agent Routing.
scoringMethodstringNoThe Scoring Method for the queue.
selfUristringNoThe URI for this object
skillEvaluationMethodstringNoThe skill evaluation method to use when routing conversations.
suppressInQueueCallRecordingbooleanNoIndicates whether recording in-queue calls is suppressed for this queue.
userMemberCountintegerNoThe number of user members (i.e., non-group members) in the queue.
whisperPromptobjectNowhisperPrompt

genesys_routing_patch_user_queues

Join or unjoin a set of queues for a user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID
divisionIdany[]NoDivision ID(s)
bodyany[]YesUser Queues

genesys_routing_patch_user_routinglanguage

Update an assigned routing language’s proficiency Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID
languageIdstringYeslanguageId
idstringNoThe globally unique identifier for the object.
languageUristringNoURI to the organization language used by this user language.
namestringNoname
proficiencynumberNoA 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.
selfUristringNoThe URI for this object
statestringNoActivate or deactivate this routing language.

genesys_routing_post_analytics_queues_observations_query

Query for queue observations Parameters:
ParameterTypeRequiredDefaultDescription
detailMetricsany[]NoMetrics for which to include additional detailed observations
filterobjectYesfilter
metricsany[]YesBehaves like a SQL SELECT clause. Only named metrics will be retrieved.

genesys_routing_post_languages

Create Language Parameters:
ParameterTypeRequiredDefaultDescription
dateModifiedstringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
idstringNoThe globally unique identifier for the object.
namestringYesThe language name.
selfUristringNoThe URI for this object
statestringNostate
versionstringNoversion

genesys_routing_post_queue_members

Bulk add or delete up to 100 queue members Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesQueue ID
deletebooleanNoTrue to delete queue members
bodyany[]YesQueue Members

genesys_routing_post_queue_wrapupcodes

Add up to 100 wrap-up codes to a queue Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesQueue ID
bodyany[]YesList of wrapup codes

genesys_routing_post_queues

Create a queue Parameters:
ParameterTypeRequiredDefaultDescription
acwSettingsobjectNoacwSettings
agentOwnedRoutingobjectNoagentOwnedRouting
autoAnswerOnlybooleanNoSpecifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered.
bullseyeobjectNobullseye
callingPartyNamestringNoThe name to use for caller identification for outbound calls from this queue.
callingPartyNumberstringNoThe phone number to use for caller identification for outbound calls from this queue.
cannedResponseLibrariesobjectNocannedResponseLibraries
conditionalGroupActivationobjectNoconditionalGroupActivation
conditionalGroupRoutingobjectNoconditionalGroupRouting
createdBystringNoThe ID of the user that created the queue.
dateCreatedstringNoThe date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
dateModifiedstringNoThe 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
defaultScriptsobjectNoThe default script Ids for the communication types.
descriptionstringNoThe queue description.
directRoutingobjectNodirectRouting
divisionobjectNodivision
emailInQueueFlowobjectNoemailInQueueFlow
enableAudioMonitoringbooleanNoIndicates whether audio monitoring is enabled for this queue.
enableManualAssignmentbooleanNoIndicates whether manual assignment is enabled for this queue.
enableTranscriptionbooleanNoIndicates whether voice transcription is enabled for this queue.
idstringNoThe globally unique identifier for the object.
joinedMemberCountintegerNoThe number of joined members in the queue.
lastAgentRoutingModestringNoThe Last Agent Routing Mode for the queue.
mediaSettingsobjectNomediaSettings
memberCountintegerNoThe total number of members in the queue.
memberGroupsany[]NoThe groups of agents associated with the queue, if any. Queue membership will update to match group membership changes.
messageInQueueFlowobjectNomessageInQueueFlow
modifiedBystringNoThe ID of the user that last modified the queue.
namestringYesThe queue name
onHoldPromptobjectNoonHoldPrompt
outboundEmailAddressobjectNooutboundEmailAddress
outboundMessagingAddressesobjectNooutboundMessagingAddresses
peerIdstringNoThe ID of an associated external queue.
queueFlowobjectNoqueueFlow
routingRulesany[]NoThe routing rules for the queue, used for Preferred Agent Routing.
scoringMethodstringNoThe Scoring Method for the queue.
selfUristringNoThe URI for this object
skillEvaluationMethodstringNoThe skill evaluation method to use when routing conversations.
sourceQueueIdstringNoThe id of an existing queue to copy the settings (does not include GPR settings) from when creating a new queue.
suppressInQueueCallRecordingbooleanNoIndicates whether recording in-queue calls is suppressed for this queue.
userMemberCountintegerNoThe number of user members (i.e., non-group members) in the queue.
whisperPromptobjectNowhisperPrompt

genesys_routing_post_skillgroup_members_divisions

Add or remove member divisions for this skill group. Parameters:
ParameterTypeRequiredDefaultDescription
skillGroupIdstringYesSkill Group ID
addDivisionIdsany[]NoaddDivisionIds
removeDivisionIdsany[]NoremoveDivisionIds

genesys_routing_post_skillgroups

Create a skill group Parameters:
ParameterTypeRequiredDefaultDescription
dateCreatedstringNoCreated date/time of the skill group. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
dateModifiedstringNoLast 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
descriptionstringNoGroup description
divisionobjectNodivision
idstringNoThe globally unique identifier for the object.
memberCountintegerNoEstimated number of members in this group. It can take some time for the count to be updated after expressions are changed.
memberDivisionsany[]NoMember divisions for this skill group
namestringYesThe group name.
selfUristringNoThe URI for this object
skillConditionsany[]YesConditions for this group
statusstringNoGroup’s filling status

genesys_routing_post_skills

Create Skill Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe name of the skill.

genesys_routing_post_user_routinglanguages

Assign a routing language to a user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID
idstringYesThe id of the existing routing language to add to the user
languageUristringNoURI to the organization language used by this user language.
proficiencynumberYesProficiency 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.
selfUristringNoThe URI for this object

genesys_routing_post_user_routingskills

Assign a routing skill to a user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID
idstringYesThe id of the existing routing skill to add to the user
proficiencynumberYesProficiency 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.
selfUristringNoThe URI for this object
skillUristringNoURI to the organization skill used by this user skill.

genesys_routing_post_utilization_labels

Create a utilization label Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe utilization label name.
utilizationobjectNoutilization

genesys_routing_post_wrapupcodes

Create a wrap-up code Parameters:
ParameterTypeRequiredDefaultDescription
createdBystringNoThe ID of the user that created the wrap-up code.
dateCreatedstringNoDate 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
dateModifiedstringNoDate 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
descriptionstringNoThe wrap-up code description.
divisionobjectNodivision
idstringNoThe globally unique identifier for the object.
modifiedBystringNoThe ID of the user that modified the wrap-up code.
namestringYesThe wrap-up code name.
selfUristringNoThe URI for this object

genesys_routing_put_directroutingbackup_settings_me

Update the user’s Direct Routing Backup settings. Parameters:
ParameterTypeRequiredDefaultDescription
agentWaitSecondsintegerNoTime (in seconds) that a Direct Routing interaction will wait for Direct Routing agent before going to selected backup. Valid range [60, 864000].
backedUpUsersany[]NoSet of users that this user is a backup for.
queueIdstringNoID of queue to be used as backup. If queueId and userId are both specified, queue behaves as secondary backup.
userIdstringNoID of user to be used as backup. If queueId and userId are both specified, user behaves as primary backup.
waitForAgentbooleanNoFlag 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:
ParameterTypeRequiredDefaultDescription
recipientIdstringYesRecipient ID
flowobjectNoflow

genesys_routing_put_queue

Update a queue Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesQueue ID
acwSettingsobjectNoacwSettings
agentOwnedRoutingobjectNoagentOwnedRouting
autoAnswerOnlybooleanNoSpecifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered.
bullseyeobjectNobullseye
callingPartyNamestringNoThe name to use for caller identification for outbound calls from this queue.
callingPartyNumberstringNoThe phone number to use for caller identification for outbound calls from this queue.
cannedResponseLibrariesobjectNocannedResponseLibraries
conditionalGroupActivationobjectNoconditionalGroupActivation
conditionalGroupRoutingobjectNoconditionalGroupRouting
createdBystringNoThe ID of the user that created the queue.
dateCreatedstringNoThe date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
dateModifiedstringNoThe 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
defaultScriptsobjectNoThe default script Ids for the communication types.
descriptionstringNoThe queue description.
directRoutingobjectNodirectRouting
divisionobjectNodivision
emailInQueueFlowobjectNoemailInQueueFlow
enableAudioMonitoringbooleanNoIndicates whether audio monitoring is enabled for this queue.
enableManualAssignmentbooleanNoIndicates whether manual assignment is enabled for this queue.
enableTranscriptionbooleanNoIndicates whether voice transcription is enabled for this queue.
idstringNoThe globally unique identifier for the object.
joinedMemberCountintegerNoThe number of joined members in the queue.
lastAgentRoutingModestringNoThe Last Agent Routing Mode for the queue.
mediaSettingsobjectNomediaSettings
memberCountintegerNoThe total number of members in the queue.
memberGroupsany[]NoThe groups of agents associated with the queue, if any. Queue membership will update to match group membership changes.
messageInQueueFlowobjectNomessageInQueueFlow
modifiedBystringNoThe ID of the user that last modified the queue.
namestringYesThe queue name
onHoldPromptobjectNoonHoldPrompt
outboundEmailAddressobjectNooutboundEmailAddress
outboundMessagingAddressesobjectNooutboundMessagingAddresses
peerIdstringNoThe ID of an associated external queue.
queueFlowobjectNoqueueFlow
routingRulesany[]NoThe routing rules for the queue, used for Preferred Agent Routing.
scoringMethodstringNoThe Scoring Method for the queue.
selfUristringNoThe URI for this object
skillEvaluationMethodstringNoThe skill evaluation method to use when routing conversations.
suppressInQueueCallRecordingbooleanNoIndicates whether recording in-queue calls is suppressed for this queue.
userMemberCountintegerNoThe number of user members (i.e., non-group members) in the queue.
whisperPromptobjectNowhisperPrompt

genesys_routing_put_settings

Update an organization’s routing settings Parameters:
ParameterTypeRequiredDefaultDescription
resetAgentScoreOnPresenceChangebooleanNoReset agent score when agent presence changes from off-queue to on-queue

genesys_routing_put_settings_transcription

Update Transcription Settings Parameters:
ParameterTypeRequiredDefaultDescription
contentSearchEnabledbooleanNoSetting to enable/disable content search
lowLatencyTranscriptionEnabledbooleanNoBoolean flag indicating whether low latency transcription via Notification API is enabled
pciDssRedactionEnabledbooleanNoSetting to enable/disable PCI DSS Redaction
piiRedactionEnabledbooleanNoSetting to enable/disable PII Redaction
transcriptionstringYesSetting to enable/disable transcription capability
transcriptionConfidenceThresholdintegerYesConfigure 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:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID
agentWaitSecondsintegerNoTime (in seconds) that a Direct Routing interaction will wait for Direct Routing agent before going to selected backup. Valid range [60, 864000].
backedUpUsersany[]NoSet of users that this user is a backup for.
queueIdstringNoID of queue to be used as backup. If queueId and userId are both specified, queue behaves as secondary backup.
waitForAgentbooleanNoFlag 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:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID
skillIdstringYesskillId
idstringNoThe globally unique identifier for the object.
namestringNoname
proficiencynumberNoA 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.
selfUristringNoThe URI for this object
skillUristringNoURI to the organization skill used by this user skill.
statestringNoActivate 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:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID
labelUtilizationsobjectNoMap of label ids to utilization settings.
utilizationobjectNoMap 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:
ParameterTypeRequiredDefaultDescription
labelUtilizationsobjectNoMap of label ids to utilization settings.
utilizationobjectNoMap of media type to utilization settings.

genesys_routing_put_utilization_label

Update a utilization label Parameters:
ParameterTypeRequiredDefaultDescription
labelIdstringYesUtilization Label ID
namestringYesThe utilization label name.

genesys_routing_put_wrapupcode

Update wrap-up code Parameters:
ParameterTypeRequiredDefaultDescription
codeIdstringYesWrapup Code ID
createdBystringNoThe ID of the user that created the wrap-up code.
dateCreatedstringNoDate 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
dateModifiedstringNoDate 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
descriptionstringNoThe wrap-up code description.
divisionobjectNodivision
idstringNoThe globally unique identifier for the object.
modifiedBystringNoThe ID of the user that modified the wrap-up code.
namestringYesThe wrap-up code name.
selfUristringNoThe URI for this object