Skip to content

Latest commit

 

History

History
1027 lines (597 loc) · 32 KB

VideoApi.md

File metadata and controls

1027 lines (597 loc) · 32 KB
Raw

\VideoApi

All URIs are relative to https://open.douyin.com

Method HTTP request Description
DouyinVideoCreate Post /video/create 创建抖音视频
DouyinVideoData Post /video/data 查询指定视频数据
DouyinVideoDelete Post /video/delete 删除授权用户发布的视频
DouyinVideoList Get /video/list 查询授权账号视频数据
DouyinVideoPartComplete Post /video/part/complete 视频分片完成上传
DouyinVideoPartInit Post /video/part/init 抖音分片初始化上传
DouyinVideoPartUpload Post /video/part/upload 上传视频分片到文件服务器
DouyinVideoPositionSearch Get /poi/search/keyword 查询POI信息
DouyinVideoShareId Get /share-id/ 获取share-id
DouyinVideoUpload Post /video/upload 抖音上传视频到文件服务器
ToutiaoVideoCreate Post /toutiao/video/create 创建头条视频
ToutiaoVideoData Post /toutiao/video/data 查询头条指定视频数据
ToutiaoVideoList Get /toutiao/video/list 查询授权账号视频数据
ToutiaoVideoPartComplete Post /toutiao/video/part/complete/ 头条视频分片完成上传
ToutiaoVideoPartInit Post /toutiao/video/part/init 头条分片初始化上传
ToutiaoVideoPartUpload Post /toutiao/video/part/upload 上传视频分片到文件服务器
ToutiaoVideoUpload Post /toutiao/video/upload 头条上传视频到文件服务器
XiguaVideoCreate Post /xigua/video/create 创建西瓜视频
XiguaVideoData Post /xigua/video/data 西瓜查询指定视频数据
XiguaVideoList Get /xigua/video/list 西瓜查询授权账号视频数据
XiguaVideoPartComplete Post /xigua/video/part/complete 视频分片完成上传
XiguaVideoPartInit Post /xigua/video/part/init 西瓜分片初始化上传
XiguaVideoPartUpload Post /xigua/video/part/upload 上传视频分片到文件服务器
XiguaVideoUpload Post /xigua/video/upload 西瓜上传视频到文件服务器

DouyinVideoCreate

DouyinVideoCreateRsp DouyinVideoCreate(ctx, openId, accessToken, body)

创建抖音视频

创建抖音视频

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
body DouyinVideoCreateReq

Return type

DouyinVideoCreateRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DouyinVideoData

DouyinVideoData DouyinVideoData(ctx, openId, accessToken, body)

查询指定视频数据

查询指定视频数据

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
body InlineObject2

Return type

DouyinVideoData

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DouyinVideoDelete

DouyinVideoDeleteRsp DouyinVideoDelete(ctx, openId, accessToken, body)

删除授权用户发布的视频

删除授权用户发布的视频

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
body InlineObject1

Return type

DouyinVideoDeleteRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DouyinVideoList

DouyinVideoListRsp DouyinVideoList(ctx, openId, accessToken, count, optional)

查询授权账号视频数据

查询授权账号视频数据

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
count int64 每页数量
optional *DouyinVideoListOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DouyinVideoListOpts struct

Name Type Description Notes

cursor | optional.Int64| 分页游标, 第一页请求cursor是0, response中会返回下一页请求用到的cursor, 同时response还会返回has_more来表明是否有更多的数据。 |

Return type

DouyinVideoListRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DouyinVideoPartComplete

DouyinVideoPartCompleteRsp DouyinVideoPartComplete(ctx, openId, accessToken, uploadId)

视频分片完成上传

视频分片完成上传

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
uploadId string 分片上传的标记。有限时间为2小时

Return type

DouyinVideoPartCompleteRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DouyinVideoPartInit

DouyinVideoPartInitRsp DouyinVideoPartInit(ctx, openId, accessToken)

抖音分片初始化上传

抖音分片初始化上传

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。

Return type

DouyinVideoPartInitRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DouyinVideoPartUpload

DouyinVideoPartUploadRsp DouyinVideoPartUpload(ctx, openId, accessToken, uploadId, partNumber, video)

上传视频分片到文件服务器

上传视频分片到文件服务器

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
uploadId string 分片上传的标记。有限时间为2小时
partNumber int64 第几个分片，从1开始
video interface{}

Return type

DouyinVideoPartUploadRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DouyinVideoPositionSearch

DouyinVideoPositionSearchRsp DouyinVideoPositionSearch(ctx, accessToken, count, keyword, optional)

查询POI信息

查询POI信息

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accessToken string 调用/oauth/client_token/生成的token，此token不需要用户授权。
count int64 每页数量。
keyword string 查询关键字，例如美食
optional *DouyinVideoPositionSearchOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DouyinVideoPositionSearchOpts struct

Name Type Description Notes

cursor | optional.Int64| 分页游标, 第一页请求cursor是0, response中会返回下一页请求用到的cursor, 同时response还会返回has_more来表明是否有更多的数据。 | city | optional.String| 查询城市，例如上海、北京。 |

Return type

DouyinVideoPositionSearchRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DouyinVideoShareId

DouyinVideoShareIdRsp DouyinVideoShareId(ctx, accessToken, needCallback, optional)

获取share-id

获取share-id

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accessToken string 调用/oauth/client_token/生成的token，此token不需要用户授权。
needCallback bool 如果需要知道视频分享成功的结果，need_callback设置为true
optional *DouyinVideoShareIdOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DouyinVideoShareIdOpts struct

Name Type Description Notes

sourceStyleId | optional.String| 多来源样式id（暂未开放）。 | defaultHashtag | optional.String| 追踪分享默认hashtag | linkParam | optional.String| 分享来源url附加参数（暂未开放）。 |

Return type

DouyinVideoShareIdRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DouyinVideoUpload

DouyinVideoUploadRsp DouyinVideoUpload(ctx, openId, accessToken, video)

抖音上传视频到文件服务器

抖音上传视频到文件服务器

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
video os.Fileos.File

Return type

DouyinVideoUploadRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: multipart/form-data

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ToutiaoVideoCreate

TouTiaoVideoCreateRsp ToutiaoVideoCreate(ctx, openId, accessToken, body)

创建头条视频

创建头条视频

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
body DouyinVideoCreateReq

Return type

TouTiaoVideoCreateRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ToutiaoVideoData

TouTiaoVideoData ToutiaoVideoData(ctx, openId, accessToken, optional)

查询头条指定视频数据

查询头条指定视频数据

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
optional *ToutiaoVideoDataOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ToutiaoVideoDataOpts struct

Name Type Description Notes

body | optional.Interface of InlineObject3| |

Return type

TouTiaoVideoData

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ToutiaoVideoList

TouTiaoVideoListRsp ToutiaoVideoList(ctx, openId, accessToken, count, optional)

查询授权账号视频数据

查询授权账号视频数据

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
count int64 每页数量
optional *ToutiaoVideoListOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ToutiaoVideoListOpts struct

Name Type Description Notes

cursor | optional.Int64| 分页游标, 第一页请求cursor是0, response中会返回下一页请求用到的cursor, 同时response还会返回has_more来表明是否有更多的数据。 |

Return type

TouTiaoVideoListRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ToutiaoVideoPartComplete

TouTiaoVideoPartCompleteRsp ToutiaoVideoPartComplete(ctx, openId, accessToken, uploadId)

头条视频分片完成上传

头条视频分片完成上传

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
uploadId string 分片上传的标记。有限时间为2小时

Return type

TouTiaoVideoPartCompleteRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ToutiaoVideoPartInit

TouTiaoVideoPartInitRsp ToutiaoVideoPartInit(ctx, openId, accessToken)

头条分片初始化上传

头条分片初始化上传

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。

Return type

TouTiaoVideoPartInitRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ToutiaoVideoPartUpload

TouTiaoVideoPartUploadRsp ToutiaoVideoPartUpload(ctx, openId, accessToken, uploadId, partNumber, video)

上传视频分片到文件服务器

上传视频分片到文件服务器

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
uploadId string 分片上传的标记。有限时间为2小时
partNumber int64 第几个分片，从1开始
video os.Fileos.File

Return type

TouTiaoVideoPartUploadRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ToutiaoVideoUpload

ToutiaoVideoUploadRsp ToutiaoVideoUpload(ctx, openId, accessToken, video)

头条上传视频到文件服务器

头条上传视频到文件服务器

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
video os.Fileos.File

Return type

ToutiaoVideoUploadRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

XiguaVideoCreate

XiGuaVideoCreateRsp XiguaVideoCreate(ctx, openId, accessToken, optional)

创建西瓜视频

创建西瓜视频

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
optional *XiguaVideoCreateOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a XiguaVideoCreateOpts struct

Name Type Description Notes

abstract | optional.String| 视频简介，400字以内 | claimOrigin | optional.String| 是否声明原创（授权账号需要在西瓜视频端内开通「实名认证」） | coverTsp | optional.String| 从视频中截取封面的时间，用该帧作为封面（单位为毫秒） | praise | optional.String| 是否给视频开通可以赞赏的入口（授权账号需要在西瓜视频端内开通「实名认证」） | text | optional.String| 标题长度应该在5-30字之间 | videoId | optional.String| video_id, 通过/xigua/video/upload/接口得到 |

Return type

XiGuaVideoCreateRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

XiguaVideoData

XiGuaVideoData XiguaVideoData(ctx, openId, accessToken, optional)

西瓜查询指定视频数据

西瓜ig查询指定视频数据

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
optional *XiguaVideoDataOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a XiguaVideoDataOpts struct

Name Type Description Notes

itemIds | optional.Interface of []string| |

Return type

XiGuaVideoData

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

XiguaVideoList

XiGuaVideoListRsp XiguaVideoList(ctx, openId, accessToken, count, optional)

西瓜查询授权账号视频数据

西瓜查询授权账号视频数据

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
count int64 每页数量
optional *XiguaVideoListOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a XiguaVideoListOpts struct

Name Type Description Notes

cursor | optional.Int64| 分页游标, 第一页请求cursor是0, response中会返回下一页请求用到的cursor, 同时response还会返回has_more来表明是否有更多的数据。 |

Return type

XiGuaVideoListRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

XiguaVideoPartComplete

XiGuaVideoPartCompleteRsp XiguaVideoPartComplete(ctx, openId, accessToken, uploadId)

视频分片完成上传

视频分片完成上传

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
uploadId string 分片上传的标记。有限时间为2小时

Return type

XiGuaVideoPartCompleteRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

XiguaVideoPartInit

XiGuaVideoPartInitRsp XiguaVideoPartInit(ctx, openId, accessToken)

西瓜分片初始化上传

西瓜分片初始化上传

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。

Return type

XiGuaVideoPartInitRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

XiguaVideoPartUpload

XiGuaVideoPartUploadRsp XiguaVideoPartUpload(ctx, openId, accessToken, uploadId, partNumber, optional)

上传视频分片到文件服务器

上传视频分片到文件服务器

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
uploadId string 分片上传的标记。有限时间为2小时
partNumber int64 第几个分片，从1开始
optional *XiguaVideoPartUploadOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a XiguaVideoPartUploadOpts struct

Name Type Description Notes

video | optional.Interface of []string| |

Return type

XiGuaVideoPartUploadRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

XiguaVideoUpload

XiGuaVideoUploadRsp XiguaVideoUpload(ctx, openId, accessToken, optional)

西瓜上传视频到文件服务器

西瓜上传视频到文件服务器

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
openId string 通过/oauth/access_token/获取，用户唯一标志
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
optional *XiguaVideoUploadOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a XiguaVideoUploadOpts struct

Name Type Description Notes

video | optional.Interface of []string| |

Return type

XiGuaVideoUploadRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]