Application APIs

1. Overview

Create an Application

Retrieve an Application

Update an Application

Delete an Application

2. Create an Application

This API is used to create a new application. A CleanSpeak application defines a content source and the filter rules for that content source.

2.1. Request

Create an Application with an automatically generated Id

URI

POST /system/application

Create an Application with the provided Id

URI

POST /system/application/{applicationId}

Table 1. Request Parameters

applicationId [UUID] Optional

The Id of the Application to create. If this parameter is omitted an Id will be generated automatically.

Table 2. Request Body

application [Object] Required

The Application object.

application.moderationConfiguration.approvalCheckOutMinutes [Integer] Optional defaults to 10

The number of minutes content is checked out for in the Approval Queue before it is automatically released to be eligible for another moderator to check out.

application.moderationConfiguration.approvalQueueSize [Integer] Optional defaults to 30

The number of items checked out of the Approval Queue at a time for a moderator.

application.moderationConfiguration.archiveConfiguration [Object] Optional

The archive configuration object.

application.moderationConfiguration.archiveConfiguration.enabled [Boolean] Optional defaults to false

Setting this value to true enables content deletion. This is false by default which means no content is deleted. If you’ll be sending in high volumes of content content deletion should be enabled. CleanSpeak is not designed to store content indefinitely.

application.moderationConfiguration.archiveConfiguration.storeDuration [Integer] Required

The number of units content should be kept. The unit value is determined by the storeTimeUnit.

application.moderationConfiguration.archiveConfiguration.storeOffsetDuration [Integer] Required

The number of units to be added to the storeDuration. The offset unit is determined by the storeOffsetTimeUnit.

application.moderationConfiguration.archiveConfiguration.storeOffsetTimeUnit [String] Required

The time unit for the offset. The possible values are:

  • minutes

  • hours

  • days

  • months

  • years

application.moderationConfiguration.archiveConfiguration.storeTimeUnit [String] Required

The time unit for the duration. The possible values are:

  • minutes

  • hours

  • days

  • months

  • years

application.moderationConfiguration.contentAlertCheckOutMinutes [Integer] Optional defaults to 10

The number of minutes content is checked out for in the Alert Queue before it is automatically released to be eligible for another moderator to check out.

application.moderationConfiguration.contentAlertQueueSize [Integer] Optional defaults to 30

The number of items checked out of the Alert Queue at a time for a moderator.

application.moderationConfiguration.contentDeletable [Boolean] Optional defaults to false

Set to true if you want the ability to delete content. Enabling this feature allows a moderator to delete content which in turn sends a notification of type contentDelete to be consumed by the CleanSpeak event handler.

application.moderationConfiguration.contentEditable [Boolean] Optional defaults to false

Set to true if you want the ability to edit content. Enabling this feature allows a moderator to edit content which in turn sends a notification of type contentEdit to be consumed by the CleanSpeak event handler.

application.moderationConfiguration.contentFlagAlertType [String] Optional defaults to User

By default when content is flagged a User alert is generated. Setting this to Content changes the behavior such that a Content alert is sent instead. The possible values are:

  • Content

  • User

application.moderationConfiguration.contentFlagUserScoreAdjustment [Integer] Optional

The amount the User score is adjusted when content is flagged. This value may be a positive or negative integer.

application.moderationConfiguration.contentUserActionsEnabled [Boolean] Optional defaults to false

Set to true if you want user actions enabled. Enable this if you intend to allow moderators to action users, for example mute, ban, kick users. When disabled you will not be able to select this application as a target for a user action.

application.moderationConfiguration.defaultActionIsQueueForApproval [Boolean] Optional defaults to false

Set to true if you want content to be queued for approval when no filter rules are hit. This includes content that matched a rule set to allow.

For example, when this parameter is set to true and the content

  • did not match any filter rules, do queue for approval.

  • did not match any filter rules, but the moderate request parameter for moderation is set to generateAlert or generatesContentAlert, do not queue for approval.

  • did match one or more filters with an action other than allow, do not queue for approval.

This feature may be used way to ensure all content is reviewed in some fashion by a moderator.

application.moderationConfiguration.dictionaryTags [Array<String>] Optional Available since 3.12.0

A list of dictionary tags to apply to moderation actions using this application.

Tags will cause the filter to throw out matches that exactly match dictionary words with any of the tags in this list.

application.moderationConfiguration.emailFilterMaxLength [Integer] Optional defaults to 50

This parameter specifies the maximum length that a match can be in order to be considered an email. If the match length is greater than the maximum match length the match will be ignored.

application.moderationConfiguration.emailFilterSpacePenalty [Double] Optional defaults to -0.05

This parameter specifies a penalty applied to the quality score if the match contains any spaces. For example, user@ example.com contains a space so the space penalty value will be added to the quality score. The email space penalty is applied once regardless of the number of spaces found in the match.

application.moderationConfiguration.emailOnAlerts [Boolean] Optional defaults to false

Set this parameter to true to email moderators for content alerts.

application.moderationConfiguration.emailOnContentFlagged [Boolean] Optional defaults to false

Set this parameter to true to email moderators when content is flagged.

application.moderationConfiguration.emailOnUserFlagged [Boolean] Optional defaults to false

Set this parameter to true to email moderators when users are flagged.

application.moderationConfiguration.emailRules [Array] Optional

The email filter rules. You must supply exactly three rules. Each rule must provide a score value which is the inclusive cutoff score for an email match. The rules correspond to a High, Medium and Low quality filter rule. In the Management Interface these rules are referenced as High, Medium and Low.

For example, the following are the default email rules:

{
  "emailRules": [
    {
      "score": 90,
      "action": "allow"
    },
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 40,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.emailRules[x].action [String] Required

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.emailRules[x].alertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.emailRules[x].score [Integer] Required

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.emailRules[x].userScoreAdjustment [Integer] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules [Array] Optional

The list of blacklist filter rules.

application.moderationConfiguration.filterRules[x].tags [Array<String>] Required

The blacklist tags for this filter rule. A filter rule may have one or more tags.

application.moderationConfiguration.filterRules[x].locales [Array<String>] Optional

The match locales. If this parameter is omitted the filter rule will apply to all locales. See Locales.

application.moderationConfiguration.filterRules[x].mildAction [String] Required

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].mildAlertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].mildUserScoreAdjustment [String] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules[x].mediumAction [String] Required

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].mediumAlertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].mediumUserScoreAdjustment [String] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules[x].highAction [String] Required

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].highAlertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].highUserScoreAdjustment [String] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules[x].severeAction [String] Required

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].severeAlertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].severeUserScoreAdjustment [String] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.ignorableCharacters [String] Optional Defaults to "qxz" Available since 3.22.0

Set this parameter to a list of characters the filter can skip over to find a match. Only the letters a through z are permitted.

Specifically, this feature will catch any blacklist word even if separated by a single character on this list. Example: SxMxUxRxF Note: only the same letter may be used to separate the characters throughout the word and only one ignored character in a row is permitted.

application.moderationConfiguration.imageConfiguration [Object] Optional

The image moderation configuration object. This parameter and all nested parameters are only valid when imageOnly is set to true.

application.moderationConfiguration.imageConfiguration.commitDelay [Integer] Optional defaults to 45

The number of seconds to wait before a moderation decision made from the enhanced image moderation queue is committed.

application.moderationConfiguration.imageConfiguration.darkMode [Boolean] Optional defaults to true

Set this parameter to 'false' to disable the dark mode theme when viewing the enhanced image moderation queue.

application.moderationConfiguration.imageConfiguration.defaultTimerDuration [Integer] Optional defaults to 2

The number of seconds each image will be displayed in the queue before advancing to the next image when the queue is set to automatically advance without keyboard interaction. This value is the default value for this application for all moderators. A moderator may change this value for their own user preference.

application.moderationConfiguration.imageConfiguration.speedModerationLayout [Boolean] Optional defaults to true

Set this parameter to false to disable the enhanced image moderation queue layout and use the legacy mode.

application.moderationConfiguration.imageOnly [Boolean] Optional defaults to false

Set this parameter to true to enable this application for image only moderation. When this parameter is set to true the imageConfiguration parameters are used to provide additional configuration.

application.moderationConfiguration.imageFilteringEnabled [Integer] Optinoal

Set to true if you want to enable third party image filtering. (The provider and credentials must be configured in the system configuration first!)

application.moderationConfiguration.imageQualityFilterRules [Array] Optional

A list of 3 quality filter rules corresponding to high, medium, and low quality.

For example, the following are the default imageQualityFilterRules:

{
  "imageQualityFilterRules": [
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 30,
      "action": "allow"
    },
    {
      "score": 0,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.imageQualityFilterRules[x].action [String] Required

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.imageQualityFilterRules[x].alertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.imageQualityFilterRules[x].score [Integer] Required

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.imageQualityFilterRules[x].userScoreAdjustment [Integer] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.maximumVideoFilterDurationInSeconds [Integer] Optional defaults to 300

The maximum amount of time a video filter request is allowed to take in seconds.

application.moderationConfiguration.noRuleUserScoreAdjustment [Integer] Optional

This score adjustment is used when the content did not match any rules. This value may be a positive or negative integer.

This may be used to increase a user score based upon good behavior, i.e. sending in content that did not contain any profanity. In this use case, you would provide a positive value for the adjustment.

This adjustment will only affect the user score while it is below 0. Once the user score is raised to 0 this adjustment will be ignored.

application.moderationConfiguration.persistent [Boolean] Optional defaults to false

Set this parameter to true to indicate the content type is persistent, false indicates this content is transient.

Persistent content is defined as content that is likely displayed indefinitely. A user can go and look at this content in the future by browsing a forum or performing a content search. Examples of persistent content include forum posts, profile pictures, etc. Persist content can be edited, deleted and pre-approved.

Transient content is defined as content that is displayed for a short period of time and then is likely gone forever. Transient content is usually synonymous with chat. This content cannot be pre-approved, edited or deleted.

Please note that both transient and persistent content in this context are persisted to the database.

application.moderationConfiguration.phoneNumberFilterMaxLength [Integer] Optional defaults to 20

This parameter specifies the maximum length that a match can be in order to be considered an phone number. If the match length is greater than the maximum match length the match will be ignored.

application.moderationConfiguration.phoneNumberFilterMinLength [Integer] Optional defaults to 7

This parameter specifies the minimum length that a match can be in order to be considered a phone number. The default value covers most world wide phone number formats.

application.moderationConfiguration.phoneNumberFilterSeparatorPenalty [Double] Optional defaults to -0.02

This parameter specifies a penalty that is applied to the quality score for a match if it contains any type of separator other than a dash or parenthesis. For example, 303;555;1234 contains two penalized separators so the separator penalty will be multiplied by the number of separators and added to the quality score.

application.moderationConfiguration.phoneNumberFilterSpacePenalty [Double] Optional defaults to -0.02

This parameter specifies a penalty that is applied to the quality score for a match if it contains one or more spaces. For example, 303 555 1234 contains two spaces so the space penalty will be multiplied by the number of spaces and added to the quality score.

application.moderationConfiguration.phoneNumberFilterWordPenalty [Double] Optional defaults to -0.03

This parameter specifies a penalty that is applied to the quality score for a match if it contains any words rather than digits. For example, three zero three 555 1234 contains three words so the word penalty will be multiplied by the number of words and added to the quality score.

application.moderationConfiguration.phoneNumberRules [Array] Optional

The phone number filter rules. You must supply exactly three rules. Each rule must provide a score value which is the inclusive cutoff score for a phone number match. The rules correspond to a High, Medium and Low quality filter rule. In the Management Interface these rules are referenced as High, Medium and Low.

For example, the following are the default phone number rules:

{
  "phoneNumberRules": [
    {
      "score": 90,
      "action": "allow"
    },
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 40,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.phoneNumberRules[x].action [String] Required

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.phoneNumberRules[x].alertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.phoneNumberRules[x].score [Integer] Required

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.phoneNumberRules[x].userScoreAdjustment [Integer] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.queuePersistentContent [Boolean] Optional defaults to false

Set this to true in order to asynchronously store persistent content. This may improve performance but there is a potential for data loss if an outage occurs before all content is committed to the database. Please consult with Inversoft Support if you are unsure how to use this feature.

application.moderationConfiguration.replacementCharacter [String] Optional

The character used during match replacement. If this value is set it will take precedence over replacementString.

application.moderationConfiguration.replacementString [String] Optional

The string used during match replacement. If neither replacementString or replacementCharacter are defined the default replacement character * will be utilized.

application.moderationConfiguration.returnFilterMatches [Boolean] Optional defaults to false Available since 3.9.1

Set this parameter to true in order to receive filter matches in the Moderate Content API response.

application.moderationConfiguration.rules [Object] Optional

The rules object. This object contains the Username Filter and Whitelist Filter rules.

application.moderationConfiguration.storeContent [Boolean] Optional defaults to false

Set this parameter to true in order to store content in the database. In order to take advantage of many of the advanced CleanSpeak moderation features you’ll need to store content.

application.moderationConfiguration.unicodeFilterRule.action [String] Optional defaults to allow Available since 3.22.0

The filter action for the unicode filter. Allowed options are allow or reject.

The unicode filter rejects content if it contains prohibited unicode ranges.

application.moderationConfiguration.unicodeFilterRule.data [String] Optional defaults to a provided config Available since 3.22.0

The unicode filter configuration represented as a dsl of ranges.

The ranges are described as a string of lines that may contain * Empty lines * Comments (a line starting with #) * Unicode ranges (A unicode codepoint is of the form \u0000 or \u{0} (Json unicode notation)) Ex: \u0000-\u{F}

A special condition is that the final unicode range may be an open range meaning the second unicode point is omitted.

Note: The ranges are inclusive so \u0000-\u000F includes the character \u000F

Note 2: The provided config may change between versions.

application.moderationConfiguration.urlFilterMaxLength [Integer] Optional defaults to 50

This parameter specifies the maximum length that a match can be in order to be considered a url. If the match length is greater than the maximum match length the match will be ignored.

application.moderationConfiguration.urlFilterSpacePenalty [Double] Optional defaults to -0.05

This parameter specifies a penalty that is applied to the quality score for a match if it contains one or more spaces. For example, www .ex a m ple .com contains spaces so the space penalty will added to the quality score.

application.moderationConfiguration.urlRules [Array] Optional

The url filter rules. You must supply exactly three rules. Each rule must provide a score value which is the inclusive cutoff score for a url match. The rules correspond to a High, Medium and Low quality filter rule. In the Management Interface these rules are referenced as High, Medium and Low.

For example, the following are the default url rules:

{
  "urlRules": [
    {
      "score": 90,
      "action": "allow"
    },
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 40,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.urlRules[x].action [String] Required

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.urlRules[x].alertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.urlRules[x].score [Integer] Required

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest url filter rule score the rule will be applied.

application.moderationConfiguration.urlRules[x].userScoreAdjustment [Integer] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.userCheckOutMinutes [Integer] Optional defaults to 10

The number of minutes a Content User is checked out for before it is automatically released to be eligible for another moderator to check out.

application.moderationConfiguration.userFlagUserScoreAdjustment [Integer] Optional

The amount the User score is adjusted when the user is flagged. This value may be a positive or negative integer.

application.moderationConfiguration.videoFilteringEnabled [Integer] Optinoal

Set to true if you want to enable third party video filtering. (The provider and credentials must be configured in the system configuration first!)

application.moderationConfiguration.videoQualityFilterRules [Array] Optional

A list of 3 quality filter rules corresponding to high, medium, and low quality.

For example, the following are the default videoQualityFilterRules:

{
  "videoQualityFilterRules": [
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 30,
      "action": "allow"
    },
    {
      "score": 0,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.videoQualityFilterRules[x].action [String] Required

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.videoQualityFilterRules[x].alertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.videoQualityFilterRules[x].score [Integer] Required

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.videoQualityFilterRules[x].userScoreAdjustment [Integer] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

applicaiton.notificationServers [Array] Optional

A list of notification servers to use on an application. (This will create new notification servers every time)

Note: In the frontend, Notification Servers are now called Webhooks.

(See Handling Notifications for more details)

applicaiton.notificationServers[x].connectTimeout [Integer] Optional Defaults to 1000

The maximum amount of time a server will take to try to connect in milliseconds.

application.notificationServers[x].readTimeout [Integer] Optional Defaults to 2000

The maximum amount of time any read call will wait for data to flow.

application.notificationServers[x].httpAuthenticationPassword [String] Optional

A password to supply on the notification request.

application.notificationServers[x].httpAuthenticationUsername [String] Optional

A username to supply on the notification request.

applicaiton.notificationServers[x].sslCertificate [String] Optional

An ssl client certificate to present on the notification request.

application.notificationServers[x].url [String] required

The url of a server listening for notifications.

Example Request JSON
{
  "application": {
    "moderationConfiguration": {
      "approvalCheckOutMinutes": 10,
      "approvalQueueSize": 30,
      "archiveConfiguration": {
        "deleteOnly": true,
        "enabled": false
      },
      "contentAlertCheckOutMinutes": 10,
      "contentAlertQueueSize": 30,
      "contentDeletable": true,
      "contentEditable": true,
      "contentFlagAlertType": "User",
      "contentUserActionsEnabled": true,
      "ignorableCharacters": "qxz",
      "imageConfiguration": {
        "commitDelay": 45,
        "darkMode": true,
        "defaultTimerDuration": 2.0,
        "speedModerationLayout": true
      },
      "imageOnly": false,
      "imageFilteringEnabled": false,
      "imageQualityFilterRules": [
        {
          "action": "allow",
          "score": 70
        },
        {
          "action": "allow",
          "score": 30
        },
        {
          "action": "allow",
          "score": 0
        }
      ],
      "maximumVideoFilterDurationInSeconds": 300,
      "videoFilteringEnabled": false,
      "videoQualityFilterRules": [
        {
          "action": "allow",
          "score": 70
        },
        {
          "action": "allow",
          "score": 30
        },
        {
          "action": "allow",
          "score": 0
        }
      ],
      "defaultActionIsQueueForApproval": false,
      "dictionaryTags": [],
      "emailOnAlerts": false,
      "emailOnContentFlagged": false,
      "emailOnEscalations": false,
      "emailOnUserFlagged": false,
      "emailRules": [
        {
          "action": "allow",
          "score": 90
        },
        {
          "score": 70,
          "action": "allow"
        },
        {
          "score": 40,
          "action": "allow"
        }
      ],
      "filterRules": [
        {
          "highAction": "authorOnly",
          "highAlertType": "User",
          "locales": [],
          "mediumAction": "allow",
          "mildAction": "allow",
          "severeAction": "reject",
          "severeAlertType": "User",
          "tags": [
            "Vulgarity"
          ]
        },
        {
          "highAction": "allow",
          "highAlertType": "User",
          "locales": [
            "en"
          ],
          "mediumAction": "allow",
          "mildAction": "allow",
          "severeAction": "authorOnly",
          "severeAlertType": "User",
          "tags": [
            "Bullying"
          ]
        }
      ],
      "persistent": true,
      "phoneNumberRules": [
        {
          "action": "allow",
          "score": 90,
          "userScoreAdjustment": -10
        },
        {
          "alertType": "Content",
          "userScoreAdjustment": -5,
          "score": 70,
          "action": "allow"
        },
        {
          "score": 40,
          "alertType": "User",
          "userScoreAdjustment": -1,
          "action": "allow"
        }
      ],
      "queuePersistentContent": false,
      "returnFilterMatches": false,
      "rules": {
        "usernameFilterRule": {
          "action": "reject",
          "enabled": false
        },
        "whitelistFilterRules": {
          "disallowedPhrase": {},
          "disallowedWord": {}
        }
      },
      "storeContent": true,
      "urlRules": [],
      "userCheckOutMinutes": 10
    },
    "name": "Chat",
    "notificationServers": [
      {
        "connectTimeout": 1000,
        "readTimeout": 2000,
        "url": "http://chat.example.com/notification-handler",
        "id": 20
      }
    ]
  }
}

2.2. Response

Table 3. Response Codes
Code Description

200

The request was successful. The response will contain a JSON body.

400

The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors.

401

You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

402

Your license has expired. The response will be empty. Contact sales@inversoft.com for assistance.

500

There was an internal error. A stack trace is provided and logged in the CleanSpeak log files. The response will be empty.

Table 4. Response Body

application [Object]

The Application object.

application.id [UUID]

The Id of the Application.

application.moderationConfiguration.approvalCheckOutMinutes [Integer]

The number of minutes content is checked out for in the Approval Queue before it is automatically released to be eligible for another moderator to check out.

application.moderationConfiguration.approvalQueueSize [Integer]

The number of items checked out of the Approval Queue at a time for a moderator.

application.moderationConfiguration.archiveConfiguration [Object]

The archive configuration object.

application.moderationConfiguration.archiveConfiguration.enabled [Boolean]

Setting this value to true enables content deletion. This is false by default which means no content is deleted. If you’ll be sending in high volumes of content content deletion should be enabled. CleanSpeak is not designed to store content indefinitely.

application.moderationConfiguration.archiveConfiguration.storeDuration [Integer]

The number of units content should be kept. The unit value is determined by the storeTimeUnit.

application.moderationConfiguration.archiveConfiguration.storeOffsetDuration [Integer]

The number of units to be added to the storeDuration. The offset unit is determined by the storeOffsetTimeUnit.

application.moderationConfiguration.archiveConfiguration.storeOffsetTimeUnit [String]

The time unit for the offset. The possible values are:

  • minutes

  • hours

  • days

  • months

  • years

application.moderationConfiguration.archiveConfiguration.storeTimeUnit [String]

The time unit for the duration. The possible values are:

  • minutes

  • hours

  • days

  • months

  • years

application.moderationConfiguration.contentAlertCheckOutMinutes [Integer]

The number of minutes content is checked out for in the Alert Queue before it is automatically released to be eligible for another moderator to check out.

application.moderationConfiguration.contentAlertQueueSize [Integer]

The number of items checked out of the Alert Queue at a time for a moderator.

application.moderationConfiguration.contentDeletable [Boolean]

Set to true if you want the ability to delete content. Enabling this feature allows a moderator to delete content which in turn sends a notification of type contentDelete to be consumed by the CleanSpeak event handler.

application.moderationConfiguration.contentEditable [Boolean]

Set to true if you want the ability to edit content. Enabling this feature allows a moderator to edit content which in turn sends a notification of type contentEdit to be consumed by the CleanSpeak event handler.

application.moderationConfiguration.contentFlagAlertType [String]

By default when content is flagged a User alert is generated. Setting this to Content changes the behavior such that a Content alert is sent instead. The possible values are:

  • Content

  • User

application.moderationConfiguration.contentFlagUserScoreAdjustment [Integer]

The amount the User score is adjusted when content is flagged. This value may be a positive or negative integer.

application.moderationConfiguration.contentUserActionsEnabled [Boolean]

Set to true if you want user actions enabled. Enable this if you intend to allow moderators to action users, for example mute, ban, kick users. When disabled you will not be able to select this application as a target for a user action.

application.moderationConfiguration.defaultActionIsQueueForApproval [Boolean]

Set to true if you want content to be queued for approval when no filter rules are hit. This includes content that matched a rule set to allow.

For example, when this parameter is set to true and the content

  • did not match any filter rules, do queue for approval.

  • did not match any filter rules, but the moderate request parameter for moderation is set to generateAlert or generatesContentAlert, do not queue for approval.

  • did match one or more filters with an action other than allow, do not queue for approval.

This feature may be used way to ensure all content is reviewed in some fashion by a moderator.

application.moderationConfiguration.dictionaryTags [Array<String>] Available since 3.12.0

A list of dictionary tags to apply to moderation actions using this application.

Tags will cause the filter to throw out matches that exactly match dictionary words with any of the tags in this list.

application.moderationConfiguration.emailFilterMaxLength [Integer]

This parameter specifies the maximum length that a match can be in order to be considered an email. If the match length is greater than the maximum match length the match will be ignored.

application.moderationConfiguration.emailFilterSpacePenalty [Double]

This parameter specifies a penalty applied to the quality score if the match contains any spaces. For example, user@ example.com contains a space so the space penalty value will be added to the quality score. The email space penalty is applied once regardless of the number of spaces found in the match.

application.moderationConfiguration.emailOnAlerts [Boolean]

Set this parameter to true to email moderators for content alerts.

application.moderationConfiguration.emailOnContentFlagged [Boolean]

Set this parameter to true to email moderators when content is flagged.

application.moderationConfiguration.emailOnUserFlagged [Boolean]

Set this parameter to true to email moderators when users are flagged.

application.moderationConfiguration.emailRules [Array]

The email filter rules. You must supply exactly three rules. Each rule must provide a score value which is the inclusive cutoff score for an email match. The rules correspond to a High, Medium and Low quality filter rule. In the Management Interface these rules are referenced as High, Medium and Low.

For example, the following are the default email rules:

{
  "emailRules": [
    {
      "score": 90,
      "action": "allow"
    },
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 40,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.emailRules[x].action [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.emailRules[x].alertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.emailRules[x].score [Integer]

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.emailRules[x].userScoreAdjustment [Integer]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules [Array]

The list of blacklist filter rules.

application.moderationConfiguration.filterRules[x].tags [Array<String>]

The blacklist tags for this filter rule. A filter rule may have one or more tags.

application.moderationConfiguration.filterRules[x].locales [Array<String>]

The match locales. If this parameter is omitted the filter rule will apply to all locales. See Locales.

application.moderationConfiguration.filterRules[x].mildAction [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].mildAlertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].mildUserScoreAdjustment [String]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules[x].mediumAction [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].mediumAlertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].mediumUserScoreAdjustment [String]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules[x].highAction [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].highAlertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].highUserScoreAdjustment [String]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules[x].severeAction [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].severeAlertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].severeUserScoreAdjustment [String]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.ignorableCharacters [String] Available since 3.22.0

The list list of characters the filter can skip over to find a match.

Specifically, this feature will catch any blacklist word even if separated by a single character on this list. Example: SxMxUxRxF Note: only the same letter may be used to separate the characters throughout the word and only one ignored character in a row is permitted.

application.moderationConfiguration.imageConfiguration [Object]

The image moderation configuration object. This parameter and all nested parameters are only valid when imageOnly is set to true.

application.moderationConfiguration.imageConfiguration.commitDelay [Integer]

The number of seconds to wait before a moderation decision made from the enhanced image moderation queue is committed.

application.moderationConfiguration.imageConfiguration.darkMode [Boolean]

Set this parameter to 'false' to disable the dark mode theme when viewing the enhanced image moderation queue.

application.moderationConfiguration.imageConfiguration.defaultTimerDuration [Integer]

The number of seconds each image will be displayed in the queue before advancing to the next image when the queue is set to automatically advance without keyboard interaction. This value is the default value for this application for all moderators. A moderator may change this value for their own user preference.

application.moderationConfiguration.imageConfiguration.speedModerationLayout [Boolean]

Set this parameter to false to disable the enhanced image moderation queue layout and use the legacy mode.

application.moderationConfiguration.imageOnly [Boolean]

Set this parameter to true to enable this application for image only moderation. When this parameter is set to true the imageConfiguration parameters are used to provide additional configuration.

application.moderationConfiguration.imageFilteringEnabled [Integer] Optinoal

Set to true if you want to enable third party image filtering. (The provider and credentials must be configured in the system configuration first!)

application.moderationConfiguration.imageQualityFilterRules [Array] Optional

A list of 3 quality filter rules corresponding to high, medium, and low quality.

For example, the following are the default imageQualityFilterRules:

{
  "imageQualityFilterRules": [
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 30,
      "action": "allow"
    },
    {
      "score": 0,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.imageQualityFilterRules[x].action [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.imageQualityFilterRules[x].alertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.imageQualityFilterRules[x].score [Integer]

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.imageQualityFilterRules[x].userScoreAdjustment [Integer] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.maximumVideoFilterDurationInSeconds [Integer] Optional defaults to 300

The maximum amount of time a video filter request is allowed to take in seconds.

application.moderationConfiguration.noRuleUserScoreAdjustment [Integer]

This score adjustment is used when the content did not match any rules. This value may be a positive or negative integer.

This may be used to increase a user score based upon good behavior, i.e. sending in content that did not contain any profanity. In this use case, you would provide a positive value for the adjustment.

This adjustment will only affect the user score while it is below 0. Once the user score is raised to 0 this adjustment will be ignored.

application.moderationConfiguration.persistent [Boolean]

Set this parameter to true to indicate the content type is persistent, false indicates this content is transient.

Persistent content is defined as content that is likely displayed indefinitely. A user can go and look at this content in the future by browsing a forum or performing a content search. Examples of persistent content include forum posts, profile pictures, etc. Persist content can be edited, deleted and pre-approved.

Transient content is defined as content that is displayed for a short period of time and then is likely gone forever. Transient content is usually synonymous with chat. This content cannot be pre-approved, edited or deleted.

Please note that both transient and persistent content in this context are persisted to the database.

application.moderationConfiguration.phoneNumberFilterMaxLength [Integer]

This parameter specifies the maximum length that a match can be in order to be considered an phone number. If the match length is greater than the maximum match length the match will be ignored.

application.moderationConfiguration.phoneNumberFilterMinLength [Integer]

This parameter specifies the minimum length that a match can be in order to be considered a phone number. The default value covers most world wide phone number formats.

application.moderationConfiguration.phoneNumberFilterSeparatorPenalty [Double]

This parameter specifies a penalty that is applied to the quality score for a match if it contains any type of separator other than a dash or parenthesis. For example, 303;555;1234 contains two penalized separators so the separator penalty will be multiplied by the number of separators and added to the quality score.

application.moderationConfiguration.phoneNumberFilterSpacePenalty [Double]

This parameter specifies a penalty that is applied to the quality score for a match if it contains one or more spaces. For example, 303 555 1234 contains two spaces so the space penalty will be multiplied by the number of spaces and added to the quality score.

application.moderationConfiguration.phoneNumberFilterWordPenalty [Double]

This parameter specifies a penalty that is applied to the quality score for a match if it contains any words rather than digits. For example, three zero three 555 1234 contains three words so the word penalty will be multiplied by the number of words and added to the quality score.

application.moderationConfiguration.phoneNumberRules [Array]

The phone number filter rules. You must supply exactly three rules. Each rule must provide a score value which is the inclusive cutoff score for a phone number match. The rules correspond to a High, Medium and Low quality filter rule. In the Management Interface these rules are referenced as High, Medium and Low.

For example, the following are the default phone number rules:

{
  "phoneNumberRules": [
    {
      "score": 90,
      "action": "allow"
    },
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 40,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.phoneNumberRules[x].action [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.phoneNumberRules[x].alertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.phoneNumberRules[x].score [Integer]

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.phoneNumberRules[x].userScoreAdjustment [Integer]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.queuePersistentContent [Boolean]

Set this to true in order to asynchronously store persistent content. This may improve performance but there is a potential for data loss if an outage occurs before all content is committed to the database. Please consult with Inversoft Support if you are unsure how to use this feature.

application.moderationConfiguration.replacementCharacter [String]

The character used during match replacement. If this value is set it will take precedence over replacementString.

application.moderationConfiguration.replacementString [String]

The string used during match replacement. If neither replacementString or replacementCharacter are defined the default replacement character * will be utilized.

application.moderationConfiguration.returnFilterMatches [Boolean] Available since 3.9.1

This parameter specifies if filter matches will be returned in the Moderate Content API response.

application.moderationConfiguration.rules [Object]

The rules object. This object contains the Username Filter and Whitelist Filter rules.

application.moderationConfiguration.storeContent [Boolean]

Set this parameter to true in order to store content in the database. In order to take advantage of many of the advanced CleanSpeak moderation features you’ll need to store content.

application.moderationConfiguration.unicodeFilterRule.action [String] Available since 3.22.0

The filter action for the unicode filter. Allowed options are allow or reject.

The unicode filter rejects content if it contains prohibited unicode ranges.

application.moderationConfiguration.unicodeFilterRule.data [String] Available since 3.22.0

The unicode filter configuration represented as a dsl of ranges.

The ranges are described as a string of lines that may contain * Empty lines * Comments (a line starting with #) * Unicode ranges (A unicode codepoint is of the form \u0000 or \u{0} (Json unicode notation)) Ex: \u0000-\u{F}

A special condition is that the final unicode range may be an open range meaning the second unicode point is omitted.

Note: The ranges are inclusive so \u0000-\u000F includes the character \u000F

Note 2: The provided config may change between versions.

application.moderationConfiguration.urlFilterMaxLength [Integer]

This parameter specifies the maximum length that a match can be in order to be considered a url. If the match length is greater than the maximum match length the match will be ignored.

application.moderationConfiguration.urlFilterSpacePenalty [Double]

This parameter specifies a penalty that is applied to the quality score for a match if it contains one or more spaces. For example, www .ex a m ple .com contains spaces so the space penalty will added to the quality score.

application.moderationConfiguration.urlRules [Array]

The url filter rules. You must supply exactly three rules. Each rule must provide a score value which is the inclusive cutoff score for a url match. The rules correspond to a High, Medium and Low quality filter rule. In the Management Interface these rules are referenced as High, Medium and Low.

For example, the following are the default url rules:

{
  "urlRules": [
    {
      "score": 90,
      "action": "allow"
    },
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 40,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.urlRules[x].action [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.urlRules[x].alertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.urlRules[x].score [Integer]

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest url filter rule score the rule will be applied.

application.moderationConfiguration.urlRules[x].userScoreAdjustment [Integer]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.userCheckOutMinutes [Integer]

The number of minutes a Content User is checked out for before it is automatically released to be eligible for another moderator to check out.

application.moderationConfiguration.userFlagUserScoreAdjustment [Integer]

The amount the User score is adjusted when the user is flagged. This value may be a positive or negative integer.

application.moderationConfiguration.videoFilteringEnabled [Integer] Optinoal

Set to true if you want to enable third party video filtering. (The provider and credentials must be configured in the system configuration first!)

application.moderationConfiguration.videoQualityFilterRules [Array] Optional

A list of 3 quality filter rules corresponding to high, medium, and low quality.

For example, the following are the default videoQualityFilterRules:

{
  "videoQualityFilterRules": [
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 30,
      "action": "allow"
    },
    {
      "score": 0,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.videoQualityFilterRules[x].action [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.videoQualityFilterRules[x].alertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.videoQualityFilterRules[x].score [Integer]

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.videoQualityFilterRules[x].userScoreAdjustment [Integer] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

applicaiton.notificationServers [Array] Optional

A list of notification servers to use on an application. (This will create new notification servers every time)

Note: In the frontend, Notification Servers are now called Webhooks.

(See Handling Notifications for more details)

applicaiton.notificationServers[x].connectTimeout [Integer] Optional Defaults to 1000

The maximum amount of time a server will take to try to connect in milliseconds.

application.notificationServers[x].readTimeout [Integer] Optional Defaults to 2000

The maximum amount of time any read call will wait for data to flow.

application.notificationServers[x].httpAuthenticationPassword [String] Optional

A password to supply on the notification request.

application.notificationServers[x].httpAuthenticationUsername [String] Optional

A username to supply on the notification request.

applicaiton.notificationServers[x].sslCertificate [String] Optional

An ssl client certificate to present on the notification request.

application.notificationServers[x].url [String]

The url of a server listening for notifications.

Example Response JSON
{
  "application": {
    "id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
    "moderationConfiguration": {
      "approvalCheckOutMinutes": 10,
      "approvalQueueSize": 30,
      "archiveConfiguration": {
        "deleteOnly": true,
        "enabled": false
      },
      "contentAlertCheckOutMinutes": 10,
      "contentAlertQueueSize": 30,
      "contentDeletable": true,
      "contentEditable": true,
      "contentFlagAlertType": "User",
      "contentFlagUserScoreAdjustment": -3,
      "contentUserActionsEnabled": true,
      "ignorableCharacters": "qxz",
      "imageConfiguration": {
        "commitDelay": 45,
        "darkMode": true,
        "defaultTimerDuration": 2.0,
        "speedModerationLayout": true
      },
      "imageFilteringEnabled": false,
      "imageQualityFilterRules": [
        {
          "action": "allow",
          "score": 70
        },
        {
          "action": "allow",
          "score": 30
        },
        {
          "action": "allow",
          "score": 0
        }
      ],
      "maximumVideoFilterDurationInSeconds": 300,
      "videoFilteringEnabled": false,
      "videoQualityFilterRules": [
        {
          "action": "allow",
          "score": 70,
          "userScoreAdjustment": 0
        },
        {
          "action": "allow",
          "score": 30,
          "userScoreAdjustment": 0
        },
        {
          "action": "allow",
          "score": 0,
          "userScoreAdjustment": 0
        }
      ],
      "defaultActionIsQueueForApproval": false,
      "dictionaryTags": [
        "whitelistA"
      ],
      "emailOnAlerts": false,
      "emailOnContentFlagged": false,
      "emailOnEscalations": false,
      "emailOnUserFlagged": false,
      "emailRules": [
        {
          "action": "allow",
          "score": 90
        },
        {
          "score": 70,
          "action": "allow"
        },
        {
          "score": 40,
          "action": "allow"
        }
      ],
      "filterRules": [
        {
          "severeAlertType": "User",
          "highAction": "replace",
          "mildAction": "allow",
          "severeAction": "reject",
          "tags": [
            "Vulgarity"
          ],
          "mediumAction": "replace",
          "highAlertType": "User",
          "highUserScoreAdjustment": -25,
          "severeUserScoreAdjustment": -50
        },
        {
          "highAlertType": "User",
          "mildAction": "allow",
          "severeAction": "reject",
          "tags": [
            "Bullying"
          ],
          "highAction": "allow",
          "mediumAction": "allow"
        }
      ],
      "imageOnly": false,
      "persistent": true,
      "phoneNumberRules": [
        {
          "action": "allow",
          "score": 90,
          "userScoreAdjustment": -10
        },
        {
          "alertType": "Content",
          "userScoreAdjustment": -5,
          "score": 70,
          "action": "allow"
        },
        {
          "score": 40,
          "alertType": "User",
          "userScoreAdjustment": -1,
          "action": "allow"
        }
      ],
      "queuePersistentContent": false,
      "returnFilterMatches": false,
      "rules": {
        "usernameFilterRule": {
          "action": "reject",
          "enabled": false
        },
        "whitelistFilterRules": {
          "disallowedPhrase": {
            "action": "allow"
          },
          "disallowedWord": {
            "action": "allow"
          }
        }
      },
      "storeContent": true,
      "urlRules": [
        {
          "score": 90,
          "action": "allow"
        },
        {
          "action": "allow",
          "score": 70
        },
        {
          "score": 40,
          "action": "allow"
        }
      ],
      "userCheckOutMinutes": 10,
      "userFlagUserScoreAdjustment": -3
    },
    "name": "Chat",
    "notificationServers": [
      {
        "connectTimeout": 1000,
        "id": 21,
        "url": "http://chat.example.com/notification-handler",
        "readTimeout": 2000
      }
    ]
  }
}

3. Retrieve an Application

This API is used to retrieve an application and its configuration.

3.1. Request

Retrieve a single application by Id

URI

GET /system/application/{applicationId}

Table 5. Request Parameters

applicationId [UUID] Required

The Id of the Application to retrieve.

Retrieve all applications

URI

GET /system/application

3.2. Response

Table 6. Response Codes
Code Description

200

The request was successful. The response will contain a JSON body.

400

The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors.

401

You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

402

Your license has expired. The response will be empty. Contact sales@inversoft.com for assistance.

404

The object you requested doesn’t exist. The response will be empty.

500

There was an internal error. A stack trace is provided and logged in the CleanSpeak log files. The response will be empty.

Table 7. Response Body

application [Object]

The Application object.

application.id [UUID]

The Id of the Application.

application.moderationConfiguration.approvalCheckOutMinutes [Integer]

The number of minutes content is checked out for in the Approval Queue before it is automatically released to be eligible for another moderator to check out.

application.moderationConfiguration.approvalQueueSize [Integer]

The number of items checked out of the Approval Queue at a time for a moderator.

application.moderationConfiguration.archiveConfiguration [Object]

The archive configuration object.

application.moderationConfiguration.archiveConfiguration.enabled [Boolean]

Setting this value to true enables content deletion. This is false by default which means no content is deleted. If you’ll be sending in high volumes of content content deletion should be enabled. CleanSpeak is not designed to store content indefinitely.

application.moderationConfiguration.archiveConfiguration.storeDuration [Integer]

The number of units content should be kept. The unit value is determined by the storeTimeUnit.

application.moderationConfiguration.archiveConfiguration.storeOffsetDuration [Integer]

The number of units to be added to the storeDuration. The offset unit is determined by the storeOffsetTimeUnit.

application.moderationConfiguration.archiveConfiguration.storeOffsetTimeUnit [String]

The time unit for the offset. The possible values are:

  • minutes

  • hours

  • days

  • months

  • years

application.moderationConfiguration.archiveConfiguration.storeTimeUnit [String]

The time unit for the duration. The possible values are:

  • minutes

  • hours

  • days

  • months

  • years

application.moderationConfiguration.contentAlertCheckOutMinutes [Integer]

The number of minutes content is checked out for in the Alert Queue before it is automatically released to be eligible for another moderator to check out.

application.moderationConfiguration.contentAlertQueueSize [Integer]

The number of items checked out of the Alert Queue at a time for a moderator.

application.moderationConfiguration.contentDeletable [Boolean]

Set to true if you want the ability to delete content. Enabling this feature allows a moderator to delete content which in turn sends a notification of type contentDelete to be consumed by the CleanSpeak event handler.

application.moderationConfiguration.contentEditable [Boolean]

Set to true if you want the ability to edit content. Enabling this feature allows a moderator to edit content which in turn sends a notification of type contentEdit to be consumed by the CleanSpeak event handler.

application.moderationConfiguration.contentFlagAlertType [String]

By default when content is flagged a User alert is generated. Setting this to Content changes the behavior such that a Content alert is sent instead. The possible values are:

  • Content

  • User

application.moderationConfiguration.contentFlagUserScoreAdjustment [Integer]

The amount the User score is adjusted when content is flagged. This value may be a positive or negative integer.

application.moderationConfiguration.contentUserActionsEnabled [Boolean]

Set to true if you want user actions enabled. Enable this if you intend to allow moderators to action users, for example mute, ban, kick users. When disabled you will not be able to select this application as a target for a user action.

application.moderationConfiguration.defaultActionIsQueueForApproval [Boolean]

Set to true if you want content to be queued for approval when no filter rules are hit. This includes content that matched a rule set to allow.

For example, when this parameter is set to true and the content

  • did not match any filter rules, do queue for approval.

  • did not match any filter rules, but the moderate request parameter for moderation is set to generateAlert or generatesContentAlert, do not queue for approval.

  • did match one or more filters with an action other than allow, do not queue for approval.

This feature may be used way to ensure all content is reviewed in some fashion by a moderator.

application.moderationConfiguration.dictionaryTags [Array<String>] Available since 3.12.0

A list of dictionary tags to apply to moderation actions using this application.

Tags will cause the filter to throw out matches that exactly match dictionary words with any of the tags in this list.

application.moderationConfiguration.emailFilterMaxLength [Integer]

This parameter specifies the maximum length that a match can be in order to be considered an email. If the match length is greater than the maximum match length the match will be ignored.

application.moderationConfiguration.emailFilterSpacePenalty [Double]

This parameter specifies a penalty applied to the quality score if the match contains any spaces. For example, user@ example.com contains a space so the space penalty value will be added to the quality score. The email space penalty is applied once regardless of the number of spaces found in the match.

application.moderationConfiguration.emailOnAlerts [Boolean]

Set this parameter to true to email moderators for content alerts.

application.moderationConfiguration.emailOnContentFlagged [Boolean]

Set this parameter to true to email moderators when content is flagged.

application.moderationConfiguration.emailOnUserFlagged [Boolean]

Set this parameter to true to email moderators when users are flagged.

application.moderationConfiguration.emailRules [Array]

The email filter rules. You must supply exactly three rules. Each rule must provide a score value which is the inclusive cutoff score for an email match. The rules correspond to a High, Medium and Low quality filter rule. In the Management Interface these rules are referenced as High, Medium and Low.

For example, the following are the default email rules:

{
  "emailRules": [
    {
      "score": 90,
      "action": "allow"
    },
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 40,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.emailRules[x].action [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.emailRules[x].alertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.emailRules[x].score [Integer]

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.emailRules[x].userScoreAdjustment [Integer]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules [Array]

The list of blacklist filter rules.

application.moderationConfiguration.filterRules[x].tags [Array<String>]

The blacklist tags for this filter rule. A filter rule may have one or more tags.

application.moderationConfiguration.filterRules[x].locales [Array<String>]

The match locales. If this parameter is omitted the filter rule will apply to all locales. See Locales.

application.moderationConfiguration.filterRules[x].mildAction [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].mildAlertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].mildUserScoreAdjustment [String]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules[x].mediumAction [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].mediumAlertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].mediumUserScoreAdjustment [String]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules[x].highAction [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].highAlertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].highUserScoreAdjustment [String]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules[x].severeAction [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].severeAlertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].severeUserScoreAdjustment [String]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.ignorableCharacters [String] Available since 3.22.0

The list list of characters the filter can skip over to find a match.

Specifically, this feature will catch any blacklist word even if separated by a single character on this list. Example: SxMxUxRxF Note: only the same letter may be used to separate the characters throughout the word and only one ignored character in a row is permitted.

application.moderationConfiguration.imageConfiguration [Object]

The image moderation configuration object. This parameter and all nested parameters are only valid when imageOnly is set to true.

application.moderationConfiguration.imageConfiguration.commitDelay [Integer]

The number of seconds to wait before a moderation decision made from the enhanced image moderation queue is committed.

application.moderationConfiguration.imageConfiguration.darkMode [Boolean]

Set this parameter to 'false' to disable the dark mode theme when viewing the enhanced image moderation queue.

application.moderationConfiguration.imageConfiguration.defaultTimerDuration [Integer]

The number of seconds each image will be displayed in the queue before advancing to the next image when the queue is set to automatically advance without keyboard interaction. This value is the default value for this application for all moderators. A moderator may change this value for their own user preference.

application.moderationConfiguration.imageConfiguration.speedModerationLayout [Boolean]

Set this parameter to false to disable the enhanced image moderation queue layout and use the legacy mode.

application.moderationConfiguration.imageOnly [Boolean]

Set this parameter to true to enable this application for image only moderation. When this parameter is set to true the imageConfiguration parameters are used to provide additional configuration.

application.moderationConfiguration.imageFilteringEnabled [Integer] Optinoal

Set to true if you want to enable third party image filtering. (The provider and credentials must be configured in the system configuration first!)

application.moderationConfiguration.imageQualityFilterRules [Array] Optional

A list of 3 quality filter rules corresponding to high, medium, and low quality.

For example, the following are the default imageQualityFilterRules:

{
  "imageQualityFilterRules": [
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 30,
      "action": "allow"
    },
    {
      "score": 0,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.imageQualityFilterRules[x].action [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.imageQualityFilterRules[x].alertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.imageQualityFilterRules[x].score [Integer]

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.imageQualityFilterRules[x].userScoreAdjustment [Integer] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.maximumVideoFilterDurationInSeconds [Integer] Optional defaults to 300

The maximum amount of time a video filter request is allowed to take in seconds.

application.moderationConfiguration.noRuleUserScoreAdjustment [Integer]

This score adjustment is used when the content did not match any rules. This value may be a positive or negative integer.

This may be used to increase a user score based upon good behavior, i.e. sending in content that did not contain any profanity. In this use case, you would provide a positive value for the adjustment.

This adjustment will only affect the user score while it is below 0. Once the user score is raised to 0 this adjustment will be ignored.

application.moderationConfiguration.persistent [Boolean]

Set this parameter to true to indicate the content type is persistent, false indicates this content is transient.

Persistent content is defined as content that is likely displayed indefinitely. A user can go and look at this content in the future by browsing a forum or performing a content search. Examples of persistent content include forum posts, profile pictures, etc. Persist content can be edited, deleted and pre-approved.

Transient content is defined as content that is displayed for a short period of time and then is likely gone forever. Transient content is usually synonymous with chat. This content cannot be pre-approved, edited or deleted.

Please note that both transient and persistent content in this context are persisted to the database.

application.moderationConfiguration.phoneNumberFilterMaxLength [Integer]

This parameter specifies the maximum length that a match can be in order to be considered an phone number. If the match length is greater than the maximum match length the match will be ignored.

application.moderationConfiguration.phoneNumberFilterMinLength [Integer]

This parameter specifies the minimum length that a match can be in order to be considered a phone number. The default value covers most world wide phone number formats.

application.moderationConfiguration.phoneNumberFilterSeparatorPenalty [Double]

This parameter specifies a penalty that is applied to the quality score for a match if it contains any type of separator other than a dash or parenthesis. For example, 303;555;1234 contains two penalized separators so the separator penalty will be multiplied by the number of separators and added to the quality score.

application.moderationConfiguration.phoneNumberFilterSpacePenalty [Double]

This parameter specifies a penalty that is applied to the quality score for a match if it contains one or more spaces. For example, 303 555 1234 contains two spaces so the space penalty will be multiplied by the number of spaces and added to the quality score.

application.moderationConfiguration.phoneNumberFilterWordPenalty [Double]

This parameter specifies a penalty that is applied to the quality score for a match if it contains any words rather than digits. For example, three zero three 555 1234 contains three words so the word penalty will be multiplied by the number of words and added to the quality score.

application.moderationConfiguration.phoneNumberRules [Array]

The phone number filter rules. You must supply exactly three rules. Each rule must provide a score value which is the inclusive cutoff score for a phone number match. The rules correspond to a High, Medium and Low quality filter rule. In the Management Interface these rules are referenced as High, Medium and Low.

For example, the following are the default phone number rules:

{
  "phoneNumberRules": [
    {
      "score": 90,
      "action": "allow"
    },
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 40,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.phoneNumberRules[x].action [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.phoneNumberRules[x].alertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.phoneNumberRules[x].score [Integer]

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.phoneNumberRules[x].userScoreAdjustment [Integer]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.queuePersistentContent [Boolean]

Set this to true in order to asynchronously store persistent content. This may improve performance but there is a potential for data loss if an outage occurs before all content is committed to the database. Please consult with Inversoft Support if you are unsure how to use this feature.

application.moderationConfiguration.replacementCharacter [String]

The character used during match replacement. If this value is set it will take precedence over replacementString.

application.moderationConfiguration.replacementString [String]

The string used during match replacement. If neither replacementString or replacementCharacter are defined the default replacement character * will be utilized.

application.moderationConfiguration.returnFilterMatches [Boolean] Available since 3.9.1

This parameter specifies if filter matches will be returned in the Moderate Content API response.

application.moderationConfiguration.rules [Object]

The rules object. This object contains the Username Filter and Whitelist Filter rules.

application.moderationConfiguration.storeContent [Boolean]

Set this parameter to true in order to store content in the database. In order to take advantage of many of the advanced CleanSpeak moderation features you’ll need to store content.

application.moderationConfiguration.unicodeFilterRule.action [String] Available since 3.22.0

The filter action for the unicode filter. Allowed options are allow or reject.

The unicode filter rejects content if it contains prohibited unicode ranges.

application.moderationConfiguration.unicodeFilterRule.data [String] Available since 3.22.0

The unicode filter configuration represented as a dsl of ranges.

The ranges are described as a string of lines that may contain * Empty lines * Comments (a line starting with #) * Unicode ranges (A unicode codepoint is of the form \u0000 or \u{0} (Json unicode notation)) Ex: \u0000-\u{F}

A special condition is that the final unicode range may be an open range meaning the second unicode point is omitted.

Note: The ranges are inclusive so \u0000-\u000F includes the character \u000F

Note 2: The provided config may change between versions.

application.moderationConfiguration.urlFilterMaxLength [Integer]

This parameter specifies the maximum length that a match can be in order to be considered a url. If the match length is greater than the maximum match length the match will be ignored.

application.moderationConfiguration.urlFilterSpacePenalty [Double]

This parameter specifies a penalty that is applied to the quality score for a match if it contains one or more spaces. For example, www .ex a m ple .com contains spaces so the space penalty will added to the quality score.

application.moderationConfiguration.urlRules [Array]

The url filter rules. You must supply exactly three rules. Each rule must provide a score value which is the inclusive cutoff score for a url match. The rules correspond to a High, Medium and Low quality filter rule. In the Management Interface these rules are referenced as High, Medium and Low.

For example, the following are the default url rules:

{
  "urlRules": [
    {
      "score": 90,
      "action": "allow"
    },
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 40,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.urlRules[x].action [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.urlRules[x].alertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.urlRules[x].score [Integer]

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest url filter rule score the rule will be applied.

application.moderationConfiguration.urlRules[x].userScoreAdjustment [Integer]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.userCheckOutMinutes [Integer]

The number of minutes a Content User is checked out for before it is automatically released to be eligible for another moderator to check out.

application.moderationConfiguration.userFlagUserScoreAdjustment [Integer]

The amount the User score is adjusted when the user is flagged. This value may be a positive or negative integer.

application.moderationConfiguration.videoFilteringEnabled [Integer] Optinoal

Set to true if you want to enable third party video filtering. (The provider and credentials must be configured in the system configuration first!)

application.moderationConfiguration.videoQualityFilterRules [Array] Optional

A list of 3 quality filter rules corresponding to high, medium, and low quality.

For example, the following are the default videoQualityFilterRules:

{
  "videoQualityFilterRules": [
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 30,
      "action": "allow"
    },
    {
      "score": 0,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.videoQualityFilterRules[x].action [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.videoQualityFilterRules[x].alertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.videoQualityFilterRules[x].score [Integer]

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.videoQualityFilterRules[x].userScoreAdjustment [Integer] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

applicaiton.notificationServers [Array] Optional

A list of notification servers to use on an application. (This will create new notification servers every time)

Note: In the frontend, Notification Servers are now called Webhooks.

(See Handling Notifications for more details)

applicaiton.notificationServers[x].connectTimeout [Integer] Optional Defaults to 1000

The maximum amount of time a server will take to try to connect in milliseconds.

application.notificationServers[x].readTimeout [Integer] Optional Defaults to 2000

The maximum amount of time any read call will wait for data to flow.

application.notificationServers[x].httpAuthenticationPassword [String] Optional

A password to supply on the notification request.

application.notificationServers[x].httpAuthenticationUsername [String] Optional

A username to supply on the notification request.

applicaiton.notificationServers[x].sslCertificate [String] Optional

An ssl client certificate to present on the notification request.

application.notificationServers[x].url [String]

The url of a server listening for notifications.

Example Response JSON
{
  "application": {
    "id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
    "moderationConfiguration": {
      "approvalCheckOutMinutes": 10,
      "approvalQueueSize": 30,
      "archiveConfiguration": {
        "deleteOnly": true,
        "enabled": false
      },
      "contentAlertCheckOutMinutes": 10,
      "contentAlertQueueSize": 30,
      "contentDeletable": true,
      "contentEditable": true,
      "contentFlagAlertType": "User",
      "contentFlagUserScoreAdjustment": -3,
      "contentUserActionsEnabled": true,
      "ignorableCharacters": "qxz",
      "imageConfiguration": {
        "commitDelay": 45,
        "darkMode": true,
        "defaultTimerDuration": 2.0,
        "speedModerationLayout": true
      },
      "imageFilteringEnabled": false,
      "imageQualityFilterRules": [
        {
          "action": "allow",
          "score": 70
        },
        {
          "action": "allow",
          "score": 30
        },
        {
          "action": "allow",
          "score": 0
        }
      ],
      "maximumVideoFilterDurationInSeconds": 300,
      "videoFilteringEnabled": false,
      "videoQualityFilterRules": [
        {
          "action": "allow",
          "score": 70,
          "userScoreAdjustment": 0
        },
        {
          "action": "allow",
          "score": 30,
          "userScoreAdjustment": 0
        },
        {
          "action": "allow",
          "score": 0,
          "userScoreAdjustment": 0
        }
      ],
      "defaultActionIsQueueForApproval": false,
      "dictionaryTags": [
        "whitelistA"
      ],
      "emailOnAlerts": false,
      "emailOnContentFlagged": false,
      "emailOnEscalations": false,
      "emailOnUserFlagged": false,
      "emailRules": [
        {
          "action": "allow",
          "score": 90
        },
        {
          "score": 70,
          "action": "allow"
        },
        {
          "score": 40,
          "action": "allow"
        }
      ],
      "filterRules": [
        {
          "severeAlertType": "User",
          "highAction": "replace",
          "mildAction": "allow",
          "severeAction": "reject",
          "tags": [
            "Vulgarity"
          ],
          "mediumAction": "replace",
          "highAlertType": "User",
          "highUserScoreAdjustment": -25,
          "severeUserScoreAdjustment": -50
        },
        {
          "highAlertType": "User",
          "mildAction": "allow",
          "severeAction": "reject",
          "tags": [
            "Bullying"
          ],
          "highAction": "allow",
          "mediumAction": "allow"
        }
      ],
      "imageOnly": false,
      "persistent": true,
      "phoneNumberRules": [
        {
          "action": "allow",
          "score": 90,
          "userScoreAdjustment": -10
        },
        {
          "alertType": "Content",
          "userScoreAdjustment": -5,
          "score": 70,
          "action": "allow"
        },
        {
          "score": 40,
          "alertType": "User",
          "userScoreAdjustment": -1,
          "action": "allow"
        }
      ],
      "queuePersistentContent": false,
      "returnFilterMatches": false,
      "rules": {
        "usernameFilterRule": {
          "action": "reject",
          "enabled": false
        },
        "whitelistFilterRules": {
          "disallowedPhrase": {
            "action": "allow"
          },
          "disallowedWord": {
            "action": "allow"
          }
        }
      },
      "storeContent": true,
      "urlRules": [
        {
          "score": 90,
          "action": "allow"
        },
        {
          "action": "allow",
          "score": 70
        },
        {
          "score": 40,
          "action": "allow"
        }
      ],
      "userCheckOutMinutes": 10,
      "userFlagUserScoreAdjustment": -3
    },
    "name": "Chat",
    "notificationServers": [
      {
        "connectTimeout": 1000,
        "id": 21,
        "url": "http://chat.example.com/notification-handler",
        "readTimeout": 2000
      }
    ]
  }
}

4. Update an Application

This API is used to update an application.

4.1. Request

URI

PUT /system/application/{applicationId}

Table 8. Request Parameters

applicationId [UUID] Required

The Id of the Application to update.

Table 9. Request Body

application [Object] Required

The Application object.

application.moderationConfiguration.approvalCheckOutMinutes [Integer] Optional defaults to 10

The number of minutes content is checked out for in the Approval Queue before it is automatically released to be eligible for another moderator to check out.

application.moderationConfiguration.approvalQueueSize [Integer] Optional defaults to 30

The number of items checked out of the Approval Queue at a time for a moderator.

application.moderationConfiguration.archiveConfiguration [Object] Optional

The archive configuration object.

application.moderationConfiguration.archiveConfiguration.enabled [Boolean] Optional defaults to false

Setting this value to true enables content deletion. This is false by default which means no content is deleted. If you’ll be sending in high volumes of content content deletion should be enabled. CleanSpeak is not designed to store content indefinitely.

application.moderationConfiguration.archiveConfiguration.storeDuration [Integer] Required

The number of units content should be kept. The unit value is determined by the storeTimeUnit.

application.moderationConfiguration.archiveConfiguration.storeOffsetDuration [Integer] Required

The number of units to be added to the storeDuration. The offset unit is determined by the storeOffsetTimeUnit.

application.moderationConfiguration.archiveConfiguration.storeOffsetTimeUnit [String] Required

The time unit for the offset. The possible values are:

  • minutes

  • hours

  • days

  • months

  • years

application.moderationConfiguration.archiveConfiguration.storeTimeUnit [String] Required

The time unit for the duration. The possible values are:

  • minutes

  • hours

  • days

  • months

  • years

application.moderationConfiguration.contentAlertCheckOutMinutes [Integer] Optional defaults to 10

The number of minutes content is checked out for in the Alert Queue before it is automatically released to be eligible for another moderator to check out.

application.moderationConfiguration.contentAlertQueueSize [Integer] Optional defaults to 30

The number of items checked out of the Alert Queue at a time for a moderator.

application.moderationConfiguration.contentDeletable [Boolean] Optional defaults to false

Set to true if you want the ability to delete content. Enabling this feature allows a moderator to delete content which in turn sends a notification of type contentDelete to be consumed by the CleanSpeak event handler.

application.moderationConfiguration.contentEditable [Boolean] Optional defaults to false

Set to true if you want the ability to edit content. Enabling this feature allows a moderator to edit content which in turn sends a notification of type contentEdit to be consumed by the CleanSpeak event handler.

application.moderationConfiguration.contentFlagAlertType [String] Optional defaults to User

By default when content is flagged a User alert is generated. Setting this to Content changes the behavior such that a Content alert is sent instead. The possible values are:

  • Content

  • User

application.moderationConfiguration.contentFlagUserScoreAdjustment [Integer] Optional

The amount the User score is adjusted when content is flagged. This value may be a positive or negative integer.

application.moderationConfiguration.contentUserActionsEnabled [Boolean] Optional defaults to false

Set to true if you want user actions enabled. Enable this if you intend to allow moderators to action users, for example mute, ban, kick users. When disabled you will not be able to select this application as a target for a user action.

application.moderationConfiguration.defaultActionIsQueueForApproval [Boolean] Optional defaults to false

Set to true if you want content to be queued for approval when no filter rules are hit. This includes content that matched a rule set to allow.

For example, when this parameter is set to true and the content

  • did not match any filter rules, do queue for approval.

  • did not match any filter rules, but the moderate request parameter for moderation is set to generateAlert or generatesContentAlert, do not queue for approval.

  • did match one or more filters with an action other than allow, do not queue for approval.

This feature may be used way to ensure all content is reviewed in some fashion by a moderator.

application.moderationConfiguration.dictionaryTags [Array<String>] Optional Available since 3.12.0

A list of dictionary tags to apply to moderation actions using this application.

Tags will cause the filter to throw out matches that exactly match dictionary words with any of the tags in this list.

application.moderationConfiguration.emailFilterMaxLength [Integer] Optional defaults to 50

This parameter specifies the maximum length that a match can be in order to be considered an email. If the match length is greater than the maximum match length the match will be ignored.

application.moderationConfiguration.emailFilterSpacePenalty [Double] Optional defaults to -0.05

This parameter specifies a penalty applied to the quality score if the match contains any spaces. For example, user@ example.com contains a space so the space penalty value will be added to the quality score. The email space penalty is applied once regardless of the number of spaces found in the match.

application.moderationConfiguration.emailOnAlerts [Boolean] Optional defaults to false

Set this parameter to true to email moderators for content alerts.

application.moderationConfiguration.emailOnContentFlagged [Boolean] Optional defaults to false

Set this parameter to true to email moderators when content is flagged.

application.moderationConfiguration.emailOnUserFlagged [Boolean] Optional defaults to false

Set this parameter to true to email moderators when users are flagged.

application.moderationConfiguration.emailRules [Array] Optional

The email filter rules. You must supply exactly three rules. Each rule must provide a score value which is the inclusive cutoff score for an email match. The rules correspond to a High, Medium and Low quality filter rule. In the Management Interface these rules are referenced as High, Medium and Low.

For example, the following are the default email rules:

{
  "emailRules": [
    {
      "score": 90,
      "action": "allow"
    },
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 40,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.emailRules[x].action [String] Required

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.emailRules[x].alertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.emailRules[x].score [Integer] Required

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.emailRules[x].userScoreAdjustment [Integer] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules [Array] Optional

The list of blacklist filter rules.

application.moderationConfiguration.filterRules[x].tags [Array<String>] Required

The blacklist tags for this filter rule. A filter rule may have one or more tags.

application.moderationConfiguration.filterRules[x].locales [Array<String>] Optional

The match locales. If this parameter is omitted the filter rule will apply to all locales. See Locales.

application.moderationConfiguration.filterRules[x].mildAction [String] Required

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].mildAlertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].mildUserScoreAdjustment [String] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules[x].mediumAction [String] Required

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].mediumAlertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].mediumUserScoreAdjustment [String] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules[x].highAction [String] Required

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].highAlertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].highUserScoreAdjustment [String] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules[x].severeAction [String] Required

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].severeAlertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].severeUserScoreAdjustment [String] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.ignorableCharacters [String] Optional Defaults to "qxz" Available since 3.22.0

Set this parameter to a list of characters the filter can skip over to find a match. Only the letters a through z are permitted.

Specifically, this feature will catch any blacklist word even if separated by a single character on this list. Example: SxMxUxRxF Note: only the same letter may be used to separate the characters throughout the word and only one ignored character in a row is permitted.

application.moderationConfiguration.imageConfiguration [Object] Optional

The image moderation configuration object. This parameter and all nested parameters are only valid when imageOnly is set to true.

application.moderationConfiguration.imageConfiguration.commitDelay [Integer] Optional defaults to 45

The number of seconds to wait before a moderation decision made from the enhanced image moderation queue is committed.

application.moderationConfiguration.imageConfiguration.darkMode [Boolean] Optional defaults to true

Set this parameter to 'false' to disable the dark mode theme when viewing the enhanced image moderation queue.

application.moderationConfiguration.imageConfiguration.defaultTimerDuration [Integer] Optional defaults to 2

The number of seconds each image will be displayed in the queue before advancing to the next image when the queue is set to automatically advance without keyboard interaction. This value is the default value for this application for all moderators. A moderator may change this value for their own user preference.

application.moderationConfiguration.imageConfiguration.speedModerationLayout [Boolean] Optional defaults to true

Set this parameter to false to disable the enhanced image moderation queue layout and use the legacy mode.

application.moderationConfiguration.imageOnly [Boolean] Optional defaults to false

Set this parameter to true to enable this application for image only moderation. When this parameter is set to true the imageConfiguration parameters are used to provide additional configuration.

application.moderationConfiguration.imageFilteringEnabled [Integer] Optinoal

Set to true if you want to enable third party image filtering. (The provider and credentials must be configured in the system configuration first!)

application.moderationConfiguration.imageQualityFilterRules [Array] Optional

A list of 3 quality filter rules corresponding to high, medium, and low quality.

For example, the following are the default imageQualityFilterRules:

{
  "imageQualityFilterRules": [
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 30,
      "action": "allow"
    },
    {
      "score": 0,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.imageQualityFilterRules[x].action [String] Required

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.imageQualityFilterRules[x].alertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.imageQualityFilterRules[x].score [Integer] Required

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.imageQualityFilterRules[x].userScoreAdjustment [Integer] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.maximumVideoFilterDurationInSeconds [Integer] Optional defaults to 300

The maximum amount of time a video filter request is allowed to take in seconds.

application.moderationConfiguration.noRuleUserScoreAdjustment [Integer] Optional

This score adjustment is used when the content did not match any rules. This value may be a positive or negative integer.

This may be used to increase a user score based upon good behavior, i.e. sending in content that did not contain any profanity. In this use case, you would provide a positive value for the adjustment.

This adjustment will only affect the user score while it is below 0. Once the user score is raised to 0 this adjustment will be ignored.

application.moderationConfiguration.persistent [Boolean] Optional defaults to false

Set this parameter to true to indicate the content type is persistent, false indicates this content is transient.

Persistent content is defined as content that is likely displayed indefinitely. A user can go and look at this content in the future by browsing a forum or performing a content search. Examples of persistent content include forum posts, profile pictures, etc. Persist content can be edited, deleted and pre-approved.

Transient content is defined as content that is displayed for a short period of time and then is likely gone forever. Transient content is usually synonymous with chat. This content cannot be pre-approved, edited or deleted.

Please note that both transient and persistent content in this context are persisted to the database.

application.moderationConfiguration.phoneNumberFilterMaxLength [Integer] Optional defaults to 20

This parameter specifies the maximum length that a match can be in order to be considered an phone number. If the match length is greater than the maximum match length the match will be ignored.

application.moderationConfiguration.phoneNumberFilterMinLength [Integer] Optional defaults to 7

This parameter specifies the minimum length that a match can be in order to be considered a phone number. The default value covers most world wide phone number formats.

application.moderationConfiguration.phoneNumberFilterSeparatorPenalty [Double] Optional defaults to -0.02

This parameter specifies a penalty that is applied to the quality score for a match if it contains any type of separator other than a dash or parenthesis. For example, 303;555;1234 contains two penalized separators so the separator penalty will be multiplied by the number of separators and added to the quality score.

application.moderationConfiguration.phoneNumberFilterSpacePenalty [Double] Optional defaults to -0.02

This parameter specifies a penalty that is applied to the quality score for a match if it contains one or more spaces. For example, 303 555 1234 contains two spaces so the space penalty will be multiplied by the number of spaces and added to the quality score.

application.moderationConfiguration.phoneNumberFilterWordPenalty [Double] Optional defaults to -0.03

This parameter specifies a penalty that is applied to the quality score for a match if it contains any words rather than digits. For example, three zero three 555 1234 contains three words so the word penalty will be multiplied by the number of words and added to the quality score.

application.moderationConfiguration.phoneNumberRules [Array] Optional

The phone number filter rules. You must supply exactly three rules. Each rule must provide a score value which is the inclusive cutoff score for a phone number match. The rules correspond to a High, Medium and Low quality filter rule. In the Management Interface these rules are referenced as High, Medium and Low.

For example, the following are the default phone number rules:

{
  "phoneNumberRules": [
    {
      "score": 90,
      "action": "allow"
    },
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 40,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.phoneNumberRules[x].action [String] Required

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.phoneNumberRules[x].alertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.phoneNumberRules[x].score [Integer] Required

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.phoneNumberRules[x].userScoreAdjustment [Integer] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.queuePersistentContent [Boolean] Optional defaults to false

Set this to true in order to asynchronously store persistent content. This may improve performance but there is a potential for data loss if an outage occurs before all content is committed to the database. Please consult with Inversoft Support if you are unsure how to use this feature.

application.moderationConfiguration.replacementCharacter [String] Optional

The character used during match replacement. If this value is set it will take precedence over replacementString.

application.moderationConfiguration.replacementString [String] Optional

The string used during match replacement. If neither replacementString or replacementCharacter are defined the default replacement character * will be utilized.

application.moderationConfiguration.returnFilterMatches [Boolean] Optional defaults to false Available since 3.9.1

Set this parameter to true in order to receive filter matches in the Moderate Content API response.

application.moderationConfiguration.rules [Object] Optional

The rules object. This object contains the Username Filter and Whitelist Filter rules.

application.moderationConfiguration.storeContent [Boolean] Optional defaults to false

Set this parameter to true in order to store content in the database. In order to take advantage of many of the advanced CleanSpeak moderation features you’ll need to store content.

application.moderationConfiguration.unicodeFilterRule.action [String] Optional defaults to allow Available since 3.22.0

The filter action for the unicode filter. Allowed options are allow or reject.

The unicode filter rejects content if it contains prohibited unicode ranges.

application.moderationConfiguration.unicodeFilterRule.data [String] Optional defaults to a provided config Available since 3.22.0

The unicode filter configuration represented as a dsl of ranges.

The ranges are described as a string of lines that may contain * Empty lines * Comments (a line starting with #) * Unicode ranges (A unicode codepoint is of the form \u0000 or \u{0} (Json unicode notation)) Ex: \u0000-\u{F}

A special condition is that the final unicode range may be an open range meaning the second unicode point is omitted.

Note: The ranges are inclusive so \u0000-\u000F includes the character \u000F

Note 2: The provided config may change between versions.

application.moderationConfiguration.urlFilterMaxLength [Integer] Optional defaults to 50

This parameter specifies the maximum length that a match can be in order to be considered a url. If the match length is greater than the maximum match length the match will be ignored.

application.moderationConfiguration.urlFilterSpacePenalty [Double] Optional defaults to -0.05

This parameter specifies a penalty that is applied to the quality score for a match if it contains one or more spaces. For example, www .ex a m ple .com contains spaces so the space penalty will added to the quality score.

application.moderationConfiguration.urlRules [Array] Optional

The url filter rules. You must supply exactly three rules. Each rule must provide a score value which is the inclusive cutoff score for a url match. The rules correspond to a High, Medium and Low quality filter rule. In the Management Interface these rules are referenced as High, Medium and Low.

For example, the following are the default url rules:

{
  "urlRules": [
    {
      "score": 90,
      "action": "allow"
    },
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 40,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.urlRules[x].action [String] Required

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.urlRules[x].alertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.urlRules[x].score [Integer] Required

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest url filter rule score the rule will be applied.

application.moderationConfiguration.urlRules[x].userScoreAdjustment [Integer] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.userCheckOutMinutes [Integer] Optional defaults to 10

The number of minutes a Content User is checked out for before it is automatically released to be eligible for another moderator to check out.

application.moderationConfiguration.userFlagUserScoreAdjustment [Integer] Optional

The amount the User score is adjusted when the user is flagged. This value may be a positive or negative integer.

application.moderationConfiguration.videoFilteringEnabled [Integer] Optinoal

Set to true if you want to enable third party video filtering. (The provider and credentials must be configured in the system configuration first!)

application.moderationConfiguration.videoQualityFilterRules [Array] Optional

A list of 3 quality filter rules corresponding to high, medium, and low quality.

For example, the following are the default videoQualityFilterRules:

{
  "videoQualityFilterRules": [
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 30,
      "action": "allow"
    },
    {
      "score": 0,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.videoQualityFilterRules[x].action [String] Required

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.videoQualityFilterRules[x].alertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.videoQualityFilterRules[x].score [Integer] Required

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.videoQualityFilterRules[x].userScoreAdjustment [Integer] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

applicaiton.notificationServers [Array] Optional

A list of notification servers to use on an application. (This will create new notification servers every time)

Note: In the frontend, Notification Servers are now called Webhooks.

(See Handling Notifications for more details)

applicaiton.notificationServers[x].connectTimeout [Integer] Optional Defaults to 1000

The maximum amount of time a server will take to try to connect in milliseconds.

application.notificationServers[x].readTimeout [Integer] Optional Defaults to 2000

The maximum amount of time any read call will wait for data to flow.

application.notificationServers[x].httpAuthenticationPassword [String] Optional

A password to supply on the notification request.

application.notificationServers[x].httpAuthenticationUsername [String] Optional

A username to supply on the notification request.

applicaiton.notificationServers[x].sslCertificate [String] Optional

An ssl client certificate to present on the notification request.

application.notificationServers[x].url [String] required

The url of a server listening for notifications.

Example Request JSON
{
  "application": {
    "moderationConfiguration": {
      "approvalCheckOutMinutes": 10,
      "approvalQueueSize": 30,
      "archiveConfiguration": {
        "deleteOnly": true,
        "enabled": false
      },
      "contentAlertCheckOutMinutes": 10,
      "contentAlertQueueSize": 30,
      "contentDeletable": true,
      "contentEditable": true,
      "contentFlagAlertType": "User",
      "contentUserActionsEnabled": true,
      "ignorableCharacters": "qxz",
      "imageConfiguration": {
        "commitDelay": 45,
        "darkMode": true,
        "defaultTimerDuration": 2.0,
        "speedModerationLayout": true
      },
      "imageOnly": false,
      "imageFilteringEnabled": false,
      "imageQualityFilterRules": [
        {
          "action": "allow",
          "score": 70
        },
        {
          "action": "allow",
          "score": 30
        },
        {
          "action": "allow",
          "score": 0
        }
      ],
      "maximumVideoFilterDurationInSeconds": 300,
      "videoFilteringEnabled": false,
      "videoQualityFilterRules": [
        {
          "action": "allow",
          "score": 70
        },
        {
          "action": "allow",
          "score": 30
        },
        {
          "action": "allow",
          "score": 0
        }
      ],
      "defaultActionIsQueueForApproval": false,
      "dictionaryTags": [],
      "emailOnAlerts": false,
      "emailOnContentFlagged": false,
      "emailOnEscalations": false,
      "emailOnUserFlagged": false,
      "emailRules": [
        {
          "action": "allow",
          "score": 90
        },
        {
          "score": 70,
          "action": "allow"
        },
        {
          "score": 40,
          "action": "allow"
        }
      ],
      "filterRules": [
        {
          "highAction": "authorOnly",
          "highAlertType": "User",
          "locales": [],
          "mediumAction": "allow",
          "mildAction": "allow",
          "severeAction": "reject",
          "severeAlertType": "User",
          "tags": [
            "Vulgarity"
          ]
        },
        {
          "highAction": "allow",
          "highAlertType": "User",
          "locales": [
            "en"
          ],
          "mediumAction": "allow",
          "mildAction": "allow",
          "severeAction": "authorOnly",
          "severeAlertType": "User",
          "tags": [
            "Bullying"
          ]
        }
      ],
      "persistent": true,
      "phoneNumberRules": [
        {
          "action": "allow",
          "score": 90,
          "userScoreAdjustment": -10
        },
        {
          "alertType": "Content",
          "userScoreAdjustment": -5,
          "score": 70,
          "action": "allow"
        },
        {
          "score": 40,
          "alertType": "User",
          "userScoreAdjustment": -1,
          "action": "allow"
        }
      ],
      "queuePersistentContent": false,
      "returnFilterMatches": false,
      "rules": {
        "usernameFilterRule": {
          "action": "reject",
          "enabled": false
        },
        "whitelistFilterRules": {
          "disallowedPhrase": {},
          "disallowedWord": {}
        }
      },
      "storeContent": true,
      "urlRules": [],
      "userCheckOutMinutes": 10
    },
    "name": "Chat",
    "notificationServers": [
      {
        "connectTimeout": 1000,
        "readTimeout": 2000,
        "url": "http://chat.example.com/notification-handler",
        "id": 20
      }
    ]
  }
}

4.2. Response

Table 10. Response Codes
Code Description

200

The request was successful. The response will contain a JSON body.

400

The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors.

401

You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

402

Your license has expired. The response will be empty. Contact sales@inversoft.com for assistance.

404

The object you are trying to update doesn’t exist. The response will be empty.

500

There was an internal error. A stack trace is provided and logged in the CleanSpeak log files. The response will be empty.

Table 11. Response Body

application [Object]

The Application object.

application.id [UUID]

The Id of the Application.

application.moderationConfiguration.approvalCheckOutMinutes [Integer]

The number of minutes content is checked out for in the Approval Queue before it is automatically released to be eligible for another moderator to check out.

application.moderationConfiguration.approvalQueueSize [Integer]

The number of items checked out of the Approval Queue at a time for a moderator.

application.moderationConfiguration.archiveConfiguration [Object]

The archive configuration object.

application.moderationConfiguration.archiveConfiguration.enabled [Boolean]

Setting this value to true enables content deletion. This is false by default which means no content is deleted. If you’ll be sending in high volumes of content content deletion should be enabled. CleanSpeak is not designed to store content indefinitely.

application.moderationConfiguration.archiveConfiguration.storeDuration [Integer]

The number of units content should be kept. The unit value is determined by the storeTimeUnit.

application.moderationConfiguration.archiveConfiguration.storeOffsetDuration [Integer]

The number of units to be added to the storeDuration. The offset unit is determined by the storeOffsetTimeUnit.

application.moderationConfiguration.archiveConfiguration.storeOffsetTimeUnit [String]

The time unit for the offset. The possible values are:

  • minutes

  • hours

  • days

  • months

  • years

application.moderationConfiguration.archiveConfiguration.storeTimeUnit [String]

The time unit for the duration. The possible values are:

  • minutes

  • hours

  • days

  • months

  • years

application.moderationConfiguration.contentAlertCheckOutMinutes [Integer]

The number of minutes content is checked out for in the Alert Queue before it is automatically released to be eligible for another moderator to check out.

application.moderationConfiguration.contentAlertQueueSize [Integer]

The number of items checked out of the Alert Queue at a time for a moderator.

application.moderationConfiguration.contentDeletable [Boolean]

Set to true if you want the ability to delete content. Enabling this feature allows a moderator to delete content which in turn sends a notification of type contentDelete to be consumed by the CleanSpeak event handler.

application.moderationConfiguration.contentEditable [Boolean]

Set to true if you want the ability to edit content. Enabling this feature allows a moderator to edit content which in turn sends a notification of type contentEdit to be consumed by the CleanSpeak event handler.

application.moderationConfiguration.contentFlagAlertType [String]

By default when content is flagged a User alert is generated. Setting this to Content changes the behavior such that a Content alert is sent instead. The possible values are:

  • Content

  • User

application.moderationConfiguration.contentFlagUserScoreAdjustment [Integer]

The amount the User score is adjusted when content is flagged. This value may be a positive or negative integer.

application.moderationConfiguration.contentUserActionsEnabled [Boolean]

Set to true if you want user actions enabled. Enable this if you intend to allow moderators to action users, for example mute, ban, kick users. When disabled you will not be able to select this application as a target for a user action.

application.moderationConfiguration.defaultActionIsQueueForApproval [Boolean]

Set to true if you want content to be queued for approval when no filter rules are hit. This includes content that matched a rule set to allow.

For example, when this parameter is set to true and the content

  • did not match any filter rules, do queue for approval.

  • did not match any filter rules, but the moderate request parameter for moderation is set to generateAlert or generatesContentAlert, do not queue for approval.

  • did match one or more filters with an action other than allow, do not queue for approval.

This feature may be used way to ensure all content is reviewed in some fashion by a moderator.

application.moderationConfiguration.dictionaryTags [Array<String>] Available since 3.12.0

A list of dictionary tags to apply to moderation actions using this application.

Tags will cause the filter to throw out matches that exactly match dictionary words with any of the tags in this list.

application.moderationConfiguration.emailFilterMaxLength [Integer]

This parameter specifies the maximum length that a match can be in order to be considered an email. If the match length is greater than the maximum match length the match will be ignored.

application.moderationConfiguration.emailFilterSpacePenalty [Double]

This parameter specifies a penalty applied to the quality score if the match contains any spaces. For example, user@ example.com contains a space so the space penalty value will be added to the quality score. The email space penalty is applied once regardless of the number of spaces found in the match.

application.moderationConfiguration.emailOnAlerts [Boolean]

Set this parameter to true to email moderators for content alerts.

application.moderationConfiguration.emailOnContentFlagged [Boolean]

Set this parameter to true to email moderators when content is flagged.

application.moderationConfiguration.emailOnUserFlagged [Boolean]

Set this parameter to true to email moderators when users are flagged.

application.moderationConfiguration.emailRules [Array]

The email filter rules. You must supply exactly three rules. Each rule must provide a score value which is the inclusive cutoff score for an email match. The rules correspond to a High, Medium and Low quality filter rule. In the Management Interface these rules are referenced as High, Medium and Low.

For example, the following are the default email rules:

{
  "emailRules": [
    {
      "score": 90,
      "action": "allow"
    },
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 40,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.emailRules[x].action [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.emailRules[x].alertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.emailRules[x].score [Integer]

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.emailRules[x].userScoreAdjustment [Integer]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules [Array]

The list of blacklist filter rules.

application.moderationConfiguration.filterRules[x].tags [Array<String>]

The blacklist tags for this filter rule. A filter rule may have one or more tags.

application.moderationConfiguration.filterRules[x].locales [Array<String>]

The match locales. If this parameter is omitted the filter rule will apply to all locales. See Locales.

application.moderationConfiguration.filterRules[x].mildAction [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].mildAlertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].mildUserScoreAdjustment [String]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules[x].mediumAction [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].mediumAlertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].mediumUserScoreAdjustment [String]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules[x].highAction [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].highAlertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].highUserScoreAdjustment [String]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.filterRules[x].severeAction [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.filterRules[x].severeAlertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.filterRules[x].severeUserScoreAdjustment [String]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.ignorableCharacters [String] Available since 3.22.0

The list list of characters the filter can skip over to find a match.

Specifically, this feature will catch any blacklist word even if separated by a single character on this list. Example: SxMxUxRxF Note: only the same letter may be used to separate the characters throughout the word and only one ignored character in a row is permitted.

application.moderationConfiguration.imageConfiguration [Object]

The image moderation configuration object. This parameter and all nested parameters are only valid when imageOnly is set to true.

application.moderationConfiguration.imageConfiguration.commitDelay [Integer]

The number of seconds to wait before a moderation decision made from the enhanced image moderation queue is committed.

application.moderationConfiguration.imageConfiguration.darkMode [Boolean]

Set this parameter to 'false' to disable the dark mode theme when viewing the enhanced image moderation queue.

application.moderationConfiguration.imageConfiguration.defaultTimerDuration [Integer]

The number of seconds each image will be displayed in the queue before advancing to the next image when the queue is set to automatically advance without keyboard interaction. This value is the default value for this application for all moderators. A moderator may change this value for their own user preference.

application.moderationConfiguration.imageConfiguration.speedModerationLayout [Boolean]

Set this parameter to false to disable the enhanced image moderation queue layout and use the legacy mode.

application.moderationConfiguration.imageOnly [Boolean]

Set this parameter to true to enable this application for image only moderation. When this parameter is set to true the imageConfiguration parameters are used to provide additional configuration.

application.moderationConfiguration.imageFilteringEnabled [Integer] Optinoal

Set to true if you want to enable third party image filtering. (The provider and credentials must be configured in the system configuration first!)

application.moderationConfiguration.imageQualityFilterRules [Array] Optional

A list of 3 quality filter rules corresponding to high, medium, and low quality.

For example, the following are the default imageQualityFilterRules:

{
  "imageQualityFilterRules": [
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 30,
      "action": "allow"
    },
    {
      "score": 0,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.imageQualityFilterRules[x].action [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.imageQualityFilterRules[x].alertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.imageQualityFilterRules[x].score [Integer]

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.imageQualityFilterRules[x].userScoreAdjustment [Integer] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.maximumVideoFilterDurationInSeconds [Integer] Optional defaults to 300

The maximum amount of time a video filter request is allowed to take in seconds.

application.moderationConfiguration.noRuleUserScoreAdjustment [Integer]

This score adjustment is used when the content did not match any rules. This value may be a positive or negative integer.

This may be used to increase a user score based upon good behavior, i.e. sending in content that did not contain any profanity. In this use case, you would provide a positive value for the adjustment.

This adjustment will only affect the user score while it is below 0. Once the user score is raised to 0 this adjustment will be ignored.

application.moderationConfiguration.persistent [Boolean]

Set this parameter to true to indicate the content type is persistent, false indicates this content is transient.

Persistent content is defined as content that is likely displayed indefinitely. A user can go and look at this content in the future by browsing a forum or performing a content search. Examples of persistent content include forum posts, profile pictures, etc. Persist content can be edited, deleted and pre-approved.

Transient content is defined as content that is displayed for a short period of time and then is likely gone forever. Transient content is usually synonymous with chat. This content cannot be pre-approved, edited or deleted.

Please note that both transient and persistent content in this context are persisted to the database.

application.moderationConfiguration.phoneNumberFilterMaxLength [Integer]

This parameter specifies the maximum length that a match can be in order to be considered an phone number. If the match length is greater than the maximum match length the match will be ignored.

application.moderationConfiguration.phoneNumberFilterMinLength [Integer]

This parameter specifies the minimum length that a match can be in order to be considered a phone number. The default value covers most world wide phone number formats.

application.moderationConfiguration.phoneNumberFilterSeparatorPenalty [Double]

This parameter specifies a penalty that is applied to the quality score for a match if it contains any type of separator other than a dash or parenthesis. For example, 303;555;1234 contains two penalized separators so the separator penalty will be multiplied by the number of separators and added to the quality score.

application.moderationConfiguration.phoneNumberFilterSpacePenalty [Double]

This parameter specifies a penalty that is applied to the quality score for a match if it contains one or more spaces. For example, 303 555 1234 contains two spaces so the space penalty will be multiplied by the number of spaces and added to the quality score.

application.moderationConfiguration.phoneNumberFilterWordPenalty [Double]

This parameter specifies a penalty that is applied to the quality score for a match if it contains any words rather than digits. For example, three zero three 555 1234 contains three words so the word penalty will be multiplied by the number of words and added to the quality score.

application.moderationConfiguration.phoneNumberRules [Array]

The phone number filter rules. You must supply exactly three rules. Each rule must provide a score value which is the inclusive cutoff score for a phone number match. The rules correspond to a High, Medium and Low quality filter rule. In the Management Interface these rules are referenced as High, Medium and Low.

For example, the following are the default phone number rules:

{
  "phoneNumberRules": [
    {
      "score": 90,
      "action": "allow"
    },
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 40,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.phoneNumberRules[x].action [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.phoneNumberRules[x].alertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.phoneNumberRules[x].score [Integer]

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.phoneNumberRules[x].userScoreAdjustment [Integer]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.queuePersistentContent [Boolean]

Set this to true in order to asynchronously store persistent content. This may improve performance but there is a potential for data loss if an outage occurs before all content is committed to the database. Please consult with Inversoft Support if you are unsure how to use this feature.

application.moderationConfiguration.replacementCharacter [String]

The character used during match replacement. If this value is set it will take precedence over replacementString.

application.moderationConfiguration.replacementString [String]

The string used during match replacement. If neither replacementString or replacementCharacter are defined the default replacement character * will be utilized.

application.moderationConfiguration.returnFilterMatches [Boolean] Available since 3.9.1

This parameter specifies if filter matches will be returned in the Moderate Content API response.

application.moderationConfiguration.rules [Object]

The rules object. This object contains the Username Filter and Whitelist Filter rules.

application.moderationConfiguration.storeContent [Boolean]

Set this parameter to true in order to store content in the database. In order to take advantage of many of the advanced CleanSpeak moderation features you’ll need to store content.

application.moderationConfiguration.unicodeFilterRule.action [String] Available since 3.22.0

The filter action for the unicode filter. Allowed options are allow or reject.

The unicode filter rejects content if it contains prohibited unicode ranges.

application.moderationConfiguration.unicodeFilterRule.data [String] Available since 3.22.0

The unicode filter configuration represented as a dsl of ranges.

The ranges are described as a string of lines that may contain * Empty lines * Comments (a line starting with #) * Unicode ranges (A unicode codepoint is of the form \u0000 or \u{0} (Json unicode notation)) Ex: \u0000-\u{F}

A special condition is that the final unicode range may be an open range meaning the second unicode point is omitted.

Note: The ranges are inclusive so \u0000-\u000F includes the character \u000F

Note 2: The provided config may change between versions.

application.moderationConfiguration.urlFilterMaxLength [Integer]

This parameter specifies the maximum length that a match can be in order to be considered a url. If the match length is greater than the maximum match length the match will be ignored.

application.moderationConfiguration.urlFilterSpacePenalty [Double]

This parameter specifies a penalty that is applied to the quality score for a match if it contains one or more spaces. For example, www .ex a m ple .com contains spaces so the space penalty will added to the quality score.

application.moderationConfiguration.urlRules [Array]

The url filter rules. You must supply exactly three rules. Each rule must provide a score value which is the inclusive cutoff score for a url match. The rules correspond to a High, Medium and Low quality filter rule. In the Management Interface these rules are referenced as High, Medium and Low.

For example, the following are the default url rules:

{
  "urlRules": [
    {
      "score": 90,
      "action": "allow"
    },
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 40,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.urlRules[x].action [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.urlRules[x].alertType [String]

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.urlRules[x].score [Integer]

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest url filter rule score the rule will be applied.

application.moderationConfiguration.urlRules[x].userScoreAdjustment [Integer]

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

application.moderationConfiguration.userCheckOutMinutes [Integer]

The number of minutes a Content User is checked out for before it is automatically released to be eligible for another moderator to check out.

application.moderationConfiguration.userFlagUserScoreAdjustment [Integer]

The amount the User score is adjusted when the user is flagged. This value may be a positive or negative integer.

application.moderationConfiguration.videoFilteringEnabled [Integer] Optinoal

Set to true if you want to enable third party video filtering. (The provider and credentials must be configured in the system configuration first!)

application.moderationConfiguration.videoQualityFilterRules [Array] Optional

A list of 3 quality filter rules corresponding to high, medium, and low quality.

For example, the following are the default videoQualityFilterRules:

{
  "videoQualityFilterRules": [
    {
      "score": 70,
      "action": "allow"
    },
    {
      "score": 30,
      "action": "allow"
    },
    {
      "score": 0,
      "action": "allow"
    }
  ]
}

application.moderationConfiguration.videoQualityFilterRules[x].action [String]

The action to be taken when this filter rule is applied. The possible values are:

  • allow

  • authorOnly

  • replace

  • queuedForApproval (Valid when storeContent and persistent are both set to true)

  • reject

The filter action must be equal to or less than the action for the next highest rule. For example if the high quality rule is set to allow then the only valid action for medium and lower quality matches is allow. This rule follows the general idea that there would be no reason to allow a high quality match but reject a low quality match.

application.moderationConfiguration.videoQualityFilterRules[x].alertType [String] Optional

The type of alert to be generated when this filter rule is applied. Omit this parameter to indicate no alert should be generated. The possible values are:

  • Content

  • User

application.moderationConfiguration.videoQualityFilterRules[x].score [Integer]

The quality score threshold for this rule. If a match score is greater than or equal to this number and less then the next highest filter rule score the rule will be applied.

application.moderationConfiguration.videoQualityFilterRules[x].userScoreAdjustment [Integer] Optional

The amount the User score is adjusted when this filter rule is applied. This value may be a positive or negative integer.

applicaiton.notificationServers [Array] Optional

A list of notification servers to use on an application. (This will create new notification servers every time)

Note: In the frontend, Notification Servers are now called Webhooks.

(See Handling Notifications for more details)

applicaiton.notificationServers[x].connectTimeout [Integer] Optional Defaults to 1000

The maximum amount of time a server will take to try to connect in milliseconds.

application.notificationServers[x].readTimeout [Integer] Optional Defaults to 2000

The maximum amount of time any read call will wait for data to flow.

application.notificationServers[x].httpAuthenticationPassword [String] Optional

A password to supply on the notification request.

application.notificationServers[x].httpAuthenticationUsername [String] Optional

A username to supply on the notification request.

applicaiton.notificationServers[x].sslCertificate [String] Optional

An ssl client certificate to present on the notification request.

application.notificationServers[x].url [String]

The url of a server listening for notifications.

Example Response JSON
{
  "application": {
    "id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
    "moderationConfiguration": {
      "approvalCheckOutMinutes": 10,
      "approvalQueueSize": 30,
      "archiveConfiguration": {
        "deleteOnly": true,
        "enabled": false
      },
      "contentAlertCheckOutMinutes": 10,
      "contentAlertQueueSize": 30,
      "contentDeletable": true,
      "contentEditable": true,
      "contentFlagAlertType": "User",
      "contentFlagUserScoreAdjustment": -3,
      "contentUserActionsEnabled": true,
      "ignorableCharacters": "qxz",
      "imageConfiguration": {
        "commitDelay": 45,
        "darkMode": true,
        "defaultTimerDuration": 2.0,
        "speedModerationLayout": true
      },
      "imageFilteringEnabled": false,
      "imageQualityFilterRules": [
        {
          "action": "allow",
          "score": 70
        },
        {
          "action": "allow",
          "score": 30
        },
        {
          "action": "allow",
          "score": 0
        }
      ],
      "maximumVideoFilterDurationInSeconds": 300,
      "videoFilteringEnabled": false,
      "videoQualityFilterRules": [
        {
          "action": "allow",
          "score": 70,
          "userScoreAdjustment": 0
        },
        {
          "action": "allow",
          "score": 30,
          "userScoreAdjustment": 0
        },
        {
          "action": "allow",
          "score": 0,
          "userScoreAdjustment": 0
        }
      ],
      "defaultActionIsQueueForApproval": false,
      "dictionaryTags": [
        "whitelistA"
      ],
      "emailOnAlerts": false,
      "emailOnContentFlagged": false,
      "emailOnEscalations": false,
      "emailOnUserFlagged": false,
      "emailRules": [
        {
          "action": "allow",
          "score": 90
        },
        {
          "score": 70,
          "action": "allow"
        },
        {
          "score": 40,
          "action": "allow"
        }
      ],
      "filterRules": [
        {
          "severeAlertType": "User",
          "highAction": "replace",
          "mildAction": "allow",
          "severeAction": "reject",
          "tags": [
            "Vulgarity"
          ],
          "mediumAction": "replace",
          "highAlertType": "User",
          "highUserScoreAdjustment": -25,
          "severeUserScoreAdjustment": -50
        },
        {
          "highAlertType": "User",
          "mildAction": "allow",
          "severeAction": "reject",
          "tags": [
            "Bullying"
          ],
          "highAction": "allow",
          "mediumAction": "allow"
        }
      ],
      "imageOnly": false,
      "persistent": true,
      "phoneNumberRules": [
        {
          "action": "allow",
          "score": 90,
          "userScoreAdjustment": -10
        },
        {
          "alertType": "Content",
          "userScoreAdjustment": -5,
          "score": 70,
          "action": "allow"
        },
        {
          "score": 40,
          "alertType": "User",
          "userScoreAdjustment": -1,
          "action": "allow"
        }
      ],
      "queuePersistentContent": false,
      "returnFilterMatches": false,
      "rules": {
        "usernameFilterRule": {
          "action": "reject",
          "enabled": false
        },
        "whitelistFilterRules": {
          "disallowedPhrase": {
            "action": "allow"
          },
          "disallowedWord": {
            "action": "allow"
          }
        }
      },
      "storeContent": true,
      "urlRules": [
        {
          "score": 90,
          "action": "allow"
        },
        {
          "action": "allow",
          "score": 70
        },
        {
          "score": 40,
          "action": "allow"
        }
      ],
      "userCheckOutMinutes": 10,
      "userFlagUserScoreAdjustment": -3
    },
    "name": "Chat",
    "notificationServers": [
      {
        "connectTimeout": 1000,
        "id": 21,
        "url": "http://chat.example.com/notification-handler",
        "readTimeout": 2000
      }
    ]
  }
}

5. Delete an Application

This API is used to delete a CleanSpeak application.

Warning Deleting an application from CleanSpeak removes all of the configuration, content, history, users and any other data associated with that application. This operation is permanent and cannot be undone. If you have a large amount of content associated with this application the operation may take a considerable amount of time to complete.

5.1. Request

URI

DELETE /system/application/{applicationId}

Table 12. Request Parameters

applicationId [UUID] Required

The Id of the Application to delete.

5.2. Response

Table 13. Response Codes
Code Description

200

The request was successful. The response will be empty.

400

The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors.

401

You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

402

Your license has expired. The response will be empty. Contact sales@inversoft.com for assistance.

404

The object you are trying to delete doesn’t exist. The response will be empty.

500

There was an internal error. A stack trace is provided and logged in the CleanSpeak log files. The response will be empty.