Versions Compared

Old Version 2

changes.mady.by.user Andrew Hill

Saved on

compared with

New Version Current

changes.mady.by.user Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title3.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

 



Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel1

Related pages:


Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

DescriptionDDesscripiptiion

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

DescriptionDDescriptioncription

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

API Specific Parameters

ParameterDescription

${RequestID}

The GUID generated within ServiceMobility when the REST Object Definitions Configuration Related Objects IVR Message Object was created.

Supported HTTP Methods

MethodDescription
GETRetrieves the current status of the IVR call request.
POSTSends a request to deliver a contact associated with a scheduled work order a preconceived message through a 3rd party interactive voice response system

Include Page
_Default HTTP Headers
_Default HTTP Headers

HTTP Body

The body contains a single IVR Message Object.

Include Page
_IVR Message Object Formats
_IVR Message Object Formats
 


Include Page
IVR Response Object
IVR Response Object