WeComClient

• 生成时间：2026-10-01T10:31:40Z
• 来源：C# interface
• 源文件：modules/integration/Yoyo.WeCom/IWeComClient.cs

服务简介

公共企业微信原子能力。所有调用显式传递连接，不读取宿主会话或数据库。

服务别名

• IWeComClient
• WeComClient

方法目录

• GetTodoAsync
• ListDepartmentsAsync
• ListMembersAsync
• SendTextMessageAsync
• UpdateTodoAsync
• VerifyCallback

方法详情

GetTodoAsync

• 用途：查询已有待办。不可用或权限不足返回明确错误。
• 声明：Task<WeComResult<WeComTodo>> GetTodoAsync(WeComConnection connection, string todoId, CancellationToken cancellationToken = default)

参数

参数名	类型	说明	DTO
connection	WeComConnection	宿主解析的显式连接。	否
todoId	string	当前应用已有的外部待办 ID。	否
cancellationToken	CancellationToken	取消信号。	否

返回

• 返回类型：Task<WeComResult<WeComTodo>>
• 说明：待办详情或脱敏错误，不代表创建能力。
• 返回包装：Task -> WeComResult

ListDepartmentsAsync

• 用途：读取应用可见部门；parentId 为空时读取可见列表，不写入本地目录。
• 声明：Task<WeComResult<IReadOnlyList<WeComDepartment>>> ListDepartmentsAsync(WeComConnection connection, long? parentId = null, CancellationToken cancellationToken = default)

参数

参数名	类型	说明	DTO
connection	WeComConnection	宿主解析的显式连接及凭据版本。	否
parentId	long?	可选的外部部门 ID。	否
cancellationToken	CancellationToken	取消信号。	否

返回

• 返回类型：Task<WeComResult<IReadOnlyList<WeComDepartment>>>
• 说明：外部部门列表或脱敏错误。
• 返回包装：Task -> WeComResult -> IReadOnlyList

ListMembersAsync

• 用途：读取指定部门成员；不承诺远端未授权字段或隐式遍历所有部门。
• 声明：Task<WeComResult<IReadOnlyList<WeComMember>>> ListMembersAsync(WeComConnection connection, long departmentId, CancellationToken cancellationToken = default)

参数

参数名	类型	说明	DTO
connection	WeComConnection	宿主解析的显式连接。	否
departmentId	long	外部部门 ID，不是本地组织 ID。	否
cancellationToken	CancellationToken	取消信号。	否

返回

• 返回类型：Task<WeComResult<IReadOnlyList<WeComMember>>>
• 说明：外部成员列表或脱敏错误。
• 返回包装：Task -> WeComResult -> IReadOnlyList

SendTextMessageAsync

• 用途：发送文本应用消息；有副作用的请求不自动重试。
• 声明：Task<WeComResult<WeComMessageReceipt>> SendTextMessageAsync(WeComConnection connection, WeComTextMessage message, CancellationToken cancellationToken = default)

参数

参数名	类型	说明	DTO
connection	WeComConnection	宿主解析的显式连接，应用 ID 来自该连接。	否
message	WeComTextMessage	明确成员接收者与 UTF-8 文本内容，不允许隐式广播。	否
cancellationToken	CancellationToken	取消信号；发送后取消可能导致结果不确定。	否

返回

• 返回类型：Task<WeComResult<WeComMessageReceipt>>
• 说明：提交回执及无效/未授权成员，或脱敏错误；不确定结果不可盲目重投。
• 返回包装：Task -> WeComResult

UpdateTodoAsync

• 用途：更新已有待办；成功返回 true，不提供创建待办能力。
• 声明：Task<WeComResult<bool>> UpdateTodoAsync(WeComConnection connection, WeComTodoUpdate update, CancellationToken cancellationToken = default)

参数

参数名	类型	说明	DTO
connection	WeComConnection	宿主解析的显式连接，应用须可见根部门。	否
update	WeComTodoUpdate	已有待办、整体及参与人状态；0=完成，1=进行中。	否
cancellationToken	CancellationToken	取消信号；发送后取消可能导致结果不确定。	否

返回

• 返回类型：Task<WeComResult<bool>>
• 说明：成功标识或脱敏错误。
• 返回包装：Task -> WeComResult

VerifyCallback

• 用途：验签、解密并校验 CorpId；也适用于 URL 验证 echostr。宿主负责时间窗口与重放防护。
• 声明：WeComResult<WeComCallback> VerifyCallback(WeComConnection connection, WeComEncryptedCallback callback)

参数

参数名	类型	说明	DTO
connection	WeComConnection	包含 CallbackToken、EncodingAesKey 和预期 CorpId 的连接。	否
callback	WeComEncryptedCallback	外层 Encrypt/echostr 密文及查询签名参数。	否

返回

• 返回类型：WeComResult<WeComCallback>
• 说明：经过协议校验的载荷与元数据；失败不返回明文。
• 返回包装：WeComResult