ClearIP Documentation

Inbound Services

Add Reputation Policy

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

Request Body:

{
  "reputationPolicy": {
    "calledNumber": "OPTIONAL_CALLED_NUMBER_PREFIX_HERE",
    "status": "STATUS_HERE: enabled, disabled",
    "action": "ACTION_HERE: report-only, block, indicate, divert",
    "reputationScoreThreshold": THRESHOLD_INTEGER_VALUE_0_TO_100,
    "comment": "COMMENT_HERE",
    "callingNumber": "OPTIONAL_CALLING_NUMBER_HERE",
    "sbc": OPTIONAL_CLEARIP_SBC_ID_HERE,
    "serviceProvider": OPTIONAL_CLEARIP_SERVICE_PROVIDER_ID_HERE,
    "group": OPTIONAL_CLEARIP_GROUP_ID_HERE,
    "user": OPTIONAL_CLEARIP_USER_ID_HERE,
    "callingCountry": OPTIONAL_CLEARIP_COUNTRY_ID_HERE
  }
}

Response Body:

{
  "reputationPolicies": [
  {
    "createdAt": CREATED_AT_UNIX_TIME_HERE,
    "updatedAt": UPDATED_AT_UNIX_TIME_HERE,
    "id": "REPUTATION_POLICY_ID_HERE",
    "calledNumber": "OPTIONAL_CALLED_NUMBER_PREFIX_HERE",
    "status": "STATUS_HERE",
    "action": "ACTION_HERE",
    "reputationScoreThreshold": THRESHOLD_INTEGER_VALUE_0_TO_100,
    "comment": "COMMENT_HERE",
    "callingNumber": "OPTIONAL_CALLING_NUMBER_HERE",
    "sbc": OPTIONAL_CLEARIP_SBC_ID_HERE,
    "serviceProvider": OPTIONAL_CLEARIP_SERVICE_PROVIDER_ID_HERE,
    "group": OPTIONAL_CLEARIP_GROUP_ID_HERE,
    "user": OPTIONAL_CLEARIP_USER_ID_HERE,
    "callingCountry": OPTIONAL_CLEARIP_COUNTRY_ID_HERE
    }
  ]
}

Update Reputation Policy

Once a Reputaion Policy is created, ClearIP does not allow for the modification of the values in the following fields: Operator, Called Number, SBC, Service Provider, Group, User, Calling Country, Calling Number.

The following fields can be updated for existing Reputation Policies: Status, Action, Reputation Score Threshold, Comment.

Method: PATCH URL: https://api.clearip.com/reputationPolicies/REPUTATION_POLICY_ID_HERE

Request Body:

{
  "reputationPolicy": {
    "status": "STATUS_HERE: enabled, disabled",
    "action": "ACTION_HERE: report-only, block, indicate, divert",
    "reputationScoreThreshold": THRESHOLD_INTEGER_VALUE_0_TO_100,
    "comment": "COMMENT_HERE",
  }
}

Response Body:

{
  "reputationPolicies": [
  {
    "createdAt": CREATED_AT_UNIX_TIME_HERE,
    "updatedAt": UPDATED_AT_UNIX_TIME_HERE,
    "id": "REPUTATION_POLICY_ID_HERE",
    "calledNumber": "OPTIONAL_CALLED_NUMBER_PREFIX_HERE",
    "status": "STATUS_HERE",
    "action": "ACTION_HERE",
    "reputationScoreThreshold": THRESHOLD_INTEGER_VALUE_0_TO_100,
    "comment": "COMMENT_HERE",
    "callingNumber": "OPTIONAL_CALLING_NUMBER_HERE",
    "sbc": OPTIONAL_CLEARIP_SBC_ID_HERE,
    "serviceProvider": OPTIONAL_CLEARIP_SERVICE_PROVIDER_ID_HERE,
    "group": OPTIONAL_CLEARIP_GROUP_ID_HERE,
    "user": OPTIONAL_CLEARIP_USER_ID_HERE,
    "callingCountry": OPTIONAL_CLEARIP_COUNTRY_ID_HERE
    }
  ]
}

Delete Reputation Policy

Method: DELETE URL: https://api.clearip.com/reputationPolicies/REPUTATION_POLICY_ID_HERE

Response Body:

{
  "reputationPolicies": [
  {
    "createdAt": CREATED_AT_UNIX_TIME_HERE,
    "updatedAt": UPDATED_AT_UNIX_TIME_HERE,
    "id": "REPUTATION_POLICY_ID_HERE",
    "calledNumber": "OPTIONAL_CALLED_NUMBER_PREFIX_HERE",
    "status": "STATUS_HERE",
    "action": "ACTION_HERE",
    "reputationScoreThreshold": THRESHOLD_INTEGER_VALUE_0_TO_100,
    "comment": "COMMENT_HERE",
    "callingNumber": "OPTIONAL_CALLING_NUMBER_HERE",
    "sbc": OPTIONAL_CLEARIP_SBC_ID_HERE,
    "serviceProvider": OPTIONAL_CLEARIP_SERVICE_PROVIDER_ID_HERE,
    "group": OPTIONAL_CLEARIP_GROUP_ID_HERE,
    "user": OPTIONAL_CLEARIP_USER_ID_HERE,
    "callingCountry": OPTIONAL_CLEARIP_COUNTRY_ID_HERE
    }
  ]
}
Inbound Services