template

Documentation

Overview

模板消息接口.

Index

• Constants
• type Client
  • func NewClient(srv mp.AccessTokenServer, clt *http.Client) *Client
  • func (clt *Client) AddTemplate(templateIdShort string) (templateId string, err error)
  • func (clt *Client) DeletePrivateTemplate(templateID string) (err error)
  • func (clt *Client) GetAllPrivateTemplate() (templateList []Template, err error)
  • func (clt *Client) GetIndustry() (primaryIndustry, secondaryIndustry Industry, err error)
  • func (clt *Client) Send(msg *TemplateMessage) (msgid int64, err error)
  • func (clt *Client) SetIndustry(industryId ...int64) (err error)
• type Industry
• type Template
• type TemplateMessage
• type TemplateSendJobFinishEvent
  • func GetTemplateSendJobFinishEvent(msg *mp.MixedMessage) *TemplateSendJobFinishEvent

Constants

const (
	TemplateSendStatusSuccess            = "success"               // 送达成功时
	TemplateSendStatusFailedUserBlock    = "failed:user block"     // 送达由于用户拒收(用户设置拒绝接收公众号消息)而失败
	TemplateSendStatusFailedSystemFailed = "failed: system failed" // 送达由于其他原因失败
)

const (
	EventTypeTemplateSendJobFinish = "TEMPLATESENDJOBFINISH"
)

Types

type Client

type Client mp.Client

func NewClient

func NewClient(srv mp.AccessTokenServer, clt *http.Client) *Client

func (*Client) AddTemplate

func (clt *Client) AddTemplate(templateIdShort string) (templateId string, err error)

从行业模板库选择模板添加到账号后台, 并返回模板id.

templateIdShort: 模板库中模板的编号, 有"TM**"和"OPENTMTM**"等形式.

func (*Client) DeletePrivateTemplate

func (clt *Client) DeletePrivateTemplate(templateID string) (err error)

删除模板

func (*Client) GetAllPrivateTemplate

func (clt *Client) GetAllPrivateTemplate() (templateList []Template, err error)

获取模板列表

func (*Client) GetIndustry

func (clt *Client) GetIndustry() (primaryIndustry, secondaryIndustry Industry, err error)

获取设置的行业信息

func (*Client) Send

func (clt *Client) Send(msg *TemplateMessage) (msgid int64, err error)

发送模板消息

func (*Client) SetIndustry

func (clt *Client) SetIndustry(industryId ...int64) (err error)

设置所属行业.

目前 industryId 的个数只能为 2.

type Industry

type Industry struct {
	FirstClass  string `json:"first_class"`
	SecondClass string `json:"second_class"`
}

type Template

type Template struct {
	TemplateId      string `json:"template_id"`      //模板ID
	Title           string `json:"title"`            //模板标题
	PrimaryIndustry string `json:"primary_industry"` //模板所属行业的一级行业
	DeputyIndustry  string `json:"deputy_industry"`  //模板所属行业的二级行业
	Content         string `json:"content"`          //模板内容
	Example         string `json:"example"`          //模板示例
}

type TemplateMessage

type TemplateMessage struct {
	ToUser     string `json:"touser"`             // 必须, 接受者OpenID
	TemplateId string `json:"template_id"`        // 必须, 模版ID
	URL        string `json:"url,omitempty"`      // 可选, 用户点击后跳转的URL, 该URL必须处于开发者在公众平台网站中设置的域中
	TopColor   string `json:"topcolor,omitempty"` // 可选, 整个消息的颜色, 可以不设置

	RawJSONData json.RawMessage `json:"data"` // 必须, JSON 格式的 []byte, 满足特定的模板需求
}

type TemplateSendJobFinishEvent

type TemplateSendJobFinishEvent struct {
	XMLName struct{} `xml:"xml" json:"-"`
	mp.MessageHeader

	Event  string `xml:"Event"  json:"Event"` // 事件信息, 此处为 TEMPLATESENDJOBFINISH
	MsgId  int64  `xml:"MsgId"  json:"MsgId"` // 模板消息ID
	Status string `xml:"Status" json:"Status"`
}

在模版消息发送任务完成后, 微信服务器会将是否送达成功作为通知, 发送到开发者中心中填写的服务器配置地址中.

func GetTemplateSendJobFinishEvent

func GetTemplateSendJobFinishEvent(msg *mp.MixedMessage) *TemplateSendJobFinishEvent