Close Visiba Triage

POST /api/v1/accessControl/close

Description

Close Visiba Triage for incoming users. NOTE: This only affects users when configuration type OPEN is used.

Request Parameters (body)

Name	Description	Required	Type	Default Value
closedReason	Reason it is being closed	Yes	ClosedReason

Response

HTTP Status Codes

Code	Description
200	Success, returns a AccessInfo
401	Unauthorized, missing X-Red-Robin-API-Key header
403	Forbidden, invalid X-Red-Robin-API-Key header
404	Not found, invalid configuration

AccessInfo

Name	Description	Type	Example
active	Active state of account	boolean	true
open	Open state of account	boolean	false
closedReason,null	An enum describing the reason for closed	ClosedReason	0

Enums

ClosedReason

String value	Description
Other	Other reason for closed
OutsideMonitoredHours	Outside monitored hours, e.g. the queue is not currently staffed
CapLimitReached	Maximum amount of sessions reached

Example Usage

Javascript

POST /api/v1/accessControl/close

const headers = new Headers();
headers.append('X-Red-Robin-API-Key', 'API_KEY');
headers.append('Content-Type', 'application/json');

const requestOptions = {
	method: 'POST',
	headers: headers,
	body: JSON.stringify({ ClosedReason: 0 }),
};

fetch('https://se.visibatriage.com/api/v1/accessControl/close', requestOptions)
	.then((response) => response.text())
	.then((result) => console.log(result))
	.catch((error) => console.log('error', error));

Example Success Response

{
	"active": true
	"open": false
	"closedReason": 0
}