freepublish

Documentation

Index

• type Article
• type ArticleList
• type ArticleListContent
• type ArticleListItem
• type FreePublish
  • func NewFreePublish(ctx *context.Context) *FreePublish
  • func (freePublish *FreePublish) Delete(articleID string, index uint) (err error)
  • func (freePublish *FreePublish) First(articleID string) (list []Article, err error)
  • func (freePublish *FreePublish) Paginate(offset, count int64, noReturnContent bool) (list ArticleList, err error)
  • func (freePublish *FreePublish) Publish(mediaID string) (publishID int64, err error)
  • func (freePublish *FreePublish) SelectStatus(publishID int64) (list PublishStatusList, err error)
• type PublishArticleDetail
• type PublishArticleItem
• type PublishStatus
• type PublishStatusList

Types

type Article

type Article struct {
	Title              string `json:"title"`                 // 标题
	Author             string `json:"author"`                // 作者
	Digest             string `json:"digest"`                // 图文消息的摘要，仅有单图文消息才有摘要，多图文此处为空
	Content            string `json:"content"`               // 图文消息的具体内容，支持HTML标签，必须少于2万字符，小于1M，且此处会去除JS
	ContentSourceURL   string `json:"content_source_url"`    // 图文消息的原文地址，即点击“阅读原文”后的URL
	ThumbMediaID       string `json:"thumb_media_id"`        // 图文消息的封面图片素材id（一定是永久MediaID）
	ShowCoverPic       uint   `json:"show_cover_pic"`        // 是否显示封面，0为false，即不显示，1为true，即显示(默认)
	NeedOpenComment    uint   `json:"need_open_comment"`     // 是否打开评论，0不打开(默认)，1打开
	OnlyFansCanComment uint   `json:"only_fans_can_comment"` // 是否粉丝才可评论，0所有人可评论(默认)，1粉丝才可评论
	URL                string `json:"url"`                   // 图文消息的URL
	IsDeleted          bool   `json:"is_deleted"`            // 该图文是否被删除
}

Article 图文信息内容

type ArticleList

type ArticleList struct {
	util.CommonError
	TotalCount int64             `json:"total_count"` // 成功发布素材的总数
	ItemCount  int64             `json:"item_count"`  // 本次调用获取的素材的数量
	Item       []ArticleListItem `json:"item"`
}

ArticleList 发布列表

type ArticleListContent

type ArticleListContent struct {
	NewsItem []Article `json:"news_item"` // 这篇图文消息素材的内容
}

ArticleListContent 用于 ArticleListItem 的 content 节点

type ArticleListItem

type ArticleListItem struct {
	ArticleID  string             `json:"article_id"`  // 成功发布的图文消息id
	Content    ArticleListContent `json:"content"`     // 内容
	UpdateTime int64              `json:"update_time"` // 这篇图文消息素材的最后更新时间
}

ArticleListItem 用于 ArticleList 的 item 节点

type FreePublish

type FreePublish struct {
	*context.Context
}

FreePublish 发布能力

func NewFreePublish

func NewFreePublish(ctx *context.Context) *FreePublish

NewFreePublish init

func (*FreePublish) Delete

func (freePublish *FreePublish) Delete(articleID string, index uint) (err error)

Delete 删除发布。 index 要删除的文章在图文消息中的位置，第一篇编号为1，该字段不填或填0会删除全部文章 !!!此操作不可逆，请谨慎操作!!!删除后微信公众号后台仍然会有记录!!!

func (*FreePublish) First

func (freePublish *FreePublish) First(articleID string) (list []Article, err error)

First 通过 article_id 获取已发布文章

func (*FreePublish) Paginate

func (freePublish *FreePublish) Paginate(offset, count int64, noReturnContent bool) (list ArticleList, err error)

Paginate 获取成功发布列表

func (*FreePublish) Publish

func (freePublish *FreePublish) Publish(mediaID string) (publishID int64, err error)

Publish 发布接口。需要先将图文素材以草稿的形式保存（见“草稿箱/新建草稿”， 如需从已保存的草稿中选择，见“草稿箱/获取草稿列表”），选择要发布的草稿 media_id 进行发布

func (*FreePublish) SelectStatus

func (freePublish *FreePublish) SelectStatus(publishID int64) (list PublishStatusList, err error)

SelectStatus 发布状态轮询接口

type PublishArticleDetail

type PublishArticleDetail struct {
	Count uint                 `json:"count"` // 当发布状态为0时（即成功）时，返回文章数量
	Items []PublishArticleItem `json:"item"`
}

PublishArticleDetail 发布任务成功详情

type PublishArticleItem

type PublishArticleItem struct {
	Index      uint   `json:"idx"`         // 当发布状态为0时（即成功）时，返回文章对应的编号
	ArticleURL string `json:"article_url"` // 当发布状态为0时（即成功）时，返回图文的永久链接
}

PublishArticleItem 发布任务成功的文章内容

type PublishStatus

type PublishStatus uint

PublishStatus 发布状态

const (
	// PublishStatusSuccess 0:成功
	PublishStatusSuccess PublishStatus = iota
	// PublishStatusPublishing 1:发布中
	PublishStatusPublishing
	// PublishStatusOriginalFail 2:原创失败
	PublishStatusOriginalFail
	// PublishStatusFail 3:常规失败
	PublishStatusFail
	// PublishStatusAuditRefused 4:平台审核不通过
	PublishStatusAuditRefused
	// PublishStatusUserDeleted 5:成功后用户删除所有文章
	PublishStatusUserDeleted
	// PublishStatusSystemBanned 6:成功后系统封禁所有文章
	PublishStatusSystemBanned
)

type PublishStatusList

type PublishStatusList struct {
	util.CommonError
	PublishID     int64                `json:"publish_id"`     // 发布任务id
	PublishStatus PublishStatus        `json:"publish_status"` // 发布状态
	ArticleID     string               `json:"article_id"`     // 当发布状态为0时（即成功）时，返回图文的 article_id，可用于“客服消息”场景
	ArticleDetail PublishArticleDetail `json:"article_detail"` // 发布任务文章成功状态详情
	FailIndex     []uint               `json:"fail_idx"`       // 当发布状态为2或4时，返回不通过的文章编号，第一篇为 1；其他发布状态则为空
}

PublishStatusList 发布任务状态列表