CreateRTCWhipStreamAddress - 创建RTC频道WHIP推流地址_视频直播(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	是	用户 ID，不能与频道中的其他用户 ID 重复。	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	串流密钥为空。