From Bright Pattern Documentation
< 3.13:List-management-api-specification
Revision as of 22:52, 26 August 2016 by Sasha (talk | contribs) (Created new topic from branched topic Documentation:ServicePattern:list-management-api-specification:Getcompletedrecords:3.12)
(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 completed records

Description Returns records of the specified calling list that have been completed within the specified campaign since the specified date and time. Time values are returned in the UTC time zone.
URL http[s]://<host>:<port>/admin/ws/t/

<tenant_url>/callinglist/getCompleted/<list_name>/<campaign_name>

Method POST
Request body Initial time in ISO format and maximum size of returned list. Current implementation limits maximum size to 1000 records (content type: application/json). Example:

{
        "fromTime":"2013-03-01T13:15:06.456",
        "maxSize":"100"
}

Returns 200 – Content and results of records completed within the specified campaign.
Body Content and result details of completed records (content type: application/json). The status part contains the results of completed records within the specified campaign. Field names in this part are pre-defined. The Completed field is always present and always set to true, other fields may be absent if record was never attempted or never reached agent. Example:

{

“completedTime”:“2013-03-01T13:15:06.456”, // UTC timezone

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

}

“status”: {
“completed”: <Boolean>, // Boolean, always true
“ lastDisposition” : <DispositionName>, // Final record disposition
“lastDate” : “2013-07-05T15:19:04.000+0400” // Timestamp of completion
“lastPhone” : <phone num> // Phone number used in the last call attempt
“lastCallDuration” : <sec> // Duration of the last call attempt from the moment of customer answer
“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 >
< Previous | Next >