All events trigger message

Requirements: As soon as the events are received need to trigger WhatsApp notification to the customer using WhatsApp Meta cloud APIs

Implementation:

Templates are registered on Meta for different events like orders created, delivered, etc which will be triggered on the basis of resources and eventSubTypes received in the event listener.

• Post API: whatsappEventListener receives the fdr event with resource example: “shipment” & eventSubType “out_for_delivery”.

• { "resource": "shipment", "eventType": "PUT", "eventSubType": "out_for_delivery", "accountSlug": "test_test_ajeet", "accountId": null, "actor": "SYSTEM", "version": "v1", "request_data": [], "response_data": { "customerOrderNumber": "Oct11Case101", "orderSiteID": null, "vendorOrderNumber": "Oct11Case101", "externalShipmentID": "Oct11Case101-5943-9018", "externalWarehouseID": "Test_test_ajeet_vs001", "externalChannelID": "CH5943", "externalWmsChannelName": "ASHITA_TEST_TEST_TEST_AJEET_VS001_2128", "external_wms_channel_id": 2128, "channelLabel": "Ashita test", "integrationType": "4", "barcodeType": "item", "vendorPartyID": null, "partner_as2_id": null, "defaultWarehouseCode": "Test_test_ajeet_vs001", "facilityLabel": "Import Only (vs001)", "facilityType": "auperator", "orderDate": "2023-10-11 12:15:53", "portal_id": 26, "paymentType": "COD", "expectedShipDate": "2023-10-12 12:00:00", "dispatchAfterDate": null, "externalManifestNumber": null, "channelManifestNumber": null, "order_id": 44210773, "channel_id": 5943, "warehouse_id": 851, "channel_account_id": 0, "account_id": 733, "connectionId": 2654, "locationId": null, "region": "Zonal", "isMetro": "0", "isSpecialplace": "0", "shippingConnectionId": null, "picklistCode": null, "invoiceNumber": "INVTESA92", "boxType": "UNKNOWN", "isPriorityShipment": "0", "isGift": "0", "invoice_url": "https://storage.googleapis.com/invoicefiles-staging/invoice/Oct11Case10159439018-1697026648028.pdf", "invoiceDate": "2023-10-11 17:47:21", "label_url": "https://storage.googleapis.com/eshopbox_wms_uploads_staging/myntraLabel/202310111751371998168073.pdf", "labels": "", "shippingInfo": [], "boxAdditionalRecommendation": [], "dimension_length": "10", "dimension_width": "10", "dimension_height": "10", "weight": "100", "chargeableWeight": "200", "trackingID": "6386710011535", "trackingDomain": "", "packageID": "", "barcode": "", "taxAmount": 0, "shipChargeAmount": null, "courierName": "Delhivery", "cp_id": 4, "created_at": "2023-10-11 17:46:05", "updated_at": "2023-10-11 17:51:38", "status": "out_for_delivery", "remarks": "manual update - ofd", "warehousePincode": "431005", "thirdPartyShipping": false, "customerName": "Rohit", "customerContactNumber": "8723050579", "email": "rohitkumar@eshopbox.com", "channelSlug": "test_test_ajeet5943", "status_updated_at": "2023-10-13 14:02:58", "status_log": { "created": "2023-10-11 17:46:05", "accepted": "2023-10-11 17:47:08", "packed": "2023-10-11 17:51:38", "out_for_delivery": "2023-10-13 14:02:58", "failed_delivery": "2023-10-13 13:53:53", "ndr_resolution_submitted": "2023-10-13 14:00:36" }, "status_log_first_occurrence": { "out_for_delivery": "2023-10-12 11:59:53", "ndr_resolution_submitted": "2023-10-12 12:00:45", "failed_delivery": "2023-10-12 12:00:29", "packed": "2023-10-11 17:51:37", "accepted": "2023-10-11 17:47:08", "created": "2023-10-11 17:46:05" }, "status_log_count": { "created": 1, "accepted": 1, "packed": 2, "out_for_delivery": 2, "failed_delivery": 4, "ndr_resolution_submitted": 4 }, "status_log_id": "254633945", "orderExternalCreatedAt": "2023-10-11 17:45:57", "riskScore": null, "riskScoreReasons": "", "pincodeServiceableRemarks": null, "shippingAddress": { "customerName": "Rohit", "addressLine1": "M-260 Ashiana Road Sector G LDA Colony", "addressLine2": null, "city": "Patan", "state": "Gujarat", "postalCode": "385340", "countryCode": "IN", "countryName": "IN", "contactPhone": "8723050579", "email": "rohitkumar@eshopbox.com" }, "warehouseAddress": { "addressLine1": "Address line 1 , Address line 2 , aurangabad , MAHARASHTRA, ", "addressLine2": "", "city": "aurangabad", "state": "MAHARASHTRA", "postalCode": "431005", "gstin": "27ABCFM8335M1ZT" }, "billingAddress": { "customerName": "Rohit", "email": "rohitkumar@eshopbox.com", "contactPhone": "8723050579" }, "id": 11202316, "balanceDue": 320, "orderTotal": 1000, "subTotal": 1000, "isCOD": "1", "track_payload": { "clickPostTrackData": { "location": null, "additional": { "courier_partner_edd": null, "destination_hub_inscan_ts": null, "order_id": "Oct11Case101-5943-9018", "latest_status": { "status": "dispatched", "clickpost_status_description": "OutForDelivery", "clickpost_status_bucket": 4, "reference_number": "Oct11Case101-5943-9018", "clickpost_status_bucket_description": "Out for delivery", "remark": "MANUAL UPDATE - OFD", "timestamp": "2023-10-13T14:02:52Z", "location": null, "clickpost_city": null, "clickpost_status_code": 6 }, "is_rvp": false, "ndr_status_code": null, "ndr_status_description": null, "account_code": "Delhivery_TEST_Account", "npr_status_code": null, "npr_status_description": null }, "status": "dispatched", "clickpost_city": null, "clickpost_status_code": 6, "clickpost_status_description": "OutForDelivery", "cp_id": 4, "remark": "MANUAL UPDATE - OFD", "account_code": "Delhivery_TEST_Account", "waybill": "6386710011535", "timestamp": "2023-10-13T14:02:52Z" } }, "account_slug": "test_test_ajeet", "packed_date": "2023-10-11 17:51:38", "items": [ { "order_item_id": 30325556, "lineItemSequenceNumber": 1, "orderItemID": "Oct11Case101-30325556", "itemID": "importTest1002", "sku": "02HZ83FNQQ8", "asin": "", "productName": "Slim fit blue shirt", "quantity": 1, "orderItemCreatedAt": "2023-10-11 17:45:57", "customerPrice": 2000, "lineItemTotal": 1000, "invoiceTotal": 1000, "cashOnDeliveryCharges": 0, "discount": 1000, "taxRate": 0, "taxAmount": 0, "inventoryItemCode": "", "giftMessage": "", "isGift": "0", "giftLabelContent": "", "lineItemOrderStatus": "", "orderItemIDs": [ "Oct11Case101-30325556" ], "productImageUrl": "https://cdn.filestackcontent.com/pDk3GPiTa6i0vzhVOn9F", "productAdditionalInfo": { "productDetails": { "unitPrice": 1990, "hsnCode": "61091000", "dimensionHeight": 10, "dimensionLength": 10, "dimensionUnit": "cm", "weight": 20, "mrp": 2000, "dimensionWidth": 10, "type": "BASE", "verticalName": "Apparels", "imageUrl": "https://cdn.filestackcontent.com/pDk3GPiTa6i0vzhVOn9F", "accountSlug": "test_test_ajeet", "sku": "importTest1002", "esin": "02HZ83FNQQ8", "brand": "DummyBrand", "additionalNames": [], "groupCode": "BLUE SHIRT", "status": "ACTIVE", "weightUnit": "g" } }, "expectedDeliveryDate": null, "shippingCharges": 0, "productUrl": null, "originalOrderItemId": null, "isVirtualKit": "0", "component": [], "onhold": "0", "cancellationAdditionalReason": "", "cancellationReason": "", "customerOrderItemID": "", "recallBlockedInventoryUsed": "" } ] }, "previous_data": [], "resource_type": "shipment.update", "account_slug": "test_test_ajeet", "custom": [] }

• A POST API message queue listener is created where we process the queue

• FailedDeliveryEventListenerDto will be renamed to WmsEventDto as it was only used for failed delivery events earlier and new fields might be added as per the requirements.

• There are various events we need to create methods for all the cases and with details received in the event above we call the particular related methods under 3 resource types

• We will check what resources we have received in the event and proceed accordingly.

• Next, we will create a method that will handle different methods on the basis of these resources to proceed further.

• We will have a method generateTemplateRequest that will be used to create the templateRequest which is to be sent to the customer on the basis of the event.

• These methods will take input variables like Name, Phone number, accountSlug, orderId, Order Items, FDR, etc. which will be used in the template to generate the msg that is to be sent to the customer.

• As soon as the template is fetched we prepare our body for triggering graph API which has the body mentioned below (https://graph.facebook.com/105339412622627/messages)

• Same as the earlier implementation, the template sent out will also be stored in the database in outgoingMessagesTable with the time details when the message was sent and other details.

• All the DB fields will be populated shipment_status_logs_id, customer_phone, business_phone, wa_template_id, root_message_id, message_id, payload, external_updatedAt, created_at from the payload after a successful response is received from meta in wa_outgoing_messages table after fetching http://messages.id from the API response.

  INSERT INTO wa_outgoing_messages (shipment_status_logs_id, customer_phone, business_phone, wa_template_id, root_message_id, message_id, payload, external_updatedAt, created_at) VALUE ('12345', '7042226080', '15550512539', '1493673698103012', '', 'wamid.HBgMOTE5NjUwMTg2Njk3FQIAERgSQUM1RDgwMzMyRTNFRjdCNzQzAA==', '{ "messaging_product": "whatsapp", "recipient_type": "individual", "to": "918383000700", "type": "template", "template": { "name": "customer_unreachable", "language": { "code": "en_US" }, "components": [ { "type": "body", "parameters": [ { "type": "text", "text": "Pablo" }, { "type": "text", "text": "566701" }, { "type": "text", "text": "Pablo" }, { "type": "text", "text": "566701" }, { "type": "text", "text": "Pablo" }, { "type": "text", "text": "566701" } ] } ] } }', CURRENT_TIMESTAMP, CURRENT_TIMESTAMP);

• A webhook is also registered on whatsapp which will receive all the delivery reports regarding when the message was sent, delivered, etc. which be saved in wa_dlr_messages table.

  INSERT INTO wa_dlr_messages (wa_outgoing_message_id, message_id, STATUS, payload, external_timestamp, created_at, updated_at) VALUES ('1234565432', 'wamid.HBgMOTE5NjUwMTg2Njk3FQIAERgSQUM1RDgwMzMyRTNFRjdCNzQzAA==', 'sent', ' { "object": "whatsapp_business_account", "entry": [ { "id": "105945132543354", "changes": [ { "value": { "messaging_product": "whatsapp", "metadata": { "display_phone_number": "15551009938", "phone_number_id": "108687922264083" }, "statuses": [ { "id": "wamid.HBgMOTE5NjUwMTg2Njk3FQIAERgSQUM1RDgwMzMyRTNFRjdCNzQzAA==", "status": "read", "timestamp": "1687433938", "recipient_id": "919650186697" } ] }, "field": "messages" } ] } ] }','2023-08-24 18:28:44', CURRENT_TIMESTAMP, CURRENT_TIMESTAMP);

   

• Mapping for Customer portal description, Resource & eventSubType on the basis of which messages will be triggered.