Expand All Collapse All

/icws/{sessionId}/status/status-messages

GET

/icws/{sessionId}/status/status-messages

Retrieves status messages.

Note

This retrieves all status messages defined in Interaction Center. This allows clients to retreive status messages only once (instead of them being embedded in each user status payload, for example). It is very important, however, that clients retrieve a user's access to status messages in order to present the user with accessible statuses.

Feature Version
status 1

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.

        Response

        200 - OK
        The status messages are included in the entity body.
        statusMessages
        Expand AllCollapse All
        Property
        Value
        Comments
        statusId
        String

        Required

        The ID of the status message. Used to refer to or set the status message.

        The value represented by this property should be treated as case-insensitive.

        messageText
        String

        Required

        Localized message text when displaying this status. Appears in list of selectable statuses.
        iconUri
        Uri

        Required

        The icon associated with this status message.
        groupTag
        String

        Required

        The group this status belongs to for reporting. A Status Group is a name that loosely categorizes a status message for reporting purposes. When a new status is defined in Interaction Administrator using the System Configuration < Status Messages container, it is mapped to a Status Group for reporting purposes.
        canHaveDate
        Boolean

        Required

        Indicates whether this status can have an ending date.
        canHaveTime
        Boolean

        Required

        Indicates whether this status can have an ending time.
        isDoNotDisturbStatus
        Boolean

        Required

        Indicates whether this status is a do not disturb status.
        isSelectableStatus
        Boolean

        Required

        Indicates whether this status is selectable by an agent.
        isPersistentStatus
        Boolean

        Required

        Indicates whether this status can persist when the agent logs out of IC.
        isForwardStatus
        Boolean

        Required

        Indicates whether this status is a forwarding status.
        isAfterCallWorkStatus
        Boolean

        Required

        Indicates whether this status requires after call work (ACW). Indicates that an agent is in "Follow Up" mode (IsAllowFollowUpStatus) after an ACD call.
        isAcdStatus
        Boolean

        Required

        Indicates whether an agent is available to receive ACD calls.
        isAllowFollowUpStatus
        Boolean

        Required

        Indicates that an agent's status can change to "Follow Up" after an ACD call terminates.
        systemId
        String

        Required

        An unique numeric identifier for this status message.
        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.