/icws/web-chat/message-history/{participantId}

Feature Version
web-chat 6

GET

/icws/web-chat/message-history/{participantId}

Retrieves all web chat message representations from the server.
Feature Version
web-chat 6

Request

Parameters
Type
Name
Comments
Template
participantId

Required

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

    Response

    200 - OK
    A request to get web chat messages from the server succeeded. The messages representation is available in the entity body.
    chatGetAllMessagesResponse
    An object representing a response to a web chat messages request.
    Property
    Value
    Comments

    Multiple options:

    The value can be assigned any of the following options.
    __type
    "urn:inin.com:webChat:chatFileMessage"

    Required

    The JSON type representing this option.
    participantId
    String

    Required

    The participant ID associated with the message.
    sequenceNumber
    Int

    Required

    The sequence number of the message in the context of the chat session.
    timestamp
    String

    Required

    The UTC timestamp representing when the event occurred.
    fileGuid
    String

    Required

    The ID of the file.
    fileName
    String

    Required

    The name of the file.
    fileSize
    Int

    Required

    The size of the file, in bytes.
    __type
    "urn:inin.com:webChat:chatParticipantStateChangedMessage"

    Required

    The JSON type representing this option.
    participantId
    String

    Required

    The participant ID associated with the message.
    sequenceNumber
    Int

    Required

    The sequence number of the message in the context of the chat session.
    timestamp
    String

    Required

    The UTC timestamp representing when the event occurred.
    initializing
    0
    The participant is in the process of connecting to the chat session.
    alerting
    1
    The participant is being alerted about the chat session.
    active
    2
    The participant is active within the chat session.
    held
    3
    The participant is on hold.
    disconnected
    4
    The participant is disconnected from the chat session.
    displayName
    String

    Required

    The display name of the user that sent the message.
    participantType
    String

    Required

    The type of user that sent the message. This will either be Agent, WebUser or System.
    __type
    "urn:inin.com:webChat:chatTextMessage"

    Required

    The JSON type representing this option.
    participantId
    String

    Required

    The participant ID associated with the message.
    sequenceNumber
    Int

    Required

    The sequence number of the message in the context of the chat session.
    timestamp
    String

    Required

    The UTC timestamp representing when the event occurred.
    contentType
    String

    Required

    The content type of the chat message. This will either be "text/plain" or "text/html".
    value
    String

    Required

    The value of the message that was sent.
    __type
    "urn:inin.com:webChat:chatTypingIndicatorMessage"

    Required

    The JSON type representing this option.
    participantId
    String

    Required

    The participant ID associated with the message.
    sequenceNumber
    Int

    Required

    The sequence number of the message in the context of the chat session.
    timestamp
    String

    Required

    The UTC timestamp representing when the event occurred.
    value
    Boolean

    Required

    Indicates whether the user started or stopped typing. A value of true indicates that typing started. A value of false indicates that typing stopped.
    400 - Bad Request
    Invalid parameter value was specified; the participant ID was not valid.

    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.
    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.
    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.
    Property
    Value
    Comments
    errorId
    String
    The error identifier that describes the current error.
    message
    String

    Required

    A message that describes the current error.