Create group links
Summary
- Group links can be shared with multiple recipients
- The endpoint can create multiple group links at once
- Required API calls:
guestService.v2/createGroupLinks
Request
Request to https://apis.alfaview.com/json/v1/guestService.v2/createGroupLinks
{
"accessInfo": {
"requestId": "### REQUEST ID ###",
"accessToken": "### ACCESS TOKEN ###"
},
"roomId": "### ROOM ID ###",
"groupLinkCreations": [
{
"description": "### GROUP LINK TITLE ###",
"validFrom": "2022-08-01T13:15:00Z",
"validUntil": "2022-08-02T14:00:00Z",
"permissionGroupId": "### PERMISSION GROUP ID ###",
"skipRoomPermissionsUpdate": false
}
]
}
Response
{
"replyInfo": {
...
"statusMessage": "OK"
},
"groupLinks": [
{
...
"joinLink": "https://app.alfaview.com/#/join/01FH0EX0VQQ378MV7Z5NAGHESK/4173dafb-5cde5c85-95a3-20ebdd43698a/NcHef8FIc17a5jpiWy4fJ0cw2dCRpbFG/v2",
"accessKey": "NcHef8FIc17a5jpiWy4fJ0cw2dCRpbFG"
}
]
}
Notes
groupLinkCreations
can contain multiple objects, contains the following attributesdescription
the title of this group link, not visible for the recipientvalidFrom
andvalidUntil
define the time frame in which the group link is valid. If onlyvalidFrom
is defined the time range has an open end. If none are defined time range is unlimited. Both values are optional.- retrieve the desired
permissionGroupId
from the Business Logic Service skipRoomPermissionsUpdate
should be set to false when creating group links
- The response contains a corresponding array of group links, which then contain an individual
joinLink
Last updated on August 9th, 2024, 08:56 am