• 3.10 • 3.11 • 3.12 • 3.13 • 3.14 • 3.15 • 3.16 • 3.17 • 3.18

Query a record

Description	Queries the status of a record of specified calling list in the specified campaign. 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>:<port>/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 pre-defined. The Completed field is always present, other fields may be absent if record was never attempted or never reached 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

< Previous | Next >