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 UTC.

Notes:

  • Campaign name is optional but has to be present.
  • Use any string value instead.
  • 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

CodeDescription
200Success
400Bad request (missing required fields or format not understood)
401Authentication failed
403User authenticated but does not have sufficient privileges
404Calling List is not found, record is not found, or invalid URL
Language
Credentials
Bearer
Click Try It! to start a request and see the response here!