Contents
- Introduction
- API Specification
- General Information
- Get campaigns
- Add a record
- Add a number of records
- Update a record
- Query a record
- Delete all records
- Get completed records
- Get updated records
- 1 Get all records
- Add records to DNC
- Replace records in DNC
Get all records
This returns all records of the specified calling list whose index is equal or greater than the specified number. Index is a record’s sequential number. Records are numbered in the order of insertion in the list starting from zero.
Time values are returned in the UTC time zone.
URL
http[s]://<host>:<port>/admin/ws/t/
<tenant_url>/callinglist/getAll/<list_name>/<campaign_name>
Method
POST
Request body
Initial index and maximum size of returned list; current implementation limits the maximum size to 1000 records (content type: application/json)
Example
{ |
Returns
200 – Record content and its current status within the specified campaign.
Body
Record content and status (content type: application/json)
The status part contains the results of calling this record within the specified campaign. Field names in this part are predefined. The Completed field is always present, while other fields may be absent if the record was never attempted or never reached the agent.
Example
[ { “index”:123000, “entry”: { } “status”: { } … ] |
Errors
400 – Bad request (missing mandatory fields or incorrect format)
401 – Authentication failed
403 – Authentication succeeded, but authorization failed (no privileges)
404 – Calling list is not found, or campaign is not found, or URL is invalid