Expand All Collapse All

/icws/{sessionId}/messaging/subscriptions/interaction-history

Feature Version
interactions 4

PUT

/icws/{sessionId}/messaging/subscriptions/interaction-history

Creates or updates a subscription to interaction history.

NOTE: interaction history is only supported for calls.

Feature Version
interactions 4

Request

Parameters
Type
Name
Comments
Header
ININ-ICWS-CSRF-Token

Required

The ININ session token 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.

      Template
      sessionId

      Required

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

        Representations
        historySubscriptionParameters
        Expand AllCollapse All
        Property
        Value
        Comments
        numberOfHistoryMessages
        Int
        The number of interactions to send. If no number is specified, then all interactions are sent.

        Response

        204 - No Content
        The interaction history subscription has been updated.
        Associated Message
        The interaction history subscription has changed.
        historyMessage
        The interaction history subscription has changes.
        Expand AllCollapse All
        Property
        Value
        Comments
        __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.
        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.
        Expand AllCollapse All
        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.
          Expand AllCollapse All
          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.
          Expand AllCollapse All
          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.
          Expand AllCollapse All
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.

          DELETE

          /icws/{sessionId}/messaging/subscriptions/interaction-history

          Removes a subscription to interaction history.
          Feature Version
          interactions 4

          Request

          Parameters
          Type
          Name
          Comments
          Header
          ININ-ICWS-CSRF-Token

          Required

          The ININ session token 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.

              Template
              sessionId

              Required

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

                Response

                204 - No Content
                The interaction history subscription has been deleted.
                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.
                Expand AllCollapse All
                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.
                  Expand AllCollapse All
                  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.
                  Expand AllCollapse All
                  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.
                  Expand AllCollapse All
                  Property
                  Value
                  Comments
                  errorId
                  String
                  The error identifier that describes the current error.
                  message
                  String

                  Required

                  A message that describes the current error.