weixin.popular.api

类 ComponentAPI

java.lang.Object

weixin.popular.api.BaseAPI

weixin.popular.api.ComponentAPI

public class ComponentAPI
extends BaseAPI

公众号第三方平台

作者:

LiYi

构造器概要

构造器

构造器和说明
ComponentAPI()

方法概要

限定符和类型	方法和说明
static weixin.popular.bean.component.AuthorizerAccessToken	api_authorizer_token(String component_access_token, String component_appid, String authorizer_appid, String authorizer_refresh_token) 获取（刷新）授权公众号的令牌
static weixin.popular.bean.component.ComponentAccessToken	api_component_token(String component_appid, String component_appsecret, String component_verify_ticket) 获取公众号第三方平台access_token
static weixin.popular.bean.component.PreAuthCode	api_create_preauthcode(String component_access_token, String component_appid) 获取预授权码
static weixin.popular.bean.component.ApiGetAuthorizerInfoResult	api_get_authorizer_info(String component_access_token, String component_appid, String authorizer_appid) 获取授权方的账户信息
static weixin.popular.bean.component.AuthorizerOption	api_get_authorizer_option(String component_access_token, String component_appid, String authorizer_appid, String option_name) 获取授权方的选项设置信息
static weixin.popular.bean.component.ApiQueryAuthResult	api_query_auth(String component_access_token, String component_appid, String authorization_code) 使用授权码换取公众号的授权信息
static BaseResult	api_set_authorizer_option(String component_access_token, String component_appid, String authorizer_appid, String option_name, String option_value) 设置授权方的选项信息
static BaseResult	clear_quota(String component_access_token, String component_appid) 第三方平台对其所有API调用次数清零
static String	componentloginpage(String component_appid, String pre_auth_code, String redirect_uri) 生成授权页 URL

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ComponentAPI

public ComponentAPI()

方法详细资料

componentloginpage

public static String componentloginpage(String component_appid,
                                        String pre_auth_code,
                                        String redirect_uri)

生成授权页 URL

参数:

component_appid - 第三方平台ID

pre_auth_code - 预授权码

redirect_uri - 重定向URI

返回:

URL

api_component_token

public static weixin.popular.bean.component.ComponentAccessToken api_component_token(String component_appid,
                                                                                     String component_appsecret,
                                                                                     String component_verify_ticket)

获取公众号第三方平台access_token

参数:

component_appid - 公众号第三方平台appid

component_appsecret - 公众号第三方平台appsecret

component_verify_ticket - 微信后台推送的ticket，此ticket会定时推送，具体请见本页末尾的推送说明

返回:

公众号第三方平台access_token

api_create_preauthcode

public static weixin.popular.bean.component.PreAuthCode api_create_preauthcode(String component_access_token,
                                                                               String component_appid)

获取预授权码

参数:

component_access_token - component_access_token

component_appid - 公众号第三方平台appid

返回:

预授权码

api_query_auth

public static weixin.popular.bean.component.ApiQueryAuthResult api_query_auth(String component_access_token,
                                                                              String component_appid,
                                                                              String authorization_code)

使用授权码换取公众号的授权信息

参数:

component_access_token - component_access_token

component_appid - 公众号第三方平台appid

authorization_code - 授权code,会在授权成功时返回给第三方平台，详见第三方平台授权流程说明

返回:

公众号的授权信息

api_authorizer_token

public static weixin.popular.bean.component.AuthorizerAccessToken api_authorizer_token(String component_access_token,
                                                                                       String component_appid,
                                                                                       String authorizer_appid,
                                                                                       String authorizer_refresh_token)

获取（刷新）授权公众号的令牌

参数:

component_access_token - component_access_token

component_appid - 公众号第三方平台appid

authorizer_appid - 授权方appid

authorizer_refresh_token - 授权方的刷新令牌，刷新令牌主要用于公众号第三方平台获取和刷新已授权用户的access_token，只会在授权时刻提供，请妥善保存。 一旦丢失，只能让用户重新授权，才能再次拿到新的刷新令牌

返回:

授权公众号的令牌

api_get_authorizer_info

public static weixin.popular.bean.component.ApiGetAuthorizerInfoResult api_get_authorizer_info(String component_access_token,
                                                                                               String component_appid,
                                                                                               String authorizer_appid)

获取授权方的账户信息

参数:

component_access_token - component_access_token

component_appid - 服务appid

authorizer_appid - 授权方appid

返回:

授权方的账户信息

api_get_authorizer_option

public static weixin.popular.bean.component.AuthorizerOption api_get_authorizer_option(String component_access_token,
                                                                                       String component_appid,
                                                                                       String authorizer_appid,
                                                                                       String option_name)

获取授权方的选项设置信息

参数:

component_access_token - component_access_token

component_appid - 公众号第三方平台appid

authorizer_appid - 授权公众号appid

option_name - 选项名称
location_report (地理位置上报选项) 0 无上报 1 进入会话时上报 2 每5s上报
voice_recognize（语音识别开关选项） 0 关闭语音识别 1 开启语音识别
customer_service（多客服开关选项） 0 关闭多客服 1 开启多客服

返回:

AuthorizerOption

api_set_authorizer_option

public static BaseResult api_set_authorizer_option(String component_access_token,
                                                   String component_appid,
                                                   String authorizer_appid,
                                                   String option_name,
                                                   String option_value)

设置授权方的选项信息

参数:

component_access_token - component_access_token

component_appid - 公众号第三方平台appid

authorizer_appid - 授权公众号appid

option_name - 选项名称
location_report (地理位置上报选项) 0 无上报 1 进入会话时上报 2 每5s上报
voice_recognize（语音识别开关选项） 0 关闭语音识别 1 开启语音识别
customer_service（多客服开关选项） 0 关闭多客服 1 开启多客服

option_value - 设置的选项值

返回:

BaseResult

clear_quota

public static BaseResult clear_quota(String component_access_token,
                                     String component_appid)

第三方平台对其所有API调用次数清零

参数:

component_access_token - 调用接口凭据

component_appid - 第三方平台APPID

返回:

result

从以下版本开始:

2.8.2