Expand All Collapse All

/icws/{sessionId}/interactions/{interactionId}/email/attachments/file/upload

Feature Version
interactions 10

POST

/icws/{sessionId}/interactions/{interactionId}/email/attachments/file/upload

Prepares for a file attachment to be uploaded to the server.
Feature Version
interactions 10

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
          emailUploadFileAttachmentRequest
          Expand AllCollapse All
          Property
          Value
          Comments
          uploadFileName
          String

          Required

          The name of the file.
          isInlineAttachment
          Boolean

          Required

          If true the file is an inline attachment and a Content-ID will be auto generated. If false the Content-ID will be an empty string.

          Response

          202 - Accepted
          Preparing server for file upload.
          emailUploadFileAttachmentResponse
          Expand AllCollapse All
          Property
          Value
          Comments
          __type
          "urn:inin.com:interactions.email:emailUploadFileAttachmentResponse"

          Required

          The JSON type representing this option.
          requestId
          String

          Required

          The ID associated with the asynchronous operation request. This can be used to correlate future events and operations.
          interactionId
          String

          Required

          The ID of the interaction this message corresponds to.
          fileName
          String

          Required

          The name of the file being uploaded.
          contentId
          String
          The Content-ID if this is an inline attachment; otherwise empty string.

          A non-null, non-empty Content-ID is generated for a inline attachment. Inline attachments conform to RFC 2111, and appear within the body of an email if a Content-ID is provided and the HTML email body includes an element associated to a valid URL using the cid: URL scheme.

          uploadUri
          Uri

          Required

          The location where the file can be uploaded.

          By default, when PUTing the file, ICWS will respond with the 'Content-Type' header set to the proper content type of the file.

          Associated Message
          The requested attached file content along with a URI specifying where to upload the attachment.
          emailUploadFileStatusMessage
          Expand AllCollapse All
          Property
          Value
          Comments
          __type
          "urn:inin.com:interactions.email:emailUploadFileStatusMessage"

          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.

          requestId
          String

          Required

          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          interactionId
          String

          Required

          The ID of the interaction this message corresponds to.
          fileName
          String

          Required

          The name of the file being uploaded.
          uploadSuccess
          Boolean

          Required

          Indicates file upload success.
          400 - Bad Request
          The request was invalid. This can occur when the interaction or cookie is not recognized, or if the interaction is not an email interaction. 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.
          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.
          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.