Skip to main content

Module api

Module api 

Source
Expand description

WeChat Mini Program API modules

This module contains submodules for various WeChat Mini Program APIs:

  • common - Shared response primitives, pagination, and date range types
  • auth - Login authentication (code2Session)
  • customer_service - Customer service messages
  • media - Temporary media upload and download
  • subscribe - Subscribe messages and template management
  • qrcode - Mini Program codes, QR codes, and URL links
  • template - Template message management
  • user - User information and phone number
  • openapi - OpenAPI quota and diagnostic management
  • wechat_kf - WeChat open customer service account binding
  • security - Content security checks
  • analytics - Data analytics and visit trends
  • operations - Mini program operations and logs
  • plugin - Plugin application management
  • nearby - Nearby points of interest
  • cloud - WeChat Cloud Base (TCB)
  • live - Live streaming rooms and goods
  • hardware - IoT hardware device messaging
  • ocr - Image processing and OCR
  • delivery - Instant/local delivery orders
  • logistics - Express delivery and tracking
  • service_market - WeChat service marketplace
  • soter - SOTER biometric authentication
  • face - Face identity verification
  • wxsearch - WeChat search page submission
  • advertising - Advertising user action tracking

§Usage

use wechat_mp_sdk::{WechatMp, types::{AppId, AppSecret}};

Re-exports§

pub use advertising::AdvertisingApi;
pub use advertising::AdvertisingRequest;
pub use advertising::AdvertisingResponse;
pub use analytics::AnalyticsApi;
pub use analytics::AnalyticsDateRangeRequest;
pub use analytics::AnalyticsResponse;
pub use analytics::PerformanceDataRequest;
pub use cloud::CloudApi;
pub use cloud::CloudDatabaseRequest;
pub use cloud::CloudResponse;
pub use cloud::DelayedFunctionTaskRequest;
pub use cloud::DeleteCloudFileRequest;
pub use cloud::DownloadFileLinkRequest;
pub use cloud::InvokeCloudFunctionRequest;
pub use cloud::SendCloudBaseSmsRequest;
pub use cloud::UploadFileLinkRequest;
pub use common::ApiResponseBase;
pub use common::DateRangeRequest;
pub use common::PaginatedRequest;
pub use common::PaginatedResponse;
pub use common::WechatApiResponse;
pub use customer_service::CustomerServiceApi;
pub use customer_service::LinkMessage;
pub use customer_service::MediaMessage;
pub use customer_service::Message;
pub use customer_service::MiniProgramPageMessage;
pub use customer_service::TextMessage;
pub use delivery::DeliveryApi;
pub use delivery::DeliveryRequest;
pub use delivery::DeliveryResponse;
pub use face::FaceApi;
pub use face::FaceResponse;
pub use face::GetVerifyIdRequest;
pub use face::QueryVerifyInfoRequest;
pub use hardware::HardwareApi;
pub use hardware::HardwareRequest;
pub use hardware::HardwareResponse;
pub use live::DeleteRoomRequest;
pub use live::GetLiveInfoRequest;
pub use live::LiveApi;
pub use live::LiveRequest;
pub use live::LiveResponse;
pub use logistics::LogisticsApi;
pub use logistics::LogisticsRequest;
pub use logistics::LogisticsResponse;
pub use media::MediaApi;
pub use media::MediaType;
pub use media::MediaUploadResponse;
pub use nearby::AddNearbyPoiRequest;
pub use nearby::DeleteNearbyPoiRequest;
pub use nearby::NearbyApi;
pub use nearby::NearbyPoiListRequest;
pub use nearby::NearbyResponse;
pub use nearby::NearbyShowStatusRequest;
pub use ocr::IdCardOcrRequest;
pub use ocr::OcrApi;
pub use ocr::OcrImageRequest;
pub use ocr::OcrResponse;
pub use openapi::ApiQuotaResponse;
pub use openapi::CallbackCheckResponse;
pub use openapi::DnsInfo;
pub use openapi::IpListResponse;
pub use openapi::OpenApiApi;
pub use openapi::PingInfo;
pub use openapi::QuotaInfo;
pub use openapi::RidInfoResponse;
pub use openapi::RidRequestInfo;
pub use operations::EmptyRequest;
pub use operations::FeedbackMediaRequest;
pub use operations::FeedbackRequest;
pub use operations::JsErrDetailRequest;
pub use operations::JsErrListRequest;
pub use operations::OperationsApi;
pub use operations::OperationsResponse;
pub use operations::RealtimeLogSearchRequest;
pub use plugin::ManagePluginApplicationRequest;
pub use plugin::ManagePluginRequest;
pub use plugin::PluginApi;
pub use plugin::PluginResponse;
pub use trait::WechatApi;
pub use trait::WechatContext;
pub use security::MediaCheckAsyncResponse;
pub use security::MsgSecCheckDetail;
pub use security::MsgSecCheckResponse;
pub use security::MsgSecCheckResult;
pub use security::SecurityApi;
pub use security::UserRiskRankOptions;
pub use security::UserRiskRankResponse;
pub use service_market::InvokeServiceRequest;
pub use service_market::ServiceMarketApi;
pub use service_market::ServiceMarketResponse;
pub use soter::SoterApi;
pub use soter::VerifySignatureRequest;
pub use soter::VerifySignatureResponse;
pub use subscribe::AddTemplateResponse;
pub use subscribe::CategoryInfo;
pub use subscribe::CategoryListResponse;
pub use subscribe::GetUserNotifyRequest;
pub use subscribe::Lang;
pub use subscribe::MiniProgramState;
pub use subscribe::PubTemplateKeywordInfo;
pub use subscribe::PubTemplateKeywordResponse;
pub use subscribe::PubTemplateTitleInfo;
pub use subscribe::PubTemplateTitleListResponse;
pub use subscribe::SubscribeApi;
pub use subscribe::SubscribeMessageData;
pub use subscribe::SubscribeMessageOptions;
pub use subscribe::SubscribeMessageValue;
pub use subscribe::TemplateInfo;
pub use subscribe::TemplateListResponse;
pub use subscribe::UserNotifyExtRequest;
pub use subscribe::UserNotifyRequest;
pub use subscribe::UserNotifyResponse;
pub use template::TemplateApi;
pub use wechat_kf::KfWorkBoundResponse;
pub use wechat_kf::KfWorkInfo;
pub use wechat_kf::WechatKfApi;
pub use wxsearch::SubmitPagesRequest;
pub use wxsearch::SubmitPagesResponse;
pub use wxsearch::WxsearchApi;

Modules§

advertising
Advertising API
analytics
Analytics API
auth
WeChat Authentication API
cloud
Cloud Base API
common
Common API response primitives
customer_service
Customer Service Message API
delivery
Instant Delivery API
endpoint_inventory
face
Face Verification API
hardware
Hardware Device API
live
Live Streaming API
logistics
Logistics / Express API
media
Temporary Media Management API
nearby
Nearby Mini Program API
ocr
Image and OCR API
openapi
OpenAPI Management API
operations
Operations API
plugin
Plugin API
qrcode
security
Security API
service_market
Service Market API
soter
SOTER Biometric API
subscribe
Subscribe Message API
template
Template Message Management API
trait
WeChat API trait and context
user
wechat_kf
WeChat Customer Service (KF) API
wxsearch
WeChat Search API