Expand All Collapse All

/icws/{sessionId}/interactions/{interactionId}/record-snippet

The recording snippet feature allows interaction recordings to be taken, stored on the IC Server, and then processed by recorder policies that have been configured.
Feature Version
interactions 13

POST

/icws/{sessionId}/interactions/{interactionId}/record-snippet

Starts/Stops a recording snippet that can be included in Interaction Recorder. If an interaction subscription (started via PUT /icws/{sessionId}/messaging/subscriptions/interactions/{interactionId}) has been started prior to making a call to stop a recording snippet, then a message containing a interactionRecordingSnippetCreatedMessage data contract will be available from GET /icws/{sessionId}/messaging/messages so that applications are aware of when a recording snippet was created.
Feature Version
interactions 13

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
        interactionId

        Required

        The interaction ID for the interaction resource.

          Representations
          recordSnippetParameters
          Feature Version
          interactions 10
          Expand AllCollapse All
          Property
          Value
          Comments
          on
          Boolean

          Required

          Either starts or stops a snippet of an interaction that can be used with Interaction Recorder.
          supervisor
          Boolean

          Required

          Indicates that a supervisor is creating the snippet on behalf of an agent.

          Response

          200 - OK
          The action was successfully performed.
          404 - Not Found
          The interaction does not exist.
          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.
          403 - Forbidden
          You do not have rights to the interaction.
          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.