Get Full Interaction Flow

Navigation: API Methods:

Get Full Interaction Flow

Contents

Purpose

This method retrieves all Interaction steps that have been completed by a user. Any selections made by the user and all user input (e.g., text entered, photos uploaded, etc.) are included.

Note: Only the paths to the images are returned. (Image content is not retrieved.) To view the content of photos uploaded by the user, use the Get Interaction Photo API.

URL Syntax and Example

http://[host:port/internalPath]Application Name/agent/version/[version]/account/[accountID]/interactiondata/[interactionuniqueid]/fullFlow

http:/interact.jacada.com/interact/agent/version/1/account/12345678/interactiondata/040100713/fullFlow

HTTP Method

GET

HTTP Headers

Tenant-Id: <account>

Application-Key: <agent app application key>

The following example shows a response that returns an entire Interaction. For explanations about the sections of a page and properties related to page layout, refer to the Jacada Interaction Server API Guide.

HTTP/1.1 200 OK

Server: Apache-Coyote/1.1

Content-Type: application/json;charset=UTF-8

Transfer-Encoding: chunked

Date: Mon, 01 Apr 2013 11:52:28 GMT

[ {

"pageNavigation" : {

"navigationTitle" : "Welcome to sprint 19",

"navigationRight" : {

"buttonState" : "NORMAL",

"buttonVisible" : true,

"buttonLabel" : "Next",

"buttonAction" : "server://navigationType?type=NEXT&shouldSendFormData=true"

"navigationLeft" : {

"buttonState" : "NORMAL",

"buttonVisible" : true,

"buttonLabel" : "Back",

"buttonAction" : "server://navigationType?type=PREVIOUS&shouldSendFormData=false"

}

"pageContent" : {

"contentHeader" : {

"id" : "1362464372212-888266df72834abe461732ed02df13d3592faf7-407a",

"innerHtml" : "Welcome! Allow us to use this script
to introduce to you the main features of this sprint: <ol> <li>
Finalize the support of the mobile new Web application -
The main feature that was missing before this sprint is the upload-photos which is now supported
with some limitations in old devices, for example 
it is not supported on Android 2.3x, and old IOS (4.x,5.x)
 </li> <li> New Admin console  -
This is a new administration application for managing the new cloud server
(which is not ready yet). Login page you can see by accessing the admin url:
 http://23.23.154.19/admin/main/12345678, and some screenshots were sent to relevant people.
Later in the sprints we will have a dedicated user for demonsrating capabilities.
 </li> </ol> All these topics are described in the documentation which is part of the this internal release.
search for the word "sprint" in the documentation to find them easily"

"allowVerticalScroll" : true,

"allowHorizonalScroll" : false

"pageMenu" : {

"menuVisible" : false,

"menuButtons" : [ {

"buttonState" : "NORMAL",

"buttonVisible" : true,

"buttonLabel" : "Help",

"buttonAction" : "server://navigationType?type=HELP&shouldSendFormData=false",

"buttonImageName" : "icon_help.png"

}, {

"buttonState" : "DISABLED",

"buttonVisible" : false,

"buttonAction" : "local://chat"

}, {

"buttonState" : "DISABLED",

"buttonVisible" : false,

"buttonAction" : "local://call?phone=,040100713&voiceQueue=0"

}, {

"buttonState" : "NORMAL",

"buttonVisible" : true,

"buttonLabel" : "More",

"buttonAction" : "local://CURRENT",

"buttonImageName" : "icon_more.png"

} ]

}

}, {

"pageNavigation" : {

"navigationTitle" : "Upload photos",

"navigationRight" : {

"buttonState" : "NORMAL",

"buttonVisible" : true,

"buttonLabel" : "Next",

"buttonAction" : "server://navigationType?type=NEXT&shouldSendFormData=true"

"navigationLeft" : {

"buttonState" : "NORMAL",

"buttonVisible" : true,

"buttonLabel" : "Back",

"buttonAction" : "server://navigationType?type=PREVIOUS&shouldSendFormData=false"

}

"pageContent" : {

"contentSections" : [ {

"id" : "1362484326294-262066df72834abe461732ed02df13d3a2fd704-6239",

"sectionGroupType" : "SINGLE",

"sectionNumberOfColumns" : 0,

"sectionChoices" : [ {

"id" : "1362484326294-262066df72834abe461732ed02df13d3a2fd704-6239",

"uploadImageList" : {

"id" : "1362484326294-262066df72834abe461732ed02df13d3a2fd704-6239",

"buttonVisible" : false,

"buttonLabel" : "upload your party photos",

"uploadImageListPageTitle" : "Your photos",

"numberOfPhotos" : 4,

"uploadImageListNumberOfColumns" : 2,

"maxImageSizeInKilobytes" : 1,

"uploadImageListOptions" : [ {

"id" : "1362484326294-262066df72834abe461732ed02df13d3a2fd704-6239-0",

"buttonVisible" : true,

"buttonLabel" : "Photo 1",

"shouldUploadToServer" : false

}, {

"id" : "1362484326294-262066df72834abe461732ed02df13d3a2fd704-6239-1",

"buttonVisible" : true,

"buttonLabel" : "Photo 2",

"buttonImageName" : "%2Fmnt%2Fsdcard%2Fhome%2Fdownloads%2Fi1152998579.png",

"shouldUploadToServer" : false

}, {

"id" : "1362484326294-262066df72834abe461732ed02df13d3a2fd704-6239-2",

"buttonVisible" : true,

"buttonLabel" : "Photo 3",

"shouldUploadToServer" : false

}, {

"id" : "1362484326294-262066df72834abe461732ed02df13d3a2fd704-6239-3",

"buttonVisible" : true,

"buttonLabel" : "Photo 4",

"buttonImageName" : "%2Fmnt%2Fsdcard%2Fhome%2Fdownloads%2Fi2101732690.png",

"shouldUploadToServer" : false

} ]

}

} ],

"isMandatory" : false

} ],

"allowVerticalScroll" : true,

"allowHorizonalScroll" : false

"pageMenu" : {

"menuVisible" : false,

"menuButtons" : [ {

"buttonState" : "DISABLED",

"buttonVisible" : false,

"buttonAction" : "server://navigationType?type=HELP&shouldSendFormData=false"

}, {

"buttonState" : "DISABLED",

"buttonVisible" : false,

"buttonAction" : "local://chat"

}, {

"buttonState" : "DISABLED",

"buttonVisible" : false,

"buttonAction" : "local://call?phone=,040100713&voiceQueue=0"

}, {

"buttonState" : "NORMAL",

"buttonVisible" : true,

"buttonLabel" : "More",

"buttonAction" : "local://CURRENT",

"buttonImageName" : "icon_more.png"

} ]

}

}, {

"pageNavigation" : {

"navigationTitle" : "Thank you",

"navigationRight" : {

"buttonState" : "NORMAL",

"buttonVisible" : true,

"buttonLabel" : "Next",

"buttonAction" : "server://navigationType?type=NEXT&shouldSendFormData=true"

"navigationLeft" : {

"buttonState" : "NORMAL",

"buttonVisible" : true,

"buttonLabel" : "Back",

"buttonAction" : "server://navigationType?type=PREVIOUS&shouldSendFormData=false"

}

"pageContent" : {

"contentHeader" : {

"id" : "1362464372212-888566df72834abe461732ed02df13d3592faf7-407d",

"innerHtml" : "Thanks you for uploading photos.
 You can now pretend to be an agent, and use the agent application at
http://23.23.154.19/agent to view the interaction flow."

"allowVerticalScroll" : true,

"allowHorizonalScroll" : false

"pageMenu" : {

"menuVisible" : false,

"menuButtons" : [ {

"buttonState" : "DISABLED",

"buttonVisible" : false,

"buttonAction" : "server://navigationType?type=HELP&shouldSendFormData=false"

}, {

"buttonState" : "DISABLED",

"buttonVisible" : false,

"buttonAction" : "local://chat"

}, {

"buttonState" : "DISABLED",

"buttonVisible" : false,

"buttonAction" : "local://call?phone=,040100713&voiceQueue=0"

}, {

"buttonState" : "NORMAL",

"buttonVisible" : true,

"buttonLabel" : "More",

"buttonAction" : "local://CURRENT",

"buttonImageName" : "icon_more.png"

} ]

}

}, {

"pageNavigation" : {

"navigationTitle" : "New Admin console",

"navigationRight" : {

"buttonState" : "NORMAL",

"buttonVisible" : true,

"buttonLabel" : "Next",

"buttonAction" : "server://navigationType?type=NEXT&shouldSendFormData=true"

"navigationLeft" : {

"buttonState" : "NORMAL",

"buttonVisible" : true,

"buttonLabel" : "Back",

"buttonAction" : "server://navigationType?type=PREVIOUS&shouldSendFormData=false"

}

"pageContent" : {

"contentHeader" : {

"id" : "1362464372212-888666df72834abe461732ed02df13d3592faf7-407e",

"innerHtml" : "
 If you want to try it open <a href=\"http://23.23.154.19/admin/main/1234\">http://23.23.154.19/admin/main/12345678
</a> The "12345678" represents the tenant ID you can use any other

91c

ID you want. Sorry, but for now you will not be able to log-in:-("

"allowVerticalScroll" : true,

"allowHorizonalScroll" : false

"pageMenu" : {

"menuVisible" : false,

"menuButtons" : [ {

"buttonState" : "DISABLED",

"buttonVisible" : false,

"buttonAction" : "server://navigationType?type=HELP&shouldSendFormData=false"

}, {

"buttonState" : "DISABLED",

"buttonVisible" : false,

"buttonAction" : "local://chat"

}, {

"buttonState" : "DISABLED",

"buttonVisible" : false,

"buttonAction" : "local://call?phone=,040100713&voiceQueue=0"

}, {

"buttonState" : "NORMAL",

"buttonVisible" : true,

"buttonLabel" : "More",

"buttonAction" : "local://CURRENT",

"buttonImageName" : "icon_more.png"

} ]

}

}, {

"pageNavigation" : {

"navigationTitle" : "What's next?",

"navigationRight" : {

"buttonState" : "NORMAL",

"buttonVisible" : true,

"buttonLabel" : "Done",

"buttonAction" : "server://navigationType?type=FINISH&shouldSendFormData=true"

"navigationLeft" : {

"buttonState" : "NORMAL",

"buttonVisible" : true,

"buttonLabel" : "Back",

"buttonAction" : "server://navigationType?type=PREVIOUS&shouldSendFormData=false"

}

"pageContent" : {

"contentHeader" : {

"id" : "1362464372212-888366df72834abe461732ed02df13d3592faf7-407b",

"innerHtml" : "play with it,
send your feedback and dont forget to keep it internal"

"allowVerticalScroll" : true,

"allowHorizonalScroll" : false

"pageMenu" : {

"menuVisible" : false,

"menuButtons" : [ {

"buttonState" : "DISABLED",

"buttonVisible" : false,

"buttonAction" : "server://navigationType?type=HELP&shouldSendFormData=false"

}, {

"buttonState" : "DISABLED",

"buttonVisible" : false,

"buttonAction" : "local://chat"

}, {

"buttonState" : "DISABLED",

"buttonVisible" : false,

"buttonAction" : "local://call?phone=,040100713&voiceQueue=0"

}, {

"buttonState" : "NORMAL",

"buttonVisible" : true,

"buttonLabel" : "More",

"buttonAction" : "local://CURRENT",

"buttonImageName" : "icon_more.png"

} ]

}

} ]