REST Object Definitions Configuration Related Objects IVR Message Object

IVR Message Object Formats

JSON Format

{
    "RequestID": "",
    "Type": "", 
    "RefCode": "", 
    "Status": "", 
    "ContactName": "", 
    "ContactNumber": "", 
    "Message": {
       "code": "",
       "desc": ""
    } 
}

IVR Message Object Properties

Required properties are in Bold.

Property	Type	Description
RequestID	string	Contains a value that uniquely identifies the record. This must be a unique value across all IVR Message objects.
Type	string	Identifies the type of message. For future use.
RefCode	string	Contains a reference number (e.g. Work Order number) for the message.
Status	string	Contains the system of the message. See: REST System Categories IVR Message Status Codes
ContactName	string	Identifies the name of the associated with the phone number
ContactNumber	string	Contains phone number to send the IVR Message to.
Message	object	Contains the message details to send. Message format: code desc