直播间自定义封面

开发环境

http://dev-cn.your-api-server.com

POST

/api/apps/upload_live_image

目前抖音直播已经集成了直播功能卡片跳转小程序的能力。为了给开发者提供更多的自由度，我们支持开发者定制功能卡片封面图，可通过此接口上传封面图。图片会在直播功能卡区域展示。

errCode

当请求失败时，会返回非 0 的err_no，错误信息会携带在 err_tips 中，错误码含义如下：

错误号	描述
1	系统错误
100	请求的 Content-Type 非法
40014	参数为空或非法
60100	图片超过 2MB
60101	title 超过 16 字符
60102	图片格式错误

Bug & Tip

Tip: 请求时务必使用 Content-Type: multipart/form-data

Tip: 图片支持 jpg, jpeg, png 格式，且最大不超过 2MB

Tip: title 限制 16 字符以内

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/api/apps/upload_live_image' \
--form 'image="some_local_path/iconb429352_144x144.jpeg"' \
--form 'app_id="ttb416c2ab2b2d7549"' \
--form 'room_id="123456"' \
--form 'title="sometitle"' \
--form 'start_page="somepage"'

响应示例

200 - 成功示例

{
  "err_no": 0,
  "err_tips": "success"
}

请求参数

Body 参数multipart/form-data

image

string

封面图

必需

示例值:

some_local_path/iconb429352_144x144.jpeg

app_id

string

必需

小程序的 appID

示例值:

ttb416c2ab2b2d7549

room_id

string

直播间 id

必需

示例值:

123456

title

string

标题

必需

示例值:

sometitle

start_page

string

跳转页

必需

示例值:

somepage

返回响应

🟢200成功

application/json

Body

err_no

integer

必需

错误码，成功时返回 0

err_tips

string

必需

错误信息，成功时返回空

🟠400请求有误

删除测试实体接口

上传资源

直播间自定义封面

errCode#

Bug & Tip#

请求参数

返回响应

errCode

Bug & Tip