开发
API

直播间自定义封面图

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

请求地址

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

请求参数

属性数据类型必填说明
app_idstring小程序的 appID
start_pagestring跳转页
titlestring标题
imagemultipart封面图
room_idint直播间 id

返回值

返回值为 JSON 形式

当服务端正确返回时,会返回如下信息:

属性数据类型说明
err_noint错误码,成功时返回 0
err_tipsstring错误信息,成功时返回空

errCode

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

错误号描述
1系统错误
100请求的 Content-Type 非法
40014参数为空或非法
60100图片超过 2MB
60101title 超过 16 字符
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 字符以内
点击纠错
评价此篇文档