Generate join url from group link

Summary

• Extract companyId, roomId, and accessKey from existing group link
• Authenticate with extracted information
• Assemble join url
• Required API calls: guestService.v2/authenticate

Existing group link

// Format:
https://app.alfaview.com/#/join/<COMPANYID>/<ROOMID>/<ACCESSKEY>/v2

// Example:
https://app.alfaview.com/#/join/01EZYCFW9MJ10P15YJ63NZ8S47/5726d492-6eb2-
5f59-9ee8-203181250dc4/rgOUSiy2pFWkRFNfnkXuJRVXcD72GoOb/v2

// Extracted:
companyId: 01EZYCFW9MJ10P15YJ63NZ8S47
roomId: 5726d492-6eb2-5f59-9ee8-203181250dc4
accessKey: rgOUSiy2pFWkRFNfnkXuJRVXcD72GoOb

Request

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

{
  "accessInfo": {
    "requestId": "string", // optional, can be used to trace a request
    // "accessToken": "string" - do not pass an accessToken!
    "includeMetadata": true,
    "returnObjectIdsOnly": true
  },
  "companyId": "string", // extracted companyId
  "roomId": "string", // extracted roomId
  "accessKey": "string", // extracted accessKey
  "displayName": "string", // guest name
  "externalId": "string" - // optional, can be used to derive a
                           // reproducible userId for groupLinks to prevent simultaneous use.
                           // The caller is responsible to provide a unique value per user;
                           // validate="optional,min=32,max=256"
}

Response

{
  "replyInfo": {
    "statusMessage": "OK"
  },
  "accessToken": "string", // use this to assemble the join url
  "tokenExpiresAt": "string", // expires 12 hours after creation
  "userId": "string",
  "linkInfo": {
    "type": "TYPE_GROUP_LINK"
  }
}

Assemble join url

// Format for web client:
https://webclient.alfaview.com/?--url=alfaview://apis.alfaview.com:443?companyId=<COMPANY>&roomId=<ROOMID or MEETINGID>&token=<ACCESSTOKEN>

// Format for native client:
alfaview://apis.alfaview.com:443?companyId=<COMPANYID>&roomId=<ROOMID or MEETINGID>&token=<ACCESSTOKEN>

// Example:
alfaview://apis.alfaview.com:443?
companyId=01EZYCFW9MJ10P15YJ63NZ8S47&roomId=5726d492-6eb2-5f59-9ee8-
203181250dc4&token=IRXPAVVc1nZCOu5+mKTfXeUQr5bf/C1bSJt3Pd0ibtpDSdineL5trHO
BuArpIqfBo41sh7S5gPxntpEBYl0wAIu6pT700f1nx2p8Idc7CDZUy6aVhYTa7Ojc3Pzu0k6UZ
twi43ixjqhKvSIYOJYdQrExlvjWhUZVuIGf6Wnk5OD73z4YmQnVLQ9c1ye6/u4l5p6fe0rgTP1
6mKCMnH/CXb5Y2lHHGdxT4ENS9Vpg0wI5ihI4xZ7Rc3VjkRpWEUDtmeKwSn1NhQkcuFezlWBQr
sI5kvxp9ROvE1aw