Fetching WhatsApp Conversations
Authorization
API URL: https://<yourdomainname>/:<Port>IrisEngage_API/api/Users/authenticate
Sample Request
{
"Name": "user1",
"Password":"password1"
}Sample Response
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6InVzZXIxIiwibmJmIjoxNjkyMTYxMDIzLCJleHAiOjE2OTIyNDc0MjMsImlhdCI6MTY5MjE2MTAyM30.8Cqo88snbPd64w3zadGh0Zmi54suExZzIf1lNl4GJ-Q",
"refreshToken": null
}
Fetching list of WhatsApp Conversations of a Customer
API URL: https://<yourdomainname>/IrisEngage_API/api/EngageAPIRequestDetails
https://<yourdomainname or IP>/IrisEngage_API/api/EngageAPIRequestDetailsSample Request
{
"MobileNo": "971569113820",
"SessionCount": 1
}Sample Response
{
"message": [
{
"requestId": "CDC079CC-C7FC-46CC-AECA-FD81D83A82B8",
"requestedDate": "08-15-2023 07:39:17 PM",
"channelName": "WhatsApp",
"chatStatus": "Cleared"
}
]
}
Fetching chat history (messages) of a session
API URL: https://<yourdomainname>/IrisEngage_API/api/GetContent
Sample Request
{
"RequestId": "CDC079CC-C7FC-46CC-AECA-FD81D83A82B8"
}Sample Response
{
"message": [
{
"id": "cdc079cc-c7fc-46cc-aeca-fd81d83a82b8",
"customerNumber": "971569113820",
"customerName": "Ganga Shyam",
"customerEmail": null,
"channelId": "1",
"botId": "7f59ef1d-4386-4b36-914e-fad77b8deb6f",
"messageId": "85a7339d-3e6f-4b22-b2e4-f8fa09bc3379",
"direction": "Inbound",
"message": "<Text>Hi</Text>",
"createdDate": "2023-08-15 07:39:17 PM",
"messageType": 0,
"channel": "WhatsApp",
"handledBy": "BOT",
"userName": ""
},
{
"id": "cdc079cc-c7fc-46cc-aeca-fd81d83a82b8",
"customerNumber": "971569113820",
"customerName": "Ganga Shyam",
"customerEmail": null,
"channelId": "1",
"botId": "7f59ef1d-4386-4b36-914e-fad77b8deb6f",
"messageId": "e0b8eeeb-0596-4a65-a992-a28ba47264ee",
"direction": "Outbound",
"message": "<Text>Hello, Welcome to Dubai Ladies Club, the destination for Happy, Healthy Women. I'm your Virtual Assistant *Dana*.</Text>",
"createdDate": "2023-08-15 07:39:18 PM",
"messageType": 0,
"channel": "WhatsApp",
"handledBy": "BOT",
"userName": ""
},
{
"id": "cdc079cc-c7fc-46cc-aeca-fd81d83a82b8",
"customerNumber": "971569113820",
"customerName": "Ganga Shyam",
"customerEmail": null,
"channelId": "1",
"botId": "7f59ef1d-4386-4b36-914e-fad77b8deb6f",
"messageId": "07fc428d-9f73-40ad-8c3c-3bf13eebb1cf",
"direction": "Outbound",
"message": "<Text>\\nI can help you with the following services\\n\\n1. Membership Plans & Offers\\n2. Outdoor & Recreation\\n3. Wellness Centre\\n4. Al Asalla Spa\\n5. Events\\n6. Outlets at DLC\\n7. Location\\n8. FAQ\\n\\n*Tip* 💡: To select the desired item, reply with the number!</Text>",
"createdDate": "2023-08-15 07:39:19 PM",
"messageType": 0,
"channel": "WhatsApp",
"handledBy": "BOT",
"userName": ""
},
{
"id": "cdc079cc-c7fc-46cc-aeca-fd81d83a82b8",
"customerNumber": "971569113820",
"customerName": "Ganga Shyam",
"customerEmail": null,
"channelId": "1",
"botId": "7f59ef1d-4386-4b36-914e-fad77b8deb6f",
"messageId": "17222f1c-aa05-4e12-a032-e25602d42f19",
"direction": "Inbound",
"message": "<Text>1</Text>",
"createdDate": "2023-08-15 07:39:24 PM",
"messageType": 0,
"channel": "WhatsApp",
"handledBy": "BOT",
"userName": ""
},
{
"id": "cdc079cc-c7fc-46cc-aeca-fd81d83a82b8",
"customerNumber": "971569113820",
"customerName": "Ganga Shyam",
"customerEmail": null,
"channelId": "1",
"botId": "7f59ef1d-4386-4b36-914e-fad77b8deb6f",
"messageId": "c031532d-4183-403a-bc23-d6789534d462",
"direction": "Outbound",
"message": "<Button><Caption>Explore and choose from a range of membership plans and exciting offers</Caption><Items><Item>Membership Packages</Item><Item>Membership Offers</Item><Item>Others</Item></Items></Button>",
"createdDate": "2023-08-15 07:39:26 PM",
"messageType": 6,
"channel": "WhatsApp",
"handledBy": "BOT",
"userName": ""
},
{
"id": "cdc079cc-c7fc-46cc-aeca-fd81d83a82b8",
"customerNumber": "971569113820",
"customerName": "Ganga Shyam",
"customerEmail": null,
"channelId": "1",
"botId": "7f59ef1d-4386-4b36-914e-fad77b8deb6f",
"messageId": "d68051e0-68a6-4805-9d24-c00cc5a43ce8",
"direction": "Inbound",
"message": "<Text>Membership Packages(1)</Text>",
"createdDate": "2023-08-15 07:39:33 PM",
"messageType": 0,
"channel": "WhatsApp",
"handledBy": "BOT",
"userName": ""
},
{
"id": "cdc079cc-c7fc-46cc-aeca-fd81d83a82b8",
"customerNumber": "971569113820",
"customerName": "Ganga Shyam",
"customerEmail": null,
"channelId": "1",
"botId": "7f59ef1d-4386-4b36-914e-fad77b8deb6f",
"messageId": "5f79a829-a1ef-4245-afa5-80f3192fae88",
"direction": "Outbound",
"message": "<Text>\\nChoose a membership package from the below\\n\\n1. Family\\n2. Individual\\n3. Student\\n4. Previous Menu</Text>",
"createdDate": "2023-08-15 07:39:34 PM",
"messageType": 0,
"channel": "WhatsApp",
"handledBy": "BOT",
"userName": ""
},
{
"id": "cdc079cc-c7fc-46cc-aeca-fd81d83a82b8",
"customerNumber": "971569113820",
"customerName": "Ganga Shyam",
"customerEmail": null,
"channelId": "1",
"botId": "7f59ef1d-4386-4b36-914e-fad77b8deb6f",
"messageId": "e94d8859-eb15-422b-84d0-75f8d121e494",
"direction": "Inbound",
"message": "<Text>2</Text>",
"createdDate": "2023-08-15 07:39:40 PM",
"messageType": 0,
"channel": "WhatsApp",
"handledBy": "BOT",
"userName": ""
},
{
"id": "cdc079cc-c7fc-46cc-aeca-fd81d83a82b8",
"customerNumber": "971569113820",
"customerName": "Ganga Shyam",
"customerEmail": null,
"channelId": "1",
"botId": "7f59ef1d-4386-4b36-914e-fad77b8deb6f",
"messageId": "b427150d-1819-407e-a5ce-e7faf61d4e54",
"direction": "Outbound",
"message": "<Text>\\nSelect one of the following services\\n\\n1. Premium Membership\\n2. Classic Membership Menu\\n3. Single Facility Membership\\n4. Group Leisure Membership\\n5. Golden Membership\\n6. Previous Menu\\n7. Main Menu</Text>",
"createdDate": "2023-08-15 07:39:41 PM",
"messageType": 0,
"channel": "WhatsApp",
"handledBy": "BOT",
"userName": ""
},
{
"id": "cdc079cc-c7fc-46cc-aeca-fd81d83a82b8",
"customerNumber": "971569113820",
"customerName": "Ganga Shyam",
"customerEmail": null,
"channelId": "1",
"botId": "7f59ef1d-4386-4b36-914e-fad77b8deb6f",
"messageId": "449be9fc-579b-457a-94bc-ff35f14000ee",
"direction": "Inbound",
"message": "<Text>4</Text>",
"createdDate": "2023-08-15 07:39:51 PM",
"messageType": 0,
"channel": "WhatsApp",
"handledBy": "BOT",
"userName": ""
},
{
"id": "cdc079cc-c7fc-46cc-aeca-fd81d83a82b8",
"customerNumber": "971569113820",
"customerName": "Ganga Shyam",
"customerEmail": null,
"channelId": "1",
"botId": "7f59ef1d-4386-4b36-914e-fad77b8deb6f",
"messageId": "79193609-0f8e-4960-8423-f36b2b7cb82a",
"direction": "Outbound",
"message": "<Text>\\nEnjoy access on weekdays only to our ladies only beach and pool and much more! Choose between 1 month, 3 months and annual memberships. \\nFor any further information please contact us on +971503403636 or 043400044 or email us on [email protected]\\n.Talk to an agent\\n2.Main Menu\\nPrevious Menu</Text>",
"createdDate": "2023-08-15 07:39:52 PM",
"messageType": 0,
"channel": "WhatsApp",
"handledBy": "BOT",
"userName": ""
}
]
}
Last updated