Fraud

Targeted Pumping By User And Calling Number Triggers

Add Targeted Pumping By User And Calling Number Trigger

Method: POST URL: https://api.clearip.com/targetedPumpingByUserAndCallingNumberTriggers

Request Body:

{
  "targetedPumpingByUserAndCallingNumberTrigger": {
    "action": "ACTION_HERE: report-only, block, divert",
    "actionTime": "ACTION_TIME_IN_MINUTES_HERE",
    "status": "STATUS_HERE: enabled, disabled",
    "adjustmentFactor": "ADJUSTMENT_FACTOR_DOUBLE_HERE",
    "minimumFraudScoreThreshold": "MINIMUM_FRAUD_SCORE_THRESHOLD_DOUBLE_HERE",
    "defaultFraudScoreThreshold": "DEFAULT_FRAUD_SCORE_THRESHOLD_DOUBLE_HERE",
    "callingNumber": "OPTIONAL_CALLED_NUMBER_HERE",
    "callingNumber": "OPTIONAL_CALLING_NUMBER_PREFIX_HERE",
    "alertEmail": "OPTIONAL_ALERT_EMAIL_HERE",
    "alertPhone": "OPTIONAL_ALERT_PHONE_HERE",
    "alertUrl": "OPTIONAL_ALERT_URL_HERE",
    "serviceProvider": "OPTIONAL_SERVICE_PROVIDER_ID_HERE",
    "group": "OPTIONAL_GROUP_ID_HERE",
    "user": "OPTIONAL_USER_ID_HERE",
    "comment": "COMMENT_HERE"
  }
}

Example Response Body:

{
  "targetedPumpingByUserAndCallingNumberTriggers": [
    {
      "createdAt": 1577836800000,
      "updatedAt": 1577836800000,
      "id": "99999999-9999-4999-9999-999999999999",
      "adjustmentFactor": 5.6,
      "minimumFraudScoreThreshold": 1,
      "defaultFraudScoreThreshold": 1,
      "actionTime": 60,
      "alertEmail": "",
      "alertPhone": "",
      "alertUrl": "",
      "status": "enabled",
      "action": "block",
      "comment": "",
      "callingNumber": "",
      "calledNumber": "",
      "reseller": "99999999-9999-4999-9999-999999999999",
      "operator": "99999999-9999-4999-9999-999999999999",
      "serviceProvider": "99999999-9999-4999-9999-999999999999",
      "group": "99999999-9999-4999-9999-999999999999",
      "user": "99999999-9999-4999-9999-999999999999"
    }
  ]
}

Delete Targeted Pumping By User And Calling Number Trigger

Method: DELETE URL: https://api.clearip.com/targetedPumpingByUserAndCallingNumberTriggers/TARGETED_PUMPING_BY_USER_AND_CALL_NUMBER_TRIGGER_ID_HERE

Example Request Method: DELETE URL: https://api.clearip.com/targetedPumpingByUserAndCallingNumberTriggers/99999999-9999-4999-9999-999999999999

Example Response:

{
  "targetedPumpingByUserAndCallingNumberTriggers": [
    {
      "createdAt": 1577836800000,
      "updatedAt": 1577836800000,
      "id": "99999999-9999-4999-9999-999999999999",
      "adjustmentFactor": 5.6,
      "minimumFraudScoreThreshold": 1,
      "defaultFraudScoreThreshold": 1,
      "actionTime": 60,
      "alertEmail": "",
      "alertPhone": "",
      "alertUrl": "",
      "status": "enabled",
      "action": "block",
      "comment": "",
      "callingNumber": "",
      "calledNumber": "",
      "reseller": "99999999-9999-4999-9999-999999999999",
      "operator": "99999999-9999-4999-9999-999999999999",
      "serviceProvider": "99999999-9999-4999-9999-999999999999",
      "group": "99999999-9999-4999-9999-999999999999",
      "user": "99999999-9999-4999-9999-999999999999"
    }
  ]
}

View Targeted Pumping By User And Calling Number Trigger

Method: GET URL: https://api.clearip.com/targetedPumpingByUserAndCallingNumberTriggers?limit=20&skip=0&sort=callingNumber

Example request: Pull Target Pumping By User and Calling Number Triggers with status of ’enabled'

Method: GET

URL: https://api.clearip.com/targetedPumpingByUserAndCallingNumberTriggers?limit=20&skip=0&sort=callingNumber%20ASC&where%5Bstatus%5D=enabled

Update Targeted Pumping By User And Calling Number Trigger

Method: PATCH URL: https://api.clearip.com/targetedPumpingByUserAndCallingNumberTriggers/TARGETED_PUMPING_BY_USER_AND_CALL_NUMBER_TRIGGER_ID_HERE

Example request: Update an existing Targeted Pumping By User and Calling Number Trigger with ID 99999999-9999-4999-9999-999999999999

Method: PATCH

URL: https://api.clearip.com/targetedPumpingByUserAndCallingNumberTriggers/99999999-9999-4999-9999-999999999999

Request Body:

{
  "targetedPumpingByUserAndCallingNumberTrigger": {
    "action": "ACTION_HERE: report-only, block, divert",
    "actionTime": "ACTION_TIME_IN_MINUTES_HERE",
    "status": "STATUS_HERE: enabled, disabled",
    "adjustmentFactor": "ADJUSTMENT_FACTOR_DOUBLE_HERE",
    "minimumFraudScoreThreshold": "MINIMUM_FRAUD_SCORE_THRESHOLD_DOUBLE_HERE",
    "defaultFraudScoreThreshold": "DEFAULT_FRAUD_SCORE_THRESHOLD_DOUBLE_HERE",
    "alertEmail": "OPTIONAL_ALERT_EMAIL_HERE",
    "alertPhone": "OPTIONAL_ALERT_PHONE_HERE",
    "alertUrl": "OPTIONAL_ALERT_URL_HERE",
    "comment": "COMMENT_HERE"
  }
}

Example Response Body:

{
  "targetedPumpingByUserAndCallingNumberTriggers": [
    {
      "createdAt": 1577836800000,
      "updatedAt": 1577836800000,
      "id": "99999999-9999-4999-9999-999999999999",
      "adjustmentFactor": 5.6,
      "minimumFraudScoreThreshold": 1,
      "defaultFraudScoreThreshold": 1,
      "actionTime": 60,
      "alertEmail": "",
      "alertPhone": "",
      "alertUrl": "",
      "status": "enabled",
      "action": "block",
      "comment": "",
      "callingNumber": "",
      "calledNumber": "",
      "reseller": "99999999-9999-4999-9999-999999999999",
      "operator": "99999999-9999-4999-9999-999999999999",
      "serviceProvider": "99999999-9999-4999-9999-999999999999",
      "group": "99999999-9999-4999-9999-999999999999",
      "user": "99999999-9999-4999-9999-999999999999"
    }
  ]
}