package
2.1.8-rc.1
Repository: https://github.com/silenceper/wechat.git
Documentation: pkg.go.dev

# Functions

NewMiniDrama 实例化小程序娱乐直播 API.

# Constants

FormatError 错误码 47001 输入格式错误.
ImageTypeError 错误码 10090002 图片类型不支持.
ImageURLError 错误码 10090003 图片 URL 无效.
InitError 错误码 -2 初始化未完成,请稍后再试.
MethodError 错误码 43002 HTTP 请求必须使用 POST 方法.
OperationError 错误码 10093011 操作失败.
OperationFrequentError 错误码 10093023 操作过于频繁.
ParamError 错误码 47003 参数不符合要求.
ParamError2 错误码 10093014 参数错误(包括参数格式、类型等错误).
PostError 错误码 44002 POST 内容为空.
ResourceNotExistError 错误码 10093030 资源不存在.
ResourceType 错误码 10090005 resource_type 无效.
Success 错误码 0、成功.
SystemError 错误码 -1、系统错误.
VideoTypeError 错误码 10090001 视频类型不支持.

# Structs

ApplyUploadRequest 申请上传请求 上传大文件时需使用分片上传方式,分为 3 个步骤: 申请分片上传,确定文件名、格式类型,返回 upload_id,唯一标识本次分片上传。 上传分片,多次调用上传文件分片,需要携带 part_number 和 upload_id,其中 part_number 为分片的编号,支持乱序上传。当传入 part_number 和 upload_id 都相同的时候,后发起上传请求的分片将覆盖之前的分片。 确认分片上传,当上传完所有分片后,需要完成整个文件的合并。请求体中需要给出每一个分片的 part_number 和 etag,用来校验分片的准确性,最后返回文件的 media_id。 如果填写了 cover_type,表明本次分片上传除上传媒体文件外还需要上传封面图片,不填写 cover_type 则默认截取视频首帧作为封面。 Content-Type 需要指定为 application/json。.
ApplyUploadResponse 申请上传响应.
AsyncMediaAuditEvent 异步媒体审核事件 see: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/mini-drama/mini_drama.html#_5-2-%E5%AE%A1%E6%A0%B8%E7%8A%B6%E6%80%81%E4%BA%8B%E4%BB%B6.
AsyncMediaUploadEvent 异步媒体上传事件 see: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/mini-drama/mini_drama.html#_5-1-%E5%AA%92%E8%B5%84%E4%B8%8A%E4%BC%A0%E5%AE%8C%E6%88%90%E4%BA%8B%E4%BB%B6.
AuditDramaRequest 审核剧目请求 该接口用于审核剧目,审核通过后,剧目下所有剧集都会被审核通过。 注意事项 Content-Type 需要指定为 application/json。 剧目信息与审核材料在首次提审时为必填,重新提审时根据是否需要修改选填, 本接口中使用的临时图片 material_id 可通过新增临时素材接口上传得到,对应临时素材接口中的 media_id,本文档中为避免与剧集的 media_id 混淆,称其为 material_id。 新增临时素材接口可以被小程序调用,调用的小程序账号和剧目提审的小程序账号必须是同一个,否则提交审核时会无法识别素材 id。.
AuditDramaResponse 审核剧目响应.
CdnLogInfo CDN 日志信息.
CommitUploadRequest 确认分片上传请求 该接口用于完成整个分片上传流程,合并所有文件分片,确认媒体文件(和封面图片文件)上传到平台的结果,返回文件的 ID。请求中需要给出每一个分片的 part_number 和 etag,用来校验分片的准确性。 注意事项 Content-Type 需要指定为 application/json。 调用该接口之前必须先调用申请分片上传接口以及上传分片接口。 如本次分片上传除上传媒体文件外还需要上传封面图片,则请求中还需提供 cover_part_infos 字段以用于合并封面图片文件分片。 请求中 media_part_infos 和 cover_part_infos 字段必须按 part_number 从小到大排序,part_number 必须从 1 开始,连续且不重复。.
CommitUploadResponse 确认分片上传响应.
DataItem 数据项.
DeleteMediaRequest 删除媒体请求 该接口用于删除已上传到平台的指定媒资文件,用于开发者后台管理使用。 Content-Type 需要指定为 application/json。.
DeleteMediaResponse 删除媒体响应.
DramaAuditDetail 剧目审核详情.
DramaInfo 剧目信息.
DramaMediaInfo 剧目媒体信息.
GetCdnLogsRequest 获取 CDN 日志下载链接请求 该接口用于获取点播 CDN 日志下载链接。 注意事项 可以查询最近 30 天内的 CDN 日志下载链接。 默认情况下 CDN 每小时生成一个日志文件,如果某一个小时没有 CDN 访问,不会生成日志文件。 CDN 日志下载链接的有效期为 24 小时。 日志字段依次为:请求时间、客户端 IP、访问域名、文件路径、字节数、省级编码、运营商编码、HTTP 状态码、referer、Request-Time、UA、range、HTTP Method、协议标识、缓存 HIT / MISS,日志数据打包存在延迟,正常情况下 3 小时后数据包趋于完整日志中的字节数为应用层数据大小,未考虑网络协议包头、加速重传等开销,因此与计费数据存在一定差异。 CDN 日志中记录的下行字节数统计而来的流量数据,是应用层数据。在实际网络传输中,产生的网络流量要比纯应用层流量多 5%-15%,比如 TCP/IP 协议的包头消耗、网络丢包重传等,这些无法被应用层统计到。在业内标准中,计费用流量一般在应用层流量的基础上加上上述开销,媒资管理服务中计费的加速流量约为日志计算加速流量的 110%。 省份映射 22:北京;86:内蒙古;146:山西;1069:河北;1177:天津;119:宁夏;152:陕西;1208:甘肃;1467:青海;1468:新疆;145:黑龙江;1445:吉林;1464:辽宁;2:福建;120:江苏;121:安徽;122:山东;1050:上海;1442:浙江;182:河南;1135:湖北;1465:江西;1466:湖南;118:贵州;153:云南;1051:重庆;1068:四川;1155:西藏;4:广东;173:广西;1441:海南;0:其他;1:港澳台;-1:海外。 运营商映射 2:中国电信;26:中国联通;38:教育网;43:长城宽带;1046:中国移动;3947:中国铁通;-1:海外运营商;0:其他运营商。.
GetCdnLogsResponse 获取 CDN 日志下载链接响应.
GetCdnUsageDataRequest 获取 CDN 用量数据请求 该接口用于查询点播 CDN 的流量数据。 注意事项 可以查询最近 365 天内的 CDN 用量数据。 查询时间跨度不超过 90 天。 可以指定用量数据的时间粒度,支持 5 分钟、1 小时、1 天的时间粒度。 流量为查询时间粒度内的总流量。.
GetCdnUsageDataResponse 获取 CDN 用量数据响应.
GetDramaRequest 获取剧目请求 该接口用于查询已提交的剧目。 注意事项 Content-Type 需要指定为 application/json。 本接口返回的图片链接均为临时链接,不应将其保存下来。 如果剧目审核结果为失败或驳回,则具体每一集的具体驳回理由及证据截图可通过“获取媒资列表”或者“获取媒资详细信息”接口来获取。.
GetDramaResponse 获取剧目响应.
GetMediaLinkRequest 获取媒体链接请求 该接口用于获取视频临时播放链接,用于给用户的播放使用。只有审核通过的视频才能通过该接口获取播放链接。 注意事项 Content-Type 需要指定为 application/json。 本接口返回的视频或图片链接均为临时链接,不应将其保存下来。 能不能获取播放链接取决于剧目审核状态,可能存在单个剧集的状态为审核通过,但是剧目整体是未通过的情况,这种情况也没法获取播放链接。 开发者如需区分不同渠道的播放流量或次数,可以在 us 参数中传入渠道标识,这样得到的播放链接中 us 参数的前半部分就包含有渠道标识。开发者把这个带有渠道标识的链接分发给对应的渠道播放,就能统计到不同渠道播放情况。统计的数据来源为 CDN 日志(从 getcdnlogs 接口得到),CDN 日志中“文件路径”列中的参数也带有该标识,再结合日志中“字节数”列的流量数值,估算每个渠道所消耗的流量。另需注意日志统计的流量和扣费流量的差异,详情参考 getcdnlogs 接口中的注意事项。.
GetMediaLinkResponse 获取媒体链接响应.
GetMediaRequest 获取媒体请求 该接口用于获取已上传到平台的指定媒资信息,用于开发者后台管理使用。用于给用户客户端播放的链接应该使用 getmedialink 接口获取。 Content-Type 需要指定为 application/json。 本接口返回的视频或图片链接均为临时链接,不应将其保存下来。.
GetMediaResponse 获取媒体响应.
GetTaskRequest 查询任务请求 该接口用于查询拉取上传的任务状态。 Content-Type 需要指定为 application/json。.
GetTaskResponse 查询任务响应.
ListDramasRequest 查询剧目列表请求 该接口用于获取已提交的剧目列表。 注意事项 Content-Type 需要指定为 application/json。 本接口返回的图片链接均为临时链接,不应将其保存下来。 如果剧目审核结果为失败或驳回,则具体每一集的具体驳回理由及证据截图可通过“获取媒资列表”或者“获取媒资详细信息”接口来获取。.
ListDramasResponse 查询剧目列表响应.
ListMediaRequest 查询媒体列表请求 该接口用于查询已经上传到平台的媒体文件列表。 注意事项 Content-Type 需要指定为 application/json。 本接口返回的视频或图片链接均为临时链接,不应将其保存下来。 media_name 参数支持模糊匹配,当需要模糊匹配时可以在前面或后面加上 %,否则为精确匹配。例如 "test%" 可以匹配到 "test123", "testxxx", "test"。 调用方式.
ListMediaResponse 查询媒体列表响应.
MediaAuditDetail 媒体审核详情.
MediaInfo 媒体信息.
MediaPlaybackInfo 媒体播放信息.
MiniDrama mini program entertainment live broadcast related.
PartInfo 分片信息.
PullUploadRequest 拉取上传请求 不填写 cover_url 字段时默认截取视频首帧作为封面。 Content-Type 需要指定为 application/json 该接口为异步接口,上传完成会推送上传完成事件到开发者服务器,开发者也可以调用"查询任务"接口来轮询上传结果。.
PullUploadResponse 拉取上传响应.
ReplaceInfo 替换信息.
SingleFileUploadRequest 单文件上传请求 Content-Type 需要指定为 multipart/form-data; boundary=<delimiter> <箭头括号> 表示必须替换为有效值的变量。 不填写 cover_type,cover_data 字段时默认截取视频首帧作为视频封面。.
SingleFileUploadResponse 单文件上传响应.
TaskInfo 任务信息.
UploadPartRequest 上传分片请求 将文件的其中一个分片上传到平台,最多支持 100 个分片,每个分片大小为 5MB,最后一个分片可以小于 5MB。该接口适用于视频和封面图片。视频最大支持 500MB,封面图片最大支持 10MB。 调用该接口之前必须先调用申请分片上传接口。 在申请分片上传时,如果不填写 cover_type,则默认截取视频首帧作为封面。 Content-Type 需要指定为 multipart/form-data; boundary=<delimiter>,<箭头括号>表示必须替换为有效值的变量。 part_number 从 1 开始。如除了上传视频外还需要上传封面图片,则封面图片的 part_number 需重新从 1 开始编号。.
UploadPartResponse 上传分片响应.

# Type aliases

ErrCode error code.