Privacy Service

The service users are: Call Centers, IVRs, Hunt Groups and Route Points.

Display service user’s Privacy service

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/service_users/(string: user_id)/services/privacy/

Retrieve the configuration of the Privacy service of the service user.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/service_users/foouser/services/privacy/ HTTP/1.1
Host: example.com

{}

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
  "directoryPrivacy": true,
  "ivrExtensionDialingPrivacy": true,
  "ivrNameDialingPrivacy": true
}
Response JSON Object:

  • directoryPrivacy (boolean) – When set, when somebody does a directory listing, the service user’s name and number do not appear. When unset, the service user’s information appears as usual.

  • ivrExtensionDialingPrivacy (boolean) – When set, the service user is unreachable through IVR extension dialing.

  • ivrNameDialingPrivacy (boolean) – When set, the service user is unreachable through IVR name dialing.

Status Codes:

Modify service user’s Privacy service

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/service_users/(string: user_id)/services/privacy/

Update the configuration of the Privacy service of the service user.

Authorization rights: minimum Group Admin.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/service_users/foouser/services/privacy/ HTTP/1.1
Host: example.com

{
  "directoryPrivacy": true,
  "ivrExtensionDialingPrivacy": false,
  "ivrNameDialingPrivacy": false
}
Request JSON Object:

  • directoryPrivacy (boolean) – When set, when somebody does a directory listing, the service user’s name and number do not appear. When unset, the service user’s information appears as usual.

  • ivrExtensionDialingPrivacy (boolean) – When set, the service user is unreachable through IVR extension dialing.

  • ivrNameDialingPrivacy (boolean) – When set, the service user is unreachable through IVR name dialing.

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
  "directoryPrivacy": true,
  "ivrExtensionDialingPrivacy": false,
  "ivrNameDialingPrivacy": false
}
Response JSON Object:

  • directoryPrivacy (boolean) – When set, when somebody does a directory listing, the service user’s name and number do not appear. When unset, the service user’s information appears as usual.

  • ivrExtensionDialingPrivacy (boolean) – When set, the service user is unreachable through IVR extension dialing.

  • ivrNameDialingPrivacy (boolean) – When set, the service user is unreachable through IVR name dialing.

Status Codes: