GetMessageToken - 擷取長串連建連Token（舊版） - ApsaraVideo Live

介面說明

使用說明

先擷取用戶端 UserId、DeviceId、DeviceType 資訊，然後傳入到服務端，服務端使用該介面擷取鑒權 Token，並返回給用戶端。不同的使用者需要使用不同的 UserId，不同的終端裝置需要使用不同的 DeviceId。

QPS 限制

本介面的單使用者 QPS 限制為 100 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。更多資訊，請參見 QPS 限制。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:GetMessageToken

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
AppId	string	是	互動訊息應用 ID。	a494caec-***-695ef345db77
DeviceId	string	是	終端裝置識別碼，唯一代表一個使用者終端裝置，使用者自訂。小寫英文、數字、底線（_）和虛線（-）組成，最大長度 64 個字元。不同終端裝置需要使用不同的 DeviceId，建議從終端裝置擷取並傳入給服務端。	a494caec-***-695ef345db77
DeviceType	string	是	終端裝置類型，取值： ios android web pc	android
UserId	string	是	使用者 UserId，使用者自訂，在 AppId 下單獨唯一。小寫英文、數字、底線（_）和小數點（.）組成，最大長度 32 個字元。不同的使用者需要使用不同的 UserId。	de1**a0

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	16A96B9A-****-CB92E68F4CD8
Result	object	返回結果。
AccessToken	string	用於長串連建連的 Token。	oauth_cloud_key:***-b0YY5Gy6Q
AccessTokenExpiredTime	integer	登入 Token 到期時間，單位：毫秒。	86400000
RefreshToken	string	更新 Token，若 AccessToken 到期，則可以使用 RefreshToken 再次擷取新 Token。	oauth_cloud_key:****-Q62xggOTdgk3gw=

樣本

正常返回樣本

JSON格式

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "AccessToken": "oauth_cloud_key:***-b0YY5Gy6Q",
    "AccessTokenExpiredTime": 86400000,
    "RefreshToken": "oauth_cloud_key:****-Q62xggOTdgk3gw="
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvaildParameter	Invalid Parameter	請求參數非法
403	Forbidden	User not authorized to operate on the specified resource.	介面許可權不足，請您聯絡管理員，配置存取權限。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。