Expand All Collapse All

/icws/{sessionId}/recordings/{recordingId}/export-uri

GET

/icws/{sessionId}/recordings/{recordingId}/export-uri

Request the export URI for a recording.

If HTTPS playback, archiving, and exporting is enabled in Recorder's configuration, the HTTPS URI will be returned; otherwise, the HTTP URI will be returned.

Feature Version
recordings 2

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.

          Query
          attachmentId

          The ID of a recorded email attachment, ranging from 1...n. Only valid when the recording is an email with an attachment.

            Response

            200 - OK
            The export URI is included in the response.
            getExportUriResponse
            Expand AllCollapse All
            Property
            Value
            Comments
            uri
            String

            Required

            The export URI for the specified recording.
            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.