Struct OpenApiApi 

pub struct OpenApiApi { /* private fields */ }

OpenAPI Management API

Provides methods for managing API quotas, debugging, and server info.

Implementations

impl OpenApiApi

pub fn new(context: Arc<WechatContext>) -> Self

Create a new OpenApiApi instance

pub async fn clear_quota(&self) -> Result<(), WechatError>

Clear all API call quotas for this appid

POST /cgi-bin/clear_quota?access_token=ACCESS_TOKEN

Returns

Ok(()) on success

pub async fn get_api_quota( &self, cgi_path: &str, ) -> Result<ApiQuotaResponse, WechatError>

Get API call quota for a specific endpoint

POST /cgi-bin/openapi/quota/get?access_token=ACCESS_TOKEN

Arguments

• cgi_path - The API path to query (e.g., “/cgi-bin/message/custom/send”)

pub async fn clear_api_quota(&self, cgi_path: &str) -> Result<(), WechatError>

Clear API call quota for a specific endpoint

POST /cgi-bin/openapi/quota/clear?access_token=ACCESS_TOKEN

Arguments

• cgi_path - The API path to clear quota for

pub async fn clear_quota_by_app_secret(&self) -> Result<(), WechatError>

Clear all API call quotas using AppSecret (no access_token required)

POST /cgi-bin/clear_quota/v2

This endpoint authenticates with appid + appsecret directly, bypassing the access_token mechanism.

pub async fn get_rid_info( &self, rid: &str, ) -> Result<RidInfoResponse, WechatError>

Get request debug information by rid

POST /cgi-bin/openapi/rid/get?access_token=ACCESS_TOKEN

Arguments

• rid - The request ID to look up

pub async fn callback_check( &self, action: &str, check_operator: &str, ) -> Result<CallbackCheckResponse, WechatError>

Check callback URL connectivity

POST /cgi-bin/callback/check?access_token=ACCESS_TOKEN

Arguments

• action - Check action type (e.g., “all”, “dns”, “ping”)
• check_operator - Operator to check (e.g., “DEFAULT”, “CHINANET”, “UNICOM”, “CAP”)

pub async fn get_api_domain_ip(&self) -> Result<IpListResponse, WechatError>

Get WeChat API server IP addresses

GET /cgi-bin/get_api_domain_ip?access_token=ACCESS_TOKEN

pub async fn get_callback_ip(&self) -> Result<IpListResponse, WechatError>

Get WeChat callback server IP addresses

GET /cgi-bin/getcallbackip?access_token=ACCESS_TOKEN

Trait Implementations

impl WechatApi for OpenApiApi

fn context(&self) -> &WechatContext

Get a reference to the WeChat context

fn api_name(&self) -> &'static str

Get the name of this API for logging and error context.