/icws/{sessionId}/interactions

POST

/icws/{sessionId}/interactions

Creates an interaction. The request will determine what type and other information about the interaction.
Feature Version
interactions 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.

        Representations
        createInteractionParameters
        Property
        Value
        Comments

        Multiple options:

        The value can be assigned any of the following options.
        __type
        "urn:inin.com:interactions:createCallParameters"

        Required

        The JSON type representing this option.
        [key]
        String

        Required

        The key identifying this pair.
        [value]
        String

        Required

        The value of this pair.
        target
        String

        Required

        The target number or queue.
        workgroup
        String
        The workgroup to dial on behalf of.
        None
        0
        Allocated
        1
        Started
        2
        Completed
        3
        accountCodeId
        String

        The account code to associate with the call.

        If account codes are disabled in the Interaction Center System, setting an accountCodeId will have no effect. Any attempt to retrieve the accountCodeId from a subscribed interaction in this case will result in an empty value.

        notes
        String
        The notes to associate with the call.
        __type
        "urn:inin.com:interactions.callback:createCallbackParameters"

        Required

        The JSON type representing this option.
        [key]
        String

        Required

        The key identifying this pair.
        [value]
        String

        Required

        The value of this pair.
        target
        String

        Required

        The target for this callback.
        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.
        name
        String
        The name of the person who created this callback.
        subject
        String

        Required

        A message that describes the reason for this callback.
        __type
        "urn:inin.com:interactions.callback:createCallbackResponseCallParameters"

        Required

        The JSON type representing this option.
        [key]
        String

        Required

        The key identifying this pair.
        [value]
        String

        Required

        The value of this pair.
        parentInteractionId
        String

        Required

        The interaction ID of the parent callback for this response.
        target
        String

        Required

        The target number or queue.
        workgroup
        String
        The workgroup to dial on behalf of.
        None
        0
        Allocated
        1
        Started
        2
        Completed
        3
        accountCodeId
        String
        The account code to associate with the call.
        __type
        "urn:inin.com:interactions.chat:createChatParameters"

        Required

        The JSON type representing this option.
        [key]
        String

        Required

        The key identifying this pair.
        [value]
        String

        Required

        The value of this pair.
        target
        String

        Required

        The target user of the interaction.
        __type
        "urn:inin.com:interactions.email:createEmailParameters"

        Required

        The JSON type representing this option.
        [key]
        String

        Required

        The key identifying this pair.
        [value]
        String

        Required

        The value of this pair.
        __type
        "urn:inin.com:interactions.email:emailContent"

        Required

        The JSON type representing this option.
        subject
        String
        The subject of the email.
        displayName
        String

        Required

        The display name for the email address.
        address
        String
        The email address.
        body
        String

        Required

        An email body.
        Text
        0
        Html
        1
        workgroup
        String
        The workgroup to send the email on behalf of. When sending an email on behalf of a workgroup, the emailContent.sender.address for the email must be one of the outbound mailboxes configured for the workgroup.
        __type
        "urn:inin.com:interactions.email:createEmailResponseParameters"

        Required

        The JSON type representing this option.
        [key]
        String

        Required

        The key identifying this pair.
        [value]
        String

        Required

        The value of this pair.
        __type
        "urn:inin.com:interactions.email:emailResponseContent"

        Required

        The JSON type representing this option.
        subject
        String
        The subject of the email.
        None
        0
        None of the parent email's attachments will be included in this response email.
        Inline
        1
        Only the inline attachments, those attachments that have an associated content-ID, will be included from the parent email's attachments as part of this response email.
        All
        2
        All of the parent email's attachments will be included as part of this response email.
        Reply
        0
        ReplyAll
        1
        Forward
        2
        parentInteractionId
        String

        Required

        The ID of the interaction being responded to.
        workgroup
        String
        The workgroup to send the email on behalf of. When sending an email on behalf of a workgroup, the emailContent.sender.address for the email must be one of the outbound mailboxes configured for the workgroup.
        __type
        "urn:inin.com:interactions:createGenericInteractionParameters"

        Required

        The JSON type representing this option.
        [key]
        String

        Required

        The key identifying this pair.
        [value]
        String

        Required

        The value of this pair.
        None
        0
        Alerting
        1
        Connected
        2
        Held
        3
        Messaging
        4
        Offering
        5
        Parked
        6
        Proceeding
        7
        Suspended
        8
        System
        9
        InternalDisconnect
        10
        ExternalDisconnect
        11
        None
        0
        Incoming
        1
        Outgoing
        2
        None
        0
        Internal
        1
        External
        2
        localLocation
        String
        The local location.
        None
        0
        Internal
        1
        External
        2
        remoteId
        String
        The remote ID.
        remoteName
        String
        The remote name.

        Response

        201 - Created
        The interaction was created successfully.
        Parameters
        Type
        Name
        Comments
        Header
        Location

        Required

        A URL specifying where a representation of the interaction can be found.

          interactionCreated
          Property
          Value
          Comments
          interactionId
          String

          Required

          The created interaction's ID.
          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 Responses

          Error Identifier
          Error Type
          Error Description
          error.request.unsupported
          Type: urn:inin.com:common:error

          A response email cannot be created if the current session does not have an active subscription to the parent email.

          Feature Version
          interactions 10
          Type documentation:
          The request is not supported. There is either a problem with the request or it is unknown.
          error.request.interactions.invalidOutboundMailboxConfiguration
          Type: urn:inin.com:common:error
          The mailbox for the ACD workgroup queue is not configured for outbound email.
          Feature Version
          interactions 15
          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.