# Basic Interfaces
Interface Name | English name | Request Path |
---|---|---|
Get Interface Call Credentials | getAccessToken | /cgi-bin/token |
Get stable version interface call credentials | getStableAccessToken | /cgi-bin/stable_token |
Network communication detection | callbackCheck | /cgi-bin/callback/check |
Get WeChat API Server IP | getApiDomainIp | /cgi-bin/get_api_domain_ip |
Get WeChat push server IP | getCallbackIp | /cgi-bin/getcallbackip |
# OpenApi Management
Interface Name | English name | Request Path |
---|---|---|
Reset the number of API calls | clearQuota | /cgi-bin/clear_quota |
Query API Call Quota | getApiQuota | /cgi-bin/openapi/quota/get |
Query rid information | getRidInfo | /cgi-bin/openapi/rid/get |
Reset the number of API calls with AppSecret | clearQuotaByAppSecret | /cgi-bin/clear_quota/v2 |
# Custom Menus
Interface Name | English name | Request Path |
---|---|---|
Create a custom menu | createCustomMenu | /cgi-bin/menu/create |
Query custom menu information | getCurrentSelfmenuInfo | /cgi-bin/get_current_selfmenu_info |
Get custom menu configuration | getMenu | /cgi-bin/menu/get |
Remove custom menus | deleteMenu | /cgi-bin/menu/delete |
Create personalized menus | addConditionalMenu | /cgi-bin/menu/addconditional |
Delete personalized menus | deleteConditionalMenu | /cgi-bin/menu/delconditional |
Test personalized menu matching results | tryMatchMenu | /cgi-bin/menu/trymatch |
# Basic Messages and Subscription Notifications
# Group message
Interface Name | English name | Request Path |
---|---|---|
Upload Graphic Message Picture | uploadImage | /cgi-bin/media/uploadimg |
Delete group messages | deleteMassMsg | /cgi-bin/message/mass/delete |
Get Group Traffic Speed | getSpeed | /cgi-bin/message/mass/speed/get |
Query the status of group message delivery | massmsgget | /cgi-bin/message/mass/get |
Group message based on OpenID | massSend | /cgi-bin/message/mass/send |
Preview message | preview | /cgi-bin/message/mass/preview |
Group messages based on hashtags | sendAll | /cgi-bin/message/mass/sendall |
Set up a group speed | setSpeed | /cgi-bin/message/mass/speed/set |
Upload Graphic Message Material | uploadnewsmsg | /cgi-bin/media/uploadnews |
# Template Messages
Interface Name | English name | Request Path |
---|---|---|
Send template messages | sendTemplateMessage | /cgi-bin/message/template/send |
Use a template | addTemplate | /cgi-bin/template/api_add_template |
Query intercepted template messages | queryBlockTmplMsg | /wxa/sec/queryblocktmplmsg |
Remove the template | deleteTemplate | /cgi-bin/template/del_private_template |
Get a list of selected templates | getAllTemplates | /cgi-bin/template/get_all_private_template |
Get Industry Information | getIndustry | /cgi-bin/template/get_industry |
Set your industry | setIndustry | /cgi-bin/template/api_set_industry |
# Subscribe to Notifications
Interface Name | English name | Request Path |
---|---|---|
Remove the template | delwxanewtemplate | /wxaapi/newtmpl/deltemplate |
Get Categories | getCategory | /wxaapi/newtmpl/getcategory |
Get keywords in the template | getpubnewtemplatekeywords | /wxaapi/newtmpl/getpubtemplatekeywords |
Get public templates under categories | getPubNewTemplatetitles | /wxaapi/newtmpl/getpubtemplatetitles |
Get a list of existing templates | getwxapubnewtemplate | /wxaapi/newtmpl/gettemplate |
Use a template | addwxanewtemplate | /wxaapi/newtmpl/addtemplate |
Send a subscription notification | sendNewSubscribeMsg | /cgi-bin/message/subscribe/bizsend |
# Subscribe to messages at once
Interface Name | English name | Request Path |
---|---|---|
Send a one-time subscription message | templateSubscribe | /cgi-bin/message/template/subscribe |
# Automatic reply
Interface Name | English name | Request Path |
---|---|---|
Get automatic response rules | getCurrentAutoreplyInfo | /cgi-bin/get_current_autoreply_info |
# Customer Service Messages
# Customer Service Management
Interface Name | English name | Request Path |
---|---|---|
Set up customer service avatar | uploadkfheadimg | /customservice/kfaccount/uploadheadimg |
Delete customer service account | delkfaccount | /customservice/kfaccount/del |
Invite to bind customer service account | invitekfworker | /customservice/kfaccount/inviteworker |
Get all customer service accounts | getkflist | /cgi-bin/customservice/getkflist |
Add customer service account | addkfaccount | /customservice/kfaccount/add |
Get an online customer service list | getonlinekflist | /cgi-bin/customservice/getonlinekflist |
Modify customer service account | updatekfaccount | /customservice/kfaccount/update |
# Session Control
Interface Name | English name | Request Path |
---|---|---|
Get a list of customer service sessions | getkfsessionlist | /customservice/kfsession/getsessionlist |
Close the session | closeSession | /customservice/kfsession/close |
Create a session | createkfsession | /customservice/kfsession/create |
Get the client session state | getkfsession | /customservice/kfsession/getsession |
Get a list of unanswered calls | getwaitcase | /customservice/kfsession/getwaitcase |
# Customer Service Messages
Interface Name | English name | Request Path |
---|---|---|
Get a chat log | getMsgList | /customservice/msgrecord/getmsglist |
Customer Service Enter Status | typing | /cgi-bin/message/custom/typing |
Send customer service messages | sendCustomMessage | /cgi-bin/message/custom/send |
# Material Management
# Permanent Materials
Interface Name | English name | Request Path |
---|---|---|
Get permanent material | getMaterial | /cgi-bin/material/get_material |
Total number of obtained permanent material | getMaterialCount | /cgi-bin/material/get_materialcount |
Get a list of permanent materials | batchGetMaterial | /cgi-bin/material/batchget_material |
Upload Graphic Message Picture | uploadImage | /cgi-bin/media/uploadimg |
Upload permanent material | addMaterial | /cgi-bin/material/add_material |
Delete permanent material | delMaterial | /cgi-bin/material/del_material |
# Temporary material
Interface Name | English name | Request Path |
---|---|---|
Get temporary material | getMedia | /cgi-bin/media/get |
Additional temporary material | uploadTempMedia | /cgi-bin/media/upload |
Get HD voice material | getHDVoice | /cgi-bin/media/get/jssdk |
# Draft management and product cards
# Draft management
Interface Name | English name | Request Path |
---|---|---|
Draft box switching settings | draft_switch | /cgi-bin/draft/switch |
Update draft | draft_update | /cgi-bin/draft/update |
Get a list of drafts | draft_batchget | /cgi-bin/draft/batchget |
Additional drafts | draft_add | /cgi-bin/draft/add |
Total number of drafts obtained | draft_count | /cgi-bin/draft/count |
Delete the draft | draft_delete | /cgi-bin/draft/delete |
Get details on the draft | getDraft | /cgi-bin/draft/get |
# Product cards
Interface Name | English name | Request Path |
---|---|---|
Get the DOM structure of the merchandise card | ecsgetproductcardinfo | /channels/ec/service/product/getcardinfo |
# Comment Management
Interface Name | English name | Request Path |
---|---|---|
Open grouped posts to comment | openArticleComment | /cgi-bin/comment/open |
View comment data for a specified article | listComment | /cgi-bin/comment/list |
Close Grouped Post Comments | closecomment | /cgi-bin/comment/close |
Comments Marked Favorites | electcomment | /cgi-bin/comment/markelect |
Comments Cancel Favorites | unelectcomment | /cgi-bin/comment/unmarkelect |
Delete Comments | delcomment | /cgi-bin/comment/delete |
Response to Comments | replycomment | /cgi-bin/comment/reply/add |
Delete reply | delreplycomment | /cgi-bin/comment/reply/delete |
# Release capability
Interface Name | English name | Request Path |
---|---|---|
Get a list of published messages | freepublish_batchget | /cgi-bin/freepublish/batchget |
Delete published articles | freepublishDelete | /cgi-bin/freepublish/delete |
Post Status Queries | freepublish_get | /cgi-bin/freepublish/get |
Get information on published graphics | freepublishGetarticle | /cgi-bin/freepublish/getarticle |
Publish a draft | freepublish_submit | /cgi-bin/freepublish/submit |
# User Management
# Label Management
Interface Name | English name | Request Path |
---|---|---|
Get a list of fans under the tag | getTagFans | /cgi-bin/user/tag/get |
Get a label | getTags | /cgi-bin/tags/get |
Create a tag | createTag | /cgi-bin/tags/create |
Edit labels | updateTag | /cgi-bin/tags/update |
Delete the tag | deleteTag | /cgi-bin/tags/delete |
Cancel labels for users in bulk | batchUntagging | /cgi-bin/tags/members/batchuntagging |
Label users in bulk | batchTagging | /cgi-bin/tags/members/batchtagging |
Get a list of users' tags | getTagidList | /cgi-bin/tags/getidlist |
# User Information
Interface Name | English name | Request Path |
---|---|---|
Cancel blocking users | batchUnblacklist | /cgi-bin/tags/members/batchunblacklist |
Get a blacklist list for Official Account | getBlacklist | /cgi-bin/tags/members/getblacklist |
Get basic user information | userInfo | /cgi-bin/user/info |
Get basic user information in bulk | batchUserinfo | /cgi-bin/user/info/batchget |
Get a list of subscribers | getFans | /cgi-bin/user/get |
Disable users | batchBlacklist | /cgi-bin/tags/members/batchblacklist |
Set user backup name | updateRemark | /cgi-bin/user/info/updateremark |
# Service Account Two dimensional code
# Scan two dimensional code open Weixin Mini Program
Interface Name | English name | Request Path |
---|---|---|
Get set rules | qrcodeJumpGet | /cgi-bin/wxopen/qrcodejumpget |
Set QR Code Rules | qrcodeJumpAdd | /cgi-bin/wxopen/qrcodejumpadd |
Rules for posting QR codes | qrcodeJumpPublish | /cgi-bin/wxopen/qrcodejumppublish |
Remove QR Code Rules | qrcodeJumpDelete | /cgi-bin/wxopen/qrcodejumpdelete |
# See QR code
Interface Name | English name | Request Path |
---|---|---|
Generate QR code with parameters | createQRCode | /cgi-bin/qrcode/create |
# Long information versus short chains
Interface Name | English name | Request Path |
---|---|---|
Long information to short chain | genShortKey | /cgi-bin/shorten/gen |
Short chains transition to longer information | fetchShorten | /cgi-bin/shorten/fetch |
# Data Statistics
# User data
Interface Name | English name | Request Path |
---|---|---|
Get user increase and decrease data | getusersummary | /datacube/getusersummary |
Get aggregate user data | getusercumulate | /datacube/getusercumulate |
# Graphical data
Interface Name | English name | Request Path |
---|---|---|
Get graphics and distribute daily data in groups | getarticlesummary | /datacube/getarticlesummary |
Get graph reading time data | getuserreadhour | /datacube/getuserreadhour |
Get graphic forwarding timed data | getusersharehour | /datacube/getusersharehour |
Get a diagram to read the overview data | getuserread | /datacube/getuserread |
Get the total data for a graph and text group | getarticletotal | /datacube/getarticletotal |
Get graphic forwarding profile data | getusershare | /datacube/getusershare |
# Message Data
Interface Name | English name | Request Path |
---|---|---|
Get message delivery profile data | getupstreammsg | /datacube/getupstreammsg |
Get Messages to Send Monthly Data | getupstreammsgmonth | /datacube/getupstreammsgmonth |
Get message sending distribution week data | getupstreammsgdistweek | /datacube/getupstreammsgdistweek |
Get message sent distributed monthly data | getupstreammsgdistmonth | /datacube/getupstreammsgdistmonth |
Get timed data for message sending | getupstreammsghour | /datacube/getupstreammsghour |
Get Message Sending Week Data | getupstreammsgweek | /datacube/getupstreammsgweek |
Get message sending distribution data | getupstreammsgdist | /datacube/getupstreammsgdist |
# Interface data
Interface Name | English name | Request Path |
---|---|---|
Get summary data on passive responses | getinterfacesummary | /datacube/getinterfacesummary |
Get passive response distribution data | getinterfacesummaryhour | /datacube/getinterfacesummaryhour |
# Web Development
# Web authorization
Interface Name | English name | Request Path |
---|---|---|
In exchange for user authorization credentials | snsAccessToken | /sns/oauth2/access_token |
Verify user authorization credentials | snsAuth | /sns/auth |
Get authorized user information | snsUserInfo | /sns/userinfo |
Refresh user authorization credentials | snsRefreshToken | /sns/oauth2/refresh_token |
# JS-SDK
Interface Name | English name | Request Path |
---|---|---|
Get the sdk temporary ticket | getTicket | /cgi-bin/ticket/getticket |
# Smart Interface
# AI open interface
Interface Name | English name | Request Path |
---|---|---|
WeChat Translation | translateContent | /cgi-bin/media/voice/translatecontent |
Upload voice files | addVoiceTorecoForText | /cgi-bin/media/voice/addvoicetorecofortext |
Get speech recognition results | queryRecoResultForText | /cgi-bin/media/voice/queryrecoresultfortext |
# ORC Identification
Interface Name | English name | Request Path |
---|---|---|
Menu Identification | menuOcr | /cv/ocr/menu |
Universal print identification | commocr | /cv/ocr/comm |
Driving license identification | drivingocr | /cv/ocr/driving |
Bank Card Identification | bankcardOcr | /cv/ocr/bankcard |
Identification of business licenses | bizlicenseOcr | /cv/ocr/bizlicense |
Driving license identification | drivinglicenseocr | /cv/ocr/drivinglicense |
ID identification | idcardOcr | /cv/ocr/idcard |
# image processing
Interface Name | English name | Request Path |
---|---|---|
Image Smart Cutting | imgAiCrop | /cv/img/aicrop |
QR Code / Barcode Identification | imgQrcode | /cv/img/qrcode |
# Weixin Mini Program
Interface Name | English name | Request Path |
---|---|---|
Pull Store Weixin Mini Program Category | getwxastorecatelist | /wxa/get_merchant_category |
Create a store Weixin Mini Program | applywxastore | /wxa/apply_merchant |
Get Store Weixin Mini Program Audit Results | getwxastoreauditinfo | /wxa/get_merchant_audit_info |
Modify store Weixin Mini Program information | modifywxastore | /wxa/modify_merchant |
Get information on provincial urban areas | getdistrictlist | /wxa/get_district |
Search for store map information | poilistsearch | /wxa/search_map_poi |
New stores | addentityshop | /wxa/add_store |
Get store details | newgetpoi | /wxa/get_store_info |
Get a list of stores | newgetpoilist | /wxa/get_store_list |
Delete a store | newdelpoi | /wxa/del_store |
Update store information | newupdatepoi | /wxa/update_store |
Create a store in a map | createnewpoid | /wxa/create_map_poi |
# WeChat Invoice
# Merchant ticketing interface
Interface Name | English name | Request Path |
---|---|---|
Query and set up authorization pages and merchant information | invoicebizsetattr | /card/invoice/setbizattr |
Request authorization information | invoiceBizGetAuthData | /card/invoice/getauthdata |
Get the sdk temporary ticket | getTicket | /cgi-bin/ticket/getticket |
Get a link to the authorisation page | invoicebizgetauthurl | /card/invoice/getauthurl |
Refused to open tickets | invoicebizrejectinsert | /card/invoice/rejectinsert |
# Ticketing platform
Interface Name | English name | Request Path |
---|---|---|
Get a ticketing platform identification number | setinvoiceurl | /card/invoice/seturl |
Query for uploaded PDF files | invoiceplatformgetpdf | /card/invoice/platform/getpdf |
Update the status of invoice vouchers | invoicekpupdatainvoicestatus | /card/invoice/platform/updatestatus |
Upload Invoice PDF | invoiceplatformsetpdf | /card/invoice/platform/setpdf |
Create an invoice voucher template | invoiceplatformcreatecard | /card/invoice/platform/createcard |
Plug an electronic invoice voucher into a user card package | insertinvoice | /card/invoice/insert |
# Invoice reimbursement
Interface Name | English name | Request Path |
---|---|---|
Check for reimbursement invoices information | invoicebxgetinvoice | /card/invoice/reimburse/getinvoiceinfo |
Update the status of reimbursement invoices | invoicebxupdatainvoicestatus | /card/invoice/reimburse/updateinvoicestatus |
Volume update of expense invoice status | invoicereimburseupdatestatusbatch | /card/invoice/reimburse/updatestatusbatch |
Bulk acquisition of reimbursement invoices information | invoicereimbursegetinvoicebatch | /card/invoice/reimburse/getinvoicebatch |
# A blitz of invoices
Interface Name | English name | Request Path |
---|---|---|
Input header to user WeChat | invoicebizgetusertitleurl | /card/invoice/biz/getusertitleurl |
Get a merchant's exclusive referral link | invoicebizgetselecttitleurl | /card/invoice/biz/getselecttitleurl |
Parse the upper QR code of the scan | invoicescantitle | /card/invoice/scantitle |
# Self-printing of electronic invoices
Interface Name | English name | Request Path |
---|---|---|
Check for reimbursement invoices information | invoicebxgetinvoice | /card/invoice/reimburse/getinvoiceinfo |
Update the status of reimbursement invoices | invoicebxupdatainvoicestatus | /card/invoice/reimburse/updateinvoicestatus |
Volume update of expense invoice status | invoicereimburseupdatestatusbatch | /card/invoice/reimburse/updatestatusbatch |
Bulk acquisition of reimbursement invoices information | invoicereimbursegetinvoicebatch | /card/invoice/reimburse/getinvoicebatch |
# Non-tax bills
Interface Name | English name | Request Path |
---|---|---|
Request authorization information | invoiceBizGetAuthData | /card/invoice/getauthdata |
Get the sdk temporary ticket | getTicket | /cgi-bin/ticket/getticket |
Refused to open tickets | invoicebizrejectinsert | /card/invoice/rejectinsert |
Get a ticketing platform identification number | setinvoiceurl | /card/invoice/seturl |
Query for uploaded PDF files | invoiceplatformgetpdf | /card/invoice/platform/getpdf |
Update the status of invoice vouchers | invoicekpupdatainvoicestatus | /card/invoice/platform/updatestatus |
Get a link to the authorisation page | notaxinvoicegetauthurl | /nontax/getbillauthurl |
Create a template for financial electronic bills | notaxinvoicecreatecard | /nontax/createbillcard |
The note inserted into the user card package | notaxinvoiceinsert | /nontax/insertbill |
Upload Invoice PDF | invoiceplatformsetpdf | /card/invoice/platform/setpdf |
# WeChat Non-tax payment
Interface Name | English name | Request Path |
---|---|---|
Enquire about receivable information | nontaxqueryfee | /nontax/queryfee |
Payment to place the order | nontaxunifiedorder | /nontax/unifiedorder |
Download Payment Statement | nontaxdownloadbill | /nontax/downloadbill |
Notification of an inconsistent order | nontaxnotifyinconsistentorder | /nontax/notifyinconsistentorder |
Notification of simulated payment results | nontaxmocknotification | /nontax/mocknotification |
Simulated query for receivable information | nontaxmockqueryfee | /nontax/mockqueryfee |
Submit a swipe payment | nontaxmicropay | /nontax/micropay |
Get a list of contributions orders | nontaxgetorderlist | /nontax/getorderlist |
Refund for Payment Orders | nontaxrefund | /nontax/refund |
Get Payment Order Details | nontaxgetorder | /nontax/getorder |
# WeChat "One thing one yard"
Interface Name | English name | Request Path |
---|---|---|
Check the QR code application form interface | intp_marketcode_applycodequery | /intp/marketcode/applycodequery |
Download QR Code Package Interface | intp_marketcode_applycodedownload | /intp/marketcode/applycodedownload |
Activate QR code interface | intp_marketcode_codeactive | /intp/marketcode/codeactive |
Check the QR code activation status interface | intp_marketcode_codeactivequery | /intp/marketcode/codeactivequery |
CODE_TICKET for CODE interface | intp_marketcode_tickettocode | /intp/marketcode/tickettocode |
Request QR code interface | intp_marketcode_applycode | /intp/marketcode/applycode |
# WeChat Medical assistant
Interface Name | English name | Request Path |
---|---|---|
Message push interface | cityservice_sendchannelmsg | /cityservice/sendchannelmsg |