User Barge-In Exempt¶
Barge-in Exempt allows you to prohibit others from interrupting your conversations with the Barge-in service. When it is on members of your group with the Barge-in service cannot interrupt your calls. When it is off, they can.
Retrieve user’s Barge-In Exempt¶
-
GET
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/barge_in_exempt/
¶ Retrieve the settings of the Barge-In Exempt service of the user.
Authorization rights: minimum EndUser.
Example request:
GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/barge_in_exempt/ HTTP/1.1 Host: example.com
Example response:
HTTP/1.1 200 OK Content-Type: "application/json" { "active": false }
- Response JSON Object:
active (boolean) – the status of the service.
- Status Codes:
200 OK – no error
404 Not Found – service is not assigned to this user
Update user’s Barge-In Exempt¶
-
PUT
/api/v1/tenants/
(string: tenant_id)/groups/
(string: group_id)/users/
(string: user_id)/services/barge_in_exempt/
¶ Update the settings of the Barge-In Exempt service of the user.
Authorization rights: minimum EndUser.
Example request:
PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/barge_in_exempt/ HTTP/1.1 Host: example.com Content-Type: "application/json" { "active": true }
- Request JSON Object:
active (boolean) – the status of the service.
Example response:
HTTP/1.1 200 OK
- Status Codes:
200 OK – no error
400 Bad Request – invalid data
404 Not Found – service is not assigned to this user