申请「短视频挂载」能力

收藏
我的收藏

接口介绍

该接口用于第三方小程序应用为授权小程序申请「短视频挂载」能力。

注意:

请求

基本信息

基本


HTTP URL

https://open.microapp.bytedance.com/openapi/v1/microapp/operation/video_application

HTTP Method

POST

权限要求

授权小程序授予运营管理权限

查询参数

参数名

参数类型

是否必须

备注

component_appid

string

第三方小程序应用 appid

authorizer_access_token

string

授权小程序接口调用凭据

请求体(json)

参数名

参数类型

是否必须

备注

intro

string

申请原因以及挂载内容介绍
字数限制:200

anchorText

string

挂载锚点文案示例
字数限制:200

imagePath

string

小程序落地页截图路径
需要使用代授权小程序上传资源
接口返回的路径才可以,接口调用时入参 material_type 字段为 4,否则报错。

请求体示例

{ "intro": "xxx", "anchorText": "xxx", "imagePath": "xxxx/xxxx" }

响应

响应体

参数名

参数类型

备注

errno

int

错误码

message

string

错误信息

响应体示例

{ "errno": 0, "message": "success" }

错误码

错误码

message

40001

参数错误

40003

找不到相关第三方小程序应用

40004

找不到相关授权小程序

40020

第三方小程序应用 authorizer_access_token 不正确或者已过期

40033

获取不到上传的材料,请确认文件路径正确

40036

授权小程序未授予该接口对应的权限

「短视频挂载」能力申请审核结果通知

「短视频挂载」能力申请审核结果出来之后,会自动触发消息发送,然后开放平台服务器会向第三方小程序应用的【消息与事件接收 URL】以 HTTP POST 方式推送相应授权小程序的「短视频挂载」能力申请的审核结果。

POST 数据示例:

{ "Nonce": "4464221", "TimeStamp": "1535551395", "Encrypt": "Encrypt Message xxxxxxxx", "MsgSignature": "ba394c04acece6c2c0edee058c5dddf82474b8ee" }

其中 Encrypt 字段需要解密,解密详情见消息推送及加解密说明部分。解密后消息格式如下:

{ "AppId": "授权小程序的appid", "TpAppId": "第三方小程序应用appid", "EventTime": "2019-01-14 12:45:10", "Event": "APPLY_VIDEO_CAPABILITY", "ApplyVideoCapabilityResults": { "status": 0, "reason": "xxx" } }

消息体字段含义如下:

参数名

参数类型

备注

AppId

string

授权小程序 appid

TpAppId

string

第三方小程序应用 appid

EventTime

string

推送事件时间

Event

string

推送事件类型

ApplyVideoCapabilityResults

object

「短视频挂载」能力申请的审核结果

reason

string

如果被拒,被拒原因

status

int

0:代表不通过,1:代表通过,2:代表能力关闭

该文档是否有帮助?