Billhighway Cloud API

<back to all web services

IvrStatusRequest

The following routes are available for this service:
GET/ivr/status
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IvrStatusResponse(IvrStatusResponse, IHaveErrorField):
    status: Optional[str] = None
    message: Optional[str] = None
    # @ApiMember(ExcludeInSchema=true)
    is_error: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IvrStatusRequest(IvrStatusRequest):
    pass

Python IvrStatusRequest DTOs

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>