Versions Compared

Old Version 5

changes.mady.by.user Mickey Bushman

Saved on

compared with

New Version 6

changes.mady.by.user Mickey Bushman

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space MOBUD and version 3

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.

Note

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.


 

Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel1

Related pages:

Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

ParameterDescription

${RequestID}

The GUID generated within ServiceMobility when the REST Object Definitions Configuration Work Order Activity 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