Endpoint Behavior Mode
This is a REST-based service endpoint used to add, edit, update, and get Endpoint Behavior Mode.
Create Endpoint Behavior Mode API
This Super Admin API enables creation of Endpoint Behavior Labels/Modes for different tenants. The API supports the authentication process similar to all the other APIs in the Admin application (i.e., basic authentication). Auth tokens are not supported on this.
The API ensures that the default endpoint behaviors are not impacted or touched upon since they will be managed only from the legacy SOAP APIs.
|
Note All the API request fields which are “String” will accept and treat Boolean as a string value. |
URL: [PortalFQDN]/admin/api/v1/tenants/{tenantId or tenantFqdn}/endpoints/behaviours
Method: POST
Path variables
|
Field |
Data type |
Mandatory |
Description |
Validations |
|---|---|---|---|---|
|
tenantId / Tenant FQDN |
String |
Y |
The tenant ID or tenant FQDN for which endpoint behavior mode will be configured |
Validate if the tenant ID is a valid tenant ID or not |
JSON parameters
|
Field |
Data type |
Parent |
Mandatory |
Description |
Validations |
|---|---|---|---|---|---|
|
audioMuteControl |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
AutomaticallyUp-date |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
beautyScreen |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
bottomIframeSize |
int |
|
N |
|
Should range between 0-100 |
|
bottomIframeUrl |
String |
|
N |
|
Length should be less than or equal to 2048 |
|
cameraMute-Control |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
contentSharing |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
deviceSettings |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
displayLabels |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
enableAutoAnswer |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
endpointBehavior |
Object |
parent |
Y |
The parent object that encapsulates all the behavior attributes |
|
|
exitOnUser-Hangup |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
fullScreenVideo |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
inCallSearch |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
inviteParticipants |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
label |
String |
|
Y |
The label/mode for the endpoint behavior data which is getting stored |
Validate that the label is not already present for a specific tenant. Validate for alphanumeric values. Anything other than alphanumeric will be rejected. Validate that label is not “DEFAULT”. Max size 64 chars Mandatory check |
|
leftIframeSize |
int |
|
N |
|
Should range between 0-100 |
|
leftIframeUrl |
String |
|
N |
|
Length should be less than or equal to 2048 |
|
leftPanel |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
lockUserName |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
loginModule |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
logoutOnUser-Hangup |
int |
|
Y |
|
Possible Values - 0,1 |
|
muteAudioOn-Entry |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
muteCameraOn-Entry |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
participantNoti-fication |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
pinnedParticipant |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
postIframeSize |
int |
|
N |
|
Should range between 0-100 |
|
postIframeUrl |
String |
|
N |
|
Length should be less than or equal to 2048 |
|
preIframeSize |
int |
|
N |
|
Should range between 0-100 |
|
preIframeUrl |
String |
|
N |
|
Length should be less than or equal to 2048 |
|
publicChat |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
recordConference |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
recordingRole |
String |
|
N |
|
This should be based on description in Recorder Endpoints. Max size 64 chars |
|
remoteContentAc-cess |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
rightIframeSize |
int |
|
N |
|
Should range between 0-100 |
|
rightIframeUrl |
String |
|
N |
|
Length should be less than or equal to 2048 |
|
shareDialogOnJoin |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
topIframeSize |
int |
|
N |
|
Should range between 0-100 |
|
topIframeUrl |
String |
|
N |
|
Length should be less than or equal to 2048 |
|
welcomePage |
int |
|
Y |
|
Possible Values - 0,1 Mandatory check |
|
windowPosition-Bottom |
int |
|
N |
|
Range -999999999 to 999999999 |
|
windowPosition-Left |
int |
|
N |
|
Range -999999999 to 999999999 |
|
windowPosition-Right |
int |
|
N |
|
Range -999999999 to 999999999 |
|
windowPosition-Top |
int |
|
N |
|
Range -999999999 to 999999999 |
|
windowSizeHeight |
int |
|
N |
|
Range -999999999 to 999999999 |
|
windowSizeWidth |
int |
|
N |
|
Range -999999999 to 999999999 |
Sample request
{
"endpointBehavior" : {
"label":"e1",
"welcomePage":"1",
"beautyScreen":"1",
"loginModule":"1",
"publicChat":"1",
"leftPanel":"0",
"inCallSearch" : "0",
"inCallSearch" : "0",
"inviteParticipants" : "0",
"contentSharing" : "1",
"shareDialogOnJoin" : "1",
"displayLabels" : "1",
"remoteContentAccess" : "1",
"cameraMuteControl" : "1",
"muteCameraOnEntry" : "1",
"audioMuteControl" : "1",
"muteAudioOnEntry" : "1",
"deviceSettings" : "1",
"pinnedParticipant" : "0",
"recordConference" : "0",
"exitOnUserHangup" : "0",
"automaticallyUpdate" : "0",
"lockUserName" : "0",
"enableAutoAnswer" : "0",
"participantNotification" : "0",
"fullScreenVideo" : "0"
}
}
Success response
In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.
JSON response parameters
|
Field |
Data type |
Mandatory |
Description |
|---|---|---|---|
|
version |
String |
Y |
Defines the version of the API. |
|
status |
String |
Y |
Defines the response stauts. For successful response, its value will be “success” |
|
data |
Object |
N |
This is the element which encapsulates the API response. For this API its value is null |
Sample JSON response
{
"version": "1",
"status": "success",
"data": null
}
Error responses
Error responses will be handled the same way as the REST LOGIN API described previously.
|
HTTP response code |
Error code |
Error message |
Scenario |
|---|---|---|---|
|
400 |
101015 |
Invalid request |
Validate that the label is not already present for a specific tenant. Validate label for alphanumeric values. Anything other than alphanumeric will be discarded. Validate that label is not “DEFAULT”. Any other Request body validation failure. |
|
403 |
|
|
Unauthorized user if anybody other than Super admin tries to access. Invalid tenant ID/FQDN. |
|
404 |
101016 |
Not Found |
Endpoint behavior is not enabled for the tenant. |
|
500 |
101014 |
Unexpected server side error |
Internal server error. |
Update Endpoint Behavior Mode API
This API allows the Super Admin to update the endpoint behavior attributes for a specific endpointBehaviorLabel. The API allows altering of partial/specific data and will not limit to just that. If a person wishes to change all the behavior attributes of a specific endpointLabel/mode, they will be able to do so. However, when changing or omitting any of the behavior attributes, all the mandatory conditions have to be satisfied in the same manner as the Create API. What this means is that a user cannot omit a mandatory behavior attribute using the Update API.
URL: [PortalFQDN]/admin/api/v1/tenants/{tenantId or tenantFqdn}/endpoints/behaviours/{label}
Method: PATCH
Path variables
|
Field |
Data type |
Mandatory |
Description |
Validations |
|---|---|---|---|---|
|
tenantId / Tenant FQDN |
String |
Y |
The tenant ID or tenant FQDN for which endpoint behavior mode will be configured |
Validate if the tenant ID is a valid tenant ID or not |
|
label |
String |
Y |
The label/mode for the endpoint behavior data which is getting updated |
Validate that the label is present for a specific tenant Validate that label is not “DEFAULT” Mandatory check |
JSON parameters
The JSON parameters are similar to the Create Endpoint Behavior Mode API.
Sample request
{
"endpointBehavior" :{
"welcomePage":"1",
"beautyScreen":"1",
"loginModule":"1",
"publicChat":"1",
"leftPanel":"1",
"inCallSearch" : "0",
"inviteParticipants" : "0",
"contentSharing" : "0",
"shareDialogOnJoin" : "0",
"displayLabels" : "0",
"remoteContentAccess" : "0",
"cameraMuteControl" : "0",
"muteCameraOnEntry" : "0",
"audioMuteControl" : "0",
"muteAudioOnEntry" : "0",
"deviceSettings" : "0",
"pinnedParticipant" : "1",
"recordConference" : "1",
"exitOnUserHangup" : "1",
"automaticallyUpdate" : "1",
"lockUserName" : "1",
"enableAutoAnswer" : "1",
"participantNotification" : "1",
"fullScreenVideo" : "1"
}
}
Success response
In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.
JSON response parameters
|
Field |
Data type |
Mandatory |
Description |
|---|---|---|---|
|
version |
String |
Y |
Defines the version of the API. |
|
status |
String |
Y |
Defines the response status. For a successful response, the value will be “success”. |
|
data |
Object |
N |
This is the element which encapsulates the API response. For this API, the value is null. |
Sample JSON response
{
"version": "1",
"status": "success",
"data": null
}
Error responses
Error responses will be handled the same way as the REST LOGIN API described previously.
|
HTTP response code |
Error code |
Error message |
Scenario |
|---|---|---|---|
|
400 |
101015 |
Invalid request |
Validate that the label is present for a specific tenant. Validate that label is not “DEFAULT”. Mandatory check Any other Request body validation failure |
|
403 |
|
|
Unauthorized user if anybody other than Tenant Admin or Super Admin tries to access. Invalid tenant ID/FQDN |
|
404 |
101016 |
Not Found |
Endpoint behavior is not enabled for the tenant. |
|
500 |
101014 |
Unexpected server side error |
Internal server error |
Get Endpoint Behavior Mode API
This API allows the Super Admin to fetch the endpointBehavior atributes for a specific EndpointBehaviorLabel/tenant.
URL: [PortalFQDN]/admin/api/v1/tenants/{tenantId or tenantFqdn}/endpoints/behaviours/{label}
Method: GET
Path variables
|
Field |
Data type |
Mandatory |
Description |
Validations |
|---|---|---|---|---|
|
tenantId / Tenant FQDN |
String |
Y |
The tenant ID or tenant FQDN for which endpoint behavior mode will be configured |
Validate if the tenant ID is a valid tenant ID or not |
|
label |
String |
N |
The label/mode for the endpoint behavior data which is getting updated. If no label is provided, all the endpoint behaviors will be returned for the requested tenant. |
If provided, validate that the label is present for a specific tenant. Validate that label is not “DEFAULT”.
|
JSON parameters
No JSON parameters will go in the request.
Success response
In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.
Sample JSON response
{
"version": "1",
"status": "success",
"data": {
"endpointBehaviors": [{
"label": "abc",
"welcomePage": "1",
"beautyScreen": "1",
"loginModule": "1",
"publicChat": "0",
"leftPanel": "0",
"inCallSearch": "0",
"inviteParticipants": "0",
"contentSharing": "0",
"shareDialogOnJoin": "0",
"displayLabels": "1",
"remoteContentAccess": "1",
"cameraMuteControl": "1",
"muteCameraOnEntry": "1",
"audioMuteControl": "1",
"muteAudioOnEntry": "0",
"deviceSettings": "0",
"pinnedParticipant": "0",
"recordConference": "0",
"exitOnUserHangup": "0",
"automaticallyUpdate": "0",
"lockUserName": "1",
"enableAutoAnswer": "1",
"participantNotification": "1",
"fullScreenVideo": "1"
}, {
"label": "xyz",
"welcomePage": "1",
"beautyScreen": "1",
"loginModule": "1",
"publicChat": "0",
"leftPanel": "0",
"inCallSearch": "0",
"inviteParticipants": "0",
"contentSharing": "0",
"shareDialogOnJoin": "0",
"displayLabels": "1",
"remoteContentAccess": "1",
"cameraMuteControl": "1",
"muteCameraOnEntry": "1",
"audioMuteControl": "1",
"muteAudioOnEntry": "0",
"deviceSettings": "0",
"pinnedParticipant": "0",
"recordConference": "0",
"exitOnUserHangup": "0",
"automaticallyUpdate": "0",
"lockUserName": "1",
"enableAutoAnswer": "1",
"participantNotification": "1",
"fullScreenVideo": "1"
}]
}
}
Error responses
Error responses will be handled the same way as the REST LOGIN API described previously.
|
HTTP response code |
Error code |
Error message |
Scenario |
|---|---|---|---|
|
400 |
101015 |
Invalid request |
Validate that the label is present for a specific tenant. Validate that label is not “DEFAULT”. Mandatory check |
|
403 |
|
|
Unauthorized user if anybody other than Tenant Admin or Super Admin tries to access. Invalid tenant id/FQDN |
|
404 |
101016 |
Not Found |
Endpoint behavior is not enabled for the tenant. |
|
500 |
101014 |
Unexpected server side error |
Internal server error |
Delete Endpoint Behavior Mode API
This API allows for the deletion of EndpointBehaviorLabels along with all the associated endpoint behavior attributes in the record.
URL: [PortalFQDN]/admin/api/v1/tenants/{tenantId or tenantPortal}/endpoints/behaviours/{label}
Method: DELETE
Path variables
|
Field |
Data type |
Mandatory |
Description |
Validations |
|---|---|---|---|---|
|
tenantId / Tenant FQDN |
String |
Y |
The tenant ID or tenant FQDN for which endpoint behavior mode will be configured |
Validate if the tenant ID is a valid tenant ID or not. |
|
label |
String |
Y |
The label/mode for the endpoint behavior data which is getting updated |
Validate that the label is present for a specific tenant. Validate that label is not “DEFAULT”. Mandatory check |
JSON parameters
No JSON parameters go in the request.
Success response
In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.
Sample JSON response
{
"version": "1",
"status": "success",
"data": null
}
Error responses
Error responses will be handled the same way as the REST LOGIN API described previously.
|
HTTP response code |
Error code |
Error message |
Scenario |
|---|---|---|---|
|
400 |
101015 |
Invalid request |
Validate that the label is present for a specific tenant. Validate that label is not “DEFAULT”. Mandatory check |
|
403 |
|
|
Unauthorized user if anybody other than Tenant Admin or Super Admin tries to access. Invalid tenant id/FQDN |
|
404 |
101016 |
Not Found |
Endpoint behavior is not enabled for the tenant |
|
500 |
101014 |
Unexpected server side error |
Internal server error |