# 批处理短剧合作推广计划

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:batchProcessDramaPromotion

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/wxadrama/batchprocessdramapromotion?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用。

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:157

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String Parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
action_typenumber操作类型。1-加入计划;2-查询计划;3-退出计划
listobjarray短剧数组

# Body.list(Array) Object Payload

短剧数组

参数名类型必填说明
src_appidstring提审方小程序的appid
drama_idstring提审的剧目id

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
listobjarray短剧数组

# Res.list(Array) Object Payload

短剧数组

参数名类型说明
src_appidstring提审方小程序的appid
drama_idstring提审的剧目id
statusnumber短剧状态。 0-未加入计划;1-审核中;2-审核通过;3-审核拒绝;4-退出计划中;5-已被下架

# 4. 注意事项

  1. 该接口必须由剧目提审时的小程序调用,即access_token对应的小程序appid必须等于src_appid。
  2. 每次批量加入短剧最大数目限制为100。
  3. 短剧需要满足码率大于0.5Mbps,分辨率大于720。
  4. 若加入计划时存在不符合条件的短剧,会使本次请求所有短剧加入失败。开发者可以通过批查询action_type=2查询短剧状态。

# 5. 代码示例

# 5.1 加入/退出计划请求示例

请求示例

此处仅以加入计划为例,如需退出计划可修改action_type为3。

{
   "action_type": 1,
   "list": [
           {"src_appid":"example_src_appid", "drama_id":"123456"},
           {"src_appid":"example_src_appid", "drama_id":"123457"}
     ]
}

返回示例

{
    "errcode":0,
    "errmsg":"ok"
}

{ //加入计划时,若分辨率或码率不满足条件
    "errcode":106017,
    "errmsg":"分辨率不足或码率不足"
}

{ //加入计划时,若授权库中已存在同内容短剧
    "errcode":106018,
    "errmsg":"官方授权库中已存在相同内容的短剧,请勿重复授权"
}

# 5.2 查询计划请求示例

请求示例

{
   "action_type": 2,
   "list": [
           {"src_appid":"example_src_appid", "drama_id":"123456"},
           {"src_appid":"example_src_appid", "drama_id":"123457"}
     ]
}

返回示例

{
   "list": [
           {"src_appid":"example_src_appid", "drama_id":"123456", "status": 0 },
           {"src_appid":"example_src_appid", "drama_id":"123457", "status": 1 }
     ],
    "errcode":0,
    "errmsg":"ok"
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述
-1系统错误,请重试
0成功
1不存在
2参数错误
21000该剧未授权播放,请通过后台api进行授权
21001用户加密的sessionkey不存在
21002商家的加密包未进行base64编码
21003解密商家加密包失败,请确认是否按接入文档中给出的加密方案加密或sessionkey要使用当前用户最新的
21004商家加密前的明文不是合法的json格式或者字段类型不对,请按接入文档排查
21005商家加密中的必填参数值(openid、src_appid及drama_id)为空
21006播放器的入参与商家加密包中的参数值不匹配
21007加密包中的openid无效
2100821008 开发者未开启预拉取
2100921009 商家流量不足

# 7. 适用范围

本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。