| Feature | Version | |
|---|---|---|
| interactions | 10 |
| Feature | Version | |
|---|---|---|
| interactions | 10 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.Required
The interaction ID for the interaction resource.Required
The messageId of the message to retrieve.Required
The ID associated with the asynchronous operation request. This can be used to correlate future events and operations.Required
The JSON type representing this option.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.
Required
Required
This property can be null.
Property type documentation:
Provides additional detail for an error.
Required
A message that describes the current error.Required
The ID of the interaction this message corresponds to.Required
The content of the email.Required
The JSON type representing this option.Required
The subject of the email.Required
The sender's email address.Required
The display name for the email address.Required
The email bodies.Required
An email body.Required
The type of the email body.Required
The timestamp of when the email was received.| Feature | Version | |
|---|---|---|
| interactions | 9 |
Required Bit Flags
The status of the signature.Property type documentation:
The email signature validation status provided by Interaction Center.
Required
The certificate used for the signature.Required
The version of the certificate.Required
The serial number of the certificate.Required
The algorithm used for the signature of the certificate.Required
The issuer of the certificate.Required
The start of the period for which the certificate is valid.Required
The end of the period for which the certificate is valid.Required
The subject of the certificate.Required
The JSON type representing this option.Required
The name of the file.Required
The Content-ID of the file, which conforms to RFC 2111.Required
The location where the file can be downloaded.By default, when GETing the file, ICWS will respond with the 'Content-Type' header set to the proper content type of the file.
When making a request from a web browser, it may be desirable to force the file to be downloaded. In this case the query string '?action=download' should be added to the end of a file's downloadUri. This will force the response header 'Content-Type' to be set to 'application/octet-stream' and will add the header 'Content-Disposition' set to 'attachment'.
Recursive
The email's message attachments. Note: These will be the actual attached messages instead of just the subject and associated retrieval messageId as they are with an emailContentsResponse.Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.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"
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.