Expand All Collapse All

/icws/{sessionId}/interactions/email/resolve-address

Feature Version
interactions 10

POST

/icws/{sessionId}/interactions/email/resolve-address

Queries for any email addresses that match the request parameters.
Feature Version
interactions 10

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
        emailResolveAddressParameters
        Expand AllCollapse All
        Property
        Value
        Comments
        name
        String

        Required

        The name to resolve email addresses for.
        maxResults
        Int
        The maximum number of results to return in the associated message. The default is to return all matches.

        Response

        200 - OK
        The query was successfully performed, and any matching addresses are in the response, up to the maximum.
        emailResolvedAddresses
        Expand AllCollapse All
        Property
        Value
        Comments
        name
        String
        The name associated with this email contact.
        address
        String

        Required

        The address of this email contact.
        400 - Bad Request
        The request was invalid. This can occur when the message body is malformed or missing required items, or if the interaction is not an email interaction. 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.
        504 - Gateway Timeout
        A timeout occurred while querying for email addresses.

        Error Responses

        Error Identifier
        Error Type
        Error Description
        error.request.timeout
        Type: urn:inin.com:common:error
        The request timed out.
        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.