Interaction SDK
(Web Services)

Service: InteractionCobrowseService


This service handles the co-browse interactions.
Attribute Summary
com.genesyslab.ail.ws.interaction.cobrowse.InteractionCobrowseAction[] interaction.cobrowse:actionsPossible
           Returns the actions possible.
String[] interaction.cobrowse:addUrls
           Add Co browse Urls.
String interaction.cobrowse:queue
           The queue of this interaction. Note that an interaction still is in the queue even when it is handled by an agent or a router.
String interaction.cobrowse:structTextMimeType
           The MIME type of the structuredText field. Must comply with rules described in RFC 2046. See MimeType domain definition for further information.
String interaction.cobrowse:structuredText
           The structured text of the interaction. It allows easy access to the structured interaction information. For an e-mail whose body is HTML-formatted, the structured text is the HTML body. For a chat transcript, the structured text is some formatted version of the transcript.
com.genesyslab.ail.ws.interaction.cobrowse.CobrowseURL[] interaction.cobrowse:urls
           Returns the URLs that were browsed in this session as an array of CoBrowseURL.

Method Summary
com.genesyslab.ail.ws.interaction.InteractionDTO createInteractionCobrowsePlaceDTO
           Create a co-browse interaction on a Place.
void markDone
           Marks this interaction as done.
void merge
           Moves this interaction into the history of another contact. This is useful if an agent discovers that the interaction has been assigned to the wrong contact, or that this interaction is duplicated elsewhere in the contact database. This method allows the agent to merge this interaction into the history of the correct contact, or to similarly merge all interactions that were mistakenly applied to this contact.
void release
           Releases this interaction.

Event Summary

Attribute Detail

Attributes of domain interaction.cobrowse

CoBrowse interaction attributes definition


actionsPossible

Type: com.genesyslab.ail.ws.interaction.cobrowse.InteractionCobrowseAction[]
Returns the actions possible.
Properties: read event


addUrls

Type: String[]
Add Co browse Urls.
Properties: write


queue

Type: String
The queue of this interaction. Note that an interaction still is in the queue even when it is handled by an agent or a router.
Properties: read read-default event


structTextMimeType

Type: String
The MIME type of the structuredText field. Must comply with rules described in RFC 2046. See MimeType domain definition for further information.
Properties: read write event


structuredText

Type: String
The structured text of the interaction. It allows easy access to the structured interaction information. For an e-mail whose body is HTML-formatted, the structured text is the HTML body. For a chat transcript, the structured text is some formatted version of the transcript.
Properties: read write event


urls

Type: com.genesyslab.ail.ws.interaction.cobrowse.CobrowseURL[]
Returns the URLs that were browsed in this session as an array of CoBrowseURL.
Properties: read read-default


Method Detail

createInteractionCobrowsePlaceDTO

Create a co-browse interaction on a Place.
Parameters:

  placeId  String
   The place identifier.

  interactionParentId  String
   The new interaction will be threaded to this parent. Can be null.

  queue  String
   The queue on which this interaction must be created.

  attributes  String[]
   The attributes to retrieve (interaction:* and interaction.cobrowse:*).

Returns:

  Type:  com.genesyslab.ail.ws.interaction.InteractionDTO

   The attributes on this interaction.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.interaction.PlaceNotExist


markDone

Marks this interaction as done.
Parameters:

  interactionId  String
   The interaction identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.interaction.RequestFailed

  error.common.ParameterInvalid

  error.interaction.BadInteractionId

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


merge

Moves this interaction into the history of another contact. This is useful if an agent discovers that the interaction has been assigned to the wrong contact, or that this interaction is duplicated elsewhere in the contact database. This method allows the agent to merge this interaction into the history of the correct contact, or to similarly merge all interactions that were mistakenly applied to this contact.
Parameters:

  interactionId  String
   The interaction identifier.

  contactId  String
   The contact into whose history this interaction must be merged

  all  boolean
   If true, also merges all the interactions of the same contact.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.ParameterInvalid

  error.interaction.BadInteractionId


release

Releases this interaction.
Parameters:

  interactionId  String
   The interaction identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.ParameterInvalid

  error.interaction.BadInteractionId

  error.common.InteractionServerTimeout

  error.common.InteractionServerCode::Type:x1::Number:x2
  


Event Detail

Interaction SDK
(Web Services)