HTTP/HTTPS
请求协议
YesDev / WebAPI / 添加或者更新kpi邮箱配置信息
添加或者更新kpi邮箱配置信息
接口地址:https://www.yesdev.cn/api/platform.php?s=Platform.Kpi_Kpi.AddOrUpdateKpiEmailConfig
接口描述: 添加或者更新kpi邮箱配置信息
接口参数
| 参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
|---|---|---|---|---|---|
| access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
| app_key | 字符串 | 可选 | app_key,团队代码 | ||
| sign | 字符串 | 可选 | - | 动态签名,签名算法请联系我们技术客服获取 | |
| type | 字符串 | 必须 | - | 最大:255 | kpiy邮件类型 100项目 200需求 300测试计划 |
| title | 字符串 | 必须 | - | 最大:255 | 标题 |
| addressee_email | 字符串 | 必须 | - | 最大:255 | 收件人地址 |
| cc_email | 字符串 | 可选 | - | 抄送人人地址 | |
| email_crontab_cycle_stype | 字符串 | 必须 | - | 最大:255 | 邮件定时周期类型 100秒 200分 300时 400天 500周 600月 700年 |
| email_crontab_cycle_stype_value | 字符串 | 必须 | - | 最大:255 | 邮件定时周期类型对应的值,0代表每, 可以多个传,比如每周工作日传(1,2,3,4,5) |
| email_crontab_cycle_time | 字符串 | 必须 | - | 最大:255 | 邮件定时的准确时分秒,默认00:00:00 |
| email_status | 字符串 | 可选 | 10 | 最大:255 | 邮箱状态 10关 20 开 |
返回字段
| 返回结果 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
| data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
| msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
| 参数 | 是否必须 | 值 |
|---|---|---|
| service | 必须 | |
| access_token | 可选 | |
| app_key | 可选 | |
| sign | 可选 | |
| type | 必须 | |
| title | 必须 | |
| addressee_email | 必须 | |
| cc_email | 可选 | |
| email_crontab_cycle_stype | 必须 | |
| email_crontab_cycle_stype_value | 必须 | |
| email_crontab_cycle_time | 必须 | |
| email_status | 可选 |
客户端请求示例
# 暂无示例,可添加示例文件:./src/view/docs/demos/Platform.Kpi_Kpi.AddOrUpdateKpiEmailConfig.json错误列表
| 错误状态码 | 错误描述信息 |
|---|---|
| 400 | ret=400,客户端参数错误或非法请求 |
| 404 | 表示接口服务不存在 |
| 406 | ret=406,access_token令牌校验不通过 |
| 407 | ret=407,app_key权限不足,或未知应用 |
| 408 | ret=408,当前用户禁止使用,或用户未登录 |
| 410 | 权限不足 |
| 500 | 表示服务端内部错误 |
本文档生成时间:2025-11-03 21:00:11 联系我们开通接入OpenAPI