Lingxing
切换旧版

查询邮件列表

POST/erp/sc/data/mail/lists

支持查询【邮件消息】列表

接口信息

API Path请求协议请求方式令牌桶容量
/erp/sc/data/mail/listsHTTPSPOST1

请求参数

flagstring必填
类型:
sent 发件
receive 收件
emailstring必填
店铺绑定邮箱
start_datestring必填
开始日期,格式:yyyy-mm-dd
end_datestring必填
开始日期,格式:yyyy-mm-dd
offsetinteger
分页偏移量,默认0
lengthinteger
分页长度,默认20

请求示例

{
    "flag": "sent",
    "email": "xxx@qq.com",
    "offset": 0,
    "length": 20
}

返回结果

Json Object

codeinteger必填
状态码,0 成功
示例 0
messagestring必填
响应信息
示例 success
error_detailsarray<any>必填
错误信息
request_idstring必填
请求链路id
示例 73A0718B-AA68-E120-D28B-F7175018175D
response_timestring必填
响应时间
示例 2022-04-19 15:16:18
dataarray<object>必填
响应数据
隐藏子属性
webmail_uuidstring必填
邮件唯一标识
示例 118155928087207936
datestring必填
日期
示例 2022-02-25 14:33:00
subjectstring必填
邮件标题
示例 标题1
from_namestring必填
发件人姓名
示例 system
from_addressstring必填
发件人地址
示例 system@tapd.cn
to_namestring必填
接收人
示例 auto-communication
to_addressstring必填
接收人地址
示例 auto-communication@qq.com
has_attachmentinteger必填
是否存在附件:
1 存在
0 不存在
示例 1
mail_sn_codestring必填
邮件编号
示例 OTH0163416
totalinteger必填
总数
示例 187

返回成功示例

{
    "code": 0,
    "message": "success",
    "error_details": [],
    "request_id": "27BB5B29-31C0-FA02-6A88-7134DED5A8C6",
    "response_time": "2022-03-31 15:49:35",
    "data": [
        {
            "webmail_uuid": "118155928087207936",
            "date": "2022-02-25 14:33:00",
            "subject": "标题1",
            "from_name": "system",
            "from_address": "system@tapd.cn",
            "to_name": "auto-communication",
            "to_address": "auto-communication@qq.com",
            "has_attachment": 1,
            "mail_sn_code": "OTH0163416"
        },
        {
            "webmail_uuid": "118155927439331328",
            "date": "2022-02-24 22:30:22",
            "subject": "标题2",
            "from_name": "system",
            "from_address": "system@tapd.cn",
            "to_name": "auto-communication",
            "to_address": "auto-communication@qq.com",
            "has_attachment": 0,
            "mail_sn_code": "OTH0163415"
        }
    ],
    "total": 187
}

返回失败示例

{
    "code": 102,
    "message": "参数不合法",
    "error_details": [
        "email => email不能为空"
    ],
    "request_id": "8671A9D1-BC61-9398-FBD9-C90A672DAD11",
    "response_time": "2022-03-31 15:55:03",
    "data": [],
    "total": 0
}