In-App Messages

Navigate to Integrations -> Outbound Webhooks

In-App Delivery Receipts

  • Select the service you are sending the in-app messages from
  • Select the channel as in-app messaging
{
    
    "deliveryInfoNotification": {
        "deliveryInfo": {
            "deliveryChannel": "appmessaging",
            "Description": "Read",
            "destinationType": "customerid",
            "timeStamp": "2016-07-22T11:22:50.065",
            "code": "7502",
            "deliveryStatus": "Read",
            "deviceid": "355004057394234",
            "destination": "9876",
            "interaction": {
               "Button_Pressed": "SUBSCRIBE",
               "MessageRef": "123252445"
            }
        },
        "correlationid": "0322-4874-96e8-560292c115cb-3f8e656c",
        "callbackData": "return callbackdata",
        "transid": "3f8e656c-0322-4874-96e8-560292c115cb"
    }
}
{
  "deliveryInfoNotification":{
    "deliveryInfo":{
      "timeStamp":"2019-07-15T11:40:24.913Z",
      "Description":"Submitted",
      "code":"7501",
      "deliveryChannel":"rt",
      "additionalInfo":"",
      "destination":"9727",
      "destinationType":"userid",
      "deliveryStatus":"Submitted"
    },
    "subtid":"",
    "transid":"6a92d666-2eb9-42e7-b357-6c72d07a8a93",
    "callbackData":"",
    "correlationid":""
  }
}
{
  "deliveryInfoNotification":{
    "deliveryInfo":{
      "timeStamp":"2019-07-15T11:40:28.906Z",
      "Description":"Delivered",
      "code":"7500",
      "deliveryChannel":"rt",
      "additionalInfo":"",
      "destination":"9727",
      "destinationType":"userid",
      "deliveryStatus":"Delivered"
      },
    "subtid":"",
    "transid":"6a92d666-2eb9-42e7-b357-6c72d07a8a93",
    "callbackData":"",
    "correlationid":""
  }
}
{
  "deliveryInfoNotification":{
  "deliveryInfo":{
    "timeStamp":"2019-07-15T11:40:28.906Z",
    "Description":"Read",
    "code":"7502",
    "deliveryChannel":"rt",
    "additionalInfo":"",
    "destination":"9727",
    "destinationType":"userid",
    "deliveryStatus":"Read"
  },
    "subtid":"",
    "transid":"6a92d666-2eb9-42e7-b357-6c72d07a8a93",
    "callbackData":"",
    "correlationid":""
  }
}
{
  "deliveryInfoNotification":{
    "deliveryInfo":{
      "timeStamp":"2019-07-17T11:24:40.947Z",
      "pushId":"",
      "Description":"Customer profile not found",
      "code":"7105",
      "deliveryChannel":"rt",
      "destination":"9727",
      "destinationType":"",
      "deviceid":"",
      "deliveryStatus":"Failed"
    },
  "subtid":"",
  "transid":"7046f24a-65bf-4530-a095-3ddbaf39e213",
  "callbackData":"",
  "correlationid":""
  }
}

Field Name

Description

deliveryChannel

This is “Email” in case of a email

Description

Detailed description of the delivery status

destinationType

This contains the email id

timeStamp

Timestamp of the event

code

Status code as mentioned in the documentation

deliveryStatus

Status of the Email

destination

This contains the destination email id

correlationid

The CorrelationID is a unique identifier that you can attach to every request as a reference a particular transaction or event. This is configured as a part of the request

callbackData

Data that you have configured to receive on the notify Url. This is configured as a part of the request

transid

Unique transaction reference id of the request

In-App Incoming Messages & Events

  • Select the app that you expect to receive messages or events from as the Entity
{
  "userId": "8953",
  "channel": "Rtm",
  "appId": "SA28064527",
  "event": "MO",
  "message": "Simple text",
  "ts": "2015-04-12T13:00:19.456Z",
  "timeStamp" : "2015-04-12T13:00:19.456Z",
  "tid": "44003228-0498-4559-9342-c9e05c7fdfa6",
  "attachments": "",
  "replyTo": "28thJuly"
}
{
    "data": {
        "update": {
            "os": "Android",
            "model": "XT1068",
            "osversion": "5.0.2",
            "make": "motorola",
            "imei": "353325061572362",
            "useragent": "Mozilla\/5.0 (Linux; Android 5.0.2; XT1068 Build\/LXB22.46-28; wv) AppleWebKit\/537.36 (KHTML, like Gecko) Version\/4.0 Chrome\/43.0.2357.121 Mobile Safari\/537.36",
            "language": "English",
            "resolution": "720x1184",
            "timezone": "India Standard Time",
            "teleco": "",
            "roaming": "0",
            "serialnumber": "ZX1D637KJM",
            "internalmemory": "13,091MB",
            "externalmemory": "13,091MB",
            "RAM": "888MB",
            "NFC": "0",
            "Bluetooth": "1"
        }
    },
    "appId": "AP04045412",
    "state": "Register",
    "userId": "1000",
    "deviceId": "353325061572362",
    "pushId": "APA91bErLXMGhNyDByQlIgQjtGJhLsInOMTEhJqDiBH8fxM4g_U5cL_KNLooe_TSXRszM-5EySaTlfGKORAHWuFqL9ibZkXGXyHayw-m5iX2aHJ05gEM8HKJ6J1O8HjGY0cubLht4yTg"
}
{
    "appId": "PU30063045",
    "clientId": "PU30063045/1889/355004053370915",
    "data": {
        "update": {
            "location": [17.434709, 78.3985573],
            "oldlocation": [17.4347098, 78.3985558]
        }
    },
    "deviceId": "355004053370915",
    "event": "LOCATIONCHANGE",
    "userId": "1889"
}
{
   "appId":"PU30063045",
   "clientId":"PU30063045/1889/355004053370915",
   "data":{
      "update":{
         "teleco":"airtel",
         "MCC":"404",
         "MNC":"49",
         "imsi":"404466006777"
      }
   },
   "deviceId":"355004053370915",
   "event":"NETWORKCHANGE",
    "userId":"1889"
}
{
    "appId": "PU30063045",
    "clientId": "PU30063045/1889/355004053370915",
    "data": {
        "update": {
            "timezone": "India Standard Time",
            "location": [17.4347098, 78.3985558]
        }
    },
    "deviceId": "355004053370915",
    "event": "TIMEZONECHANGE",
    "userId": "1889"
}
{
   "appId":"SP15163316",
   "clientId":"SP15163316/1010/567D9BD2EA4D4EF78C560888AD600C0A",
   "data":{
      "update":{
         "roaming":1,
         "location":[ 17.4347098, 78.3985558]   
      }
   },
   "deviceId":"567D9BD2EA4D4EF78C560888AD600C0A",
   "event":"ROAMINGCHANGE",
    "userId":"1010"
}
{
   "clientId":"",
   "userId":"1000",
   "appId":"AP04045412",
   "deviceId":"353325061572362",
   "event":"ProfileUpdate",
   "state":"PROFILEUPDATE",
   "data":{
      "update":{
         "idlescreen":"1"
      }
   }
}
{
   "clientId":"",
   "userId":"1000",
   "appId":"AP04045412",
   "deviceId":"353325061572362",
   "event":"ProfileUpdate",
   "state":"PROFILEUPDATE",
   "data":{
      "update":{
         "batterylevel":"85.0%"
      }
   }
}
{
   "clientId":"",
   "userId":"1000",
   "appId":"AP04045412",
   "deviceId":"353325061572362",
   "event":"ProfileUpdate",
   "state":"PROFILEUPDATE",
   "data":{
      "update":{
         "foregroundapp":"com.imimobile.www.rtmapp"
      }
   }
}
{
   "clientId":"",
   "userId":"1000",
   "appId":"AP04045412",
   "deviceId":"353325061572362",
   "event":"ProfileUpdate",
   "state":"PROFILEUPDATE",
   "data":{
      "update":{
         "foreground":"1",
         "last_opened":"2014-02-28 07:25:25"
      }
   }
}
{
   "clientId":"",
   "userId":"1000",
   "appId":"AP04045412",
   "deviceId":"353325061572362",
   "event":"ProfileUpdate",
   "state":"PROFILEUPDATE",
   "data":{
      "update":{
         "phonemode":"vibrate"
      }
   }
}
{
    "appId": "SP15163316",
    "event": "ProfileUpdate",
    "userId": "2162",
    "state": "PROFILEUPDATE",
    "data": {
        "update": {
            "signalstrength": "-77"
        }
    },
    "clientId": "",
    "deviceId": "358240059476333"
}
{
   "appId":"PR29114917",
   "event":"OnProfileUpdate",
   "userId":"2008",
   "state":"PROFILEUPDATE",
   "data":{
      "update":{
         "IP":"192.168.2.105"
      }
   },
   "clientId":"",
   "deviceId":"353325069299604"
}
{   
   "appId":"FO11122834",   
   "event":"OnProfileUpdate",
   "userId":"100019",
   "data":{
      "update":{
         "MAC":"CC:C3:EA:FF:48:A5"
      }
   },
   "state":"PROFILEUPDATE",
   "deviceId":"353217051341173",
   "clientId":""
}
{   
   "appId":"SP15163316",
   "event":"OnProfileUpdate",
   "userId":"9999",
   "state":"PROFILEUPDATE",
   "data":{
      "update":{
         "cellid":"46152"
      }
   },
   
   "clientId":"",
   "deviceId":"867290027958296",
}
{
   
   "appId":"SP15163316",   
   "event":"OnProfileUpdate",
   "userId":"9999",
   "state":"PROFILEUPDATE",
   "data":{
      "update":{
         "connectType":"network.EDGE"
      }
   },   
   "clientId":"",
   "deviceId":"867290027958296"
}