Camlin Visual Channel*
Visual channel is used to provide HTML5 output that can be rendered on desktop or mobile web browsers. CamlinConnect runtime inbound visual channel provides HTML5 based output of Camlin Apps developed through CamlinConnect console. Common clients for visual channels are :
Visual IVR
HTML5 based mobile applications
Websites or web applications
etc
Endpoint for Visual Channel
There are 2 types of visual channels endpoints: stateful endpoint and stateless endpoint.
Stateful endpoint
This is the endpoint type that should be used in most visual channels applications where persistent session needs to preserved. Each new request will be executed from the current interaction in the flow.
URL
protocol://hostname:port/nuassist/index.html
protocol://hostname:port/nuassist/?
Parameters
Parameter | Mandatory | Values | Default Value | Description |
|---|---|---|---|---|
pt | Yes | {projectToken} | Project token of the camlin app that you are requesting for | |
isAppUser | yes/no | yes | Mostly used as yes in production for recording interactions with Camlin app in reporting system (Camlin analytics) | |
Custom parameter | Any other variable that you want to set in camlin app : This is a generic feature on Camlin inbound channels to set any of Camlin app variable with request parameter |
Sample URL
https://www.camlinconnect.com/nuassist/?pt=myDemoApp
Stateless endpoint
This endpoint type is for applications that do not need persistent session (which preserves current user interaction after page refresh). Each request is treated in a stateless manner, which means from the start of flow
URL
protocol://hostname:port/nuassist/mi
Parameter | Mandatory | Values | Default Value | Description |
|---|---|---|---|---|
pt | Yes | {projectToken} | Project token of the camlin app that you are requesting for | |
a | Yes | ho | This is pretty much static for the time being | |
in | {interactionName} | To start the flow from a particular interaction. Useful for contextual handoff | ||
language | {language} | Language to present the output in a particular locale | ||
isAppUser | yes/no | yes | Mostly used as yes in production for recording interactions with Camlin app in reporting system (Camlin analytics) | |
code | {oAuthOneTimeToken} | To use OAuth2 code for authentication purposes. | ||
Custom parameter | Any other variable that you want to set in camlin app : This is a generic feature on Camlin inbound channels to set any of Camlin app variable with request parameter |
Sample URL
https://www.camlinconnect.com/nuassist/mi?a=ho&pt=myDemoApp&language=en&isAppUser=yes
Links
See Channel Settings for details of how to configurate project settings for visual channel
See Visual Interaction for details of how to configurate a visual interaction
See Create a simple web form for an example of how to build a simple web form application