Remote Office Services

Display user’s remote office

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

Retrieve the settings of the Remote Office service of the user.

Example request:

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

Example response:

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

{
     "active": true
     "phoneNumber": "+323216549054"
}
Response JSON Object:

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

  • phoneNumber (string) – The remote phone number or the SIP-URI.

Status Codes:

Update a user’s remote office

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

Update the settings of the Remote Office service of the user.

Example request:

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

{
     "active": true
     "phoneNumber": "+32321654920"
}
Request JSON Object:

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

  • phoneNumber (string) – The remote phone number or the SIP-URI.

Example response:

Response:

Similar to GET instance method response.

Status Codes: