Header
All request must contains "X-ApiKey" header with ClientKey in there
ClientKey example: "0d4852a98cbf4c8csb0cdee1b6f31e95f"
...
SmartAdvocate system needs to be configured to work with predictive dialing system. Below is the description of the typical configuration.
Three Four status types will be created:
...
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":515512,
"Note":"Test case note"
} |
AddCaseNoteByPhone
Adds a note to cases found by phone number. If the phone is assigned with several cases, then the note will be added to all open cases, if there are no open ones, then all closed
Parameters
Phone - Plaintiff’s phone number
Note - text of the note
Code Block | ||
---|---|---|
| ||
{
"Phone":"1234567890",
"Note":"Test case note"
} |
...