{ "componentChunkName": "component---src-templates-doc-page-js", "path": "/docs/en/JS_API/variables/response/", "result": {"data":{"site":{"siteMetadata":{"title":"Gatsby-doc-engine"}},"markdownRemark":{"id":"ddbc4ab0-4da8-57e6-b157-cc90770f0ee9","excerpt":"This object is used for filling in system responses. is a list of responses made while processing chatbot reactions. It is an array containing strictly typed…","html":"

$response

\n
\n

This object is used for filling in system responses.

\n

$response.replies is a list of responses made while processing chatbot reactions. It is an array containing strictly typed elements and utilized in order to transfer chatbot replies to platform-specific chat adapters, such as Telegram, Facebook, etc.

\n

replies supports objects of the following types:

\n\n
{\n  \"type\":\"text\",\n  \"text\":\"....\",\n  \"tts\":\"....\",\n  \"markup\":\n    \"html|markdown|plain\"\n}\n
\n
\n\n
    \"type\": \"buttons\",\n    \"buttons\": [\n        {\n            \"text\": \"button\"\n            // all the remaining attributes will be\n            // directly passed on to the messenger\n        }\n    ]\n}
\n
\n\n
{\n    \"type\": \"inlineButtons\",\n    \"buttons\": [\n        {\n            \"text\": \"button\",\n            \"url\": \"https://www.google.com\"\n        }\n    ]\n}
\n
\n\n
{\n  \"type\":\"image\",\n  \"imageUrl\":\"http://...\"\n}
\n
\n\n
{\n  \"type\":\"link\",\n  \"url\":\"http://...\"\n}
\n
\n\n
{\n    \"type\": \"raw\",\n    \"body\": {\n        ...\n    },\n    \"method\": \"sendMessage\"\n}
\n
\n\n

firstMessage:is the message that will be shown in the live chat. It is the last client response by default.

\n

closeChatPhrases: is a string array of commands which the user can type in himself in order to close the live chat and get back to the bot.

\n

ignoreOffline: is a flag indicating whether or not the transfer to a customer service agent should be made despite the lack of agents available. false by default.

\n

oneTimeMessage: indicates if the value of firstMessage should be sent to a customer service agent without making the switch. It enables the agent to receive information on the dialogue without initiating a live chat. false by default.

\n

destination: is a group of customer service agents that the client should be transferred to.

\n
{\n  \"type\":\"switch\",\n  \"firstMessage\":\"...\",\n  \"closeChatPhrases\": [\"..\"],\n  \"ignoreOffline\":true|false,\n\"oneTimeMessage\": true|false\n}
\n
\n\n
{\n  \"type\": \"location\",\n  \"lat\": 59.934280,\n  \"lon\": 30.335099\n}
\n
\n\n

interval: is the time limit (in seconds) for the user to make his response.

\n

targetState: is the state transitioned into if there is no response from the user.

\n
{\n  \"type\":\"timeout\",\n  \"interval\":10,\n  \"targetState\":\"/timedout\"\n}
\n
\n\n
$response.replies.push({type:\"dtmf\"});
\n
\n\n
$response.replies.push({type:\"hangup\"});
\n
\n

How to use

\n\n
  script:\n     $response.replies.push( {\n          type: \"image\",\n          imageUrl: \" https://testimageurl.jpg\",\n          text: \"Image\" // this field is optional\n      } )
\n
\n\n
$response.replies .push({\n     type:\"switch\",\n     phoneNumber:74155,\n     closeChatPhrases: catchAll.closeChatPhrases,\n     firstMessage: $client.history,\n     destination: catchAll.operatorGroup,\n                    });
\n
\n\n
init:\n    bind(\"postProcess\", function(){\n        var $session = $jsapi.context().session;\n        var $response = $jsapi.context().response;\n        var answer = $response.replies ? $response.replies.reduce (function (answers, current) {\n            answers += \" \" + current.text;\n            return answers;\n        }, \"\")  : \"\";\n        if ($session.lastAnswer && (answer == $session.lastAnswer)) {\n            $session.answerRepetition = $session.answerRepetition || 0;\n            $session.answerRepetition += 1;\n        } else {\n            $session.answerRepetition = 0;\n        }\n        if ($session.answerRepetition == 2) {\n            $response.replies = [{\n                \"type\": \"text\",\n                \"text\": \"We are going in circles. Could you ask me something else?\"\n            }];\n        }\n        $session.lastAnswer = answer;\n    });
","frontmatter":{"title":"","description":null},"headings":[{"value":"$response"}]}},"pageContext":{"slug":"/docs/en/JS_API/variables/response/","previous":{"fields":{"slug":"/docs/en/JS_API/variables/session/"},"frontmatter":{"title":"","description":null}},"next":{"fields":{"slug":"/docs/en/JS_API/variables/parseTree/"},"frontmatter":{"title":"","description":null}}}}, "staticQueryHashes": ["1209419333"]}