Header
All request must contains "X-ApiKey" header with ClientKey in there
ClientKey example: "0d4852a98cbf4c8csb0cdee1b6f31e95f"
...
Campaign - Dialer campaign name. Can be empty to return all cases to dial.
CaseGroup - Case Group name. Can be empty to return cases from all case groups.
Records - number of records to return.
Auto-change - true/false. Automatically change the status to “In the Dialer” for returned cases.
Return Values
| Code Block | ||
|---|---|---|
| ||
[
{
"CaseID": 6,
"Phones": [
{
"PhoneName": "Cell",
"Phone": "4025555759",
"Primary": true,
"Text": true
},
{
"PhoneName": "Home",
"Phone": "4025551234",
"Primary": false,
"Text": false
}
],
"CaseStatus": "LIT 04 - Answer Received",
"DialerStatus": "To Dial",
"Campaign": "Intake follow-up",
"Attempts": "1",
"DialDateTime": "2020-07-28T23:02:00",
"ZipCode": "68046"
}
] |
...
| Code Block | ||
|---|---|---|
| ||
{
"CaseID": 7,
"Phones": [
{
"PhoneName": "Home Primary Phone",
"Phone": "4023205759",
"Primary": true,
"Text": false
},
{
"PhoneName": "Cell",
"Phone": "4025758268",
"Primary": false,
"Text": false
}
],
"CaseStatus": "LIT 03 - Lawsuit Served",
"DialerStatus": "Do not dial",
"Campaign": "Intake follow-up",
"Attempts": "1",
"DialDateTime": "2020-06-09T11:26:00",
"ZipCode": "11235"
} |
UpdateCaseStatus
Updated Updates status for one or more cases. Only CaseID is required, the rest of the parameters can be omitted if no update is needed.
Parameters
CaseID - SmartAdvocate case id
Status - New Dialer Status to be set (To Dial/In the Dialer/Do not Dial). Can be empty, in which case the status will not be updated.
NextCall - date/time of the next call. Should be used in conjunction with “To Dial” dialer status. For “In the Dialer” and “Do not Dial” current date/time should be used.
Attempts - Attempts count. Updates Attempts status in SmartAdvocate.
Disposition - New Last Dialer Disposition status to be set.
...