REST Standard REST APIs IVR REST API

3.18.0

The IVR REST API provides the technician with the ability to send a contact associated with a scheduled work order a preconceived message through a 3rd party interactive voice response system. The 3rd party system may then update the mobile application through the same API using the request ID sent up with the IVR request.

Assumptions: REST System Categories IVR Messages and IVR Message Status Codes system categories have been configured appropriately.

Before the IVR REST API can be used for a given entity, it will be necessary to use the REST Configuration REST APIs Entity System Configuration REST API to update the entity's REST Object Definitions Configuration Related Objects Entity System Configuration Object and configure the RestApi.IVR property, to define the REST Endpoint URI of an API that implements the REST Interfaces IVR REST API Interface.

On this page:

Related pages:

Resource URL Summary

Get the current status of an IVR message request

GET /seiapi/v3/IVR/${RequestID}

Send an IVR message

POST /seiapi/v3/IVR/${RequestID}

API Specific Parameters

Parameter	Description
`${RequestID}`	The `GUID` generated within ServiceMobility when the REST Object Definitions Configuration Related Objects IVR Message Object was created.

Supported HTTP Methods

Method	Description
GET	Retrieves the current status of the IVR call request.
POST	Sends a request to deliver a contact associated with a scheduled work order a preconceived message through a 3rd party interactive voice response system.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.

HTTP Body

The body contains a single I VR Message Object.

JSON Format

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

Response Body

{
    "RequestID": "",
    "ContactName": "",
    "ContactNumber": "",
    "CallStatus": "${free text}"
}

Response Object Properties

Property	Type	Description
RequestID	string	Unique ID (GUID) generated by the originating system (ServiceMobility)
ContactName	string	Name of the targeted recipient
ContactNumber	string	Contact phone number for the targeted receipient
CallStatus	string	Status of the IVR call (see IVR Message Status Codes system category)