Camlin Multi-Channel and Multi-modal
A multi-modal interaction can be initiated through API or Voice channel and the a Visual interface sms link can be sent to initiate a Voice+Visual multi-modal user session. The session are bind together using a unique handoff token. The handoff token can be generated upfront using API channel or can be generated on a new call by Voice channel. Here are the details of each inbound requests
Technical Specification
Inbound API URL to generate a handoff token
Parameters
Parameter | Type | Mandatory | Values | Default Value | Description |
|---|---|---|---|---|---|
projectToken | Path | Yes | {projectToken} | Project token of the camlin app that you are requesting for | |
endpoint | Path | Yes | {endpoint} | HTTP endpoint you are hitting on the API channel | |
generateHandoffToken | Query String | {projectToken} | To generate a 20 character long handoff token | ||
isAppUser | Query String | yes/no | yes | Mostly used as yes in production for recording interactions with Camlin app in reporting system (Camlin analytics) | |
Custom parameter | Query String | 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
Inbound Voice URL to patch the API session with Voice session
protocol://hostname:port/nuassist/vxml/svxml/{projectToken}
Parameters
Parameter | Type | Mandatory | Values | Default Value | Description |
|---|---|---|---|---|---|
projectToken | Path | Yes | {projectToken} | Project token of the camlin app that you are requesting for | |
nmsoutbounddialled | Query String | Yes | {cli} | HTTP endpoint you are hitting on the API channel | |
ht | Query String | Yes | {handoffToken} | To provide the handoff token | |
Custom parameter | Query String | 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 |
Rest of the optional parameter details can be referred from Voice channel
Inbound Visual URL that can be sent in the SMS link
Websocket based ( Preferred one)
{protocol}://{host}/nuassist/hov?pt={projectToken}&ht={handoffToken}
Polling based (Only as a fallback option)
{protocol}://{host}/nuassist/view.htm?pt={projectToken}&ht={handoffToken}&a=hov&isAppUser=yes
Paramaters
Parameter | Type | Mandatory | Values | Default Value | Description |
|---|---|---|---|---|---|
pt | Path | Yes | {projectToken} | Project token of the camlin app that you are requesting for | |
a | Query String | Yes | hov | action = handoff voice | |
ht | Query String | Yes | {handoffToken} | To provide the handoff token | |
isAppUser | Query String | {yes/no} | yes | Mostly used as yes in production for recording interactions with Camlin app in reporting system (Camlin analytics) | |
Custom parameter | Query String | 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 |