POST高危 测试邮箱连接
POST。body 为 JSON 对象,字段结构见接口参考。本接口涉及资金、票据或审批状态变更,调用前请与用户确认。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
config.finance.invoice-mailbox.test-connection | config:write | POST /v1/invoice-mailbox/config/test-connection(comap-finance) |
⚠️ 高危接口:删除或状态变更类操作,MCP 调用须先向用户复述并获同意后携 confirm: true。
必填字段
| 字段 | 依据 |
|---|---|
protocol | 接口规格 |
server | 接口规格 |
port | 接口规格 |
account | 接口规格 |
条件必填(如「某状态时必填」)不在此表,以上方参数说明为准。 判定规则见必填字段的判定。
请求体字段(body)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
protocol | string | 是 | 协议 IMAP/POP3 |
server | string | 是 | 服务器地址 |
port | integer(int32) | 是 | 端口 1-65535 |
sslEnabled | boolean | — | 是否SSL |
account | string | 是 | 登录账号 |
password | string | — | 密码/授权码;编辑态留空=复用已存邮箱密码(需传 mailboxId) |
mailboxId | integer(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 字段
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
success | boolean | — | 是否连接成功 |
message | string | — | 结果说明/失败原因 |
错误处理
响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:
| 错误码 | 说明 | 可重试 |
|---|---|---|
| 92101 | 访问凭证无效 | 否 |
| 92201 | 接口未登记或已停用 | 否 |
| 92202 | 超出凭证授权范围——本接口需 config:write | 否 |
| 92204 | 绑定员工无此接口的功能权限 | 否 |
| 92203 | 上游服务调用失败 | 先查询处理结果,禁止盲目重试 |
| 92301 | 请求过于频繁 | 是 |
| 92205 | 写操作处理超时,结果未知(下游可能仍在执行) | 否,先查询确认结果 |
| 92302 | 有参数相同的写请求正在处理中 | 等待并确认前一次结果,勿重复提交 |
除此之外,comap-finance 自身的业务校验失败会原样透传其业务码与提示
(如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内,
以响应里的 message 为准。完整的平台层错误码见错误码说明。
← 返回进项发票收件邮箱配置