• 5.19 • 5.2 • 5.3 • 5.8

Get Updated Records

This method returns records of the specified calling list that have had any activity within the specified campaign since the requested initial time (UTC). Input parameters are the initial time in ISO format and the maximum size of the returned list. Current implementation limits "maxSize" to 1000 records.

All time values are returned in UTC.

Request

URL

http[s]://<host>/configapi/v2/callinglist/getChanged/<list_name>/<campaign_name>

Method

POST

Body Content Type

JSON object

Body

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

Result

[
{
“entry”: {
       "fieldName_1":"value_1",
        ...
        "fieldName_n":"value_n"
  }
  “completed”:  false,
“recordDisposition” : <DispositionName>, // RecordDisposition name
“recordDispositionCode”:99, 
“totalAttempts”: <num>                   // Total number of call attempts
                                         // made per record,
                                         // counts all numbers.
 “attempts”: [
{
     “call_attempted”:<true/false>,      // some actions like addition/removal
                                         // to DNC are not call attempts
“disposition” : <DispositionName>,  // call attempt disposition 
“dispositionCode” : 88,
“date”  : “2013-07-05T15:19:04.000”,// date of call attempt
“phone” : <phone num>,              // Phone number used in attempt
“callNotes”: <text>,
“agent”: <login_id>,                // Login ID of the agent who handled
                                    // the last call
“CPAResult”:<CPA result name>,      // Call Progress Analysis
“dialingDuration”: <sec>,           // duration from start call until
                                    // phone network answer received
“cpaDuration”: <sec>,               // duration from the network answer until
                                    // voice answer was detected
“duration” : <sec>                  // Call duration of last call attempt,
                                    // talk time
 },
…
]
},
…
] 

Notes

• The result format is similar to the “long format” export of the list.
• Returned list contains JSON objects sorted by completion time.
• 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 “attempts” field contains a copy of call attempts for this record.
• Attempts are sorted by time with the most recent attempt first .

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

< Previous | Next >