Show Hide

 

Feedback

  • Contents
 

REST API Value Types

Type

Example values

String

Valid JSON-format string, numbers, true, false, or null

Boolean

  • true

  • false

  • true

  • false

  • 0

  • 1

Integer

  • 123

  • 123

Note: Range restrictions may apply.

Number

  • 1.5

  • 1.5

Note: Range restrictions may apply.

OneOf

String that matches one of the multiple acceptable values for an Interaction Media Server configuration setting.

Directory

String containing a directory path or the friendly name of a network interface on the server.

Network interface

  • Any (matches any network interface on the Interaction Media Server host.

  • IP address of a network interface on the Interaction Media Server host.

  • Friendly name, such as Local Area Connection.

For example, the Interaction Media Server property, Recording Retrieval HTTP Interface, can accept Any or a friendly name of a network interface card (NIC) on the Interaction Media Server host.

Port range

  • 16384-32767

  • 16384,32767

DSCP value

An integer from 0 to 63

IP address

  • 127.0.0.1

  • 2001:db8:a0b:12f0::1

IP address type

  • all

  • IP4

  • IP6

  • IP4IP6

CPU mask

An array of Boolean values where the first position represents CPU 0