Welcome to DSI IVR Web APIs!! Below are samples to Start With...

Customer Lookup by Phone Number

Request Type:

GET

URL:

http://150.136.21.50/api/IVR/phone?regioncode=SE&phonenumber=6735028

Response:

{
"Result": [
{
"Account": "8001474828",
"DisplayName": "NANCY BATTS",
"House": "3920",
"Unit": "203",
"Publication": "500",
"AreaCode": "407",
"PhoneNumber": "7911932"
"RunStatus": "F",
"AccountStatus": "",
"TerminationCode": "VR",
"FutureRestartDate": "5/31/2020 12:00:00 AM",
"FreqCode": null,
"DeliveryHolds": null
}
],
"Comment": null
}

Response: If No Data Found

{
"Result": [],
"Comment": "No Record Found!!"
}

Customer Lookup by Account Number

Request Type:

GET

URL:

http://150.136.21.50/api/IVR/account?regioncode=SE&accountnumber=8024820064

Response:

{
"Result": [
{
"Account": "8001474828",
"DisplayName": "NANCY BATTS",
"House": "3920",
"Unit": "203",
"Publication": "500",
"AreaCode": "407",
"PhoneNumber": "7911932"
"RunStatus": "F",
"AccountStatus": "",
"TerminationCode": "VR",
"FutureRestartDate": "5/31/2020 12:00:00 AM",
"FreqCode": null,
"DeliveryHolds": null
}
],
"Comment": null
}

Response: If No Data Found

{
"Result": [],
"Comment": "No Record Found!!"
}

Vacation Hold with “Forfeit” (no vacpack)

Request Type:

POST

URL:

http://150.136.21.50/api/IVR/vacationholdforfeit

Request Body:

{
"RegionCode":"SE",
"AccountNumber": "8041604961",
"StopDate": "02-FEB-20",
"StopReason": "VH",
"StopMemo": "IVR set stop date for NO VACPAK",
"RestartDate": "27-FEB-20",
"RestartSource": "VR",
"StopSource": "VO",
"Prisun": "N"
}

Vacation Hold with “Vacpack”

Request Type:

POST

URL:

http://150.136.21.50/api/IVR/vacationholdvacpack

Request Body:

{
"RegionCode":"SE",
"AccountNumber": "8001474828",
"FirstDate": "02-MAY-20",
"LastDate": "27-MAY-20",
"StopReason": "",
"Memo": "IVR set vacation start end dates"
}

Enter Complaint

Request Type:

POST

URL:

http://150.136.21.50/api/IVR/registercomplaint

Request Body:

{
"RegionCode":"SE",
"AccountNumber": "8001474828",
"FirstDate": "01-MAR-20",
"LastDate": "02-MAR-20",
"ComplaintCode": "MC",
"Amount": 0,
"Trouble": "N",
"Message": "IVR",
"MfCopies": 0,
"SatCopies": 0,
"SunCopies": 0
}

Inserting a Tag

Request Type:

POST

URL:

http://150.136.21.50/api/IVR/inserttag

Request Body:

{
"RegionCode":"SE",
"AccountNumber": "8001474828",
"TagCode": "AC"
}