Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.belerweb.social.weixin.api
Class Weixin

java.lang.Object
  extended by com.belerweb.social.SDK
      extended by com.belerweb.social.weixin.api.Weixin

public final class Weixin
extends SDK

微信SDK

Constructor Summary
Weixin(String token)
          只传入token实例化微信SDK，适合于只开发基于微信基础接口的被动接受消息类应用，如智能应答机器人。不推荐适用。
Weixin(String appId, String secret)
          通过appId和secret实例化微信SDK，适合于只开发基于微信高级接口的OAuth2应用，如客服功能。
Weixin(String appId, String secret, String token)
          通过token、appId和secret实例化微信SDK，支持微信基础和高级接口。推荐适用
Weixin(String appid, String secret, String redirectUri, String token)
           
 
Method Summary
 Result<QRTicket> createQR(QRType type, Integer sceneId)
          自动获取accessToken并创建二维码ticket 每次创建二维码ticket需要提供一个开发者自行设定的参数（scene_id） 文档地址：http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码
 Result<QRTicket> createQR(String accessToken, QRType type, Integer sceneId)
          创建二维码ticket 每次创建二维码ticket需要提供一个开发者自行设定的参数（scene_id） 文档地址：http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码
 AccessToken getAccessToken()
          获取access token access_token是公众号的全局唯一票据，公众号调用各接口时都需使用access_token。正常情况下access_token有效期为7200秒， 重复获取将导致上次获取的access_token失效。 公众号可以使用AppID和AppSecret调用本接口来获取access_token。AppID和AppSecret可在开发模式中获得（需要已经成为开发者，且帐号没有异常状态）。
 String getAppId()
           
 Group getGroup()
           
 Media getMedia()
           
 Menu getMenu()
           
 OAuth2 getOAuth2()
           
 String getRedirectUri()
           
 String getSecret()
           
 String getToken()
          在公众平台网站的高级功能 – 开发模式页，点击“成为开发者”按钮，填写URL和Token，其中URL是开发者用来接收微信服务器数据的接口URL。Token可由开发者可以任意填写，用作生成签名（ 该Token会和接口URL中包含的Token进行比对，从而验证安全性）
 User getUser()
           
 Result<Boolean> sendCustomMessage(Message message)
          发送客服消息 当用户主动发消息给公众号的时候，微信将会把消息数据推送给开发者，开发者在一段时间内（目前为24小时）可以调用客服消息接口，通过POST一个JSON数据包来发送消息给普通用户， 在24小时内不限制发送次数。此接口主要用于客服等有人工消息处理环节的功能，方便开发者为用户提供更加优质的服务。 文档地址：http://mp.weixin.qq.com/wiki/index.php?title=发送客服消息
 Result<Boolean> sendCustomMessage(String accessToken, Message message)
          发送客服消息 当用户主动发消息给公众号的时候，微信将会把消息数据推送给开发者，开发者在一段时间内（目前为24小时）可以调用客服消息接口，通过POST一个JSON数据包来发送消息给普通用户， 在24小时内不限制发送次数。此接口主要用于客服等有人工消息处理环节的功能，方便开发者为用户提供更加优质的服务。 文档地址：http://mp.weixin.qq.com/wiki/index.php?title=发送客服消息
 Result<Boolean> sendTemplateMessage(Message message)
          发送模板消息
 Result<Boolean> sendTemplateMessage(String accessToken, Message message)
          发送模板消息
 void setAppId(String appId)
           
 void setRedirectUri(String redirectUri)
           
 void setSecret(String secret)
           
 void setToken(String token)
           
 boolean validate(String signature, String timestamp, String nonce)
          验证消息真实性 文档地址：http://mp.weixin.qq.com/wiki/index.php?title=验证消息真实性
 
Methods inherited from class com.belerweb.social.SDK
addNotNullParameter, addParameter, addTrueParameter, get, get, lonLatToAddress, post, post, post
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Weixin

public Weixin(String token)
只传入token实例化微信SDK，适合于只开发基于微信基础接口的被动接受消息类应用，如智能应答机器人。不推荐适用。

Parameters:
token - 在公众平台网站的高级功能 – 开发模式页，点击“成为开发者”按钮，填写URL和Token，其中URL是开发者用来接收微信服务器数据的接口URL。Token可由开发者可以任意填写 ，用作生成签名（该Token会和接口URL中包含的Token进行比对，从而验证安全性）。

Weixin

public Weixin(String appId,
              String secret)
通过appId和secret实例化微信SDK，适合于只开发基于微信高级接口的OAuth2应用，如客服功能。

Parameters:
appId - 公众号的唯一标识
secret - 公众号的appsecret

Weixin

public Weixin(String appId,
              String secret,
              String token)
通过token、appId和secret实例化微信SDK，支持微信基础和高级接口。推荐适用

Parameters:
appId - 公众号的唯一标识
secret - 公众号的appsecret
token - 在公众平台网站的高级功能 – 开发模式页，点击“成为开发者”按钮，填写URL和Token，其中URL是开发者用来接收微信服务器数据的接口URL。Token可由开发者可以任意填写 ，用作生成签名（该Token会和接口URL中包含的Token进行比对，从而验证安全性）。

Weixin

public Weixin(String appid,
              String secret,
              String redirectUri,
              String token)
Method Detail

validate

public boolean validate(String signature,
                        String timestamp,
                        String nonce)
验证消息真实性 文档地址：http://mp.weixin.qq.com/wiki/index.php?title=验证消息真实性

Parameters:
signature - 微信加密签名，signature结合了开发者填写的token参数和请求中的timestamp参数、nonce参数。
timestamp - 时间戳
nonce - 随机数
Returns:
消息有效返回true，否则返回false

getAppId

public String getAppId()

setAppId

public void setAppId(String appId)

getSecret

public String getSecret()

setSecret

public void setSecret(String secret)

getRedirectUri

public String getRedirectUri()

setRedirectUri

public void setRedirectUri(String redirectUri)

getAccessToken

public AccessToken getAccessToken()
获取access token access_token是公众号的全局唯一票据，公众号调用各接口时都需使用access_token。正常情况下access_token有效期为7200秒， 重复获取将导致上次获取的access_token失效。 公众号可以使用AppID和AppSecret调用本接口来获取access_token。AppID和AppSecret可在开发模式中获得（需要已经成为开发者，且帐号没有异常状态）。

createQR

public Result<QRTicket> createQR(QRType type,
                                 Integer sceneId)
自动获取accessToken并创建二维码ticket 每次创建二维码ticket需要提供一个开发者自行设定的参数（scene_id） 文档地址：http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码

Parameters:
type - 二维码类型，QR_SCENE为临时,QR_LIMIT_SCENE为永久
sceneId - 场景值ID，临时二维码时为32位整型，永久二维码时最大值为1000

createQR

public Result<QRTicket> createQR(String accessToken,
                                 QRType type,
                                 Integer sceneId)
创建二维码ticket 每次创建二维码ticket需要提供一个开发者自行设定的参数（scene_id） 文档地址：http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码

Parameters:
accessToken - access_token是公众号的全局唯一票据
type - 二维码类型，QR_SCENE为临时,QR_LIMIT_SCENE为永久
sceneId - 场景值ID，临时二维码时为32位整型，永久二维码时最大值为1000

sendCustomMessage

public Result<Boolean> sendCustomMessage(Message message)
发送客服消息 当用户主动发消息给公众号的时候，微信将会把消息数据推送给开发者，开发者在一段时间内（目前为24小时）可以调用客服消息接口，通过POST一个JSON数据包来发送消息给普通用户， 在24小时内不限制发送次数。此接口主要用于客服等有人工消息处理环节的功能，方便开发者为用户提供更加优质的服务。 文档地址：http://mp.weixin.qq.com/wiki/index.php?title=发送客服消息

Parameters:
message - 消息

sendCustomMessage

public Result<Boolean> sendCustomMessage(String accessToken,
                                         Message message)
发送客服消息 当用户主动发消息给公众号的时候，微信将会把消息数据推送给开发者，开发者在一段时间内（目前为24小时）可以调用客服消息接口，通过POST一个JSON数据包来发送消息给普通用户， 在24小时内不限制发送次数。此接口主要用于客服等有人工消息处理环节的功能，方便开发者为用户提供更加优质的服务。 文档地址：http://mp.weixin.qq.com/wiki/index.php?title=发送客服消息

Parameters:
accessToken - access_token是公众号的全局唯一票据
message - 消息

sendTemplateMessage

public Result<Boolean> sendTemplateMessage(Message message)
发送模板消息

为了保证用户不受到骚扰，在开发者出现需要主动提醒、通知用户时，才允许开发者在公众平台网站中模板消息库中选择模板，选择后获得模板ID，再根据模板ID向用户主动推送提醒、通知消息。

模板消息调用时主要需要模板ID和模板中各参数的赋值内容。请注意：

  1. 模板中参数内容必须以".DATA"结尾，否则视为保留字;
  2. 模板保留符号"{{ }}"

具体调用方法

第一步：获取模板ID
通过在模板消息功能的模板库中使用需要的模板，可以获得模板ID。

第二步：请求接口

文档地址：https://mp.weixin.qq.com/advanced/tmplmsg?action=faq&lang=zh_CN

Parameters:
message - 消息

sendTemplateMessage

public Result<Boolean> sendTemplateMessage(String accessToken,
                                           Message message)
发送模板消息

为了保证用户不受到骚扰，在开发者出现需要主动提醒、通知用户时，才允许开发者在公众平台网站中模板消息库中选择模板，选择后获得模板ID，再根据模板ID向用户主动推送提醒、通知消息。

模板消息调用时主要需要模板ID和模板中各参数的赋值内容。请注意：

  1. 模板中参数内容必须以".DATA"结尾，否则视为保留字;
  2. 模板保留符号"{{ }}"

具体调用方法

第一步：获取模板ID
通过在模板消息功能的模板库中使用需要的模板，可以获得模板ID。

第二步：请求接口

文档地址：https://mp.weixin.qq.com/advanced/tmplmsg?action=faq&lang=zh_CN

Parameters:
accessToken - access_token是公众号的全局唯一票据
message - 消息

getToken

public String getToken()
在公众平台网站的高级功能 – 开发模式页，点击“成为开发者”按钮，填写URL和Token，其中URL是开发者用来接收微信服务器数据的接口URL。Token可由开发者可以任意填写，用作生成签名（ 该Token会和接口URL中包含的Token进行比对，从而验证安全性）

setToken

public void setToken(String token)

getOAuth2

public OAuth2 getOAuth2()

getUser

public User getUser()

getGroup

public Group getGroup()

getMedia

public Media getMedia()

getMenu

public Menu getMenu()
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2014. All Rights Reserved.