Teams Status¶

Retrieve MS Teams Status¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/teams_status/¶

Get the details about the enabling of MS Teams at the level of the Group.

In case of Enterprise mode, if the Enterprise is onboarded, MS Teams can be enabled or disabled ofr each Group.

In case of Service Provider mode, it is the Group itself that is onboarded.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/teams_status/ HTTP/1.1
Host: example.com

Example response:

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

{
   "onboarded": true,
   "enabled": true
}

Response JSON Object:

onboarded (boolean) – The Enterprise / SP Group is onboarded.
enabled (boolean) – Teams is enabled for the Group (in case of SP Group it is redundant with onboarded).

Status Codes:

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/teams_status/¶

Update the MS Teams enabling of the Group. Only relevant for Enteprisie mode.

Example request:

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

{
   "enabled": false
}

Request JSON Object:

enabled (boolean) – (Required) Enable/disable Teams for this Enterprise Group

Example response:

Response:

Similar to GET instance method response.

Status Codes:

200 OK – no error
400 Bad Request – failed to update. It can be because it is a SP Group, because the Enterprise is not onboarded or because there are still Trunk Users or HPBX Users with Teams enabled.