Camlin Text Channel*
CamlinConnect Text channel provides the text output as a response for a user input (text input as a short code or keyword or natural language) that can either be delivered directly to an end customer or can simply be returned in HTTP response. This can be used for
Providing HTTP response to a system that is responsible to send the SMS responses
Providing HTTP response to a system that is responsible to send the chatbot responses
Endpoint
Inbound URL
protocol://hostname:port/nuassist/rest/in/sms
Parameters
Parameter | Mandatory | Values | Default Value | Description |
---|---|---|---|---|
pt | Yes | {projectToken} | Project token of the camlin app that you are requesting for | |
message | {userInput} | To provide user input that can be recognised by text flow developed in CamlinConnect console | ||
phoneNo | {cli} | To provide the Caller ID of incoming text from end user mobile number | ||
id | {sessionID} | To provide the session Id of incoming text from end user | ||
sync | true/yes/false/no | true | To send the response synchronously or asynchronously
| |
stateless | true/false/yes/no | false | To treat each request in a stateless manner, which means from the start of flow | |
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
Links
See Channel Settings for details of how to configurate project settings for text channel
See Text Interaction for details of how to configurate a text interaction
See Create an SMS Bot for an example of how to build a simple chatbot