HTTP/HTTPS
请求协议
APIUSB / 平台接口 / 获取邮件记录列表
获取邮件记录列表
接口地址:https://api.apiusb.com/api/platform?s=Platform.EmailRecord.GetEmailList
接口描述: 获取邮件记录列表
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
order | 整型 | 可选 | 1 | 1按发送时间顺序显示,2按发送时间逆序 | |
page | 整型 | 可选 | 1 | 最小:1 | 第几页 |
perpage | 整型 | 可选 | 10 | 最小:1;最大:10 | 分页数量 |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.邮件记录 | items | |
data.邮件记录ID | items[].id | |
data.接收人邮箱 | items[].email_address | |
data.邮件标题 | items[].email_title | |
data.邮件内容 | items[].email_content | |
data.邮件发送结果 | items[].email_result | |
data.邮件发送时间 | items[].email_time | |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
order | 可选 | |
page | 可选 | |
perpage | 可选 |
客户端请求示例
# 暂无示例,可添加示例文件:./src/view/docs/demos/Platform.EmailRecord.GetEmailList.json
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-03-29 10:37:07