elixir_wechat v0.1.2 GlobalComponentAppIdClient

NOTICE: THIS MODULE IS ONLY FOR DOCUMENT.

Initialize a WeChat Component client with component_appid globally.

This suite is used for construct a Client to invoke WeChat APIs via elixir_wechat library, this usecase is usual for the Client side.

defmodule WeChat.MyComponentApp do
  use WeChat.Component, appid: "MY_COMPONENT_APPID"
end

Options:

  • :appid - the appid of WeChat 3rd-party platform application.
  • :scenario - the scenario of initialized client, options: :hub or :client, set as :hub option means it is self-manange access token in the hub, we need to do it when using this library in the Server side, set as :client option means this library sends refresh request to the hub to fetch valid access token of authorizer, using :client by default.
  • :adapter_storage - the implements for some items persistence, e.g. access_token, secret_key, component_access_token and etc, when set scenario as :client by default, there will use WeChat.Storage.ComponentDefault by default, if need to override it for yourself, please implement required functions follow WeChat.Adapter.Storage.ComponentClient behaviour module.

Link to this section Summary

Functions

Perform CARD API(s)

Perform CARD_CODE API(s)

Perform CARD_USER API(s)

Perform COMPONENT API(s)

Perform DATACUBE API(s)

Perform MATERIAL API(s)

Perform MEDIA API(s)

Perform MENU API(s)

Perform MESSAGE_CUSTOM API(s)

Perform MESSAGE_TEMPLATE API(s)

Perform QRCODE API(s)

Refresh authorizer access_token in :client scenario, by default a refresh request will be sent to the hub server to fetch a fresh access_token

Perform SHOWQRCODE API(s)

Perform TAGS API(s)

Perform TEMPLATE API(s)

Perform USER API(s)

Link to this section Functions

Link to this function

card(http_verb, authorizer_appid)
card(:get, String.t()) :: any()

Perform CARD API(s)

card(:get, authorizer_appid)
card(:post, authorizer_appid)

Send request to URL https://api.weixin.qq.com/card.

Link to this function

card(http_verb, authorizer_appid, parameters)
card(:get, String.t(), keyword()) :: any()
card(:get, String.t(), atom()) :: any()
card(:post, String.t(), map() | String.t()) :: any()
card(:post, String.t(), atom()) :: any()

Perform CARD API(s)

card(:get, authorizer_appid, uri_supplement)
card(:get, authorizer_appid, query)
card(:post, authorizer_appid, uri_supplement)
card(:post, authorizer_appid, data)

Send request to URL https://api.weixin.qq.com/card.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/card/${uri_supplement}, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

card(:http_verb, authorizer_appid, :"${uri_supplement}")
Link to this function

card(http_verb, authorizer_appid, uri_supplement, parameters)
card(:get, String.t(), atom(), keyword()) :: any()
card(:post, String.t(), atom(), map() | String.t()) :: any()

Perform CARD API(s)

card(:get, authorizer_appid, uri_supplement, query)
card(:post, authorizer_appid, uri_supplement, data)

Send request to URL https://api.weixin.qq.com/card.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/card/${uri_supplement}, and need to post data or append query string, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

card(:http_verb, authorizer_appid, :"${uri_supplement}", query)
card(:http_verb, authorizer_appid, :"${uri_supplement}", data)
Link to this function

card_code(http_verb, authorizer_appid)
card_code(:get, String.t()) :: any()

Perform CARD_CODE API(s)

card_code(:get, authorizer_appid)
card_code(:post, authorizer_appid)

Send request to URL https://api.weixin.qq.com/card/code.

Link to this function

card_code(http_verb, authorizer_appid, parameters)
card_code(:get, String.t(), keyword()) :: any()
card_code(:get, String.t(), atom()) :: any()
card_code(:post, String.t(), map() | String.t()) :: any()
card_code(:post, String.t(), atom()) :: any()

Perform CARD_CODE API(s)

card_code(:get, authorizer_appid, uri_supplement)
card_code(:get, authorizer_appid, query)
card_code(:post, authorizer_appid, uri_supplement)
card_code(:post, authorizer_appid, data)

Send request to URL https://api.weixin.qq.com/card/code.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/card/code/${uri_supplement}, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

card_code(:http_verb, authorizer_appid, :"${uri_supplement}")
Link to this function

card_code(http_verb, authorizer_appid, uri_supplement, parameters)
card_code(:get, String.t(), atom(), keyword()) :: any()
card_code(:post, String.t(), atom(), map() | String.t()) :: any()

Perform CARD_CODE API(s)

card_code(:get, authorizer_appid, uri_supplement, query)
card_code(:post, authorizer_appid, uri_supplement, data)

Send request to URL https://api.weixin.qq.com/card/code.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/card/code/${uri_supplement}, and need to post data or append query string, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

card_code(:http_verb, authorizer_appid, :"${uri_supplement}", query)
card_code(:http_verb, authorizer_appid, :"${uri_supplement}", data)
Link to this function

card_user(http_verb, authorizer_appid)
card_user(:get, String.t()) :: any()

Perform CARD_USER API(s)

card_user(:get, authorizer_appid)
card_user(:post, authorizer_appid)

Send request to URL https://api.weixin.qq.com/card/user.

Link to this function

card_user(http_verb, authorizer_appid, parameters)
card_user(:get, String.t(), keyword()) :: any()
card_user(:get, String.t(), atom()) :: any()
card_user(:post, String.t(), map() | String.t()) :: any()
card_user(:post, String.t(), atom()) :: any()

Perform CARD_USER API(s)

card_user(:get, authorizer_appid, uri_supplement)
card_user(:get, authorizer_appid, query)
card_user(:post, authorizer_appid, uri_supplement)
card_user(:post, authorizer_appid, data)

Send request to URL https://api.weixin.qq.com/card/user.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/card/user/${uri_supplement}, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

card_user(:http_verb, authorizer_appid, :"${uri_supplement}")
Link to this function

card_user(http_verb, authorizer_appid, uri_supplement, parameters)
card_user(:get, String.t(), atom(), keyword()) :: any()
card_user(:post, String.t(), atom(), map() | String.t()) :: any()

Perform CARD_USER API(s)

card_user(:get, authorizer_appid, uri_supplement, query)
card_user(:post, authorizer_appid, uri_supplement, data)

Send request to URL https://api.weixin.qq.com/card/user.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/card/user/${uri_supplement}, and need to post data or append query string, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

card_user(:http_verb, authorizer_appid, :"${uri_supplement}", query)
card_user(:http_verb, authorizer_appid, :"${uri_supplement}", data)
Link to this function

component(http_verb, parameters)
component(:post, map()) :: any()
component(:post, atom()) :: any()

Perform COMPONENT API(s)

component(:post, uri_supplement)
component(:post, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/component.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/component/${uri_supplement}, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

component(:http_verb, :"${uri_supplement}")
Link to this function

component(http_verb, uri_supplement, parameters)
component(:post, atom(), map() | String.t()) :: any()

Perform COMPONENT API(s)

component(:post, uri_supplement, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/component.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/component/${uri_supplement}, and need to post data or append query string, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

component(:http_verb, :"${uri_supplement}", query)
component(:http_verb, :"${uri_supplement}", data)
Link to this function

datacube(http_verb, authorizer_appid)
datacube(:get, String.t()) :: any()

Perform DATACUBE API(s)

datacube(:get, authorizer_appid)
datacube(:post, authorizer_appid)

Send request to URL https://api.weixin.qq.com/datacube.

Link to this function

datacube(http_verb, authorizer_appid, parameters)
datacube(:get, String.t(), keyword()) :: any()
datacube(:get, String.t(), atom()) :: any()
datacube(:post, String.t(), map() | String.t()) :: any()
datacube(:post, String.t(), atom()) :: any()

Perform DATACUBE API(s)

datacube(:get, authorizer_appid, uri_supplement)
datacube(:get, authorizer_appid, query)
datacube(:post, authorizer_appid, uri_supplement)
datacube(:post, authorizer_appid, data)

Send request to URL https://api.weixin.qq.com/datacube.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/datacube/${uri_supplement}, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

datacube(:http_verb, authorizer_appid, :"${uri_supplement}")
Link to this function

datacube(http_verb, authorizer_appid, uri_supplement, parameters)
datacube(:get, String.t(), atom(), keyword()) :: any()
datacube(:post, String.t(), atom(), map() | String.t()) :: any()

Perform DATACUBE API(s)

datacube(:get, authorizer_appid, uri_supplement, query)
datacube(:post, authorizer_appid, uri_supplement, data)

Send request to URL https://api.weixin.qq.com/datacube.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/datacube/${uri_supplement}, and need to post data or append query string, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

datacube(:http_verb, authorizer_appid, :"${uri_supplement}", query)
datacube(:http_verb, authorizer_appid, :"${uri_supplement}", data)
Link to this function

get_access_token(authorizer_appid)

Link to this function

get_component_access_token()

Link to this function

material(http_verb, authorizer_appid)
material(:get, String.t()) :: any()

Perform MATERIAL API(s)

material(:get, authorizer_appid)
material(:post, authorizer_appid)

Send request to URL https://api.weixin.qq.com/cgi-bin/material.

Link to this function

material(http_verb, authorizer_appid, parameters)
material(:get, String.t(), keyword()) :: any()
material(:get, String.t(), atom()) :: any()
material(:post, String.t(), map() | String.t()) :: any()
material(:post, String.t(), atom()) :: any()

Perform MATERIAL API(s)

material(:get, authorizer_appid, uri_supplement)
material(:get, authorizer_appid, query)
material(:post, authorizer_appid, uri_supplement)
material(:post, authorizer_appid, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/material.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/material/${uri_supplement}, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

material(:http_verb, authorizer_appid, :"${uri_supplement}")
Link to this function

material(http_verb, authorizer_appid, uri_supplement, parameters)
material(:get, String.t(), atom(), keyword()) :: any()
material(:post, String.t(), atom(), map() | String.t()) :: any()

Perform MATERIAL API(s)

material(:get, authorizer_appid, uri_supplement, query)
material(:post, authorizer_appid, uri_supplement, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/material.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/material/${uri_supplement}, and need to post data or append query string, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

material(:http_verb, authorizer_appid, :"${uri_supplement}", query)
material(:http_verb, authorizer_appid, :"${uri_supplement}", data)
Link to this function

media(http_verb, authorizer_appid)
media(:get, String.t()) :: any()

Perform MEDIA API(s)

media(:get, authorizer_appid)
media(:post, authorizer_appid)

Send request to URL https://api.weixin.qq.com/cgi-bin/media.

Link to this function

media(http_verb, authorizer_appid, parameters)
media(:get, String.t(), keyword()) :: any()
media(:get, String.t(), atom()) :: any()
media(:post, String.t(), map() | String.t()) :: any()
media(:post, String.t(), atom()) :: any()
media(:post_form, String.t(), map()) :: any()

Perform MEDIA API(s)

media(:get, authorizer_appid, uri_supplement)
media(:get, authorizer_appid, query)
media(:post, authorizer_appid, uri_supplement)
media(:post, authorizer_appid, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/media.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/media/${uri_supplement}, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

media(:http_verb, authorizer_appid, :"${uri_supplement}")
Link to this function

media(http_verb, authorizer_appid, uri_supplement, parameters)
media(:get, String.t(), atom(), keyword()) :: any()
media(:post, String.t(), atom(), map() | String.t()) :: any()
media(:post_form, String.t(), atom(), map()) :: any()

Perform MEDIA API(s)

media(:get, authorizer_appid, uri_supplement, query)
media(:post, authorizer_appid, uri_supplement, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/media.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/media/${uri_supplement}, and need to post data or append query string, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

media(:http_verb, authorizer_appid, :"${uri_supplement}", query)
media(:http_verb, authorizer_appid, :"${uri_supplement}", data)
Link to this function

message_custom(http_verb, authorizer_appid)
message_custom(:get, String.t()) :: any()

Perform MESSAGE_CUSTOM API(s)

message_custom(:get, authorizer_appid)
message_custom(:post, authorizer_appid)

Send request to URL https://api.weixin.qq.com/cgi-bin/message/custom.

Link to this function

message_custom(http_verb, authorizer_appid, parameters)
message_custom(:get, String.t(), keyword()) :: any()
message_custom(:get, String.t(), atom()) :: any()
message_custom(:post, String.t(), map() | String.t()) :: any()
message_custom(:post, String.t(), atom()) :: any()

Perform MESSAGE_CUSTOM API(s)

message_custom(:get, authorizer_appid, uri_supplement)
message_custom(:get, authorizer_appid, query)
message_custom(:post, authorizer_appid, uri_supplement)
message_custom(:post, authorizer_appid, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/message/custom.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/message/custom/${uri_supplement}, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

message_custom(:http_verb, authorizer_appid, :"${uri_supplement}")
Link to this function

message_custom(http_verb, authorizer_appid, uri_supplement, parameters)
message_custom(:get, String.t(), atom(), keyword()) :: any()
message_custom(:post, String.t(), atom(), map() | String.t()) :: any()

Perform MESSAGE_CUSTOM API(s)

message_custom(:get, authorizer_appid, uri_supplement, query)
message_custom(:post, authorizer_appid, uri_supplement, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/message/custom.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/message/custom/${uri_supplement}, and need to post data or append query string, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

message_custom(:http_verb, authorizer_appid, :"${uri_supplement}", query)
message_custom(:http_verb, authorizer_appid, :"${uri_supplement}", data)
Link to this function

message_template(http_verb, authorizer_appid)
message_template(:get, String.t()) :: any()

Perform MESSAGE_TEMPLATE API(s)

message_template(:get, authorizer_appid)
message_template(:post, authorizer_appid)

Send request to URL https://api.weixin.qq.com/cgi-bin/message/template.

Link to this function

message_template(http_verb, authorizer_appid, parameters)
message_template(:get, String.t(), keyword()) :: any()
message_template(:get, String.t(), atom()) :: any()
message_template(:post, String.t(), map() | String.t()) :: any()
message_template(:post, String.t(), atom()) :: any()

Perform MESSAGE_TEMPLATE API(s)

message_template(:get, authorizer_appid, uri_supplement)
message_template(:get, authorizer_appid, query)
message_template(:post, authorizer_appid, uri_supplement)
message_template(:post, authorizer_appid, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/message/template.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/message/template/${uri_supplement}, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

message_template(:http_verb, authorizer_appid, :"${uri_supplement}")
Link to this function

message_template(http_verb, authorizer_appid, uri_supplement, parameters)
message_template(:get, String.t(), atom(), keyword()) :: any()
message_template(:post, String.t(), atom(), map() | String.t()) :: any()

Perform MESSAGE_TEMPLATE API(s)

message_template(:get, authorizer_appid, uri_supplement, query)
message_template(:post, authorizer_appid, uri_supplement, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/message/template.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/message/template/${uri_supplement}, and need to post data or append query string, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

message_template(:http_verb, authorizer_appid, :"${uri_supplement}", query)
message_template(:http_verb, authorizer_appid, :"${uri_supplement}", data)
Link to this function

poi(http_verb, authorizer_appid)
poi(:get, String.t()) :: any()

Perform POI API(s)

poi(:get, authorizer_appid)
poi(:post, authorizer_appid)

Send request to URL https://api.weixin.qq.com/cgi-bin/poi.

Link to this function

poi(http_verb, authorizer_appid, parameters)
poi(:get, String.t(), keyword()) :: any()
poi(:get, String.t(), atom()) :: any()
poi(:post, String.t(), map() | String.t()) :: any()
poi(:post, String.t(), atom()) :: any()

Perform POI API(s)

poi(:get, authorizer_appid, uri_supplement)
poi(:get, authorizer_appid, query)
poi(:post, authorizer_appid, uri_supplement)
poi(:post, authorizer_appid, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/poi.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/poi/${uri_supplement}, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

poi(:http_verb, authorizer_appid, :"${uri_supplement}")
Link to this function

poi(http_verb, authorizer_appid, uri_supplement, parameters)
poi(:get, String.t(), atom(), keyword()) :: any()
poi(:post, String.t(), atom(), map() | String.t()) :: any()

Perform POI API(s)

poi(:get, authorizer_appid, uri_supplement, query)
poi(:post, authorizer_appid, uri_supplement, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/poi.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/poi/${uri_supplement}, and need to post data or append query string, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

poi(:http_verb, authorizer_appid, :"${uri_supplement}", query)
poi(:http_verb, authorizer_appid, :"${uri_supplement}", data)
Link to this function

qrcode(http_verb, authorizer_appid)
qrcode(:get, String.t()) :: any()

Perform QRCODE API(s)

qrcode(:get, authorizer_appid)
qrcode(:post, authorizer_appid)

Send request to URL https://api.weixin.qq.com/cgi-bin/qrcode.

Link to this function

qrcode(http_verb, authorizer_appid, parameters)
qrcode(:get, String.t(), keyword()) :: any()
qrcode(:get, String.t(), atom()) :: any()
qrcode(:post, String.t(), map() | String.t()) :: any()
qrcode(:post, String.t(), atom()) :: any()

Perform QRCODE API(s)

qrcode(:get, authorizer_appid, uri_supplement)
qrcode(:get, authorizer_appid, query)
qrcode(:post, authorizer_appid, uri_supplement)
qrcode(:post, authorizer_appid, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/qrcode.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/qrcode/${uri_supplement}, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

qrcode(:http_verb, authorizer_appid, :"${uri_supplement}")
Link to this function

qrcode(http_verb, authorizer_appid, uri_supplement, parameters)
qrcode(:get, String.t(), atom(), keyword()) :: any()
qrcode(:post, String.t(), atom(), map() | String.t()) :: any()

Perform QRCODE API(s)

qrcode(:get, authorizer_appid, uri_supplement, query)
qrcode(:post, authorizer_appid, uri_supplement, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/qrcode.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/qrcode/${uri_supplement}, and need to post data or append query string, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

qrcode(:http_verb, authorizer_appid, :"${uri_supplement}", query)
qrcode(:http_verb, authorizer_appid, :"${uri_supplement}", data)
Link to this function

refresh_access_token(authorizer_appid, options)

Refresh authorizer access_token in :client scenario, by default a refresh request will be sent to the hub server to fetch a fresh access_token.

  refresh_access_token(authorizer_appid, [access_token: access_token])
Link to this function

shorturl(http_verb, authorizer_appid, parameters)
shorturl(:post, String.t(), map() | String.t()) :: any()
shorturl(:post, String.t(), atom()) :: any()

Perform SHORTURL API(s)

shorturl(:post, authorizer_appid, uri_supplement)
shorturl(:post, authorizer_appid, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/shorturl.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/shorturl/${uri_supplement}, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

shorturl(:http_verb, authorizer_appid, :"${uri_supplement}")
Link to this function

shorturl(http_verb, authorizer_appid, uri_supplement, parameters)
shorturl(:post, String.t(), atom(), map() | String.t()) :: any()

Perform SHORTURL API(s)

shorturl(:post, authorizer_appid, uri_supplement, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/shorturl.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/shorturl/${uri_supplement}, and need to post data or append query string, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

shorturl(:http_verb, authorizer_appid, :"${uri_supplement}", query)
shorturl(:http_verb, authorizer_appid, :"${uri_supplement}", data)
Link to this function

showqrcode(http_verb, authorizer_appid)
showqrcode(:get, String.t()) :: any()

Perform SHOWQRCODE API(s)

showqrcode(:get, authorizer_appid)

Send request to URL https://mp.weixin.qq.com/cgi-bin/showqrcode.

Link to this function

showqrcode(http_verb, authorizer_appid, parameters)
showqrcode(:get, String.t(), keyword()) :: any()
showqrcode(:get, String.t(), atom()) :: any()

Perform SHOWQRCODE API(s)

showqrcode(:get, authorizer_appid, uri_supplement)
showqrcode(:get, authorizer_appid, query)

Send request to URL https://mp.weixin.qq.com/cgi-bin/showqrcode.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://mp.weixin.qq.com/cgi-bin/showqrcode/${uri_supplement}, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

showqrcode(:http_verb, authorizer_appid, :"${uri_supplement}")
Link to this function

showqrcode(http_verb, authorizer_appid, uri_supplement, parameters)
showqrcode(:get, String.t(), atom(), keyword()) :: any()

Perform SHOWQRCODE API(s)

showqrcode(:get, authorizer_appid, uri_supplement, query)

Send request to URL https://mp.weixin.qq.com/cgi-bin/showqrcode.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://mp.weixin.qq.com/cgi-bin/showqrcode/${uri_supplement}, and need to post data or append query string, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

showqrcode(:http_verb, authorizer_appid, :"${uri_supplement}", query)
showqrcode(:http_verb, authorizer_appid, :"${uri_supplement}", data)
Link to this function

tags(http_verb, authorizer_appid)
tags(:get, String.t()) :: any()

Perform TAGS API(s)

tags(:get, authorizer_appid)
tags(:post, authorizer_appid)

Send request to URL https://api.weixin.qq.com/cgi-bin/tags.

Link to this function

tags(http_verb, authorizer_appid, parameters)
tags(:get, String.t(), keyword()) :: any()
tags(:get, String.t(), atom()) :: any()
tags(:post, String.t(), map() | String.t()) :: any()
tags(:post, String.t(), atom()) :: any()

Perform TAGS API(s)

tags(:get, authorizer_appid, uri_supplement)
tags(:get, authorizer_appid, query)
tags(:post, authorizer_appid, uri_supplement)
tags(:post, authorizer_appid, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/tags.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/tags/${uri_supplement}, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

tags(:http_verb, authorizer_appid, :"${uri_supplement}")
Link to this function

tags(http_verb, authorizer_appid, uri_supplement, parameters)
tags(:get, String.t(), atom(), keyword()) :: any()
tags(:post, String.t(), atom(), map() | String.t()) :: any()

Perform TAGS API(s)

tags(:get, authorizer_appid, uri_supplement, query)
tags(:post, authorizer_appid, uri_supplement, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/tags.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/tags/${uri_supplement}, and need to post data or append query string, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

tags(:http_verb, authorizer_appid, :"${uri_supplement}", query)
tags(:http_verb, authorizer_appid, :"${uri_supplement}", data)
Link to this function

template(http_verb, authorizer_appid)
template(:get, String.t()) :: any()

Perform TEMPLATE API(s)

template(:get, authorizer_appid)
template(:post, authorizer_appid)

Send request to URL https://api.weixin.qq.com/cgi-bin/template.

Link to this function

template(http_verb, authorizer_appid, parameters)
template(:get, String.t(), keyword()) :: any()
template(:get, String.t(), atom()) :: any()
template(:post, String.t(), map() | String.t()) :: any()
template(:post, String.t(), atom()) :: any()

Perform TEMPLATE API(s)

template(:get, authorizer_appid, uri_supplement)
template(:get, authorizer_appid, query)
template(:post, authorizer_appid, uri_supplement)
template(:post, authorizer_appid, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/template.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/template/${uri_supplement}, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

template(:http_verb, authorizer_appid, :"${uri_supplement}")
Link to this function

template(http_verb, authorizer_appid, uri_supplement, parameters)
template(:get, String.t(), atom(), keyword()) :: any()
template(:post, String.t(), atom(), map() | String.t()) :: any()

Perform TEMPLATE API(s)

template(:get, authorizer_appid, uri_supplement, query)
template(:post, authorizer_appid, uri_supplement, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/template.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/template/${uri_supplement}, and need to post data or append query string, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

template(:http_verb, authorizer_appid, :"${uri_supplement}", query)
template(:http_verb, authorizer_appid, :"${uri_supplement}", data)
Link to this function

user(http_verb, authorizer_appid)
user(:get, String.t()) :: any()

Perform USER API(s)

user(:get, authorizer_appid)
user(:post, authorizer_appid)

Send request to URL https://api.weixin.qq.com/cgi-bin/user.

Link to this function

user(http_verb, authorizer_appid, parameters)
user(:get, String.t(), keyword()) :: any()
user(:get, String.t(), atom()) :: any()
user(:post, String.t(), map() | String.t()) :: any()
user(:post, String.t(), atom()) :: any()

Perform USER API(s)

user(:get, authorizer_appid, uri_supplement)
user(:get, authorizer_appid, query)
user(:post, authorizer_appid, uri_supplement)
user(:post, authorizer_appid, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/user.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/user/${uri_supplement}, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

user(:http_verb, authorizer_appid, :"${uri_supplement}")
Link to this function

user(http_verb, authorizer_appid, uri_supplement, parameters)
user(:get, String.t(), atom(), keyword()) :: any()
user(:post, String.t(), atom(), map() | String.t()) :: any()

Perform USER API(s)

user(:get, authorizer_appid, uri_supplement, query)
user(:post, authorizer_appid, uri_supplement, data)

Send request to URL https://api.weixin.qq.com/cgi-bin/user.

Refer WeChat Official Accounts Platform document, if you need to call a service's url is https://api.weixin.qq.com/cgi-bin/user/${uri_supplement}, and need to post data or append query string, please use uri_supplement parameter to construct the corresponding service's complete url, for example:

user(:http_verb, authorizer_appid, :"${uri_supplement}", query)
user(:http_verb, authorizer_appid, :"${uri_supplement}", data)