{"id":18044,"date":"2018-03-20T13:23:19","date_gmt":"2018-03-20T13:23:19","guid":{"rendered":"http:\/\/developer.kore.ai\/v10-1\/?post_type=docs&p=13546"},"modified":"2022-10-05T06:41:34","modified_gmt":"2022-10-05T05:41:34","slug":"mobile-sdk-push-notification","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/sdks\/mobile-sdk-push-notification\/","title":{"rendered":"Mobile SDK Push Notification"},"content":{"rendered":"

Kore.ai supports sending push notifications to mobile devices over the Mobile SDK channel.<\/span><\/p>\n

Kore mobile SDKs get embedded with the native host mobile application, which is responsible for managing push notification subscriptions with an APNS and GCM provider. The Host Mobile application server needs to host a webhook to receive updates from Kore.ai. It sends these updates as push notifications to the devices.<\/span><\/p>\n

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

Registering for Push Notification<\/span><\/span><\/h2>\n

To enable Push Notifications for your app, <\/span>follow the steps below:<\/span><\/p>\n

    \n
  1. In the XO Platform, go to <\/span>Deploy > Channels > Web\/Mobile SDK<\/strong>.<\/span><\/li>\n
  2. In the Web\/Mobile SDK channel window, select <\/span>Configure<\/strong>.<\/span><\/li>\n
  3. Enable the <\/span>Web\/Mobile Client <\/strong>if it is not enabled.<\/span><\/li>\n
  4. Expand <\/span>App Details<\/strong> and <\/span>select the app<\/strong> that you want to enable Push Notifications For.\u00a0<\/span><\/li>\n
      \n
    1. You can register your app at this point, by clicking <\/span>Add<\/strong>. <\/span>See <\/span>SDK App Registration<\/span><\/a> for details about registering an app with the XO Platform via the SDK.\u00a0<\/span><\/li>\n
    2. If your app is already registered, select it and click <\/span>Edit<\/strong>.\u00a0<\/span><\/li>\n<\/ol>\n
    3. On the <\/span>Create\/Edit APP <\/span><\/em>screen, click the <\/span>Enable<\/strong> checkbox.<\/span><\/li>\n
    4. In the box below, enter a URL to which the push notification should be sent.<\/span><\/li>\n<\/ol>\n

      \"\"<\/a><\/span><\/p>\n

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

      User Device Registration<\/span><\/span><\/h2>\n

      For each user who opts to receive the notification, the Mobile Application needs to send the device and user details to Kore.ai. Kore.ai sends device details and the user ID while making the webhook call.<\/p>\n

      Subscription API<\/h4>\n
        \n
      • Endpoint<\/strong>
        \n\n\n\n
        POST<\/strong><\/td>\nhttps:\/\/bots.kore.ai\/api\/users\/:userId\/sdknotifications\/subscribe<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n
      • Authorization Header<\/strong> authorization: \u201cbearer xxxxxxxxxxxxxxx\u201d <\/code><\/li>\n
      • Payload<\/strong>\n
        {deviceId : , (required)\r\nosType : ios  \/ android  (required)\r\n}<\/pre>\n<\/li>\n
      • Sample Request<\/strong>\n
        curl -X POST \\\r\n  https:\/\/bots.kore.ai\/api\/users\/u-46b5fdXXXXXXXXX-4b85347a38ea\/sdknotifications\/subscribe \\\r\n  -H 'authorization: bearer jmABumfQUt8AaMXXXXXXXXXXXXXXXXXz0hsvVI' \\\r\n  -H 'content-type: application\/json' \\\r\n  -d '  {\r\n         \"deviceId\" : \"device123\",\r\n         \"osType\" : \"ios\"\r\n          }'<\/pre>\n<\/li>\n<\/ul>\n
        Unsubscription API<\/h4>\n
          \n
        • Endpoint<\/strong>
          \n\n\n\n
          DELETE<\/strong><\/td>\nhttps:\/\/bots.kore.ai\/api\/users\/:userId\/sdknotifications\/unsubscribe<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n
        • Authorization Header<\/strong>  authorization: \u201cbearer xxxxxxxxxxxxxxx\u201d <\/code><\/li>\n
        • Payload<\/strong>\n
               {deviceId : , (required)\r\n      osType : ios  \/ android  (required)\r\n     }<\/pre>\n<\/li>\n
        • Sample Request<\/strong>\n
          curl -X DELETE \\\r\n  https:\/\/bots.kore.ai\/api\/users\/u-46b5fdXXXXXXXXX-4b85347a38ea\/sdknotifications\/unsubscribe \\\r\n  -H 'authorization: bearer jmABumfQUt8AaMXXXXXXXXXXXXXXXXXz0hsvVI' \\\r\n  -H 'content-type: application\/json' \\\r\n  -d '  {\r\n         \"deviceId\" : \"device123\",\r\n         \"osType\" : \"ios\"\r\n         }'<\/pre>\n<\/li>\n<\/ul>\n
          <\/div><\/div>\n","protected":false},"excerpt":{"rendered":"
          Kore.ai supports sending push notifications to mobile devices over the Mobile SDK channel. Kore mobile SDKs get embedded with the native host mobile application, which is responsible for managing push notification subscriptions with an APNS and GCM provider. The Host Mobile application server needs to host a webhook to receive updates from Kore.ai. It sends…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[36],"tags":[],"class_list":["post-18044","post","type-post","status-publish","format-standard","hentry","category-sdks"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18044","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=18044"}],"version-history":[{"count":5,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18044\/revisions"}],"predecessor-version":[{"id":48139,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18044\/revisions\/48139"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=18044"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=18044"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=18044"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}