GetCallsHistoryForDateRange
Usage
Allows clients to retrieve the Calls history from the Debitsuccess billing system based on the specified parameters.
Since this API call does not have pagination, our recommendation is to apply smaller date ranges (not more than 30 days) otherwise, you may receive timeout errors.
Parameters
Name | Data Type | Length |
| Description |
|---|---|---|---|---|
|
|
|
| Date/time message was processed |
|
|
|
|
|
|
|
|
| Unique ID for the user |
| String |
| Required | Provided by Debitsuccess |
| String |
| Required | Provided by Debitsuccess |
| String | 100 | Optional | Allows requesting user to be logged |
| DateTime |
| Required | Start of the reporting period |
| DateTime |
| Optional | End of the reporting period |
* Following is a list of the different combinations of parameters which can be used for this method:
Providing StartDate and EndDate parameter returns all the Calls history during the specified period for all accounts
Providing the StartDate parameter returns all the Calls history from the specified date for all accounts
Response
Name | Data Type | Description |
|---|---|---|
DateCreated | DateTime | Date/time message was processed |
Id | String | Unique ID for the message |
ResponseNotes () |
| Collection of validation messages |
| String |
|
| String |
|
| Enum | Error, Warning, Info |
Status | Enum | Failed, Succeed, Unknown |
AccountReferenceNo | String | Debitsuccess Reference |
ExternalAccountReferenceNo | String | External account reference |
CallNotes () |
|
|
| String | Debitsuccess Reference |
| String | External account reference |
| String | Call Notes |
| String | CA (Call Attempt) CCI (CC Form In) CE (Client Enquiry) COM (Complaint) CR (Cancellation Request) CS (Customer Service) CU (Catch Up Arranged) DC (Detail Change) DDI (DD Form In) FAC (Facility Enquiry) FD (Final Credit Control Call) FDC (Final Credit Control Call Cancelation) FDD (Final Credit Control Call Deferral) FIR (First Payment Reversal) GTR (Guarantor Details Updated) HLD (Hold Refer To Author) LTR (Letter) OD (Overdue Call) OD1 (OD 1 Letter) OD2 (OD 2 Letter) OD3 (OD 3 Letter) ODM (OD Call Spoke to Member) ODP (OD Call Payment Made) ODS (OD Call Payment Scheduled) ODX (OD Call Left Message) PAY (Payment) PC (Payment Variation) RDC (Reinstated from Debt Collection) REE (Re Enrolment) REF (Refund Request) RTF (Reported To Facility) RTM (Returned Mail) RV (Review) SDC (Debt Collection) SUS (Suspension) SYS (System Update) TRN (Transfer) WCL (Welcome Letter) |
| String | Channel |
| DateTime | Call note date |
Error Code
Type | Error Code | Error Message |
|---|---|---|
Error | 02 | Invalid user credentials |
Info | 00 | Success |
Related Pages
On this page: