調用CreateRTCWhipStreamAddress擷取RTC頻道WHIP推流地址-ApsaraVideo for Live-阿里雲

介面說明

使用說明

通過調用 CreateRTCWhipStreamAddress 介面，建立在對應 RTC 房間（頻道）的 WhipAddress 推流地址。
使用 OBS 工具，通過 whip 協議進行推流。
- 運行 OBS 推流工具。
- 在功能表列中選擇檔案>設定。
- 在設定頁面選擇直播，配置如下資訊，單擊確定。
  
  參數
  描述
  服務
  選擇 WHIP。
  伺服器
  使用步驟 1 中通過介面產生的 WhipAddress 地址。
  Bearer Token
  串流密鑰為空白。
其他使用者，進入相應房間（頻道）觀看。

QPS 限制

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

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
ClientToken	string	否	等冪參數。說明用於區分多次請求是不是同一個請求的標識，針對本介面不建議填寫。	58E73333-xxxx-xxxx-xxxx
AppId	string	是	應用 ID。	6a06dcc-xxxx-xxxx-xxxx-ee3exxxxxx
ChannelId	string	是	加入的頻道 ID。	ch00000****001
UserId	string	是	使用者識別碼，不能與頻道中的其他使用者識別碼重複。	zb0000****0001
DisplayName	string	是	在頻道中顯示的使用者名稱稱。說明支援填寫中文等字元，為避免名稱過長，大小建議小於 32 個 byte。	主播小二
ExpireTime	integer	否	推流有效時間長度，單位：秒，預設為 43200 秒。說明若超過設定的有效期間，則正在使用由本介面所產生地址進行的推流不受影響，但是用該地址重新推流則會失敗。	43200

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	58E7D4-xxxx-xxxx-xxxx-6B56Cxxxxx
WhipAddress	string	WHIP 協議 URL。	https://xxxxxx.media-sh.xxxxx.com/xxxxxxxxxxxx/3723a3xxxxxxxxx223c606b*5f7a2bc7c56ea5cdd0xxxxe?auth_key=17495xxxxx-xxxx-0-f013003067c78c4053f9cd0xxxxxxx&qqzr=H4sIAAAAAAAC_6pWSlayUkrOMxxxxxxrPyCxQ0lFKQTCLlKyUjM2NjNDQ1TEy2Mjc3xxxxxxxxxxqRYAAAD__xxxxx__xxxxxxxx

樣本

正常返回樣本

JSON格式

{
  "RequestId": "58E7**D4-xxxx-xxxx-xxxx-6B5**6Cxxxxx",
  "WhipAddress": "https://xxxxxx.media-sh.xxxxx.com/xxxxxxxxxxxx/3723a3xxxxxxxxx223c606b***5f7a2bc7c56ea5cdd0xxxxe?auth_key=17495xxxxx-xxxx-0-f013003067c78c4053f9cd0xxxxxxx&qqzr=H4sIAAAAAAAC_6pWSlayUkrOMxxxxxxrPyCxQ0lFKQTCLlKyUjM2Nj**NDQ1TEy2Mjc3xxxxxxxxxxqRYAAAD__xxxxx__xxxxxxxx"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InputInvalid	%s.	輸入參數不合法
500	ServerError	%s.	未知錯誤，請稍後重試或提交工單諮詢。
403	NoAuth	%s.	沒有許可權
404	ResourceNotExist	%s.	請求資源不存在，請檢查後重新嘗試

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

變更歷史

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

參數	描述
服務	選擇 WHIP。
伺服器	使用步驟 1 中通過介面產生的 WhipAddress 地址。
Bearer Token	串流密鑰為空白。