GET api/IVRStatus

Gets the current status and configuration of the IVR system.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Returns information about the IVR system.

IVRStatus

Name	Description	Type	Additional information
Enabled	Gets or sets whether IVR is currently enabled.	boolean	None.
ServiceUrl	Gets or sets the URL of the IVR Service, if applicable.	string	None.
ConnectionOK	Gets or sets whether we currently have access to the IVR Service.	boolean	None.
ConnectionErrorMessage	Gets or sets the error that occurred if we failed to connect to the IVR Service. Empty if connection succeeded.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "enabled": true,
  "serviceUrl": "sample string 2",
  "connectionOK": true,
  "connectionErrorMessage": "sample string 4"
}

application/xml, text/xml

Sample:

<IVRStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <ConnectionErrorMessage>sample string 4</ConnectionErrorMessage>
  <ConnectionOK>true</ConnectionOK>
  <Enabled>true</Enabled>
  <ServiceUrl>sample string 2</ServiceUrl>
</IVRStatus>