| Line 5: | Line 5: | ||
== URL == | == URL == | ||
| − | http[s]:// | + | http[s]://<host>/admin/ws/t/<tenant_url>/callinglist/get/<list_name>/<campaign_name> |
| − | |||
| − | |||
== Method == | == Method == | ||
| Line 16: | Line 14: | ||
=== Example === | === Example === | ||
| − | { | + | { |
| − | + | "keyfieldName_1":"value_1", | |
| − | + | ... | |
| − | + | "keyfieldName_n":"value_n" | |
| − | + | } | |
| − | |||
| − | |||
| − | |||
== Returns == | == Returns == | ||
| Line 34: | Line 29: | ||
=== Example === | === Example === | ||
| − | + | { “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 | |
| − | “completed”: | + | “lastDate” : “2013-07-05T15:19:04.000” // Timestamp of the last call attempt (ISO 8601 format ) |
| − | “ lastDisposition” : | + | “lastPhone” : <phone num> // Phone number used in the last call attempt |
| − | “lastDate” : “2013-07-05T15:19:04.000” // Timestamp of the last call attempt (ISO 8601 format ) | + | “lastCallDuration” : <sec> // Duration of the last call attempt |
| − | “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 68: | Line 60: | ||
| − | + | ||
</translate> | </translate> | ||
Latest revision as of 23:04, 17 September 2018
Contents
- Introduction
- API Specification
- General Information
- Get campaigns
- Add a record
- Add a number of records
- Update a record
- 1 Query a record
- Delete all records
- Get completed records
- Get updated records
- Get all records
- Add records to DNC
- Replace records in DNC
Query a record
Query a record queries the status of a record of the specified calling list in the specified campaign. In addition, it returns an error if the record with specified values of unique keys does not exist.
Time values are returned in the UTC time zone.
URL
http[s]://<host>/admin/ws/t/<tenant_url>/callinglist/get/<list_name>/<campaign_name>
Method
POST
Request body
Names and values of unique keys, i.e., fields used for record identification (content type: application/json)
Example
{
"keyfieldName_1":"value_1",
...
"keyfieldName_n":"value_n"
}
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 predefined. The Completed field is always present, while other fields may be absent if the record was never attempted or never reached the agent.
Example
{ “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 record is not found, or URL is invalid