/icws/{sessionId}/unified-messaging/{unifiedMessageId}/voicemail-message/play/stop

POST

/icws/{sessionId}/unified-messaging/{unifiedMessageId}/voicemail-message/play/stop

Stops a play operation on a target end point. This will generate a new message on the voicemail messages subscription.

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.

        Template
        unifiedMessageId

        Required

        The Unified messsage Id.

          Response

          204 - No Content
          The request for stop operation was successful.
          400 - Bad Request
          The stop operation is not allowed on a unified-message of this type.

          Error Responses

          Error Identifier
          Error Type
          Error Description
          error.request.invalidRepresentation.missingRequiredParameter
          Type: urn:inin.com:common:missingPropertyError
          A required parameter was not present.
          error.request.invalidRepresentation.invalidProperty
          Type: urn:inin.com:common:invalidPropertyError
          The request representation object contained an invalid property.
          error.request.invalidRepresentation.malformed
          Type: urn:inin.com:common:error
          The request representation object was malformed.
          error
          Provides additional detail for an error.
          Property
          Value
          Comments

          Multiple options:

          The value can be assigned any of the following options.
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          __type
          "urn:inin.com:common:invalidPropertyError"

          Required

          The JSON type representing this option.
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          propertyName
          String
          The name of the invalid, required property.
          __type
          "urn:inin.com:common:missingPropertyError"

          Required

          The JSON type representing this option.
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          propertyName
          String
          The name of the missing required property.
          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.