Expand All Collapse All

/icws/{sessionId}/recordings/{recordingId}/media-details

Feature Version
recordings 6

GET

/icws/{sessionId}/recordings/{recordingId}/media-details

Request media details for a recording.

Feature Version
recordings 6

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.

        Template
        recordingId

        Required

        The ID of the recording being viewed/edited.

          Response

          200 - OK
          Media details are included in the response.
          getMediaDetailsResponse
          Expand AllCollapse All
          Property
          Value
          Comments
          recordingId
          String
          Recording Id.

          This property can be null.

          relatedRecordingId
          String
          Related recording Id for this recording.

          This property can be null.

          expirationDate
          DateTime
          ExpirationDate Date for this recording.

          This property can be null.

          recordingDate
          DateTime

          Required

          Recording Date for this recording.
          interactionId
          String

          Required

          Interaction Id for this recording.
          initiationPolicyName
          String
          Initiation Policy Name used for this recording.

          This property can be null.

          lineName
          String
          Call Line Name.

          This property can be null.

          snippetInitiator
          String
          Snippet Initiated by (Display Name).

          This property can be null.

          unknown
          0
          external
          1
          intercom
          2
          conference
          3
          isArchived
          Double
          True if this recording is Archived.

          This property can be null.

          duration
          Double
          Recording Length.

          This property can be null.

          unknown
          0
          inbound
          1
          outbound
          2
          intercom
          3
          unknown
          0
          policyRelated
          1
          snippetRecording
          2
          numAttachments
          Double
          Number of attachments, if this is email recording.

          This property can be null.

          unknown
          0
          call
          1
          chat
          2
          chatTranscript
          3
          email
          4
          screen
          5
          socialConversation
          6
          socialDirectMessage
          7
          isEncrypted
          Boolean
          True if this recording is Encrypted.

          This property can be null.

          initiatorInteractionAddress
          String
          Initiator Interaction Address for this recording.

          This property can be null.

          interactionAddress
          String
          Interaction Address for this recording.

          This property can be null.

          screenRecordedHostName
          String
          Screen Recorded Host Name for this recording.

          This property can be null.

          fileSize
          Double
          File Size.

          This property can be null.

          customerKeywordScorePositive
          Double
          Customer Keyword Score Negative.

          This property can be null.

          customerKeywordScoreNegative
          Double
          Customer Keyword Score Negative.

          This property can be null.

          agentKeywordScorePositive
          Double
          Agent Keyword Score Positive.

          This property can be null.

          agentKeywordScoreNegative
          Double
          Agent Keyword Score Negative.

          This property can be null.

          403 - Forbidden
          The user is not authorized to access the recording.
          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.
          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.