CDR Obfuscation Profiles
These APIs enable Super Admins to manage the Call Detail Record (CDR) obfuscation profiles. An obfuscation profile indicates what data should be obfuscated in the CDR for each Tenant.
Super Admins can also create a default Obfuscation Profile via the REST APIs.
This customizability is especially useful for healthcare and GDPR customers who must follow strict guidelines on storing Personally Identifiable Information (PII).
Create System CDR Obfuscation Profile
URL: /admin/api/v1/system/tenants/cdr/obfuscation/profiles
Method: POST
Parameters
No parameters.
Request body
{
"obfuscationLevel": "GUESTS",
"fields": [
"callerName"
]
}
Success response
In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.
Sample JSON response
{
"version": "1",
"status": "success",
"data": {
"id": 1,
"tenantId": 0,
"obfuscationLevel": "GUESTS",
"fields": [
"callerName"
]
}
}
Error responses
|
HTTP response code |
Error message |
|---|---|
|
400 |
Bad request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
500 |
Internal server error |
Get All System CDR Obfuscation Profiles
URL: /admin/api/v1/system/tenants/cdr/obfuscation/profiles
Method: GET
Parameters
No parameters.
Success response
In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.
Sample JSON response
{
"version": "1",
"status": "success",
"data": {
"id": 1,
"tenantId": 0,
"obfuscationLevel": "GUESTS",
"fields": [
"callerName"
]
}
}
Error responses
|
HTTP response code |
Error message |
|---|---|
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
500 |
Internal server error |
Force Update All CDR Obfuscation Profiles with Specified Obfuscation Level
URL: /admin/api/v1/system/tenants/cdr/obfuscation/profiles
Method: PUT
Parameters
No parameters.
Request body
{
"obfuscationLevel": "GUESTS",
"fields": [
"callerName"
]
}
Success response
In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.
Sample JSON response
{
"version": "1",
"status": "success",
"data": {
"id": 1,
"tenantId": 0,
"obfuscationLevel": "GUESTS",
"fields": [
"callerName"
]
}
}
Error responses
|
HTTP response code |
Error message |
|---|---|
|
400 |
Bad request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
500 |
Internal server error |
Update System CDR Obfuscation Profiles
URL: /admin/api/v1/system/tenants/cdr/obfuscation/profiles/{profileId}
Method: PUT
Parameters
|
Field |
Data type |
Mandatory |
Description |
|---|---|---|---|
|
profileId |
Integer |
Y |
CDR obfuscation profile to update. |
Request body
{
"obfuscationLevel": "GUESTS",
"fields": [
"callerName"
]
}
Success response
In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.
Sample JSON response
{
"version": "1",
"status": "success",
"data": {
"id": 1,
"tenantId": 0,
"obfuscationLevel": "GUESTS",
"fields": [
"callerName"
]
}
}
Error responses
|
HTTP response code |
Error message |
|---|---|
|
400 |
Bad request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
500 |
Internal server error |
Get System CDR Obfuscation Profile
URL: /admin/api/v1/system/tenants/cdr/obfuscation/profiles/{profileId}
Method: GET
Parameters
|
Field |
Data type |
Mandatory |
Description |
|---|---|---|---|
|
profileId |
Integer |
Y |
CDR obfuscation profile to read. |
Success response
In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.
Sample JSON response
{
"version": "1",
"status": "success",
"data": {
"id": 1,
"tenantId": 0,
"obfuscationLevel": "GUESTS",
"fields": [
"callerName"
]
}
}
Error responses
|
HTTP response code |
Error message |
|---|---|
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
500 |
Internal server error |
Delete System CDR Obfuscation Profile
URL: /admin/api/v1/system/tenants/cdr/obfuscation/profiles/{profileId}
Method: DELETE
Parameters
|
Field |
Data type |
Mandatory |
Description |
|---|---|---|---|
|
profileId |
Integer |
Y |
CDR obfuscation profile to delete. |
Success response
In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.
Sample JSON response
{
"version": "1",
"status": "success",
"data": {}
}
Error responses
|
HTTP response code |
Error message |
|---|---|
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
500 |
Internal server error |
Create Tenant CDR Obfuscation Profile
URL: /admin/api/v1/tenants/{tenantId}/cdr/obfuscation/profiles
Method: POST
Parameters
|
Field |
Data type |
Mandatory |
Description |
|---|---|---|---|
|
tenantId |
String |
Y |
Tenant ID or Tenant FQDN. |
Request body
{
"obfuscationLevel": "GUESTS",
"fields": [
"callerName"
]
}
Success response
In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.
Sample JSON response
{
"version": "1",
"status": "success",
"data": {
"id": 1,
"tenantId": 0,
"obfuscationLevel": "GUESTS",
"fields": [
"callerName"
]
}
}
Error responses
|
HTTP response code |
Error message |
|---|---|
|
400 |
Bad request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
500 |
Internal server error |
Get All Tenant CDR Obfuscation Profiles
URL: /admin/api/v1/tenants/{tenantId}/cdr/obfuscation/profiles
Method: GET
Parameters
|
Field |
Data type |
Mandatory |
Description |
|---|---|---|---|
|
tenantId |
String |
Y |
Tenant ID or Tenant FQDN. |
Success response
In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.
Sample JSON response
{
"version": "1",
"status": "success",
"data": {
"id": 1,
"tenantId": 0,
"obfuscationLevel": "GUESTS",
"fields": [
"callerName"
]
}
}
Error responses
|
HTTP response code |
Error message |
|---|---|
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
500 |
Internal server error |
Update Tenant CDR Obfuscation Profile
URL: /admin/api/v1/tenants/{tenantId}/cdr/obfuscation/profiles/{profileId}
Method: PUT
Parameters
|
Field |
Data type |
Mandatory |
Description |
|---|---|---|---|
|
tenantId |
String |
Y |
Tenant ID or Tenant FQDN. |
|
profileId |
Integer |
Y |
CDR obfuscation profile to update. |
Request body
{
"obfuscationLevel": "GUESTS",
"fields": [
"callerName"
]
}
Success response
In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.
Sample JSON response
{
"version": "1",
"status": "success",
"data": {
"id": 1,
"tenantId": 0,
"obfuscationLevel": "GUESTS",
"fields": [
"callerName"
]
}
}
Error responses
|
HTTP response code |
Error message |
|---|---|
|
400 |
Bad request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
500 |
Internal server error |
Get Tenant CDR Obfuscation Profile
URL: /admin/api/v1/tenants/{tenantId}/cdr/obfuscation/profiles/{profileId}
Method: PUT
Parameters
|
Field |
Data type |
Mandatory |
Description |
|---|---|---|---|
|
tenantId |
String |
Y |
Tenant ID or Tenant FQDN. |
|
profileId |
Integer |
Y |
CDR obfuscation profile to read. |
Success response
In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.
Sample JSON response
{
"version": "1",
"status": "success",
"data": {
"id": 1,
"tenantId": 0,
"obfuscationLevel": "GUESTS",
"fields": [
"callerName"
]
}
}
Error responses
|
HTTP response code |
Error message |
|---|---|
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
500 |
Internal server error |
Delete Tenant CDR Obfuscation Profile
URL: /admin/api/v1/tenants/{tenantId}/cdr/obfuscation/profiles/{profileId}
Method: DELETE
Parameters
|
Field |
Data type |
Mandatory |
Description |
|---|---|---|---|
|
tenantId |
String |
Y |
Tenant ID or Tenant FQDN. |
|
profileId |
Integer |
Y |
CDR obfuscation profile to delete. |
Success response
In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.
Sample JSON response
{
"version": "1",
"status": "success",
"data": {}
}
Error responses
|
HTTP response code |
Error message |
|---|---|
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not found |
|
500 |
Internal server error |
Get CDR Fields that Can Be Obfuscated
URL: /admin/api/v1/system/tenants/cdr/obfuscation/fields
Method: GET
Parameters
No parameters.
Success response
In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.
Sample JSON response
{
"version": "1",
"status": "success",
"data": [
{
"fieldName": "callerName"
}
]
}
Error responses
|
HTTP response code |
Error message |
|---|---|
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
500 |
Internal server error |