Skip to main content

API access

  • API base URL https://apis.alfaview.com/json/v1/
  • Common API endpoints
    • Authentication Service
      https://apis.alfaview.com/json/v1/authenticationService
    • Business Logic Service
      https://apis.alfaview.com/json/v1/businessLogicService
    • Company Service
      https://apis.alfaview.com/json/v1/companyService
    • Guest Service
      https://apis.alfaview.com/json/v1/guestService.v2
    • Meeting Service
      https://apis.alfaview.com/json/v1/meetingService
    • Quota Service
      https://apis.alfaview.com/json/v1/quotaService
    • Room Service
      https://apis.alfaview.com/json/v1/roomService
    • User Service
      https://apis.alfaview.com/json/v1/userService
  • Username/Password credentials can be created via user invite in the admin interface at https://app.alfaview.com/#/accounts/
  • API keys need to be created via account management in the admin interface at https://app.alfaview.com/#/settings/

Constants

  • Define a requestId function that generates unique identifiers for debugging requests later on
  • DEPRECATED: Define a constant for guest access codes (random string)
  • DEPRECATED: Define a constant for join link base url https://app.alfaview.com/#/join/
  • DEPRECATED: Define a constant for roles (Should now be retrieved from the Business Logic Service)
    • Moderator:
      { "voice": true, "video": true, "promote": true, "join": true, "screen": true, "chat": true, "chatBroadcast": true }
    • Participant:
      { "voice": true, "video": true, "join": true, "screen": true, "chat": true }
    • Spectator:
      { "join": true, "chat": true }

Error handling

Examples

{
  "replyInfo": {
    "requestId": "z3ai9B11509",
    "statusMessage": "OK"
  },
  ...
}
{
  "code": 16,
  "message": "token expired",
  "details": [
    {
      "@type": "type.googleapis.com/common.ReplyInfo",
      "requestId": "tn5BoQ10239",
      "statusCode": "TOKEN_OUTDATED",
      "statusMessage": "token expired"
    }
  ]
}

Notes

  • API Responses contain a replyInfo
  • Check containing statusMessage to be OK
  • If error says token expired you will have to reauthenticate
  • I error says context deadline exceeded there was a timeout and the request needs to be reissued

Zuletzt aktualisiert am 3. Juli 2025, 12:10 Uhr