open_lark/service/im/v1/batch_message/
mod.rs

1use reqwest::Method;
2use serde::{Deserialize, Serialize};
3use std::collections::HashMap;
4
5use crate::impl_full_service;
6use crate::{
7    core::{
8        api_req::ApiRequest,
9        api_resp::{ApiResponseTrait, BaseResponse, EmptyResponse, ResponseFormat},
10        config::Config,
11        constants::AccessTokenType,
12        endpoints::EndpointBuilder,
13        http::Transport,
14        req_option::RequestOption,
15        standard_response::StandardResponse,
16        SDKResult,
17    },
18    service::im::v1::models::{BatchMessageStatus, ReceiveIdType, UserIdType},
19};
20
21/// 批量消息服务
22pub struct BatchMessageService {
23    pub config: Config,
24}
25
26/// 批量发送消息请求
27#[derive(Debug, Serialize, Deserialize)]
28pub struct BatchSendMessageRequest {
29    /// 消息接收者ID列表
30    pub receive_id_list: Vec<String>,
31    /// 消息内容
32    pub msg_type: String,
33    /// 消息内容
34    pub content: String,
35    /// 用户ID类型，可选值为open_id、user_id、union_id
36    #[serde(skip_serializing_if = "Option::is_none")]
37    pub uuid: Option<String>,
38}
39
40// 接入统一 Service 抽象（IM v1 - BatchMessageService）
41impl_full_service!(BatchMessageService, "im.batch_message", "v1");
42
43/// 批量发送消息响应
44#[derive(Debug, Clone, Serialize, Deserialize)]
45pub struct BatchSendMessageResponse {
46    /// 批量消息ID
47    pub batch_message_id: String,
48    /// 无效的接收者ID列表
49    pub invalid_receive_ids: Vec<String>,
50}
51
52impl ApiResponseTrait for BatchSendMessageResponse {
53    fn data_format() -> ResponseFormat {
54        ResponseFormat::Data
55    }
56}
57
58/// 查询批量消息进度响应
59#[derive(Debug, Clone, Serialize, Deserialize)]
60pub struct GetBatchProgressResponse {
61    /// 批量消息进度信息
62    pub batch_message_progress: BatchMessageProgress,
63}
64
65/// 批量消息进度信息
66#[derive(Debug, Clone, Serialize, Deserialize)]
67pub struct BatchMessageProgress {
68    /// 批量消息ID
69    pub batch_message_id: String,
70    /// 状态
71    pub status: BatchMessageStatus,
72    /// 总数
73    pub total_count: i32,
74    /// 成功数
75    pub success_count: i32,
76    /// 失败数
77    pub fail_count: i32,
78    /// 已读数
79    pub read_count: i32,
80}
81
82impl ApiResponseTrait for GetBatchProgressResponse {
83    fn data_format() -> ResponseFormat {
84        ResponseFormat::Data
85    }
86}
87
88/// 查询批量消息推送和阅读人数响应
89#[derive(Debug, Clone, Serialize, Deserialize)]
90pub struct GetBatchReadUserResponse {
91    /// 已读用户列表
92    pub read_users: Vec<BatchReadUser>,
93    /// 是否还有更多数据
94    pub has_more: bool,
95    /// 分页标记
96    pub page_token: Option<String>,
97}
98
99/// 批量消息已读用户信息
100#[derive(Debug, Clone, Serialize, Deserialize)]
101pub struct BatchReadUser {
102    /// 用户ID
103    pub user_id: String,
104    /// 用户姓名
105    pub name: Option<String>,
106    /// 阅读时间
107    pub read_time: String,
108}
109
110impl ApiResponseTrait for GetBatchReadUserResponse {
111    fn data_format() -> ResponseFormat {
112        ResponseFormat::Data
113    }
114}
115
116impl BatchMessageService {
117    pub fn new(config: Config) -> Self {
118        Self { config }
119    }
120
121    /// 批量发送消息
122    pub async fn send(
123        &self,
124        receive_id_type: ReceiveIdType,
125        request: BatchSendMessageRequest,
126        option: Option<RequestOption>,
127    ) -> SDKResult<BatchSendMessageResponse> {
128        let api_req = ApiRequest {
129            http_method: Method::POST,
130            api_path: crate::core::endpoints::im::IM_V1_BATCH_MESSAGES.to_string(),
131            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
132            query_params: HashMap::from([(
133                "receive_id_type",
134                receive_id_type.as_str().to_string(),
135            )]),
136            body: serde_json::to_vec(&request)?,
137            ..Default::default()
138        };
139
140        let api_resp: BaseResponse<BatchSendMessageResponse> =
141            Transport::request(api_req, &self.config, option).await?;
142        api_resp.into_result()
143    }
144
145    /// 批量撤回消息
146    pub async fn delete(
147        &self,
148        batch_message_id: &str,
149        option: Option<RequestOption>,
150    ) -> SDKResult<EmptyResponse> {
151        let api_req = ApiRequest {
152            http_method: Method::DELETE,
153            api_path: EndpointBuilder::replace_param(
154                crate::core::endpoints::im::IM_V1_DELETE_BATCH_MESSAGE,
155                "batch_message_id",
156                batch_message_id,
157            ),
158            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
159            ..Default::default()
160        };
161
162        let api_resp: BaseResponse<EmptyResponse> =
163            Transport::request(api_req, &self.config, option).await?;
164        api_resp.into_result()
165    }
166
167    /// 查询批量消息整体进度
168    pub async fn get_progress(
169        &self,
170        batch_message_id: &str,
171        option: Option<RequestOption>,
172    ) -> SDKResult<GetBatchProgressResponse> {
173        let api_req = ApiRequest {
174            http_method: Method::GET,
175            api_path: EndpointBuilder::replace_param(
176                crate::core::endpoints::im::IM_V1_BATCH_MESSAGE_PROGRESS,
177                "batch_message_id",
178                batch_message_id,
179            ),
180            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
181            ..Default::default()
182        };
183
184        let api_resp: BaseResponse<GetBatchProgressResponse> =
185            Transport::request(api_req, &self.config, option).await?;
186        api_resp.into_result()
187    }
188
189    /// 查询批量消息推送和阅读人数
190    pub async fn read_user(
191        &self,
192        batch_message_id: &str,
193        user_id_type: Option<UserIdType>,
194        page_size: Option<i32>,
195        page_token: Option<String>,
196        option: Option<RequestOption>,
197    ) -> SDKResult<GetBatchReadUserResponse> {
198        let mut query_params = HashMap::new();
199        if let Some(user_id_type) = user_id_type {
200            query_params.insert("user_id_type", user_id_type.as_str().to_string());
201        }
202        if let Some(page_size) = page_size {
203            query_params.insert("page_size", page_size.to_string());
204        }
205        if let Some(page_token) = page_token {
206            query_params.insert("page_token", page_token);
207        }
208
209        let api_req = ApiRequest {
210            http_method: Method::GET,
211            api_path: EndpointBuilder::replace_param(
212                crate::core::endpoints::im::IM_V1_BATCH_MESSAGE_READ_USER,
213                "batch_message_id",
214                batch_message_id,
215            ),
216            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
217            query_params,
218            ..Default::default()
219        };
220
221        let api_resp: BaseResponse<GetBatchReadUserResponse> =
222            Transport::request(api_req, &self.config, option).await?;
223        api_resp.into_result()
224    }
225}
open_lark/service/im/v1/batch_message/mod.rs

open_lark/service/im/v1/batch_message/
mod.rs
