| Line 5: | Line 5: | ||
== URL == | == URL == | ||
| − | http[s]:// | + | http[s]://<host>/admin/ws/t/<tenant_url>/callinglist/getCompleted/<list_name>/<campaign_name> |
| − | |||
| − | |||
== Method == | == Method == | ||
| Line 16: | Line 14: | ||
=== Example === | === Example === | ||
| − | { | + | { |
| − | + | "fromTime":"2013-03-01T13:15:06.456", | |
| − | + | "maxSize":"100" | |
| − | + | } | |
| − | |||
| − | |||
| − | |||
== Returns == | == Returns == | ||
| Line 33: | Line 28: | ||
=== Example === | === 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 | |
| − | “completed”: | + | “lastDate” : “2013-07-05T15:19:04.000+0400” // Timestamp of completion |
| − | “ lastDisposition” : | + | “lastPhone” : <phone num> // Phone number used in the last call attempt |
| − | “lastDate” : “2013-07-05T15:19:04.000+0400” // Timestamp of completion | + | “lastCallDuration” : <sec> // Duration of the last call attempt from the moment of customer answer |
| − | “lastPhone” : | + | “lastAgent”: <login_id> // Username of the agent who handled the last call attempt if successful |
| − | “lastCallDuration” : | + | “totalAttempts”: <num> // Total number of call attempts made for the record |
| − | “lastAgent”: | + | |
| − | “totalAttempts”: | + | } |
| − | + | } | |
| − | |||
| − | } | ||
| − | |||
== Errors == | == Errors == | ||
| Line 71: | Line 63: | ||
| − | |||
</translate> | </translate> | ||
Latest revision as of 23:09, 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
- 1 Get completed records
- Get updated records
- Get all records
- Add records to DNC
- Replace records in DNC
Get completed records
Get completed records 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>/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 predefined. The Completed field is always present and always set to true, while other fields may be absent if the record was never attempted or never reached the 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