Expand All Collapse All

/icws/{sessionId}/messaging/subscriptions/unified-messaging/fax-messages

PUT

/icws/{sessionId}/messaging/subscriptions/unified-messaging/fax-messages

Creates or updates a subscription to all fax messages accessible to this session and user.
Feature Version
unified-messaging 2

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 subscription was created or updated successfully.
        Associated Message
        A user's list of current fax messages.
        faxMessagesMessage
        A message object that contains added, changed, and removed fax messages for an authenticated user.
        Expand AllCollapse All
        Property
        Value
        Comments
        __type
        "urn:inin.com:unifiedMessaging:faxMessagesMessage"

        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.

        __type
        "urn:inin.com:unifiedMessaging:faxMessageAdded"

        Required

        The JSON type representing this option.
        unifiedMessageId
        String

        Required

        The unique identifier for the message.
        unread
        0
        The message has not been read.
        read
        1
        The message has been read.
        dateReceived
        DateTime

        Required

        The date/time stamp the message was received.
        from
        String

        Required

        The party that sent the message.
        subject
        String

        Required

        The subject of the message.
        fileUri
        Uri

        Required

        The URI to access the message file.
        fileName
        String

        Required

        The message file name.
        mimeType
        String
        The mime type of the attachment fileUri.
        __type
        "urn:inin.com:unifiedMessaging:faxMessage"

        Required

        The JSON type representing this option.
        unifiedMessageId
        String

        Required

        The unique identifier for the message.
        unread
        0
        The message has not been read.
        read
        1
        The message has been read.
        faxMessagesRemoved
        List [1,*]: String
        The list of fax message IDs removed from a user's inbox.
        Associated Message
        The state of the fax subscription has changed.

        There are cases where the server needs to update the consumer about the status of the subscription. For example, if a user mailbox is removed then unified messaging operation can no longer function. The server will send a faulted message, remove the subscription and clear any associated unified messages from its cache.

        faxMessageSubscriptionStateMessage
        Expand AllCollapse All
        Property
        Value
        Comments
        __type
        "urn:inin.com:unifiedMessaging:faxMessageSubscriptionStateMessage"

        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.
        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.

          DELETE

          /icws/{sessionId}/messaging/subscriptions/unified-messaging/fax-messages

          Delete a subscription to a user's fax messages.
          Feature Version
          unified-messaging 2

          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

                204 - No Content
                The subscription was successfully deleted.
                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.