聊天室

為聊天室建立訪問令牌

（以下內容均翻譯自英文版文件，最新資訊及內容敬請切換至英文語系參考原文）

 

BlendVision 聊天室系統使用不同於 BlendVision One 的訪問令牌。要訪問聊天室 API，您必須取得一個獨立的訪問令牌。您必須先從 BlendVision One 取得 API 令牌後才能取得聊天室令牌。有關 API 令牌的更多資訊，請參照 身分驗證 。

 

建立聊天室（可選）

如果您還沒有聊天室，可以通過向以下 API 發送 POST 請求來建立：

POST /bv/chatroom/v1/chatrooms

成功的回應將包含一個 id，即已建立好的聊天室的 ID。

 

建立聊天室令牌

要建立聊天室令牌，請向以下 API 發送 POST 請求：

POST /bv/chatroom/v1/chatrooms/{id}/tokens

請將 {id} 替換為您的聊天室的 ID。

該請求的主體應包含以下參數：

名稱 類型 必填 描述
role string 否

該令牌的角色。如果未提供，默認為 ROLE_VIEWER 。
允許使用的值： ROLE_VIEWER 、ROLE_ADMIN
device_id string 否 令牌的設備標識碼。如果未提供，默認為產生的 UUID 字符串。
subject string 否 令牌的用戶標識碼。如果未提供，默認為產生的訪客 UUID 字符串。

以下是 Curl 請求的範例：

curl --request POST \
  --url https://api.one.blendvision.com/bv/chatroom/v1/chatrooms/id/tokens \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'authorization: Bearer <chatroom-token>' \
  --data '{
  "role": "ROLE_ADMIN",
  "device_id": "string",
  "subject": "string"
}'

要管理聊天室， role 欄必須為 ROLE_ADMIN 。

成功的回應將回傳聊天室令牌和其他詳細資訊：

{
  "endpoint": "string",
  "authorizer": "string",
  "token": "string",
  "signature": "string",
  "chat": {
    "pub": "string",
    "sub": "string"
  }
}

 

 

更新於