Expand All Collapse All

/icws/{sessionId}/recordings/send-as-email

PUT

/icws/{sessionId}/recordings/send-as-email

Creates and sends an email based on the specified list of recordings. For each recording within the list, the associated recording media will be exported and included as attachments on the email.
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.

        Representations
        recordingsEmailParameters
        Send recordings by email parameters.
        Expand AllCollapse All
        Property
        Value
        Comments
        recordingIds
        List [Unbounded]: String

        Required

        A list of recording IDs.
        displayName
        String

        Required

        The displayable participant name.
        address
        String

        Required

        The email address of the participant.
        replyToAddress
        String

        Required

        A single TO reply email address.
        emailSubject
        String

        Required

        The subject of the email to send.
        emailBody
        String

        Required

        The body of the email to send.
        priority
        Int

        Required

        The numerical priority of the email to send: 1-Normal, 2-Low, 4-High. Other values will default to Normal.

        Response

        204 - No Content
        The email has been sent.
        403 - Forbidden
        The user is not authorized to use recordings management.
        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.