Expand All Collapse All

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

POST

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

Sends a chat message from the participant.
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.

    Representations
    chatSendMessageRequest
    An object representing a request to send a web chat message.
    Expand AllCollapse All
    Property
    Value
    Comments
    message
    String

    Required

    The content of the chat message.

    contentType
    String

    Required

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

    Response

    204 - No Content
    The message was sent successfully.
    400 - Bad Request
    This may indicate that the request was malformed.

    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.