Whitelist/Blacklist

Add Whitelist/Blacklist Rule for Calling Number

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

Request Body:

{
  "whiteBlackListCallingNumber": {
    "callingNumber": "CALLING_NUMBER_PREFIX_HERE",
    "action": "ACTION_HERE: whitelist, blacklist, continue, bypass-fraud-control, divert",
    "comment": "COMMENT_HERE",
    "calledNumber": "OPTIONAL_CALLED_NUMBER_HERE",
    "operator": "OPERATOR_ID_HERE",
    "sbc": "OPTIONAL_SBC_ID_HERE",
    "serviceProvider": "OPTIONAL_SERVICE_PROVIDER_ID_HERE",
    "group": "OPTIONAL_GROUP_ID_HERE",
    "user": "OPTIONAL_USER_ID_HERE",
    "calledCountry": "OPTIONAL_CALLED_COUNTRY_ID_HERE"
  }
}

Response Body:

{
  "whiteBlackListCallingNumbers": [
    {
      "createdAt": CREATED_AT_UNIX_TIME_HERE,,
      "updatedAt": UPDATED_AT_UNIX_TIME_HERE,,
      "id": "WHITELIST_BLACKLIST_RECORD_ID_HERE",
      "callingNumber": "CALLING_NUMBER_PREFIX_HERE",
      "action": "ACTION_HERE",
      "comment": "COMMENT_HERE",
      "calledNumber": "OPTIONAL_CALLED_NUMBER_HERE",
      "operator": "OPERATOR_ID_HERE",
      "sbc": "OPTIONAL_SBC_ID_HERE",
      "serviceProvider": "OPTIONAL_SERVICE_PROVIDER_ID_HERE",
      "group": "OPTIONAL_GROUP_ID_HERE",
      "user": "OPTIONAL_USER_ID_HERE",
      "calledCountry": "OPTIONAL_CALLED_COUNTRY_ID_HERE"
    }
  ]
}

Example Request: Blacklist Specific Calling Number

{
  "whiteBlackListCallingNumber": {
    "callingNumber": "14045266060",
    "action": "blacklist",
    "comment": "",
    "calledNumber": "",
    "operator": "99999999-9999-4999-9999-999999999999",
    "sbc": null,
    "serviceProvider": null,
    "group": null,
    "user": null,
    "calledCountry": null
  }
}

Example Response: Blacklist Specific Calling Number

{
  "whiteBlackListCallingNumbers": [
    {
      "createdAt": 1577836800000,
      "updatedAt": 1577836800000,
      "id": "99999999-9999-4999-9999-999999999999",
      "callingNumber": "14045266060",
      "action": "blacklist",
      "comment": "",
      "calledNumber": "",
      "operator": "99999999-9999-4999-9999-999999999999",
      "sbc": null,
      "serviceProvider": null,
      "group": null,
      "user": null,
      "calledCountry": null
    }
  ]
}

Add Whitelist/Blacklist Rule for Called Number

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

Request Body:

{
  "whiteBlackListCalledNumber": {
    "calledNumber": "CALLED_NUMBER_PREFIX_HERE",
    "action": "ACTION_HERE: whitelist, blacklist, continue, bypass-fraud-control, divert",
    "comment": "COMMENT_HERE",
    "callingNumber": "OPTIONAL_CALLING_NUMBER_HERE",
    "operator": "OPERATOR_ID_HERE",
    "sbc": "OPTIONAL_SBC_ID_HERE",
    "serviceProvider": "OPTIONAL_SERVICE_PROVIDER_ID_HERE",
    "group": "OPTIONAL_GROUP_ID_HERE",
    "user": "OPTIONAL_USER_ID_HERE",
    "callingCountry": "OPTIONAL_CALLING_COUNTRY_ID_HERE"
  }
}

Response Body:

{
  "whiteBlackListCalledNumbers": [
    {
      "createdAt": CREATED_AT_UNIX_TIME_HERE,
      "updatedAt": UPDATED_AT_UNIX_TIME_HERE,
      "id": "WHITELIST_BLACKLIST_RECORD_ID_HERE",
      "calledNumber": "CALLED_NUMBER_PREFIX_HERE",
      "action": "ACTION_HERE",
      "comment": "COMMENT_HERE",
      "callingNumber": "OPTIONAL_CALLING_NUMBER_HERE",
      "operator": "OPERATOR_ID_HERE",
      "sbc": "OPTIONAL_SBC_ID_HERE",
      "serviceProvider": "OPTIONAL_SERVICE_PROVIDER_ID_HERE",
      "group": "OPTIONAL_GROUP_ID_HERE",
      "user": "OPTIONAL_USER_ID_HERE",
      "callingCountry": "OPTIONAL_CALLING_COUNTRY_ID_HERE"
    }
  ]
}