首頁>編程相關>Ai源碼
下載

wechat-open-toolkit 微信開放平台工具套件

方便建置基礎的Node.js 微信第三方服務平台。

範例程式碼

npm install wechat-open-toolkit
 const express = require ( 'express' )
const app = express ( )
const WechatOpenToolkit = require ( 'wechat-open-toolkit' )
const {
    EVENT_COMPONENT_VERIFY_TICKET , EVENT_AUTHORIZED , EVENT_UPDATE_AUTHORIZED ,
    EVENT_UNAUTHORIZED , EVENT_COMPONENT_ACCESS_TOKEN , EVENT_AUTHORIZER_ACCESS_TOKEN , 
    EVENT_AUTHORIZER_JSAPI_TICKET
} = WechatOpenToolkit

// 微信第三方平台列表
let list = [
    {
        componentAppId : '' , // 微信第三方平台 appId
        componentAppSecret : '' , // 微信第三方平台 appSecret
        token : '' , // 消息校验 Token
        encodingAESKey : '' // 消息加解密 key
    }
]

let toolkit = new WechatOpenToolkit ( { list } )

// 绑定全部事件
toolkit . on ( EVENT_COMPONENT_VERIFY_TICKET , ret => {
    console . log ( ret )
} )
toolkit . on ( EVENT_AUTHORIZED , ret => {
    console . log ( ret )
} )
toolkit . on ( EVENT_UPDATE_AUTHORIZED , ret => {
    console . log ( ret )
} )
toolkit . on ( EVENT_UNAUTHORIZED , ret => {
    console . log ( ret )
} )
toolkit . on ( EVENT_COMPONENT_ACCESS_TOKEN , ret => {
    console . log ( ret )
} )
toolkit . on ( EVENT_AUTHORIZER_ACCESS_TOKEN , ret => {
    console . log ( ret )
} )
toolkit . on ( EVENT_AUTHORIZER_JSAPI_TICKET , ret => {
    console . log ( ret )
} )
toolkit . on ( 'error' , err => {
    console . error ( err )
} )

// 通常需要绑定5个中间件
app . use ( '/wechat/events' , toolkit . events ( ) ) // 第三方平台事件接收中间件

list . forEach ( ( { componentAppId } ) => {

    let authMiddleware = toolkit . auth ( componentAppId , 'https://domain.com/' ) // 第三方平台网页授权中间件
    let msgMiddleware = toolkit . message ( componentAppId ) // 授权方用户消息接收中间件
    let autoTestMiddleware = toolkit . autoTest ( componentAppId ) // 第三方平台全网发布测试中间件

    app . get ( `/wechat/auth/ ${ componentAppId } ` , authMiddleware )
  
    app . post ( `/wechat/message/ ${ componentAppId } /:authorizerAppId` , msgMiddleware , autoTestMiddleware , ( req , res ) => {
        res . end ( 'success' )
        console . log ( req . wechat )
    } )

    app . get ( `/wechat/oauth/ ${ componentAppId } /:authorizerAppId` , ( req , res ) => {
        let { authorizerAppId } = req . params
        let oauthMiddleware = toolkit . oauth ( componentAppId , authorizerAppId , 'https://domain.com/' ) // 授权方网页授权中间件
        oauthMiddleware ( req , res )
    } )
} )

app . listen ( 3000 )
console . log ( 'server start at 3000' )

接入co-wechat-api 和wechat-api 範例程式碼

 const CoWechatApi = require ( 'co-wechat-api' )
const WechatApi = require ( 'wechat-api' )

let store = { } // 缓存数据

let componentAppId = 'test app id'
let authorizerAppId = 'test app id'

let api = new WechatApi ( '' , '' , callback => {
    // 每次调用 api.方法()，都会从 store 对象取 access token
    callback ( null , {
        accessToken : store [ ` ${ componentAppId } / ${ authorizerAppId } ` ] ,
        expireTime : Date . now ( ) + 1000 * 60
    }
} )

let coApi = new CoWechatApi ( '' , '' , async ( ) => {
    // 每次调用 api.方法()，都会从 store 对象取 access token
    return {
        accessToken : store [ ` ${ componentAppId } / ${ authorizerAppId } ` ] ,
        expireTime : Date . now ( ) + 1000 * 60
    }
} )

// 每次授权方 access token 更新时，同步更新缓存数据
toolkit . on ( EVENT_AUTHORIZER_ACCESS_TOKEN , function ( ret ) {
    let { AppId , authorizer_appid , authorizer_access_token } = ret
    store [ ` ${ AppID } / ${ authorizer_appid } ` ] = authorizer_access_token // 更新
} )

// 该功能需等到 access token 首次更新后，才能调用
api . sendText ( )
await coApi . sendText ( )
///

範例程式碼僅供參考，依實際情況調整。

微信第三方平台要求配置2個URL，分別推播第三方平台事件與公眾號事件，清單整理如下：

  • 授權事件接收URL
    • component_verity_ticket 當微信伺服器推送component_verity_ticket 時觸發
    • authorized 當有新的公眾號授權給第三方平台時觸發
    • updateauthorized 當已授權公眾號修改授權給第三方平台的權限時觸發
    • unauthorized 當已授權公眾號取消授權時觸發
  • 公眾號碼訊息接收URL
    • 推播用戶與公眾號的訊息
    • 用戶點擊底部選單、追蹤、取消追蹤、掃碼事件

微信開放平台與微信第三方平台

微信開放平台帳號需在微信開放平台註冊，註冊後取得帳號及密碼。 (註冊時提供的郵箱之前未註冊過公眾號碼和小程式)

一個微信開放平台帳號可以創建多個第三方平台，創建後得到第三方平台的appId和appSecret 。也就是程式碼中使用的componentAppId 、 componentAppSecret 。 (第三方平台的數量有上限，客製化開發服務商類型上限是5個、平台型服務商類型上限是5個)

當收到微信推送的component_verify_ticket 時觸發component_verify_ticket 事件

 toolkit . on ( EVENT_COMPONENT_VERIFY_TICKET , function ( result ) {
/* {
    AppId: "wx304925fbea25bcbe",
    CreateTime: "1562424829"
    InfoType: "component_verify_ticket",
    ComponentVerifyTicket: 'ticket@@@lEHjsBEi_TPDey0IZxw4Zbb7JRYLOtEf9ksvDpSwzkwog3R6xEpdaK0yIee7JOyOXM0V7cp0dpM58GKmb8FSKA'
} */
} )

微信伺服器會每隔10分鐘推送1次，這會導致每次進程重新啟動後，有1至10分鐘服務不可用（因為其他功能全部依賴於component_verify_ticket），解決方法是儲存上一次的推送數據，並且每次啟動時，主動觸發一次相同事件。範例如下： 

 // ！在所有侦听事件绑定完成后，再触发事件
// 从数据库（或其他地方）读取上次缓存的数据，通过事件通知给组件
toolkit . emit ( EVENT_COMPONENT_VERIFY_TICKET , {
    AppId : "wx52ffab2939ad" ,
    CreateTime : "142345003"
    InfoType : "component_verify_ticket" ,
    ComponentVerifyTicket : 'ticket@@@lEHjsBEi_TPDey0IZxw4Zbb7JRYLOtEf9ksvDpSwzkwog3R6xEpdaK0yIee7JOyOXM0V7cp0dpM58GKmb8FSKA'
} )

當刷新第三方平台access token 時觸發component_access_token 事件

 toolkit . on ( EVENT_COMPONENT_ACCESS_TOKEN , function ( result ) {
/* {
    component_access_token: 'M5CvflZyL5fkV29gU6MhQIoNsvzPEGBjYgmgA7yxnI_l8sblqm0QUULiMHoWY3gXPOnenZs3-42x_EenE1DEAg2F1K3X_fOI44h_eqxrV_7b0K7yc3pEGf_qTZl8HOlyCTSiAHAVML',
    expires_in: 7200,
    componentAppId: 'componentAppId'
} */
} )

當刷新授權方access token 時觸發authorizer_access_token 事件

 toolkit . on ( EVENT_AUTHORIZER_ACCESS_TOKEN , function ( result ) {
/**
{
    AppId: 'wx304925fbea25bcbe',
    authorizer_appid: 'wxc736b9251b3c6c41',
    authorizer_access_token: 'j7mR_dvcCAmUq5Iw-MuzE4sBT0unN-ukg7LR8EqZEQ1wZ7oyw0rs1Idk40d7uxriOubE3795JiFa3e5jDGdofRpTemXd2HLLV6p_i_Uwy7m2Rp-qv1k1ld-T9iCCDcVeQONdALDFDC',
    authorizer_refresh_token: 'refreshtoken@@@6Esz0GgFsth_vRPtqjQd_aIQcCBcJ4iuzQFf3akLwgg',
    expires_in: 7200
}
*/
} )

當刷新授權方jsapi_ticket 時觸發authorizer_jsapi_ticket 事件

 toolkit . on ( EVENT_AUTHORIZER_JSAPI_TICKET , function ( result ) {
/* {
    errcode: 0,
    errmsg: 'ok',
    ticket: 'Zqqmael1_O_ddyFwCE14BtflzySMrtVpp086SHhK3P07xXnhjii2MTmKAGQHBwPOg8GsEtR9HG_dHUngs22ayQ',
    expires_in: 7200,
    componentAppId: 'wx304925fbea25bcbe',
    authorizerAppId: 'wxc736b9251b3c6c41'
} */
} )

當新的公眾號授權成功時觸發authorized 事件

 toolkit . on ( EVENT_AUTHORIZED , function ( result ) {
/* {
    AppId: 'wx304925fbea25bcbe',
    CreateTime: '1562428385',
    InfoType: 'authorized',
    AuthorizerAppid: 'wxc736b9251b3c6c41',
    AuthorizationCode: 'queryauthcode@@@SozCwT_ve8WQI6Poum-qdGrrBrnQoX2rApglrUIMF0e308IQY7w_tCfAkndxzUth_YwHDto8DUsIeNrX4atetA',
    AuthorizationCodeExpiredTime: '1562431985',
    PreAuthCode: 'preauthcode@@@c4Uh5vOCS3wu9Bbx4tJWxplzkn5swwVHQc9xGtF57C1lfk_UeW50INZsh2flrwxh'
} */
} )

當已授權公眾號更新權限時觸發updateauthorized 事件

 toolkit . on ( EVENT_UPDATE_AUTHORIZED , function ( result ) {
/* {
    AppId: 'wx304925fbea25bcbe',
    CreateTime: '1562426956',
    InfoType: 'updateauthorized',
    AuthorizerAppid: 'wxc736b9251b3c6c41',
    AuthorizationCode: 'queryauthcode@@@SozCwT_ve8WQI6Poum-qdG_rFKaepJCyhL-zx1OkvsxmmJkbZadF78t3U9lh20IaWFqb2DcLne7MGVICr5eRfQ',
    AuthorizationCodeExpiredTime: '1562430556',
    PreAuthCode: 'preauthcode@@@ivkKNYhiXXsDFLBmH2ccOCg6doXsD_RdQOS7Cxw5GoILrdQktfx_glIzmhWQrMyT'
} */
} )

當已授權公眾號取消授權時觸發unauthorized 事件

 toolkit . on ( EVENT_UNAUTHORIZED , function ( result ) {
/* {
    AppId: 'wx304925fbea25bcbe',
    CreateTime: '1562428154',
    InfoType: 'unauthorized',
    AuthorizerAppid: 'wxc736b9251b3c6c41'
} */
} )

當有錯誤時觸發error 事件

 toolkit . on ( 'error' , function ( err ) {
    console . error ( err )
} )

實例方法：

  • auth(componentAppId, redirectUrl [, authType])傳回第三方平台授權中介軟體

  • events()傳回第三方平台授權事件處理中介軟體

  • message(componentAppId)傳回授權方訊息處理中介軟體

  • autoTest(componentAppId)傳回全網發布測試案例的中間件

  • oauth(componentAppId, authorizerAppId, redirectUrl [, scope [, state]])傳回授權方網頁授權中介軟體

類別方法：

  • getAuthorizerInfo(componentAppId, componentAccessToken, authorizerAppId)取得授權方的帳號基本信息

  • clearQuota(componentAppId, componentAccessToken)第三方平台對其所有API呼叫次數清零

  • getJsApiConfig(authorizerAppId, authorizerJsApiTicket, url)取得授權方js sdk 配置

  • getOauthAccessToken(componentAppId, componentAccessToken, authorizerAppId, code)取得授權方網頁授權access token

  • getUserInfo(authorizerAccessToken, openId)取得授權方微信使用者基本信息

  • send(authorizerAccessToken, openId, type, content)發送客服訊息

  • getAuthorizerOptionInfo(componentAppId, componentAccessToken, authorizerAppId, optionName)取得授權方的選項設定信息

  • setAuthorizerOption(componentAppId, componentAccessToken, authorizerAppId, optionName, optionValue)設定授權方選項信息

  • createOpenAccount(authorizerAppId, authorizerAccessToken)建立開放平台帳號並綁定公眾號碼/小程序

  • bindOpenAccount(openAppId, authorizerAppId, authorizerAccessToken)將公眾號/小程式綁定到開放平台帳號下

  • unbindOpenAccount(openAppId, authorizerAppId, authorizerAccessToken)將公眾號/小程式從開放平台帳號下解綁

  • getOpenAccount(authorizerAppId, authorizerAccessToken)取得公眾號/小程式所綁定的開放平台帳號

auth

返回第三方平台授權中間件。

  • componentAppId <string> 第三方平台APPID
  • redirectUrl <string> 授權成功後重定向的URL
  • authType <number|string> 授權的類型
  • pageStyle <number> 頁面樣式

redirectUrl該連結的網域必須和目前服務的網域相同，而且和微信第三方平台配置的網域相同。

authType指定授權時顯示的可選項。 1表示僅展示公眾號、 2表示僅展示小程式、 3表示展示公眾號和小程式。預設為3 。也可以傳入授權方APPID，指定授權方。

pageStyle指定授權頁面的樣式。 1表示PC掃碼授權； 2表示微信瀏覽器開啟。預設值為1 。 

 const { AUTH_TYPE_BOTH , PAGE_STYLE_PC } = require ( 'wechat-open-toolkit' )
let componentAppId = 'wx52ffab2939ad'
let redirectUrl = 'https://domain.com/authorized'
let authMiddleware = toolkit . auth ( componentAppId , redirectUrl , AUTH_TYPE_BOTH , PAGE_STYLE_PC )

// 浏览器打开该路由即可扫码授权
app . get ( `/wechat/auth/ ${ componentAppId } ` , authMiddleware )

events

返回第三方平台授權事件處理中介軟體。 

 app . use ( '/wechat/events' , toolkit . events ( ) )

message

返回授權方訊息處理中介軟體

  • componentAppId <string> 第三方平台appId 
 const componentAppId = 'wx52ffab2939ad'
let msgMiddleware = toolkit . message ( componentAppId ) // 用户消息中间件

app . post ( `/wechat/message/ ${ componentAppId } /:authorizerAppId` , msgMiddleware , ( req , res ) => {
    console . log ( req . wechat )
    /**
    {
        ToUserName: 'gh_2a33e5f5a9b0',
        FromUserName: 'oVtjJv5NEub-fbE7E6_P2_jCLMXo',
        CreateTime: '1508406464',
        MsgType: 'text',
        Content: 'hello world',
        MsgId: '6478556432393017916'
    }
    */
} )

被動回覆訊息功能

當第三方平台收到授權方使用者訊息時，可以使用被動回覆功能回覆訊息。

  • res.text(content)回覆文字訊息
  • res.image(mediaId)回覆圖片
  • res.voice(mediaId)回覆語音
  • res.video(mediaId [, title [, description]])回覆視頻
  • res.music(thumbMediaId [, HQMusicUrl [, musicUrl [, title [, description]]]])回覆音樂
  • res.news(articles)回覆圖文
    • Title標題
    • Description描述
    • Url跳轉鏈接
    • PicUrl縮圖鏈接
 let componentAppId = 'wx52ffab2939ad' // 第三方平台APPID
let msgMiddleware = toolkit . message ( componentAppId ) // 用户消息中间件

app . post ( `/wechat/message/ ${ componentAppId } /:authorizerAppId` , msgMiddleware , ( req , res ) => {
    let { MsgType , Content , MediaId , Label , Title , Description , Url } = req . wechat
    switch ( MsgType ) {
        case 'text' :
            res . text ( Content ) // 被动回复文本消息
            break ;
        case 'image' :
            res . image ( MediaId ) // 被动回复图片消息
            break ;
        case 'voice' :
            res . voice ( MediaId ) // 被动回复语音消息
            break ;
        case 'video' :
            res . video ( MediaId ) // 被动回复视频消息
            break ;
        case 'location' :
            res . text ( Label )
            break ;
        case 'link' :
            res . news ( [ { Title , Description , Url } ] )
    }
} )

autoTest

傳回全網發布測試案例的中間件。此中間件需要放置在message 中間件後面，以及其他中間件前面。

  • componentAppId <string> 第三方平台APPID 
 let componentAppId = 'wx52ffab2939ad'
let msgMiddleware = toolkit . message ( componentAppId ) // 用户消息中间件
let testMiddleware = toolkit . autoTest ( componentAppId ) // 全网发布测试中间件

app . post ( `/wechat/message/ ${ componentAppId } /:authorizerAppId` , msgMiddleware , testMiddleware , ( req , res ) => {
    res . end ( 'success' ) // 响应微信服务器
    console . log ( req . wechat )
} )

oauth

返回第三方平台代理微信公眾號網頁授權中間件。

  • componentAppId <string> 第三方平台APPID
  • authorizerAppId <string> 授權方APPID
  • redirectUrl <string> 授權成功後的重定向URL
  • scope <string> 網頁授權的類型。可選
  • state <string> 授權的附帶值。可選

scope 為授權作用域。可能的值為：snsapi_base 和snsapi_userinfo。預設為：snsapi_base 

 const { OAUTH_TYPE_USERINFO } = require ( 'wechat-open-toolkit' )
let componentAppId = 'wx304925fbea25bcbe'
let authorizerAppId = 'wxc736b9251b3c6c41'
let redirectUrl = 'https://domain.com/authorized'
let oauthMiddleware = toolkit . oauth ( componentAppId , authorizerAppId , redirectUrl , OAUTH_TYPE_USERINFO )

app . get ( `/wechat/oauth/ ${ componentAppId } / ${ authorizerAppId } ` , oauthMiddleware )

getAuthorizerInfo

取得授權方的帳號基本信息

 let ret = await WechatOpenToolkit . getAuthorizerInfo ( componentAppId , componentAccessToken , authorizerAppId )

getJsApiConfig

取得授權方的js sdk 配置對象

  • authorizerAppId <string> 授權方APPID
  • authorizerJsApiTicket <string> 授權方JsApi Ticket
  • url <string> 要配置的網頁鏈接
 let conf = WechatOpenToolkit . getJsApiConfig ( authorizerAppId , authorizerJsApiTicket , url )
/**
{
    appId: '',
    timestamp: 158923408,
    nonceStr: '292jslk30dk',
    signature: '20kjafj20dfhl2j0sjhk2h3f0afjasd2'
}
*/

getOauthAccessToken

取得授權方的網頁授權access token

  • componentAppId <string> 第三方平台APPID
  • componentAccessToken <string>
  • authorizerAppId <string> 授權方APPID
  • code <string> 網頁授權後得到的臨時code 
 let ret = await WechatOpenToolkit . getOauthAccessToken ( componentAppId , componentAccessToken , authorizerAppId , code )

getUserInfo

取得授權方微信使用者的基本訊息

  • authorizerAccessToken <string> 授權方網頁授權得到的access token
  • openId <string> 授權方微信使用者的openId 
 let ret = await WechatOpenToolkit . getUserInfo ( authorizerAccessToken , openId )

send

發送客服訊息

  • authorizerAccessToken <string> 授權方access token
  • openId <string> 微信用戶openId
  • type <string> 訊息類型
  • content <string> 訊息主體
 await WechatOpenToolkit . send ( authorizerAccessToken , openId , 'text' , { content : '消息内容' } ) // 发送文本消息
await WechatOpenToolkit . send ( authorizerAccessToken , openId , 'image' , { media_id : 'MEDIA_ID' } ) // 发送图片消息
await WechatOpenToolkit . send ( authorizerAccessToken , openId , 'voice' , { media_id : 'MEDIA_ID' } ) // 发送语音消息

await WechatOpenToolkit . send ( authorizerAccessToken , openId , 'video' , {
    media_id : 'MEDIA_ID' ,
    thumb_media_id : 'MEDIA_ID' ,
    title : 'TITLE' ,
    description : 'DESCRIPTION'
} ) // 发送视频消息

await WechatOpenToolkit . send ( authorizerAccessToken , openId , 'music' , {
    title : 'TITLE' ,
    description : 'DESCRIPTION' ,
    musicurl : 'MUSIC_URL' ,
    hqmusicurl : 'HQ_MUSIC_URL' ,
    thumb_media_id : 'MEDIA_ID'
} ) // 发送音乐消息

await WechatOpenToolkit . send ( authorizerAccessToken , openId , 'news' , {
    articles : [ {
        title : 'TITLE' ,
        description : 'DESCRIPTION' ,
        url : 'URL' ,
        picurl : 'PIC_URL'
    } ]
} ) // 发送图文消息

await WechatOpenToolkit . send ( authorizerAccessToken , openId , 'mpnews' , { media_id : 'MEDIA_ID' } ) // 发送图文消息

getAuthorizerOptionInfo

此API用於取得授權方的公眾號或小程式的選項設定訊息，如：地理位置上報，語音辨識開關，多客服開關。

  • componentAppId
  • componentAccessToken
  • authorizerAppId
  • optionName 
 let ret = await WechatOpenToolkit . getAuthorizerOptionInfo ( componentAppId , componentAccessToken , authorizerAppId , optionName )

setAuthorizerOption

設定授權方選項

  • componentAppId <string> 第三方平台APPID
  • componentAccessToken <string>
  • authorizerAppId <string> 授權方平台APPID
  • optionName <string>
  • optionValue <number>

此API用於設定授權方的公眾號或小程式的選項訊息，如：地理位置上報，語音辨識開關，多客服開關。 

 await WechatOpenToolkit . setAuthorizerOption ( componentAppId , componentAccessToken , authorizerAppId , optionName , optionValue )

clearQuota

第三方平台對其所有API呼叫次數清零

  • componentAppId <string> 第三方平台APPID
  • componentAccessToken <string> 
 await WechatOpenToolkit . clearQuota ( componentAppId , componentAccessToken )

createOpenAccount

建立開放平台帳號並綁定公眾號/小程序

  • authorizerAppId <string> 授權方APPID
  • authorizerAccessToken <string> 
 let ret = await WechatOpenToolkit . createOpenAccount ( authorizerAppId , authorizerAccessToken )

bindOpenAccount

將公眾號/小程式綁定到開放平台帳號下

  • openAppId <string>
  • authorizerAppId <string>
  • authorizerAccessToken <string> 
 await WechatOpenToolkit . bindOpenAccount ( openAppId , authorizerAppId , authorizerAccessToken )

unbindOpenAccount

將公眾號/小程式從開放平台帳號下解綁

  • openAppId <string>
  • authorizerAppId <string>
  • authorizerAccessToken <string> 
 await WechatOpenToolkit . unbindOpenAccount ( openAppId , authorizerAppId , authorizerAccessToken )

getOpenAccount

取得公眾號/小程式所綁定的開放平台帳號

  • authorizerAppId <string>
  • authorizerAccessToken <string> 
 let ret = await WechatOpenToolkit . getOpenAccount ( authorizerAppId , authorizerAccessToken )
展開
附加信息
相關應用
爲您推薦
相關資訊 全部