HTTP/HTTPS
请求协议
APIUSB / 平台接口 / 发送邮件
发送邮件
接口地址：https://api.apiusb.com/api/platform?s=Platform.Email.EmailAdd
接口描述： 通过sendgrid发送邮件
接口参数
| 参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
|---|---|---|---|---|---|
| access_token | 字符串 | 可选 | 访问令牌，仅当开启签名验证时需要传递，生成令牌可使用App.Auth.ApplyToken接口 | ||
| pid | 整型 | 可选 | 0 | 邮件父Id | |
| depid | 整型 | 可选 | 0 | 部门ID | |
| folder_id | 整型 | 可选 | 1 | 邮件所在目录 | |
| operatorid | 整型 | 可选 | 0 | 操作员ID | |
| clientid | 整型 | 可选 | 0 | 客户ID | |
| fromname | 字符串 | 必须 | - | 发件人名字 | |
| fromemail | 字符串 | 必须 | - | 发件人邮箱 | |
| toemail | 字符串 | 必须 | - | 收件人邮箱，多个使用,分割 | |
| ccemail | 字符串 | 可选 | - | 抄送邮箱，多个使用,分割 | |
| bccemail | 字符串 | 可选 | - | 密送邮箱，多个使用,分割 | |
| priorityid | 整型 | 必须 | 0 | 权重ID | |
| optionid | 整型 | 必须 | 0 | 权重ID | |
| subject | 字符串 | 必须 | - | 邮件标题 | |
| content | 字符串 | 必须 | - | 邮件内容 | |
| attachments | file | 可选 | - | 附件 | |
| notes | 字符串 | 可选 | - | 备注 | |
| private | 整型 | 必须 | 0 | 是否私有 | |
| due_time | 日期 | 可选 | - | 截止时间 | |
| reminder | 整型 | 可选 | - | 提醒0不提醒，1提醒处理 |
返回字段
| 返回结果 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误 |
| data | 对象或混合类型 | 业务数据，由各自接口指定，通常为对象 |
| data.id | 整型 | 添加邮件发送成功的ID |
| msg | 字符串 | 提示信息，失败时的错误提示 |
在线测试
| 参数 | 是否必须 | 值 |
|---|---|---|
| service | 必须 | |
| access_token | 可选 | |
| pid | 可选 | |
| depid | 可选 | |
| folder_id | 可选 | |
| operatorid | 可选 | |
| clientid | 可选 | |
| fromname | 必须 | |
| fromemail | 必须 | |
| toemail | 必须 | |
| ccemail | 可选 | |
| bccemail | 可选 | |
| priorityid | 必须 | |
| optionid | 必须 | |
| subject | 必须 | |
| content | 必须 | |
| attachments | 可选 | |
| notes | 可选 | |
| private | 必须 | |
| due_time | 可选 | |
| reminder | 可选 |
客户端请求示例
# 暂无示例，可添加示例文件：./src/view/docs/demos/Platform.Email.EmailAdd.json错误列表
| 错误状态码 | 错误描述信息 |
|---|---|
| 400 | ret=400，客户端参数错误或非法请求 |
| 404 | 表示接口服务不存在 |
| 406 | ret=406，access_token令牌校验不通过 |
| 407 | ret=407，app_key权限不足，或未知应用 |
| 408 | ret=408，当前用户禁止使用，或用户未登录 |
| 500 | 表示服务端内部错误 |
本文档生成时间：2024-04-27 12:22:04