Billhighway Cloud API

<back to all web services

IvrStatusRequest

The following routes are available for this service:
GET/ivr/status
IvrStatusResponse Parameters:
NameParameterData TypeRequiredDescription
StatusformstringNo
MessageformstringNo

Allowable Values

  • Enabled
  • Disabled
  • Error
IsErrorformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /ivr/status HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<IvrStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.IVR">
  <Message xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.IVR">String</Message>
  <Status xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.IVR">String</Status>
</IvrStatusResponse>