Instant Messaging API Documentation
Kenyt.AI Instant Messaging API Documentation:
Usecase
Send Instant message over Whatsapp/SMS/Email
API URL
https://www.kenyt.ai/dashboardapi/api/crm/send-message?authToken=<value>&organizationId=<value>
Method : Post
Json Payload
{
"Name": "<Value>",
"Email": "<Value>",
"Phone": "<Value>",
"TemplateName": "<Value>",
"BotId": <Value>,
"Arguments": [
"value1",
"value2"
],
"AttachmentLinks": [
"attachmentlink1"
]
}
|
Name |
String |
optional |
Description |
|
Auth Token |
String |
mandatory |
Authorization Token of the account |
|
OrganizationId |
String |
mandatory |
Organization Id of the account |
|
BotId |
Number |
mandatory |
Bot Id of the template bot |
|
|
String |
optional** |
Email Address of the lead |
|
Phone |
String |
optional** |
Mobile Number of the lead |
|
TemplateName |
String |
mandatory |
Name of the template |
|
Arguments |
String[] |
optional |
Variable arguments of the template message body |
|
AttachmentLinks |
String[] |
optional |
Attachments sent along with the message |
**: Either Email or Phone is mandatory.
Note:
Kenyt Team will provide Auth Token, Organization ID, Bot ID and list of templates.
These can be managed from Kenyt Dashboard as well.
Sample Responses:
Response: 200 OK
{
"Id": null,
"Success": true,
"Message": "Message queued successfully"
}
Response :200 OK : Template name mismatch
{
"Id": null,
"Success": false,
"Message": "template not found"
}
Response :400 Bad Request
{
"Id": null,
"Success": false,
"Message": "Unable to queue message"
}
Response :400 If Template is not approved
{
"Id": null,
"Success": false,
"Message": "Unable to queue message Reason : The selected template is unapproved or inactive,sending message failed!!"
}
Response :401 Invalid Authorization Token
{
"Message": "Authorization Failed"
}
Sample Template : Lead Capture Template
[Automated lead notification]
New lead captured, Please follow up with the customer.
Name: {{1}}
Phone: {{2}}
Email: {{3}}
City: {{4}}, {{5}}
Address: {{6}}
Device: {{7}}
Browser: {{8}}
OS: {{9}}
{{10}}
Json Payload
{
"Name": "Pratyush xxxx",
"Email": "pratyushxxxx@gmail.com",
"Phone": "+917893xxxx",
"TemplateName": "Lead Capture Template",
"BotId": 100,
"Arguments": [
"Test Lead",
"+917777060101",
"test060101@test.com",
"Hyderabad",
"TG",
"NA",
"Mobile",
"Chrome",
"NA",
"2 bhk"
]
}
Output
Sample Template : Expo Template (with attachment)
We are proud to announce that we are the Title Sponsor for Times Property East Hyderabad Expo 2022.
We invite you to visit us on 25th & 26th June at our Platinum stall no PD – 1 & get a glimpse of the Kenyt Realestate – carefully crafted to suit modern needs with innovation and foresight!
Call for more Info: 9999 99 99 99
Json Payload
{
"Name": "Pratyush xxxx",
"Email": "pratyushxxxx@gmail.com",
"Phone": "+917893xxxx",
"TemplateName": "Expo Template",
"BotId": 100,
"AttachmentLinks": [
" https://media.glassdoor.com/sqll/2039232/kenyt-squarelogo-1560147016958.png"
]
}
Note
Attachment links can be changed per api call.
Output
