From Bright Pattern Documentation
Get All Records
Calling list records are sequentially numbered in order of insertion, beginning from zero. This method returns a list of records in the calling list that has an index that is greater than or to equal to the requested record index.
Input parameters are "initial record index" and "maximum size of returned list." Current implementation limits "maxSize" to 1000 records. All time values are returned in UTC.
Request
URL
http[s]://<host>/configapi/v2/callinglist/getAll/<list_name>/<campaign_name>
Method
POST
Body Content Type
JSON object
Body
{
"fromIndex":123456,
"maxSize":100
}
Result
[
{
“index”:123000,
“entry”: {
"fieldName_1":"value_1",
...
"fieldName_n":"value_n"
}
“status”: {
“completed”: <Boolean>, // Boolean true/false
“lastDisposition” : <DispositionName>, // Final disposition if completed,
// last call attempt disposition
// otherwise
“lastDate” : “2013-07-05T15:19:04.000”// date completed or last call
// attempt made
“lastPhone” : <phone num> // Phone number used in final attempt
// or last attempt otherwise
“lastCallDuration” : <sec> // Call duration from the moment of
// customer answer
“lastAgent”: <login_id> // Login ID of the agent who
// handled the last call
“totalAttempts”: <num> // Total number of call attempts
// made per record, counts all numbers.
}
},
…
]
Notes
- The returned list contains JSON objects sorted by index.
- The “entry” field of these objects contains a copy of the list entry
- Field names are provided as they were defined during list creation.
- The “status” field contains the results of calling this record in this campaign.
- Field names are predefined.
- “Completed” is always present; all other fields may be absent if the record was never called or never reached the agent.
Response Codes
| Code | Description |
| 200 | Success |
| 400 | Bad request (missing required request fields or format not understood) |
| 401 | Authentication failed |
| 403 | User authenticated but does not have sufficient privileges |
| 404 | Calling List is not found, campaign is not found, or invalid URL |
Body
List of JSON objects