...
Configure the bot to say something based on the output from the attached function node.
Status call back
We can identify the delivery status of the Twilio SMS or IVR calls we make from the system through the Twilio status call back property.
Voice/ IVR status callBack
Please use the below snippet to set the status call back function for IVR communication.
| Code Block |
|---|
msg.twilio = {
settings: {
machineDetection: "DetectMessageEnd",
machineDetectionTimeout: 30,
asyncAmd: false,
asyncAmdStatusCallbackMethod: "POST",
asyncAmdStatusCallback: "https://domain/oeapi/amd",
statusCallback:'https://domain/oeapi/twilio/voice/status',
statusCallbackMethod: 'POST',
statusCallbackEvent: ['initiated', 'answered', 'ringing', 'completed']
}
} |
The status of the connection will be available under the response property CallStatus
When the call is initiated the status is
CallStatus: "initiated"When the phone is ringing the status is
CallStatus: "ringing"When the user attends the phone call the status is
CallStatus: "In-Progress"When the call is disconnected the status is
CallStatus: "completed"When the user does not attend the call or when the user disconnects the call without attending, then the status is
CallStatus: "no-answer"
SMS status callBack
Please use the below snippet to set the status call back function for SMS communication.
| Code Block |
|---|
msg.twilio = {
settings: {
statusCallbackMethod:'POST',
statusCallback: 'https://domain/oeapi/twilio/sms/status',
}
} |
The status of the connection will be available under the response property CallStatus
When the SMS is sent, the status is
SmsStatus: "sent"When the SMS is delivered, the status is
SmsStatus: "delivered"
StatusCallBack Flow sample
The sample code to set up Twilio SMS and IVR services are given below. Import this code snippet in the Experience Designer.
| Code Block |
|---|
[{"id":"fd8bf50c.2ce77","type":"tab","label":"Twilio sms/voice status callback","disabled":false,"info":""},{"id":"c8ccf1b3.e47898","type":"alexa-flow-config reff","z":"fd8bf50c.2ce77","skillConfig":"ad3fc2e.9afca4","x":100,"y":50,"wires":[]},{"id":"2b8e648b.70e6c4","type":"twilio out","z":"fd8bf50c.2ce77","twilio":"b84e0bf3.5721c8","twilioType":"call","url":"","number":"","name":"IVR ","x":770,"y":140,"wires":[]},{"id":"5d780d4a.4c1c84","type":"inject","z":"fd8bf50c.2ce77","name":"","topic":"","payload":"","payloadType":"date","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":380,"y":140,"wires":[["7738659a.6fc32c"]]},{"id":"7738659a.6fc32c","type":"function","z":"fd8bf50c.2ce77","name":"IVR status call back","func":"msg.topic = '+1999996666' // Phone number to call, needs the +1, we are set up for US based calling. \nmsg.payload = 'https://domain/oeapi/twilio/voice'\n// https://www.twilio.com/docs/voice/answering-machine-detection\nmsg.twilio = {\n settings: {\n machineDetection: \"DetectMessageEnd\",\n machineDetectionTimeout: 30,\n asyncAmd: false,\n asyncAmdStatusCallbackMethod: \"POST\",\n asyncAmdStatusCallback: \"https://domain/oeapi/amd\",\n statusCallback:'https://domain/oeapi/twilio/voice/status',\n statusCallbackMethod: 'POST',\n statusCallbackEvent: ['initiated', 'answered', 'ringing', 'completed']\n }\n}\nreturn msg;\n","outputs":1,"noerr":0,"x":590,"y":140,"wires":[["2b8e648b.70e6c4"]]},{"id":"c3c90630.5b944","type":"comment","z":"fd8bf50c.2ce77","name":"Twilio- Voice","info":"(617) 622-5611","x":190,"y":140,"wires":[]},{"id":"7e5811e9.bbb408","type":"http in","z":"fd8bf50c.2ce77","name":"Twilio - Voice","url":"/twilio/voice","method":"post","upload":false,"swaggerDoc":"","x":190,"y":220,"wires":[["a2e2e292.9b1978"]]},{"id":"a2e2e292.9b1978","type":"function","z":"fd8bf50c.2ce77","name":"IVR","func":"msg.payload2 = msg.payload;\nif(msg.req.body.AnsweredBy && msg.req.body.AnsweredBy === 'machine_start') {\n global.set('AnswerType','machine_start'); \n} else {\n global.set('AnswerType','notMachine'); \n}\nif(msg.payload.SpeechResult) {\n var SpeechResult = msg.payload.SpeechResult.toLowerCase();\n if (SpeechResult === 'snow' || SpeechResult === 'no.') {\n msg.payload.SpeechResult = 'no';\n }\n} else {\n if (msg.req.url.indexOf(\"sessionId\") !== -1) {\n msg.payload.SpeechResult = 'did not understand'; // have intent did not understand\n } \n}\n\nreturn msg;","outputs":1,"noerr":0,"x":370,"y":240,"wires":[["f04173b2.4d176"]]},{"id":"f04173b2.4d176","type":"orbita-bot-provider-v2","z":"fd8bf50c.2ce77","name":"","botInParser":"var utterance = msg.payload2.SpeechResult || \"launch\";\nif(utterance) {\n utterance =utterance.replace('.', '');\n}\nnode.warn(utterance);\nmsg.payload = {\n \"query\": utterance,\n // \"sessionId\": msg.payload.sessionId,\n \"originalRequest\": {\n \"source\": \"twilio\",\n \"data\": msg.payload2\n }\n}\n\n// msg.payload.sessionId = msg.req.query.sessionId || msg.payload.sessionId;\n\n\nif(msg.req.query.sessionId) {\n msg.payload.sessionId = msg.req.query.sessionId\n}\n\nif(msg.payload.sessionEnd) {\n msg.payload.session = {};\n}\n\n","botOutParser":"","transcriptEnabled":false,"ttsconfig":"{\n \"languageCode\": \"en-US\",\n \"ssmlGender\": \"FEMALE\",\n \"name\": \"en-US-Standard-C\",\n \"audioEncoding\": \"MP3\"\n}","providerType":"Google","skillConfig":"ad3fc2e.9afca4","token":"","noerr":0,"agentId":"","nlpData":false,"x":540,"y":240,"wires":[["611dc26.c789f3c"]]},{"id":"611dc26.c789f3c","type":"switch","z":"fd8bf50c.2ce77","name":"End?","property":"payload.sessionEnd","propertyType":"msg","rules":[{"t":"true"},{"t":"else"}],"checkall":"true","repair":false,"outputs":2,"x":710,"y":240,"wires":[["ed8b6d4c.c424c8"],["b150adb4.3517f8"]]},{"id":"ed8b6d4c.c424c8","type":"template","z":"fd8bf50c.2ce77","name":"Hangup","field":"payload","fieldType":"msg","format":"handlebars","syntax":"mustache","template":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Response>\n <Say voice=\"Polly.Joanna\" language=\"en-US\">{{payload.ssml}}</Say>\n <Hangup/>\n</Response>\n","x":860,"y":200,"wires":[["6bb145a5.d9aa64"]]},{"id":"b150adb4.3517f8","type":"template","z":"fd8bf50c.2ce77","name":"Respond","field":"payload","fieldType":"msg","format":"handlebars","syntax":"mustache","template":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Response>\n <Gather input=\"speech dtmf\" enhanced=\"true\" speechModel=\"phone_call\" actionOnEmptyResult=\"true\" timeout=\"3\" action=\"https://14a2-120-138-12-133.ngrok.io/oeapi/twilio/voice?sessionId={{payload.sessionId}}\" method=\"POST\">\n <Say voice=\"Polly.Joanna\" language=\"en-US\">{{payload.ssml}}</Say>\n </Gather>\n\n <Say voice=\"Polly.Joanna\" language=\"en-US\">Sorry, I couldn't hear you. Goodbye!</Say>\n</Response>\n\n","output":"str","x":860,"y":260,"wires":[["6bb145a5.d9aa64"]]},{"id":"6bb145a5.d9aa64","type":"http response","z":"fd8bf50c.2ce77","name":"","x":1030,"y":220,"wires":[]},{"id":"cd4bae9b.d398b","type":"http in","z":"fd8bf50c.2ce77","name":"","url":"/twilio/voice/status","method":"post","upload":false,"swaggerDoc":"","x":380,"y":360,"wires":[["9c0b623b.1515b8"]]},{"id":"9c0b623b.1515b8","type":"http response","z":"fd8bf50c.2ce77","name":"","statusCode":"","headers":{},"x":630,"y":360,"wires":[]},{"id":"be1e060b.b0f6c","type":"comment","z":"fd8bf50c.2ce77","name":"voice status callback","info":"","x":150,"y":360,"wires":[]},{"id":"5dab882c.9a03f8","type":"http in","z":"fd8bf50c.2ce77","name":"","url":"/twilio/sms/status","method":"post","upload":false,"swaggerDoc":"","x":380,"y":580,"wires":[["95fbf349.599458"]]},{"id":"95fbf349.599458","type":"http response","z":"fd8bf50c.2ce77","name":"","statusCode":"","headers":{},"x":697,"y":579,"wires":[]},{"id":"719336fe.5978b","type":"comment","z":"fd8bf50c.2ce77","name":"SMS status callback","info":"","x":150,"y":580,"wires":[]},{"id":"864486d9.21396","type":"inject","z":"fd8bf50c.2ce77","name":"","topic":"","payload":"{}","payloadType":"json","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":330,"y":500,"wires":[["855cdd12.993a9"]]},{"id":"855cdd12.993a9","type":"function","z":"fd8bf50c.2ce77","name":"SMS","func":"if(!msg) {\n msg = {};\n \n}\n\nmsg.twilio = {\n settings: {\n statusCallbackMethod:'POST',\n statusCallback: 'https://domain/oeapi/twilio/sms/status',\n }\n}\n\nmsg.payload = 'Hello welcome to twilio SMS'\n\nreturn msg;","outputs":1,"noerr":0,"x":530,"y":500,"wires":[["8b30b926.342f58"]]},{"id":"8b30b926.342f58","type":"twilio out","z":"fd8bf50c.2ce77","twilio":"b84e0bf3.5721c8","twilioType":"sms","url":"","number":"","name":"","x":710,"y":500,"wires":[]},{"id":"58603a8d.f4c5f4","type":"comment","z":"fd8bf50c.2ce77","name":"Twilio- SMS","info":"","x":170,"y":500,"wires":[]},{"id":"6c97f3c6.7c8e34","type":"http in","z":"fd8bf50c.2ce77","name":"","url":"/amd","method":"post","upload":false,"swaggerDoc":"","x":380,"y":420,"wires":[["d9ada7c7.818e88"]]},{"id":"d9ada7c7.818e88","type":"http response","z":"fd8bf50c.2ce77","name":"","statusCode":"","headers":{},"x":650,"y":420,"wires":[]},{"id":"98df258d.8cd8a","type":"http in","z":"fd8bf50c.2ce77","name":"","url":"/failure","method":"post","upload":false,"swaggerDoc":"","x":170,"y":260,"wires":[["a2e2e292.9b1978"]]},{"id":"ad3fc2e.9afca4","type":"alexa-skill-config","skillname":"Version Three","projectId":"6225f5afb596ce006bd75a36","intents":"[]","skillstate":"fromsession"},{"id":"b84e0bf3.5721c8","type":"twilio-api","z":"","sid":"ACace0e69fb0f8de8904ead0afacecc082","from":"+1999996666","name":""},{"id":"slots","type":"slots","z":"","slots":[]}] |
Best Practices
Do not use special characters in the messages.
If the message is large (i.e. greater than 140 characters), split the message into segments and use multiple Twilio nodes to send the segments with a delay.
The maximum number of characters allowed in one segment is 140. If you use multiple segments, then you should restrict the maximum number of characters used in each segment to 134 as 6 characters will be utilized to link the segments together.
...