API Details

send Navigate to XML API

This REST API is used for send mail.

End Point	https://www.vcareapi.com:8080/mail
Field (Short Description)	Value/Tag Name	Format	Field Example	Type	Notes	Validation rules
action		String	send	Required	This needs to be passed as send	send
sender_name		String		Required
sender_email		String		Required
subject		String		Required
body		String		Required
receiver_name		String		Required
receiver_email		String		Required
source		String	API	Required	Source of the order/application	Expected Value:API, TABLET, WEBSITE
agent_id		String	John Doe	Required	This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.
agent_password		String	JohnDoe	Conditional	This is the password for the Agent Id mentioned above. This is configuration level field. If you have set the permissions for the Agent Id for the requirement of the password in API transactions then you will need to pass the Agent Password in all the REST API transaction, else if you have set the permissions to password not required then you don't need to pass the Agent Password in the REST API.

Sample Request REST

{
    "sender_name": "Cintex Wireless",
    "action": "send",
    "sender_email": "postmaster@mg.cintexwireless.com",
    "subject": "Cintex Wireless Forgot Password .",
    "body": "<html>\r\n\t\t\t\t\t\t<body>\r\n\t\t\t\t\t\t<div align="center">\r\n\t\t\t\t\t\t<table style="background: #ccc;" border="0" width="100%" cellspacing="0" cellpadding="0">\r\n\t\t\t\t\t\t<tbody>\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td style="background: #395701; ;padding: 8px 25px; color: #fff;">\r\n\t\t\t\t\t\t<div align="center">\r\n\t\t\t\t\t\t<table border="0" width="600" cellspacing="0" cellpadding="0">\r\n\t\t\t\t\t\t<tbody>\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td>\r\n\t\t\t\t\t\t<p align="right"><a style="color: #fff;" href="https:\/\/stage.cintexwireless.com\/AboutLifeline.php" target="_blank" rel="noopener">Lifeline Program<\/a>&nbsp;|&nbsp;<a style="color: #fff;" href="https:\/\/stage.cintexwireless.com\/AboutUs.php" target="_blank" rel="noopener">About Us<\/a>&nbsp;|&nbsp;<a style="color: #fff;" href="https:\/\/stage.cintexwireless.com\/FAQsHelpCenter.php" target="_blank" rel="noopener">Help Center<\/a>&nbsp;|&nbsp;<a style="color: #fff;" href="https:\/\/stage.cintexwireless.com\/Support.php" target="_blank" rel="noopener">Support<\/a><\/p>\r\n\t\t\t\t\t\t<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\t\t\t\t\t\t<\/tbody>\r\n\t\t\t\t\t\t<\/table>\r\n\t\t\t\t\t\t<\/div>\r\n\t\t\t\t\t\t<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td valign="top">\r\n\t\t\t\t\t\t<div align="center">\r\n\t\t\t\t\t\t<table style="margin-top: 10px;" border="0" width="600" cellspacing="0" cellpadding="0">\r\n\t\t\t\t\t\t<tbody>\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td>&nbsp;<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\t\t\t\t\t\t<\/tbody>\r\n\t\t\t\t\t\t<\/table>\r\n\t\t\t\t\t\t<table style="margin-top: 10px; background-color: #fff;" border="0" width="600" cellspacing="0" cellpadding="0">\r\n\t\t\t\t\t\t<tbody>\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td style="padding: 0 25px;">&nbsp;<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td style="padding: 0 25px;">\r\n\t\t\t\t\t\t<p style="margin-top: 15px;"><a href="#"><img src="https:\/\/stage.cintexwireless.com\/images\/logo.png" width="150" height="" \/><\/a><\/p>\r\n\t\t\t\t\t\t<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td style="padding: 0 25px;">\r\n\t\t\t\t\t\t <p style="text-align:center; font-weight:bold; color: #002478;font-size: 18px;margin-top: 40px; padding-left:30px">Thank you for choosing Cintex Wireless!<\/p>\r\n\r\n\t\t\t\t\t\t<p style="margin-top: 35px;"> <strong>Dear ARAYNARD AHILTON, <\/strong><\/p>\r\n\r\n\t\t\t\t\t\t\t\t\t\t\t<p style="margin-top:15px ;">Reset your account password.<\/p>\r\n\t\t\t\t\t\t\t\t\t\t\t<p style="margin-top: ;">Please click on below button to continue to set new password.<\/p>\r\n\r\n\t\t\t\t\t\t<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td>\r\n\t\t\t\t\t\t<table style="margin-bottom: 20px;" border="0" width="100%" cellspacing="0" cellpadding="0">\r\n\t\t\t\t\t\t<tbody>\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td>&nbsp;<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td style="text-align: right; width: 30%;" valign="top"><img style="text-align: center; width: 40px;" src="https:\/\/stage.cintexwireless.com\/images\/hand_arrow.gif" width="30" height="" \/><\/td>\r\n\t\t\t\t\t\t<td style="text-align: left; width: 50%;" valign="top" width="150">\r\n\t\t\t\t\t\t<table border="0" width="100%" cellspacing="0" cellpadding="0">\r\n\t\t\t\t\t\t<tbody>\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td style="background-color: #09f; text-align: center; font-weight: bold;" align="center bgcolor="#09F" width="68%" height="30"><a style="color: #fff; text-decoration: none; font-weight: bold;" href="https:\/\/stage.cintexwireless.com\/UpdatePassword.php?NFMxZTRYRDRjaFNjbDZob2twNzNGcnJQQ2tON0hvdXZFNHo4cTBabFVJNUVtdmNSTWh1WStVMENVcTIxVTFwWjVmMEtnM1B6ZDcvdkhaRGtLSFlodmtkc2JNT1JmaTk5dU5YeTI1WmRFVWdSNUVnZHdyZG1hcDJUL3c5Y05TSng4YnE1czVNeFJNV2ZLWE1CQ2xvS01FN1E0Zmo0V3EydnppbE0rVkZnK0EvR2Q5dVpHaldIY1ZLTk5hbElHSFJYdEE5VklJRloxZjVrcWlRWjUwalljQT09">Continue To Set New Password<\/a><\/td>\r\n\t\t\t\t\t\t<td width="4%">&nbsp;<\/td>\r\n\t\t\t\t\t\t<td width="28%">&nbsp;<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\r\n\r\n\r\n\t\t\t\t\t\t<\/tbody>\r\n\t\t\t\t\t\t<\/table>\r\n\t\t\t\t\t\t<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\r\n\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td colspan="3" style="padding: 0 25px;">\r\n\t\t\t\t\t\t\t<p style="margin-top: 15px;"><strong>Note:-<\/strong> <i>This link will be expire.<\/i><\/p>\r\n\t\t\t\t\t\t<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td>&nbsp;<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\r\n\t\t\t\t\t\t<\/tbody>\r\n\t\t\t\t\t\t<\/table>\r\n\t\t\t\t\t\t<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\t\t\t\t\t\t<\/tbody>\r\n\t\t\t\t\t\t<\/table>\r\n\t\t\t\t\t\t<\/div>\r\n\t\t\t\t\t\t<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td valign="top">\r\n\t\t\t\t\t\t<div align="center">\r\n\t\t\t\t\t\t<table style="margin-top: 10px;" border="0" width="600" cellspacing="0" cellpadding="0">\r\n\t\t\t\t\t\t<tbody>\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td>&nbsp;<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\t\t\t\t\t\t<\/tbody>\r\n\t\t\t\t\t\t<\/table>\r\n\t\t\t\t\t\t<table style="margin-top: 10px; background: #fff;" border="0" width="600" cellspacing="0" cellpadding="0">\r\n\t\t\t\t\t\t<tbody>\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td style="background: #395701; ;padding: 8px 25px; color: #fff;">\r\n\t\t\t\t\t\t<p><strong>Need Help?<\/strong><\/p>\r\n\t\t\t\t\t\t<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td style="padding: 0 25px;">\r\n\t\t\t\t\t\t<p style="margin-top: 15px;">Visit our <a class="help-center" href="https:\/\/stage.cintexwireless.com\/FAQsHelpCenter.php" target="_blank" rel="noopener">Help Center<\/a> or call us at 1-(855) 655-3097.<\/p>\r\n\t\t\t\t\t\t<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td style="padding: 0 25px;">\r\n\t\t\t\t\t\t<p style="margin-top: 15px;">Thank You,<br \/>Cintex Wireless<\/p>\r\n\t\t\t\t\t\t<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td style="padding: 0 25px;">\r\n\t\t\t\t\t\t<p style="margin-top: 15px;">&nbsp;<\/p>\r\n\t\t\t\t\t\t<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td style="background: #395701; ;padding: 8px 25px; color: #fff;text-align:center">\r\n\r\n\t\t\t\t\t\t<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\t\t\t\t\t\t<\/tbody>\r\n\t\t\t\t\t\t<\/table>\r\n\t\t\t\t\t\t<\/div>\r\n\t\t\t\t\t\t<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t<td valign="top" height="100">&nbsp;<\/td>\r\n\t\t\t\t\t\t<\/tr>\r\n\r\n\t\t\t\t\t\t<\/tbody>\r\n\t\t\t\t\t\t<\/table>\r\n\t\t\t\t\t\t<\/div>\r\n\t\t\t\t\t\t<\/body>\r\n\t\t\t\t\t\t<\/html>",
    "receiver_name": [
        "ARAYNARD AHILTON"
    ],
    "receiver_email": [
        "tesops@vcaremail.com"
    ],
    "agent_id": "ewebsiteapi",
    "source": "WEBSITE"   
}

List of status code, description and resolution.
Status Code	Description	How to Resolve?
RESTAPI000	SUCCESS	SUCCESS
RESTAPI001	FAIL	Multiple errors like Invalid Token, Token already used, Token expire & Invalid Access!!
RESTAPI101	FAIL	Module required.
RESTAPI102	FAIL	Action required.
RESTAPI103	FAIL	Source Not Allowed.
RESTAPI104	FAIL	Invalid Agent ID or Password.
RESTAPI105	FAIL	Module does not exist.
RESTAPI106	FAIL	Action does not exist.
RESTAPI107	FAIL	Invalid company.
RESTAPI108	FAIL	Invalid method.
RESTAPI109	FAIL	Unauthorized Access.
RESTAPI010	FAIL	Multiple errors come in an array.

Sample Response

{
    "msg_code": "RESTAPI000",
    "msg": "Email sent successfully"
}

SUCCESS

Sample Fail Response: 1

{
    
    "msg": "Invalid Token",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}

Error Description: Invalid Token

How to Resolve?: Provide valid token in header

Sample Fail Response: 2

{
    
    "msg": "Invalid Access!!",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}

Error Description: Invalid Access!!

How to Resolve?: Request method will be POST

Sample Fail Response: 3

{
    "errors":["Source Not Allowed"]
    "msg": "Source Not Allowed",
    "msg_code": "RESTAPI103",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}

Error Description: Source Not Allowed

How to Resolve?: Provide valid Source

Sample Fail Response: 4

{
    "errors":["Agent Id should not be blank"]
    "msg": "Agent Id should not be blank",
    "msg_code": "RESTAPI104",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}

Error Description: Agent Id should not be blank

How to Resolve?: Provide valid Agent Id

Sample Fail Response: 5

{
    "errors":["Invalid Agent Id"]
    "msg": "Invalid Agent Id",
    "msg_code": "RESTAPI104",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}

Error Description: Invalid Agent Id

How to Resolve?: Provide valid Agent Id

Sample Fail Response: 6

{
    
    "msg": "Token already used",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}

Error Description: Token already used

How to Resolve?: You can use token once per request

Sample Fail Response: 7

{
    
    "msg": "Token expire",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}

Error Description: Token expire

How to Resolve?: Create token again

Sample Fail Response: 8

{
    "errors":["Please enter Enrollment Id"]
    "msg": "Error occurred",
    "msg_code": "RESTAPI110",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}

Error Description: Error occurred

How to Resolve?: Provide Enrollment Id

All the status codes are listed under the status code sections. Please click here to go to the status code.