get
https://api.servetel.in/v1/broadcast/leads/
This API allows you to fetch list of leads in lead list.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Sample Request
curl --request GET \
--url https://api.servetel.in/v1/broadcast/leads/id \
--header 'accept: application/json'📘 Important!
Before we begin, note that the * sign denotes the mandatory variables in each table.
Request Variables (Path Params)
The following parameter is required to fetch list of leads in lead list:
| Variable Name | Description | Data Type |
|---|---|---|
| id | Unique ID of the broadcast List to which the lead corresponds to | String |
Sample Response
[
{
"id": 21025113,
"lead_id": 21025113,
"list_id": 5358,
"field_0": "+9188888888882",
"field_1": "xyz",
"field_2": null,
"field_3": null,
"field_4": null,
"field_5": "1200",
"field_6": "July 2",
"skill_id": null,
"move_to_hopper_status": 1,
"time_group": null,
"added_by": 10959,
"created_by": 10959,
"dial_status": 2,
"lead_picked": 0,
"available_at": {
"$date": {
"$numberLong": "1608049043000"
}
},
"dialer_dial_status": 0,
"created_at": {
"$date": {
"$numberLong": "1593030529000"
}
},
"retry_count": 0,
"alternate_phone_number": null,
"priority": null,
"list_name": "June Payment Collection",
"header": "[\"Phone Number\",\"Name\",\"Email Id\",\"Address\",\"Company Name\",\"Due Amount\",\"Due Date\"]",
"sensitive_field_map": null,
"dialer_skill": null
},Response Variables
The response returned is as following:
| Variable Name | Description | Data Type |
|---|---|---|
| id | Unique ID of the broadcast List to which the lead corresponds to | String |
| lead_id | Unique ID of the Lead | Integer |
| list_id | Unique ID of the Broadcast List the lead corresponds to | Integer |
| field_0 | Phone Number of the Lead | String |
| field_1 | Name for the Lead | String |
| field_2 | Email of the Lead | String |
| field_3 | Address for the Lead | String |
| field_4 | Company Name of the Lead | String |
| field_5 | Custom Field. | String |
| field_6 | Custom Field. | String |
| skill_id | Unique ID of the skill assigned to the lead. | Integer |
| time_group | Unique ID of the time group assigned to the lead. | Integer |
| added_by | Unique ID of the client. | Integer |
| created_by | Unique ID of the client. | Integer |
| dial_status | Status of the lead. For example: "1" => "New", "2" => "Message Played" , "3" => "DTMF Pressed", "4" => "No Answer", "5" => "DND", "6" => "Busy", "7" => "Congestion", "8" => "Failed", "9" => "Account DND". | Integer |
| lead_picked | Whether the call is answered by the lead or not. | Integer |
| available_at.$date.$numberLong | Total time for which the lead was available to call. | String |
| dialer_dial_status | Disposition status of the lead in the lead list. For example: 'New' => 0, 'Undisposed' => -1, 'Number in Account DND List' => -2, 'Number in Public DND List' => -3, 'Emergency' => -4, 'Call Drop' => -5, 'Channel Limit Reached' => -6, 'Number in Account Block List' => -7. | Integer |
| created_at.$date.$numberLong | Time at which the lead was created in the list | String |
| retry_count | Times for which the call has been retried for the lead. | String |
| alternate_phone_number | Alternate phone number of the lead. | String |
| priority | Priority at which the lead will be selected to dial. Note: Priority should be between 1 and 30 where 30 is highest and 1 is lowest. | Integer |
| list_name | Name of the List Lead corresponds to | String |
| header | Name of all the detail fields that corresponds to the Lead | JSON |
| sensitive_field_map | Number of fields mapped with the lead that are sensitive. | String. |
| dialer_skill | ID and name of the skill list assigned to the lead. | Object |
fields can increase like field_7, field_8 etc. according to the field array that is set while creating the Broadcast List.