跳到主要内容

POST高危 测试邮箱连接

POST。body 为 JSON 对象,字段结构见接口参考。本接口涉及资金、票据或审批状态变更,调用前请与用户确认。

接口编码所需范围后端接口
config.finance.invoice-mailbox.test-connectionconfig:writePOST /v1/invoice-mailbox/config/test-connection(comap-finance)

⚠️ 高危接口:删除或状态变更类操作,MCP 调用须先向用户复述并获同意后携 confirm: true。

必填字段

字段依据
protocol接口规格
server接口规格
port接口规格
account接口规格

条件必填(如「某状态时必填」)不在此表,以上方参数说明为准。 判定规则见必填字段的判定。

请求体字段(body)

字段类型必填说明
protocolstring是协议 IMAP/POP3
serverstring是服务器地址
portinteger(int32)是端口 1-65535
sslEnabledboolean—是否SSL
accountstring是登录账号
passwordstring—密码/授权码;编辑态留空=复用已存邮箱密码(需传 mailboxId)
mailboxIdinteger(int64)—已存邮箱ID:编辑态密码留空时用于复用已存密码测试

「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "config.finance.invoice-mailbox.test-connection",
"body": {
"protocol": "string",
"server": "string",
"port": 0,
"account": "string"
}
}'

响应 data 字段

字段类型必填说明
successboolean—是否连接成功
messagestring—结果说明/失败原因

错误处理​

响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:

错误码说明可重试
92101访问凭证无效否
92201接口未登记或已停用否
92202超出凭证授权范围——本接口需 config:write否
92204绑定员工无此接口的功能权限否
92203上游服务调用失败先查询处理结果,禁止盲目重试
92301请求过于频繁是
92205写操作处理超时,结果未知(下游可能仍在执行)否,先查询确认结果
92302有参数相同的写请求正在处理中等待并确认前一次结果,勿重复提交

除此之外,comap-finance 自身的业务校验失败会原样透传其业务码与提示 (如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内, 以响应里的 message 为准。完整的平台层错误码见错误码说明。

← 返回进项发票收件邮箱配置