pushapi

README

Go-Push-API

MiPush、JiPush、UMeng API Server SDK for Golang.

MiPush

The Xiaomi message push service is a system-level channel on MIUI and is universal across the platform, which can provide developers with stable, reliable, and efficient push services.

JiPush

Aurora, push, authentication, SMS, magic chain RESTFul API Go SDK, including auroral push (JPush), auroral magic chain (JMLink), auroral SMS (JSMS), auroral authentication (JVerification) and other related open source projects.

Installation

go get -u -v github.com/houseme/go-push-api@main

Quick Start

package main

Contributors

You can contribute in one of three ways:

1. File bug reports using the issue tracker.
2. Answer questions or fix bugs on the issue tracker.
3. Contribute new features or update the wiki.

License

The Go-Push-API is open-sourced software licensed under the MIT license.

Security

Documentation

Index

• func BatchSubscribeTopicByAlias(builder *builder.Builder, params mi.Params) (*mi.Result, error)
• func BatchSubscribeTopicByRegIds(builder *builder.Builder, params mi.Params) (*mi.Result, error)
• func BatchUnSubscribeTopicByAlias(builder *builder.Builder, params mi.Params) (*mi.Result, error)
• func DealTopic(builder *builder.Builder, params mi.Params) error
• func GetMessageStatus(builder *builder.Builder, params mi.Params) (*mi.Result, error)
• func RevokeMessage(builder *builder.Builder, params mi.Params) (*mi.Result, error)
• func SendMessage(builder *builder.Builder, params mi.Params) (*mi.Result, error)
• func SubscribeTopicByAlias(builder *builder.Builder, params mi.Params) (*mi.Result, error)
• func SubscribeTopicByRegID(builder *builder.Builder, params mi.Params) (*mi.Result, error)
• func UnSubscribeTopicByAlias(builder *builder.Builder, params mi.Params) (*mi.Result, error)
• func UnSubscribeTopicByRegID(builder *builder.Builder, params mi.Params) (*mi.Result, error)
• type Jums
  • func NewClient(ctx context.Context, key, secret string) *Jums
  • func (j *Jums) SendPush(ctx context.Context, client *jums.Jums, title, content, url string, ...) error
  • func (j *Jums) SendSms(tempID int, phone, code, signID string) error

Functions

func BatchSubscribeTopicByAlias

func BatchSubscribeTopicByAlias(builder *builder.Builder, params mi.Params) (*mi.Result, error)

BatchSubscribeTopicByAlias 批量注册主题

func BatchSubscribeTopicByRegIds

func BatchSubscribeTopicByRegIds(builder *builder.Builder, params mi.Params) (*mi.Result, error)

BatchSubscribeTopicByRegIds 批量注册主题

func BatchUnSubscribeTopicByAlias

func BatchUnSubscribeTopicByAlias(builder *builder.Builder, params mi.Params) (*mi.Result, error)

BatchUnSubscribeTopicByAlias 批量注册主题

func DealTopic

func DealTopic(builder *builder.Builder, params mi.Params) error

DealTopic 处理topic

func GetMessageStatus

func GetMessageStatus(builder *builder.Builder, params mi.Params) (*mi.Result, error)

GetMessageStatus 获取消息状态

func RevokeMessage

func RevokeMessage(builder *builder.Builder, params mi.Params) (*mi.Result, error)

RevokeMessage 消息退回

func SendMessage

func SendMessage(builder *builder.Builder, params mi.Params) (*mi.Result, error)

SendMessage 发送消息

func SubscribeTopicByAlias

func SubscribeTopicByAlias(builder *builder.Builder, params mi.Params) (*mi.Result, error)

SubscribeTopicByAlias 通过别名订阅topic

func SubscribeTopicByRegID

func SubscribeTopicByRegID(builder *builder.Builder, params mi.Params) (*mi.Result, error)

SubscribeTopicByRegID 注册topic

func UnSubscribeTopicByAlias

func UnSubscribeTopicByAlias(builder *builder.Builder, params mi.Params) (*mi.Result, error)

UnSubscribeTopicByAlias 通过别名取消注册topic

func UnSubscribeTopicByRegID

func UnSubscribeTopicByRegID(builder *builder.Builder, params mi.Params) (*mi.Result, error)

UnSubscribeTopicByRegID 通过regId取消注册topic

Types

type Jums

type Jums struct {
	// contains filtered or unexported fields
}

Jums 推送客户端

func NewClient

func NewClient(ctx context.Context, key, secret string) *Jums

NewClient 创建推送客户端

func (*Jums) SendPush

func (j *Jums) SendPush(ctx context.Context, client *jums.Jums, title, content, url string, aud []string) error

SendPush 发送推送

func (*Jums) SendSms

func (j *Jums) SendSms(tempID int, phone, code, signID string) error

SendSms 发送短信