Show Hide

 

Feedback

  • Contents
 

REST API Restrictions

The Interaction Media Server REST API has the following restrictions:

  • The body component of a REST API request must specify the Content-Type header as application/json. If the body component of the REST API request is empty, you can exclude the Content-Type header. Failure to set the Content-Type header as application/json for a non-empty body component returns a 400 Bad Request status code.

  • Uniform Resource Identifiers (URIs) are case-sensitive.

  • The REST API allows only the following characters in Interaction Media Server property names: 

    :.$-_
0123456789
abcdefghijklmnopqrstuvwxyz
ABCDEFGHIJKLMNOPQRSTUVWXYZ

  • Names for Interaction Media Server parameters and properties are case-sensitive. Ensure that you use the necessary case when specifying parameter and property names. For example, a REST API request for the notifierdscpvalue property does not match the NotifierDscpValue property.

  • Interaction Media Server parameters require a value. If you do not specify a value when adding a parameter through a PUT request, the REST API uses the default value. You cannot create custom Interaction Media Server parameters.

  • Interaction Media Server properties do not require a value. If you do not specify a value when adding a parameter through a PUT request, the REST API does not create a value. Interaction Media Server disregards any property that does not have a value. You can create custom Interaction Media Server properties.

  • The system restricts some values for Interaction Media Server parameters and properties in their length, range, and formats. Failure to specify valid parameter and property values in REST API request returns an error. For more information about REST API values and formats, see REST API Value Types. For more information about valid values for Interaction Media Server parameters and properties, see Interaction Media Server Config-Parameters Page and Interaction Media Server Config-Properties Page.

  • The Interaction Media Server REST API uses the same port as the Recording Retrieval process on Interaction Media Server. The default value is 8102. You cannot define separate network ports for the Recording Retrieval process and the REST API. To change this port number, edit the value for the Recording Retrieval HTTP Port parameter on the Config-Parameters page of the Interaction Media Server web interface.