POST 新增/编辑邮箱配置
POST。body 为 JSON 对象,字段结构见接口参考。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
config.finance.invoice-mailbox.save | config:write | POST /v1/invoice-mailbox/config/save(comap-finance) |
必填字段
| 字段 | 依据 |
|---|---|
name | 接口规格 |
address | 接口规格 |
protocol | 接口规格 |
server | 接口规格 |
port | 接口规格 |
account | 接口规格 |
scopeType | 接口规格 |
条件必填(如「某状态时必填」)不在此表,以上方参数说明为准。 判定规则见必填字段的判定。
请求体字段(body)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | integer(int64) | — | 主键 ID,编辑时必填 |
name | string | 是 | 邮箱名称 |
address | string | 是 | 收件地址(租户内唯一) |
protocol | string | 是 | 协议 IMAP/POP3 |
server | string | 是 | 服务器地址 |
port | integer(int32) | 是 | 端口 1-65535 |
sslEnabled | boolean | — | 是否SSL |
account | string | 是 | 登录账号 |
password | string | — | 密码/授权码,新增必填;编辑留空=不修改 |
scopeType | string | 是 | 可见范围类型 ALL/DEPT/USER |
scopeDeptIds | integer(int64)[] | — | 可见部门ID列表(scopeType=DEPT 时使用) |
scopeUserIds | integer(int64)[] | — | 可见人员ID列表(scopeType=USER 时使用) |
「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。
请求示例
curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "config.finance.invoice-mailbox.save",
"body": {
"id": "1961000000000000001",
"name": "string",
"address": "string",
"protocol": "string",
"server": "string",
"port": 0,
"account": "string",
"scopeType": "string"
}
}'
错误处理
响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:
| 错误码 | 说明 | 可重试 |
|---|---|---|
| 92101 | 访问凭证无效 | 否 |
| 92201 | 接口未登记或已停用 | 否 |
| 92202 | 超出凭证授权范围——本接口需 config:write | 否 |
| 92204 | 绑定员工无此接口的功能权限 | 否 |
| 92203 | 上游服务调用失败 | 先查询处理结果,禁止盲目重试 |
| 92301 | 请求过于频繁 | 是 |
| 92205 | 写操作处理超时,结果未知(下游可能仍在执行) | 否,先查询确认结果 |
| 92302 | 有参数相同的写请求正在处理中 | 等待并确认前一次结果,勿重复提交 |
除此之外,comap-finance 自身的业务校验失败会原样透传其业务码与提示
(如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内,
以响应里的 message 为准。完整的平台层错误码见错误码说明。
← 返回进项发票收件邮箱配置