Expand All Collapse All

/icws/web-chat/file/{participantId}/{fileGuid}/{fileName}

GET

/icws/web-chat/file/{participantId}/{fileGuid}/{fileName}

Gets a file from the chat session.
Feature Version
web-chat 1

Request

Parameters
Type
Name
Comments
Template
participantId

Required

The participant ID of the participant which the request is being made on behalf of.

    Template
    fileGuid

    Required

    The globally unique identifier (GUID) associated with the file to be retrieved.

      Template
      fileName

      Required

      The file name associated with the file to be retrieved.

        Response

        200 - OK
        The file was retrieved successfully. The response will include the file. The Content-Type header will be set as application/octet-stream.
        400 - Bad Request
        This may indicate that the file was not able to be retrieved.

        Error Responses

        Error Identifier
        Error Type
        Error Description
        error.request.webChat.invalidParticipantId
        Type: urn:inin.com:common:error
        The request failed because the participant ID is unkown 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.
        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.