直播间自定义封面
收藏
我的收藏

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

请求头

POST https://developer.toutiao.com/api/apps/upload_live_image

请求参数

属性
数据类型
必填
说明
app_id
string
小程序的 appID
start_page
string
跳转页。小程序页面路径,例page/detail/detail?id=1
title
string
标题
image
multipart
封面图
room_id
int
直播间 id,可以通过获取直播房间数据接口获得。

返回值

返回值为 JSON 形式。
当服务端正确返回时,会返回如下信息:
属性
数据类型
说明
err_no
int
错误码,成功时返回 0
err_tips
string
错误信息,成功时返回空

错误码

HTTP状态码
错误码
描述
排查建议
200
0
请求成功
200
1
系统错误
200
100
请求的 Content-Type 非法
200
40014
参数为空或非法
200
60100
图片超过 2MB
200
60101
title 超过 16 字符
200
60102
图片格式错误

请求示例

curl --location --request POST 'https://developer.toutiao.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'

响应示例

正常示例

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

异常示例

{ "err_no": 1, "err_tips": "system error" }

Bug & Tip

    Tip: 请求时 务必使用 Content-Type: multipart/form-data
    Tip: 图片支持 jpg, jpeg, png 格式,且最大不超过 2MB
    Tip: title 限制 16 字符以内