PHP实现支付宝小程序发送模板消息的工具类

头像
crelaber
    阅读 15 分钟
    14

    背景

    最近公司项目一直在围绕着支付宝做应用开发，为了能保证消息能够及时的给用户传递，因此需要开发模板消息的功能，而小程序的模板消息也是最快捷的通知方式

    事先准备

    1、请仔细阅读支付宝模板消息发送指引：模板消息指引
    2、仔细阅读用户的授权文档，用户授权的详细的实现步骤可以见我写的另外一篇文章：《PHP实现支付宝小程序用户授权的工具类》
    3、在小程序中加入模板消息的权限，如下图

    clipboard.png
    4、仔细阅读支付宝发送模板消息接口文档：alipay.open.app.mini.templatemessage.send
    5、事先通过小程序的form组件收集好对一个的formid，formid组件文档
    6、将小程序绑定到生活号上
    7、配置一个模板消息编号，详细步骤：小程序--->模板消息，最终配置号的模板消息如下

    clipboard.png

    实现流程

    1、通过客户端的form组件，收集好formid，并单独开一个后端接口将formid通过http请求保存到后台，最好是尽可能多的收集formid，比如按钮的点击事件、tab的切换上都可以增加formid组件
    2、通过调用alipay.open.app.mini.templatemessage.send接口，给客户端发送模板消息 ，注意支付宝所有的模板消息都是基于生活号进行分发的，所以事先一定要绑定好对应的生活号

    实现方法

    相关常量

    //模板消息的接口方法名称
const API_METHOD_SEND_TPL_MSG = 'alipay.open.app.mini.templatemessage.send';
//模板消息的结果返回节点名称
const RESPONSE_OUTER_NODE_SEND_TPL_MSG = 'alipay_open_app_mini_templatemessage_send_response';

    入口方法

    /**
     * 发送小程序模板消息
     * @param $formId
     * @param $to 发送给用户的编号
     * @param $tplId 模板编号
     * @param $tplContent 模板内容
     * @param $page 要跳转的页面
     * @return array
     */
    public static function sendAmpTplMsg($formId,$to,$tplId,$tplContent,$page = ''){
        $param = self::getTplMsgBaseParam($formId,$to,$tplId,$tplContent,$page = '');
        $url = self::buildRequestUrl($param);
        $response = self::getResponse($url,self::RESPONSE_OUTER_NODE_SEND_TPL_MSG);
        return $response;
    }

    获取基础参数方法

    /**
     * 获取发送模板消息的接口参数
     */
    protected static function getTplMsgBaseParam($formId,$to,$tplId,$tplContent,$page = ''){
        $baseParam = [
            'to_user_id' => $to,
            'form_id' => $formId,
            'user_template_id' => $tplId,
            'page' => $page,
            'data' => $tplContent,
        ];
        $bizContent = json_encode($baseParam,JSON_UNESCAPED_UNICODE);
        $busiParam = [
            'biz_content' => $bizContent
        ];
        $param = self::buildApiBuisinessParam($busiParam,self::API_METHOD_SEND_TPL_MSG);
        return $param;
    }
    
    /**
     * 构建业务参数
     */
    protected static function buildApiBuisinessParam($businessParam,$apiMethod){
        $pubParam = self::getApiPubParam($apiMethod);
        $businessParam = array_merge($pubParam,$businessParam);
        $signContent = self::getSignContent($businessParam);
        error_log('sign_content ===========>'.$signContent);
        $rsaHelper = new RsaHelper();
        $sign = $rsaHelper->createSign($signContent);
        error_log('sign ===========>'.$sign);
        $businessParam['sign'] = $sign;
        return $businessParam;
    }
    
    /**
     * 公共参数
     *
     */
    protected static function getApiPubParam($apiMethod){
        $ampBaseInfo = BusinessHelper::getAmpBaseInfo();
        $param = [
            'timestamp' => date('Y-m-d H:i:s') ,
            'method' => $apiMethod,
            'app_id' => formatArrValue($ampBaseInfo,'appid',config('param.amp.appid')),
            'sign_type' =>self::SIGN_TYPE_RSA2,
            'charset' =>self::FILE_CHARSET_UTF8,
            'version' =>self::VERSION,
        ];
        return $param;
    }
    
    /**
     * 获取签名的内容
     */
    protected static function getSignContent($params) {
        ksort($params);
        $stringToBeSigned = "";
        $i = 0;
        foreach ($params as $k => $v) {
            if (!empty($v) && "@" != substr($v, 0, 1)) {
                if ($i == 0) {
                    $stringToBeSigned .= "$k" . "=" . "$v";
                } else {
                    $stringToBeSigned .= "&" . "$k" . "=" . "$v";
                }
                $i++;
            }
        }
        unset ($k, $v);
        return $stringToBeSigned;
    }
    
    /**
     * 构建请求链接
     */
    protected static function buildRequestUrl($param){
        $paramStr = http_build_query($param);
        return self::API_DOMAIN . $paramStr;
    }

    获取返回的结果值

    /**
     * 获取返回的数据，对返回的结果做进一步的封装和解析
     */
    protected static function getResponse($url,$responseNode){
        $json = curlRequest($url);
        error_log("result is =========>".$json);
        $response = json_decode($json,true);
        $responseContent = formatArrValue($response,$responseNode,[]);
        $errResponse = formatArrValue($response,self::RESPONSE_OUTER_NODE_ERROR_RESPONSE,[]);
        if($errResponse){
            return $errResponse;
        }
        return $responseContent;
    }

    返回结果

    如果返回的节点code为10000,则表示消息发送

    {
    "alipay_open_app_mini_templatemessage_send_response":{
        "code":"10000",
        "msg":"Success"
      }
    ,"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

    调用

    $formId = 'MjA4ODMwMjI2MjE4Mzc4MF8xNTQ2ODQ0MTUyNzU0XzA1NQ==';
$openId = '2088302262183780';
$tplId = 'Mzc4OTk2ODU1YzM4NTI3NmY5ZjI2OTdhNGNkZDE2NGQ=';
$content = [
    'keyword1' => [
        'value' => '您的朋友【】偷去了你的能量啦~',
    ],
    'keyword2' => [
        'value' => '朋友偷能量提醒',
    ],
    'keyword3' => [
        'value' => '点我查看详情',
    ],
];
$result = AmpHelper::sendAmpTplMsg($formId,$openId,$tplId,$content,$page= 'pages/index/index');

    效果图

    clipboard.png

    附录：完整的工具类

    <?php
/**
 * Created by PhpStorm.
 * User: My
 * Date: 2018/8/16
 * Time: 17:45
 */

namespace App\Http\Helper;

use App\Http\Helper\Sys\BusinessHelper;
use Illuminate\Support\Facades\Log;

class AmpHelper
{

    const API_DOMAIN = "https://openapi.alipay.com/gateway.do?";
    const API_METHOD_GENERATE_QR = 'alipay.open.app.qrcode.create';
    const API_METHOD_AUTH_TOKEN = 'alipay.system.oauth.token';
    const API_METHOD_GET_USER_INFO = 'alipay.user.info.share';
    const API_METHOD_SEND_TPL_MSG = 'alipay.open.app.mini.templatemessage.send';
    const API_METHOD_TRADE_PAY = 'alipay.trade.create';

    const SIGN_TYPE_RSA2 = 'RSA2';
    const VERSION = '1.0';
    const FILE_CHARSET_UTF8 = "UTF-8";
    const FILE_CHARSET_GBK = "GBK";
    const RESPONSE_OUTER_NODE_QR = 'alipay_open_app_qrcode_create_response';
    const RESPONSE_OUTER_NODE_AUTH_TOKEN = 'alipay_system_oauth_token_response';
    const RESPONSE_OUTER_NODE_USER_INFO = 'alipay_user_info_share_response';
    const RESPONSE_OUTER_NODE_SEND_TPL_MSG = 'alipay_open_app_mini_templatemessage_send_response';
    const RESPONSE_OUTER_NODE_TRADE_PAY = 'alipay_trade_create_response';
    const RESPONSE_OUTER_NODE_ERROR_RESPONSE = 'error_response';

    const STATUS_CODE_SUCCESS = 10000;
    const STATUS_CODE_EXCEPT = 20000;


    /**
     * 获取用户信息接口，根据token
     * @param $code 授权码
     * 通过授权码获取用户的信息
     */
    public static function getAmpUserInfoByAuthCode($code){
        $aliUserInfo = [];
        $tokenData = AmpHelper::getAmpToken($code);
        //如果token不存在，这种主要是为了处理支付宝的异常记录
        if(isset($tokenData['code'])){
            return $tokenData;
        }
        $token = formatArrValue($tokenData,'access_token');
        if($token){
            $userBusiParam = self::getAmpUserBaseParam($token);
            $url = self::buildRequestUrl($userBusiParam);
            $resonse = self::getResponse($url,self::RESPONSE_OUTER_NODE_USER_INFO);
            if($resonse['code'] == self::STATUS_CODE_SUCCESS){
                //有效的字段列
                $userInfoColumn = ['user_id','avatar','province','city','nick_name','is_student_certified','user_type','user_status','is_certified','gender'];
                foreach ($userInfoColumn as $column){
                    $aliUserInfo[$column] = formatArrValue($resonse,$column,'');
                }

            }else{
                $exceptColumns = ['code','msg','sub_code','sub_msg'];
                foreach ($exceptColumns as $column){
                    $aliUserInfo[$column] = formatArrValue($resonse,$column,'');
                }
            }
        }
        return $aliUserInfo;
    }


    /**
     * 获取小程序token接口
     */
    public static function getAmpToken($code){
        $param = self::getAuthBaseParam($code);
        $url = self::buildRequestUrl($param);
        $response = self::getResponse($url,self::RESPONSE_OUTER_NODE_AUTH_TOKEN);
        $tokenResult = [];
        if(isset($response['code']) && $response['code'] != self::STATUS_CODE_SUCCESS){
            $exceptColumns = ['code','msg','sub_code','sub_msg'];
            foreach ($exceptColumns as $column){
                $tokenResult[$column] = formatArrValue($response,$column,'');
            }
        }else{
            $tokenResult = $response;
        }
        return $tokenResult;
    }

    /**
     * 获取二维码链接接口
     * 433ac5ea4c044378826afe1532bcVX78
     * https://openapi.alipay.com/gateway.do?timestamp=2013-01-01 08:08:08&method=alipay.open.app.qrcode.create&app_id=2893&sign_type=RSA2&sign=ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE&version=1.0&biz_content=
    {"url_param":"/index.html?name=ali&loc=hz", "query_param":"name=1&age=2", "describe":"二维码描述"}
    */
    public static function generateQrCode($mpPage = 'pages/index',$queryParam = [],$describe){
        $param = self::getQrcodeBaseParam($mpPage,$queryParam,$describe );
        $url = self::buildRequestUrl($param);
        $response = self::getResponse($url,self::RESPONSE_OUTER_NODE_QR);
        return $response;
    }


    /**
     * 发送小程序模板消息
     * @param $formId
     * @param $to 发送给用户的编号
     * @param $tplId 模板编号
     * @param $tplContent 模板内容
     * @param $page 要跳转的页面
     * @return array
     */
    public static function sendAmpTplMsg($formId,$to,$tplId,$tplContent,$page = ''){
        $param = self::getTplMsgBaseParam($formId,$to,$tplId,$tplContent,$page = '');
        $url = self::buildRequestUrl($param);
        $response = self::getResponse($url,self::RESPONSE_OUTER_NODE_SEND_TPL_MSG);
        return $response;
    }

    /**
     * 获取支付的方法
     */
    public static function tradePay($outTradeNo,$totalAmount,$subject,$body = ''){
        $param = self::getTradePayBaseParam($outTradeNo,$totalAmount,$subject,$body);
        $result = self::doBusiness($param,self::RESPONSE_OUTER_NODE_TRADE_PAY);
        return $result;
    }


    /**
     * 获取返回的数据，对返回的结果做进一步的封装和解析
     */
    protected static function getResponse($url,$responseNode){
        $json = curlRequest($url);
        error_log("result is =========>".$json);
        $response = json_decode($json,true);
        $responseContent = formatArrValue($response,$responseNode,[]);
        $errResponse = formatArrValue($response,self::RESPONSE_OUTER_NODE_ERROR_RESPONSE,[]);
        if($errResponse){
            return $errResponse;
        }
        return $responseContent;
    }


    /**
     * 开始所有的业务并获取相应的结果
     */
    protected static function doBusiness($busiParam,$reponseNode){
        $url = self::buildRequestUrl($busiParam);
        $response = self::getResponse($url,$reponseNode);
        return $response;
    }

    /**
     * 获取请求的链接
     */
    protected static function buildQrRequestUrl($mpPage = 'pages/index',$queryParam = []){
        $paramStr = http_build_query(self::getQrBaseParam($mpPage,$queryParam));
        return self::API_DOMAIN . $paramStr;
    }



    /**
     * 构建请求链接
     */
    protected static function buildRequestUrl($param){
        $paramStr = http_build_query($param);
        return self::API_DOMAIN . $paramStr;
    }


    /**
     * 获取用户的基础信息接口
     */
    protected static function getAmpUserBaseParam($token){
        $busiParam = [
            'auth_token' => $token,
        ];
        $param = self::buildApiBuisinessParam($busiParam,self::API_METHOD_GET_USER_INFO);
        return $param;

    }

    /**
     *获取二维码的基础参数
     */
    protected static function getQrcodeBaseParam($page= 'pages/index/index',$queryParam = [],$describe = ''){
        $busiParam = [
            'biz_content' => self::getQrBizContent($page,$queryParam,$describe)
        ];
        $param = self::buildApiBuisinessParam($busiParam,self::API_METHOD_GENERATE_QR);
        return $param;

    }

    /**
     *获取授权的基础参数
     */
    protected static function getAuthBaseParam($code,$refreshToken = ''){
        $busiParam = [
            'grant_type' => 'authorization_code',
            'code' => $code,
            'refresh_token' => $refreshToken,
        ];
        $param = self::buildApiBuisinessParam($busiParam,self::API_METHOD_AUTH_TOKEN);
        return $param;
    }

    /**
     * 获取发送模板消息的接口参数
     */
    protected static function getTplMsgBaseParam($formId,$to,$tplId,$tplContent,$page = ''){
        $baseParam = [
            'to_user_id' => $to,
            'form_id' => $formId,
            'user_template_id' => $tplId,
            'page' => $page,
            'data' => $tplContent,
        ];
        $bizContent = json_encode($baseParam,JSON_UNESCAPED_UNICODE);
        $busiParam = [
            'biz_content' => $bizContent
        ];
        $param = self::buildApiBuisinessParam($busiParam,self::API_METHOD_SEND_TPL_MSG);
        return $param;
    }

    /**
     * 获取支付的基础参数接口
     * @param $outTradeNo 第三方交易订单号
     * @param $totalAmount 待支付的金额
     * @param $subject 主题，可以是商品名称
     * @param $body 描述，可以是商品简介
     * @return array
     */
    protected static function getTradePayBaseParam($outTradeNo,$totalAmount,$subject,$body = ''){
        $baseParam = [
            'out_trade_no' =>$outTradeNo,
            'total_amount' =>$totalAmount,
            'subject' =>$subject,
            'body' =>$body,
            'notify_url' => getDomain().'/alipay/notify'
        ];
        return self::buildBusiBaseParam($baseParam, self::API_METHOD_TRADE_PAY);
    }


    /**
     * 构建基础的业务参数
     */
    protected static function buildBusiBaseParam($param, $apiMethod){
        $bizContent = json_encode($param,JSON_UNESCAPED_UNICODE);
        $busiParam = [
            'biz_content' => $bizContent
        ];
        $param = self::buildApiBuisinessParam($busiParam,$apiMethod);
        return $param;
    }

    /**
     * 构建业务参数
     */
    protected static function buildApiBuisinessParam($businessParam,$apiMethod){
        $pubParam = self::getApiPubParam($apiMethod);
        $businessParam = array_merge($pubParam,$businessParam);
        $signContent = self::getSignContent($businessParam);
        error_log('sign_content ===========>'.$signContent);
        $rsaHelper = new RsaHelper();
        $sign = $rsaHelper->createSign($signContent);
        error_log('sign ===========>'.$sign);
        $businessParam['sign'] = $sign;
        return $businessParam;
    }


    /**
     * 公共参数
     *
     */
    protected static function getApiPubParam($apiMethod){
        $ampBaseInfo = BusinessHelper::getAmpBaseInfo();
        $param = [
            'timestamp' => date('Y-m-d H:i:s') ,
            'method' => $apiMethod,
            'app_id' => formatArrValue($ampBaseInfo,'appid',config('param.amp.appid')),
            'sign_type' =>self::SIGN_TYPE_RSA2,
            'charset' =>self::FILE_CHARSET_UTF8,
            'version' =>self::VERSION,
        ];
        return $param;
    }


    /**
     * 获取签名的内容
     */
    protected static function getSignContent($params) {
        ksort($params);
        $stringToBeSigned = "";
        $i = 0;
        foreach ($params as $k => $v) {
            if (!empty($v) && "@" != substr($v, 0, 1)) {
                if ($i == 0) {
                    $stringToBeSigned .= "$k" . "=" . "$v";
                } else {
                    $stringToBeSigned .= "&" . "$k" . "=" . "$v";
                }
                $i++;
            }
        }
        unset ($k, $v);
        return $stringToBeSigned;
    }


    protected static function convertArrToQueryParam($param){
        $queryParam = [];
        foreach ($param as $key => $val){
            $obj = $key.'='.$val;
            array_push($queryParam,$obj);
        }
        $queryStr = implode('&',$queryParam);
        return $queryStr;
    }

    /**
     * 转换字符集编码
     * @param $data
     * @param $targetCharset
     * @return string
     */
    protected static function characet($data, $targetCharset) {
        if (!empty($data)) {
            $fileType = self::FILE_CHARSET_UTF8;
            if (strcasecmp($fileType, $targetCharset) != 0) {
                $data = mb_convert_encoding($data, $targetCharset, $fileType);
            }
        }
        return $data;
    }

    /**
     * 获取业务参数内容
     */
    protected static function getQrBizContent($page, $queryParam = [],$describe = ''){
        if(is_array($queryParam)){
            $queryParam = http_build_query($queryParam);
        }
        $obj = [
            'url_param' => $page,
            'query_param' => $queryParam,
            'describe' => $describe
        ];
        $bizContent = json_encode($obj,JSON_UNESCAPED_UNICODE);
        return $bizContent;
    }

}
    php
    crelaber
    1.1k 声望22 粉丝
    « 上一篇
    PHP实现微信小程序支付的帮助类
    下一篇 »
    nginx实现一个域名配置多个laravel项目

    引用和评论

    推荐阅读
    头像
    PHP实现微信小程序用户授权的工具类

    crelaber赞 2阅读 8.5k

    头像
    一个用JavaScript生成思维导图(mindmap)的github repo

    注销赞 1阅读 6.2k

    头像
    从零开始 Elasticsearh Docker 单机集群

    zzMeow赞 1阅读 2.8k

    头像
    如何使用Visual Studio Code调试PHP CLI应用和Web应用

    注销赞 1阅读 2.5k

    头像
    深度剖析 Swoole6 PHP 多线程实现原理

    韩天峰赞 1阅读 960

    头像
    浅谈Fiori Design Guidelines

    注销阅读 2.2k

    头像
    什么是api?有什么用？具体怎么运用api?看完这篇文章你就理解了

    已注销赞 1阅读 998

    0 条评论
    得票最新