From Bright Pattern Documentation
< 3.11:List-management-api-specification
Revision as of 20:12, 11 May 2016 by Sasha (talk | contribs) (Created new topic from branched topic Documentation:ServicePattern:list-management-api-specification:Getallrecords:3.10)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
• 3.10 • 3.11 • 3.12 • 3.13 • 3.14 • 3.15 • 3.16 • 3.17 • 3.18

Get all records

Description 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 maximum size to 1000 records (content type: application/json). Example:

{
        "fromIndex":"123456",
        "maxSize":"100"
}

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 pre-defined. The Completed field is always present, other fields may be absent if record was never attempted or never reached agent. Example:

[

{

“index”:123000,

“entry”: {
        "fieldName_1":"value_1",
        ...
        "fieldName_n":"value_n"

}

“status”: {
“completed”: <Boolean>, // Boolean true/false
“ lastDisposition” : <DispositionName>, // For completed records, final record disposition; otherwise, disposition of the last call attempt
“lastDate” : “2013-07-05T15:19:04.000” // Timestamp of the last call attempt (ISO 8601 format )
“lastPhone” : <phone num> // Phone number used in the last call attempt
“lastCallDuration” : <sec> // Duration of the last call attempt
“lastAgent”: <login_id> // Username of the agent who handled the last call attempt if successful
“totalAttempts”: <num> // Total number of call attempts made for the record

}
},

]

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

< Previous | Next >