API PREREQUISITES:
Your Teleduce account should be activated with Lead API mode
| URL | https://teleduce.corefactors.in/lead/retrieval/ |
| Header | API-KEY :<CUSTOMER API-KEY> |
| Method | GET |
| API Data | application /json (for POST) |
OPTIONAL FILTER PARAMETERS:
| Parameters | Parameter Value | Description |
| modified_at_range | today, this week, this month or start_date,end_date(YYYY-MM-DD,YYYY-MM-DD) | We can get the data based on given Modified date |
| created_at_range | today, this week, this month or start_date,end_date(YYYY-MM-DD,YYYY-MM-DD) | We can get the data based on given Created date |
PAGINATION PARAMETERS:
| Parameters | Parameter Value | Description |
| page | E.g: 1 or 2 | Lead data size Note: 1. Maximum data allowed in a single call is 100 Leads 2. If more than 100 leads are present, then to get them you can give subsequent requests with optional parameter “page” whose value should always be >= 1 3. To know if more leads are there or not , you can use the response data parameter “is_more_leads_available” in Success Response. 4. If is_more_leads_available = True you can give the next request to Lead API with below parameter values page = current_page + 1 record_size = current_record_size (if provided in previous request) 5. Default Values if not provided page = 1 record_size = 100 6.If you want to customise the Number of Leads in a single request you can use optional parameter “record_size” whose value should always be between 1-100 |
| record_size | E.g : 50 or 100 | Lead data size Note: 1. Maximum data allowed in a single call is 100 Leads 2. If more than 100 leads are present, then to get them you can give subsequent requests with optional parameter “page” whose value should always be >= 1 3. To know if more leads are there or not , you can use the response data parameter “is_more_leads_available” in Success Response. 4. If is_more_leads_available = True you can give the next request to Lead API with below parameter values page = current_page + 1 record_size = current_record_size (if provided in previous request) 5. Default Values if not provided page = 1 record_size = 100 6.If you want to customise the Number of Leads in a single request you can use optional parameter “record_size” whose value should always be between 1-100 |
PYTHON SAMPLE CODE:
| import requests import json url = “https://teleduce.corefactors.in/lead/retrieval/” header = { “API-KEY”:”xxxxxxxxxxxx”, ‘Content-Type’: ‘application/json’ } reqdata = requests.get(url, headers=header ) print (reqdata.content) |
SUCCESS RESPONSE FORMAT :
| { “response_code”: “7000”, “is_more_leads_available”: true, “response”: [ { “created_at”: “2019-06-18T12:28:22.364”, “Lead Revenue”: “0.00”, “Research”: “”, “Description”: “Crm Solution Providers//want to give the demo// he is resselling the software to the “, “Mobile”: “99142491xx”, “Leads Stages”: “Prospects”, “modified_at”: “2019-06-19T15:32:06.977”, “Requirement”: “”, “Lead Source”: “JustDial”, “Email”: “mpsb78@gmail.com”, “First Name”: “Maninder”, “Industry “: “Others”, “Lead Lost Reason”: “”, “Lead Owner”: “Akshay”, “ID”: “LD569615”, “PAN Number”: “”, “Lead Status”: “Open”, “Lead Group”: “lknn.m”, “Company Name”: “Corefactors”, “Lead type”: null } |
ERROR RESPONSE FORMAT :
{
“reponse” : “xxxxxxxxxx”,
“response_code”: “xxxxx”,
“response_type” : “error”,
}
API RESPONSE CODE and RESPONSES
| S.No | Code | Code Description |
| 1 | 7000 | Succes |
| 2 | 7001 | No Authentication Key |
| 3 | 7002 | Invalid Authentication Key |
| 4 | 7003 | Invalid Values for Page or Recordsize Parameter. Permitted range: > 1 |
| 5 | 7004 | Invalid Value for Recordsize Parameter. Permitted range: 1-100 |
| 6 | 7005 | Invalid Values for Page or Recordsize Parameter. Permitted Numericals in the range > 1 |
| 7 | 7006 | Invalid Value for created_at_range .Allowed format YYYY-MM-DD,YYYY-MM-DD |
| 8 | 7007 | Invalid Value for modified_at_range .Allowed format YYYY-MM-DD,YYYY-MM-DD |
| 9 | 7008 | No More Leads |
————————————————————————————————————————————————-
For any support required on API. Please write to support@corefactors.in.