Cache Status

Download OpenAPI specification:Download

cache-status_0

REST API to manage fallback cache for SIPRec service and routing fallback configuration for mediaservice functions.

Cache Status API Endpoints

Base url: https://api.prod-eu-north-1.iotcomms.io/cache

The cache API provides access to the fallback functions for the SIPRec service and the Mediaservice. The API can be used to resolve situations where connectivity is lost between iotcomms.io platform and the customer. It allows the services to be executed based on the previously cached data.

/{domain}/ivrfallback

GET

Query for a list of ivr fallback objects

Authorizations:
jwtAuthorizer
path Parameters
domain
required
string

Responses

Response Headers
Access-Control-Allow-Origin
string
Response Schema: application/json
data
Array of strings (An array containing the keys (numbers) of fallback objects currently stored)
success
boolean

Response samples

Content type
application/json
{
  • "data": [
    • "string"
    ],
  • "success": true
}

/{domain}/ivrfallback/{number}

GET

Query IVR fallback cache for configuration for a specific number

Authorizations:
jwtAuthorizer
path Parameters
domain
required
string
number
required
string

Responses

Response Headers
Access-Control-Allow-Origin
string
Response Schema: application/json
object (FallbackObject)
mode
string
Enum: "onError" "always"
ttl
number

The time to live (in seconds) of the object

object (FallbackInstruction)
object
sipFrom
string

Only applicable when action type is 'call'

xHeaders
object

This property allow custom X- headers to be added to the SIP request of the call generated in case the action is set to call.

sipDiversion
string

Only applicable when action type is 'call'

sipPAI
string

Only applicable when action type is 'call'

type
string
Enum: "call" "hangup"
contactParameters
object

This property allow custom URL parameters to be added to the contact: header of the call generated in case the action is set to call. It take an object of format {"prop1":"val1", "prop2":"val2"} as value resulting in the URL parameters prop1=val1;prop2=val2 to be appended to the contact: header.

sipTo
string

Only applicable when action type is 'call'

pHeaders
object

This property allow custom P- headers to be added to the SIP request of the call generated in case the action is set to call.

copyHeaders
Array of strings

This property is set to an array that contains the names of SIP headers starting with either the prefix P- or X- to be copied.

contactUserParameters
object

This property allow custom user parameters to be added to the user part of URL in contact: header of the call generated in case the action is set to call. It take an object of format {"prop1":"val1", "prop2":"val2"} as value resulting in the URL parameters prop1=val1;prop2=val2 to be appended to the user part of the URL in contact: header.

sipRPID
string

Only applicable when action type is 'call'

destAddr
string

Only applicable when action type is 'call'

maxRingTime
integer

Only applicable when action type is 'call'

Array of objects

List of files to be played or text to be played after translating via TTS

Array
fileName
string

Unique name of the prompt file if format is file or record. Name will not include filename extension

format
string

The type of phrase to be played

Type Notes
awstts Synthesize speech using AWS Polly
googletts Synthesize speech using Google TTS
url Fetch mp3 file from URL
file Fetch uploaded prompt file
cacheTimeToLive
string

The duration the cache of a phrase will be kept. Not applicable for the phrase type 'file'.

Enum Days
DAY 1
WEEK 7
MONTH 30
QUARTER 91
HALF-YEAR 182
googleTTSParameters
object

Parameters passed on to Googles API for synthesized speech. Only applicable for the 'googletts' phrase type

refreshCache
boolean

Instructs the IVR ignore the cache and obtain a new copy of the specified phrase. Only applicable for the 'url' & 'file' phrase types

awsTTSParameters
object

Parameters passed on to AWS Polly

success
boolean

Response samples

Content type
application/json
{
  • "data": {
    • "mode": "onError",
    • "ttl": 0,
    • "command": {
      • "action": {
        • "sipFrom": "string",
        • "xHeaders": { },
        • "sipDiversion": "string",
        • "sipPAI": "string",
        • "type": "call",
        • "contactParameters": { },
        • "sipTo": "string",
        • "pHeaders": { },
        • "copyHeaders": [
          • "string"
          ],
        • "contactUserParameters": { },
        • "sipRPID": "string",
        • "destAddr": "string",
        • "maxRingTime": 0
        },
      • "phrases": [
        • {
          • "fileName": "string",
          • "format": "string",
          • "cacheTimeToLive": "string",
          • "googleTTSParameters": { },
          • "refreshCache": true,
          • "awsTTSParameters": { }
          }
        ]
      }
    },
  • "success": true
}

/{domain}/ivrfallback/{number}

POST

Set IVR fallback configuration for a specific number

Authorizations:
jwtAuthorizer
path Parameters
domain
required
string
number
required
string
Request Body schema: application/json
required
mode
string
Enum: "onError" "always"
expiration
string
Default: "HALF-YEAR"

When the fallback object should expire. This property can either be a string in which case it behaves as a period of days (enum listed below) or as a number in which case it behaves as a unix timestamp (in seconds).

Enum Days
DAY 1
WEEK 7
MONTH 30
QUARTER 91
HALF-YEAR 182
object (FallbackInstruction)
object
sipFrom
string

Only applicable when action type is 'call'

xHeaders
object

This property allow custom X- headers to be added to the SIP request of the call generated in case the action is set to call.

sipDiversion
string

Only applicable when action type is 'call'

sipPAI
string

Only applicable when action type is 'call'

type
string
Enum: "call" "hangup"
contactParameters
object

This property allow custom URL parameters to be added to the contact: header of the call generated in case the action is set to call. It take an object of format {"prop1":"val1", "prop2":"val2"} as value resulting in the URL parameters prop1=val1;prop2=val2 to be appended to the contact: header.

sipTo
string

Only applicable when action type is 'call'

pHeaders
object

This property allow custom P- headers to be added to the SIP request of the call generated in case the action is set to call.

copyHeaders
Array of strings

This property is set to an array that contains the names of SIP headers starting with either the prefix P- or X- to be copied.

contactUserParameters
object

This property allow custom user parameters to be added to the user part of URL in contact: header of the call generated in case the action is set to call. It take an object of format {"prop1":"val1", "prop2":"val2"} as value resulting in the URL parameters prop1=val1;prop2=val2 to be appended to the user part of the URL in contact: header.

sipRPID
string

Only applicable when action type is 'call'

destAddr
string

Only applicable when action type is 'call'

maxRingTime
integer

Only applicable when action type is 'call'

Array of objects

List of files to be played or text to be played after translating via TTS

Array
fileName
string

Unique name of the prompt file if format is file or record. Name will not include filename extension

format
string

The type of phrase to be played

Type Notes
awstts Synthesize speech using AWS Polly
googletts Synthesize speech using Google TTS
url Fetch mp3 file from URL
file Fetch uploaded prompt file
cacheTimeToLive
string

The duration the cache of a phrase will be kept. Not applicable for the phrase type 'file'.

Enum Days
DAY 1
WEEK 7
MONTH 30
QUARTER 91
HALF-YEAR 182
googleTTSParameters
object

Parameters passed on to Googles API for synthesized speech. Only applicable for the 'googletts' phrase type

refreshCache
boolean

Instructs the IVR ignore the cache and obtain a new copy of the specified phrase. Only applicable for the 'url' & 'file' phrase types

awsTTSParameters
object

Parameters passed on to AWS Polly

Responses

Response Headers
Access-Control-Allow-Origin
string
Response Schema: application/json
success
boolean

Indicates if the API call was successful or not

Request samples

Content type
application/json
{
  • "mode": "onError",
  • "expiration": "HALF-YEAR",
  • "command": {
    • "action": {
      • "sipFrom": "string",
      • "xHeaders": { },
      • "sipDiversion": "string",
      • "sipPAI": "string",
      • "type": "call",
      • "contactParameters": { },
      • "sipTo": "string",
      • "pHeaders": { },
      • "copyHeaders": [
        • "string"
        ],
      • "contactUserParameters": { },
      • "sipRPID": "string",
      • "destAddr": "string",
      • "maxRingTime": 0
      },
    • "phrases": [
      • {
        • "fileName": "string",
        • "format": "string",
        • "cacheTimeToLive": "string",
        • "googleTTSParameters": { },
        • "refreshCache": true,
        • "awsTTSParameters": { }
        }
      ]
    }
}

Response samples

Content type
application/json
{
  • "success": true
}

/{domain}/ivrfallback/{number}

DELETE

Delete IVR fallback configuration for a specific number from cache

Authorizations:
jwtAuthorizer
path Parameters
domain
required
string
number
required
string

Responses

Response Headers
Access-Control-Allow-Origin
string
Response Schema: application/json
success
boolean

Indicates if the API call was successful or not

Response samples

Content type
application/json
{
  • "success": true
}

/{domain}/ivrfallback/{number}

OPTIONS
path Parameters
domain
required
string
number
required
string

Responses

Response Headers
Access-Control-Allow-Origin
string
Access-Control-Allow-Methods
string
Access-Control-Allow-Headers
string
Response Schema: application/json
object (Empty Schema)

Response samples

Content type
application/json
{ }

/{domain}/siprecfallback/{number}

GET

Query SIPRec fallback cache for status of a specific number

Authorizations:
jwtAuthorizer
path Parameters
domain
required
string
number
required
string

Responses

Response Headers
Access-Control-Allow-Origin
string
Response Schema: application/json
inCache
boolean

Indicates whether the number is persistent in the cache or not.

Response samples

Content type
application/json
{
  • "inCache": true
}

/{domain}/siprecfallback/{number}

DELETE

Delete specific number from SIPRec fallback cache

Authorizations:
jwtAuthorizer
path Parameters
domain
required
string
number
required
string

Responses

Response Headers
Access-Control-Allow-Origin
string
Response Schema: application/json
deleted
boolean

Indicates whether the number was deleted from the cache or not. Attempts to delete non-existing number will return false.

Response samples

Content type
application/json
{
  • "deleted": true
}

/{domain}/siprecfallback/{number}

OPTIONS
path Parameters
domain
required
string
number
required
string

Responses

Response Headers
Access-Control-Allow-Origin
string
Access-Control-Allow-Methods
string
Access-Control-Allow-Headers
string
Response Schema: application/json
object (Empty Schema)

Response samples

Content type
application/json
{ }