fuyao

README

发送扶摇app消息

安装

go get gitee.com/sparrow614/sparrow_cloud_go/

注意

必须配置环境变量:
SC_SPARROW_PUSH_SVC
SC_FUYAO_MESSAGE_API

发送消息示例

import (
    "gitee.com/sparrow614/sparrow_cloud_go/fuyao"
)

func main() {
    // 发送文本消息
    // 要发送的订阅消息code：task_notice，
    // 发送消息的服务：SparrowCloudGo，
    // 发送text消息：this is a 测试 消息！
    err := fuyao.SendMsg("this is a 测试 消息！", "task_notice", "text", "SparrowCloudGo")
    if err != nil {
        // handle error
    }

    // 发送图片消息
    // 要发送的订阅消息code：task_notice，
    // 发送消息的服务是：SparrowCloudGo，
    // 发送image消息，图片url：https://oss.test.com/test.png
    err = fuyao.SendMsg("https://oss.test.com/test.png", "task_notice", "image", "SparrowCloudGo", map[string]interface{}{"shop_id":2,"user_id_list":[]string{"abcdef"},"nickname":"waro","title":"image card test"})
    if err != nil {
        // handle error
    }


    // 发送markdown消息
    // 要发送的订阅消息code：task_notice，
    // 发送消息的服务是：SparrowCloudGo，
    // 发送消息msg
    msg := "### 标题\n\n BUG等级**严重**\n\n 该服务出现异常，请求成功率不可容忍，请修复"
    err = fuyao.SendMsg(msg, "task_notice", "markdown", "SparrowCloudGo")
    if err != nil {
        // handle error
    }
}

发送消息函数参数说明

SendMsg(data interface{}, codeType string, contentType string, msgSender string, kwargs ...map[string]interface{}) (restclient.Response, error)

data: 发送的消息内容
codeType: 要发送的订阅消息code
contentType: 发送消息的类型,目前支持"text","image","markdown","card_text","card_image".
msgSender: 扶摇app中展示的发送消息服务的名称，一般可以取当前发送服务的名字作为该参数的值
kwargs: 可选参数，可以添加shop_id(整型),user_id_list(字符串切片类型),nickname(字符串类型),title(字符串类型)

发送数据格式和contentType的关系

1.文本消息、图片消息、markdown消息
contentType:
    "text"/"image"/"markdown"
数据格式为：
    {
        "shop_id": 8, #int型，可为none
        "msg_sender": "测试wenwen",
        "code_type": "bowen_test",
        "user_id_list":["111","222"],   # 可为空列表
        "msg": {
            "content_type": "markdown",
            "data": "# xxx",
            "nickname": "宇智波悟空" #非必传，
        }
    }

2.文本卡片、图片卡片
contentType:
    "card_text"/"card_image"
数据格式为：
    {
        "shop_id": 8,
        "msg_sender": "测试wenwen",
        "code_type": "bowen_test",
        "user_id_list":["111","222"],
        "msg": {
            "content_type": "card_image",
            "data": "www.xxxxxxxx.comn",
            "title": "通知"
        }
    }

Documentation

Index

• func SendMsg(data interface{}, codeType string, contentType string, msgSender string, ...) (restclient.Response, error)
• type InputData
• type Msg

Functions

func SendMsg

func SendMsg(data interface{}, codeType string, contentType string, msgSender string, kwargs ...map[string]interface{}) (restclient.Response, error)

Types

type InputData

type InputData struct {
	ShopID     int      `json:"shop_id,omitempty"`
	MsgSender  string   `json:"msg_sender"`
	CodeType   string   `json:"code_type"`
	UserIDList []string `json:"user_id_list,omitempty"`
	Msg        Msg      `json:"msg"`
}

type Msg

type Msg struct {
	ContentType string      `json:"content_type"`
	Data        interface{} `json:"data"`
	NickName    string      `json:"nickname,omitempty"`
	Title       string      `json:"title,omitempty"`
}