Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

The API follows general HTTP response status codes. In addition to the status HTTP code included in the JSON response, you can also rely on the HTTP status code returned by the response.

...

Code Block
languagejson
{
  "message": "api cannot be executed during office hours time condition",
  "http_code": 403
}

Warning

HTTP status code -

442

400

Returns the following error response if the value passed for insert_leads is not a bool value or no value was provided.

Code Block
languagejson
{
  "message": "insert_leads must be a boolean value",
  "http_code": 442400
}

...

Returns the following error response if the value passed for delete_leads is not a bool value or no value was provided.

Code Block
languagejson
{
  "message": "delete_leads must be a boolean value",
  "http_code": 443400
}

...

HTTP status code - 444

Returns the following error response if the value passed for lead_ids is not an integer value or was passed with double quotes.

Code Block
languagejson
{
  "message": "lead_ids must only contain integer values",
  "lead_count": 1,
  "lead_ids": [
    "0"
  ],
  "http_code": 444400
}

Warning

HTTP status code - 445

Returns the following error response if no value was passed for lead_ids.

Code Block
languagejson
{
  "message": "lead_ids must contain atleast 1 value",
  "http_code": 445400
}

...

Returns the following error response if the values passed for lead_ids exceed 500 values.

Code Block
languagejson
{
  "message": "lead_ids cannot exceed 500 values",
  "http_code": 446400
}

Warning

HTTP status code - 447

Returns the following error response if the values passed for lead_ids contain duplicate values.

Code Block
languagejson
{
  "message": "lead_ids cannot contain duplicate values",
  "lead_count": 1,
  "lead_ids": [
    0
  ],
  "http_code": 447400
}

Warning

HTTP status code - 448

Returns the following error response if the values passed for lead_ids do not exist in the vicidial_list table.

Code Block
languagejson
{
  "message": "lead_ids does not exist",
  "lead_count": 1,
  "lead_ids": [
    0
  ],
  "http_code": 448400
}

Warning

HTTP status code -

449

500

Returns the following error response for any other errors not mentioned above.

Code Block
languagejson
{
  "message": "Unexpected character encountered while parsing number: s. Path 'lead_ids[97]', line 104, position 5.",
  "http_code": 449500
}

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.

...