From Bright Pattern Documentation
| Line 1: | Line 1: | ||
<translate>= Query a Record= | <translate>= Query a Record= | ||
This method queries the status of an existing record in the specified calling list in the specified campaign. It returns an error if a record with the same values of unique keys as configured in the list definition does not exist. All time values are returned in the UTC time zone. | This method queries the status of an existing record in the specified calling list in the specified campaign. It returns an error if a record with the same values of unique keys as configured in the list definition does not exist. All time values are returned in the UTC time zone. | ||
| − | |||
== Request == | == Request == | ||
=== URL === | === URL === | ||
| − | http[s]://<host | + | http[s]://<host>/configapi/v2/callinglist/get/<list_name>/<campaignname> |
=== Method === | === Method === | ||
| Line 58: | Line 57: | ||
* Field names are predefined. | * Field names are predefined. | ||
* “Completed” is always present; all other fields may be absent if the record was never called or never reached agent. | * “Completed” is always present; all other fields may be absent if the record was never called or never reached agent. | ||
| − | |||
=== Response Codes === | === Response Codes === | ||
| Line 80: | Line 78: | ||
| Calling List is not found, record is not found, or invalid URL | | Calling List is not found, record is not found, or invalid URL | ||
|} | |} | ||
| − | |||
=== Body === | === Body === | ||
| Line 88: | Line 85: | ||
| − | + | ||
</translate> | </translate> | ||
Revision as of 23:05, 17 September 2018
<translate>= Query a Record= This method queries the status of an existing record in the specified calling list in the specified campaign. It returns an error if a record with the same values of unique keys as configured in the list definition does not exist. All time values are returned in the UTC time zone.
Request
URL
http[s]://<host>/configapi/v2/callinglist/get/<list_name>/<campaignname>
Method
POST
Body Content Type
JSON object
Body
{
"keyfieldName_1":"value_1",
...
"keyfieldName_n":"value_n"
}
Notes
- Campaign name is optional but has to be present.
- Use any string value instead.
Result
{ “entry”: {
"fieldName_1":"value_1",
...
"fieldName_n":"value_n"
}
“status”: {
“completed”: <Boolean>, // Boolean true/false
“lastDisposition” : <DispositionName>, // Final disposition if completed,
// last call attempt disposition
// otherwise
“lastDate” : “2013-07-05T15:19:04.000” // date completed or last call
// attempt made (ISO 8601 format )
“lastPhone” : <phone num> // Phone number used in final attempt
// or last attempt otherwise
“lastCallDuration” : <sec> // Call duration of last call attempt,
// total
“lastAgent”: <login_id> // Login ID of the agent who
// handled the last call
“totalAttempts”: <num> // Total number of call attempts
// made per record, counts all numbers.
}
}
Notes
- The request can contain either a full or partial set of fields for the object, but the key fields are mandatory.
- Only key fields are used for the object search; the non-key fields are ignored.
- There are two sub-objects in the returned JSON.
- The “entry” contains a copy of the list entry.
- Field names are provided as they were defined during list creation.
- The “status” contains the results of calling this record in this campaign.
- Field names are predefined.
- “Completed” is always present; all other fields may be absent if the record was never called or never reached agent.
Response Codes
| Code | Description |
| 200 | Success |
| 400 | Bad request (missing required fields or format not understood) |
| 401 | Authentication failed |
| 403 | User authenticated but does not have sufficient privileges |
| 404 | Calling List is not found, record is not found, or invalid URL |
Body
JSON object containing all fields for the record
</translate>