Detailed Description

Mask activity

Overview

This API allows user to mask the content of an activity. Only one activity can be masked at a time. Please note that this API will be successful even if masking is not enabled or no masking patterns are configured for the corresponding activity type.
For this API to execute successfully: An activity with the ID specified in the request body must exist. The activity must be of type Email or Chat. The activity must not be locked. If activity is of type 'Chat', it must be in completed state.
As part of completing this API request:

For activity of type 'Email', below attributes will be masked:
- Subject
- Content
- Text content
- Email Header
For activity of type 'Chat', below attributes will be masked:
- Subject
- Chat transcript
- Survey answers

Since: 12.0 ES1

APIs

Method	URL	Description
PUT	`/ws/v19/interaction/activity/mask`	Mask the content of an activity.

Authentication

Authentication is required. The client must be logged in to call this API. Each API request must contain X-egain-session request header returned by Login API.

Permissions

All of the following are required:

User must have 'Edit' action on 'Activity' resource or 'Manage Utilities' action on 'Utilities' resource.
The activity must either belong to the user's home department, or to a department in which the user is a foreign user.

Licenses

The logged in user must have the following licenses:

ECE MailPlus: To mask the content of activity of type 'Email'.
ECE ChatPlus: To mask the content of activity of type 'Chat'.

Request

Request headers

Name	Description	Allowed values	Default value
X-egain-session	Session ID obtained from Login API response header	N/A	N/A
Accept	Content type accepted by client.	`application/xml` or `application/json`	N/A
Content-Type	Media type sent by the client	`application/xml` or `application/json`	N/A
Accept-Language	Language locale accepted by client (used for locale specific fields in resource representation and in error responses)	Supported 'Accept-Language' header codes	`default system language`

Request Body

The request body is mandatory. Request body can be in either XML or JSON format.

Elements required in the request body

Name	Description
id	ID of the Activity.
lastModified.date	Value of last Modified date of the activity.

Optional elements allowed in the request body

None

Request body XML schemas:

v19-schema-interaction-activity-Activity

Supported API specific query parameters

None

Supported common query parameters

None

Response

Response headers

Name	Description	Possible values
X-egain-session	ID of the current user session	N/A
Content-Type	Media type of response body	`application/xml` or `application/json`

Response body XML schemas:

v19-schema-kb-WSError - used in case of error

HTTP status codes

Success Status codes

204 - No Content

Successfully modified the activity.

Failure Status codes

400 - Bad Request

Any query parameter is sent in the request.
Request body does not contain the required elements.
Unsupported element is present in the request body.
Any criteria for successful execution mentioned in the Overview or Request Body sections are violated.
Request body is empty.

401 - Unauthorized

X-egain-session request header is missing.
Session is invalid or expired.

403 - Forbidden

If the user does not have the appropriate permissions for this operation. Refer the Permissions section.

406 - Not Acceptable

Invalid 'Accept-Language' header value.

409 - Conflict

The lastModified date of the activity in the request does not match its lastModified date on the server.

500 - Internal server error

Examples:

Example 1 - Mask activity of type 'Email'
Example 2 - Mask activity of type 'Chat'