{"id":32092,"date":"2022-01-25T14:29:21","date_gmt":"2022-01-25T14:29:21","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=32092"},"modified":"2023-03-10T15:13:38","modified_gmt":"2023-03-10T15:13:38","slug":"proactive-notifications-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/proactive-notifications-api\/","title":{"rendered":"Proactive Notifications API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Proactive Notifications allow enterprises to engage with their end users (customers or employees) by providing relevant and timely updates.<\/p>\n

Proactive notification includes:<\/p>\n

    \n
  • Nudge the employees to reset their password before it expires in certain days<\/li>\n
  • Remind users to submit expense reports.<\/li>\n
  • Inform customers about their order status. <\/li>\n
  • Other reminders which are defined.<\/li>\n<\/ul>\n\n\n\n\n\n\n\n
    Method<\/b><\/td>\nPOST<\/td>\n<\/tr>\n
    Endpoint<\/b><\/td>\n\n

    https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/notify<\/code><\/p>\n

    <\/span><\/td>\n<\/tr>\n

    Content Type<\/b><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
    Authorization<\/b><\/td>\n\n

    auth: {{JWT}}<\/code><\/p>\n

    See How to generate the JWT Token<\/a>.<\/td>\n<\/tr>\n

    API Scope<\/b><\/td>\n\n
      \n
    • Bot Builder: Proactive Messages<\/li>\n
    • Admin Console: Channel Management > Proactive Messages<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
      \r\n\t\t
      \r\n\t\t\t

       <\/p>\n

      Path Parameters<\/span><\/h2>\n\n\n\n\n\n
      Parameter<\/b><\/th>\nDescription<\/b><\/th>\nMandate<\/b><\/th>\n<\/tr>\n
      host<\/b><\/td>\nThe environment URL. For example, https:\/\/bots.kore.ai<\/code><\/td>\nRequired<\/td>\n<\/tr>\n
      BotId<\/b><\/td>\n\n

      Bot ID<\/i> or Stream ID<\/i> can be accessed under General Settings<\/b> on the Bot Builder.<\/p>\n

      Note<\/b>: This is required only for Bot Builder API scope of Proactive Messages.<\/td>\n

      		Required<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
      \r\n\t\t
      \r\n\t\t\t

       <\/p>\n

      Sample Request<\/span><\/h2>\n
      curl --location --request \r\nPOST \\' https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/notify' \\\r\n--header 'auth: {{JWT}}' \\\r\n--header 'Content-Type: application\/json' \\\r\n--data-raw '{\r\n    \"channel\": \"msteams\",\r\n    \"userIdentityType\": \"resolve\",\r\n    \"message\": {\r\n        \"type\": \"text\",\r\n        \"val\": \"hello\"\r\n    },\r\n    \"identities\": [\r\n        \"john@kore.com\",\r\n        \"jane@outlook.com\",\r\n        \"sam@slack.com\"\r\n    ]\r\n}'\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
      \r\n\t\t
      \r\n\t\t\t
       <\/p>\n
      Body Parameters<\/span><\/h2>\n\n\n\n\n\n\n\n
      Parameter<\/b><\/th>\nDescription<\/b><\/th>\nMandate<\/b><\/th>\n<\/tr>\n
      channel<\/td>\n\n
      Name of the channel for which notifications to be sent<\/p>\n
      Accepted channel types are:\u201cmsteams<\/strong>\u201d and “slack<\/strong>“.<\/td>\n
      		Required<\/td>\n<\/tr>\n
      userIdentityType<\/td>\n\n
      Define whether to resolve the user identities provided in the API call to get the channel identities, or to directly use the user identities for delivering the messages<\/p>\n
      The values is resolve<\/em>.<\/td>\n
      		Required<\/td>\n<\/tr>\n
      message<\/td>\n\n
      It is an object and accepts two fields<\/p>\n
        \n
      • type<\/em> \u2192 Indicates the type of message. \u201ctext\u201d for sending plain text and \u201cscript\u201d for sending JavaScript templates as messages.<\/li>\n
      • val<\/em> \u2192 value of the message to be sent to user.<\/li>\n<\/ul>\n
        Example 1:Text<\/strong>:
        \n{
        \n\"type\": \"text\",
        \n\"val\": \"Hi User\"
        \n}<\/code><\/p>\n
        Example 2: Script<\/strong>:<\/p>\n
        {
        \n\"type\": \"script\",
        \n\"val\": \"var envMsg = 'John'; var channel = context.session.BotUserSession.lastMessage.channel; print(JSON.stringify({text: 'Hi ' + envMsg + ' message is from ' + channel + ' channel'}));\"
        \n}<\/code><\/td>\n
      		Required<\/td>\n<\/tr>\n
      identities<\/td>\n\n
      It accepts the list of user identities for whom notifications need to be sent.<\/p>\n
      A maximum of 1000 identities are supported.<\/td>\n
      		Required<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
      \r\n\t\t
      \r\n\t\t\t
       <\/p>\n
      Sample Response<\/span><\/h2>\n
      {\r\n    \"status\": \"IN_PROGRESS\",\r\n    \"percentageComplete\": 0,\r\n    \"streamId\": \"st-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n    \"createdBy\": \"u-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n    \"jobType\": \"PROACTIVE_NOTIFICATIONS_API\",\r\n    \"action\": \"PROACTIVE_NOTIFICATIONS\",\r\n    \"statusLogs\": [],\r\n    \"_id\": \"ds-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n    \"lMod\": \"2022-01-25T06:56:48.000Z\",\r\n    \"createdOn\": \"2022-01-25T06:56:48.891Z\",\r\n    \"requestedTime\": \"2022-01-25T06:56:48.891Z\",\r\n    \"__v\": 0\r\n}\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
      <\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>
      \r\n\t
      \r\n\t\t
      \r\n\t\t\t\r\n\t\t<\/div>\r\n\t<\/div>\r\n<\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"Proactive Notifications allow enterprises to engage with their end users (customers or employees) by providing relevant and timely updates. Proactive notification includes: Nudge the employees to reset their password before it expires in certain days Remind users to submit expense reports. Inform customers about their order status. Other reminders which are defined. Method POST Endpoint...","protected":false},"author":17,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-32092","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/32092","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\/17"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=32092"}],"version-history":[{"count":7,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/32092\/revisions"}],"predecessor-version":[{"id":55805,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/32092\/revisions\/55805"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=32092"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=32092"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=32092"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}