From Bright Pattern Documentation
| Line 5: | Line 5: | ||
== URL== | == URL== | ||
| − | http[s]:// | + | http[s]://<host>/admin/ws/t/<tenant_url>/callinglist/getChanged/<list_name>/<campaign_name> |
| − | |||
| − | |||
== Method == | == Method == | ||
| Line 16: | Line 14: | ||
=== Example === | === Example === | ||
| − | { | + | { |
| − | + | "fromTime":"2013-03-01T13:15:06.456", | |
| − | + | "maxSize":"100" | |
| − | + | } | |
| − | |||
| − | |||
| − | |||
== Returns == | == Returns == | ||
| Line 31: | Line 26: | ||
=== Example === | === Example === | ||
| − | { | + | { |
| − | + | ||
| − | + | “entry”: { | |
| − | + | "fieldName_1":"value_1", | |
| − | + | ... | |
| − | + | "fieldName_n":"value_n" | |
| − | + | ||
| − | + | } | |
| − | + | ||
| − | + | “completed”: false, | |
| − | + | “recordDisposition” : <DispositionName>, // Record disposition name | |
| − | + | “recordDispositionCode”:99, | |
| − | “recordDisposition” : | + | “totalAttempts”: <num> // Total number of call attempts made for the record. |
| − | “recordDispositionCode”:99, | + | |
| − | “totalAttempts”: | + | “attempts”: [ |
| − | + | { | |
| − | + | “call_attempted”:<true/false>, // Indication of whether there was an attempt to dial any of the record numbers, some actions like adding number to DNC are not actual call attempts | |
| − | { | + | “ disposition” : <DispositionName>, // Call attempt disposition |
| − | “call_attempted”: | + | “dispositionCode” : 88, |
| − | “ disposition” : | + | “date” : “2013-07-05T15:19:04.000”, // Date of call attempt |
| − | “dispositionCode” : 88, | + | “phone” : <phone num>, // Phone number used in this attempt |
| − | “date” : “2013-07-05T15:19:04.000”, // Date of call attempt | + | “callNotes”: <text>, // Call notes provided by the agent for this call attempt if successful |
| − | “phone” : | + | “agent”: <login_id>, // Username of the agent who handled this call attempt if successful |
| − | “callNotes”: | + | “CPAResult”:<CPA result name>, // Result of call progress analysis |
| − | “agent”: | + | “dialingDuration”: <sec>, // Duration of dialing from initiation of the attempt till network signaling reported the call as answered |
| − | “CPAResult”: | + | “CPADuration”: <sec>, // Duration of call progress analysis from the network answer signal till the decision about the type of answer |
| − | “dialingDuration”: | + | “callDuration” : <sec> // Duration of call from detection of live voice till call termination. |
| − | “CPADuration”: | + | }, |
| − | “callDuration” : | + | … |
| − | }, | + | ] |
| − | … | + | }, |
| − | ] | + | … |
| − | }, | + | ] |
| − | |||
| − | |||
| − | |||
| − | |||
== Errors == | == Errors == | ||
| Line 81: | Line 72: | ||
| − | + | ||
</translate> | </translate> | ||
Latest revision as of 23:14, 17 September 2018
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
- 1 Get updated records
- Get all records
- Add records to DNC
- Replace records in DNC
List Management API Specification
Get updated records
This returns records of the specified calling list that have had any activity within the specified campaign since the specified date and time.
Time values are returned in the UTC time zone.
URL
http[s]://<host>/admin/ws/t/<tenant_url>/callinglist/getChanged/<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 detailed results of records updated within the specified campaign
Body
Content and details of call attempts of all records updated since the specified time (content type: application/json). The attempts part contains the attempts results in a format similar to the one used for detailed campaign result export. For more information, see the Reporting Reference Guide, section Campaign Results. Attempts are sorted by time, starting from the most recent one.
Example
{
“entry”: {
"fieldName_1":"value_1",
...
"fieldName_n":"value_n"
}
“completed”: false,
“recordDisposition” : <DispositionName>, // Record disposition name
“recordDispositionCode”:99,
“totalAttempts”: <num> // Total number of call attempts made for the record.
“attempts”: [
{
“call_attempted”:<true/false>, // Indication of whether there was an attempt to dial any of the record numbers, some actions like adding number to DNC are not actual 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 this attempt
“callNotes”: <text>, // Call notes provided by the agent for this call attempt if successful
“agent”: <login_id>, // Username of the agent who handled this call attempt if successful
“CPAResult”:<CPA result name>, // Result of call progress analysis
“dialingDuration”: <sec>, // Duration of dialing from initiation of the attempt till network signaling reported the call as answered
“CPADuration”: <sec>, // Duration of call progress analysis from the network answer signal till the decision about the type of answer
“callDuration” : <sec> // Duration of call from detection of live voice till call termination.
},
…
]
},
…
]
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