Create guest links

Summary

• Guest links are non-shareable
• Guest links are for individual recipients
• Can create multiple guest links
• Optionally sends an email in the specified language (DE or EN)
• Required API calls: guestService.v2/createGuestLinks

Request

Request POST to https://apis.alfaview.com/json/v1/guestService.v2/createGuestLinks

{
  "accessInfo": {
    "requestId": "### REQUEST ID ###",
    "accessToken": "### ACCESS TOKEN ###"
  },
  "roomId": "### ROOM ID ###",
  "guestLinkCreations": [
    {
      "email": "### GUEST EMAIL ###",
      "displayName": "### GUEST NAME ###",
      "validFrom": "2022-07-25T07:25:48.057Z",
      "validUntil": "2022-07-25T07:25:48.057Z",
      "locale": "### GUEST LOCALE ###",
      "sendEmail": true,
      "permissionGroupId": "### PERMISSION GROUP ID ###",
      "skipRoomPermissionsUpdate": false
    }
  ]
}

Response

{
  "replyInfo": {
    ...
    "statusMessage": "OK"
  },
  "guestLinks": [
    {
      ...
      "joinLink":
      "https://app.alfaview.com/#/join/01FH0EX2VQQ378MV7Z5NAGHESK/4173dafb-5cde5c85-95a3-20ebdf43698a/PHLlurwVkiY91KAlXVc8WtNsKBoRwStK/v2",
      "accessKey": "PHLlurwVkiY91KAlXVc8WtNsKBoRwStK"
    }
  ]
}

Notes

• guestLinkCreations can contain multiple objects, contains the following attributes
  • displayName the name the guest will display during a meeting, optional
  • validFrom and validUntil define the time frame in which the guest link is valid. If only validFrom is defined the time range has an open end. If none are defined time range is unlimited. Both values are optional.
  • set sendEmail to true if an invitation email needs to be sent out to the guest
  • locale applies to the invitation email, can be de or en, defaults to en
  • retrieve the desired permissionGroupId from the Business Logic Service
  • skipRoomPermissionsUpdate should be set to false when creating guest links
• The response contains a corresponding array of guest links, which then contain an individual joinLink
• As of today, guest links created with this endpoint will not show up in the administration interface for a rooms guest links (known issue, will be fixed soon)