Struct SubscribeApi 

pub struct SubscribeApi { /* private fields */ }

Subscribe Message API

Provides methods for sending subscribe messages and managing templates.

Implementations

impl SubscribeApi

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

Create a new SubscribeApi instance

pub async fn send( &self, options: SubscribeMessageOptions, ) -> Result<(), WechatError>

Send subscribe message

POST /cgi-bin/message/subscribe/send?access_token=ACCESS_TOKEN

Arguments

• options - Subscribe message options

Example

use wechat_mp_sdk::api::subscribe::{
    SubscribeApi, SubscribeMessageOptions, SubscribeMessageData, SubscribeMessageValue
};

let mut data = SubscribeMessageData::new();
data.insert("thing1".to_string(), SubscribeMessageValue::new("Order #123"));

let options = SubscribeMessageOptions {
    touser: "user_openid".to_string(),
    template_id: "template_id".to_string(),
    data,
    page: Some("pages/index/index".to_string()),
    miniprogram_state: None,
    lang: None,
};

subscribe_api.send(options).await?;

pub async fn add_template( &self, tid: &str, kid_list: Option<Vec<i32>>, scene_desc: Option<&str>, ) -> Result<String, WechatError>

Add template from template library

POST /wxaapi/newtmpl/addtemplate?access_token=ACCESS_TOKEN

Arguments

• tid - Template library ID
• kid_list - Keyword ID list (optional)
• scene_desc - Scene description (optional)

Returns

The private template ID

Example

let pri_tmpl_id = subscribe_api.add_template("tid123", Some(vec![1, 2, 3]), Some("payment notification")).await?;
println!("Template ID: {}", pri_tmpl_id);

pub async fn get_template_list(&self) -> Result<Vec<TemplateInfo>, WechatError>

Get template list

GET /wxaapi/newtmpl/gettemplate?access_token=ACCESS_TOKEN

Returns

List of templates

Example

let templates = subscribe_api.get_template_list().await?;
for tmpl in templates {
    println!("Template: {} - {}", tmpl.private_template_id, tmpl.title);
}

pub async fn delete_template( &self, pri_tmpl_id: &str, ) -> Result<(), WechatError>

Delete template

POST /wxaapi/newtmpl/deltemplate?access_token=ACCESS_TOKEN

Arguments

• pri_tmpl_id - Private template ID to delete

Example

subscribe_api.delete_template("pri_tmpl_id_123").await?;

pub async fn get_category(&self) -> Result<Vec<CategoryInfo>, WechatError>

Get category list

GET /wxaapi/newtmpl/getcategory?access_token=ACCESS_TOKEN

Returns

List of categories available for templates

Example

let categories = subscribe_api.get_category().await?;
for cat in categories {
    println!("Category: {} - {}", cat.id, cat.name);
}

pub async fn get_pub_template_keywords_by_id( &self, tid: &str, ) -> Result<PubTemplateKeywordResponse, WechatError>

pub async fn get_pub_template_title_list( &self, ids: &[i32], start: i32, limit: i32, ) -> Result<PubTemplateTitleListResponse, WechatError>

pub async fn set_user_notify( &self, request: &UserNotifyRequest, ) -> Result<UserNotifyResponse, WechatError>

pub async fn set_user_notify_ext( &self, request: &UserNotifyExtRequest, ) -> Result<UserNotifyResponse, WechatError>

pub async fn get_user_notify( &self, request: &GetUserNotifyRequest, ) -> Result<UserNotifyResponse, WechatError>

Trait Implementations

impl WechatApi for SubscribeApi

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.