Document toolboxDocument toolbox

IVR REST API Interface

Owned by Mickey Bushman
Last updated: Oct 03, 2024 by Jason Andrew
4 min read

3.18.0

The IVR REST API Interface defines the REST API interface which customers will need to implement if they would like ServiceMobility to send IVR messages via their own systems.

By implementing an API which matches the IVR REST API Interface, customers can configure ServiceMobility (via the Entity System Configuration object) so that requests to send an IVR message via the IVR REST API are passed through to their system.

On this page:

Related pages:

Resource URL Summary

Send an IVR message

POST <REST Endpoint URI>

API Specific Parameters

ParameterDescription

{0}

ServiceMobility with replace the text {0} within the configured REST Endpoint URI with the value of the ${RequestID} parameter from the initiating IVR REST API call.

(warning) It is mandatory for the REST Endpoint URI to contain the text {0} within the URI at some point.

HTTP Headers

ServiceMobility will set both of the Standard HTTP Headers when calling this REST API Interface.

That is:

  • The Content-Type header will be set to application/json; and
  • The x-access-token header will be set to the JWT that was used in the call to the API that triggered ServiceMobility to call the configured endpoint that implements this interface.

The x-access-token header will either be the JWT issued by ServiceMobility, or by the endpoint that implements the Authentication REST API Interface that ServiceMobility has been configured to use.

Implementations of this interface may evaluate the JWT supplied, if required, but please note that ServiceMobility will have already authenticated the JWT in the initial API call before passing the call on to the configured endpoint.

API Specifics

Send an IVR message

This REST API must send the requested IVR message.

URL

POST <REST Endpoint URI>

HTTP Request Body

The HTTP request body will contain a valid IVR Message Object.

HTTP Response

Response Codes

HTTP CodeDescription
200OK. The IVR message was sent successfully.
401Invalid Logon.
500Server error. An error occurred while processing the request. The HTTP response body should have more details as to the possible cause.

On success, an HTTP response code of 200 must be returned, and the response body must contain a valid response body that is the same as would be returned from the IVR REST API.

ServiceMobility will return the response code (and response body, if present) as the response to the initiating IVR REST API call.