Document toolboxDocument toolbox

IVR Message Object

This object details about an IVR Message.

IVR Messages are generated by the mobile device.

On this page:

Related pages:

IVR Message Object Formats

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

IVR Message Object Properties

(info) Required properties are in Bold.

PropertyTypeDescription
RequestIDstringContains a value that uniquely identifies the record. This must be a unique value across all IVR Message objects.
Typestring

Identifies the type of message. For future use.

RefCodestring

Contains a reference number (e.g. Work Order number) for the message.

Statusstring

Contains the system of the message.

See: IVR Message Status Codes

ContactNamestringIdentifies the name of the associated with the phone number
ContactNumberstringContains phone number to send the IVR Message to.

Message


object

Contains the message details to send.

Message format:

  • code
  • desc