Data Streams - WhatsApp

WhatsApp - Inbound Message

{
  "attachments": "[]",
  "channel": "WhatsApp",
  "dataIntegration": {
      "context": {
		"serviceId": "4xxx3",
		"serviceName": "Appointment Booking",
		"flowId": "xxx",
		"flowName": "Doctor Appointment ",
		"messagingAPI": "False",
		"Key": "Value", // added in the send or receive or start nodes
		"Key2": "Value2" added in the send or receive or start nodes
		},
    "appContext": {
      "key1": "Value2",
      "tenant_identifier": "dummy_tenant"
    }
  },
  "message": "xxxx",
  "userId": "",
  "tid": "xxxx",
  "waid": "xxxx",
  "datetime": "2022-01-1xxxx:52:12.980Z",
  "system": "",
  "appId": "xxxx",
  "location": "",
  "event": "MO",
  "contacts": "[]",
  "ts": "2022-01-xxxx:52:12.980Z",
  "username": ""
}
{
  "buttonText": "Yes",
  "transid": "9b2bc6ca-xxxx-49e4-8450-xxxx150ac78b_0",
  "channel": "WhatsApp",
  "dataIntegration": {
    "context": {
      "serviceId": "",
      "serviceName": "",
      "flowId": "",
      "flowName": "",
      "messagingAPI": "false"
    },
    "appContext": {
      "tenant_identifier": "xxxx",
      "Topic": "ClientstagingTopic",
      "URL": "b-1.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096,b-3.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096,b-2.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096",
      "webhookurl": "https://integrations.imiconnect.co/v1/integration/"
    }
  },
  "userId": "",
  "tid": "9b2bc6ca-xxxx-49e4-xxxx-c9ef150ac78b_0",
  "clientUUID": "0a4a1900-xxxx-4385-xxxx-5ef0927d6683",
  "x-wx-gtrid": "0cce6129-xxxx-4c0e-xxxx-fe9bffee04d5",
  "waid": "919963585090",
  "appId": "a_171931xxxx79979870",
  "event": "postback",
  "errors": "",
  "identityKeyHash": "",
  "ts": "2024-11-xxxx:23:52.672+05:30",
  "buttonPayload": "Yes",
  "username": ""
}
{
  "attachments": "[]",
  "channel": "WhatsApp",
  "dataIntegration": {
      "context": {
		"serviceId": "xxxx3",
		"serviceName": "Appointment Booking",
		"flowId": "xxxx",
		"flowName": "Doctor Appointment ",
		"messagingAPI": "False",
		"Key": "Value", // added in the send or receive or start nodes
		"Key2": "Value2" added in the send or receive or start nodes
		},
    "appContext": {
      "key1": "Value2",
      "tenant_identifier": "dummy_tenant"
    }
  },
  "message": "dummy_data",
  "userId": "dummy_data",
  "tid": "dummy_data",
  "waid": "dummy_data",
  "datetime": "2022-01-xxxx:56:43.889Z",
  "system": "",
  "appId": "dummy_data",
  "location": "",
  "event": "MO",
  "contacts": "[]",
  "ts": "2022-01-xxxx:56:43.889Z",
  "username": ""
}
{
  "attachments": "[{\"mime_type\":\"image/jpeg\",\"url\":\"https://webex-encryption.s3.amazonaws.com/0e9e69f6-a01d-49a2-acce-5d925a1591f81199856637771074.jpg?keyUri=kms%3A%2F%2Fkms-us-int.wbx2.com%2Fkeys%2F8d6d02a1-de41-4dd4-ae83-01d5d35f0b6d&JWE=eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiZGlyIn0..KCw9tj9wm8AWgB05.V-_XEG_CFbqZ6Da04FuJDPHKFIK_jEl8Lp-o_LkNUCbhqYZAsuANJfQwHddZBIXihehfuNUzfZbdfmNFUvwEvlgy69ga8dDHhu5IEJnIJ0SCdFbqpJRVJaYmDTwO22qRKz-sIYEUewe6gLrudg03Y9VVUQZtsXf94pH-Gk5VAN7g-NmyOsq6LWJWPwzouPpbHv6IBxerqoZDNHlPH1-9QChHGlbd9kVr5Fh62ZdDs1-Tz2KOXiMVNq07FBu-uWYE-3ogPIX1LFCpx4A7asr5RUf-3KWG8cj3VJCLEAzsmLMeabs21rt8jB08pLfHcNO_kxa4imVJxSF1I5c6D2HKPE5YQ3BuNG5r.BxuYpvin0UdXU_uzNuno9w\"}]",
  "transid": "abf75926-xxxx-473a-xxxx-74264e231a7a_0",
  "channel": "WhatsApp",
  "dataIntegration": {
    "context": {
      "serviceId": "",
      "serviceName": "",
      "flowId": "",
      "flowName": "",
      "messagingAPI": "false"
    },
    "appContext": {
      "tenant_identifier": "xxxx1",
      "Topic": "DummyTopic",
      "URL": "b-1.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096,b-3.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096,b-2.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096 ClientstagingTopic",
      "webhookurl": "https://integrations.imiconnect.co/v1/integration/"
    }
  },
  "message": "",
  "type": "image",
  "userId": "",
  "tid": "abf75926-xxxx-473a-xxxx-74264e231a7a_0",
  "clientUUID": "0a4a1900-98ef-4385-b9f9-5ef0927d6683",
  "x-wx-gtrid": "a22e7327-96d6-4bc8-b8fb-dbb1937cc81c",
  "waid": "919xxxx85090",
  "system": "",
  "appId": "a_171xxxx82679979870",
  "location": "",
  "event": "MO",
  "contacts": "[]",
  "identityKeyHash": "",
  "ts": "2024-11-xxxx:43:57.904+05:30",
  "username": ""
}
{
  "attachments": "[{\"mime_type\":\"video/mp4\",\"url\":\"https://xxxx.s3.amazonaws.com/46cd1f72-xxxx-xxxx-b9f0-43899275e58e57xxxx175296214.mp4?keyUri=kms%3A%2F%2Fkms-us-int.wbx2.com%2Fkeys%2F8d6d02a1-de41-4dd4-ae83-01d5d35f0b6d&JWE=eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiZGlyIn0..uyVQOdDUyohCgdg6.o-CviIJDtx33mX1LRdwX0keRz3NQgtsCGL7Lqk7ETaaSdYG2XU1Ub0z1js_S-I0ksrf13K3nCY5wBV0b1Kg8R6d9i4gQ-dClirk0SAWq5Yg8uyUufthofEZ6KvT6g9DlXjfmxQcG-5fZKVpiIMwHQuUCqugNITewOygb1zBPStf0_6f2pAcb-mDs2ZwpRU6ZHaU6mOPGGxxfmE5vIIm4kGhGr2fdDPg1JgoHPS81JEI6ABAVuOLgXX1XFfl0s-PQX_6NQWep-o3Y1wYlE1ziv_jS4pIRjPT-VWKDURUJ_zD6O7QFtx5du5rW78e0upsEIHNjYnMxzP5gpvLXGwNv9eZR5p0EA6o.xEvTC_qcRiUD79XfwWi_ig\"}]",
  "transid": "3ae531c2-xxxx-41d2-xxxx-d1881c0aad25_0",
  "channel": "WhatsApp",
  "dataIntegration": {
    "context": {
      "serviceId": "",
      "serviceName": "",
      "flowId": "",
      "flowName": "",
      "messagingAPI": "false"
    },
    "appContext": {
      "tenant_identifier": "xxxx",
      "Topic": "ClientstagingTopic",
      "URL": "b-1.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:xxxx,b-3.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096,b-2.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096",
      "webhookurl": "https://integrations.imiconnect.co/v1/integration/"
    }
  },
  "message": "",
  "type": "video",
  "userId": "",
  "tid": "3ae531c2-xxxx-41d2-xxxx-d1881c0aad25_0",
  "clientUUID": "0a4a1900-98ef-4385-b9f9-5ef0927d6683",
  "x-wx-gtrid": "170ca2ac-0097-47b7-9c10-3bf9e1341c90",
  "waid": "919xxxx85090",
  "system": "",
  "appId": "a_1719316xxxx9979870",
  "location": "",
  "event": "MO",
  "contacts": "[]",
  "identityKeyHash": "",
  "ts": "2024-11-xxxx:10:00.448+05:30",
  "username": ""
}
{
  "attachments": "[{\"mime_type\":\"audio/ogg; codecs=opus\",\"url\":\"https://webex-encryption.s3.amazonaws.com/cac660ef-a185-4da5-850d-52fabff9017f950308086963922.ogg?keyUri=kms%3A%2F%2Fkms-us-int.wbx2.com%2Fkeys%2F8d6d02a1-de41-4dd4-ae83-01d5d35f0b6d&JWE=eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiZGlyIn0..-7mB9BaZVLo52Qh9.vlxFwIOMPLPvE1V1l5VwDpU5KYi-NhotZc6Bwn0Ffue_kgcaDu73fgHdbaZFH-wy3DC_XidLyjhBlcgWssY2eEg0O5bcPj96Em4vv3HJUqVEYTzePg8sSvMwhK8yyrEcFOtPgM4wrWwfI6hyurC15NNzMKkyAhhZar4_5kEcg6l7CHhBd41v4t_1Y72jikE0oWSiO-W9uSepAfNCnI5SxACG9x9LCEYMKdfaDcjrOoiUf3I3Wcbi_dDoJEcfQkBGh28DqjP0bKfbdN0uKO-12P6tC2A0nemKoOcduIeF8NZUxaqRgZeP3_48oRi9MpnNvqPHb_41arVFvI6eAwP3OLiOKCGv_QE.3FWXPBgQ8bZdydmdbyHE7A\"}]",
  "transid": "d02004fb-xxxx-433c-xxxx-9e79ee17c212_0",
  "channel": "WhatsApp",
  "dataIntegration": {
    "context": {
      "serviceId": "",
      "serviceName": "",
      "flowId": "",
      "flowName": "",
      "messagingAPI": "false"
    },
    "appContext": {
      "tenant_identifier": "asxxxxdf",
      "Topic": "WEEEE"
    }
  },
  "message": "",
  "type": "audio",
  "userId": "",
  "tid": "d02004fb-xxxx-433c-xxxx-9e79ee17c212_0",
  "clientUUID": "0a4a1900-xxxx-4385-xxxx-5ef0927d6683",
  "x-wx-gtrid": "776ca065-xxxx-437c-xxxx-10419a5a8d7c",
  "waid": "919xxxx85090",
  "system": "",
  "appId": "a_17193xxxx679979870",
  "location": "",
  "event": "MO",
  "contacts": "[]",
  "identityKeyHash": "",
  "ts": "2024-11-xxxx:47:10.807+05:30",
  "username": ""
}
{
  "attachments": "[]",
  "transid": "5b32807a-xxxx-45b5-xxxx-e4dc9ad7e42e_0",
  "channel": "WhatsApp",
  "dataIntegration": {
    "context": {
      "serviceId": "",
      "serviceName": "",
      "flowId": "",
      "flowName": "",
      "messagingAPI": "false"
    },
    "appContext": {
      "tenant_identifier": "cxxxx2",
      "Topic": "xxxxTopic",
      "URL": "b-1.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096,b-3.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096,b-2.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096",
      "webhookurl": "https://integrations.xxxx.co/xx/integration/"
    }
  },
  "message": "",
  "type": "location",
  "userId": "",
  "tid": "5b32807a-xxxx-45b5-xxxx-e4dc9ad7e42e_0",
  "clientUUID": "0a4a1900-xxxx-4385-xxxx-5ef0927d6683",
  "x-wx-gtrid": "79adc288-xxxx-4b3c-xxxx-9776bbf5aa6d",
  "waid": "919xxxx85090",
  "system": "",
  "appId": "a_1719316xxxx9979870",
  "location": "{\"address\":\"2nd Floor, The Skyview 10, Hyderabad, TG 500081\",\"xxxx\":\"17.4xxxx743042\",\"name\":\"Cowrks\",\"url\":\"https://foursquare.com/v/631030f0472b2823c72015f8\",\"longitude\":\"78.375427246094\"}",
  "event": "MO",
  "contacts": "[]",
  "identityKeyHash": "",
  "ts": "2024-11-xxxx:15:28.002+05:30",
  "username": ""
}
{
  "attachments": "[]",
  "transid": "5b7786c5-xxxx-4df8-xxxx-db92ab793a1b_0",
  "channel": "WhatsApp",
  "dataIntegration": {
    "context": {
      "serviceId": "",
      "serviceName": "",
      "flowId": "",
      "flowName": "",
      "messagingAPI": "false"
    },
    "appContext": {
      "tenant_identifier": "cxxxxa2",
      "Topic": "xxxxTopic",
      "URL": "b-1.dev-campaign-integrat.xxxx.c20.kafka.us-east-1.amazonaws.com:xxxx,b-3.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096,b-2.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096",
      "webhookurl": "https://integrations.xxxx.co/xxxx/integration/"
    }
  },
  "message": "",
  "type": "contacts",
  "userId": "",
  "tid": "5b7786c5-xxxx-4df8-xxxx-db92ab793a1b_0",
  "clientUUID": "0a4a1900-xxxx-4385-xxxx-5ef0927d6683",
  "x-wx-gtrid": "3d6cb0b0-xxxx-442b-xxxx-da042c7be81f",
  "waid": "91xxxx585090",
  "system": "",
  "appId": "a_171931xxxx79979870",
  "location": "",
  "event": "MO",
  "contacts": "[{\"birthday\":\"xxxx-12-03\",\"emails\":[{\"type\":\"HOME\",\"email\":\"[email protected]\"}],\"addresses\":[{\"zip\":\"502032\",\"country\":\"India\",\"city\":\"Hyderabad\",\"street\":\"Temple\\\\r\\\\nMain Road\",\"state\":\"Ta\",\"type\":\"HOME\"}],\"org\":{\"company\":\"imi\"},\"name\":{\"last_name\":\"Smith\",\"first_name\":\"John\",\"formatted_name\":\"John Smith\"},\"phones\":[{\"phone\":\"+9199634589123\",\"type\":\"HOME\"},{\"phone\":\"+886 3 589 4612\",\"type\":\"WORK\"}]}]",
  "identityKeyHash": "",
  "ts": "2024-11-xxxx:16:57.506+05:30",
  "username": ""
}
{
  "attachments": "[{\"sticker\":{\"metadata\":{},\"xxxx\":\"zWIntfn/2OA3Rbhe4nMS9xnK7a8M9WpasYBjDjiy4K8=\",\"mime_type\":\"image/webp\",\"id\":\"1700910053813320\"},\"url\":\"https://webex-encryption.s3.amazonaws.com/53e33ab2-0857-48f4-8654-09e763740e511700910053813320.webp?keyUri=kms%3A%2F%2Fkms-us-int.wbx2.com%2Fkeys%2F8d6d02a1-de41-4dd4-ae83-01d5d35f0b6d&JWE=eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiZGlyIn0..Sp7aJCPjaGVYo0pJ.Dnn_fHJSc1M-otZVxydssgpNaKWCGA9iFXZ2TdsWX_OKutwHBZ1a-2EEmuGWb8fsoFnMERWpBiG3t5OXwxQ-7seNBWIDGbiaejPFEemyViDPVMOgitwpat0ZYuOASVAAecVzRgzuSDj3hpQect44Nlj9aQRK9luBJ1LZVgASLynBQIfhHM_fSKw5g8Ly4FVGJb9z3jy8ixuqm0yr00f7LSeRs8Qei11oaLgXwUmMFXqheWvEwuSG4A9WcZpgp9JO6p_ANyVQvb5hwYRfd9K9rsPOW-qFe9Dnj1a4DuZz_nnOaYNlgK9hO0mkR2deIcjWEESl7Y2MpOJ8pY1EaNf_Ev5OC6f4nE2k1g.LNwMBThgWELqCjjSF2F1tQ\"}]",
  "transid": "d3d0e43a-xxxx-41fe-xxxx-12e7c8285fcc_0",
  "channel": "WhatsApp",
  "dataIntegration": {
    "context": {
      "serviceId": "",
      "serviceName": "",
      "flowId": "",
      "flowName": "",
      "messagingAPI": "false"
    },
    "appContext": {
      "tenant_identifier": "cxxxxa2",
      "Topic": "xxxxTopic",
      "URL": "b-1.dev-campaign-integrat.xxxx.c20.kafka.us-east-1.amazonaws.com:xxxx,b-3.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096,b-2.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096",
      "webhookurl": "https://integrations.xxxx.co/v1/integration/"
    }
  },
  "message": "",
  "type": "sticker",
  "userId": "",
  "tid": "d3d0e43a-xxxx-41fe-xxxx-12e7c8285fcc_0",
  "clientUUID": "0a4a1900-xxxx-4385-xxxx-5ef0927d6683",
  "x-wx-gtrid": "67f0475c-xxxx-417e-xxxx-402f0a1ae69b",
  "waid": "91xxxx585090",
  "system": "",
  "appId": "a_1719316xxxx9979870",
  "location": "",
  "event": "MO",
  "contacts": "[]",
  "identityKeyHash": "",
  "ts": "2024-11-xxxx:14:00.244+05:30",
  "username": ""
}
{
  "transid": "6d7c6bfa-xxxx-460e-xxxx-25b4f9a03e1d_0",
  "channel": "WhatsApp",
  "listRowTitle": "Row3",
  "dataIntegration": {
    "context": {
      "serviceId": "",
      "serviceName": "",
      "flowId": "",
      "flowName": "",
      "messagingAPI": "false"
    },
    "appContext": {
      "tenant_identifier": "xxxx",
      "Topic": "xxxxTopic",
      "URL": "b-1.dev-campaign-integrat.xxxx.c20.kafka.us-east-1.amazonaws.com:xxxx,b-3.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096,b-2.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096",
      "webhookurl": "https://integrations.xxxx.co/v1/integration/"
    }
  },
  "contextId": "wamid.HBgMOTE5OTYzNxxxxDkwFQIAERgSMDk0QTYyMEZFRkY2M0Q0QTFDAA==",
  "userId": "",
  "tid": "6d7c6bfa-xxxx-xxxx-xxxx-25b4f9a03e1d_0",
  "clientUUID": "0a4a1900-xxxx-4385-xxxx-5ef0927d6683",
  "x-wx-gtrid": "f561bf88-xxxx-46bf-xxxx-2953bda6cf19",
  "waid": "9199xxxx5090",
  "listRowIdentifier": "id3",
  "appId": "a_1719316xxxx9979870",
  "listRowDescription": "desc3",
  "event": "list",
  "identityKeyHash": "",
  "ts": "2024-11-xxxx:30:49.276+05:30",
  "username": ""
}
{
  "transid": "2ae8ccd3-xxxx-4fdc-xxxx-c1ba6942ef7e_0",
  "channel": "WhatsApp",
  "dataIntegration": {
    "context": {
      "serviceId": "",
      "serviceName": "",
      "flowId": "",
      "flowName": "",
      "messagingAPI": "false"
    },
    "appContext": {
      "tenant_identifier": "xxxx",
      "Topic": "xxxxTopic",
      "URL": "b-1.dev-campaign-integrat.xxxx.c20.kafka.us-east-1.amazonaws.com:xxxx,b-3.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096,b-2.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096",
      "webhookurl": "https://integrations.imiconnect.co/v1/integration/"
    }
  },
  "contextId": "wamid.HBgMOTE5OTYzNTg1MxxxxQIAERgSODY3NzcyMTZGMDEyOTM2NkRFAA==",
  "replyButtonTitle": "Replt1",
  "userId": "",
  "tid": "2ae8ccd3-xxxx-4fdc-xxxx-c1ba6942ef7e_0",
  "clientUUID": "0a4a1900-xxxx-4385-xxxx-5ef0927d6683",
  "x-wx-gtrid": "2e310755-xxxx-4eba-xxxx-d690ffb34d75",
  "waid": "919963xxxx90",
  "appId": "a_17193168xxxx979870",
  "replyButtonIdentifier": "R1",
  "event": "reply",
  "identityKeyHash": "",
  "ts": "2024-11-xxxx:33:44.763+05:30",
  "username": "xxxx"
}

WhatsApp - Inbound Message Descriptions

Field NameDescriptions
attachmentsThe WhatsApp attachment details
channelThe value is 'WhatsApp'
dataIntegrationThe object contains key-value pairs which are added either by Data Stream admin or in flow and also app context object.
contextThe object contains key-value pairs which are added either by Data Stream admin or in flow.
serviceIdContains the unique reference id of the service.
serviceNameContains the name of the service.
flowIdContains the unique ID for the flow.
flowNameContains the name of the flow.
messagingAPIIndicates whether the request is sent through the Send Message API.
appContextThe object is added as key-value pair either by Data Stream admin or in flow.
tenant_identifierContains the unique reference ID of the tenant.
userIdUnique identification number of the user.
tidContains the transaction id.
waidContains the unique WhatsApp for Business account ID.
datetimeData and Time on which the message is received.
appIdContains the application ID.
location
eventContains the type of incoming event.
contacts
tsTimestamp when the incoming message is sent to the platform.
usernameUnique name of the user.

WhatsApp - Delivery Receipt

{
  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2022-01-12T14:38:12.539+05:30",
      "Description": "Delivered",
      "code": "7500",
      "deliveryChannel": "whatsapp",
      "additionalInfo": "",
      "destination": "dummy_data",
      "destinationType": "waid",
      "deliveryStatus": "Delivered"
    },
    "subtid": "dummy_data",
    "transid": "dummy_data",
    "callbackData": "",
    "correlationid": ""
  },
    "dataIntegration": {
      "context": {
        "Key": "Value",
        "Key2": "Value2"
      },
      "appContext": {
        "adminKey": "",
        "tenant_identifier": "dummyTenant"
      }
    }
  }
}
{
  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2022-01-12T14:38:12.539+05:30",
      "Description": "Read",
      "code": "7502",
      "deliveryChannel": "whatsapp",
      "additionalInfo": "",
      "destination": "dummy_data",
      "destinationType": "waid",
      "deliveryStatus": "Read"
    },
    "subtid": "afe1daab-1d7b-4c4d-80a3-0986ba042a27",
    "transid": "ad1efed4-f199-4ab2-abb0-2b187846c3c8",
    "callbackData": "",
    "correlationid": ""
  },
  "dataIntegration": {
    "dataIntegration": {
      "context": {
        "Key": "Value",
        "Key2": "Value2"
      },
      "appContext": {
        "adminKey": "",
        "tenant_identifier": "dummyTenant"
      }
    }
  }
}

  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2022-01-12T14:38:01.712+05:30",
      "Description": "Submitted",
      "code": "7501",
      "deliveryChannel": "whatsapp",
      "additionalInfo": "",
      "destination": "dummy_data",
      "destinationType": "waid",
      "deliveryStatus": "Submitted"
    },
    "subtid": "dummy_data",
    "transid": "dummy_data",
    "callbackData": "",
    "correlationid": ""
  },
  "dataIntegration": {
    "dataIntegration": {
      "context": {
        "Key": "Value",
        "Key2": "Value2"
      },
      "appContext": {
        "adminKey": "",
        "tenant_identifier": "dummyTenant"
      }
    }
  }
}
{
  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2022-01-12T17:35:02.357+05:30",
      "Description": "Failed to upload media",
      "code": "7738",
      "deliveryChannel": "whatsapp",
      "additionalInfo": "Failed to upload media",
      "destination": "dummy_data",
      "destinationType": "waid",
      "deliveryStatus": "Failed"
    },
    "subtid": "dummy_data",
    "transid": "dummy_data",
    "callbackData": "",
    "correlationid": ""
  },
  "dataIntegration": {
    "dataIntegration": {
      "context": {
        "Key": "Value",
        "Key2": "Value2"
      },
      "appContext": {
        "adminKey": "",
        "tenant_identifier": "dummyTenant"
      }
    }
  }
}

WhatsApp - Delivery Receipt Descriptions

Field NameDescription
deliveryInfoNotificationSystem variable
deliveryInfoSystem variable
timeStampTimestamp of the event
DescriptionDetailed description of the delivery status.
codeStatus code as mentioned in the documentation
deliveryChannelChannel to be used to send message
additionalInfoAdditional info such as details about the browser used to open a link in case of Click events.
destinationThe mobile number to which message will be sent.
destinationType
deliveryStatusStatus of messages once sent
subtidA unique transaction id will be generated as subtid for the flow level transactions(or node tid).
transidUnique transaction reference id of the request.
callbackDataData that you have configured to receive on the notify Url. This is configured as a part of the request
correlationidThe 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.
dataIntegrationThe object contains key-value pairs which are added either by Data Stream admin or in flow and also app context object.
contextThe object contains key-value pairs which are added either by Data Stream admin or in flow.
Key
Key2
appContextThe object is added as key-value pair either by Data Stream admin or in flow.
adminKey
tenant_identifierContains the unique reference ID of the tenant.

WhatsApp - Outbound Message

{
  "extraparams": {
    "authkey": "XXX",
    "connect_message_id": "XXX",
    "x_req_origin_time": "2022-02-04 17:19:23.378",
    "channel": 8,
    "destination": "919949452221",
    "main_tid": "XXX",
    "tid": "XX",
    "sid": "17218_10926",
    "report_info": {
      "request_source": 3,
      "source_tid": "XXX"
    },
    "routerName": "",
    "outbound_notification_events": "",
    "routerId": "",
    "noOfMessages": 1,
    "nodetid": "94be7d8c-3165-4131-88ab-1c39789ff46d",
    "destinationType": "waid",
    "sourceOriginTime": "2022-02-04T17:19:19.449Z",
    "messagePriority": 1,
    "sfeSessionInfo": "transid::983d1672-7e34-867e-04af-c673450330da_0_12907_38589",
    "sourceTid": "983d1672-7e34-867e-04af-c673450330da_0",
    "sfe_dr": 2,
    "mt_trans_date": "2022-02-04 17:19:23.392",
    "evtid": "9",
    "servicekey": "56ac7865-e69c-11ea-9cd6-12f2d349e6e3",
    "apiDestination": "919949452221",
    "flowid": "10926",
    "txn_log_level": 2
  },
  "channel": "wa",
  "submittedOn": 1643995163394,
  "validateDestination": false,
  "type": "text",
  "priority": 5,
  "tid": "94be7d8c-3165-4131-88ab-1c39789ff46d",
  "recipient_type": "individual",
  "waid": "919949452221",
  "preview_url": false,
  "appId": "a_164368290210260900",
  "x_msg_seq": 0,
  "text": {
    "body": "Gateway Submit",
  },
"dataIntegration": {
      "context": {
		"serviceId": "43553",
		"serviceName": "Appointment Booking",
		"flowId": "1234",
		"flowName": "Doctor Appointment ",
		"messagingAPI": "False",
		"Key": "Value", // added in the send or receive or start nodes
		"Key2": "Value2" added in the send or receive or start nodes
		},
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": "dummy data",
      "webhookurl": ""
    }
  }
}
{
  "extraparams": {
    "authkey": "12a3cd31-afab-4349-9f87-590342f53444",
    "connect_message_id": "07cd85af-ab1e-453f-8c10-59a57db9d86e",
    "x_req_origin_time": "2022-02-04 17:19:25.375",
    "channel": 8,
    "destination": "919949452221",
    "main_tid": "d7bef734-744c-4e2f-ad95-5cb1de968a04",
    "tid": "d7bef734-744c-4e2f-ad95-5cb1de968a04",
    "sid": "17218_10926",
    "report_info": {
      "request_source": 3,
      "source_tid": "983d1672-7e34-867e-04af-c673450330da_0"
    },
    "routerName": "",
    "outbound_notification_events": "",
    "routerId": "",
    "noOfMessages": 1,
    "_nodetid": "d7bef734-744c-4e2f-ad95-5cb1de968a04",
    "destinationType": "waid",
    "sourceOriginTime": "2022-02-04T17:19:19.449Z",
    "messagePriority": 1,
    "sfeSessionInfo": "transid::983d1672-7e34-867e-04af-c673450330da_0_12907_38589",
    "sourceTid": "983d1672-7e34-867e-04af-c673450330da_0",
    "sfe_dr": 1,
    "mt_trans_date": "2022-02-04 17:19:25.380",
    "evtid": "9",
    "servicekey": "56ac7865-e69c-11ea-9cd6-12f2d349e6e3",
    "apiDestination": "919949452221",
    "flowid": "10926",
    "txn_log_level": 2
  },
  "channel": "wa",
  "submittedOn": 1643995165383,
  "validateDestination": false,
  "type": "audio",
  "priority": 5,
  "tid": "d7bef734-744c-4e2f-ad95-5cb1de968a04",
  "recipient_type": "individual",
  "waid": "919949452221",
  "preview_url": false,
  "appId": "a_164368290210260900",
  "x_msg_seq": 0,
  "audio": {
    "mimeType": "audio/aac",
    "url": "http://techslides.com/demos/samples/sample.aac",
  },
"dataIntegration": {
      "context": {
		"serviceId": "43553",
		"serviceName": "Appointment Booking",
		"flowId": "1234",
		"flowName": "Doctor Appointment ",
		"messagingAPI": "False",
		"Key": "Value", // added in the send or receive or start nodes
		"Key2": "Value2" added in the send or receive or start nodes
		},
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": "b-3.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9098,b-1.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9098,b-2.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9098",
      "webhookurl": "https://integrations.imiconnect.site/v1/integration/"
    }
  }
}
{
  "extraparams": {
    "authkey": "12a3cd31-afab-4349-9f87-590342f53444",
    "connect_message_id": "b75da4e9-a3a3-4640-be68-534fdfa36977",
    "x_req_origin_time": "2022-02-04 17:19:25.403",
    "channel": 8,
    "destination": "919949452221",
    "main_tid": "8c4d1967-25f9-4dd1-a66d-2b6c61119fb1",
    "tid": "8c4d1967-25f9-4dd1-a66d-2b6c61119fb1",
    "sid": "17218_10926",
    "report_info": {
      "request_source": 3,
      "source_tid": "983d1672-7e34-867e-04af-c673450330da_0"
    },
    "routerName": "",
    "outbound_notification_events": "",
    "routerId": "",
    "noOfMessages": 1,
    "_nodetid": "8c4d1967-25f9-4dd1-a66d-2b6c61119fb1",
    "destinationType": "waid",
    "sourceOriginTime": "2022-02-04T17:19:19.449Z",
    "messagePriority": 1,
    "sfeSessionInfo": "transid::983d1672-7e34-867e-04af-c673450330da_0_12907_38589",
    "sourceTid": "983d1672-7e34-867e-04af-c673450330da_0",
    "sfe_dr": 1,
    "mt_trans_date": "2022-02-04 17:19:25.405",
    "evtid": "9",
    "servicekey": "56ac7865-e69c-11ea-9cd6-12f2d349e6e3",
    "apiDestination": "919949452221",
    "flowid": "10926",
    "txn_log_level": 2
  },
  "channel": "wa",
  "submittedOn": 1643995165853,
  "validateDestination": false,
  "video": {
    "caption": "Test",
    "mimeType": "video/mp4",
    "url": "http://techslides.com/demos/sample-videos/small.mp4"
  },
  "type": "video",
  "priority": 5,
  "tid": "8c4d1967-25f9-4dd1-a66d-2b6c61119fb1",
  "recipient_type": "individual",
  "waid": "919949452221",
  "preview_url": false,
  "appId": "a_164368290210260900",
  "x_msg_seq": 0,
"dataIntegration": {
      "context": {
		"serviceId": "43553",
		"serviceName": "Appointment Booking",
		"flowId": "1234",
		"flowName": "Doctor Appointment ",
		"messagingAPI": "False",
		"Key": "Value", // added in the send or receive or start nodes
		"Key2": "Value2" added in the send or receive or start nodes
		},
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": "b-3.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9098,b-1.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9098,b-2.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9098",
      "webhookurl": "https://integrations.imiconnect.site/v1/integration/"
    }
  }
}
{
  "template": {
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "text": "vr raooo",
            "type": "text"
          }
        ]
      },
      {
        "sub_type": "quick_reply",
        "index": "0",
        "type": "button",
        "parameters": [
          {
            "payload": "yes",
            "type": "payload"
          }
        ]
      },
      {
        "sub_type": "quick_reply",
        "index": "1",
        "type": "button",
        "parameters": [
          {
            "payload": "no",
            "type": "payload"
          }
        ]
      },
      {
        "sub_type": "quick_reply",
        "index": "2",
        "type": "button",
        "parameters": [
          {
            "payload": "thanks",
            "type": "payload"
          }
        ]
      }
    ],
    "name": "feedback_updateess",
    "language": {
      "code": "en",
      "policy": "deterministic"
    }
  },
  "extraparams": {
    "authkey": "12a3cd31-afab-4349-9f87-590342f53444",
    "connect_message_id": "853a27b6-6807-4145-a789-bc89dffa8a50",
    "x_req_origin_time": "2022-02-04 18:01:37.233",
    "channel": 8,
    "destination": "919949452221",
    "templateId": "429603284864310",
    "main_tid": "eff7c05c-52d8-4d5c-aa6d-910d0bc67501",
    "tid": "eff7c05c-52d8-4d5c-aa6d-910d0bc67501",
    "sid": "17218_11043",
    "report_info": {
      "request_source": 3,
      "source_tid": "c9e555ee-ad5b-29ba-d9d6-abc5c26ee90d_0"
    },
    "routerName": "",
    "outbound_notification_events": "",
    "routerId": "",
    "noOfMessages": 1,
    "_nodetid": "eff7c05c-52d8-4d5c-aa6d-910d0bc67501",
    "destinationType": "waid",
    "sourceOriginTime": "2022-02-04T18:01:33.576Z",
    "messagePriority": 1,
    "sfeSessionInfo": "transid::c9e555ee-ad5b-29ba-d9d6-abc5c26ee90d_0_13009_38590",
    "sourceTid": "c9e555ee-ad5b-29ba-d9d6-abc5c26ee90d_0",
    "sfe_dr": 1,
    "mt_trans_date": "2022-02-04 18:01:37.321",
    "evtid": "9",
    "servicekey": "56ac7865-e69c-11ea-9cd6-12f2d349e6e3",
    "apiDestination": "919949452221",
    "flowid": "11043",
    "txn_log_level": 2
  },
  "channel": "wa",
  "submittedOn": 1643997697412,
  "validateDestination": false,
  "type": "template",
  "priority": 5,
  "tid": "eff7c05c-52d8-4d5c-aa6d-910d0bc67501",
  "recipient_type": "individual",
  "waid": "919949452221",
  "preview_url": false,
  "appId": "a_164368290210260900",
  "x_msg_seq": 0,
"dataIntegration": {
      "context": {
		"serviceId": "43553",
		"serviceName": "Appointment Booking",
		"flowId": "1234",
		"flowName": "Doctor Appointment ",
		"messagingAPI": "False",
		"Key": "Value", // added in the send or receive or start nodes
		"Key2": "Value2" added in the send or receive or start nodes
		},
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": "dummy data",
      "webhookurl": ""
    }
  }
}
{
  "extraparams": {
    "authkey": "12a3cd31-afab-4349-9f87-590342f53444",
    "connect_message_id": "8719203f-32d8-4da2-b581-a06fa5e715f3",
    "x_req_origin_time": "2022-02-04 18:17:32.165",
    "channel": 8,
    "destination": "919949452221",
    "main_tid": "1bb54f81-daa1-4441-b8dd-12139623e40b",
    "tid": "1bb54f81-daa1-4441-b8dd-12139623e40b",
    "sid": "17218_10926",
    "report_info": {
      "request_source": 3,
      "source_tid": "f58e4a37-7d72-695b-8c45-f0bff9c7a265_0"
    },
    "routerName": "",
    "outbound_notification_events": "",
    "routerId": "",
    "noOfMessages": 1,
    "_nodetid": "1bb54f81-daa1-4441-b8dd-12139623e40b",
    "destinationType": "waid",
    "sourceOriginTime": "2022-02-04T18:17:27.291Z",
    "messagePriority": 1,
    "sfeSessionInfo": "transid::f58e4a37-7d72-695b-8c45-f0bff9c7a265_0_12907_38591",
    "sourceTid": "f58e4a37-7d72-695b-8c45-f0bff9c7a265_0",
    "sfe_dr": 1,
    "mt_trans_date": "2022-02-04 18:17:32.166",
    "evtid": "9",
    "servicekey": "56ac7865-e69c-11ea-9cd6-12f2d349e6e3",
    "apiDestination": "919949452221",
    "flowid": "10926",
    "txn_log_level": 2
  },
  "channel": "wa",
  "submittedOn": 1643998653632,
  "validateDestination": false,
  "type": "location",
  "priority": 5,
  "tid": "1bb54f81-daa1-4441-b8dd-12139623e40b",
  "recipient_type": "individual",
  "waid": "919949452221",
  "preview_url": false,
  "appId": "a_164368290210260900",
  "location": {
    "address": "Jubiliee Hills",
    "latitude": "31.78789997",
    "name": "Pedhama Temple",
    "longitude": "45.88988967"
  },
  "x_msg_seq": 0,
"dataIntegration": {
      "context": {
		"serviceId": "43553",
		"serviceName": "Appointment Booking",
		"flowId": "1234",
		"flowName": "Doctor Appointment ",
		"messagingAPI": "False",
		"Key": "Value", // added in the send or receive or start nodes
		"Key2": "Value2" added in the send or receive or start nodes
		},
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": "dummy data",
      "webhookurl": ""
    }
  }
}
{
  "extraparams": {
    "authkey": "12a3cd31-afab-4349-9f87-590342f53444",
    "connect_message_id": "a5563f09-0bbd-46f8-9cef-7e1799809784",
    "x_req_origin_time": "2022-02-04 18:17:32.167",
    "channel": 8,
    "destination": "919949452221",
    "main_tid": "31dac824-c346-4544-b48d-9cc488992da1",
    "tid": "31dac824-c346-4544-b48d-9cc488992da1",
    "sid": "17218_10926",
    "report_info": {
      "request_source": 3,
      "source_tid": "f58e4a37-7d72-695b-8c45-f0bff9c7a265_0"
    },
    "routerName": "",
    "outbound_notification_events": "",
    "routerId": "",
    "noOfMessages": 1,
    "_nodetid": "31dac824-c346-4544-b48d-9cc488992da1",
    "destinationType": "waid",
    "sourceOriginTime": "2022-02-04T18:17:27.291Z",
    "messagePriority": 1,
    "sfeSessionInfo": "transid::f58e4a37-7d72-695b-8c45-f0bff9c7a265_0_12907_38591",
    "sourceTid": "f58e4a37-7d72-695b-8c45-f0bff9c7a265_0",
    "sfe_dr": 1,
    "mt_trans_date": "2022-02-04 18:17:32.169",
    "evtid": "9",
    "servicekey": "56ac7865-e69c-11ea-9cd6-12f2d349e6e3",
    "apiDestination": "919949452221",
    "flowid": "10926",
    "txn_log_level": 2
  },
  "channel": "wa",
  "submittedOn": 1643998653618,
  "validateDestination": false,
  "type": "contacts",
  "priority": 5,
  "tid": "31dac824-c346-4544-b48d-9cc488992da1",
  "recipient_type": "individual",
  "waid": "919949452221",
  "preview_url": false,
  "appId": "a_164368290210260900",
  "x_msg_seq": 0,
  "contacts": [
    {
      "name": {
        "prefix": "sri",
        "last_name": "K",
        "first_name": "srilakshmi",
        "formatted_name": "Srilakshmi"
      },
      "phones": [
        {
          "phone": "+91 9949452221",
          "type": "home",
"dataIntegration": {
      "context": {
		"serviceId": "43553",
		"serviceName": "Appointment Booking",
		"flowId": "1234",
		"flowName": "Doctor Appointment ",
		"messagingAPI": "False",
		"Key": "Value", // added in the send or receive or start nodes
		"Key2": "Value2" added in the send or receive or start nodes
		},
    "appContext": {
      "tenant_identifier": "CloudqaR6",
      "Topic": "CloudQAR6S2Topic",
      "URL": "dummy data",
      "webhookurl": ""
    }
  }
}
]
    }
  ]
}

WhatsApp - Outbound Message Descriptions

Field NameDescription
extraparams
authkeyThe unqiue authentication key
connect_message_idThe unqiue identification reference ID for the message sent from the platform
x_req_origin_time
channel
destinationThe MSISDN number or the phone number on which the message is sent.
main_tid
tidTransaction ID
sid
report_info
request_source
source_tid
routerName
outbound_notification_events
routerId
noOfMessages
nodetid
destinationType
sourceOriginTime
messagePriority
sfeSessionInfo
sourceTid
transid
sfe_dr
mt_trans_date
evtid
servicekey
apiDestination
flowid
txn_log_level
channel
submittedOn
validateDestination
type
priority
tid
recipient_type
waid
preview_url
appId
x_msg_seq
text
body
dataIntegration
context
serviceId
serviceName
flowId
flowName
messagingAPI
Key
Key2
appContext
tenant_identifier
Topic
URL
webhookurl