Instant Messaging & Presence¶
Display group’s instant messaging & presence¶
-
GET
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/services/instant_messaging_presence/
¶ Retrieve the settings of the Instant Messaging & Presence service of the group.
Authorization rights: minimum Group Admin.
Example request:
GET /api/v1/tenants/foo/groups/foogroup/services/instant_messaging_presence/ HTTP/1.1 Host: example.com
Example response:
HTTP/1.1 200 OK Content-Type: "application/json" { "useTenantSetting": false, "serviceDomain": "fooGroup" }
- Response JSON Object:
useTenantSetting (boolean) – use the tenant setting.
serviceDomain (string) – the domain of service for this Group if not using the Tenant one.
- Status Codes:
200 OK – no error
Update a group’s instant messaging & presence¶
-
PUT
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/services/instant_messaging_presence/
¶ Update the settings of the Instant Messaging & Presence service of the group.
Authorization rights: minimum Group Admin.
Example request:
PUT /api/v1/tenants/foo/groups/foogroup/services/instant_messaging_presence/ HTTP/1.1 Host: example.com Content-Type: "application/json" { "useTenantSetting": false, "serviceDomain": "fooGroup" }
- Request JSON Object:
useTenantSetting (boolean) – use the tenant setting.
serviceDomain (string) – the domain of service for this Group if not using the Tenant one.
Example response:
HTTP/1.1 200 OK
- Status Codes:
200 OK – no error
400 Bad Request – invalid data