{"id":21403,"date":"2019-06-11T05:56:02","date_gmt":"2019-06-11T04:56:02","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=21403"},"modified":"2022-10-03T09:35:47","modified_gmt":"2022-10-03T08:35:47","slug":"customizing-error-messages","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/bot-settings\/customizing-error-messages\/","title":{"rendered":"Customizing Error Messages"},"content":{"rendered":"

In the XO Platform, each Virtual Assistant contains a set of predefined error messages along with actions for standard HTTP Status codes returned for an HTTP Request method.<\/span><\/p>\n

In most cases, the default response and action are sufficient for an end-user response, however, you may need to handle other HTTP Status codes not defined by default, customize the error message itself, or change the default response by Kore.ai in the event of an error.<\/span><\/p>\n

This topic describes how to customize and create error messages for Kore.ai assistants.<\/span><\/p>\n

<\/div><\/div>\n

Custom Status Codes<\/span><\/span><\/h1>\n

There are approximately 25 HTTP Status codes defined by default.<\/span><\/p>\n

To customize an HTTP Status code:<\/span><\/p>\n

    \n
  1. Open the assistant in the XO Platform<\/span><\/li>\n
  2. Select <\/span>Build<\/strong> tab from top menu<\/span><\/li>\n
  3. From the left menu click <\/span>Configurations -> General Settings.
    \"\"<\/a>
    <\/strong><\/li>\n
  4. Scroll down to locate the <\/span>Error Messages<\/strong> section.
    \"\"<\/a>
    <\/span><\/li>\n
  5. Click the <\/span>Edit<\/strong> icon for the code that you want to customize to open the <\/span>Setup Error Message<\/strong> dialog.<\/span>
    <\/span><\/li>\n
  6. In the <\/span>Message Type<\/strong> field, select one of the following options:<\/span>\n
      \n
    1. Custom<\/strong> \u2013 Displays a <\/span>Custom Message<\/strong> field to define an error-specific message for the end-user.<\/span><\/li>\n
    2. Source<\/strong> \u2013 Displays the <\/span>Error Paths<\/strong> field where you can use to define the JSON path from the JSON response payload for HTTP Status codes other than those in the 2XX range (success messages).<\/span><\/li>\n<\/ol>\n<\/li>\n
    3. In the <\/span>Action<\/strong> field, specify the action to take when the number of consecutive errors defined in the <\/span>Error Recurrence<\/strong> field is reached. Select one of the following:<\/span>\n
        \n
      1. Disable<\/strong> \u2013 The task is set to <\/span>Inactive<\/strong> when the error occurs. The end-user can activate the task when needed.<\/span><\/li>\n
      2. Reschedule<\/strong> \u2013 Displays the <\/span>Retry Interval<\/strong> field used to define the elapsed time in minutes after which to retry the task when the error occurs.<\/span><\/li>\n
      3. Disable Auth<\/strong> \u2013 When the error occurs, the authorization mechanism defined for the task is disabled. Any other task that uses the same authorization mechanism is also disabled.<\/span><\/li>\n
      4. Notify<\/strong> \u2013 Displays the error message in the end-user interface.
        \"\"<\/a><\/span>
        <\/span><\/li>\n<\/ol>\n<\/li>\n
      5. In the <\/span>Message<\/strong> field (available only for the default messages), enter the text message displayed to the end-user.<\/span><\/li>\n
      6. In the <\/span>Error Recurrence<\/strong> field, specify the number of consecutive error codes must be returned before the action is executed. By default, the <\/span>Error Recurrence<\/strong> field is set to \u201d <\/span>1<\/span> \u201c.<\/span><\/li>\n
      7. Click <\/span>Add<\/strong> to save and close the <\/span>Setup Error Message<\/strong> dialog for your custom error message.<\/span><\/li>\n<\/ol>\n

        To create a new HTTP Status code, click <\/span>Add Error Message<\/strong>, define the fields for your new code as described in the preceding section, and then click <\/span>Add.<\/strong><\/p>\n

        <\/div><\/div>\n","protected":false},"excerpt":{"rendered":"

        In the XO Platform, each Virtual Assistant contains a set of predefined error messages along with actions for standard HTTP Status codes returned for an HTTP Request method. In most cases, the default response and action are sufficient for an end-user response, however, you may need to handle other HTTP Status codes not defined by…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[65],"tags":[],"class_list":["post-21403","post","type-post","status-publish","format-standard","hentry","category-bot-settings"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/21403","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=21403"}],"version-history":[{"count":8,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/21403\/revisions"}],"predecessor-version":[{"id":47203,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/21403\/revisions\/47203"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=21403"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=21403"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=21403"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}