/icws/{sessionId}/messaging/subscriptions/queues/{subscriptionId}

PUT

/icws/{sessionId}/messaging/subscriptions/queues/{subscriptionId}

Creates or updates a subscription to an interaction queue.

Note

If the entire contents of an Interaction Queue is to be watched, Queue watches are more efficient than having individual Interaction watches on each Interaction in the Queue.

Feature Version
queues 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.

        Template
        subscriptionId

        Required

        The ID for this subscription. This can be used to correlate future events and operations.

          Representations
          queueSubscriptionParameters
          Property
          Value
          Comments
          system
          0
          A special Queue that represents interactions on a user's queue or station queue.
          user
          1
          Represents a user's interactions.
          workgroup
          2
          Represents a workgroup's interactions. Interactions passed to a Workgroup queue can be picked up by its member agents.
          station
          3
          Represents a station's interactions.
          queueName
          String

          Required

          The name of the queue being identified.
          attributeNames
          List [1,*]: String

          Required

          The set of attribute names for this subscription. These can be standard CIC attribute names or custom attribute names to support custom handlers / integrations.

          Note

          For information about the standard attributes defined by the Interaction Center System, see the "Interaction Attributes Technical Reference" in the Interaction Center Documentation Library. This document describes the attributes and the format of their values.

          Response

          200 - OK
          The subscription for this interaction queue has been updated.
          Associated Message
          The contents of the interaction queue have changed.
          queueContentsMessage
          Represents the content changes on an Interaction Queue.
          Property
          Value
          Comments
          __type
          "urn:inin.com:queues:queueContentsMessage"

          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.

          subscriptionId
          String

          Required

          The subscription ID that this message correlates to.
          interactionId
          String

          Required

          The interaction ID of the interaction.
          [key]
          String

          Required

          The key identifying this pair.
          [value]
          String

          Required

          The value of this pair.
          conferenceParentId
          String
          The interaction ID of the parent interaction of the conference containing this interaction.
          interactionId
          String

          Required

          The interaction ID of the interaction.
          [key]
          String

          Required

          The key identifying this pair.
          [value]
          String

          Required

          The value of this pair.
          interactionsRemoved
          List [Unbounded]: String
          The set of interactions that have been removed in the queue.
          Associated Message

          The interaction was replaced by another (e.g. during a consult transfer). This message will only be generated for the session creating a consult transfer or other sessions that are subscribed to queues that contain the associated interactions.

          The isDelta property will always be false for these messages.

          interactionMorphedMessage
          Property
          Value
          Comments
          __type
          "urn:inin.com:interactions:interactionMorphedMessage"

          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.

          interactionID
          String

          Required

          The interaction's ID.
          newInteractionID
          String

          Required

          The new interaction ID after the morph.
          Associated Message
          The state of the interaction queue has changed.
          Feature Version
          queues 2
          queueSubscriptionStateMessage
          Feature Version
          queues 2
          Property
          Value
          Comments
          __type
          "urn:inin.com:queues:queueSubscriptionStateMessage"

          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.

          none
          0
          There is no subscription.
          normal
          1
          Subscriptions are working as expected. Suspended subscriptions can be resumed, returning them to this state.
          suspended
          2
          Suspended subscriptions have become incapable of sending their associated message. Suspended subscriptions can be resumed, returning them to the normal state.
          faulted
          3
          Faulted subscriptions have encountered a problem they cannot recover from, so they've ended themselves. A subsequent DELETE request, on a faulted subscription, is not necessary, but it cannot be resumed, and will need to be re-made.
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          subscriptionId
          String

          Required

          The subscription ID that this message correlates to.
          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.
          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.
            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.

            DELETE

            /icws/{sessionId}/messaging/subscriptions/queues/{subscriptionId}

            Removes the interaction queue subscription.
            Feature Version
            queues 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.

                  Template
                  subscriptionId

                  Required

                  The ID for this subscription. This can be used to correlate future events and operations.

                    Response

                    204 - No Content
                    The interaction queue subscription has been removed.
                    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.
                    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.
                      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.