Section II – Functional Modules > Dialog (Treatment) Interface > Events         Bottom of Page
Genesys 8.1
SCXML Technical Reference
< Action Elements

Events

The following are the event namespaces or conventions:

Event naming convention — dialog.xxxx

The following are the dialog action result events.

Event

Attributes

Description

dialog.start.done

 

This event indicates the successful completion of the starting of an application. This can be sent in conjunction with the <start> action or asynchronously to indicate the completion of an application started at the resource.

requestid

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

dialog.start.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.dialog.start

 

This indicates that an abnormal condition occurred while trying to perform the start request. This event will be sent as a result of a timeout of the request as well as problems with the request 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:

  • invalidattribute
  • unknown
  • invalidstate.state (null, hold, , treating, routed)
  • remote
  • cancelled
  • timeout

description

This is a more detailed description of the error.

The following are the possible values

  • 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.
  • unknown — The cause of the failure is unknown.
  • invalidstate.state — The interaction is in an invalid state and cannot finish the dialog action.
  • remote — There was an error in the media server while trying to process this dialog action.
  • cancelled — This dialog action has been cancelled.
  • timeout — A target has not been found within the requested time period xxxx. xxxx is the value of the timeout attribute.

dialog.stop.done

 

This event indicates the success of the stop request and that the request has stopped the dialog application.

requestid

This is the ID of the <stop> request.

error.dialog.stop

 

This indicates that an error occurred while trying to perform the <stop> 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 dialog action requests. xxxx is the value of the requestid attribute.

requestid

This is the ID of the <continue> request.

dialog.collect.done

 

This event indicates the success of the collect request and collects the digits.

requestid

This is the ID of the <collect> request.

digits

These are the digits that were collected.

dialog.collect.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.dialog.collect

 

This indicates that an error occurred while trying to perform the <collect> 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:

  • invalidattribute
  • unknown
  • invalidstate.state (null, hold, , treating, routed)
  • remote
  • cancelled

description

This is a more detailed description of the error.

The following are the possible values

  • 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.
  • unknown — The cause of the failure is unknown.
  • invalidstate.state — The interaction is in an invalid state and cannot finish the dialog action.
  • remote — There was an error in the media server while trying to process this dialog action.
  • cancelled — This dialog action has been cancelled.

dialog.play.done

 

This event indicates the success of the play request and that the announcements were played.

requestid

This is the ID of the <play> request.

dialog.play.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.dialog.play

 

This indicates that an error occurred while trying to perform the <play> 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:

  • invalidattribute
  • unknown
  • invalidstate.state (null, hold, , treating, routed)
  • remote
  • cancelled

description

This is a more detailed description of the error.

The following are the possible values

  • 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.
  • unknown — The cause of the failure is unknown.
  • invalidstate.state — The interaction is in an invalid state and cannot finish the dialog action.
  • remote — There was an error in the media server while trying to process this dialog action.
  • cancelled — This dialog action has been cancelled.

dialog.playandcollect.done

 

This event indicates the success of the playandcollect request and that the announcements were played and the digits collected.

requestid

This is the ID of the <playandcollect> request.

digits

These are the digits that were collected.

dialog.playandcollect.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.dialog.playandcollect

 

This indicates that an error occurred while trying to perform the <playandcollect> 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:

  • invalidattribute
  • unknown
  • invalidstate.state (null, hold, , treating, routed)
  • remote
  • cancelled

description

This is a more detailed description of the error.

The following are the possible values

  • 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.
  • unknown — The cause of the failure is unknown.
  • invalidstate.state — The interaction is in an invalid state and cannot finish the dialog action.
  • remote — There was an error in the media server while trying to process this dialog action.
  • cancelled — This dialog action has been cancelled.

dialog.playandverify.done

 

This event indicates the success of the playandverify request and that the announcements were played and the digits were collected and verified.

requestid

This is the ID of the <playandverify> request.

digits

These are the digits that were collected.

dialog.playandverify.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.dialog.playandverify

 

This indicates that an error occurred while trying to perform the <playandverify> 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:

  • invalidattribute
  • unknown
  • invalidstate.state (null, hold, , treating, routed)
  • remote
  • cancelled

description

This is a more detailed description of the error.

The following are the possible values

  • 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.
  • unknown — The cause of the failure is unknown.
  • invalidstate.state — The interaction is in an invalid state and cannot finish the dialog action.
  • remote — There was an error in the media server while trying to process this dialog action.
  • cancelled — This dialog action has been cancelled.

dialog.playsound.done

 

This event indicates the success of the playsound request and that the sound was played.

requestid

This is the ID of the <playsound> request.

dialog.playsound.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.dialog.playsound

 

This indicates that an error occurred while trying to perform the <playsound> 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:

  • invalidattribute
  • unknown
  • invalidstate.state (null, hold, , treating, routed)
  • remote
  • cancelled

description

This is a more detailed description of the error.

The following are the possible values

  • 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.
  • unknown — The cause of the failure is unknown.
  • invalidstate.state — The interaction is in an invalid state and cannot finish the dialog action.
  • remote — There was an error in the media server while trying to process this dialog action.
  • cancelled — This dialog action has been cancelled.

dialog.createann.done

 

This event indicates the success of the createann request and that the announcement for the user was recorded.

requestid

This is the ID of the <createann> request.

userannid

This is the ID of the announcement that was recorded for the user.

dialog.createann.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.dialog.createann

 

This indicates that an error occurred while trying to perform the <createann> 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:

  • invalidattribute
  • unknown
  • invalidstate.state (null, hold, , treating, routed)
  • remote
  • cancelled

description

This is a more detailed description of the error.

The following are the possible values

  • 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.
  • unknown — The cause of the failure is unknown.
  • invalidstate.state — The interaction is in an invalid state and cannot finish the dialog action.
  • remote — There was an error in the media server while trying to process this dialog action.
  • cancelled — This dialog action has been cancelled.

dialog.deleteann.done

 

This event indicates the success of the deleteann request and that the announcement was deleted.

requestid

This is the ID of the <deleteann> request.

dialog.deleteann.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.dialog.deleteann

 

This indicates that an error occurred while trying to perform the <deleteann> 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:

  • invalidattribute
  • unknown
  • invalidstate.state (null, hold, , treating, routed)
  • remote
  • cancelled

description

This is a more detailed description of the error.

The following are the possible values

  • 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.
  • unknown — The cause of the failure is unknown.
  • invalidstate.state — The interaction is in an invalid state and cannot finish the dialog action.
  • remote — There was an error in the media server while trying to process this dialog action.
  • cancelled — This dialog action has been cancelled.

dialog.remote.done

 

This event indicates the success of the remote request and that the remote resource has executed the dialog application.

requestid

This is the ID of the <remote> request.

dialog.remote.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.dialog.remote

 

This indicates that an error occurred while trying to perform the <remote> 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:

  • invalidattribute
  • unknown
  • invalidstate.state (null, hold, , treating, routed)
  • remote
  • cancelled

description

This is a more detailed description of the error.

The following are the possible values

  • 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.
  • unknown — The cause of the failure is unknown.
  • invalidstate.state — The interaction is in an invalid state and cannot finish the dialog action.
  • remote — There was an error in the media server while trying to process this dialog action.
  • cancelled — This dialog action has been cancelled.

dialog.setdialogdefaultdest.done

 

This event indicates the success of the setdialogdefaultdest request and that the resource has accepted the default destination.

requestid

This is the ID of the <setdialogdefaultdest> request.

dialog.setdialogdefaultdest.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.dialog.setdialogdefaultdest

 

This indicates that an error occurred while trying to perform the <setdialogdefaultdest> 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:

  • invalidattribute
  • unknown
  • invalidstate.state (null, hold, , treating, routed)
  • remote
  • cancelled

description

This is a more detailed description of the error.

The following are the possible values

  • 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.
  • unknown — The cause of the failure is unknown.
  • invalidstate.state — The interaction is in an invalid state and cannot finish the dialog action.
  • remote — There was an error in the media server while trying to process this dialog action.
  • cancelled — This dialog action has been cancelled.



Section II – Functional Modules > Dialog (Treatment) Interface > Events         Top of Page
Genesys 8.1
SCXML Technical Reference
< Action Elements