/
Activity Logs (WhatsApp)

Activity Logs (WhatsApp)

Owned by Lakshay Aggarwal (Unlicensed)
Last updated: Nov 17, 2023
4 min read

Event Logs:

  1. The first message is triggered event structure:

{ "resource": "customer_notification", "eventType": "POST", "eventSubType": "inqueue/sent etc", "accountSlug": "vitaminplanet", "accountId": null, "actor": "customerName", "version": "v1", "response_data": { "vendorOrderNumber": "#124676", "order_id": 49996100, "account_id": 379, "notification_type" : "whatsApp", "messagedId" : "dartuytiuytiytu4565645eryrtrthg", "isRootMessage" : 1, "status": "failed_delivery", "customerName": "Lakshay Aggarwal", "failureReason" : "", "customerContactNumber": "9650186697", "email": "test@gmail.com", "forwardTrackingID" : "3213452365357" "externalShipmentID" : "", "customerOrderNumber": "", "channelId" : "", "account_slug": "vitaminplanet", "timestamp": "16789878" (epoch convert in dd-mm--yyyy), "from": "Eshopbox (number)", "to": "customer contact", "sentOn": "timestamp", "deliveredAt": "timestamp", } "account_slug": "vitaminplanet" }

  1. Customer reply to message activity log (changes need to be done as Above):

{ "resource": "customer_notification", "eventType": "POST", "eventSubType": "customer_reply", "accountSlug": "vitaminplanet", "accountId": null, "actor": {{customer_name}}, "version": "v1", "response_data": { "action_taken": "Request delivery attempt" "vendorOrderNumber": "#124676", "order_id": 49996100, "account_id": 379, "status": "failed_delivery", "customerName": "Lakshay Aggarwal", "customerContactNumber": "9650186697", "email": "test@gmail.com", "account_slug": "vitaminplanet", "timestamp": "16789878" (epoch convert in dd-mm--yyyy), "from": "Eshopbox (number)", "to": "customer contact", "sentOn": "timestamp", "deliveredAt": "timestamp", } "account_slug": "vitaminplanet" }

 

Conditions:

  1. First outgoing message

  • DLR of the first outgoing message

  • if DLR belongs to root then add isRootMessage: 1,

  • else isRootMessage key not required

  1. add All "eventSubType in the form of a table as per the BRD activity

  2. In the case of DLR: eventSubType - “In queue”, “sent”, “delivered”, “read”, “failed”

  3. Customer Action taken - eventSubStype: “Update address”, “Add alternate number”, “Select new delivery date” (date selected), “Reattempt”, “Report fake delivery”, “Cancel my order”

IMPLEMENTATION:

  1. Logging of events as the first message is triggered on the “WhatsApp-notifications service” event structure for the first trigger message sent to the customer would be as follows:

{ "resource": "customer_notification", "eventType": "POST", "eventSubType": "inqueue", --- will be inqueue as dlr is received on other service "accountSlug": "vitaminplanet", "accountId": null, "actor": "customerName", "version": "v1", "response_data": { "vendorOrderNumber": "#124676", "account_id": 379, "notification_type" : "whatsApp", "messagedId" : "dartuytiuytiytu4565645eryrtrthg", "forwardTrackingID" : "3213452365357" "externalShipmentID" : "", "customerOrderNumber": "", "channelId" : "", "isRootMessage" : 1, "status": "failed_delivery", "customerName": "Lakshay Aggarwal", "customerContactNumber": "9650186697", "account_slug": "vitaminplanet", "timestamp": "16789878" (epoch convert in dd-mm--yyyy), "from": "Eshopbox (number)", "to": "customer contact", } "account_slug": "vitaminplanet" }

  1. DLR for the first message triggered will be published on the “WhatsApp-webhook-service” event structure as follows:

    1. As webhooks are received the events are logged on the basis of message IDs which will be a key factor for identifying for which order the event is for

    2. To fetch order details we need to backtrack and fetch the shipment status log ID on the basis of root_message_id and then fetch the details required for preparing the event:
      The following query is already present in dao layer

SELECT orders.customerOrderNumber AS customerOrderNumber, orders.channel_id, channels.channelSlug, order_items.orderItemID AS orderItemID, orders.shipping_addressLine1 AS shippingAddress1, orders.shipping_addressLine2 AS shippingAddress2, orders.shipping_city AS shippingCity, orders.shipping_state AS shippingState, orders.shipping_postalCode AS shippingPostalCode, orders.shipping_contactPhone AS contactNumber, orders.shipping_email AS email, shipments.id AS id, orders.id AS order_id, shipments.trackingID AS trackingId, orders.billing_contactPhone, orders.shipping_customerName, shipments.id AS shipmentId FROM orders LEFT JOIN channels ON channels.id = orders.channel_id LEFT JOIN shipments ON shipments.order_id = orders.id LEFT JOIN order_items ON order_items.shipment_id = shipments.id LEFT JOIN shipment_status_logs ON shipment_status_logs.shipment_id = shipments.id WHERE shipment_status_logs.id = :shipment_status_log_id GROUP BY shipments.id
{ "resource": "customer_notification", "eventType": "POST", "eventSubType": "sent", --- will be sent/delivered/read/failed as dlr is received on this service "accountSlug": "vitaminplanet", "accountId": null, "actor": "customerName", "version": "v1", "response_data": { "vendorOrderNumber": "#124676", "order_id": 49996100, "account_id": 379, "notification_type" : "whatsApp", "messagedId" : "dartuytiuytiytu4565645eryrtrthg", "isRootMessage" : 0, "status": "failed_delivery", "customerName": "Lakshay Aggarwal", "forwardTrackingID" : "3213452365357" "externalShipmentID" : "", "customerOrderNumber": "", "channelId" : "", "failureReason" : "", "customerContactNumber": "9650186697", "email": "test@gmail.com", "forwardTrackingID" : "3213452365357" "account_slug": "vitaminplanet", "timestamp": "16789878" (epoch convert in dd-mm--yyyy), "from": "Eshopbox (number)", "to": "customer contact", "sentOn": "timestamp", "deliveredAt": "timestamp", "readAt": "timestamp", } "account_slug": "vitaminplanet", }

  1. Customer Action Taken - The DLR event will be published on the basis of message IDs same as the DLR (status) event structure would be as follows:

    1. For this, we need to fetch root_message_id on the basis of message_id backtrack and fetch from a database on the basis of WHATSAPP db: wa_customer_reply.wa_root_outgoing_message_id

SELECT wa_root_outgoing_message_id, message_id FROM wa_customer_reply LEFT JOIN wa_outgoing_message_id ON wa_customer_reply.wa_root_outgoing_message_id = wa_outgoing_message_id.id WHERE id = "SAMPLE"

b. To fetch order details we need to backtrack and fetch the shipment status log ID on the basis of root_message_id and then fetch the details required for preparing the event:
The following query is already present in Dao layer:

SELECT orders.customerOrderNumber AS customerOrderNumber, orders.channel_id, channels.channelSlug, order_items.orderItemID AS orderItemID, orders.shipping_addressLine1 AS shippingAddress1, orders.shipping_addressLine2 AS shippingAddress2, orders.shipping_city AS shippingCity, orders.shipping_state AS shippingState, orders.shipping_postalCode AS shippingPostalCode, orders.shipping_contactPhone AS contactNumber, orders.shipping_email AS email, shipments.id AS id, orders.id AS order_id, shipments.trackingID AS trackingId, orders.billing_contactPhone, orders.shipping_customerName, shipments.id AS shipmentId FROM orders LEFT JOIN channels ON channels.id = orders.channel_id LEFT JOIN shipments ON shipments.order_id = orders.id LEFT JOIN order_items ON order_items.shipment_id = shipments.id LEFT JOIN shipment_status_logs ON shipment_status_logs.shipment_id = shipments.id WHERE shipment_status_logs.id = :shipment_status_log_id GROUP BY shipments.id
{ "resource": "customer_notification", "eventType": "POST", "eventSubType": "Update address”, “Add alternate number”, “Select new delivery date” (date selected), “Reattempt”, “Report fake delivery”, “Cancel my order" -- on basis of customer response "accountSlug": "vitaminplanet", "accountId": null, "actor": "customerName", "version": "v1", "response_data": { "vendorOrderNumber": "#124676", "order_id": 49996100, "account_id": 379, "notification_type" : "whatsApp", "messagedId" : "dartuytiuytiytu4565645eryrtrthg", "rootMessageId": "dartuytiuytiytu4565645eryrtrthgdshbjsd" "forwardTrackingID" : "3213452365357" "externalShipmentID" : "92387492", "customerOrderNumber": "#124676", "channelId" : "8780", "isRootMessage" : 0, "status": "failed_delivery", "customerName": "Lakshay Aggarwal", "failureReason" : "", "customerContactNumber": "9650186697", "email": "test@gmail.com", "forwardTrackingID" : "3213452365357" "account_slug": "vitaminplanet", "timestamp": "16789878" (epoch convert in dd-mm--yyyy), "from": "Eshopbox (number)", "to": "customer contact", "sentOn": "timestamp", "deliveredAt": "timestamp", "readAt: "timestamp", } "account_slug": "vitaminplanet", }
Add label

Related content