Do Not Disturb Services

Display user’s do not disturb

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/dnd/

Retrieve the settings of the Do Not Disturb service of the user.

Example request:

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

Example response:

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

{
   "active": true
   "ringSplash": false
}
Response JSON Object:

  • active (boolean) – the status of the service.

  • ringSplash (boolean) – Play Ring Reminder when a call is blocked.

Status Codes:

Update a user’s do not disturb

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/dnd/

Update the settings of the Do Not Disturb service of the user.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/dnd/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "active": true
   "ringSplash": true
}
Request JSON Object:

  • active (boolean) – the status of the service.

  • ringSplash (boolean) – Play Ring Reminder when a call is blocked.

Example response:

Response:

Similar to GET instance method response.

Status Codes: