/icws/{sessionId}/messaging/messages

GET

/icws/{sessionId}/messaging/messages

Retrieves any queued message representations from the server.

This endpoint is equivalent in functionality to the Event Source with same resource URL, but the response is a JSON payload. The messages should be requested frequently with a short-polling mechanism.

Applications should not utilize this GET method for retrieving messages and the event source in a single session. For more information on handling message retrieval, see Retrieving Messages.

Feature Version
messaging 1

Request

Parameters
Type
Name
Comments
Template
sessionId

Required

The ININ session ID necessary for all calls that require a security or user context.

    Header
    Cookie

    Required

    The session cookie. With the exception of the connection request, all requests must provide a session cookie.

      Response

      200 - OK
      A request to Get messages from the server succeeded. The messages representation is available in the entity body.
      Property
      Value
      Comments

      Multiple options:

      The value can be assigned any of the following options.
      __type
      "urn:inin.com:configuration.people:accessControlGroupsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      id
      String

      Required

      The unique identifier used to reference this configuration object.
      displayName
      String
      The display name of this configuration object.

      This property can be null.

      uri
      Uri
      A URI used to access this configuration object.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      name
      String

      Required

      The key identifying this pair.
      value
      String

      Required

      The value of this pair.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      isPermanent
      Boolean

      This is a read only property and can not be changed with PUT or POST operations.

      Feature Version
      configuration 2

      Setting this property to null will set it to its default value.

      Default value: false

      removed
      List [1,*]: String
      __type
      "urn:inin.com:configuration.people:accountCodesConfigurationMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      accountCodesEnabled
      Boolean
      Property to enable the use of account codes.

      Setting this property to null will set it to its default value.

      Default value: false

      __type
      "urn:inin.com:configuration.people:accountCodesMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      description
      String

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      removed
      List [1,*]: String
      __type
      "urn:inin.com:configuration.system:actionsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      dde
      0
      customScreenPop
      1
      webBrowserScreenPop
      2
      url
      String

      Required

      The URL to open in the browser.
      new
      0
      Pop to a new browser (only supported in Internet Explorer and Firefox).
      tab
      1
      Pop to a new tab on an existing browser session (Not supported in web-based clients).
      name
      String

      Required

      The name to identify the parameter.
      friendlyName
      String

      Required

      The name displayed to the user.
      allow
      0
      Allow override.
      restrict
      1
      Allow override with restricted values(multiple choice).
      disallow
      2
      Do not allow override.
      defaultValue
      String
      The value to use when Attendant overrides are disallowed, or the default value to use then they are allowed or restricted.

      This property can be null.

      [key]
      String

      Required

      [value]
      String

      Required

      removed
      List [1,*]: String
      __type
      "urn:inin.com:alerts:alertCatalogChangedMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      __type
      "urn:inin.com:alerts:alertSet"

      Required

      The JSON type representing this option.
      none
      0
      Access mode has not been set.
      ownerDefault
      1
      Access to the owner's default alert set.
      owned
      2
      Access as an owned alert set.
      shared
      3
      Other users may access and subscribe to the alert set in a read-only manner.
      subscribed
      4
      Indicates whether the alert set is currently subscribed to.
      description
      String
      The description.
      displayString
      String
      The display string.
      owner
      String

      Required

      Gets the owner of the alert set.
      __type
      "urn:inin.com:alerts:alertDefinition"

      Required

      The JSON type representing this option.
      alertDefinitionId
      String

      The ID for the alert definition. This parameter should be defined for update operations.

      Note

      The alertDefinitionId represents a string formatted GUID. If an alertDefintionId is not provided a GUID ID will be automicatlly generated as the alert definition is updated.

      description
      String
      The description.
      displayString
      String
      The display string.
      isEditable
      Boolean

      Required

      A value indicating whether this instance is editable.
      statisticIdentifier
      String

      Required

      Gets the statistic defintion.
      parameterTypeId
      String

      Required

      This member needs to match the ID of a parameter type exactly.
      value
      String

      Required

      This member either needs to match a parameter value exactly or be set to an empty string to use a default value.
      __type
      "urn:inin.com:alerts:alertRule"

      Required

      The JSON type representing this option.
      alertActionId
      String

      Gets the action ID. This parameter should be defined for update operations.

      Note

      The alertActionId represents a string formatted GUID. If an alertActionId is not provided a GUID ID will be automicatlly generated as the alert action is updated.

      isEditable
      Boolean

      Required

      A value indicating whether this instance is editable.
      targetId
      String

      Required

      The target ID who the alert action is destined for.
      [key]
      String

      Required

      The key identifying this pair.
      [value]
      String

      Required

      The value of this pair.
      alertRuleId
      String

      The ID for the Alert Rule. This parameter should be defined for update operations.

      Note

      The alertRuleId represents a string formatted GUID. If an alertRuleId is not provided a GUID ID will be automicatlly generated as the alert rule is updated.

      none
      0
      Alert severity is not set.
      normal
      1
      The status of the resource is normal.
      minor
      2
      An alert level that indicates a problem of relatively low severity that should not impede use of the resource.
      major
      3
      An alert level that indicates some kind of possibly service-affecting problem with the resource. The severity of the problem is relatively high and normal use of the resource is likely to be impaired.
      warning
      4
      An alert level that indicates a condition exists that could potentially cause a problem with the resource.
      critical
      5
      An alert level that indicates a severe problem exists with the resource and normal use is disrupted or severely impeded. This is the most severe alarm level.
      isEditable
      Boolean

      Required

      A value indicating whether this instance is editable.

      Multiple options:

      The value can be assigned any of the following options.
      __type
      "urn:inin.com:alerts:boolCondition"

      Required

      The JSON type representing this option.
      alertConditionId
      String
      unknown
      0
      Represents the condition has not been specified yet.
      isNotAvailable
      1
      Repesents a condition where IsNull is true (True in Visual Basic), which indicates a null reference (Nothing in Visual Basic), or not set value.
      isAvailable
      2
      Repesents a condition where IsNull is false (False in Visual Basic), which indicates a valid value other than a null reference (Nothing in Visual Basic).
      isTrue
      3
      Represents a condition where the boolean value is expected to be true (True in Visual Basic).
      isFalse
      4
      Represents a condition where the boolean value is expected to be false (False in Visual Basic).
      isLessThan
      5
      Represents a condition where the numeric value is expected to be less than the minimum.
      isGreaterThan
      6
      Represents a condition where the numeric value is expected to be greater than the maximum.
      range
      7
      Represents a condition where the numeric value is between the lower and the upper bound (minimum and maximum).
      equalTo
      8
      Represents a condition where a StatisticValue string value is equal to the comparison value.
      notEqualTo
      9
      Represents a condition where a StatisticValue string value is not equal to the comparison value.
      contains
      10
      Represents a condition where a StatisticValue string value contains the comparison value.
      doesNotContain
      11
      Represents a condition where a StatisticValue string value does not contain the comparison value.
      matchesPrefix
      12
      Represents a condition where a StatisticValue string value matches the prefix.
      __type
      "urn:inin.com:alerts:numericDoubleCondition"

      Required

      The JSON type representing this option.
      alertConditionId
      String
      unknown
      0
      Represents the condition has not been specified yet.
      isNotAvailable
      1
      Repesents a condition where IsNull is true (True in Visual Basic), which indicates a null reference (Nothing in Visual Basic), or not set value.
      isAvailable
      2
      Repesents a condition where IsNull is false (False in Visual Basic), which indicates a valid value other than a null reference (Nothing in Visual Basic).
      isTrue
      3
      Represents a condition where the boolean value is expected to be true (True in Visual Basic).
      isFalse
      4
      Represents a condition where the boolean value is expected to be false (False in Visual Basic).
      isLessThan
      5
      Represents a condition where the numeric value is expected to be less than the minimum.
      isGreaterThan
      6
      Represents a condition where the numeric value is expected to be greater than the maximum.
      range
      7
      Represents a condition where the numeric value is between the lower and the upper bound (minimum and maximum).
      equalTo
      8
      Represents a condition where a StatisticValue string value is equal to the comparison value.
      notEqualTo
      9
      Represents a condition where a StatisticValue string value is not equal to the comparison value.
      contains
      10
      Represents a condition where a StatisticValue string value contains the comparison value.
      doesNotContain
      11
      Represents a condition where a StatisticValue string value does not contain the comparison value.
      matchesPrefix
      12
      Represents a condition where a StatisticValue string value matches the prefix.
      minimum
      Double

      Required

      maximum
      Double

      Required

      __type
      "urn:inin.com:alerts:numericIntCondition"

      Required

      The JSON type representing this option.
      alertConditionId
      String
      unknown
      0
      Represents the condition has not been specified yet.
      isNotAvailable
      1
      Repesents a condition where IsNull is true (True in Visual Basic), which indicates a null reference (Nothing in Visual Basic), or not set value.
      isAvailable
      2
      Repesents a condition where IsNull is false (False in Visual Basic), which indicates a valid value other than a null reference (Nothing in Visual Basic).
      isTrue
      3
      Represents a condition where the boolean value is expected to be true (True in Visual Basic).
      isFalse
      4
      Represents a condition where the boolean value is expected to be false (False in Visual Basic).
      isLessThan
      5
      Represents a condition where the numeric value is expected to be less than the minimum.
      isGreaterThan
      6
      Represents a condition where the numeric value is expected to be greater than the maximum.
      range
      7
      Represents a condition where the numeric value is between the lower and the upper bound (minimum and maximum).
      equalTo
      8
      Represents a condition where a StatisticValue string value is equal to the comparison value.
      notEqualTo
      9
      Represents a condition where a StatisticValue string value is not equal to the comparison value.
      contains
      10
      Represents a condition where a StatisticValue string value contains the comparison value.
      doesNotContain
      11
      Represents a condition where a StatisticValue string value does not contain the comparison value.
      matchesPrefix
      12
      Represents a condition where a StatisticValue string value matches the prefix.
      minimum
      Int

      Required

      maximum
      Int

      Required

      __type
      "urn:inin.com:alerts:numericTimeSpanCondition"

      Required

      The JSON type representing this option.
      alertConditionId
      String
      unknown
      0
      Represents the condition has not been specified yet.
      isNotAvailable
      1
      Repesents a condition where IsNull is true (True in Visual Basic), which indicates a null reference (Nothing in Visual Basic), or not set value.
      isAvailable
      2
      Repesents a condition where IsNull is false (False in Visual Basic), which indicates a valid value other than a null reference (Nothing in Visual Basic).
      isTrue
      3
      Represents a condition where the boolean value is expected to be true (True in Visual Basic).
      isFalse
      4
      Represents a condition where the boolean value is expected to be false (False in Visual Basic).
      isLessThan
      5
      Represents a condition where the numeric value is expected to be less than the minimum.
      isGreaterThan
      6
      Represents a condition where the numeric value is expected to be greater than the maximum.
      range
      7
      Represents a condition where the numeric value is between the lower and the upper bound (minimum and maximum).
      equalTo
      8
      Represents a condition where a StatisticValue string value is equal to the comparison value.
      notEqualTo
      9
      Represents a condition where a StatisticValue string value is not equal to the comparison value.
      contains
      10
      Represents a condition where a StatisticValue string value contains the comparison value.
      doesNotContain
      11
      Represents a condition where a StatisticValue string value does not contain the comparison value.
      matchesPrefix
      12
      Represents a condition where a StatisticValue string value matches the prefix.
      minimum
      Duration

      Required

      maximum
      Duration

      Required

      __type
      "urn:inin.com:alerts:numericTimeStampCondition"

      Required

      The JSON type representing this option.
      alertConditionId
      String
      unknown
      0
      Represents the condition has not been specified yet.
      isNotAvailable
      1
      Repesents a condition where IsNull is true (True in Visual Basic), which indicates a null reference (Nothing in Visual Basic), or not set value.
      isAvailable
      2
      Repesents a condition where IsNull is false (False in Visual Basic), which indicates a valid value other than a null reference (Nothing in Visual Basic).
      isTrue
      3
      Represents a condition where the boolean value is expected to be true (True in Visual Basic).
      isFalse
      4
      Represents a condition where the boolean value is expected to be false (False in Visual Basic).
      isLessThan
      5
      Represents a condition where the numeric value is expected to be less than the minimum.
      isGreaterThan
      6
      Represents a condition where the numeric value is expected to be greater than the maximum.
      range
      7
      Represents a condition where the numeric value is between the lower and the upper bound (minimum and maximum).
      equalTo
      8
      Represents a condition where a StatisticValue string value is equal to the comparison value.
      notEqualTo
      9
      Represents a condition where a StatisticValue string value is not equal to the comparison value.
      contains
      10
      Represents a condition where a StatisticValue string value contains the comparison value.
      doesNotContain
      11
      Represents a condition where a StatisticValue string value does not contain the comparison value.
      matchesPrefix
      12
      Represents a condition where a StatisticValue string value matches the prefix.
      minimum
      DateTime

      Required

      maximum
      DateTime

      Required

      __type
      "urn:inin.com:alerts:stringCondition"

      Required

      The JSON type representing this option.
      alertConditionId
      String
      unknown
      0
      Represents the condition has not been specified yet.
      isNotAvailable
      1
      Repesents a condition where IsNull is true (True in Visual Basic), which indicates a null reference (Nothing in Visual Basic), or not set value.
      isAvailable
      2
      Repesents a condition where IsNull is false (False in Visual Basic), which indicates a valid value other than a null reference (Nothing in Visual Basic).
      isTrue
      3
      Represents a condition where the boolean value is expected to be true (True in Visual Basic).
      isFalse
      4
      Represents a condition where the boolean value is expected to be false (False in Visual Basic).
      isLessThan
      5
      Represents a condition where the numeric value is expected to be less than the minimum.
      isGreaterThan
      6
      Represents a condition where the numeric value is expected to be greater than the maximum.
      range
      7
      Represents a condition where the numeric value is between the lower and the upper bound (minimum and maximum).
      equalTo
      8
      Represents a condition where a StatisticValue string value is equal to the comparison value.
      notEqualTo
      9
      Represents a condition where a StatisticValue string value is not equal to the comparison value.
      contains
      10
      Represents a condition where a StatisticValue string value contains the comparison value.
      doesNotContain
      11
      Represents a condition where a StatisticValue string value does not contain the comparison value.
      matchesPrefix
      12
      Represents a condition where a StatisticValue string value matches the prefix.
      text
      String

      Required

      alertSetId
      String

      Required

      The ID of the alert set.

      Note

      The alertSetId represents a string formatted GUID. Any attempt to provide a string that does not represent a GUID will cause a 400 status code to be returned.

      created
      DateTime

      Required

      Date and time the alert set was created.
      ownerDisplayName
      String

      Required

      Gets the display name of the owner of the alert set.
      modified
      DateTime

      Required

      Date and time the alert set was modified.
      modifiedBy
      String

      Required

      The name of the user who last modified the alert set.
      subscribedByOther
      Boolean
      A value indicating whether the AlertSet is subscribed to by users other than the current user.
      subscribedByOwner
      Boolean
      Indicates whether or not this AlertSet is subscribed to by the owner.
      subscribedByUser
      Boolean
      A value indicating whether the AlertSet is subscribed to by the current user.
      alertSetsRemoved
      List [1,*]: String
      __type
      "urn:inin.com:alerts:alertNotificationMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      alertDefinitionId
      String

      Required

      Gets the ID of the AlertDefinition assoicated with this notifiction.
      alertRuleId
      String

      Required

      Gets the ID of the AlertRule that the alert was raised on.
      cleared
      Boolean

      Required

      Gets a value indicating whether this AlertNotification is cleared.
      timeStamp
      DateTime

      Required

      Gets the received date and time.

      Multiple options:

      The value can be assigned any of the following options.
      __type
      "urn:inin.com:statistics:statisticBoolValue"

      Required

      The JSON type representing this option.
      int
      0
      double
      1
      string
      2
      bool
      3
      timeStamp
      4
      timeDuration
      5
      duration
      6
      futureDuration
      7
      finiteDuration
      8
      percent
      9
      statusMessage
      10
      weightedPercent
      11
      error
      12
      value
      Boolean

      Required

      __type
      "urn:inin.com:statistics:statisticDoubleValue"

      Required

      The JSON type representing this option.
      int
      0
      double
      1
      string
      2
      bool
      3
      timeStamp
      4
      timeDuration
      5
      duration
      6
      futureDuration
      7
      finiteDuration
      8
      percent
      9
      statusMessage
      10
      weightedPercent
      11
      error
      12
      value
      Double

      Required

      __type
      "urn:inin.com:statistics:statisticDurationValue"

      Required

      The JSON type representing this option.
      int
      0
      double
      1
      string
      2
      bool
      3
      timeStamp
      4
      timeDuration
      5
      duration
      6
      futureDuration
      7
      finiteDuration
      8
      percent
      9
      statusMessage
      10
      weightedPercent
      11
      error
      12
      value
      Duration

      Required

      __type
      "urn:inin.com:statistics:statisticErrorValue"

      Required

      The JSON type representing this option.
      int
      0
      double
      1
      string
      2
      bool
      3
      timeStamp
      4
      timeDuration
      5
      duration
      6
      futureDuration
      7
      finiteDuration
      8
      percent
      9
      statusMessage
      10
      weightedPercent
      11
      error
      12
      malformedStatisticKey
      1
      unknownStatisticKey
      2
      statisticProviderTooBusy
      3
      other
      99
      __type
      "urn:inin.com:statistics:statisticFiniteDurationValue"

      Required

      The JSON type representing this option.
      int
      0
      double
      1
      string
      2
      bool
      3
      timeStamp
      4
      timeDuration
      5
      duration
      6
      futureDuration
      7
      finiteDuration
      8
      percent
      9
      statusMessage
      10
      weightedPercent
      11
      error
      12
      stoppedTimeSpan
      Duration
      startTickingTime
      DateTime
      ticking
      Boolean

      Required

      __type
      "urn:inin.com:statistics:statisticFutureDurationValue"

      Required

      The JSON type representing this option.
      int
      0
      double
      1
      string
      2
      bool
      3
      timeStamp
      4
      timeDuration
      5
      duration
      6
      futureDuration
      7
      finiteDuration
      8
      percent
      9
      statusMessage
      10
      weightedPercent
      11
      error
      12
      value
      Duration

      Required

      __type
      "urn:inin.com:statistics:statisticIntValue"

      Required

      The JSON type representing this option.
      int
      0
      double
      1
      string
      2
      bool
      3
      timeStamp
      4
      timeDuration
      5
      duration
      6
      futureDuration
      7
      finiteDuration
      8
      percent
      9
      statusMessage
      10
      weightedPercent
      11
      error
      12
      value
      Int

      Required

      __type
      "urn:inin.com:statistics:statisticPercentValue"

      Required

      The JSON type representing this option.
      int
      0
      double
      1
      string
      2
      bool
      3
      timeStamp
      4
      timeDuration
      5
      duration
      6
      futureDuration
      7
      finiteDuration
      8
      percent
      9
      statusMessage
      10
      weightedPercent
      11
      error
      12
      value
      Double

      Required

      __type
      "urn:inin.com:statistics:statisticStatusMessageKeyValue"

      Required

      The JSON type representing this option.
      int
      0
      double
      1
      string
      2
      bool
      3
      timeStamp
      4
      timeDuration
      5
      duration
      6
      futureDuration
      7
      finiteDuration
      8
      percent
      9
      statusMessage
      10
      weightedPercent
      11
      error
      12
      value
      DateTime

      Required

      __type
      "urn:inin.com:statistics:statisticStringValue"

      Required

      The JSON type representing this option.
      int
      0
      double
      1
      string
      2
      bool
      3
      timeStamp
      4
      timeDuration
      5
      duration
      6
      futureDuration
      7
      finiteDuration
      8
      percent
      9
      statusMessage
      10
      weightedPercent
      11
      error
      12
      value
      String

      Required

      __type
      "urn:inin.com:statistics:statisticTimeDurationValue"

      Required

      The JSON type representing this option.
      int
      0
      double
      1
      string
      2
      bool
      3
      timeStamp
      4
      timeDuration
      5
      duration
      6
      futureDuration
      7
      finiteDuration
      8
      percent
      9
      statusMessage
      10
      weightedPercent
      11
      error
      12
      value
      DateTime

      Required

      __type
      "urn:inin.com:statistics:statisticTimeStampValue"

      Required

      The JSON type representing this option.
      int
      0
      double
      1
      string
      2
      bool
      3
      timeStamp
      4
      timeDuration
      5
      duration
      6
      futureDuration
      7
      finiteDuration
      8
      percent
      9
      statusMessage
      10
      weightedPercent
      11
      error
      12
      value
      DateTime

      Required

      __type
      "urn:inin.com:interactions.assistance:assistanceRequestDetailsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      assistanceId
      String

      Required

      The assistance ID for this assistance request.
      interactionId
      String
      The interaction ID associated with the assistance request.
      None
      0
      Accepted
      1
      Completed
      2
      text
      String

      Required

      The message text.
      participantId
      String

      Required

      The user ID of the participant that added the message text.
      timeAdded
      DateTime

      Required

      The date and time the message text was added.
      userId
      String

      Required

      The user ID of the participant.
      displayName
      String

      Required

      The display name of the participant.
      None
      0
      Initiated
      1
      Ignored
      2
      Accepted
      3
      __type
      "urn:inin.com:interactions.assistance:assistanceRequestListMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      requestsAdded
      List [Unbounded]: String
      The assistance requests that have been added.

      Property type documentation:

      Represents a list of assistance requests.

      requestsRemoved
      List [Unbounded]: String
      The assistance requests that have been removed.

      Property type documentation:

      Represents a list of assistance requests.

      __type
      "urn:inin.com:interactions.assistance:assistanceRequestSubscriptionStateMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      none
      0
      There is no subscription.
      normal
      1
      Subscriptions are working as expected. Suspended subscriptions can be resumed, returning them to this state.
      suspended
      2
      Suspended subscriptions have become incapable of sending their associated message. Suspended subscriptions can be resumed, returning them to the normal state.
      faulted
      3
      Faulted subscriptions have encountered a problem they cannot recover from, so they've ended themselves. A subsequent DELETE request, on a faulted subscription, is not necessary, but it cannot be resumed, and will need to be re-made.
      errorId
      String
      The error identifier that describes the current error.
      message
      String

      Required

      A message that describes the current error.
      __type
      "urn:inin.com:messaging:asyncOperationCompletedMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      requestId
      String

      Required

      __type
      "urn:inin.com:configuration.hardware:audioSourcesMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      removed
      List [1,*]: String
      __type
      "urn:inin.com:dialer:autoLoginMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      campaignId
      String

      Required

      The ID of the campaign the agent is logged in to.
      initiatorName
      String

      Required

      This identifies the rule or supervisor who initiated the agent's campaign login.
      __type
      "urn:inin.com:dialer:autoLogoutMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      campaignIds
      List [1,*]: String

      Required

      The list of campaign IDs for which a campaign logoff was requested.
      initiatorName
      String

      Required

      This identifies the rule or supervisor who initiated the agent's campaign logout request.
      __type
      "urn:inin.com:dialer:availableCampaignsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      __type
      "urn:inin.com:dialer:availableCampaign"

      Required

      The JSON type representing this option.
      name
      String

      Required

      The name of the campaign.
      id
      String

      Required

      The ID of the campaign.
      workgroup
      String

      Required

      The workgroup associated with the campaign.
      Invalid
      0
      On
      1
      Off
      2
      ScheduleOnly
      4
      Auto
      8
      Paused
      16
      Completed
      32
      hasBaseScript
      Boolean
      Represents whether this campaign applies a Base Script definition.
      Feature Version
      dialer 3
      customScriptUrl
      String
      Custom script URL associated with campaign.
      Feature Version
      dialer 3
      isLoggedIn
      Boolean
      Indicates whether agent is currently logged into this campaign.
      Feature Version
      dialer 3
      Predictive
      1
      Power
      2
      Preview
      3
      Agentless
      8
      __type
      "urn:inin.com:dialer:changedCampaign"

      Required

      The JSON type representing this option.
      name
      String

      Required

      The name of the campaign.
      id
      String

      Required

      The ID of the campaign.
      Invalid
      0
      On
      1
      Off
      2
      ScheduleOnly
      4
      Auto
      8
      Paused
      16
      Completed
      32
      id
      String

      Required

      The ID of the removed campaign.
      agentHasLogonCampaignRight
      Boolean

      Required

      Specifies if the agent has the "Logon Campaign" security right to choose which campaigns to log in to. Agents without this right are automatically logged in to all campaigns they are eligible for. After agents are logged in, ready-for-calls still needs to be called to have calls routed to them.
      __type
      "urn:inin.com:dialer:breakStatusMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      NotOnBreak
      0
      BreakPending
      1
      OnBreak
      2
      __type
      "urn:inin.com:interactions.callback:callbackMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      interactionId
      String

      Required

      The ID of the interaction this message corresponds to.
      target
      String

      Required

      The target for this callback.
      name
      String
      The name of the person who created this callback.
      subject
      String

      Required

      A message that describes the reason for this callback.
      attempts
      Int
      The retry attempt for this callback.
      maxAttempts
      Int
      The maximum number of attempts for this callback.
      associatedCallId
      String
      The call ID of the associated call to the callback.
      snoozed
      Boolean
      Whether this callback is snoozed or not.
      __type
      "urn:inin.com:statistics:chainedParametersChangeMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      [key]
      String

      Required

      This is the parameterTypeId.

      Multiple options:

      The value can be assigned any of the following options.
      value
      String

      Required

      A possible value for the parameter.
      displayString
      String

      Required

      A user friendly string for display purposes.
      description
      String

      Required

      The description for the parameter value.
      __type
      "urn:inin.com:statistics:qualifiedParameterValue"

      Required

      The JSON type representing this option.
      value
      String

      Required

      A possible value for the parameter.
      displayString
      String

      Required

      A user friendly string for display purposes.
      description
      String

      Required

      The description for the parameter value.
      parameterTypeId
      String

      Required

      The ID of the parameter type.
      parameterValuesRemoved
      List [Unbounded]: String

      Property type documentation:

      Represents a collection of strings.

      __type
      "urn:inin.com:interactions.chat:chatContentsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      interactionId
      String

      Required

      The ID of the interaction this message corresponds to.

      Multiple options:

      The value can be assigned any of the following options.
      None
      0
      SystemMember
      1
      CurrentUser
      2
      Internal
      3
      External
      4
      displayName
      String

      Required

      The display name of the chat member.
      interactionId
      String

      Required

      The interaction ID for the updated interaction. A combination of this field and the userId can be used to uniquely identify a user.
      userId
      String

      Required

      The userId of the chat member. A combination of this field and the interactionId can be used to uniquely identify a user.
      __type
      "urn:inin.com:interactions.chat:fullChatMember"

      Required

      The JSON type representing this option.
      None
      0
      SystemMember
      1
      CurrentUser
      2
      Internal
      3
      External
      4
      displayName
      String

      Required

      The display name of the chat member.
      interactionId
      String

      Required

      The interaction ID for the updated interaction. A combination of this field and the userId can be used to uniquely identify a user.
      userId
      String

      Required

      The userId of the chat member. A combination of this field and the interactionId can be used to uniquely identify a user.
      isTyping
      Boolean

      Required

      Indicates if this chat member is typing.
      text
      String

      Required

      The chat text.

      This property can be null.

      timestamp
      DateTime

      Required

      The timestamp associated with the chat text.
      Text
      0
      File
      1
      __type
      "urn:inin.com:interactions.chat:chatMembersMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      interactionId
      String

      Required

      The ID of the interaction this message corresponds to.
      __type
      "urn:inin.com:interactions.chat:fullChatMember"

      Required

      The JSON type representing this option.
      None
      0
      SystemMember
      1
      CurrentUser
      2
      Internal
      3
      External
      4
      displayName
      String

      Required

      The display name of the chat member.
      interactionId
      String

      Required

      The interaction ID for the updated interaction. A combination of this field and the userId can be used to uniquely identify a user.
      userId
      String

      Required

      The userId of the chat member. A combination of this field and the interactionId can be used to uniquely identify a user.
      isTyping
      Boolean

      Required

      Indicates if this chat member is typing.
      __type
      "urn:inin.com:configuration.people:clientButtonsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      addin
      0
      customNotification
      1
      launchApplication
      2
      launchUrl
      3
      Feature Version
      configuration 16
      always
      0
      withActiveInteractionSelected
      1
      withInteractionSelected
      2
      defaultValue
      String
      This is the default value of this property. It will be used if there is no value associated with the session's language or none of its fallback languages are configured.
      language
      String

      Required

      value
      String

      Required

      deactivateAfterUse
      Boolean
      Feature Version
      configuration 13

      Setting this property to null will set it to its default value.

      Default value: false

      displayNotification
      Boolean
      Feature Version
      configuration 13

      Setting this property to null will set it to its default value.

      Default value: false

      enabled
      Boolean
      Feature Version
      configuration 13

      Setting this property to null will set it to its default value.

      Default value: false

      iconUri
      Uri
      The download url for the icon associated with the client button.

      This is a read only property and can not be changed with PUT or POST operations.

      Feature Version
      configuration 13

      This property can be null.

      all
      0
      call
      1
      iwebcallback
      2
      chat
      3
      email
      4
      generic
      5
      workitem
      6
      socialdirectmessage
      7
      socialconversation
      8
      localApplication
      String
      Indicates the application associated with the action. This is the fully qualified local path to an executable, or a path relative to the local Interaction Client workstation (e.g., C:\Program Files\Interactive Intelligence\application.exe), or a UNC path (e.g., \\hydra\icapplications\application.exe).
      Feature Version
      configuration 13

      This property can be null.

      queue
      0
      interaction
      1
      openUrl
      String
      Indicates the url associated with the action.
      Feature Version
      configuration 16

      This property can be null.

      removed
      List [1,*]: String
      __type
      "urn:inin.com:configuration.people:clientConfigurationTemplatesMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      removed
      List [1,*]: String
      __type
      "urn:inin.com:configuration.people:clientTemplatesMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      applicationId
      String
      The value must conform to all of these criteria:
      • Is a string with from 0 to 7000 characters.

      This property can be null.

      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      fileDateLastModified
      DateTime

      This property can be null.

      isPermanent
      Boolean

      This is a read only property and can not be changed with PUT or POST operations.

      Setting this property to null will set it to its default value.

      Default value: false

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      removed
      List [1,*]: String
      __type
      "urn:inin.com:connection:connectionStateChangeMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      none
      0
      up
      1
      down
      2
      none
      0
      up
      1
      down
      2
      reason
      String

      Required

      A description of the condition that caused the change in connection state.
      shouldReconnect
      Boolean
      A flag indicating that the condition for the connection to go down is one that the client should reconnect to the server. When newConnectionState is set to down, an unspecified value should be assumed to be false.
      Feature Version
      connection 3
      __type
      "urn:inin.com:interactions:consultMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      originalParty
      Boolean
      The original party has two-way audio with the agent.
      consultedParty
      Boolean
      The consulted party has two-way audio with the agent.
      __type
      "urn:inin.com:qualityManagement:createSearchCompletedMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      requestId
      String

      Required

      moreResults
      Boolean

      Required

      True if the result count exceeds the maximum number of results specified.
      recordingId
      String

      Required

      The ID of the recording.
      unknown
      0
      call
      1
      chat
      2
      chatTranscript
      3
      email
      4
      screen
      5
      socialConversation
      6
      socialDirectMessage
      7
      interactionId
      String

      Required

      Interaction ID of the recording.
      recordingDuration
      Int
      The recording duration in milliseconds.

      This property can be null.

      recordingTime
      DateTime

      Required

      The recording time in UTC.
      recordingInitiationPolicy
      String
      The name of the recording initiation policy.

      This property can be null.

      recordingVersion
      Int

      Required

      The version of the recording.
      recordingFileSize
      Int
      The size of the recording in bytes.

      This property can be null.

      workgroup
      String
      The IC Workgroup associated with this recording.

      This property can be null.

      NoRights
      0
      The user has no rights to the object.
      ReadAccess
      1
      The user has read access to the object.
      WriteAccess
      2
      The user has write access to the object.
      CanPlay
      4
      The user can play the recording.
      CanExportOrArchive
      8
      The user can export or archive the recording.
      CanEmail
      16
      The user can email the recording.
      CanScore
      32
      The user can score the recording.
      CanViewParticipant
      64
      The user can view participants of the recording.
      CanDeleteRecording
      128
      The user can delete the recording.
      CanViewAuditTrail
      4096
      The user can view the recording's audit trail.
      CanViewScorecards
      8192
      The user can view scorecards.
      CanViewCustomAttributes
      16384
      The user can view recording custom attributes.
      CanModifyCustomAttributes
      32768
      The user can modify recording custom attributes.
      CanViewTags
      65536
      The user can view recording tags.
      CanModifyTags
      131072
      The user can modify recording tags.
      CanAddBookmarks
      262144
      The user can add recording bookmarks.
      CanViewSignatureComments
      524288
      The user can view scorecard signature comments.
      CanDeleteScorecards
      1048576
      The user can delete scorecards.
      CanAssignQuestionnaires
      2097152
      The user can assign questionnaires.
      EncumberedRecording
      1073741824
      The recording is encumbered.
      recordingMediaStatus
      String
      The status of the recording media.

      This property can be null.

      scorecardId
      String

      Required

      The scorecard ID.
      questionnaireId
      String

      Required

      The scorecard's questionnaire ID.
      scoredUser
      String
      The IC User ID of the scored user.

      This property can be null.

      scoringUser
      String
      The IC User ID of the scoring user.

      This property can be null.

      isFailed
      Boolean
      True if the scorecard is considered failed.

      This property can be null.

      scoringTime
      DateTime

      Required

      The UTC time this scorecard was last modified.
      invalid
      0
      assigned
      1
      inProgress
      2
      complete
      3
      rank
      String
      The scorecard's current rank.

      This property can be null.

      scorePct
      Double

      Required

      The scorecard's current score percentage.
      notRequired
      0
      inProgress
      1
      complete
      2
      none
      0
      marked
      1
      required
      2
      avgWorkgroupScorePct
      Double
      The average score percentage for this scorecard within the workgroup.

      This property can be null.

      avgWorkgroupRank
      String
      The average rank for this scorecard within the workgroup.

      This property can be null.

      surveyFormId
      String

      Required

      The unique ID for the completed survey.
      surveyId
      String

      Required

      The ID of the survey.
      scorePct
      Double
      The survey score percentage.

      This property can be null.

      rank
      String
      The survey rank.

      This property can be null.

      __type
      "urn:inin.com:ipa:currentPageSubscriptionClosePageEventArgs"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      workItemInstanceId
      String

      Required

      This property indicates the ID of the work item instance from which this message was received.

      workItemCompleted
      1
      workItemHeld
      2
      workItemDisconnected
      3
      workItemNoLongerAssignedToUser
      4
      processInError
      5
      userNoLongerLicensedForIpa
      6
      __type
      "urn:inin.com:ipa:currentPageSubscriptionCommandCompleteEventArgs"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      workItemInstanceId
      String

      Required

      This property indicates the ID of the work item instance from which this message was received.

      requestId
      String

      Required

      This property contains the same token that was included in the response when the page command was queued. It can be used to correlate this event message to the request that caused the caused the event to occur.

      dataId
      String

      This property indicates the fully-scoped ID of the data that is being referenced.

      See String Representation of Fully-Scoped GUID for more information about how a fully-scoped GUID is represented as a string.

      __type
      "urn:inin.com:ipa:currentPageSubscriptionShowPageEventArgs"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      workItemInstanceId
      String

      Required

      This property indicates the ID of the work item instance from which this message was received.

      workItemDynamicDetails
      String

      Required

      This property indicates the current Work Item Dynamic Details of the work item instance for which the page is being displayed.

      pageInstanceId
      String

      Required

      This property indicates the ID of the specific page instance that is being shown as the current page. Each time a command is sent to PAS for the current page, that command request must also include this ID.

      __type
      "urn:inin.com:ipa:runtimeDataValuesListMeta"

      Required

      The JSON type representing this option.
      payloadType
      String

      Required

      This field specifies the type of payload that is described by the object that contains this meta object.

      The value of this field will always be "dataValue" for the data values received as part of a show page event message.

      formatVersion
      String

      Required

      This field contains a string value that looks like a typical #.#.#.# version string. The numbers represented in this string may change over time as new features are added to IPA.

      The current value for formatVersion is 3.0.0.0.

      Multiple options:

      The value can be assigned any of the following options.
      __type
      "urn:inin.com:ipa:booleanDataInstColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      __type
      "urn:inin.com:ipa:booleanDataInstCollItem"

      Required

      The JSON type representing this option.
      id
      String

      Required

      This field contains the object instance ID for this object instance.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      val
      Boolean

      This field contains a boolean value to use for this data object instance collection item . If this field is not emitted or if its value is null, then an not set should be assumed.

      This property can be null.

      __type
      "urn:inin.com:ipa:booleanDataInstSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      val
      Boolean

      This field contains a boolean value to use for this data type object instance . If this field is not emitted or if its value is null, then an not set should be assumed.

      Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

      This property can be null.

      __type
      "urn:inin.com:ipa:complexDataInstColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      __type
      "urn:inin.com:ipa:complexDataInstCollItem"

      Required

      The JSON type representing this option.
      id
      String

      Required

      This field contains the object instance ID for this object instance.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      uniqueId
      String

      This field contains the unique identifier ($ID) for the complex data type instance. If the field is not emitted, then it should be assumed that either the field does not apply in this context, or that no unique ID was defined for the corresponding complex data type definition. But, if the value is null or empty string, then it should be assumed that a unique ID is defined, but the value resolves to null or empty string.

      It should be noted that, unlike most of the other fields with a name that ends in "Id" that are GUIDs, this uniqueId field is not a GUID. Rather, the value of this field is a string calculated by Process Automation Server. For example, it could be the concatentation of all of the string representations from all of the fields identified as being part of the unique identifier within the complex data definition. Or, it could be the result of a custom calculation.

      The class that contains this value is used in various different contexts, and this uniqueId field does not apply in every context. The unique ID is a runtime concept, so it does not make sense in definitions. Similarly, the value is only calculated by Process Automation Server, so it does not make sense when sending values from a client to the server.

      This property can be null.

      Multiple options:

      The value can be assigned any of the following options.
      __type
      "urn:inin.com:ipa:booleanPropValColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      __type
      "urn:inin.com:ipa:booleanPropValSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      val
      Boolean

      This field contains a boolean value to use for this complex object property value . If this field is not emitted or if its value is null, then an not set should be assumed.

      This property can be null.

      __type
      "urn:inin.com:ipa:complexPropValColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      items
      List [Unbounded]: Multiple Options: basePropVal

      Recursive

      TODO: Description.

      Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.

      This property can be null.

      The items in this list can be null.

      __type
      "urn:inin.com:ipa:complexPropValSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      val
      Complex Type: complexValue

      Recursive

      This field contains a complex object value to use for this complex object property value . If this field is not emitted or if it value is null, then not set should be assumed.

      This property can be null.

      Property type documentation:

      This class represents a complex object value, includes values for the object's properties and may include a unique ID depending on the context in which this class is used.

      __type
      "urn:inin.com:ipa:currencyPropValColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      __type
      "urn:inin.com:ipa:currencyDataInstCollItem"

      Required

      The JSON type representing this option.
      id
      String

      Required

      This field contains the object instance ID for this object instance.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      amount
      String

      This field contains a string representation of the amount of the currency, which may be postive or negative.

      See String Representation of Currency Values for more information about how a currency value is represented.

      This property can be null.

      code
      String

      This field specifies the currency code that is associated with the amount field.

      See String Representation of Currency Values for more information about how a currency value is represented.

      This property can be null.

      __type
      "urn:inin.com:ipa:currencyPropValSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      __type
      "urn:inin.com:ipa:datePropValColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      __type
      "urn:inin.com:ipa:stringDataInstCollItem"

      Required

      The JSON type representing this option.
      id
      String

      Required

      This field contains the object instance ID for this object instance.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      val
      String

      This field contains the string representation of the value to use for this string representation of value . If this field is not emitted or if its value is null, a value of not set should be assumed.

      This property can be null.

      __type
      "urn:inin.com:ipa:datePropValSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this date complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.

      See String Representation of Date Values for more information about how a date value is represented as a string.

      This property can be null.

      __type
      "urn:inin.com:ipa:dateTimePropValColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      __type
      "urn:inin.com:ipa:dateTimePropValSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this date-time complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.

      See String Representation of Date-Time Values for more information about how a date-time value is represented as a string.

      This property can be null.

      __type
      "urn:inin.com:ipa:decimalPropValColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      __type
      "urn:inin.com:ipa:decimalPropValSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this decimal complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.

      See String Representation of Decimal Values for more information about how a decimal value is represented as a string.

      This property can be null.

      __type
      "urn:inin.com:ipa:durationPropValColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      __type
      "urn:inin.com:ipa:durationPropValSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this duration complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.

      See String Representation of Duration Values for more information about how a decimal value is represented as a string.

      This property can be null.

      __type
      "urn:inin.com:ipa:longPropValColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      __type
      "urn:inin.com:ipa:longPropValSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this long complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.

      See String Representation of Long Values for more information about how a long value is represented as a string.

      This property can be null.

      __type
      "urn:inin.com:ipa:mailboxPropValColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      __type
      "urn:inin.com:ipa:mailboxDataInstCollItem"

      Required

      The JSON type representing this option.
      id
      String

      Required

      This field contains the object instance ID for this object instance.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      val
      String

      Required

      This field contains a string representation of the mailbox value.

      See String Representation of Mailbox Values for more information about how a mailbox value is represented.

      type
      String

      Required

      This field contains a string representation of the mailbox type. Possible values are show below.

      • SMTP
      • OTHER

      See String Representation of Mailbox Values for more information about how a mailbox value is represented.

      __type
      "urn:inin.com:ipa:mailboxPropValSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      __type
      "urn:inin.com:ipa:skillPropValColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      __type
      "urn:inin.com:ipa:skillPropValSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this skill complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.

      The string representation of a skill value is simply the name of the skill.

      This property can be null.

      __type
      "urn:inin.com:ipa:stringPropValColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      __type
      "urn:inin.com:ipa:stringPropValSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this string complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.

      The string representation of a string value is simply the string itself.

      This property can be null.

      __type
      "urn:inin.com:ipa:timePropValColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      __type
      "urn:inin.com:ipa:timePropValSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this time complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.

      See String Representation of Time Values for more information about how a time value is represented as a string.

      This property can be null.

      __type
      "urn:inin.com:ipa:uriPropValColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      __type
      "urn:inin.com:ipa:uriPropValSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this uri complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.

      The string representation of a URI value is simply the URI itself.

      This property can be null.

      __type
      "urn:inin.com:ipa:userQueuePropValColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      __type
      "urn:inin.com:ipa:userQueueDataInstCollItem"

      Required

      The JSON type representing this option.
      id
      String

      Required

      This field contains the object instance ID for this object instance.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      val
      String

      Required

      This field holds the username associated with the user queue.

      See String Representation of User Queue Values for more information about how a user queue value is represented.

      displayName
      String

      This field specifies the display name is associated with the val field. If the field is not emitted or the value is null or empty string, then it is assumed that there is no display name configured in IA for this user.

      See String Representation of User Queue Values for more information about how a user queue value is represented.

      This property can be null.

      __type
      "urn:inin.com:ipa:userQueuePropValSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      __type
      "urn:inin.com:ipa:workgroupQueuePropValColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      __type
      "urn:inin.com:ipa:workgroupQueuePropValSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the property definition that corresponds to this property value.

      See the section on defId and name fields for more information about when the defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this user queue complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.

      The string representation of a workgroup queue value is simply the name of the workgroup.

      This property can be null.

      __type
      "urn:inin.com:ipa:complexDataInstSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      __type
      "urn:inin.com:ipa:currencyDataInstColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      __type
      "urn:inin.com:ipa:currencyDataInstSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      __type
      "urn:inin.com:ipa:dateDataInstColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      __type
      "urn:inin.com:ipa:dateDataInstSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this date data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

      Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

      See String Representation of Date Values for more information about how a date value is represented as a string.

      This property can be null.

      __type
      "urn:inin.com:ipa:dateTimeDataInstColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      __type
      "urn:inin.com:ipa:dateTimeDataInstSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this date-time data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

      Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

      See String Representation of Date-Time Values for more information about how a date-time value is represented as a string.

      This property can be null.

      __type
      "urn:inin.com:ipa:decimalDataInstColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      __type
      "urn:inin.com:ipa:decimalDataInstSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this decimal data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

      Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

      See String Representation of Decimal Values for more information about how a decimal value is represented as a string.

      This property can be null.

      __type
      "urn:inin.com:ipa:durationDataInstColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      __type
      "urn:inin.com:ipa:durationDataInstSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this duration data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

      Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

      See String Representation of Duration Values for more information about how a decimal value is represented as a string.

      This property can be null.

      __type
      "urn:inin.com:ipa:longDataInstColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      __type
      "urn:inin.com:ipa:longDataInstSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this long data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

      Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

      See String Representation of Long Values for more information about how a long value is represented as a string.

      This property can be null.

      __type
      "urn:inin.com:ipa:mailboxDataInstColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      __type
      "urn:inin.com:ipa:mailboxDataInstSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      __type
      "urn:inin.com:ipa:skillDataInstColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      __type
      "urn:inin.com:ipa:skillDataInstSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this skill data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

      Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

      The string representation of a skill value is simply the name of the skill.

      This property can be null.

      __type
      "urn:inin.com:ipa:stringDataInstColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      __type
      "urn:inin.com:ipa:stringDataInstSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this string data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

      Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

      The string representation of a string value is simply the string itself.

      This property can be null.

      __type
      "urn:inin.com:ipa:timeDataInstColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      __type
      "urn:inin.com:ipa:timeDataInstSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this time data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

      Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

      See String Representation of Time Values for more information about how a time value is represented as a string.

      This property can be null.

      __type
      "urn:inin.com:ipa:uriDataInstColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      __type
      "urn:inin.com:ipa:uriDataInstSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this uri data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

      Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

      The string representation of a URI value is simply the URI itself.

      This property can be null.

      __type
      "urn:inin.com:ipa:userQueueDataInstColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      __type
      "urn:inin.com:ipa:userQueueDataInstSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      __type
      "urn:inin.com:ipa:workgroupQueueDataInstColl"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      __type
      "urn:inin.com:ipa:workgroupQueueDataInstSing"

      Required

      The JSON type representing this option.
      defId
      String

      This field contains the ID of the data definition from which the object instance is being created.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      id
      String

      This field contains the object instance ID for this object instance.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      name
      String

      This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

      See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

      This property can be null.

      security
      String

      The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

      This property can be null.

      val
      String

      This field contains the string representation of the value to use for this workgroup queue data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

      Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

      The string representation of a workgroup queue value is simply the name of the workgroup.

      This property can be null.

      sourceId
      String

      Required

      This field indicates the fully scoped GUID that is the ID or the collection that contains the list if items (singleton or complex) from which a selection may be made.

      For example, this could be the ID for a collection of basic or simple types displayed in a single-column grid. Or, it could be the ID of a collection that contains a complex object for each row that is to be displayed in a multi-column grid. Either way, this is the ID of a collection of all of the items, not just the selected items.

      See String Representation of Fully-Scoped GUID for more information about how a fully-scoped GUID is represented as a string.

      destinationId
      String

      Required

      This field indicates the fully scoped GUID that is the ID of the variable that holds the selected item (single select mode), or the ID of the collection that holds the list of selected items (multi-select mode).

      When configured to select "by unique identifier", the variable indicated by this ID will be a string singleton (single-select mode) or string collection (multi-select mode), and only a string representation of the uniqueId(s) of the selected item(s) will be in that variable.

      When configured to select "by data type", the variable indicated by this ID will be a singleton (single-select mode) or collection (multi-select mode) of the same type indicated by the sourceId field, which could be a basic, simple or complex type. And, in this case, a complete copy of each select item is stored in the variable indicated by this destination field; not just the uniqueId(s).

      See String Representation of Fully-Scoped GUID for more information about how a fully-scoped GUID is represented as a string.

      items
      List [Unbounded]: String

      This field holds the list of simple GUIDs that are the IDs of the selected items, regardless of whether configured to select "by data type" or "by unique identifier".

      This field is always a collection regardless of whether single-select mode or mult-select mode is being used. But, at most one item can exist in this list for single-select mode, whereas multiple items can exist in this list for mult-select mode.

      See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

      This property can be null.

      pageAndDataDefinitions
      Uri

      Required

      This property contains the URL where the page definition and data definitions can be found for the current page of this work item instance. The page and data definitions for the specific revision of the specific page definition of the specific process definition are wrapped into a JSON file at this location.

      __type
      "urn:inin.com:dialer:dataPopMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      Multiple options:

      The value can be assigned any of the following options.
      __type
      "urn:inin.com:dialer:dataPop"

      Required

      The JSON type representing this option.
      interactionId
      String

      Required

      The interaction ID for the call being popped.
      campaignId
      String

      Required

      ID of the campaign associated with the call.
      [key]
      String

      Required

      The key identifying this pair.
      [value]
      String

      Required

      The value of this pair.
      autoDisconnectOnDisposition
      Boolean

      Required

      Specifies if the client application should disconnect the call immediately after it is dispositioned. If true, the client application, agent, or caller must disconnect the call. Dialer does not automatically disconnect.
      allowAgentCallbacks
      Boolean

      Required

      Specifies if this call can be dispositioned as rescheduled for a specific agent.
      label
      String

      Required

      Name of a disposition choice the agent can select from at the end of a call.
      wrapUpCategory
      String

      Required

      The wrap-up category assigned to the call.
      wrapUpCode
      String

      Required

      The wrap-up code assigned to the call.
      abandon
      Boolean

      Required

      Specifies if a call is marked as abandoned.
      preview
      0
      This is a preview call.
      ownAgentCallback_Preview
      1
      This is an agent-owned callback from a preview campaign.
      regular
      2
      This is a regularly dialed call.
      ownAgentCallback
      3
      This is an agent-owned callback from a non-preview campaign.
      agentless
      4
      This is an agentless call.
      precise
      5
      This is a precisely dialed call.
      manual
      6
      This is a manually dialed outbound call.
      __type
      "urn:inin.com:dialer:previewPop"

      Required

      The JSON type representing this option.
      interactionId
      String

      Required

      The interaction ID for the call being popped.
      campaignId
      String

      Required

      ID of the campaign associated with the call.
      [key]
      String

      Required

      The key identifying this pair.
      [value]
      String

      Required

      The value of this pair.
      autoDisconnectOnDisposition
      Boolean

      Required

      Specifies if the client application should disconnect the call immediately after it is dispositioned. If true, the client application, agent, or caller must disconnect the call. Dialer does not automatically disconnect.
      allowAgentCallbacks
      Boolean

      Required

      Specifies if this call can be dispositioned as rescheduled for a specific agent.
      preview
      0
      This is a preview call.
      ownAgentCallback_Preview
      1
      This is an agent-owned callback from a preview campaign.
      callPlaced
      Boolean

      Required

      Indicates whether Dialer has been requested to place the preview call. If true, attempts to call the place-preview-call method fail.
      previewTimeout
      DateTime
      If "Enable preview countdown" is configured for the campaign, the previewTimeout is the IC server time when the preview countdown expires. Compare this time to the server clock time via GET /icws/connection/server-time to account for client/server time drift. The server does not support initiating a preview call after the countdown is reached. If that functionality is required, it must be included in the client application.
      allowSkip
      Boolean

      Required

      Indicates whether the agent is allowed to skip this preview call. To skip a preview call, call the disposition method with a wrapup label of "Skipped - Agent Skip".
      __type
      "urn:inin.com:wfm:dataVersionsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      scheduleVersion
      Int
      The latest version of this user's schedule.
      timeOffRequestVersion
      Int
      The latest version of this user's time off requests.
      notificationVersion
      Int
      The latest version of this user's notification list.
      accrualVersion
      Int
      The latest version of this user's time off accrual.
      availabilityVersion
      Int
      The latest version of time-off availability.
      activityCodesVersion
      Int
      The latest version of activity codes.
      tradeRequestVersion
      Int
      The latest version of shift trades.
      Feature Version
      wfm 4
      __type
      "urn:inin.com:configuration.people:defaultUserMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      id
      String
      The unique identifier used to reference this configuration object. The value of this can be null when the grouping of this value is All. Otherwise, it is required.

      This property can be null.

      displayName
      String
      The display name of this configuration object.

      This property can be null.

      uri
      Uri
      A URI used to access this configuration object.

      This property can be null.

      none
      0
      Represents no object type.
      acg
      1
      Represents an ACG object type.
      workgroup
      2
      Represents the workgroup object type.
      lineGroup
      3
      Represents the lineGroup object type.
      feedbackSurveyGroup
      4
      Represents the feedbackSurveyGroup object type.
      all
      0
      Represents all possible ConfigurationIds.
      single
      1
      Represents a single ConfigurationId.
      group
      2
      Represents a grouping of ConfigurationIds where each ConfigurationId is a member of some other Aggregate (Workgroup, Role, ...).
      none
      0
      The property was not inherited.
      Workgroup
      1
      The property was inherited from a Workgroup configuration object.
      Role
      2
      The property was inherited from a Role configuration object.
      DefaultUser
      3
      The property was inherited from the Default User configuration object.
      ClientConfigurationTemplate
      4
      The property was inherited from a Client Configuration Template configuration object.
      actualValue
      Boolean
      The value directly assigned to this configuration object. This value is required for POST and PUT operations.

      This property can be null.

      effectiveValue
      Boolean
      The effective value of this property, from the blending of the actualValue with the inheritedValue. This value is required for GET object and GET object list operations.

      This property can be null.

      inheritedValue
      Boolean
      The actual inherited value, based on this configuration object's membership/inheritance, such as Workgroup, Role, and Default User.

      This property can be null.

      none
      0
      The property was not inherited.
      Workgroup
      1
      The property was inherited from a Workgroup configuration object.
      Role
      2
      The property was inherited from a Role configuration object.
      DefaultUser
      3
      The property was inherited from the Default User configuration object.
      ClientConfigurationTemplate
      4
      The property was inherited from a Client Configuration Template configuration object.
      values
      Boolean

      Required

      actualValue
      String
      The value directly assigned to this configuration object. This value is required for POST and PUT operations.

      This property can be null.

      effectiveValue
      String
      The effective value of this property, from the blending of the actualValue with the inheritedValue. This value is required for GET object and GET object list operations.

      This property can be null.

      inheritedValue
      String
      The actual inherited value, based on this configuration object's membership/inheritance, such as Workgroup, Role, and Default User.

      This property can be null.

      none
      0
      The property was not inherited.
      Workgroup
      1
      The property was inherited from a Workgroup configuration object.
      Role
      2
      The property was inherited from a Role configuration object.
      DefaultUser
      3
      The property was inherited from the Default User configuration object.
      ClientConfigurationTemplate
      4
      The property was inherited from a Client Configuration Template configuration object.
      values
      String

      Required

      actualValue
      Duration
      The value directly assigned to this configuration object. This value is required for POST and PUT operations.

      This property can be null.

      effectiveValue
      Duration
      The effective value of this property, from the blending of the actualValue with the inheritedValue. This value is required for GET object and GET object list operations.

      This property can be null.

      inheritedValue
      Duration
      The actual inherited value, based on this configuration object's membership/inheritance, such as Workgroup, Role, and Default User.

      This property can be null.

      none
      0
      The property was not inherited.
      Workgroup
      1
      The property was inherited from a Workgroup configuration object.
      Role
      2
      The property was inherited from a Role configuration object.
      DefaultUser
      3
      The property was inherited from the Default User configuration object.
      ClientConfigurationTemplate
      4
      The property was inherited from a Client Configuration Template configuration object.
      values
      Duration

      Required

      None
      0
      PDF
      1
      PNG
      2
      whisperToneLevel
      Int
      The value must conform to all of these criteria:
      • Is a value from -40 to 0.

      Setting this property to null will set it to its default value.

      Default value: -25

      __type
      "urn:inin.com:configuration.system:dialPlanClassificationsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      removed
      List [1,*]: String
      __type
      "urn:inin.com:directories:directoriesMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      read
      Boolean
      Permission to read a directory.
      create
      Boolean
      Permission to create a new directory.
      update
      Boolean
      Permission to update a directory.
      delete
      Boolean
      Permission to delete a directory.
      rename
      Boolean
      Permission to rename a directory.
      primaryNumber
      Boolean
      Permission to access a primary number designation.
      admin
      Boolean
      Administrative rights to a directory.
      count
      Int
      A count of the directory's contacts if known.
      canRefresh
      Boolean
      A value indicating whether the directory can be refreshed. This property will be ommitted if the directory cannot be refreshed.
      company
      0
      Represents a company directory.
      workgroup
      1
      Represents an Interaction Center workgroup as a directory.
      general
      2
      Represents an external directory. For example Interaction Center Private Contacts.
      stationGroup
      3
      Represents an Interaction Center station group as a directory.
      speedDial
      4
      Represents a directory for speed dial entries.
      groupAndProfile
      5
      Represents a directory for Attendant workgroups and profiles.
      tracker
      6
      Represents an Interaction Tracker directory.
      directoryID
      String

      Required

      The directory's ID.
      displayName
      String

      Required

      The directory's display name.
      list
      0
      Represents a list.
      filter
      1
      Represents a filter.
      speedDial
      2
      Represents a speed dial.
      tracker
      3
      Represents Interaction Tracker.
      hasActivation
      Boolean
      A value indicating whether the directory has activation information. This property will be omitted if the directory does not have activation information.
      hasDynamicFields
      Boolean
      A value indicating whether the directory has dynamic fields. This property will be omitted if the directory does not have dynamic fields.
      hasStatus
      Boolean
      A value indicating whether the directory has status information. This property will be omitted if the directory does not have status information.
      isPrivate
      Boolean
      A value indicating whether the directory is private. This property will be omitted if the directory is not private.
      ownerID
      String
      The directory's owner ID. This property will be omitted if the directory does not have an owner ID.
      schemaID
      String

      Required

      The directory's schema ID.
      directoriesRemoved
      List [1,*]: String
      The set of directories that have been removed.
      company
      Boolean
      Represents the company directory category.
      workgroup
      Boolean
      The category for all workgroup directories.
      general
      Boolean
      The category for all general directories.
      stationGroup
      Boolean
      The category for all station group directories.
      speedDial
      Boolean
      The category for all speed dial directories.
      groupAndProfile
      Boolean
      The category for all group and profile directories.
      tracker
      Boolean
      The category for all Tracker directories.
      __type
      "urn:inin.com:directories:directoryMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      totalCount
      Int
      This number represents the total number of contacts in the directory. This value will always be greater than, or equal to filteredCount.
      filteredCount
      Int
      This number represents the total number of contacts that match the subscription parameters. This value will always be less than or equal to totalCount.
      __type
      "urn:inin.com:directories:contactEntry"

      Required

      The JSON type representing this option.
      read
      Boolean
      Permission to read a contact entry.
      create
      Boolean
      Permission to create a contact entry.
      update
      Boolean
      Permission to update a contact entry.
      delete
      Boolean
      Permission to delete a contact entry.
      assistant
      String
      The name of the contact's assistant or subordinate.
      businessAddress
      String
      The contact's business address.
      businessCity
      String
      The contact's business city.
      businessCountry
      String
      The contact's business country.
      businessEmail
      String
      The contact's business email address.
      businessState
      String
      The contact's business state.
      businessZipCode
      String
      The contact's business zip code.
      company
      String
      The company that this contact works for.
      department
      String
      The department that this contact works in.
      displayName
      String
      The contact's display name. Usually this is Lastname, Firstname.
      firstName
      String
      The contact's first name.
      homeAddress
      String
      The contact's number and street, apartment, etc.
      homeCity
      String
      The home address city.
      homeCountry
      String
      The country associated with the contact's home address.
      homeEmail
      String
      The contact's personal Email address.
      homeState
      String
      The state where the home is located.
      homeZipCode
      String
      The home address zip code.
      lastName
      String
      The contact's last name.
      notes
      String
      The note text, if any, that is stored in this contact entry.
      none
      -1
      Identifies that there is no default phone number designated.
      Feature Version
      directories 7
      extension
      0
      Identifies the extension field as the default phone number.
      businessPhone
      1
      Identifies the business phone field as the default phone number.
      businessPhone2
      2
      Identifies the business phone 2 field as the default phone number.
      homePhone
      3
      Identifies the home phone field as the default phone number.
      homePhone2
      4
      Identifies the home phone 2 field as the default phone number.
      mobilePhone
      5
      Identifies the mobile phone field as the default phone number.
      faxPhone
      6
      Identifies the fax phone field as the default phone number.
      pagerPhone
      7
      Identifies the page phone field as the default phone number.
      assistantPhone
      8
      Identifies the assistant phone field as the default phone number.
      statusURI
      String
      The contact's Status URI.
      title
      String
      The contact's job title.
      alias
      String
      The contact's alias.
      standardizedNumber
      String

      Required

      The standardized phone number.
      displayString
      String

      Required

      The phone number's display string.
      baseNumber
      String
      The phone number.
      extension
      String
      The extension.
      autoDialable
      Boolean
      Whether or not the extension is a auto dialable.
      editNumber
      String

      The string to use when editing the phone number. This property contains the phone number and/or an extension. They are delimited by /^ when the extension is autodialed, and just ^ when it isn't. Extensions without a number will always be returned as autodialed.

      Note

      editNumber has been marked obsolete. displayString can be used in its place, as it provides identical information. Alternatively numberInfo can be used for to retrieve similar information as it contains the parsed information found in displayString.

      Feature Version Obsolete Version
      directories 6 8
      dialable
      Boolean
      Whether or not the returned number is a dialable number.
      entryID
      String

      Required

      A unique identifier for the contact.
      extension
      String
      The contact's extension.
      index
      Int

      Required

      The zero-based index of this contact within the directory subscription's current page.
      ownerID
      String
      The owner of this contact entry.
      skills
      List [Unbounded]: String
      The Skills that this contact has.
      trackerData
      String
      The tracker data.
      userID
      String
      The contact's user ID.
      voicemailLocation
      String
      The contact's voicemail location.
      workgroups
      List [Unbounded]: String
      The workgroups that this contact is a member of.
      activated
      Boolean
      Indicates if the user is activated on the current workgroup.
      Feature Version
      directories 5
      statusID
      String

      The ID of the status message that the specified contact is currently set to.

      The value represented by this property should be treated as case-insensitive.

      This property can be null.

      statusID
      String

      Required

      The ID of the status message that the specified contact is currently set to.

      The value represented by this property should be treated as case-insensitive.

      loggedIn
      Boolean

      Required

      Whether the contact is logged in.
      onPhone
      Boolean

      Required

      Whether the contact is on the phone.
      statusNotes
      String

      The directory contact's status notes. This property will only be provided if the logged-in user has View access for the "Notes" ACL in the "Directory Status Columns" group.

      Access Restrictions

      Type API Name UI Name
      Access Right viewStatusColumns "Status Notes" Directory Status Columns - Notes - View

      This property can be null.

      untilDateTime
      DateTime

      Required

      The status until date and time.

      Note

      This property will only be applied if CanHaveDate and CanHaveTime are true.

      hasDate
      Boolean

      Required

      This has to do with UI, not the untilDateTime.
      hasTime
      Boolean

      Required

      This has to do with UI, not the untilDateTime.
      onPhone
      Boolean

      The contact's onPhone status. This property will only be provided if the logged-in user has View access for the "On Phone" ACL in the "Directory Status Columns" group.

      Access Restrictions

      Type API Name UI Name
      Access Right viewStatusColumns "On Phone" Directory Status Columns - On Phone - View

      This property can be null.

      onPhoneChanged
      DateTime

      The directory contact's status onPhoneChanged. This property will only be provided if the logged-in user has View access for the "On Phone" ACL in the "Directory Status Columns" group.

      Access Restrictions

      Type API Name UI Name
      Access Right viewStatusColumns "On Phone" Directory Status Columns - On Phone - View

      This property can be null.

      statusChanged
      DateTime

      The directory contact's statusChanged. This property will only be provided if the logged-in user has View access for the "Time In Status" ACL in the "Directory Status Columns" group.

      Access Restrictions

      Type API Name UI Name
      Access Right viewStatusColumns "Time In Status" Directory Status Columns - Time In Status - View

      This property can be null.

      loggedIn
      Boolean

      The directory contact's status loggedIn. This property will only be provided if the logged-in user has View access for the "Logged In" ACL in the "Directory Status Columns" group.

      Access Restrictions

      Type API Name UI Name
      Access Right viewStatusColumns "Logged In" Directory Status Columns - Logged In - View

      This property can be null.

      stations
      List [Unbounded]: String

      The directory contact's status stations. This property will only be provided if the logged-in user has View access for the "Logged In" ACL in the "Directory Status Columns" group.

      Access Restrictions

      Type API Name UI Name
      Access Right viewStatusColumns "Logged In" Directory Status Columns - Logged In - View

      This property can be null.

      icServers
      List [Unbounded]: String

      The directory contact's status icServers. This property will only be provided if the logged-in user has View access for the "Logged In" ACL in the "Directory Status Columns" group.

      Access Restrictions

      Type API Name UI Name
      Access Right viewStatusColumns "Logged In" Directory Status Columns - Logged In - View

      This property can be null.

      contactsRemoved
      List [Unbounded]: String
      The set of directory contact entryIDs that have been removed.
      subscriptionId
      String

      Required

      The subscription's ID.
      __type
      "urn:inin.com:connection:effectiveStationChangeMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      __type
      "urn:inin.com:interactions.email:emailContentsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      interactionId
      String

      Required

      The ID of the interaction this message corresponds to.
      parentInteractionId
      String
      The ID of the parent interaction.
      conversationId
      String
      The ID of the conversation this email belongs to.
      isEditable
      Boolean

      Required

      Indicates whether or not the email can be edited by the current user.
      None
      0
      New
      1
      Reply
      2
      ReplyAll
      3
      Forward
      4
      Reply
      0
      ReplyAll
      1
      Forward
      2
      __type
      "urn:inin.com:interactions.email:emailContentsResponse"

      Required

      The JSON type representing this option.
      subject
      String
      The subject of the email.
      displayName
      String

      Required

      The display name for the email address.
      address
      String
      The email address.
      body
      String

      Required

      An email body.
      Text
      0
      Html
      1
      receivedTimestamp
      DateTime

      Required

      The timestamp of when the email was received.
      OK
      0
      The email signature was validated.
      MessageModified
      1
      The message was modified after it was signed.
      CertificateNotTrusted
      2
      The email signature is not considered trusted.
      EmailHeaderMismatch
      4
      The email sender does not match the email signature.
      Unknown
      128
      The email signature could not be validated for an unknown reason.
      version
      Int

      Required

      The version of the certificate.
      serialNumber
      String

      Required

      The serial number of the certificate.
      signatureAlgorithm
      String

      Required

      The algorithm used for the signature of the certificate.
      issuer
      String

      Required

      The issuer of the certificate.
      validFrom
      DateTime

      Required

      The start of the period for which the certificate is valid.
      validTo
      DateTime

      Required

      The end of the period for which the certificate is valid.
      subject
      String

      Required

      The subject of the certificate.
      __type
      "urn:inin.com:interactions.email:emailFileAttachment"

      Required

      The JSON type representing this option.
      name
      String

      Required

      The name of the file.
      contentId
      String

      Required

      The Content-ID of the file, which conforms to RFC 2111.
      downloadUri
      Uri

      Required

      The location where the file can be downloaded.

      By default, when GETing the file, ICWS will respond with the 'Content-Type' header set to the proper content type of the file.

      When making a request from a web browser, it may be desirable to force the file to be downloaded. In this case the query string '?action=download' should be added to the end of a file's downloadUri. This will force the response header 'Content-Type' to be set to 'application/octet-stream' and will add the header 'Content-Disposition' set to 'attachment'.

      __type
      "urn:inin.com:interactions.email:emailMessageAttachment"

      Required

      The JSON type representing this option.
      subject
      String

      Required

      The subject of the attached message.
      messageId
      String

      Required

      The identifier used to retrieve the attached message.
      hasResponse
      Boolean
      Whether the email has been responded to. This will only be returned if true.
      Feature Version
      interactions 9
      edited
      Boolean
      Whether the email has been edited. This will only be returned if true.
      Feature Version
      interactions 9
      mailbox
      String
      The email address for the mailbox that contains this email.
      Feature Version
      interactions 9
      mailboxDisplayName
      String
      The display name for the mailbox that contains this email.
      Feature Version
      interactions 9
      hasLoadedExternalContent
      Boolean
      HTML content (typically images) linked from other domains was downloaded and displayed with this email message.
      Feature Version
      interactions 9
      unusedEmailAttachments
      List [Unbounded]: String
      A client controlled list of removed attachment CIDs.
      Feature Version
      interactions 12
      __type
      "urn:inin.com:interactions.email:emailMessageAttachmentMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      requestId
      String

      Required

      interactionId
      String

      Required

      The ID of the interaction this message corresponds to.
      __type
      "urn:inin.com:interactions.email:emailMessageContentsResponse"

      Required

      The JSON type representing this option.
      subject
      String

      Required

      The subject of the email.
      receivedTimestamp
      DateTime

      Required

      The timestamp of when the email was received.
      messageAttachments
      List [1,*]: Complex Type: emailMessageContentsResponse

      Recursive

      The email's message attachments. Note: These will be the actual attached messages instead of just the subject and associated retrieval messageId as they are with an emailContentsResponse.
      __type
      "urn:inin.com:interactions.email:emailSubscriptionStateMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      none
      0
      There is no subscription.
      normal
      1
      Subscriptions are working as expected. Suspended subscriptions can be resumed, returning them to this state.
      suspended
      2
      Suspended subscriptions have become incapable of sending their associated message. Suspended subscriptions can be resumed, returning them to the normal state.
      faulted
      3
      Faulted subscriptions have encountered a problem they cannot recover from, so they've ended themselves. A subsequent DELETE request, on a faulted subscription, is not necessary, but it cannot be resumed, and will need to be re-made.
      __type
      "urn:inin.com:interactions.email:emailUploadFileStatusMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      requestId
      String

      Required

      interactionId
      String

      Required

      The ID of the interaction this message corresponds to.
      fileName
      String

      Required

      The name of the file being uploaded.
      uploadSuccess
      Boolean

      Required

      Indicates file upload success.
      __type
      "urn:inin.com:unifiedMessaging:faxMessageSubscriptionStateMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      none
      0
      There is no subscription.
      normal
      1
      Subscriptions are working as expected. Suspended subscriptions can be resumed, returning them to this state.
      suspended
      2
      Suspended subscriptions have become incapable of sending their associated message. Suspended subscriptions can be resumed, returning them to the normal state.
      faulted
      3
      Faulted subscriptions have encountered a problem they cannot recover from, so they've ended themselves. A subsequent DELETE request, on a faulted subscription, is not necessary, but it cannot be resumed, and will need to be re-made.
      __type
      "urn:inin.com:unifiedMessaging:faxMessagesMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      __type
      "urn:inin.com:unifiedMessaging:faxMessageAdded"

      Required

      The JSON type representing this option.
      unifiedMessageId
      String

      Required

      The unique identifier for the message.
      unread
      0
      The message has not been read.
      read
      1
      The message has been read.
      dateReceived
      DateTime

      Required

      The date/time stamp the message was received.
      from
      String

      Required

      The party that sent the message.
      subject
      String

      Required

      The subject of the message.
      fileUri
      Uri

      Required

      The URI to access the message file.
      fileName
      String

      Required

      The message file name.
      mimeType
      String
      The mime type of the attachment fileUri.
      __type
      "urn:inin.com:unifiedMessaging:faxMessage"

      Required

      The JSON type representing this option.
      unifiedMessageId
      String

      Required

      The unique identifier for the message.
      unread
      0
      The message has not been read.
      read
      1
      The message has been read.
      faxMessagesRemoved
      List [1,*]: String
      The list of fax message IDs removed from a user's inbox.
      __type
      "urn:inin.com:system:handlerSentNotificationMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      objectId
      String

      Required

      The identifier of the object for the notification.

      The value represented by this property should be treated as case-insensitive.

      eventId
      String

      Required

      The identifier of the event for the notification.

      The value represented by this property should be treated as case-insensitive.

      data
      List [Unbounded]: String

      Required

      A list of strings that were provided by the handler which sent the notification.
      __type
      "urn:inin.com:interactions:historyMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      initiationTime
      DateTime
      The time the interaction began.
      None
      0
      Incoming
      1
      Outgoing
      2
      terminationTime
      DateTime
      The time the interaction was disconnected or left the queue.
      interactionId
      String
      The interaction ID of the interaction to which the history data corresponds.
      log
      String
      The log information about the interaction as a string.
      None
      0
      Connected
      1
      Forwarded
      2
      localAddress
      String
      The address of the local party.
      localId
      String
      The displayable address of the local party.
      localName
      String
      The displayable name of the local party.
      notes
      String
      The notes that were added to the interaction.
      remoteAddress
      String
      The address of the remote party.
      remoteId
      String
      The displayable address of the remote party.
      remoteName
      String
      The displayable name of the remote party.
      __type
      "urn:inin.com:configuration.system:imageResourcesMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      description
      String

      This property can be null.

      fileLastModifiedDate
      Date

      This property can be null.

      horizontalResolution
      Int

      This property can be null.

      imageUri
      Uri

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      None
      0
      TIFF
      1
      JPEG
      2
      PNG
      3
      tags
      String

      This property can be null.

      verticalResolution
      Int

      This property can be null.

      removed
      List [1,*]: String
      __type
      "urn:inin.com:interactions:interactionAlertingMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      interactionId
      String

      Required

      The unique identifier of the Interaction that is alerting.
      interactionType
      String

      Required

      The type of Interaction that is alerting. This will be valued with the 'objectType' Interaction attribute value.
      name
      String

      Required

      The name associated to the party that initiated the Interaction.
      address
      String

      Required

      The telephone number, telephone extension, email address, or other such origin of the Interaction.
      None
      0
      User
      1
      Station
      2
      Workgroup
      3
      StationGroup
      4
      AcdUser
      5
      AcdStation
      6
      None
      0
      StartAlerting
      1
      StopAlerting
      2
      autoAnswer
      Boolean

      Required

      Indicates whether the alerting Interaction should be picked up automatically.
      system
      0
      A special Queue that represents interactions on a user's queue or station queue.
      user
      1
      Represents a user's interactions.
      workgroup
      2
      Represents a workgroup's interactions. Interactions passed to a Workgroup queue can be picked up by its member agents.
      station
      3
      Represents a station's interactions.
      queueName
      String

      Required

      The name of the queue being identified.
      [key]
      String

      Required

      The key identifying this pair.
      [value]
      String

      Required

      The value of this pair.
      __type
      "urn:inin.com:interactions:interactionChangedMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      interactionID
      String

      Required

      The interaction's ID.
      [key]
      String

      Required

      The key identifying this pair.
      [value]
      String

      Required

      The value of this pair.
      __type
      "urn:inin.com:interactions:interactionDeallocatedMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      interactionID
      String

      Required

      The interaction's ID.
      __type
      "urn:inin.com:interactions:interactionLostRightsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      interactionID
      String

      Required

      The interaction's ID.
      __type
      "urn:inin.com:interactions:interactionMorphedMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      interactionID
      String

      Required

      The interaction's ID.
      newInteractionID
      String

      Required

      The new interaction ID after the morph.
      __type
      "urn:inin.com:configuration.interactionRecorder:interactionRecorderConfigurationMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      enableSnippetRecordings
      Boolean
      Feature Version
      configuration 11

      This property can be null.

      forceHandsetPlayback
      Boolean

      This property can be null.

      __type
      "urn:inin.com:interactions:interactionRecordingSnippetCreatedMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      interactionID
      String

      Required

      The interaction's ID.
      recordingSnippetId
      String

      Required

      The new snippetRecording Id.
      __type
      "urn:inin.com:dataExtractor:jobStatusMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      name
      String

      Required

      The name of the job.

      submittedUserId
      String

      Required

      The user ID that was used to submit the job.

      id
      String

      Required

      The unique ID associated with the job. This value is set by the server at the time the job is created.

      submittedUserSiteId
      Int

      Required

      The site ID associated with the user who submitted the job.

      submitTime
      DateTime

      The datetime the job was submitted.

      queuedTime
      DateTime

      The datetime the job was queued.

      canceledTime
      DateTime

      The datetime the job was canceled.

      finishedTime
      DateTime

      The datetime the job finished.

      startedTime
      DateTime

      The datetime the job started.

      failedTime
      DateTime

      The datetime the job failed.

      stateChangedTime
      DateTime

      The datetime the job last changed state.

      cancelUserId
      String

      The user ID that cancelled the job.

      outputFolder
      String

      The output path where the extracted files were saved to.

      errorInfo
      String

      Additional error information.

      submitted
      0

      When the job has been submitted.

      queued
      1

      When the job has been queued.

      started
      2

      When the job has been started.

      failed
      3

      If the job failed.

      canceled
      4

      If the job was canceled.

      finished
      5

      When the job has finished.

      __type
      "urn:inin.com:configuration.interactionAnalyzer:keywordSetsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      category
      String
      The value must conform to all of these criteria:
      • Is a string with from 1 to 128 characters.

      This property can be null.

      agentScore
      Int
      The agent score is the value that should be assigned to the agent upon detection of this keyword. The value must conform to all of these criteria:
      • Is a value from -100 to 100.

      Setting this property to null will set it to its default value.

      Default value: 0

      customerScore
      Int
      The customer score is the value that should be assigned to the customer upon detection of this keyword. The value must conform to all of these criteria:
      • Is a value from -100 to 100.

      Setting this property to null will set it to its default value.

      Default value: 0

      language
      String
      The languages that are supported by the server for keywords can be obtained from GET /icws/{sessionId}/configuration/interaction-analyzer/licensed-languages. If a language not in that list is used in a POST or PUT operation, the server will return an error.

      This property can be null.

      minimumConfidenceThreshold
      Float
      The minimum confidence threshold specifies how certain Interaction Analyzer must be before reporting instances of the keyword. The value must conform to all of these criteria:
      • Is a value from 0 to 1.

      Setting this property to null will set it to its default value.

      Default value: 0.5

      userAntiPronunciations
      List [Unbounded]: String
      The anti-pronunciations are phonetic spellings of words that Interaction Analyzer should not use to detect this keyword. For more information, see the Interaction Analyzer Technical Reference Document in the Interaction Center Documentation Library. This must be set if userPronunciations, userWords, and userAntiWords are all null. Is a collection of items that each conform to all of these criteria:
      • Is a string with at most 128 characters.
      • Is a value representing a valid user pronunciation.

      This property can be null.

      Property type documentation:

      Represents a collection of strings.

      userAntiWords
      List [Unbounded]: String
      The words or spellings words that Interaction Analyzer should not use to detect this keyword. This must be set if userPronunciations, userAntiPronunciations, and userWords are all null. Is a collection of items that each conform to all of these criteria:
      • Is a string with at most 128 characters.
      • Is a value representing a valid keyword word.

      This property can be null.

      Property type documentation:

      Represents a collection of strings.

      userPronunciations
      List [Unbounded]: String
      The pronunciations are phonetic spellings of words that Interaction Analyzer should use to detect this keyword. For more information, see the Interaction Analyzer Technical Reference Document in the Interaction Center Documentation Library. This must be set if userAntiPronunciations, userWords, and userAntiWords are all null. Is a collection of items that each conform to all of these criteria:
      • Is a string with at most 128 characters.
      • Is a value representing a valid user pronunciation.

      This property can be null.

      Property type documentation:

      Represents a collection of strings.

      userWords
      List [Unbounded]: String
      The words or spellings that Interaction Analyzer should use to detect this keyword. This must be set if userPronunciations, userAntiPronunciations, and userAntiWords are all null. Is a collection of items that each conform to all of these criteria:
      • Is a string with at most 128 characters.
      • Is a value representing a valid keyword word.

      This property can be null.

      Property type documentation:

      Represents a collection of strings.

      removed
      List [1,*]: String
      __type
      "urn:inin.com:ipa:launchableProcessesSubscriptionEventArgs"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      processDefinitionId
      String

      Required

      This is the ID associated with the process definition. This ID does not change as new revisions of the process are created, modified or published.

      revision
      String

      Required

      This is the revision of the process indicated by the processDefinitionId. Each different published version of the same process will have the same processDefinitionId, but will have a different revision.

      name
      String

      Required

      This is the current name of the process definition indicated by the processDefinitionId. All revisions of the process definition with the same processDefinitionId share the same current name.

      description
      String

      Required

      This is the current description the process definition indicated by the processDefinitionId. All revisions of the process definition with the same processDefinitionId share the same current description.

      removed
      List [Unbounded]: String

      This property contains the list of IDs for the process definitions that were previously launchable by the current user, but are no longer launchable by that user. The process may have been deactivated or deleted, the user may no longer have the appropriate ACLs, etc.

      __type
      "urn:inin.com:configuration.system:layoutsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      description
      String

      This property can be null.

      positionDefaultHeight
      Int
      The value must conform to all of these criteria:
      • Is a value from 10 to 2048.

      Setting this property to null will set it to its default value.

      Default value: 10

      positionDefaultWidth
      Int
      The value must conform to all of these criteria:
      • Is a value from 10 to 2048.

      Setting this property to null will set it to its default value.

      Default value: 10

      removed
      List [1,*]: String
      __type
      "urn:inin.com:licenses:licenseMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      name
      String

      Required

      isAssigned
      Boolean

      Required

      Indicates whether or not the license is assigned to the user. An assigned license has not necessarily been acquired.

      __type
      "urn:inin.com:configuration.system:loginAuthenticationMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      disableAlternateWindowsAuth
      Boolean
      Property to disable the use of Alternate Windows Authentication.

      Setting this property to null will set it to its default value.

      Default value: false

      disableCachedCredentials
      Boolean
      Property to disable the use of cached credentials.

      Setting this property to null will set it to its default value.

      Default value: false

      disableIcAuth
      Boolean
      Property to disable the use of IC Authentication.

      Setting this property to null will set it to its default value.

      Default value: false

      disableSingleSignOn
      Boolean
      Property to disable the use of Single Sign On.

      Setting this property to null will set it to its default value.

      Default value: false

      disableWindowsAuth
      Boolean
      Property to disable the use of Windows Authentication.

      Setting this property to null will set it to its default value.

      Default value: false

      showLegalAgreementUponLogin
      Boolean
      Property to enable or disable showing of the legal agreement during the login process.
      Feature Version
      configuration 12

      Setting this property to null will set it to its default value.

      Default value: false

      __type
      "urn:inin.com:dialer:logoutGrantedMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      name
      String
      The name of the campaign.
      id
      String

      Required

      The ID of the campaign.
      __type
      "urn:inin.com:dialer:manualOutboundCallStatusMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      campaignId
      String

      Required

      Id of the campaign for which manual outbound call was initiated.
      agentId
      String

      Required

      Id of the agent that initiated the manual outbound call.
      identity
      String

      Required

      Dialer Identity of the manual outbound call.
      Unknown
      0
      None
      1
      InvalidCampaign
      2
      InvalidAgent
      3
      InternalError
      4
      AgentNotIdle
      5
      ContactNotFound
      6
      ContactUncallable
      7
      ContactBlocked
      8
      PlaceCallFailed
      9
      InvalidPhoneNumber
      10
      CallBlocked
      11
      CallPlaced
      12
      CallComplete
      13
      PolicyCompleted
      14
      PreviouslyDialed
      15
      filterblocked
      Boolean

      Required

      Contact record was excluded by the campaign filter.
      zoneblocked
      Boolean

      Required

      Contact was zone blocked.
      skillblocked
      Boolean

      Required

      Agent initiating the call does not have the skills necessary.
      dailylimitblocked
      Boolean

      Required

      The number of calls for the contact reached the daily limit.
      minimumspacingblocked
      Boolean

      Required

      Minimum spacing between calls is not satisfied.
      campaignownershipblocked
      Boolean

      Required

      Contact does not belong to the campaign initiating the call.
      donotcallblocked
      Boolean

      Required

      Contact is blocked by Do-Not-Call policy.
      querytimefilterblocked
      Boolean

      Required

      Contact record was excluded by the campaign query time filter.
      previouslydialed
      Boolean

      Required

      A flag indicating the phone number associated with the call has been previously dialed.
      uncallablestatus
      String

      Required

      The status of the record when uncallable.
      __type
      "urn:inin.com:alerts:memoListMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      [key]
      String

      Required

      The identifier for a memo.
      expiration
      DateTime
      The memo's expiration date and time.
      memoTitle
      String
      The title of the memo.
      memoBody
      String
      The body of the memo.
      desktopAlert
      0
      The memo will be displayed as a desktop alert.
      notificationArea
      1
      The memo will be displayed in the client's notification area.
      information
      0
      The information sound that should be played with this memo.
      warning
      1
      The warning sound that should be played with this memo.
      error
      2
      The error sound that should be played with this memo.
      iconUri
      Uri

      The location where the icon file associated with this memo can be downloaded. This URI will be of the form /SessionManagerFileTransfer/alerts/memo/icon/{sessionId}/{memoIconFileName}.

      Memo icon downloads require an active ICWS session as the sessionId. ICO and PNG are the only supported memo icon file formats. The desired file extension (*.ico or *.png respectively) should be appended to the URI prior to the request to control which format is returned. Requests without an extension will assume PNG.

      Requests for PNG memo icons support an optional iconSize parameter to control the size of the returned PNG. For example, to request a 16px by 16px PNG, the URL would end in /memoIconFilename.png?iconSize=16. The default iconSize is 32 without this parameter.

      url
      String
      A URL for the memo. This property is not guaranteed to be a properly-formatted URL string.
      [key]
      String

      Required

      The identifier for a memo.
      expiration
      DateTime
      The memo's expiration date and time.
      memoTitle
      String
      The title of the memo.
      memoBody
      String
      The body of the memo.
      desktopAlert
      0
      The memo will be displayed as a desktop alert.
      notificationArea
      1
      The memo will be displayed in the client's notification area.
      information
      0
      The information sound that should be played with this memo.
      warning
      1
      The warning sound that should be played with this memo.
      error
      2
      The error sound that should be played with this memo.
      iconUri
      Uri

      The location where the icon file associated with this memo can be downloaded. This URI will be of the form /SessionManagerFileTransfer/alerts/memo/icon/{sessionId}/{memoIconFileName}.

      Memo icon downloads require an active ICWS session as the sessionId. ICO and PNG are the only supported memo icon file formats. The desired file extension (*.ico or *.png respectively) should be appended to the URI prior to the request to control which format is returned. Requests without an extension will assume PNG.

      Requests for PNG memo icons support an optional iconSize parameter to control the size of the returned PNG. For example, to request a 16px by 16px PNG, the URL would end in /memoIconFilename.png?iconSize=16. The default iconSize is 32 without this parameter.

      url
      String
      A URL for the memo. This property is not guaranteed to be a properly-formatted URL string.
      removed
      List [Unbounded]: String
      The IDs of memos that have been removed from the user's memo list.
      __type
      "urn:inin.com:unifiedMessaging:mwiMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      messagesWaiting
      Int

      Required

      A count of waiting (unread) messages. When this field is zero there are no waiting messages.
      __type
      "urn:inin.com:unifiedMessaging:mwiSubscriptionStateMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      none
      0
      There is no subscription.
      normal
      1
      Subscriptions are working as expected. Suspended subscriptions can be resumed, returning them to this state.
      suspended
      2
      Suspended subscriptions have become incapable of sending their associated message. Suspended subscriptions can be resumed, returning them to the normal state.
      faulted
      3
      Faulted subscriptions have encountered a problem they cannot recover from, so they've ended themselves. A subsequent DELETE request, on a faulted subscription, is not necessary, but it cannot be resumed, and will need to be re-made.
      __type
      "urn:inin.com:dialer:outboundServerConnectionStateChangeMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      none
      0
      up
      1
      down
      2
      none
      0
      up
      1
      down
      2
      reason
      String

      Required

      A description of the condition that caused the change in connection state.
      __type
      "urn:inin.com:ipa:pasSubscriptionEventArgs"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      none
      0
      running
      1
      shuttingDown
      2
      down
      3
      __type
      "urn:inin.com:configuration.people:passwordPoliciesMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      accountLockoutDuration
      Int
      The number of minutes an account is locked out. The value must conform to all of these criteria:
      • Is a value from 0 to 99999.
      Feature Version
      configuration 2

      Setting this property to null will set it to its default value.

      Default value: 30

      allSequentialDigitsAllowed
      Boolean
      When this is set to true, a password can be all sequential digits.
      Feature Version
      configuration 2

      Setting this property to null will set it to its default value.

      Default value: false

      description
      String
      Feature Version
      configuration 2

      This property can be null.

      failedLoginCountResetTime
      Int
      The number of minutes before the failed login count is reset. The value must conform to all of these criteria:
      • Is a value from 0 to 99999.
      Feature Version
      configuration 2

      Setting this property to null will set it to its default value.

      Default value: 30

      maximumFailedLoginAttempts
      Int
      The maximum number of failed login attempts before the account it locked out. The value must conform to all of these criteria:
      • Is a value from 0 to 999.
      Feature Version
      configuration 2

      Setting this property to null will set it to its default value.

      Default value: 5

      maximumPasswordAge
      Int
      The maximum number of days a password can be set before it must be changed. The value must conform to all of these criteria:
      • Is a value from 0 to 999.
      Feature Version
      configuration 2

      Setting this property to null will set it to its default value.

      Default value: 180

      maximumPasswordAgeWarningPeriod
      Int
      The number of days before a password expires that a warning will be shown to the user. The value must conform to all of these criteria:
      • Is a value from 0 to 999.
      Feature Version
      configuration 2

      Setting this property to null will set it to its default value.

      Default value: 14

      minimumLowercaseCharacters
      Int
      The minimum number of lowercase characters the password must contain. The value must conform to all of these criteria:
      • Is a value from 0 to 99.
      Feature Version
      configuration 10

      Setting this property to null will set it to its default value.

      Default value: 0

      minimumNumericCharacters
      Int
      The minimum number of numeric characters the password must contain. The value must conform to all of these criteria:
      • Is a value from 0 to 99.
      Feature Version
      configuration 10

      Setting this property to null will set it to its default value.

      Default value: 0

      minimumPasswordAge
      Int
      The minimum age of a password in days before a user can change it. The value must conform to all of these criteria:
      • Is a value from 0 to 999.
      Feature Version
      configuration 2

      Setting this property to null will set it to its default value.

      Default value: 2

      minimumPasswordHistory
      Int
      The minimum number of unique passwords in the account history before one can be reused. The value must conform to all of these criteria:
      • Is a value from 0 to 24.
      Feature Version
      configuration 2

      Setting this property to null will set it to its default value.

      Default value: 24

      minimumPasswordLength
      Int
      The minimum character length of password. If this is less than minimumNumberUniqueDtfmDigits, that will become the effective minimum length. The value must conform to all of these criteria:
      • Is a value from 1 to 24.
      Feature Version
      configuration 2

      Setting this property to null will set it to its default value.

      Default value: 8

      minimumSpecialCharacters
      Int
      The minimum number of special characters the password must contain. The value must conform to all of these criteria:
      • Is a value from 0 to 99.
      Feature Version
      configuration 10

      Setting this property to null will set it to its default value.

      Default value: 0

      minimumUniqueDtmfDigits
      Int
      The minimum number of unique DTMF digits allowed in the password. Only characters that can be converted to DTMF are considered in this count. The value must conform to all of these criteria:
      • Is a value from 0 to 12.
      Feature Version
      configuration 2

      Setting this property to null will set it to its default value.

      Default value: 4

      minimumUppercaseCharacters
      Int
      The minimum number of uppercase characters the password must contain. The value must conform to all of these criteria:
      • Is a value from 0 to 99.
      Feature Version
      configuration 10

      Setting this property to null will set it to its default value.

      Default value: 0

      specialCharacters
      String
      A list containing the special characters that can be used to satisfy the pasword policy requirements for special characters.
      Feature Version
      configuration 10

      This property can be null.

      userMustChangePassword
      Boolean
      When this is set to true, users must change their password at next login.
      Feature Version
      configuration 2

      Setting this property to null will set it to its default value.

      Default value: false

      removed
      List [1,*]: String
      __type
      "urn:inin.com:recordings:pauseScreenRecordingCompletedMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      requestId
      String

      Required

      recordingIds
      List [Unbounded]: String

      Required

      A list of recording IDs.
      __type
      "urn:inin.com:configuration.system:positionsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      bottom
      Float
      The value must conform to all of these criteria:
      • Is a value from 0 to 1.

      Setting this property to null will set it to its default value.

      Default value: 0

      left
      Float
      The value must conform to all of these criteria:
      • Is a value from 0 to 1.

      Setting this property to null will set it to its default value.

      Default value: 0

      right
      Float
      The value must conform to all of these criteria:
      • Is a value from 0 to 1.

      Setting this property to null will set it to its default value.

      Default value: 0

      top
      Float
      The value must conform to all of these criteria:
      • Is a value from 0 to 1.

      Setting this property to null will set it to its default value.

      Default value: 0

      removed
      List [1,*]: String
      __type
      "urn:inin.com:configuration.system:problemReporterMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      emailAddresses
      List [Unbounded]: String

      This property can be null.

      Property type documentation:

      Represents a collection of strings.

      __type
      "urn:inin.com:configuration.people:queueColumnsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      attribute
      String
      The built-in Queue Columns provided with PureConnect do not have a value for their attribute property. As a result, their values will be returned as null when queried. For all non-built-in Queue Columns, this property is required to be set and cannot be null.

      This property is required to be present in POST operations.

      This property can be null.

      Boolean
      0
      Duration
      1
      InteractionId
      2
      MultiValueInteractionId
      3
      MultiValueNumber
      4
      MultiValueString
      5
      Number
      6
      String
      7
      TimeStamp
      8
      isPermanent
      Boolean

      This is a read only property and can not be changed with PUT or POST operations.

      Setting this property to null will set it to its default value.

      Default value: false

      removed
      List [1,*]: String
      __type
      "urn:inin.com:queues:queueContentsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String

      Required

      The subscription ID that this message correlates to.
      interactionId
      String

      Required

      The interaction ID of the interaction.
      [key]
      String

      Required

      The key identifying this pair.
      [value]
      String

      Required

      The value of this pair.
      conferenceParentId
      String
      The interaction ID of the parent interaction of the conference containing this interaction.
      interactionId
      String

      Required

      The interaction ID of the interaction.
      [key]
      String

      Required

      The key identifying this pair.
      [value]
      String

      Required

      The value of this pair.
      interactionsRemoved
      List [Unbounded]: String
      The set of interactions that have been removed in the queue.
      __type
      "urn:inin.com:queues:queueSubscriptionStateMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      none
      0
      There is no subscription.
      normal
      1
      Subscriptions are working as expected. Suspended subscriptions can be resumed, returning them to this state.
      suspended
      2
      Suspended subscriptions have become incapable of sending their associated message. Suspended subscriptions can be resumed, returning them to the normal state.
      faulted
      3
      Faulted subscriptions have encountered a problem they cannot recover from, so they've ended themselves. A subsequent DELETE request, on a faulted subscription, is not necessary, but it cannot be resumed, and will need to be re-made.
      subscriptionId
      String

      Required

      The subscription ID that this message correlates to.
      __type
      "urn:inin.com:configuration.hardware:recordingBeepTonesMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      toneAmplitudeOne
      Int
      Defines the volume of the first beep in decibels. The value must conform to all of these criteria:
      • Is a value from -33 to 6.

      This property is required to be present in POST operations.

      toneAmplitudeTwo
      Int
      Defines the volume of the second beep in decibels. The value must conform to all of these criteria:
      • Is a value from -33 to 6.

      This property is required to be present in POST operations.

      toneDuration
      Int
      Defines how long in milliseconds that this beep tone will last. The value must conform to all of these criteria:
      • Is a value from 160 to 240.

      This property is required to be present in POST operations.

      toneFrequencyOne
      Int
      Defines the frequency of the first beep in Hertz. The value must conform to all of these criteria:
      • Is a value from 1260 to 1540.

      This property is required to be present in POST operations.

      toneFrequencyTwo
      Int
      Defines the frequency of the second beep in Hertz. The value must conform to at least one of these criteria:
      • Is a value from 1260 to 1540.
      • Is a value from 0 to 0.

      This property is required to be present in POST operations.

      toneInterval
      Int
      Defines the interval between the beeps in the recordings. The value must conform to all of these criteria:
      • Is a value from 10 to 20.

      This property is required to be present in POST operations.

      removed
      List [1,*]: String
      __type
      "urn:inin.com:journeymap:relatedInteractionsInfo"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      filteredCount
      Int
      This number represents the total number of interactions that match the subscription parameters.
      subscriptionId
      String

      Required

      The Subscription's Id.
      relatedIntxSearchID
      String

      Required

      This is same as what is provided in subscription parameters. eg. indivId, orgId, locId.
      interactionId
      String

      Required

      The Interaction's Id.
      __type
      "urn:inin.com:journeymap:participant"

      Required

      The JSON type representing this option.
      indivId
      String

      Required

      Participant's indivID.
      displayName
      String
      Participant's display name.
      unknown
      0
      Participant role is unknown.
      initiator
      1
      Participant is an initiator.
      respondant
      2
      Participant is respondant.
      participant
      3
      Other participants.
      orgName
      String
      Individual's organizaion name.
      orgId
      String
      Individual's organizaion Id.
      locationName
      String
      Individual's location name.
      locId
      String
      Individual's organization's location Id.
      wrapUpCode
      String
      Wrap up code for interaction.
      segmentAccountCode
      String
      Interaction's segment account code.
      segmentStartTime
      String
      Segment's start time.
      segmentDuration
      String
      Segment total duration.
      interactionType
      String
      Segment's interaction type eg. Call, Chat, Email, etc.
      noteExists
      Boolean
      Indicate whether notes exist for interaction.
      recordingId
      String
      Interaction's recording Id.
      surveyExist
      Boolean
      Indicate whether survey exist for interaction.
      surveyScore
      Int
      Survey score for this interaction.
      surveyMinScore
      Int
      Minimum survey score for the interaction.
      surveyMaxScore
      Int
      Maximum survey score for the interaction.
      appIncidentId
      String
      Application incident Id.
      __type
      "urn:inin.com:configuration.people:responseManagementDocumentsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      description
      String
      The description of this configuration object.

      This property can be null.

      documentDateLastModified
      DateTime
      The date this configuration object's file was last modified.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      removed
      List [1,*]: String
      __type
      "urn:inin.com:responseManagement:responseManagementMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      id
      Guid

      Required

      The identifier for the library.
      name
      String

      Required

      The name for the library.
      url
      Uri

      Required

      The URL to download the library.
      cacheTag
      String

      Required

      A value that represents the current version of a library. It is used by the client to avoid requesting a version of the library that the client already has.
      librariesRemoved
      List [Unbounded]: Guid
      A list of removed libraries.
      __type
      "urn:inin.com:recordings:resumeScreenRecordingCompletedMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      requestId
      String

      Required

      __type
      "urn:inin.com:configuration.people:rolesMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      removed
      List [1,*]: String
      __type
      "urn:inin.com:configuration.integrations:salesforceCTIConfigurationsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      createCallLogForInternalCalls
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      createCallLogOnInteractionsNotConnected
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      openAndEditCallLogOnDisconnect
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      popAccountCodeDialogOnDisconnect
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      callAttribute
      String

      This property can be null.

      isDateTimeAttribute
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      salesforceField
      String

      This property can be null.

      syncOnInbound
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      syncOnOutbound
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      saveWrapTimeField
      String

      This property can be null.

      sendScreenPopOnAlerting
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      showAdvancedTransferButton
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      showSpeedDial
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      speedDialDirectory
      String

      This property can be null.

      speedDialNumber
      String

      This property can be null.

      useAdvancedDial
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      removed
      List [1,*]: String
      __type
      "urn:inin.com:configuration.people:schedulesMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      description
      String

      This property can be null.

      isActive
      Boolean

      Setting this property to null will set it to its default value.

      Default value: true

      keywords
      List [Unbounded]: String
      Is a collection of items that each conform to all of these criteria:
      • Is a value not containing the character ','.

      This property can be null.

      Property type documentation:

      Represents a collection of strings.

      dates
      List [Unbounded]: Int
      The dates when the schedule is recurring. This property is valid for monthly and yearly schedule pattern. Is a collection of items that each conform to all of these criteria:
      • Is a value from 1 to 31.

      This property can be null.

      Property type documentation:

      Represents a collection of integers.

      days
      List [Unbounded]: Int
      The days the weekly schedule spans. When the pattern is a weekly day span, the value of this is expected to be a pair of days that consist of the day the schedule starts and the day the schedule ends. When the pattern is a weekly day list, the value of this is expected to have up to 7 values in it. The valid values for the days are [1..7] for [Sunday..Saturday]. This property is valid for weekly schedule patterns only. Is a collection of items that each conform to all of these criteria:
      • Is a value from 1 to 7.

      This property can be null.

      Property type documentation:

      Represents a collection of integers.

      endDate
      Date
      The end date of the schedule. The date is in the extended ISO8601 format, for example 2016-01-31, but a POST also accepts the basic ISO8601 format like 20160131. When there is no end date, the value is 0001-01-01.

      This property is required to be present in POST operations.

      endTime
      Time
      The end time of the schedule. The time is in the extended ISO8601 format, for example 22:05:00, but the POST also accepts the basic ISO8601 format like T220500.

      This property is required to be present in POST operations.

      isAllDay
      Boolean
      This can be used for weekly schedule pattern when the schedule spans multiple days.

      This property can be null.

      isDaySpan
      Boolean
      This can be used for weekly schedule pattern when the schedule spans multiple days.

      This property can be null.

      isRelative
      Boolean
      This can be used for yearly and monthly schedule pattern to indicate the relative day within the schedule.

      This property can be null.

      month
      Int
      The month when the schedule is recurring. The value is [1..12] for [January..December]. The value is This can only be used for yearly schedule pattern. The value must conform to all of these criteria:
      • Is a value from 1 to 12.

      This property can be null.

      oneTime
      0
      repeatDaily
      1
      repeatWeekly
      2
      repeatMonthly
      3
      repeatYearly
      4
      day
      0
      sunday
      1
      monday
      2
      tuesday
      3
      wednesday
      4
      thursday
      5
      friday
      6
      saturday
      7
      first
      0
      second
      1
      third
      2
      fourth
      3
      last
      4
      startDate
      Date
      The start date of the schedule. The date is in the extended ISO8601 format, for example 2016-01-31, but a POST also accepts the basic ISO8601 format like 20160131.

      This property is required to be present in POST operations.

      startTime
      Time
      The start time of the schedule. The time is in the extended ISO8601 format, for example 22:05:00, but the POST also accepts the basic ISO8601 format like T220500.

      This property is required to be present in POST operations.

      weeklyEndTime
      Time
      Time when the schedule ends if the schedule spans multiple days in weekly schedule. The time is in extended ISO8601 24 hour format of hh:mm:ss. The value must conform to all of these criteria:
      • Is a value matching the regular expression '(^(([0-1][0-9])|(2[0-3])):([0-5][0-9]):([0-5][0-9])$)'.

      This property can be null.

      weeklyStartTime
      Time
      Time when the schedule starts if the schedule spans multiple days in weekly schedule. The time is in extended ISO8601 24 hour format of hh:mm:ss. The value must conform to all of these criteria:
      • Is a value matching the regular expression '(^(([0-1][0-9])|(2[0-3])):([0-5][0-9]):([0-5][0-9])$)'.

      This property can be null.

      removed
      List [1,*]: String
      __type
      "urn:inin.com:configuration.people:secureInputFormsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      name
      String

      Required

      value
      String

      Required

      description
      String

      This property can be null.

      id
      String

      Required

      displayName
      String

      Required

      formName
      String

      This property can be null.

      none
      0
      custom
      1
      simple
      2
      ivrHandlerName
      String

      This property can be null.

      removed
      List [1,*]: String
      __type
      "urn:inin.com:configuration.system:serverParametersMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      value
      String

      This property can be null.

      removed
      List [1,*]: String
      __type
      "urn:inin.com:session:sessionsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      applicationName
      String

      Required

      The name of the application or program used to create the session. E.g., "Interaction Client .NET Edition".
      machineName
      String

      Required

      The name of the machine or computer where the session was created, if captured at login. This field will be an empty string if there is no machine information.
      connectionChange
      0
      configurationChange
      1
      __type
      "urn:inin.com:dialer:setFormDefinitionMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      campaignId
      String

      Required

      Campaign ID for Base Script definition.
      name
      String

      Required

      Name of the Base Script page.
      column
      String

      Required

      Database column linked to control.
      label
      String

      Required

      Label of the Base Script page.
      readOnly
      Boolean

      Required

      Specifies whether control has read-only property set.
      Text
      0
      Numeric
      1
      Radio
      2
      Listbox
      3
      DateTime
      4
      maxLines
      Int
      Maximum lines allowed for the control if applicable.
      maxChars
      Int
      Maximum characters allowed for the control if applicable.
      ShortDate
      1
      LongDate
      2
      Time
      4
      ShortDateWithTime
      5
      LongDateWithTime
      6
      [key]
      String

      Required

      The key identifying this pair.
      [value]
      String

      Required

      The value of this pair.
      label
      String

      Required

      Name of a disposition choice the agent can select from at the end of a call.
      wrapUpCategory
      String

      Required

      The wrap-up category assigned to the call.
      wrapUpCode
      String

      Required

      The wrap-up code assigned to the call.
      abandon
      Boolean

      Required

      Specifies if a call is marked as abandoned.
      recordStatus
      String

      Required

      Record status assigned for this disposition.
      isContact
      Boolean

      Required

      Specifies if this disposition is considered a contact.
      text
      String

      Required

      Static text of the Base Script page.
      stage
      Int
      Stage ID for the Base Script page.
      foregroundColor
      String

      Required

      Foreground color of the Base Script page.
      backgroundColor
      String

      Required

      Background color of the Base Script page.
      allowBreak
      Boolean

      Required

      Specifies whether this base script allows agents to request break.
      allowSkip
      Boolean

      Required

      Specifies whether this base script allows agents to skip calls.
      allowAgentOwned
      Boolean

      Required

      Specifies whether this base script allows agent-owned callbacks.
      militaryTime
      Boolean

      Required

      Specifies whether this base script should use 24-time format.
      pickupCall
      Boolean

      Required

      Specifies whether this base script should automatically pick-up alerting calls.
      allowSchedulePhone
      Boolean

      Required

      Specifies whether this base script allows scheduling.
      autoDisconnect
      Boolean

      Required

      Specifies whether this base script allows auto disconnect on disposition.
      allowEditingOfNumberToDial
      Boolean

      Required

      Specifies whether this base script allows editing of Number to Dial.
      allowAgentsAdditionalCalls
      Boolean

      Required

      Specifies whether this base script allows agents to place Additional Followup calls.
      allowEditingAdditionalCallNumbers
      Boolean

      Required

      Specifies whether this base script allows editing Additional Call Numbers.
      overrideDncBlock
      Boolean

      Required

      Specifies whether this base script allows overriding DNC block for manual calls.
      overrideZoneBlock
      Boolean

      Required

      Specifies whether this base script allows overriding zone block for manual calls.
      overrideSkillsBlock
      Boolean

      Required

      Specifies whether this base script allows overriding skills block for manual calls.
      overrideDailyLimitBlock
      Boolean

      Required

      Specifies whether this base script allows overriding daily limit block for manual calls.
      objectName
      String

      Required

      Object display name.
      extension
      String

      Required

      Extension number.
      objectType
      String

      Required

      Type of the object [Station, User, Workgroup, StationGroup or Attendant].
      __type
      "urn:inin.com:configuration.people:skillCategoriesMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      removed
      List [1,*]: String
      __type
      "urn:inin.com:configuration.people:skillsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      proficiency
      Int

      Required

      desireToUse
      Int

      Required

      removed
      List [1,*]: String
      __type
      "urn:inin.com:recordings:startScreenRecordingCompletedMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      requestId
      String

      Required

      __type
      "urn:inin.com:recordings:startStationAudioPlaybackCompletedMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      requestId
      String

      Required

      interactionId
      String
      The interaction ID for the station audio playback. This may be null on error.
      __type
      "urn:inin.com:connection:stationConnectionStateChangeMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      canBeDialed
      Boolean
      Indicates whether the station can be dialed.
      extension
      String

      Required

      Indicates the station extension.
      id
      String

      Required

      Indicates the station ID.
      ringAlways
      Boolean
      Indicates whether the station will always ring.
      sipAddress
      String
      Indicates the station SIP address.
      sipPassword
      String
      Indicates the station SIP password.
      sipUser
      String
      Indicates the station SIP User.
      remoteNumber
      String
      Indicates the remote number. Only available for remote number stations.
      managedIPPhone
      String

      Required

      This represents Managed IP Phone.
      Feature Version
      connection 15
      emergencyResponderLocationID
      String

      Required

      This represents emergency responder location ID for the emergency address stored in station object.
      Feature Version
      connection 15
      none
      0
      workstation
      1
      remoteWorkstation
      2
      remoteNumber
      3
      none
      0
      call
      1
      chat
      2
      email
      3
      generic
      4
      callback
      5
      smsMessage
      6
      workItem
      7
      directMessage
      8
      Feature Version
      connection 13
      socialConversation
      9
      Feature Version
      connection 13
      __type
      "urn:inin.com:statistics:statisticCatalogMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      statisticCatalogCacheTag
      String
      This tag represents the state of the session user's accessible categories of the statistic catalog. A client can persist the statistic catalog locally along with this cache tag. If a client chooses to do so, it can then send this cache tag in subsequent statistic catalog subscription requests. If the statistic categories which would be returned are the same, the corresponding statistic catalog message will not be sent and the client can use their cached statistic catalog.
      statisticCategoryId
      String

      Required

      The ID of the statistic category.
      displayString
      String

      Required

      A user friendly string for display purposes.
      description
      String

      Required

      A description of the statistic category.
      statisticIdentifier
      String

      Required

      The ID of the statistic definition.
      displayString
      String

      Required

      A user friendly string for display purposes.
      description
      String

      Required

      A description of the statistic definition.
      unitsDisplayString
      String

      Required

      The display string to define the measurement of units.
      orderedParameterTypeList
      List [Unbounded]: String

      Required

      The types of parameters required in a specific order.
      shouldBeSuppressed
      Boolean

      Required

      Gets a value indicating whether this should be suppressed from direct presentation to the user.
      precision
      Int

      Required

      The precision of the data.
      none
      0
      milliseconds
      1
      seconds
      2
      gigabytes
      3
      kilobytes
      4
      percent
      5
      int
      0
      double
      1
      string
      2
      bool
      3
      timeStamp
      4
      timeDuration
      5
      duration
      6
      futureDuration
      7
      finiteDuration
      8
      percent
      9
      statusMessage
      10
      weightedPercent
      11
      error
      12
      suppressInUI
      0
      The statistic should not be displayed in the UI.
      suppressInAlerts
      1
      The statistic should not be used for alerts.
      sortIndex
      Int
      The index used to sort statistics in views.
      expanded
      Boolean
      True if this statistic definition is expanded; otherwise false.
      drillDownId
      String

      Required

      The ID of the drill down.
      typeHint
      String

      Required

      The hint as to what the format is of the drill down data.
      hintString
      String

      Required

      The string that gives a hint as to what this drill down data refers to.
      accessControlRights
      List [Unbounded]: String

      Required

      A list of access rights that the user should have in order to see this catalog.
      licenses
      List [Unbounded]: String

      Required

      A list of the licenses that the user should have in order to see this catalog.
      parameterTypeId
      String

      Required

      The ID of the parameter type.
      displayString
      String

      Required

      A user friendly string for display purposes.
      description
      String

      Required

      The description of the associated parameter type.
      accessControlLists
      List [Unbounded]: String

      Required

      Each of the access control lists returned by this property could be used to fetch parameter values that the Session user is allowed to use. When retrieving available parameter values associated with this ParameterTypeDefinition, the values will be filtered to only include items allowed by these access control lists.
      preserveOrder
      Boolean

      Required

      True if the display order should be preserved; otherwise false.
      __type
      "urn:inin.com:configuration.people:statisticParameterGroupsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      removed
      List [1,*]: String
      __type
      "urn:inin.com:statistics:statisticValueMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      __type
      "urn:inin.com:status:statusMessagesMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      statusId
      String

      Required

      The ID of the status message. Used to refer to or set the status message.

      The value represented by this property should be treated as case-insensitive.

      messageText
      String

      Required

      Localized message text when displaying this status. Appears in list of selectable statuses.
      iconUri
      Uri

      Required

      The icon associated with this status message.
      groupTag
      String

      Required

      The group this status belongs to for reporting. A Status Group is a name that loosely categorizes a status message for reporting purposes. When a new status is defined in Interaction Administrator using the System Configuration < Status Messages container, it is mapped to a Status Group for reporting purposes.
      canHaveDate
      Boolean

      Required

      Indicates whether this status can have an ending date.
      canHaveTime
      Boolean

      Required

      Indicates whether this status can have an ending time.
      isDoNotDisturbStatus
      Boolean

      Required

      Indicates whether this status is a do not disturb status.
      isSelectableStatus
      Boolean

      Required

      Indicates whether this status is selectable by an agent.
      isPersistentStatus
      Boolean

      Required

      Indicates whether this status can persist when the agent logs out of IC.
      isForwardStatus
      Boolean

      Required

      Indicates whether this status is a forwarding status.
      isAfterCallWorkStatus
      Boolean

      Required

      Indicates whether this status requires after call work (ACW). Indicates that an agent is in "Follow Up" mode (IsAllowFollowUpStatus) after an ACD call.
      isAcdStatus
      Boolean

      Required

      Indicates whether an agent is available to receive ACD calls.
      isAllowFollowUpStatus
      Boolean

      Required

      Indicates that an agent's status can change to "Follow Up" after an ACD call terminates.
      systemId
      String

      Required

      An unique numeric identifier for this status message.
      statusMessagesRemoved
      List [Unbounded]: String
      A list of removed status messages.
      __type
      "urn:inin.com:status:statusMessagesUserAccessMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      userId
      String

      Required

      The unique identifier for this user status entry. This is the IC User name.
      statusMessagesAdded
      List [Unbounded]: String

      A list of added status message IDs that the user has rights to.

      The values represented in this property should be treated as case-insensitive.

      statusMessagesRemoved
      List [Unbounded]: String

      A list of status message IDs the user no longer has rights to.

      The values represented in this property should be treated as case-insensitive.

      __type
      "urn:inin.com:configuration.hardware:structuredParametersMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      description
      String

      This property can be null.

      name
      String

      Required

      Secrets
      0
      String
      1
      MultiString
      2
      values
      List [Unbounded]: String

      Required

      This property can be null.

      Property type documentation:

      Represents a collection of strings.

      removed
      List [1,*]: String
      __type
      "urn:inin.com:configuration:systemMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      id
      String

      Required

      The unique identifier used to reference this object.
      displayName
      String
      The display name of this object.

      This property can be null.

      __type
      "urn:inin.com:configuration.system:systemParametersMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      value
      String
      The value for this configuration object.
      Feature Version
      configuration 8

      This property can be null.

      removed
      List [1,*]: String
      __type
      "urn:inin.com:activations:userActivationMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String

      Required

      The ID of the watched subscription.
      userId
      String

      Required

      The ID of the user of this activation record.
      [key]
      String

      Required

      The key identifying this pair.
      [value]
      Boolean

      Required

      The value of this pair.
      __type
      "urn:inin.com:status:userStatusMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      userId
      String

      Required

      The unique identifier for this user status to update. This is the IC User name.

      statusId
      String

      Required

      The ID of the status message that the specified user is currently set to.

      The value represented by this property should be treated as case-insensitive.

      notes
      String

      The status message notes set by user.

      forwardNumber
      String

      The forward number set by user.

      onPhone
      Boolean

      This property indicates whether the user is on phone.

      onPhoneChanged
      DateTime

      This property is updated when status on onPhone changes.

      statusChanged
      DateTime

      This property is update when user status changes.

      stations
      List [Unbounded]: String

      The stations on which the user is logged in.

      icServers
      List [Unbounded]: String

      The name of the icServers to which the user is connected to.

      presenceServer
      String

      The name of the server that is providing status for this user.

      loggedIn
      Boolean

      Indicates whether or not the user is logged into a station.

      __type
      "urn:inin.com:status:userStatusPreviousInfoMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      statusId
      String

      Required

      Previous status message identifier defined from StatusMessageList.

      The value represented by this property should be treated as case-insensitive.

      notes
      String

      Required

      Previous status notes.
      forwardNumber
      String
      Previous status forward number.
      __type
      "urn:inin.com:configuration.people:usersMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      acdAgentGreeting
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      acdAgentGreetingFile
      String

      This property can be null.

      alias
      String

      This property can be null.

      autoAnswerAcdInteractions
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      autoAnswerNonAcdInteractions
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      clientConfigDateLastModified
      DateTime
      The date this configuration object was last modified.

      This property can be null.

      none
      0
      The property was not inherited.
      Workgroup
      1
      The property was inherited from a Workgroup configuration object.
      Role
      2
      The property was inherited from a Role configuration object.
      DefaultUser
      3
      The property was inherited from the Default User configuration object.
      ClientConfigurationTemplate
      4
      The property was inherited from a Client Configuration Template configuration object.
      applicationId
      String

      Required

      publishedDate
      DateTime

      Required

      cost
      Int
      The value must conform to all of these criteria:
      • Is a value from 0 to 100.

      Setting this property to null will set it to its default value.

      Default value: 0

      emergencyResponderLocationID
      String
      This location ID points to emergency details stored in Emergency Routing service (ERS) database.

      This is a read only property and can not be changed with PUT or POST operations.

      Feature Version
      configuration 16

      This property can be null.

      excludeFromDirectory
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      extension
      String
      The user's extension. The value for it must be unique among the workgroups and stations with an extension to ensure that the user can be reached. Additionally, if regional dialing is enabled on one or more locations, than each subset of the extension with a length of the number of significant digits must be unique as well. For example, say User X has an extension of 1111 and User Y has an extension of 111. If the number of significant digits is 3, then these extensions are invalid because User Y's extension is a subset of User X's extension. If the number of significant digits is 4, then these extensions are valid. The value must conform to all of these criteria:
      • Is a value representing a valid Extension.

      This property can be null.

      faxCapability
      Boolean

      Setting this property to null will set it to its default value.

      Default value: true

      homeSite
      Int
      The value must conform to all of these criteria:
      • Is a value referring to an existing configured item.

      This property can be null.

      acdSocialMedia
      Boolean
      This is used to enable user's Social Media types ACD routing from a configured workgroup.
      Feature Version
      configuration 14

      This property can be null.

      acdWhatsApp
      Boolean
      This is used to enable user's WhatsApp ACD routing from a configured workgroup.
      Feature Version
      configuration 14

      This property can be null.

      assignable
      0
      concurrent
      1
      hasClientAccess
      Boolean
      This is used to indicate if the user should be allowed to access the Interaction Client.

      Setting this property to null will set it to its default value.

      Default value: false

      none
      0
      directRoutedWorkItems
      1
      groupRoutedWorkItems
      2
      processMonitor
      3
      processDesigner
      4
      licenseActive
      Boolean
      This is used to indicate if the user's assigned licenses should be considered active by the server. Setting this to false will remove this user's licenses from the applied counts.

      Setting this property to null will set it to its default value.

      Default value: false

      none
      0
      media1
      1
      media2
      2
      media3
      3
      invalid
      0
      call
      1
      chat
      2
      email
      3
      generic
      4
      callback
      5
      workItem
      6
      socialDirectMessage
      7
      Feature Version
      configuration 14
      socialConversation
      8
      Feature Version
      configuration 14
      lyncIntegrationEnabled
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      lyncLineUri
      String
      The value must conform to all of these criteria:
      • Is a string with from 1 to 128 characters.

      This property can be null.

      none
      0
      publicConnectivity
      1
      remoteCallControl
      2
      organizeMeetingWithAnonymousParticipants
      3
      unifiedCommunications
      4
      enhancedPresence
      5
      remoteCallControlDualMode
      6
      autoAttendantEnabled
      7
      lyncSipAddress
      String
      The value must conform to all of these criteria:
      • Is a string with from 1 to 128 characters.

      This property can be null.

      directoryMoniker
      String

      This property can be null.

      displayName
      String

      This property can be null.

      emailAddress
      String

      This property can be null.

      mailboxMoniker
      String

      This property can be null.

      none
      0
      interactionMessageStore
      1
      imapSmtp
      2
      genericProvider
      3
      mwiAddress
      String

      This property can be null.

      mwiEnabled
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      default
      0
      address
      1
      nameSpellingsAsr
      List [Unbounded]: String

      This property can be null.

      Property type documentation:

      Represents a collection of strings.

      nameSpellingTts
      String

      This property can be null.

      ntDomainUser
      String
      The value must conform to all of these criteria:
      • Has a unique value for this attribute compared to other instances of this configuration object.

      This property can be null.

      outboundAni
      String

      This property can be null.

      outlookIntegrationEnabled
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      pagerActive
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      none
      0
      The property was not inherited.
      Workgroup
      1
      The property was inherited from a Workgroup configuration object.
      Role
      2
      The property was inherited from a Role configuration object.
      DefaultUser
      3
      The property was inherited from the Default User configuration object.
      ClientConfigurationTemplate
      4
      The property was inherited from a Client Configuration Template configuration object.
      assistantName
      String

      This property can be null.

      city
      String

      This property can be null.

      companyName
      String

      This property can be null.

      country
      String

      This property can be null.

      departmentName
      String

      This property can be null.

      emailAddress
      String

      This property can be null.

      emailAlias
      String

      This property can be null.

      givenName
      String

      This property can be null.

      notes
      String

      This property can be null.

      officeLocation
      String

      This property can be null.

      number
      String

      Required

      This property can be null.

      extension
      String

      This property can be null.

      dialExtensionAutomatically
      Boolean

      This property can be null.

      postalCode
      String

      This property can be null.

      stateOrProvince
      String

      This property can be null.

      streetAddress
      String

      This property can be null.

      surname
      String

      This property can be null.

      title
      String

      This property can be null.

      none
      0
      The property was not inherited.
      Workgroup
      1
      The property was inherited from a Workgroup configuration object.
      Role
      2
      The property was inherited from a Role configuration object.
      DefaultUser
      3
      The property was inherited from the Default User configuration object.
      ClientConfigurationTemplate
      4
      The property was inherited from a Client Configuration Template configuration object.
      statisticsShiftStarts
      List [Unbounded]: Duration
      Is a collection of items that each conform to all of these criteria:
      • Is a value from 0 to 86340.

      Setting this property to null will set it to its default value.

      Default value: 0:00

      Property type documentation:

      Represents a collection of durations.

      statusText
      String

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      umDestination
      String
      The value must conform to at least one of these criteria:
      • Is a configuration ID reference to an existing instance in the server's 'Station' collection, where 'i3config::attribute::station_type' is 'Unified Messaging'.
      • Is the value ''IC Server''.

      This property can be null.

      umRemoteOverride
      String

      This property can be null.

      All
      0
      Generous
      1
      Best
      2
      Strict
      3
      actualValue
      Int
      The value directly assigned to this configuration object. This value is required for POST and PUT operations.

      This property can be null.

      effectiveValue
      Int
      The effective value of this property, from the blending of the actualValue with the inheritedValue. This value is required for GET object and GET object list operations.

      This property can be null.

      inheritedValue
      Int
      The actual inherited value, based on this configuration object's membership/inheritance, such as Workgroup, Role, and Default User.

      This property can be null.

      none
      0
      The property was not inherited.
      Workgroup
      1
      The property was inherited from a Workgroup configuration object.
      Role
      2
      The property was inherited from a Role configuration object.
      DefaultUser
      3
      The property was inherited from the Default User configuration object.
      ClientConfigurationTemplate
      4
      The property was inherited from a Client Configuration Template configuration object.
      values
      Int

      Required

      phoneNumber
      String

      Required

      The phone number to call.
      timeout
      Int

      Required

      How long to ring the follow-me number before moving to the next number in the list or transferring the call to voice mail.
      usePin
      Boolean

      Required

      If true, than the call recipient will be required to enter their IC password to accept the call.
      invalid
      0
      call
      1
      chat
      2
      email
      3
      generic
      4
      callback
      5
      workItem
      6
      socialDirectMessage
      7
      Feature Version
      configuration 14
      socialConversation
      8
      Feature Version
      configuration 14
      utilization
      Int

      Required

      maxAssignable
      Int

      Required

      none
      0
      The property was not inherited.
      Workgroup
      1
      The property was inherited from a Workgroup configuration object.
      Role
      2
      The property was inherited from a Role configuration object.
      DefaultUser
      3
      The property was inherited from the Default User configuration object.
      ClientConfigurationTemplate
      4
      The property was inherited from a Client Configuration Template configuration object.
      vniStation
      String

      This property can be null.

      whisperToneLevel
      Int
      The value must conform to all of these criteria:
      • Is a value from -40 to 0.

      Setting this property to null will set it to its default value.

      Default value: -25

      removed
      List [1,*]: String
      __type
      "urn:inin.com:unifiedMessaging:voicemailMessageSubscriptionStateMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      none
      0
      There is no subscription.
      normal
      1
      Subscriptions are working as expected. Suspended subscriptions can be resumed, returning them to this state.
      suspended
      2
      Suspended subscriptions have become incapable of sending their associated message. Suspended subscriptions can be resumed, returning them to the normal state.
      faulted
      3
      Faulted subscriptions have encountered a problem they cannot recover from, so they've ended themselves. A subsequent DELETE request, on a faulted subscription, is not necessary, but it cannot be resumed, and will need to be re-made.
      __type
      "urn:inin.com:unifiedMessaging:voicemailMessagesMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      __type
      "urn:inin.com:unifiedMessaging:voicemailMessageAdded"

      Required

      The JSON type representing this option.
      unifiedMessageId
      String

      Required

      The unique identifier for the message.
      unread
      0
      The message has not been read.
      read
      1
      The message has been read.
      dateReceived
      DateTime

      Required

      The date/time stamp the message was received.
      from
      String

      Required

      The party that sent the message.
      subject
      String

      Required

      The subject of the message.
      __type
      "urn:inin.com:unifiedMessaging:voicemailMessage"

      Required

      The JSON type representing this option.
      unifiedMessageId
      String

      Required

      The unique identifier for the message.
      unread
      0
      The message has not been read.
      read
      1
      The message has been read.
      voicemailMessagesRemoved
      List [1,*]: String
      The list of voicemail message IDs removed from a user's inbox.
      __type
      "urn:inin.com:unifiedMessaging:voicemailPlayStatusMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      unifiedMessageId
      String

      Required

      The unique identifier of the voicemail message that the play update refers to.
      playing
      0
      The voicemail is currently playing.
      stopped
      1
      The voicemail has stopped playing.
      __type
      "urn:inin.com:activations:workgroupActivationMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String

      Required

      The ID of the watched subscription.
      workgroupId
      String

      Required

      List of IDs for workgroups that are targets.
      [key]
      String

      Required

      The key identifying this pair.
      [value]
      Boolean

      Required

      The value of this pair.
      __type
      "urn:inin.com:configuration.people:workgroupsMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      acdSaveRepliesToSentItemsFolder
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      acdUseAvailablityTime
      Boolean

      Setting this property to null will set it to its default value.

      Default value: true

      agentScoreChange
      Int
      The value must conform to all of these criteria:
      • Is a value from -1000 to 1000.

      Setting this property to null will set it to its default value.

      Default value: -10

      callbackMaxRetry
      Int
      The value must conform to all of these criteria:
      • Is a value of at least 0.

      Setting this property to null will set it to its default value.

      Default value: 0

      callbackServiceLevelDistribution
      List [Unbounded]: Duration
      Is a collection of items that each conform to all of these criteria:
      • Is a collection containing 1 to 14 items.
      • Is a value from 0 to 604800.

      Setting this property to null will set it to its default value.

      Default value: [300, 600, 900, 1800, 3600, 7200, 14400, 28800]

      Property type documentation:

      Represents a collection of durations.

      callbackServiceLevelTarget
      Duration
      The value must conform to all of these criteria:
      • Is a value from 0 to 604800.

      Setting this property to null will set it to its default value.

      Default value: 14400

      callbackSnoozeDuration
      Int
      The value must conform to all of these criteria:
      • Is a value of at least 0.

      Setting this property to null will set it to its default value.

      Default value: 0

      callServiceLevelDistribution
      List [Unbounded]: Duration
      Is a collection of items that each conform to all of these criteria:
      • Is a collection containing 1 to 14 items.
      • Is a value from 0 to 604800.

      Setting this property to null will set it to its default value.

      Default value: [5, 10, 20, 30, 40, 50, 60, 120]

      Property type documentation:

      Represents a collection of durations.

      callServiceLevelTarget
      Duration
      The value must conform to all of these criteria:
      • Is a value from 0 to 604800.

      Setting this property to null will set it to its default value.

      Default value: 30

      callStatisticsPeriod
      Int
      The value must conform to all of these criteria:
      • Is a value from 5 to 480.

      Setting this property to null will set it to its default value.

      Default value: 30

      captureInRecordings
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      chatServiceLevelDistribution
      List [Unbounded]: Duration
      Is a collection of items that each conform to all of these criteria:
      • Is a collection containing 1 to 14 items.
      • Is a value from 0 to 604800.

      Setting this property to null will set it to its default value.

      Default value: [10, 20, 30, 45, 60, 90, 120, 240]

      Property type documentation:

      Represents a collection of durations.

      chatServiceLevelTarget
      Duration
      The value must conform to all of these criteria:
      • Is a value from 0 to 604800.

      Setting this property to null will set it to its default value.

      Default value: 30

      clientWaitTimeout
      Int
      The value must conform to all of these criteria:
      • Is a value from 0 to 60.

      Setting this property to null will set it to its default value.

      Default value: 30

      emailServiceLevelDistribution
      List [Unbounded]: Duration
      Is a collection of items that each conform to all of these criteria:
      • Is a collection containing 1 to 14 items.
      • Is a value from 0 to 604800.

      Setting this property to null will set it to its default value.

      Default value: [300, 600, 1200, 1800, 3600, 7200, 14400, 28800]

      Property type documentation:

      Represents a collection of durations.

      emailServiceLevelTarget
      Duration
      The value must conform to all of these criteria:
      • Is a value from 0 to 604800.

      Setting this property to null will set it to its default value.

      Default value: 14400

      estimatedCallTimeInterval
      Int
      The value must conform to all of these criteria:
      • Is a value from 5 to 480.

      Setting this property to null will set it to its default value.

      Default value: 30

      executeTransferActionOnUserTransfer
      Boolean

      Setting this property to null will set it to its default value.

      Default value: true

      extension
      String
      The value must conform to all of these criteria:
      • Is a value representing a valid Extension.

      This property can be null.

      faxCapability
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      genericServiceLevelDistribution
      List [Unbounded]: Duration
      Is a collection of items that each conform to all of these criteria:
      • Is a collection containing 1 to 14 items.
      • Is a value from 0 to 604800.

      Setting this property to null will set it to its default value.

      Default value: [10, 20, 30, 45, 60, 90, 120, 240]

      Property type documentation:

      Represents a collection of durations.

      genericServiceLevelTarget
      Duration
      The value must conform to all of these criteria:
      • Is a value from 0 to 604800.

      Setting this property to null will set it to its default value.

      Default value: 30

      gracePeriodBeforeNew
      Int
      The value must conform to all of these criteria:
      • Is a value from 0 to 120.

      Setting this property to null will set it to its default value.

      Default value: 10

      hasQueue
      Boolean

      This is a read only property and can not be changed with PUT or POST operations.

      Setting this property to null will set it to its default value.

      Default value: false

      isAcdEmailRoutingActive
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      isActive
      Boolean

      Setting this property to null will set it to its default value.

      Default value: true

      isCallbackEnabled
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      isExemptHeldInteractionsEnabled
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      isWrapUpActive
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      keypadWaitTimeout
      Int
      The value must conform to all of these criteria:
      • Is a value from 0 to 60.

      Setting this property to null will set it to its default value.

      Default value: 30

      maximumChatReponseTime
      Int
      The value must conform to all of these criteria:
      • Is a value from 0 to 3600.

      This property can be null.

      maxNumberOfExempt
      Int
      The value must conform to all of these criteria:
      • Is a value from 1 to 100.

      Setting this property to null will set it to its default value.

      Default value: 1

      membersSpanSites
      Boolean
      This value can only be set to true if the homesite is participating in multi-site configuration. The value must conform to all of these criteria:
      • Is a value referring to an existing configured item.

      Setting this property to null will set it to its default value.

      Default value: false

      canReceiveEncryptedEmail
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      emailAddress
      String

      This property is required to be present in POST operations.

      inboundFolder
      String
      For inbound mailbox types, this folder must exist in the configured mailbox. For non-inbound mailboxes, this must be null. An Invalid Folder validation error will be returned otherwise. The value must conform to all of these criteria:
      • The ACD mailbox inbound folder must exist or be set to null.

      This property can be null.

      mailboxMoniker
      String
      When this value is changed for inbound mailboxes, the current Inbound Folder must exist in the new mailbox or an Invalid Folder validation error will be returned with the folder name. The value must conform to all of these criteria:
      • The ACD mailbox inbound folder must exist or be set to null.

      This property is required to be present in POST operations.

      inbound
      0
      outbound
      1
      outboundAndInbound
      2
      nameSpellingsAsr
      List [Unbounded]: String

      This property can be null.

      Property type documentation:

      Represents a collection of strings.

      nameSpellingTts
      String

      This property can be null.

      onHoldMessage
      String

      This property can be null.

      onHoldMusic
      String

      This property can be null.

      operatorTarget
      String

      This property can be null.

      playToExternalPartiesOnly
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      None
      0
      Custom
      1
      GroupRing
      2
      Sequential
      3
      RoundRobin
      4
      ACD
      5
      recordAll
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      revertToAvailableTimeout
      Int
      The value must conform to all of these criteria:
      • Is a value from 0 to 10000.

      Setting this property to null will set it to its default value.

      Default value: 0

      socialConversationServiceLevelDistribution
      List [Unbounded]: Duration
      Is a collection of items that each conform to all of these criteria:
      • Is a collection containing 1 to 14 items.
      • Is a value from 0 to 604800.
      Feature Version
      configuration 14

      Setting this property to null will set it to its default value.

      Default value: [300, 600, 1200, 1800, 3600, 7200, 14400, 28800]

      Property type documentation:

      Represents a collection of durations.

      socialConversationServiceLevelTarget
      Duration
      The value must conform to all of these criteria:
      • Is a value from 0 to 604800.
      Feature Version
      configuration 14

      Setting this property to null will set it to its default value.

      Default value: 14400

      socialDirectMessageServiceLevelDistribution
      List [Unbounded]: Duration
      Is a collection of items that each conform to all of these criteria:
      • Is a collection containing 1 to 14 items.
      • Is a value from 0 to 604800.
      Feature Version
      configuration 14

      Setting this property to null will set it to its default value.

      Default value: [10, 20, 30, 45, 60, 90, 120, 240]

      Property type documentation:

      Represents a collection of durations.

      socialDirectMessageServiceLevelTarget
      Duration
      The value must conform to all of these criteria:
      • Is a value from 0 to 604800.
      Feature Version
      configuration 14

      Setting this property to null will set it to its default value.

      Default value: 14400

      statisticsShiftStarts
      List [Unbounded]: Duration
      Is a collection of items that each conform to all of these criteria:
      • Is a value from 0 to 86340.

      Setting this property to null will set it to its default value.

      Default value: 0:00

      Property type documentation:

      Represents a collection of durations.

      useRecordingTones
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      useTiffForFaxes
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      voicemailMessage
      String

      This property can be null.

      displayName
      String

      This property can be null.

      emailAddress
      String

      This property can be null.

      none
      0
      interactionMessageStore
      1
      imapSmtp
      2
      genericProvider
      3
      workItemServiceLevelDistribution
      List [Unbounded]: Duration
      Is a collection of items that each conform to all of these criteria:
      • Is a collection containing 1 to 14 items.
      • Is a value from 0 to 604800.

      Setting this property to null will set it to its default value.

      Default value: [30, 60, 900, 1800, 3600, 14400, 86400, 172800]

      Property type documentation:

      Represents a collection of durations.

      workItemServiceLevelTarget
      Duration
      The value must conform to all of these criteria:
      • Is a value from 0 to 604800.

      Setting this property to null will set it to its default value.

      Default value: 14400

      wrapUpPrompt
      String

      This property can be null.

      wrapUpTimeout
      Int
      The value must conform to all of these criteria:
      • Is a value of at least 1.
      • Both the values of wrapUpStatus and wrapUpTimeout needs both to be null or not null.

      This property can be null.

      removed
      List [1,*]: String
      __type
      "urn:inin.com:configuration.people:wrapUpCategoriesMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      isActualContact
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      isPermanent
      Boolean

      This is a read only property and can not be changed with PUT or POST operations.

      Setting this property to null will set it to its default value.

      Default value: false

      isSuccessfulInteraction
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      phoneNumberStatus
      String
      The value must conform to all of these criteria:
      • Is a string with from 0 to 1 characters.

      This property can be null.

      recordStatus
      String
      The value must conform to all of these criteria:
      • Is a string with from 0 to 1 characters.

      This property can be null.

      shouldIncrementAttempts
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      removed
      List [1,*]: String
      __type
      "urn:inin.com:configuration.people:wrapUpCodesMessage"

      Required

      The JSON type representing this option.
      isDelta
      Boolean

      Required

      When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

      When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

      subscriptionId
      String
      The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
      createdDate
      DateTime
      The date this configuration object was created.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      lastModifiedDate
      DateTime
      The date this configuration object was last modified.

      This is a read only property and can not be changed with PUT or POST operations.

      This property can be null.

      notes
      String
      The notes for this configuration object.

      This property can be null.

      digits
      String
      The value must conform to all of these criteria:
      • Has a unique value for this attribute compared to other instances of this configuration object.
      • Is a value matching the regular expression '\d{1,10}'.

      This property can be null.

      isPermanent
      Boolean

      This is a read only property and can not be changed with PUT or POST operations.

      Setting this property to null will set it to its default value.

      Default value: false

      isRightPartyContact
      Boolean

      Setting this property to null will set it to its default value.

      Default value: false

      removed
      List [1,*]: String
      400 - Bad Request
      The request was invalid. This can occur when the message body is malformed or missing required items. This will also occur if a required header or query string parameter is missing or invalid.
      error
      Provides additional detail for an error.
      Property
      Value
      Comments
      errorId
      String
      The error identifier that describes the current error.
      message
      String

      Required

      A message that describes the current error.
      401 - Unauthorized
      The specified session token is missing, invalid, or has expired.
      Parameters
      Type
      Name
      Comments
      Header
      WWW-Authenticate

      Required

      Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.

      WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"

        error
        Provides additional detail for an error.
        Property
        Value
        Comments
        errorId
        String
        The error identifier that describes the current error.
        message
        String

        Required

        A message that describes the current error.
        410 - Gone
        This resource has been deprecated and removed from the API.
        error
        Provides additional detail for an error.
        Property
        Value
        Comments
        errorId
        String
        The error identifier that describes the current error.
        message
        String

        Required

        A message that describes the current error.
        500 - Internal Server Error
        An unexpected error occurred while processing the request.
        error
        Provides additional detail for an error.
        Property
        Value
        Comments
        errorId
        String
        The error identifier that describes the current error.
        message
        String

        Required

        A message that describes the current error.

        Event Source

        /icws/{sessionId}/messaging/messages

        A server-sent event endpoint for message representations. Each server-sent message is a single message representation.

        This endpoint is equivalent in functionality to the GET method with same resource URL, but the response is an implementation of the W3C Server-Sent Events Recommendation.

        Applications should not utilize this event source and the GET method for retrieving messages in a single session. For more information on handling message retrieval, see Retrieving Messages.

        Feature Version
        messaging 2

        Parameters

        Type
        Name
        Comments
        Template
        sessionId

        Required

        The ININ session ID necessary for all calls that require a security or user context.

          Header
          Cookie

          Required

          The session cookie. With the exception of the connection request, all requests must provide a session cookie.

            Query
            heartbeat

            Indicates that the client will send a periodic request as a heartbeat. This query string does not require a value. The required request to provide a heartbeat is POST /icws/{sessionId}/messaging/heartbeat.

            Feature Version
            messaging 3

              Server-sent Message Representation

              Property
              Value
              Comments

              Multiple options:

              The value can be assigned any of the following options.
              __type
              "urn:inin.com:configuration.people:accessControlGroupsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:configuration.people:accountCodesConfigurationMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              createdDate
              DateTime
              The date this configuration object was created.

              This is a read only property and can not be changed with PUT or POST operations.

              This property can be null.

              lastModifiedDate
              DateTime
              The date this configuration object was last modified.

              This is a read only property and can not be changed with PUT or POST operations.

              This property can be null.

              notes
              String
              The notes for this configuration object.

              This property can be null.

              accountCodesEnabled
              Boolean
              Property to enable the use of account codes.

              Setting this property to null will set it to its default value.

              Default value: false

              __type
              "urn:inin.com:configuration.people:accountCodesMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:configuration.system:actionsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:alerts:alertCatalogChangedMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              alertSetsRemoved
              List [1,*]: String
              __type
              "urn:inin.com:alerts:alertNotificationMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              alertDefinitionId
              String

              Required

              Gets the ID of the AlertDefinition assoicated with this notifiction.
              alertRuleId
              String

              Required

              Gets the ID of the AlertRule that the alert was raised on.
              cleared
              Boolean

              Required

              Gets a value indicating whether this AlertNotification is cleared.
              timeStamp
              DateTime

              Required

              Gets the received date and time.
              __type
              "urn:inin.com:interactions.assistance:assistanceRequestDetailsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              assistanceId
              String

              Required

              The assistance ID for this assistance request.
              interactionId
              String
              The interaction ID associated with the assistance request.
              None
              0
              Accepted
              1
              Completed
              2
              text
              String

              Required

              The message text.
              participantId
              String

              Required

              The user ID of the participant that added the message text.
              timeAdded
              DateTime

              Required

              The date and time the message text was added.
              __type
              "urn:inin.com:interactions.assistance:assistanceRequestListMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              requestsAdded
              List [Unbounded]: String
              The assistance requests that have been added.

              Property type documentation:

              Represents a list of assistance requests.

              requestsRemoved
              List [Unbounded]: String
              The assistance requests that have been removed.

              Property type documentation:

              Represents a list of assistance requests.

              __type
              "urn:inin.com:interactions.assistance:assistanceRequestSubscriptionStateMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              none
              0
              There is no subscription.
              normal
              1
              Subscriptions are working as expected. Suspended subscriptions can be resumed, returning them to this state.
              suspended
              2
              Suspended subscriptions have become incapable of sending their associated message. Suspended subscriptions can be resumed, returning them to the normal state.
              faulted
              3
              Faulted subscriptions have encountered a problem they cannot recover from, so they've ended themselves. A subsequent DELETE request, on a faulted subscription, is not necessary, but it cannot be resumed, and will need to be re-made.
              __type
              "urn:inin.com:messaging:asyncOperationCompletedMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              requestId
              String

              Required

              __type
              "urn:inin.com:configuration.hardware:audioSourcesMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:dialer:autoLoginMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              campaignId
              String

              Required

              The ID of the campaign the agent is logged in to.
              initiatorName
              String

              Required

              This identifies the rule or supervisor who initiated the agent's campaign login.
              __type
              "urn:inin.com:dialer:autoLogoutMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              campaignIds
              List [1,*]: String

              Required

              The list of campaign IDs for which a campaign logoff was requested.
              initiatorName
              String

              Required

              This identifies the rule or supervisor who initiated the agent's campaign logout request.
              __type
              "urn:inin.com:dialer:availableCampaignsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              __type
              "urn:inin.com:dialer:availableCampaign"

              Required

              The JSON type representing this option.
              name
              String

              Required

              The name of the campaign.
              id
              String

              Required

              The ID of the campaign.
              workgroup
              String

              Required

              The workgroup associated with the campaign.
              Invalid
              0
              On
              1
              Off
              2
              ScheduleOnly
              4
              Auto
              8
              Paused
              16
              Completed
              32
              hasBaseScript
              Boolean
              Represents whether this campaign applies a Base Script definition.
              Feature Version
              dialer 3
              customScriptUrl
              String
              Custom script URL associated with campaign.
              Feature Version
              dialer 3
              isLoggedIn
              Boolean
              Indicates whether agent is currently logged into this campaign.
              Feature Version
              dialer 3
              Predictive
              1
              Power
              2
              Preview
              3
              Agentless
              8
              __type
              "urn:inin.com:dialer:changedCampaign"

              Required

              The JSON type representing this option.
              name
              String

              Required

              The name of the campaign.
              id
              String

              Required

              The ID of the campaign.
              Invalid
              0
              On
              1
              Off
              2
              ScheduleOnly
              4
              Auto
              8
              Paused
              16
              Completed
              32
              id
              String

              Required

              The ID of the removed campaign.
              agentHasLogonCampaignRight
              Boolean

              Required

              Specifies if the agent has the "Logon Campaign" security right to choose which campaigns to log in to. Agents without this right are automatically logged in to all campaigns they are eligible for. After agents are logged in, ready-for-calls still needs to be called to have calls routed to them.
              __type
              "urn:inin.com:dialer:breakStatusMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              NotOnBreak
              0
              BreakPending
              1
              OnBreak
              2
              __type
              "urn:inin.com:interactions.callback:callbackMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              interactionId
              String

              Required

              The ID of the interaction this message corresponds to.
              target
              String

              Required

              The target for this callback.
              name
              String
              The name of the person who created this callback.
              subject
              String

              Required

              A message that describes the reason for this callback.
              attempts
              Int
              The retry attempt for this callback.
              maxAttempts
              Int
              The maximum number of attempts for this callback.
              associatedCallId
              String
              The call ID of the associated call to the callback.
              snoozed
              Boolean
              Whether this callback is snoozed or not.
              __type
              "urn:inin.com:statistics:chainedParametersChangeMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              [key]
              String

              Required

              This is the parameterTypeId.
              parameterValuesRemoved
              List [Unbounded]: String

              Property type documentation:

              Represents a collection of strings.

              __type
              "urn:inin.com:interactions.chat:chatContentsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              interactionId
              String

              Required

              The ID of the interaction this message corresponds to.

              Multiple options:

              The value can be assigned any of the following options.
              None
              0
              SystemMember
              1
              CurrentUser
              2
              Internal
              3
              External
              4
              displayName
              String

              Required

              The display name of the chat member.
              interactionId
              String

              Required

              The interaction ID for the updated interaction. A combination of this field and the userId can be used to uniquely identify a user.
              userId
              String

              Required

              The userId of the chat member. A combination of this field and the interactionId can be used to uniquely identify a user.
              __type
              "urn:inin.com:interactions.chat:fullChatMember"

              Required

              The JSON type representing this option.
              None
              0
              SystemMember
              1
              CurrentUser
              2
              Internal
              3
              External
              4
              displayName
              String

              Required

              The display name of the chat member.
              interactionId
              String

              Required

              The interaction ID for the updated interaction. A combination of this field and the userId can be used to uniquely identify a user.
              userId
              String

              Required

              The userId of the chat member. A combination of this field and the interactionId can be used to uniquely identify a user.
              isTyping
              Boolean

              Required

              Indicates if this chat member is typing.
              text
              String

              Required

              The chat text.

              This property can be null.

              timestamp
              DateTime

              Required

              The timestamp associated with the chat text.
              Text
              0
              File
              1
              __type
              "urn:inin.com:interactions.chat:chatMembersMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              interactionId
              String

              Required

              The ID of the interaction this message corresponds to.
              __type
              "urn:inin.com:configuration.people:clientButtonsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:configuration.people:clientConfigurationTemplatesMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:configuration.people:clientTemplatesMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:connection:connectionStateChangeMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              none
              0
              up
              1
              down
              2
              none
              0
              up
              1
              down
              2
              reason
              String

              Required

              A description of the condition that caused the change in connection state.
              shouldReconnect
              Boolean
              A flag indicating that the condition for the connection to go down is one that the client should reconnect to the server. When newConnectionState is set to down, an unspecified value should be assumed to be false.
              Feature Version
              connection 3
              __type
              "urn:inin.com:interactions:consultMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              originalParty
              Boolean
              The original party has two-way audio with the agent.
              consultedParty
              Boolean
              The consulted party has two-way audio with the agent.
              __type
              "urn:inin.com:qualityManagement:createSearchCompletedMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              requestId
              String

              Required

              moreResults
              Boolean

              Required

              True if the result count exceeds the maximum number of results specified.
              recordingId
              String

              Required

              The ID of the recording.
              unknown
              0
              call
              1
              chat
              2
              chatTranscript
              3
              email
              4
              screen
              5
              socialConversation
              6
              socialDirectMessage
              7
              interactionId
              String

              Required

              Interaction ID of the recording.
              recordingDuration
              Int
              The recording duration in milliseconds.

              This property can be null.

              recordingTime
              DateTime

              Required

              The recording time in UTC.
              recordingInitiationPolicy
              String
              The name of the recording initiation policy.

              This property can be null.

              recordingVersion
              Int

              Required

              The version of the recording.
              recordingFileSize
              Int
              The size of the recording in bytes.

              This property can be null.

              workgroup
              String
              The IC Workgroup associated with this recording.

              This property can be null.

              NoRights
              0
              The user has no rights to the object.
              ReadAccess
              1
              The user has read access to the object.
              WriteAccess
              2
              The user has write access to the object.
              CanPlay
              4
              The user can play the recording.
              CanExportOrArchive
              8
              The user can export or archive the recording.
              CanEmail
              16
              The user can email the recording.
              CanScore
              32
              The user can score the recording.
              CanViewParticipant
              64
              The user can view participants of the recording.
              CanDeleteRecording
              128
              The user can delete the recording.
              CanViewAuditTrail
              4096
              The user can view the recording's audit trail.
              CanViewScorecards
              8192
              The user can view scorecards.
              CanViewCustomAttributes
              16384
              The user can view recording custom attributes.
              CanModifyCustomAttributes
              32768
              The user can modify recording custom attributes.
              CanViewTags
              65536
              The user can view recording tags.
              CanModifyTags
              131072
              The user can modify recording tags.
              CanAddBookmarks
              262144
              The user can add recording bookmarks.
              CanViewSignatureComments
              524288
              The user can view scorecard signature comments.
              CanDeleteScorecards
              1048576
              The user can delete scorecards.
              CanAssignQuestionnaires
              2097152
              The user can assign questionnaires.
              EncumberedRecording
              1073741824
              The recording is encumbered.
              recordingMediaStatus
              String
              The status of the recording media.

              This property can be null.

              scorecardId
              String

              Required

              The scorecard ID.
              questionnaireId
              String

              Required

              The scorecard's questionnaire ID.
              scoredUser
              String
              The IC User ID of the scored user.

              This property can be null.

              scoringUser
              String
              The IC User ID of the scoring user.

              This property can be null.

              isFailed
              Boolean
              True if the scorecard is considered failed.

              This property can be null.

              scoringTime
              DateTime

              Required

              The UTC time this scorecard was last modified.
              invalid
              0
              assigned
              1
              inProgress
              2
              complete
              3
              rank
              String
              The scorecard's current rank.

              This property can be null.

              scorePct
              Double

              Required

              The scorecard's current score percentage.
              notRequired
              0
              inProgress
              1
              complete
              2
              none
              0
              marked
              1
              required
              2
              avgWorkgroupScorePct
              Double
              The average score percentage for this scorecard within the workgroup.

              This property can be null.

              avgWorkgroupRank
              String
              The average rank for this scorecard within the workgroup.

              This property can be null.

              surveyFormId
              String

              Required

              The unique ID for the completed survey.
              surveyId
              String

              Required

              The ID of the survey.
              scorePct
              Double
              The survey score percentage.

              This property can be null.

              rank
              String
              The survey rank.

              This property can be null.

              __type
              "urn:inin.com:ipa:currentPageSubscriptionClosePageEventArgs"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              workItemInstanceId
              String

              Required

              This property indicates the ID of the work item instance from which this message was received.

              workItemCompleted
              1
              workItemHeld
              2
              workItemDisconnected
              3
              workItemNoLongerAssignedToUser
              4
              processInError
              5
              userNoLongerLicensedForIpa
              6
              __type
              "urn:inin.com:ipa:currentPageSubscriptionCommandCompleteEventArgs"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              workItemInstanceId
              String

              Required

              This property indicates the ID of the work item instance from which this message was received.

              requestId
              String

              Required

              This property contains the same token that was included in the response when the page command was queued. It can be used to correlate this event message to the request that caused the caused the event to occur.

              dataId
              String

              This property indicates the fully-scoped ID of the data that is being referenced.

              See String Representation of Fully-Scoped GUID for more information about how a fully-scoped GUID is represented as a string.

              __type
              "urn:inin.com:ipa:currentPageSubscriptionShowPageEventArgs"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              workItemInstanceId
              String

              Required

              This property indicates the ID of the work item instance from which this message was received.

              workItemDynamicDetails
              String

              Required

              This property indicates the current Work Item Dynamic Details of the work item instance for which the page is being displayed.

              pageInstanceId
              String

              Required

              This property indicates the ID of the specific page instance that is being shown as the current page. Each time a command is sent to PAS for the current page, that command request must also include this ID.

              __type
              "urn:inin.com:ipa:runtimeDataValuesListMeta"

              Required

              The JSON type representing this option.
              payloadType
              String

              Required

              This field specifies the type of payload that is described by the object that contains this meta object.

              The value of this field will always be "dataValue" for the data values received as part of a show page event message.

              formatVersion
              String

              Required

              This field contains a string value that looks like a typical #.#.#.# version string. The numbers represented in this string may change over time as new features are added to IPA.

              The current value for formatVersion is 3.0.0.0.

              Multiple options:

              The value can be assigned any of the following options.
              __type
              "urn:inin.com:ipa:booleanDataInstColl"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              __type
              "urn:inin.com:ipa:booleanDataInstSing"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              val
              Boolean

              This field contains a boolean value to use for this data type object instance . If this field is not emitted or if its value is null, then an not set should be assumed.

              Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

              This property can be null.

              __type
              "urn:inin.com:ipa:complexDataInstColl"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              __type
              "urn:inin.com:ipa:complexDataInstCollItem"

              Required

              The JSON type representing this option.
              id
              String

              Required

              This field contains the object instance ID for this object instance.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              __type
              "urn:inin.com:ipa:complexDataInstSing"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              __type
              "urn:inin.com:ipa:currencyDataInstColl"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              __type
              "urn:inin.com:ipa:currencyDataInstSing"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              __type
              "urn:inin.com:ipa:dateDataInstColl"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              __type
              "urn:inin.com:ipa:dateDataInstSing"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              val
              String

              This field contains the string representation of the value to use for this date data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

              Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

              See String Representation of Date Values for more information about how a date value is represented as a string.

              This property can be null.

              __type
              "urn:inin.com:ipa:dateTimeDataInstColl"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              __type
              "urn:inin.com:ipa:dateTimeDataInstSing"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              val
              String

              This field contains the string representation of the value to use for this date-time data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

              Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

              See String Representation of Date-Time Values for more information about how a date-time value is represented as a string.

              This property can be null.

              __type
              "urn:inin.com:ipa:decimalDataInstColl"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              __type
              "urn:inin.com:ipa:decimalDataInstSing"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              val
              String

              This field contains the string representation of the value to use for this decimal data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

              Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

              See String Representation of Decimal Values for more information about how a decimal value is represented as a string.

              This property can be null.

              __type
              "urn:inin.com:ipa:durationDataInstColl"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              __type
              "urn:inin.com:ipa:durationDataInstSing"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              val
              String

              This field contains the string representation of the value to use for this duration data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

              Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

              See String Representation of Duration Values for more information about how a decimal value is represented as a string.

              This property can be null.

              __type
              "urn:inin.com:ipa:longDataInstColl"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              __type
              "urn:inin.com:ipa:longDataInstSing"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              val
              String

              This field contains the string representation of the value to use for this long data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

              Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

              See String Representation of Long Values for more information about how a long value is represented as a string.

              This property can be null.

              __type
              "urn:inin.com:ipa:mailboxDataInstColl"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              __type
              "urn:inin.com:ipa:mailboxDataInstSing"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              __type
              "urn:inin.com:ipa:skillDataInstColl"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              __type
              "urn:inin.com:ipa:skillDataInstSing"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              val
              String

              This field contains the string representation of the value to use for this skill data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

              Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

              The string representation of a skill value is simply the name of the skill.

              This property can be null.

              __type
              "urn:inin.com:ipa:stringDataInstColl"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              __type
              "urn:inin.com:ipa:stringDataInstSing"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              val
              String

              This field contains the string representation of the value to use for this string data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

              Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

              The string representation of a string value is simply the string itself.

              This property can be null.

              __type
              "urn:inin.com:ipa:timeDataInstColl"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              __type
              "urn:inin.com:ipa:timeDataInstSing"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              val
              String

              This field contains the string representation of the value to use for this time data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

              Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

              See String Representation of Time Values for more information about how a time value is represented as a string.

              This property can be null.

              __type
              "urn:inin.com:ipa:uriDataInstColl"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              __type
              "urn:inin.com:ipa:uriDataInstSing"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              val
              String

              This field contains the string representation of the value to use for this uri data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

              Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

              The string representation of a URI value is simply the URI itself.

              This property can be null.

              __type
              "urn:inin.com:ipa:userQueueDataInstColl"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              __type
              "urn:inin.com:ipa:userQueueDataInstSing"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              __type
              "urn:inin.com:ipa:workgroupQueueDataInstColl"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              __type
              "urn:inin.com:ipa:workgroupQueueDataInstSing"

              Required

              The JSON type representing this option.
              defId
              String

              This field contains the ID of the data definition from which the object instance is being created.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              id
              String

              This field contains the object instance ID for this object instance.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              name
              String

              This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.

              See the section on id, defId and name fields for more information about when the id, defId and name fields are used.

              This property can be null.

              security
              String

              The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.

              This property can be null.

              val
              String

              This field contains the string representation of the value to use for this workgroup queue data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.

              Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.

              The string representation of a workgroup queue value is simply the name of the workgroup.

              This property can be null.

              sourceId
              String

              Required

              This field indicates the fully scoped GUID that is the ID or the collection that contains the list if items (singleton or complex) from which a selection may be made.

              For example, this could be the ID for a collection of basic or simple types displayed in a single-column grid. Or, it could be the ID of a collection that contains a complex object for each row that is to be displayed in a multi-column grid. Either way, this is the ID of a collection of all of the items, not just the selected items.

              See String Representation of Fully-Scoped GUID for more information about how a fully-scoped GUID is represented as a string.

              destinationId
              String

              Required

              This field indicates the fully scoped GUID that is the ID of the variable that holds the selected item (single select mode), or the ID of the collection that holds the list of selected items (multi-select mode).

              When configured to select "by unique identifier", the variable indicated by this ID will be a string singleton (single-select mode) or string collection (multi-select mode), and only a string representation of the uniqueId(s) of the selected item(s) will be in that variable.

              When configured to select "by data type", the variable indicated by this ID will be a singleton (single-select mode) or collection (multi-select mode) of the same type indicated by the sourceId field, which could be a basic, simple or complex type. And, in this case, a complete copy of each select item is stored in the variable indicated by this destination field; not just the uniqueId(s).

              See String Representation of Fully-Scoped GUID for more information about how a fully-scoped GUID is represented as a string.

              items
              List [Unbounded]: String

              This field holds the list of simple GUIDs that are the IDs of the selected items, regardless of whether configured to select "by data type" or "by unique identifier".

              This field is always a collection regardless of whether single-select mode or mult-select mode is being used. But, at most one item can exist in this list for single-select mode, whereas multiple items can exist in this list for mult-select mode.

              See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.

              This property can be null.

              pageAndDataDefinitions
              Uri

              Required

              This property contains the URL where the page definition and data definitions can be found for the current page of this work item instance. The page and data definitions for the specific revision of the specific page definition of the specific process definition are wrapped into a JSON file at this location.

              __type
              "urn:inin.com:dialer:dataPopMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              Multiple options:

              The value can be assigned any of the following options.
              __type
              "urn:inin.com:dialer:dataPop"

              Required

              The JSON type representing this option.
              interactionId
              String

              Required

              The interaction ID for the call being popped.
              campaignId
              String

              Required

              ID of the campaign associated with the call.
              [key]
              String

              Required

              The key identifying this pair.
              [value]
              String

              Required

              The value of this pair.
              autoDisconnectOnDisposition
              Boolean

              Required

              Specifies if the client application should disconnect the call immediately after it is dispositioned. If true, the client application, agent, or caller must disconnect the call. Dialer does not automatically disconnect.
              allowAgentCallbacks
              Boolean

              Required

              Specifies if this call can be dispositioned as rescheduled for a specific agent.
              preview
              0
              This is a preview call.
              ownAgentCallback_Preview
              1
              This is an agent-owned callback from a preview campaign.
              regular
              2
              This is a regularly dialed call.
              ownAgentCallback
              3
              This is an agent-owned callback from a non-preview campaign.
              agentless
              4
              This is an agentless call.
              precise
              5
              This is a precisely dialed call.
              manual
              6
              This is a manually dialed outbound call.
              __type
              "urn:inin.com:dialer:previewPop"

              Required

              The JSON type representing this option.
              interactionId
              String

              Required

              The interaction ID for the call being popped.
              campaignId
              String

              Required

              ID of the campaign associated with the call.
              [key]
              String

              Required

              The key identifying this pair.
              [value]
              String

              Required

              The value of this pair.
              autoDisconnectOnDisposition
              Boolean

              Required

              Specifies if the client application should disconnect the call immediately after it is dispositioned. If true, the client application, agent, or caller must disconnect the call. Dialer does not automatically disconnect.
              allowAgentCallbacks
              Boolean

              Required

              Specifies if this call can be dispositioned as rescheduled for a specific agent.
              preview
              0
              This is a preview call.
              ownAgentCallback_Preview
              1
              This is an agent-owned callback from a preview campaign.
              callPlaced
              Boolean

              Required

              Indicates whether Dialer has been requested to place the preview call. If true, attempts to call the place-preview-call method fail.
              previewTimeout
              DateTime
              If "Enable preview countdown" is configured for the campaign, the previewTimeout is the IC server time when the preview countdown expires. Compare this time to the server clock time via GET /icws/connection/server-time to account for client/server time drift. The server does not support initiating a preview call after the countdown is reached. If that functionality is required, it must be included in the client application.
              allowSkip
              Boolean

              Required

              Indicates whether the agent is allowed to skip this preview call. To skip a preview call, call the disposition method with a wrapup label of "Skipped - Agent Skip".
              __type
              "urn:inin.com:wfm:dataVersionsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              scheduleVersion
              Int
              The latest version of this user's schedule.
              timeOffRequestVersion
              Int
              The latest version of this user's time off requests.
              notificationVersion
              Int
              The latest version of this user's notification list.
              accrualVersion
              Int
              The latest version of this user's time off accrual.
              availabilityVersion
              Int
              The latest version of time-off availability.
              activityCodesVersion
              Int
              The latest version of activity codes.
              tradeRequestVersion
              Int
              The latest version of shift trades.
              Feature Version
              wfm 4
              __type
              "urn:inin.com:configuration.people:defaultUserMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              createdDate
              DateTime
              The date this configuration object was created.

              This is a read only property and can not be changed with PUT or POST operations.

              This property can be null.

              lastModifiedDate
              DateTime
              The date this configuration object was last modified.

              This is a read only property and can not be changed with PUT or POST operations.

              This property can be null.

              notes
              String
              The notes for this configuration object.

              This property can be null.

              None
              0
              PDF
              1
              PNG
              2
              whisperToneLevel
              Int
              The value must conform to all of these criteria:
              • Is a value from -40 to 0.

              Setting this property to null will set it to its default value.

              Default value: -25

              __type
              "urn:inin.com:configuration.system:dialPlanClassificationsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:directories:directoriesMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              directoriesRemoved
              List [1,*]: String
              The set of directories that have been removed.
              __type
              "urn:inin.com:directories:directoryMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              totalCount
              Int
              This number represents the total number of contacts in the directory. This value will always be greater than, or equal to filteredCount.
              filteredCount
              Int
              This number represents the total number of contacts that match the subscription parameters. This value will always be less than or equal to totalCount.
              contactsRemoved
              List [Unbounded]: String
              The set of directory contact entryIDs that have been removed.
              subscriptionId
              String

              Required

              The subscription's ID.
              __type
              "urn:inin.com:connection:effectiveStationChangeMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              __type
              "urn:inin.com:interactions.email:emailContentsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              interactionId
              String

              Required

              The ID of the interaction this message corresponds to.
              parentInteractionId
              String
              The ID of the parent interaction.
              conversationId
              String
              The ID of the conversation this email belongs to.
              isEditable
              Boolean

              Required

              Indicates whether or not the email can be edited by the current user.
              None
              0
              New
              1
              Reply
              2
              ReplyAll
              3
              Forward
              4
              Reply
              0
              ReplyAll
              1
              Forward
              2
              __type
              "urn:inin.com:interactions.email:emailContentsResponse"

              Required

              The JSON type representing this option.
              subject
              String
              The subject of the email.
              receivedTimestamp
              DateTime

              Required

              The timestamp of when the email was received.
              __type
              "urn:inin.com:interactions.email:emailMessageAttachment"

              Required

              The JSON type representing this option.
              subject
              String

              Required

              The subject of the attached message.
              messageId
              String

              Required

              The identifier used to retrieve the attached message.
              hasResponse
              Boolean
              Whether the email has been responded to. This will only be returned if true.
              Feature Version
              interactions 9
              edited
              Boolean
              Whether the email has been edited. This will only be returned if true.
              Feature Version
              interactions 9
              mailbox
              String
              The email address for the mailbox that contains this email.
              Feature Version
              interactions 9
              mailboxDisplayName
              String
              The display name for the mailbox that contains this email.
              Feature Version
              interactions 9
              hasLoadedExternalContent
              Boolean
              HTML content (typically images) linked from other domains was downloaded and displayed with this email message.
              Feature Version
              interactions 9
              unusedEmailAttachments
              List [Unbounded]: String
              A client controlled list of removed attachment CIDs.
              Feature Version
              interactions 12
              __type
              "urn:inin.com:interactions.email:emailMessageAttachmentMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              requestId
              String

              Required

              interactionId
              String

              Required

              The ID of the interaction this message corresponds to.
              __type
              "urn:inin.com:interactions.email:emailSubscriptionStateMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              none
              0
              There is no subscription.
              normal
              1
              Subscriptions are working as expected. Suspended subscriptions can be resumed, returning them to this state.
              suspended
              2
              Suspended subscriptions have become incapable of sending their associated message. Suspended subscriptions can be resumed, returning them to the normal state.
              faulted
              3
              Faulted subscriptions have encountered a problem they cannot recover from, so they've ended themselves. A subsequent DELETE request, on a faulted subscription, is not necessary, but it cannot be resumed, and will need to be re-made.
              __type
              "urn:inin.com:interactions.email:emailUploadFileStatusMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              requestId
              String

              Required

              interactionId
              String

              Required

              The ID of the interaction this message corresponds to.
              fileName
              String

              Required

              The name of the file being uploaded.
              uploadSuccess
              Boolean

              Required

              Indicates file upload success.
              __type
              "urn:inin.com:unifiedMessaging:faxMessageSubscriptionStateMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              none
              0
              There is no subscription.
              normal
              1
              Subscriptions are working as expected. Suspended subscriptions can be resumed, returning them to this state.
              suspended
              2
              Suspended subscriptions have become incapable of sending their associated message. Suspended subscriptions can be resumed, returning them to the normal state.
              faulted
              3
              Faulted subscriptions have encountered a problem they cannot recover from, so they've ended themselves. A subsequent DELETE request, on a faulted subscription, is not necessary, but it cannot be resumed, and will need to be re-made.
              __type
              "urn:inin.com:unifiedMessaging:faxMessagesMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              __type
              "urn:inin.com:unifiedMessaging:faxMessageAdded"

              Required

              The JSON type representing this option.
              unifiedMessageId
              String

              Required

              The unique identifier for the message.
              unread
              0
              The message has not been read.
              read
              1
              The message has been read.
              dateReceived
              DateTime

              Required

              The date/time stamp the message was received.
              from
              String

              Required

              The party that sent the message.
              subject
              String

              Required

              The subject of the message.
              __type
              "urn:inin.com:unifiedMessaging:faxMessage"

              Required

              The JSON type representing this option.
              unifiedMessageId
              String

              Required

              The unique identifier for the message.
              unread
              0
              The message has not been read.
              read
              1
              The message has been read.
              faxMessagesRemoved
              List [1,*]: String
              The list of fax message IDs removed from a user's inbox.
              __type
              "urn:inin.com:system:handlerSentNotificationMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              objectId
              String

              Required

              The identifier of the object for the notification.

              The value represented by this property should be treated as case-insensitive.

              eventId
              String

              Required

              The identifier of the event for the notification.

              The value represented by this property should be treated as case-insensitive.

              data
              List [Unbounded]: String

              Required

              A list of strings that were provided by the handler which sent the notification.
              __type
              "urn:inin.com:interactions:historyMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              initiationTime
              DateTime
              The time the interaction began.
              None
              0
              Incoming
              1
              Outgoing
              2
              terminationTime
              DateTime
              The time the interaction was disconnected or left the queue.
              interactionId
              String
              The interaction ID of the interaction to which the history data corresponds.
              log
              String
              The log information about the interaction as a string.
              None
              0
              Connected
              1
              Forwarded
              2
              localAddress
              String
              The address of the local party.
              localId
              String
              The displayable address of the local party.
              localName
              String
              The displayable name of the local party.
              notes
              String
              The notes that were added to the interaction.
              remoteAddress
              String
              The address of the remote party.
              remoteId
              String
              The displayable address of the remote party.
              remoteName
              String
              The displayable name of the remote party.
              __type
              "urn:inin.com:configuration.system:imageResourcesMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:interactions:interactionAlertingMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              interactionId
              String

              Required

              The unique identifier of the Interaction that is alerting.
              interactionType
              String

              Required

              The type of Interaction that is alerting. This will be valued with the 'objectType' Interaction attribute value.
              name
              String

              Required

              The name associated to the party that initiated the Interaction.
              address
              String

              Required

              The telephone number, telephone extension, email address, or other such origin of the Interaction.
              None
              0
              User
              1
              Station
              2
              Workgroup
              3
              StationGroup
              4
              AcdUser
              5
              AcdStation
              6
              None
              0
              StartAlerting
              1
              StopAlerting
              2
              autoAnswer
              Boolean

              Required

              Indicates whether the alerting Interaction should be picked up automatically.
              system
              0
              A special Queue that represents interactions on a user's queue or station queue.
              user
              1
              Represents a user's interactions.
              workgroup
              2
              Represents a workgroup's interactions. Interactions passed to a Workgroup queue can be picked up by its member agents.
              station
              3
              Represents a station's interactions.
              queueName
              String

              Required

              The name of the queue being identified.
              [key]
              String

              Required

              The key identifying this pair.
              [value]
              String

              Required

              The value of this pair.
              __type
              "urn:inin.com:interactions:interactionChangedMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              interactionID
              String

              Required

              The interaction's ID.
              [key]
              String

              Required

              The key identifying this pair.
              [value]
              String

              Required

              The value of this pair.
              __type
              "urn:inin.com:interactions:interactionDeallocatedMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              interactionID
              String

              Required

              The interaction's ID.
              __type
              "urn:inin.com:interactions:interactionLostRightsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              interactionID
              String

              Required

              The interaction's ID.
              __type
              "urn:inin.com:interactions:interactionMorphedMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              interactionID
              String

              Required

              The interaction's ID.
              newInteractionID
              String

              Required

              The new interaction ID after the morph.
              __type
              "urn:inin.com:configuration.interactionRecorder:interactionRecorderConfigurationMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              enableSnippetRecordings
              Boolean
              Feature Version
              configuration 11

              This property can be null.

              forceHandsetPlayback
              Boolean

              This property can be null.

              __type
              "urn:inin.com:interactions:interactionRecordingSnippetCreatedMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              interactionID
              String

              Required

              The interaction's ID.
              recordingSnippetId
              String

              Required

              The new snippetRecording Id.
              __type
              "urn:inin.com:dataExtractor:jobStatusMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              name
              String

              Required

              The name of the job.

              submittedUserId
              String

              Required

              The user ID that was used to submit the job.

              id
              String

              Required

              The unique ID associated with the job. This value is set by the server at the time the job is created.

              submittedUserSiteId
              Int

              Required

              The site ID associated with the user who submitted the job.

              submitTime
              DateTime

              The datetime the job was submitted.

              queuedTime
              DateTime

              The datetime the job was queued.

              canceledTime
              DateTime

              The datetime the job was canceled.

              finishedTime
              DateTime

              The datetime the job finished.

              startedTime
              DateTime

              The datetime the job started.

              failedTime
              DateTime

              The datetime the job failed.

              stateChangedTime
              DateTime

              The datetime the job last changed state.

              cancelUserId
              String

              The user ID that cancelled the job.

              outputFolder
              String

              The output path where the extracted files were saved to.

              errorInfo
              String

              Additional error information.

              submitted
              0

              When the job has been submitted.

              queued
              1

              When the job has been queued.

              started
              2

              When the job has been started.

              failed
              3

              If the job failed.

              canceled
              4

              If the job was canceled.

              finished
              5

              When the job has finished.

              __type
              "urn:inin.com:configuration.interactionAnalyzer:keywordSetsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:ipa:launchableProcessesSubscriptionEventArgs"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              removed
              List [Unbounded]: String

              This property contains the list of IDs for the process definitions that were previously launchable by the current user, but are no longer launchable by that user. The process may have been deactivated or deleted, the user may no longer have the appropriate ACLs, etc.

              __type
              "urn:inin.com:configuration.system:layoutsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:licenses:licenseMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              name
              String

              Required

              isAssigned
              Boolean

              Required

              Indicates whether or not the license is assigned to the user. An assigned license has not necessarily been acquired.

              __type
              "urn:inin.com:configuration.system:loginAuthenticationMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              disableAlternateWindowsAuth
              Boolean
              Property to disable the use of Alternate Windows Authentication.

              Setting this property to null will set it to its default value.

              Default value: false

              disableCachedCredentials
              Boolean
              Property to disable the use of cached credentials.

              Setting this property to null will set it to its default value.

              Default value: false

              disableIcAuth
              Boolean
              Property to disable the use of IC Authentication.

              Setting this property to null will set it to its default value.

              Default value: false

              disableSingleSignOn
              Boolean
              Property to disable the use of Single Sign On.

              Setting this property to null will set it to its default value.

              Default value: false

              disableWindowsAuth
              Boolean
              Property to disable the use of Windows Authentication.

              Setting this property to null will set it to its default value.

              Default value: false

              showLegalAgreementUponLogin
              Boolean
              Property to enable or disable showing of the legal agreement during the login process.
              Feature Version
              configuration 12

              Setting this property to null will set it to its default value.

              Default value: false

              __type
              "urn:inin.com:dialer:logoutGrantedMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              name
              String
              The name of the campaign.
              id
              String

              Required

              The ID of the campaign.
              __type
              "urn:inin.com:dialer:manualOutboundCallStatusMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              campaignId
              String

              Required

              Id of the campaign for which manual outbound call was initiated.
              agentId
              String

              Required

              Id of the agent that initiated the manual outbound call.
              identity
              String

              Required

              Dialer Identity of the manual outbound call.
              Unknown
              0
              None
              1
              InvalidCampaign
              2
              InvalidAgent
              3
              InternalError
              4
              AgentNotIdle
              5
              ContactNotFound
              6
              ContactUncallable
              7
              ContactBlocked
              8
              PlaceCallFailed
              9
              InvalidPhoneNumber
              10
              CallBlocked
              11
              CallPlaced
              12
              CallComplete
              13
              PolicyCompleted
              14
              PreviouslyDialed
              15
              filterblocked
              Boolean

              Required

              Contact record was excluded by the campaign filter.
              zoneblocked
              Boolean

              Required

              Contact was zone blocked.
              skillblocked
              Boolean

              Required

              Agent initiating the call does not have the skills necessary.
              dailylimitblocked
              Boolean

              Required

              The number of calls for the contact reached the daily limit.
              minimumspacingblocked
              Boolean

              Required

              Minimum spacing between calls is not satisfied.
              campaignownershipblocked
              Boolean

              Required

              Contact does not belong to the campaign initiating the call.
              donotcallblocked
              Boolean

              Required

              Contact is blocked by Do-Not-Call policy.
              querytimefilterblocked
              Boolean

              Required

              Contact record was excluded by the campaign query time filter.
              previouslydialed
              Boolean

              Required

              A flag indicating the phone number associated with the call has been previously dialed.
              uncallablestatus
              String

              Required

              The status of the record when uncallable.
              __type
              "urn:inin.com:alerts:memoListMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              [key]
              String

              Required

              The identifier for a memo.
              expiration
              DateTime
              The memo's expiration date and time.
              memoTitle
              String
              The title of the memo.
              memoBody
              String
              The body of the memo.
              desktopAlert
              0
              The memo will be displayed as a desktop alert.
              notificationArea
              1
              The memo will be displayed in the client's notification area.
              information
              0
              The information sound that should be played with this memo.
              warning
              1
              The warning sound that should be played with this memo.
              error
              2
              The error sound that should be played with this memo.
              iconUri
              Uri

              The location where the icon file associated with this memo can be downloaded. This URI will be of the form /SessionManagerFileTransfer/alerts/memo/icon/{sessionId}/{memoIconFileName}.

              Memo icon downloads require an active ICWS session as the sessionId. ICO and PNG are the only supported memo icon file formats. The desired file extension (*.ico or *.png respectively) should be appended to the URI prior to the request to control which format is returned. Requests without an extension will assume PNG.

              Requests for PNG memo icons support an optional iconSize parameter to control the size of the returned PNG. For example, to request a 16px by 16px PNG, the URL would end in /memoIconFilename.png?iconSize=16. The default iconSize is 32 without this parameter.

              url
              String
              A URL for the memo. This property is not guaranteed to be a properly-formatted URL string.
              [key]
              String

              Required

              The identifier for a memo.
              expiration
              DateTime
              The memo's expiration date and time.
              memoTitle
              String
              The title of the memo.
              memoBody
              String
              The body of the memo.
              desktopAlert
              0
              The memo will be displayed as a desktop alert.
              notificationArea
              1
              The memo will be displayed in the client's notification area.
              information
              0
              The information sound that should be played with this memo.
              warning
              1
              The warning sound that should be played with this memo.
              error
              2
              The error sound that should be played with this memo.
              iconUri
              Uri

              The location where the icon file associated with this memo can be downloaded. This URI will be of the form /SessionManagerFileTransfer/alerts/memo/icon/{sessionId}/{memoIconFileName}.

              Memo icon downloads require an active ICWS session as the sessionId. ICO and PNG are the only supported memo icon file formats. The desired file extension (*.ico or *.png respectively) should be appended to the URI prior to the request to control which format is returned. Requests without an extension will assume PNG.

              Requests for PNG memo icons support an optional iconSize parameter to control the size of the returned PNG. For example, to request a 16px by 16px PNG, the URL would end in /memoIconFilename.png?iconSize=16. The default iconSize is 32 without this parameter.

              url
              String
              A URL for the memo. This property is not guaranteed to be a properly-formatted URL string.
              removed
              List [Unbounded]: String
              The IDs of memos that have been removed from the user's memo list.
              __type
              "urn:inin.com:unifiedMessaging:mwiMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              messagesWaiting
              Int

              Required

              A count of waiting (unread) messages. When this field is zero there are no waiting messages.
              __type
              "urn:inin.com:unifiedMessaging:mwiSubscriptionStateMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              none
              0
              There is no subscription.
              normal
              1
              Subscriptions are working as expected. Suspended subscriptions can be resumed, returning them to this state.
              suspended
              2
              Suspended subscriptions have become incapable of sending their associated message. Suspended subscriptions can be resumed, returning them to the normal state.
              faulted
              3
              Faulted subscriptions have encountered a problem they cannot recover from, so they've ended themselves. A subsequent DELETE request, on a faulted subscription, is not necessary, but it cannot be resumed, and will need to be re-made.
              __type
              "urn:inin.com:dialer:outboundServerConnectionStateChangeMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              none
              0
              up
              1
              down
              2
              none
              0
              up
              1
              down
              2
              reason
              String

              Required

              A description of the condition that caused the change in connection state.
              __type
              "urn:inin.com:ipa:pasSubscriptionEventArgs"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              none
              0
              running
              1
              shuttingDown
              2
              down
              3
              __type
              "urn:inin.com:configuration.people:passwordPoliciesMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:recordings:pauseScreenRecordingCompletedMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              requestId
              String

              Required

              __type
              "urn:inin.com:configuration.system:positionsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:configuration.system:problemReporterMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              createdDate
              DateTime
              The date this configuration object was created.

              This is a read only property and can not be changed with PUT or POST operations.

              This property can be null.

              lastModifiedDate
              DateTime
              The date this configuration object was last modified.

              This is a read only property and can not be changed with PUT or POST operations.

              This property can be null.

              notes
              String
              The notes for this configuration object.

              This property can be null.

              emailAddresses
              List [Unbounded]: String

              This property can be null.

              Property type documentation:

              Represents a collection of strings.

              __type
              "urn:inin.com:configuration.people:queueColumnsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:queues:queueContentsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String

              Required

              The subscription ID that this message correlates to.
              interactionId
              String

              Required

              The interaction ID of the interaction.
              [key]
              String

              Required

              The key identifying this pair.
              [value]
              String

              Required

              The value of this pair.
              conferenceParentId
              String
              The interaction ID of the parent interaction of the conference containing this interaction.
              interactionId
              String

              Required

              The interaction ID of the interaction.
              [key]
              String

              Required

              The key identifying this pair.
              [value]
              String

              Required

              The value of this pair.
              interactionsRemoved
              List [Unbounded]: String
              The set of interactions that have been removed in the queue.
              __type
              "urn:inin.com:queues:queueSubscriptionStateMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              none
              0
              There is no subscription.
              normal
              1
              Subscriptions are working as expected. Suspended subscriptions can be resumed, returning them to this state.
              suspended
              2
              Suspended subscriptions have become incapable of sending their associated message. Suspended subscriptions can be resumed, returning them to the normal state.
              faulted
              3
              Faulted subscriptions have encountered a problem they cannot recover from, so they've ended themselves. A subsequent DELETE request, on a faulted subscription, is not necessary, but it cannot be resumed, and will need to be re-made.
              subscriptionId
              String

              Required

              The subscription ID that this message correlates to.
              __type
              "urn:inin.com:configuration.hardware:recordingBeepTonesMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:journeymap:relatedInteractionsInfo"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              filteredCount
              Int
              This number represents the total number of interactions that match the subscription parameters.
              subscriptionId
              String

              Required

              The Subscription's Id.
              relatedIntxSearchID
              String

              Required

              This is same as what is provided in subscription parameters. eg. indivId, orgId, locId.
              interactionId
              String

              Required

              The Interaction's Id.
              __type
              "urn:inin.com:journeymap:participant"

              Required

              The JSON type representing this option.
              indivId
              String

              Required

              Participant's indivID.
              displayName
              String
              Participant's display name.
              unknown
              0
              Participant role is unknown.
              initiator
              1
              Participant is an initiator.
              respondant
              2
              Participant is respondant.
              participant
              3
              Other participants.
              orgName
              String
              Individual's organizaion name.
              orgId
              String
              Individual's organizaion Id.
              locationName
              String
              Individual's location name.
              locId
              String
              Individual's organization's location Id.
              wrapUpCode
              String
              Wrap up code for interaction.
              segmentAccountCode
              String
              Interaction's segment account code.
              segmentStartTime
              String
              Segment's start time.
              segmentDuration
              String
              Segment total duration.
              interactionType
              String
              Segment's interaction type eg. Call, Chat, Email, etc.
              noteExists
              Boolean
              Indicate whether notes exist for interaction.
              recordingId
              String
              Interaction's recording Id.
              surveyExist
              Boolean
              Indicate whether survey exist for interaction.
              surveyScore
              Int
              Survey score for this interaction.
              surveyMinScore
              Int
              Minimum survey score for the interaction.
              surveyMaxScore
              Int
              Maximum survey score for the interaction.
              appIncidentId
              String
              Application incident Id.
              __type
              "urn:inin.com:configuration.people:responseManagementDocumentsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:responseManagement:responseManagementMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              librariesRemoved
              List [Unbounded]: Guid
              A list of removed libraries.
              __type
              "urn:inin.com:recordings:resumeScreenRecordingCompletedMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              requestId
              String

              Required

              __type
              "urn:inin.com:configuration.people:rolesMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:configuration.integrations:salesforceCTIConfigurationsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:configuration.people:schedulesMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:configuration.people:secureInputFormsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:configuration.system:serverParametersMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:session:sessionsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              __type
              "urn:inin.com:dialer:setFormDefinitionMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              campaignId
              String

              Required

              Campaign ID for Base Script definition.
              name
              String

              Required

              Name of the Base Script page.
              column
              String

              Required

              Database column linked to control.
              label
              String

              Required

              Label of the Base Script page.
              readOnly
              Boolean

              Required

              Specifies whether control has read-only property set.
              Text
              0
              Numeric
              1
              Radio
              2
              Listbox
              3
              DateTime
              4
              maxLines
              Int
              Maximum lines allowed for the control if applicable.
              maxChars
              Int
              Maximum characters allowed for the control if applicable.
              ShortDate
              1
              LongDate
              2
              Time
              4
              ShortDateWithTime
              5
              LongDateWithTime
              6
              [key]
              String

              Required

              The key identifying this pair.
              [value]
              String

              Required

              The value of this pair.
              label
              String

              Required

              Name of a disposition choice the agent can select from at the end of a call.
              wrapUpCategory
              String

              Required

              The wrap-up category assigned to the call.
              wrapUpCode
              String

              Required

              The wrap-up code assigned to the call.
              abandon
              Boolean

              Required

              Specifies if a call is marked as abandoned.
              recordStatus
              String

              Required

              Record status assigned for this disposition.
              isContact
              Boolean

              Required

              Specifies if this disposition is considered a contact.
              text
              String

              Required

              Static text of the Base Script page.
              stage
              Int
              Stage ID for the Base Script page.
              foregroundColor
              String

              Required

              Foreground color of the Base Script page.
              backgroundColor
              String

              Required

              Background color of the Base Script page.
              allowBreak
              Boolean

              Required

              Specifies whether this base script allows agents to request break.
              allowSkip
              Boolean

              Required

              Specifies whether this base script allows agents to skip calls.
              allowAgentOwned
              Boolean

              Required

              Specifies whether this base script allows agent-owned callbacks.
              militaryTime
              Boolean

              Required

              Specifies whether this base script should use 24-time format.
              pickupCall
              Boolean

              Required

              Specifies whether this base script should automatically pick-up alerting calls.
              allowSchedulePhone
              Boolean

              Required

              Specifies whether this base script allows scheduling.
              autoDisconnect
              Boolean

              Required

              Specifies whether this base script allows auto disconnect on disposition.
              allowEditingOfNumberToDial
              Boolean

              Required

              Specifies whether this base script allows editing of Number to Dial.
              allowAgentsAdditionalCalls
              Boolean

              Required

              Specifies whether this base script allows agents to place Additional Followup calls.
              allowEditingAdditionalCallNumbers
              Boolean

              Required

              Specifies whether this base script allows editing Additional Call Numbers.
              overrideDncBlock
              Boolean

              Required

              Specifies whether this base script allows overriding DNC block for manual calls.
              overrideZoneBlock
              Boolean

              Required

              Specifies whether this base script allows overriding zone block for manual calls.
              overrideSkillsBlock
              Boolean

              Required

              Specifies whether this base script allows overriding skills block for manual calls.
              overrideDailyLimitBlock
              Boolean

              Required

              Specifies whether this base script allows overriding daily limit block for manual calls.
              objectName
              String

              Required

              Object display name.
              extension
              String

              Required

              Extension number.
              objectType
              String

              Required

              Type of the object [Station, User, Workgroup, StationGroup or Attendant].
              __type
              "urn:inin.com:configuration.people:skillCategoriesMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:configuration.people:skillsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:recordings:startScreenRecordingCompletedMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              requestId
              String

              Required

              __type
              "urn:inin.com:recordings:startStationAudioPlaybackCompletedMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              requestId
              String

              Required

              interactionId
              String
              The interaction ID for the station audio playback. This may be null on error.
              __type
              "urn:inin.com:connection:stationConnectionStateChangeMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              __type
              "urn:inin.com:statistics:statisticCatalogMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              statisticCatalogCacheTag
              String
              This tag represents the state of the session user's accessible categories of the statistic catalog. A client can persist the statistic catalog locally along with this cache tag. If a client chooses to do so, it can then send this cache tag in subsequent statistic catalog subscription requests. If the statistic categories which would be returned are the same, the corresponding statistic catalog message will not be sent and the client can use their cached statistic catalog.
              statisticCategoryId
              String

              Required

              The ID of the statistic category.
              displayString
              String

              Required

              A user friendly string for display purposes.
              description
              String

              Required

              A description of the statistic category.
              statisticIdentifier
              String

              Required

              The ID of the statistic definition.
              displayString
              String

              Required

              A user friendly string for display purposes.
              description
              String

              Required

              A description of the statistic definition.
              unitsDisplayString
              String

              Required

              The display string to define the measurement of units.
              orderedParameterTypeList
              List [Unbounded]: String

              Required

              The types of parameters required in a specific order.
              shouldBeSuppressed
              Boolean

              Required

              Gets a value indicating whether this should be suppressed from direct presentation to the user.
              precision
              Int

              Required

              The precision of the data.
              none
              0
              milliseconds
              1
              seconds
              2
              gigabytes
              3
              kilobytes
              4
              percent
              5
              int
              0
              double
              1
              string
              2
              bool
              3
              timeStamp
              4
              timeDuration
              5
              duration
              6
              futureDuration
              7
              finiteDuration
              8
              percent
              9
              statusMessage
              10
              weightedPercent
              11
              error
              12
              suppressInUI
              0
              The statistic should not be displayed in the UI.
              suppressInAlerts
              1
              The statistic should not be used for alerts.
              sortIndex
              Int
              The index used to sort statistics in views.
              expanded
              Boolean
              True if this statistic definition is expanded; otherwise false.
              drillDownId
              String

              Required

              The ID of the drill down.
              typeHint
              String

              Required

              The hint as to what the format is of the drill down data.
              hintString
              String

              Required

              The string that gives a hint as to what this drill down data refers to.
              accessControlRights
              List [Unbounded]: String

              Required

              A list of access rights that the user should have in order to see this catalog.
              licenses
              List [Unbounded]: String

              Required

              A list of the licenses that the user should have in order to see this catalog.
              parameterTypeId
              String

              Required

              The ID of the parameter type.
              displayString
              String

              Required

              A user friendly string for display purposes.
              description
              String

              Required

              The description of the associated parameter type.
              accessControlLists
              List [Unbounded]: String

              Required

              Each of the access control lists returned by this property could be used to fetch parameter values that the Session user is allowed to use. When retrieving available parameter values associated with this ParameterTypeDefinition, the values will be filtered to only include items allowed by these access control lists.
              preserveOrder
              Boolean

              Required

              True if the display order should be preserved; otherwise false.
              __type
              "urn:inin.com:configuration.people:statisticParameterGroupsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:statistics:statisticValueMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              __type
              "urn:inin.com:status:statusMessagesMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              statusMessagesRemoved
              List [Unbounded]: String
              A list of removed status messages.
              __type
              "urn:inin.com:status:statusMessagesUserAccessMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              userId
              String

              Required

              The unique identifier for this user status entry. This is the IC User name.
              statusMessagesAdded
              List [Unbounded]: String

              A list of added status message IDs that the user has rights to.

              The values represented in this property should be treated as case-insensitive.

              statusMessagesRemoved
              List [Unbounded]: String

              A list of status message IDs the user no longer has rights to.

              The values represented in this property should be treated as case-insensitive.

              __type
              "urn:inin.com:configuration.hardware:structuredParametersMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:configuration:systemMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              createdDate
              DateTime
              The date this configuration object was created.

              This is a read only property and can not be changed with PUT or POST operations.

              This property can be null.

              lastModifiedDate
              DateTime
              The date this configuration object was last modified.

              This is a read only property and can not be changed with PUT or POST operations.

              This property can be null.

              notes
              String
              The notes for this configuration object.

              This property can be null.

              __type
              "urn:inin.com:configuration.system:systemParametersMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:activations:userActivationMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String

              Required

              The ID of the watched subscription.
              userId
              String

              Required

              The ID of the user of this activation record.
              [key]
              String

              Required

              The key identifying this pair.
              [value]
              Boolean

              Required

              The value of this pair.
              __type
              "urn:inin.com:status:userStatusMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              userId
              String

              Required

              The unique identifier for this user status to update. This is the IC User name.

              statusId
              String

              Required

              The ID of the status message that the specified user is currently set to.

              The value represented by this property should be treated as case-insensitive.

              notes
              String

              The status message notes set by user.

              forwardNumber
              String

              The forward number set by user.

              onPhone
              Boolean

              This property indicates whether the user is on phone.

              onPhoneChanged
              DateTime

              This property is updated when status on onPhone changes.

              statusChanged
              DateTime

              This property is update when user status changes.

              stations
              List [Unbounded]: String

              The stations on which the user is logged in.

              icServers
              List [Unbounded]: String

              The name of the icServers to which the user is connected to.

              presenceServer
              String

              The name of the server that is providing status for this user.

              loggedIn
              Boolean

              Indicates whether or not the user is logged into a station.

              __type
              "urn:inin.com:status:userStatusPreviousInfoMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              statusId
              String

              Required

              Previous status message identifier defined from StatusMessageList.

              The value represented by this property should be treated as case-insensitive.

              notes
              String

              Required

              Previous status notes.
              forwardNumber
              String
              Previous status forward number.
              __type
              "urn:inin.com:configuration.people:usersMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:unifiedMessaging:voicemailMessageSubscriptionStateMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              none
              0
              There is no subscription.
              normal
              1
              Subscriptions are working as expected. Suspended subscriptions can be resumed, returning them to this state.
              suspended
              2
              Suspended subscriptions have become incapable of sending their associated message. Suspended subscriptions can be resumed, returning them to the normal state.
              faulted
              3
              Faulted subscriptions have encountered a problem they cannot recover from, so they've ended themselves. A subsequent DELETE request, on a faulted subscription, is not necessary, but it cannot be resumed, and will need to be re-made.
              __type
              "urn:inin.com:unifiedMessaging:voicemailMessagesMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              __type
              "urn:inin.com:unifiedMessaging:voicemailMessageAdded"

              Required

              The JSON type representing this option.
              unifiedMessageId
              String

              Required

              The unique identifier for the message.
              unread
              0
              The message has not been read.
              read
              1
              The message has been read.
              dateReceived
              DateTime

              Required

              The date/time stamp the message was received.
              from
              String

              Required

              The party that sent the message.
              subject
              String

              Required

              The subject of the message.
              __type
              "urn:inin.com:unifiedMessaging:voicemailMessage"

              Required

              The JSON type representing this option.
              unifiedMessageId
              String

              Required

              The unique identifier for the message.
              unread
              0
              The message has not been read.
              read
              1
              The message has been read.
              voicemailMessagesRemoved
              List [1,*]: String
              The list of voicemail message IDs removed from a user's inbox.
              __type
              "urn:inin.com:unifiedMessaging:voicemailPlayStatusMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              unifiedMessageId
              String

              Required

              The unique identifier of the voicemail message that the play update refers to.
              playing
              0
              The voicemail is currently playing.
              stopped
              1
              The voicemail has stopped playing.
              __type
              "urn:inin.com:activations:workgroupActivationMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String

              Required

              The ID of the watched subscription.
              workgroupId
              String

              Required

              List of IDs for workgroups that are targets.
              [key]
              String

              Required

              The key identifying this pair.
              [value]
              Boolean

              Required

              The value of this pair.
              __type
              "urn:inin.com:configuration.people:workgroupsMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:configuration.people:wrapUpCategoriesMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String
              __type
              "urn:inin.com:configuration.people:wrapUpCodesMessage"

              Required

              The JSON type representing this option.
              isDelta
              Boolean

              Required

              When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

              When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

              subscriptionId
              String
              The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
              removed
              List [1,*]: String