...
| Info |
|---|
API is allowed to operate within office hours. |
The endpoint URL server address will be provided by TForge.
...
Method | Endpoint | Description |
|---|
POST | https://server/vicidial/lead/dearchive/customer_name | Lead dearchive endpoint |
...
Disable SSL verification upon sending the request.
For testing, create a dummy list and load 500 leads into that list.
Use created lead IDs and archive leads using the Lead Archive API.
...
| Code Block |
|---|
|
{
"successmessage": "lead_ids batch was successfully processed",
"select_count": 1,
"insert_count": 1,
"delete_count": 1,
"statushttp_code": 200
} |
| Warning |
|---|
HTTP status code - 441 |
...
| Code Block |
|---|
|
{
"errormessage": "api cannot be executed during office hours time condition",
"statushttp_code": 441
} |
| Warning |
|---|
HTTP status code - 442 |
...
| Code Block |
|---|
|
{
"errormessage": "insert_leads must be a boolean value",
"statushttp_code": 442
} |
| Warning |
|---|
HTTP status code - 443 |
...
| Code Block |
|---|
|
{
"errormessage": "delete_leads must be a boolean value",
"statushttp_code": 443
} |
| Warning |
|---|
HTTP status code - 444 |
...
| Code Block |
|---|
|
{
"errormessage": "lead_ids must only contain integer values",
"lead_count": 1,
"lead_ids": [
"0"
],
"statushttp_code": 444
} |
| Warning |
|---|
HTTP status code - 445 |
...
| Code Block |
|---|
|
{
"errormessage": "lead_ids must contain atleast 1 value",
"statushttp_code": 445
} |
| Warning |
|---|
HTTP status code - 446 |
...
| Code Block |
|---|
|
{
"errormessage": "lead_ids cannot exceed 500 values",
"statushttp_code": 446
} |
| Warning |
|---|
HTTP status code - 447 |
...
| Code Block |
|---|
|
{
"errormessage": "lead_ids cannot contain duplicate values",
"lead_count": 1,
"lead_ids": [
0
],
"statushttp_code": 447
} |
| Warning |
|---|
HTTP status code - 448 |
...
| Code Block |
|---|
|
{
"errormessage": "lead_ids does not exist",
"lead_count": 1,
"values": [
0
],
"statushttp_code": 448
} |
| Warning |
|---|
HTTP status code - 449 |
...
| Code Block |
|---|
|
{
"errormessage": "Unexpected character encountered while parsing number: s. Path 'lead_ids[97]', line 104, position 5.",
"statushttp_code": 449
} |
Conclusion
If you encounter any issues with the API, please log a ticket with our support department. You can also contact us at 010-035-0909 or email our dedicated Customer Experience team at cex@teleforge.co.za. Please ensure to include your ticket number for reference and expedited support.
...