Section II – Functional Modules > Queue Interface > Events         Bottom of Page
Genesys 8.1
SCXML Technical Reference
< Action Elements

Events

The event namespace convention is queue.xxxx.

The following are the Queue action result events:

Event

Attributes

Description

queue.submit.done

 

This event indicates the success of the request and that a target has been selected.

requestid

This is the ID associated with the request.

targetselected

This is the DN and the switch name of the target to which the interaction was routed or should be routed to definitively; the target format is (Name@SwitchName.Type).

vqselected

This is the virtual queue that was selected.

targetcomponentselected

This is the agent-level target to which the interaction was routed or should be routed to definitively.

If the target specified in <submit> and selected for routing is of type Agent, Place, Queue, or Routing Point, this contains the target itself. If the desired target type is Agent Group, Place Group, or Queue Group, the function returns the agent, place, or queue from the corresponding group the interaction was sent to. The target format is (Name@StatServerName.Type).

targetobjectselected

This is the high-level target (one that you specify in a <submit>) to which the interaction was routed or should be routed to definitively. If a skill expression is used, the function returns: ?:SkillExpression@statserver.GA or even ?GroupName:SkillExpression@statserver.GA

The target format is (Name@StatServerName.Type).

interactionid

This is the interaction id associated with the interaction that was initiated.

resource

This is an ECMAScript resource object which represents the target selected and can be used on any interaction-related action. See the resource object for details.

queue.submit.requestid

 

This event provides the application with request ID for the given request that was invoked.

requestid

This is the ID associated with the request from the orchestration application or the resource.

error.queue.submit

 

This indicates that an abnormal condition occurred while trying to perform the request. This event will be sent as a result of a timeout of the request, as well as problems with the request or interaction itself.

requestid

This is the ID associated with the request.

error

This is the type of error that occurred.

The following are the possible values:

  • timeout
  • invalidattribute
  • abandoned
  • unknown
  • invalidstate.state (null, ringing, hold, transferring, treating, routed)
  • badtranslation
  • remote
  • failedcustomercontact
  • failedagent

description

This is a more detailed description of the error:

The following are the possible values

  • timeout — a target has not been found within the requested time period xxxx. xxxx is the value of the timeout attribute.
  • invalidattribute — The attribute yyy:xxx has an invalid value (zzz) or is not allowed under the conditions of the request. yyy is the name of the element associated with the attribute. xxx is the name of the attribute. zzz is the value of the attribute.
  • abandoned — The customer has abandoned the interaction.
  • unknown — The cause of the failure is unknown.
  • invalidstate.state — The interaction is in an invalid state and cannot be redirected to the selected target.
  • badtranslation — The destination address xxx could not be translated. xxx is the address of the target selected.
  • remote — There was an error in the media server while trying to redirect the interaction to the selected target.

queue.cancel.done

 

This event indicates the success of the clear request and that the request has been removed from the queue.

requestid

This is the ID of the <cancel> request.

error.queue.cancel

 

This indicates that an error occurred while trying to perform the <cancel> request.

requestid

This is the ID associated with the request.

error

This is the type of error that occurred.

description

This is a more detailed description of the error.

queue.update.done

 

This event indicates that the request has been updated successfully.

requestid

This is the ID of the <update> request.

error.queue.update

 

This indicates that an error occurred while trying to perform the <update> request.

requestid

This is the ID associated with the request.

error

This is the type of error that occurred. The following are the possible values:

  • Invalidrequestid

description

This is a more detailed description of the error.

The following are the possible values:

  • Invalidrequestid — The request id xxxx does not match any outstanding <submit> requests. xxxx is the value of the requestid attribute.

queue.query.done

 

This event indicates the success of the query request.

requestid

This is the ID of the <query> request.

interactionid

This is the interaction id associated with the request.

priority

This is the current priority of the request.

positioninqueue

This is the current position of the request in the queue.

invqwaittime

This is the expected wait for the queue in relationship to the request.

error.queue.query

 

This indicates that an error occurred while trying to perform the <query> request.

requestid

This is the ID associated with the request.

error

This is the type of error that occurred.

description

This is a more detailed description of the error

queue.default.done

 

This event indicates the success of the request and that a default target has been selected.

requestid

This is the ID associated with the request.

defaultselected

This is the default configured target address.

queue.default.requestid

 

This event provides the application with request ID for the given request that was invoked.

requestid

This is the ID associated with the request from the orchestration application or the resource.

error.queue.default

 

This indicates that an error occurred while trying to perform the <default> request.

requestid

This is the ID associated with the request.

error

This is the type of error that occurred:

  • timeout
  • invalidattribute
  • abandoned
  • unknown
  • invalidstate.state (null, ringing, hold, transferring, treating, routed)
  • badtranslation
  • remote

description

This is a more detailed description of the error.

The following are the possible values:

  • timeout — the interaction was not redirected to the default target in a timely manner.
  • invalidattribute — The attribute yyy:xxx has an invalid value (zzz) or is not allowed under the conditions of the request. yyy is the name of the element associated with the attribute. xxx is the name of the attribute. zzz is the value of the attribute.
  • abandoned — The customer has abandoned the interaction.
  • unknown — The cause of the failure is unknown.
  • invalidstate.state — The interaction is in an invalid state and cannot be redirected to the default target.
  • badtranslation — The destination address xxx could not be translated. xxx is the address of the default target.
  • remote — There was an error in the media server while trying to redirect the interaction to the default target.

queue.getremoteaddress.requestid

 

This event provides the application with request ID for the given request that was invoked.

requestid

This is the ID associated with the request from the orchestration application or the resource.

The following are the queue asynchronous events:

Event

Attributes

Description

queue.cancelled

This event indicates that a target has been selected from another <submit> action request and that this <submit> action request has been cancelled.

requestid

This is the submit request ID associated with the interaction.




Section II – Functional Modules > Queue Interface > Events         Top of Page
Genesys 8.1
SCXML Technical Reference
< Action Elements